All API responses have a similar structure. This is as follows:
ConsumerDataSubmissionDetails
| traceId | string | Unique identifier for the HTTP request. Used internally by SimplyIOA. |
|---|
| errors | array of string | An array of strings containing error messages (if any errors occurred) |
| payload | object | The payload object contains API specific response information. Each API endpoint has their own unique definition for this payload object. |
| metadata | OrderedMap[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
| Name | Type | Description |
|---|
| onlineJourneyUrl | string | The URL used to continue the customer’s journey on the SimplyIOA website. |