/
ActDelete RESTified API

ActDelete RESTified API

5.4.0

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

Description

Used to delete a standard activity in Scheduling.          

Uses sp:ActDeleteRequest.  

On this page:

Related pages:

Resource URL Summary


Pass Through Call to Scheduling'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 Scheduling's "ActDeleteRequest" API

This RESTified API will perform a pass-through call to the Scheduling 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 Scheduling "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 Scheduling "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 Scheduling "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 Scheduling Error codes, the possible Return Codes from this API are:

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





Related content

DeleteUser RESTified API
DeleteUser RESTified API
More like this
ActUpdate RESTified API
ActUpdate RESTified API
More like this
Delete Standard Activity SOAP API
Delete Standard Activity SOAP API
More like this
Delete Standard Activity SOAP API
Delete Standard Activity SOAP API
More like this