Pass Through Call to ServiceScheduling's "Job Book Request" API
This RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "Book Job Request" API (when configured).
URL
PUT /up/v5/rest/scheduling/BookJob
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 ServiceScheduling "Book Job Request" API.
Book Job Request Object Format
Book Job Request Object Properties (bold property names indicate required field)
| Property | Type | Length | Description | Req? | Fied Mapping: ServiceScheduling | |||||
|---|---|---|---|---|---|---|---|---|---|---|
Id |
| SS: 50 | Caller’s identifier of the job to be booked. It must be unique in the ServiceOptimizer database, unless AllowRebook (below) is True. | Yes | JobId | |||||
| WorkType | object | see _WorkType Object Format. | yes | - | ||||||
HTTP Response
Success
On success, a JSON-formatted version of the ServiceScheduling "Book Job Request" API response will be returned.
{
"Success" : true,
"Code" : 0,
"Message" : "OK",
"Payload" : {
"result" : {
"type" : "OK",
"code" : "0"
},
"TravelTime" : "3",
"WorkItems" : [
{
"Id" : "Dep-1306",
"Tech" : "DE3_9_01",
"ETA" : "2006-01-03T08:01",
"IRU" : "EMID_I01",
"FRU" : "EMIDLAND"
},
{
"Id" : "Dep-1307",
"Tech" : "DE3_9_01",
"ETA" : "2006-01-03T09:02",
"IRU" : "EMID_I01",
"FRU" : "EMIDLAND"
}
]
}
}
Error
On error, a JSON-formatted version of the ServiceScheduling "Book Job Request" API response will be returned.
{
"Success": false,
"Code": 9,
"Payload": {
"returnCode": {
"type": "Error",
"code": "SCH Error Code"
}
}
}
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are: