Errors

Error responses are optimized based on HTTP status code.

Responses

400 - Bad Request

Clients can generate this error by sending a malformed request body.

HTTP/1.1 400 Bad Request
Content-Length: 43
<?xml version="1.0"?>
<BadRequestResponse
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xs="http://www.w3.org/2001/XMLSchema"
  xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/400ErrorResponse">
  <status>400 Bad Request</status>
  <message>{ an xml validation message }</message>
</BadRequestResponse>

422 - Unprocessable Entity

Clients can generate this error when requests are provided data that does not meet the constraints enforced by the application.

HTTP/1.1 422 - Unprocessable Entity
Content-Length: 660
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<UnprocessableEntityErrorResponse xmlns="http://www.decisiv.net/platform_api/0.0.7/Case/422ErrorResponse"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.decisiv.net/platform_api/0.0.7/Case/422ErrorResponse">
    <message>message0</message>
    <errors>
        <error>
            <resource>resource0</resource>
            <field>field0</field>
            <code>missing</code>
        </error>
        <error>
            <resource>resource1</resource>
            <field>field1</field>
            <messages>
              <message>required if field3 is froog</message>
            </messages>
            <code>missing</code>
        </error>
        <error>
            <resource>resource1</resource>
            <field>field2</field>
            <messages>
              <message>field2 cannot be frobbed</message>
              <message>field2 is limited to 10 EBCIDIC characters</message>
            </messages>
            <code>invalid</code>
        </error>
    </errors>
</UnprocessableEntityErrorResponse>

Error Codes

Name Description
missing This means a resource does not exist.
missing_field This means a required field on a resource has not been set.
invalid This means the formatting of a field is invalid. The documentation for that resource should be able to give you more specific information.
already_exists This means another resource has the same value as this field. This can happen in resources that must have some unique key (such as Label names).