Response Format
REST is the simplest response format to use -
it's a simple XML or JSON block.
At the moment we support a response in XML or
JSON. By default XML is selected
as the response format. If you want JSON as the
response format add format=json to the query
string.
A successful method call returns this:
<?xml version="1.0" encoding="utf-16" ?>
<response>
[RESPONSE XML]
</response>
{
"response":{
[RESPONSE JSON]
}
}
Example:
<?xml version="1.0" encoding="utf-8"?>
<response>
<sociotocoSet sociotocoId="9e8bdbcb-b869-402d-83e4-1ad1add2ba37">
<name />
<urlName>SFDRQ7K9</urlName>
</sociotocoSet>
</response>
{
"response":{
"sociotocoSet":{
"sociotocoId":"9e8bdbcb-b869-402d-83e4-1ad1add2ba37",
"name":null,
"urlName":"SFDRQ7K9"
}
}
}
If an error occurs, the following is
returned:
<?xml version="1.0" encoding="utf-8" ?>
<response>
<error code="[ERROR CODE]">[ERROR MESSAGE]</error>
</response>
{
"response":{
"error":{
"code":[ERROR CODE],
"message":[ERROR MESSAGE]
}
}
}
Example:
<?xml version="1.0" encoding="utf-8"?>
<response>
<error code="200">Invalid key in query parameters.</error>
</response>
{
"response":{
"error":{
"code":200,
"message":"Invalid key in query parameters."
}
}
}