Error Response Message

Sample Error Response Message

Code Snippet

CODE

{
  "errors": [
    {
      "code": "123"
"description": "This booking 000ARH4104 is not currently valid. Field, Type, Message: Origin, 1, Location 'MTARA' does not have siding 'SLMRY' (customer siding) as a child siding.",
    }
  ],
  "links": [
    {
      "rel": "help",
      "href": "http://example.com"
    }
  ]
}

Error Response Headers (HTTP:400,401,403,429,500)

Table of Values

Name	Value	Data Type	Comment
version	1	integer	The version of this message format.
transactionID	FONTERRA_20171107131313_3dc7ffca-fd28-49ba-9636-1ff66bfe5341	string	An unique identifier for a set of messages belonging to each other. Can be null if there is no transaction ID attached to this message. Identifier is defined as <app>_<initiator>_<timestamp>_UUID for example
messageID	string	string	Unique identifier for this message. This is similar to the Mule ESB MessageID who would use this id internally. The message ID should only exist for the message between two systems, so a stream over three components will use two messageIDs one for component A to B and one from B to C. This value cannot be set by the caller.
currentSystem	EdiBooking	string	System that generated the message
userInitiatingRequest	email	string	User requesting/submitting information Login ID
creationTimestamp	2017-11-07 13:13:13:123 NZDT	string	Date of creation of the message in YYYY-MM-DD hh:mm:ss:ms in NZDT
auditCategory	edi.booking	string	Holds a string that can be used to collect log information over all services
payloadEncrypted	false	boolean	If true the payload is encrypted, when false it is not. This is set for the content encryption(like GPG), not the connection (like SSL)
payloadEncoding	UTF-8	string	When the payload is text, it should contain the text encoding (Like 'UTF-8'), if binary, the encoding is binary When the payload is encrypted, the encoding should be the encoding of the unencrypted payload. If the payload type is not known, or not disclosed, the value is pass-through
debug	0	integer	Logs all requests if set in debug mode 0 - Don't debug 1 - Debug mode
retryNumber	0	integer	Attempts made by calling service to read content
Cache-Control	no-cache	string	Recommended caching time for services to expire (When data should be refreshed.) (When data should be refreshed.) The directives can be used max-age, s-max-age, private/public, no-cache, no-store, must-revalidate, proxy-revalidate