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 12 Current »

5.4.0

A pass-through API to ServiceScheduling (when configured) which allows the ServiceScheduling's "ActDeleteRequest" API to be called.

Description

Used to delete a standard activity in ServiceScheduling.          

Uses sp:ActDeleteRequest.  

On this page:

Related pages:

Resource URL Summary


Pass Through Call to ServiceScheduling's "ActDeleteRequest" API

PUT /up/v5/rest/scheduling/ActDelete

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.


API Specifics


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

ActDelete JSON
{
	"actID": ""
}


DeleteAct Object Properties (bold property names indicate required field)

PropertyTypeDescriptionReq?
actID

string

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:

 Click here to expand...
  • SP_ACTIVITY_NO_INVALID (131)
  • SP_OK_CAPACITY_EXCEEDED (640)





  • No labels