UpdateServicerNotes RESTified API
- Andrew Hill (Deactivated)
- Jason Andrew
- Mickey Bushman
Resource URL Summary
Pass Through Call to Dispatch's "Update Servicer Notes" API
PUT /up/v5/rest/dispatch/updateCallNotes
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specifics
Pass Through Call to Dispatch's "Update Servicer Notes" API
This RESTified API will perform a pass-through call to the Dispatch sub-system's "Update Servicer Notes" API (when configured).
URL
PUT /up/v5/rest/dispatch/updateCallNotes
HTTP Request Body
This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Dispatch "Update Servicer Notes" API.
UpdateServicerNotes Object Format
{
"Id": "0.616182638892496",
"NotesType": "Servicer External",
"Notes": "Salvage Product Verified~31846192_2~1ZR3529W039488 5892~~2018-10-29 09:02:44~~~~~0~0~Tracking No: <1Z R3529W0394885892>~~0~0000000~~~~00000",
"NotesDate": "2018-11-20"
}
UpdateServicerNotes Object Properties
| Property | Type | Required? | Description | Dispatch Field Mapping |
|---|---|---|---|---|
Id | string | No | The call number that was used when the call was originally created. | CallNo |
NoteType | string | No | These are the types of notes sent to the servicer. | NoteType |
Notes | object | No | These are notes sent to the servicer. | Notes |
NotesData | string | No | Date on which notes were entered. | NotesDate |
HTTP Response
Success
On success, a JSON-formatted version of the Dispatch "Update Servicer Notes" API response will be returned.
{
"MFGID": "9999",
"Id": "0.616182638892496",
"AckMsg": "OK"
}
Error
On error, a JSON-formatted version of the Dispatch "Update Servicer Notes" API response will be returned.
{
"Success": false,
"Code": 9,
"Payload": {
"returnCode": {
"type": "Error",
"message": "Dispatch Error Code"
}
}
}
Return Codes
In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.