Pass Through Call to ServiceScheduling's "ActDeleteRequest" API
This RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "ActDeleteRequest" API (when configured).
URL
PUT /up/v5/rest/scheduling/ActDelete
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 "ActDeleteRequest" API.
ActDelete Object Format
DeleteAct Object Properties (bold property names indicate required field)
Property | Type | Description | Req? | |
---|---|---|---|---|
actID |
SS : ActID (unsigned int) | Identifier for the Activities as returned from EmpActAdd. SS Field Mapping: actID | Yes |
|
HTTP Response
Success
On success, a JSON-formatted version of the ServiceScheduling "DeleteActRequest" API response will be returned.
{ "Success": true, "Code": 0, "Message": "OK", "Payload": { "result": { "type": "OK", "code": "0" } } }
Error
On error, a JSON-formatted version of the ServiceScheduling "DeleteActRequest" 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, and the ServiceScheduling Error codes, the possible Return Codes from this API are: