Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

5.4.0

A pass-through API to ServiceDispatch (when configured) which allows the ServiceDispatch's "Update Servicer Notes" API to be called.        

On this page:

Related pages:

Resource URL Summary

Pass Through Call to ServiceDispatch'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 ServiceDispatch's "Update Servicer Notes" API

This RESTified API will perform a pass-through call to the ServiceDispatch 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 ServiceDispatch "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

PropertyTypeRequired?DescriptionField Mapping: ServiceDispatch 
IdstringNoPass through parameter to the ServiceDispatch "Update Servicer Notes" API. CallNo
NoteTypestringNoPass through parameter to the ServiceDispatch "Update Servicer Notes" API. NoteType
NotesobjectNo

Pass through parameter to the ServiceDispatch "Update Servicer Notes" API. 

Notes
NotesDatastringNo

Pass through parameter to the ServiceDispatch "Update Servicer Notes" API. 

NotesDate

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "Update Servicer Notes" API response will be returned.

{
    "MFGID": "9999",
    "Id": "0.616182638892496",
    "AckMsg": "OK"
}

Error

On error, a JSON-formatted version of the ServiceDispatch "Update Servicer Notes" API response will be returned.

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"  
        }
    }
}

In addition to the Standard Return Codes, Service Dispatch has unique error codes that can be found here.

  • No labels