API Call Return Information
All API calls will return information structured as shown below.
| Field | Type | Description |
|---|---|---|
| Code | integer | Please refer to API status codes table. |
| Description | string | Please refer to API status codes table. |
| <XML/JSON> | XML/JSON Object | See each individual API function. |
<Status>
<Code>SUCCESS</Code>
<Message>Success.[ActivityId]: ae3f9e1d-9fc2-4bda-88a1-69396d22b5cf</Message>
</Status>
<XML/JSON> || XML/JSON Object || See each individual API function.ActivityId
All endpoints return an ActivityId, as seen above. The ActivityId will be different each time the endpoint is called, essentially representing a unique id associated with the service call.
Viewpoint recommends logging the returned Code and Message values after each call.
