Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • message - a string message that tells us what the problem is. This is almost always the exception's message property.
  • responseIdentifier - a server generated GUID that can be found in event viewer on the services web server to find more information about the error.  This can be used for troubleshooting.  If you are getting a response with no message, event viewer should have the full exception logged with the guid
Warning

Old end points do not conform to this standard yet. If you browse the help page for your services site, any end points that start with 'A{something}' are the old style of end points.

New end points that fail model validation do not conform to this standard yet. Model validation would be any input restrictions you see in the online end point help documentation, like fields that are required but not sent by the client. We will be updating model validation to this format before release.

In addition to the JSON object on the response body an HTTP status code must be assigned to the response.  The framework will blank out the message property on the JSON object for any HTTP status codes >= 500.  These are considered internal server errors and the assumption is the message property may contain sensitive information that is not appropriate for end users to see.  HTTP status codes >= 400 and < 500 are assumed to be client facing messages and the message property will be populated.  Regardless the entire exception is always written to the Aptify Exception Manager.  

...