CreateSkill RESTified API
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 Object Properties (Bold property name indicates the field is required)
Property | Type | Length | Description | Req? | Mapping Field: Service Scheduling |
---|---|---|---|---|---|
Id |
| SS: 30 | Pass through parameter to the ServiceScheduling "Create Skill" API. Identifier for the Skill. | Yes |
|
Desc |
| 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 |
|
Version |
| Pass through parameter to the ServiceScheduling "Create Skill" API. The current version of this API | No |
|
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: