Versions Compared

Version Old Version 2 New Version Current
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title5.4.0

A pass-through API to ServiceScheduling Scheduling (when configured) which allows the ServiceSchedulingScheduling's "Get Responsibility Units" API to be called.

Description

The sp:GetRespUnitsRequest API method returns a set of responsibility units in the array RespUnits.


Info

In this context, the ServiceScheduling Scheduling "Get Responsibility Units" API is the sp:GetRespUnitsRequest API API.  



Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Pass Through Call to ServiceSchedulingScheduling's "Get Responsibility Units" API

PUT /up/v5/rest/scheduling/GetRespUnits


Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specifics


Panel
borderColor#D3D3D3

Pass Through Call to

ServiceScheduling

Scheduling's "Get Responsibility Units" API

This RESTified API will perform a pass-through call to the ServiceScheduling subScheduling sub-system's "Get Responsibility Units" API (when configured).

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /up/v5/rest/scheduling/GetRespUnits

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 the Scheduling "Get Responsibility Units" APi.

GetResponsibilityUnits Object Format

Code Block
languagejs
titleGetResponsibilityUnits JSON
collapsetrue
{
    "FRU": "ParentRespUnit",
    "OffsetId": "PrevRespUnit",
    "Options": {
        "FRUCount": 1
    }
}

GetResponsibilityUnits Object Properties (bold property names indicate required field)

string

SS: Unit (string)integer
PropertyTypeLengthDescriptionReq?FRUMapping Field: Service Scheduling
FRU

string

SS: 9

Pass through parameter to the ServiceScheduling "the Scheduling Get Responsibility Units" API API. 

If this is not supplied, all Final Responsibility Units (FRUs) will be returned; if this is the ID of an FRU, all its constituent IRUs will be returned.

SS Field: Yes

ParentRespUnit

Yes

OffsetUd

string

SS: Unit (string)


SS: 9

Pass through parameter to the ServiceScheduling "the Scheduling Get Responsibility Units" API API. 

Is the start point for each batch; it should not be set for the first batch.

SS Field: PrevRespUnit

YesYes

PrevRespUnit

Optionsobject
PropertyTypeDescription
FRUCount

Pass through parameter to

the ServiceScheduling "

the Scheduling Get Responsibility Units

" API

 API. 

The number of Responsibility Units which will be returned in each batch if you wish to impose a limit. Leave unset if no limit is to be applied.

SS Field: options.RespUnitCount

NoNo

see: GetResponsibilty.Options.Objects

HTTP Response

Success

On success, a JSON-formatted version of the ServiceScheduling Scheduling "Get Responsibility Units" API response will be returned.

Code Block
languagejs
{
    "Success": true,
    "Code": "0",
    "Message": "",
    "Payload": {
        "result": {
            "type": "OK",
            "code": "0"
        },
    "OffsetId": "PrevRespUnit",
    "OffsetCount": "RespUnitCount",
    "FRUs": [
        {FRU}
    ]
  }
}

Error

On error, a JSON-formatted version of the ServiceScheduling Scheduling "Get Responsibility Units" 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 to the Standard Return Codes, and the Scheduling API return codes, the possible Return Codes from this API are:

Expand
  • SP_OK (0)
  • SP_UNIT_INVALID (28)