APIExceptionType
Fields
The account number provided to the exception.
The API calls associated with this exception if any.
The user assigned to handle this exception if any.
Category associated with this exception.
Free field for the API caller to categorise a channel. This could be (but not limited to) the client's team that calleded the API, the name of the 'flow' the call belongs to, etc.
Storage for the API client to submit any contextual information.
The customer contact provided to the exception.
The events associated with this exception if any.
External identifier submitted by the API client to track this exception on their end.
The key date associated with the exception, if available.
Notes associated with this exception if any.
The operations team assigned to this exception if any.
The current priority for the API exception.
The current resolution status for the API exception.
The current resolution type for the API exception.
The supply point identifier provided to the exception.
Tags associated with this exception if any.
The user id provided to the exception.
Example
{
"accountNumber": "A-C2299044",
"apiCalls": [APICallType],
"assignedUser": AssignedUserType,
"category": "UNKNOWN",
"channel": "course-physical-claim-degree-affect",
"context": {"key": "value"},
"createdAt": "2005-08-22T01:41:46.745184+00:00",
"customerContact": "worker-if-happy-four-character",
"events": [APIExceptionEventType],
"externalIdentifier": "53317509",
"id": "81372519",
"keyDate": "2009-01-24",
"notes": [APIExceptionNoteType],
"operationsTeam": OperationsTeamType,
"priority": "LOW",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"supplyPointIdentifier": "94715464",
"tags": "MOVE_IN",
"userId": 1
}