Skip to main content

Consumer Data Responses

All API responses have a similar structure. This is as follows:

ConsumerDataSubmissionDetails

traceIdstringUnique identifier for the HTTP request. Used internally by SimplyIOA.
errorsarray of stringAn array of strings containing error messages (if any errors occurred)
payloadobjectThe payload object contains API specific response information. Each API endpoint has their own unique definition for this payload object.
metadataOrderedMap[string, string]Metadata that can be passed along with the request, and is returned with each response. Can be used for customer specific information.

ConsumerDataSubmissionDetails

NameTypeDescription
homeOnlineJourneyUrlstringThe URL used to continue the customer’s home journey on the SimplyIOA website.
autoOnlineJourneyUrlstringThe URL used to continue the customer’s auto journey on the SimplyIOA website.