Response Format and Error Messages

If interacting with our API or DPS directly, then once you have made a request or subscribed to a push group, you should receive a response or push in the below format:

{
 Data: { RESPONSE_OBJECT },
 Messages: [
   { 
     ErrorCode: '{ ERROR_CODE }',
     Message: '{ MORE_DETAILS }',
   }
 ],
}

The Data property will contain the requested data, assuming no errors in the request. You can find out more about the stucture of specific response objects in our API Reference.

The Messages property will contain any errors or notices about the request you have made. This contains an ErrorCode and a Message with more details, as defined in the table below:

Error Code	Meaning
MissingData	One of the required properties on the Request JSON is missing
UnknownData	One of the properties sent does not match from the option list
DataFormatError	One of the properties sent does not lead to a possible request
DataCapped	The returned data has been capped
InsufficientAccessPrivileges	The API details used do not have the sufficient access level for this resource
ServerError	Other server error, the Enact team have been notified

If using the LCPDelta Python package, responses and pushes will be returned directly in pandas DataFrame or Python dictionary format, and any error messages will be returned in place in the event of an error.