Resource URL Summary

Pass Through Call to ServiceDispatch's "Get Servicer Notes" API

PUT /up/v5/rest/dispatch/getServicerNotes

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

This will return to the requestor any notes that the servicer may have added to the call record. It does not return notes added by the requestor.

Parameter	Datatype (length)	Desc ription
`AckMsg`	String	This message confirms that the request was properly made.
`CallNo`	String(20))	The call number supplied in the request.
`CreatedOn`	Date	The date the notes were created on.
`ClientCode`	String(25)	The notes for the service call.

Pass Through Call to Dispatch's "Get Servicer Notes" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Get Servicer Notes" API (when configured).

URL

PUT /up/v5/rest/dispatch/getServicerNotes

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 "Get Servicer Notes" API.

GetServicerNotes Object Format

{
	"Id": "",
	"NoteType": "",
	"StartDate": "",
	"StartTime": "",
	"EndDate": "",
	"EndTime": ""
}

GetServicerNotes Object Properties

Property	Type	Required?	Description	Dispatch Field Mapping
`Id`	`string`	No	Pass through parameter to the Dispatch "Get Servicer Notes" API.	`CallNo`
`NoteType`	`string`	No	Pass through parameter to the Dispatch "Get Servicer Notes" API.	`NoteType`
`StartDate`	`string`	No	Pass through parameter to the Dispatch "Get Servicer Notes" API. Format expected as "YYYYMMDD".	`StartDate`
`StartTime`	`string`	No	Pass through parameter to the Dispatch "Get Servicer Notes" API. Format expected as "HH:MM", 24-hour format.	`StartTime`
`EndDate`	`string`	No	Pass through parameter to the Dispatch "Get Servicer Notes" API. Format expected as "YYYYMMDD".	`EndDate`
`EndTime`	`string`	No	Pass through parameter to the Dispatch "Get Servicer Notes" API. Format expected as "HH:MM", 24-hour format.	`EndTime`

HTTP Response

Success

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

GetServicerNotes Response Object Format

{
    "AckMsg": "OK",
    "WorkItemCount": "2",
    "WorkItems": [
        {
            "Id": "TU.2018-8-19.100012",
            "Notes": [
                {
                    "Type": "SERVICER EXTERNAL",
                    "Note": "this is test",
                    "CreatedBy": "SPI_BATCH",
                    "CreatedOn": "2019-10-12T00:12:42.000Z"
                },
                {
                    "Type": "SERVICER EXTERNAL",
                    "Note": "this is test",
                    "CreatedBy": "SPI_BATCH",
                    "CreatedOn": "2019-10-12T00:15:18.000Z"
                }
            ]
        },
        {
            "Id": "TP.2018-8-19.100011"
        }
    ]
}

GetServicerNotes Response Object Properties

Property			Type	Description
`AckMsg`			`string`	Description of the response success.
`WorkItemCount`			`string`	The number of Dispatch Servicer objects in the `WorkItems` array.
`WorkItems`			`array`	An array of objects, each representing the notes for a Dispatch Servicer.
	`Id`		string	The ID of the Dispatch Servicer.
	`Notes`		`array`	An optional array of notes for the Dispatch Servicer.
		`Type`	`string`	The Dispatch Servicer type.
		`Note`	`string`	The note.
		`CreatedBy`	`string`	The source of the note (e.g. user, system).
		`CreatedOn`	`string`	The date and time the note was created.

Error

On error, a JSON-formatted version of the Dispatch "Get 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.

ServiceBroker 5

GetServicerNotes RESTified API