Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.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.  

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Pass Through Call to ServiceScheduling's "ActDeleteRequest" API

PUT /up/v5/rest/scheduling/ActDelete

Include Page
_Default HTTP Headers
_Default HTTP Headers


API Specifics


Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Code Block
languagejs
titleActDelete JSON
collapsetrue
{
	"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.

Code Block
languagejs
{
    "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.

Code Block
languagejs
{
    "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 API codes, the possible Return Codes from this API are:

Expand
  • SP_ACTIVITY_NO_INVALID (131)
  • SP_OK_CAPACITY_EXCEEDED (640)