JSON or XML Return Format
By default, the BlueCamroo API returns objects in JSON format. For example, a JSON return of the Titles lookup values looks like this:
[{"Id":9,"MasterLabel":"tst","SortOrder":null},{"Id":6,"MasterLabel":"Dr.","SortOrder":1},{"Id":1,"MasterLabel":"Mr.","SortOrder":2},{"Id":2,"MasterLabel":"Mrs.","SortOrder":3},{"Id":3,"MasterLabel":"Miss.","SortOrder":4},{"Id":5,"MasterLabel":"Ms.","SortOrder":5},{"Id":7,"MasterLabel":"Rev.","SortOrder":6}]
The JSON response is invoked by using the HTTP GET method and the URL:
https://{company}.bluecamroo.com/api/salutation
XML
The API can return objects in XML format by the addition of ?format=xml to the URL. For example:
https://{company}.bluecamroo.com/api/v1.1/salutation?format=xml
Returns
<?xml version="1.0" encoding="utf-8"?> <ArrayOfSalutation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Salutation> <Id>9</Id> <MasterLabel>tst</MasterLabel> <SortOrder xsi:nil="true" /> </Salutation> <Salutation> <Id>6</Id> <MasterLabel>Dr.</MasterLabel> <SortOrder>1</SortOrder> </Salutation> <Salutation> <Id>1</Id> <MasterLabel>Mr.</MasterLabel> <SortOrder>2</SortOrder> </Salutation> <Salutation> <Id>2</Id> <MasterLabel>Mrs.</MasterLabel> <SortOrder>3</SortOrder> </Salutation> <Salutation> <Id>3</Id> <MasterLabel>Miss.</MasterLabel> <SortOrder>4</SortOrder> </Salutation> <Salutation> <Id>5</Id> <MasterLabel>Ms.</MasterLabel> <SortOrder>5</SortOrder> </Salutation> <Salutation> <Id>7</Id> <MasterLabel>Rev.</MasterLabel> <SortOrder>6</SortOrder> </Salutation> </ArrayOfSalutation>