Response bodies from the CodeGuard service are in JSON format, with a Content-Type: of application/json
and UTF-8 character encoding.
The following status codes represent "success" conditions:
A successful response will include a JSON document representing a resource.
HTTP/1.1 201 OK
Content-Type: application/json
Content-Length: 184
Last-Modified: Fri, 01 Jun 2013 14:53:22 GMT
{
"type": "Example",
"name": "Example Resource",
"parent": {
"type": "Root",
"name": "(root)",
"path": "/"
},
"path": "/example-resource"
}
A successful response will return a 200 status code.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 184
Last-Modified: Fri, 01 Jun 2013 14:53:22 GMT
The following status codes represent failure states. In most cases a response body will be included with the following error document format:
{
"error" : {
"message" : "Invalid partner API key"
}
}
Indicates that the format of the request is invalid. This may be caused by missing or malformed required parameters.
Indicates that the requester does not have permission to access the requested resource. This could be caused by invalid or malformed authentication parameters.
Indicates that a resource cannot be retrieved.
This response indicates a failure in the API's application server. The developers will be notified.