/
CreateSkill RESTified API

CreateSkill RESTified API

5.4.0

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

Description

Skills (each at a certain level) are required by job types and are possessed by operatives. The scheduling process matches the skills required by the job type (plus any extra skills set when the job was booked) with the skills which each operative has, to make sure that a job is not given to an operative who does not have the skills to do it at or above the required level.

In this context, the ServiceScheduling "Create Skill" API is the sp:SkillCreateRequest API.

On this page:

Related pages:

Resource URL Summary

Pass Through Call to ServiceScheduling's "Create Skill" API

PUT /up/v5/rest/scheduling/SkillCreate  

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.


API Specifics

Pass Through Call to ServiceScheduling's "Create Skill" API

This RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "Create Skill" API (when configured).

URL

PUT /up/v5/rest/scheduling/SkillCreate

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 "Create Skill" APi.

CreateSkill Object Format

CreateSkill JSON
{
    "Id": "SkillID",
    "Desc": ""
    "Version": "1"
}

CreateSkill Object Properties (Bold property name indicates the field is required)

PropertyTypeLengthDescriptionReq?Mapping Field: Service Scheduling
Id

string


SS: 30

Pass through parameter to the ServiceScheduling "Create Skill" API. 

Identifier for the Skill.

Yes

SkillId

Desc

string


SS: 35

Pass through parameter to the ServiceScheduling "Create Skill" API. 

The description of the skill.  If not supplied, the description stored in the database will be a copy of the supplied SkillID.

No

SkillDesc

Version

string


Pass through parameter to the ServiceScheduling "Create Skill" API. 

The current version of this API

No

SkillVersion

HTTP Response

Success

On success, a JSON-formatted version of the ServiceScheduling "Create Skill" API response will be returned.

{
	"Success": true,
	"Code": "0",
	"Message": "",
	"Payload": {
    	"result": {
      		"type": "OK",
      		"code": "0"
    	}
  	}
}

Error

On error, a JSON-formatted version of the ServiceScheduling "Create Skill" 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_OK (0)
  • SP_SKILL_DESC_INVALID (199)
  • SP_SKILLID_NOT_SUPPLIED (213)
  • SP_SKILLID_ALREADY_EXISTS (229)
  • SP_SKILLID_INVALID (253)

Related content

Create Skill SOAP API
Create Skill SOAP API
More like this
Create Skill SOAP API
Create Skill SOAP API
More like this