Document toolboxDocument toolbox

Create Skill SOAP API

On This Page:

Related Pages:

The sp:SkillCreateRequest API method can be used to create valid skills which may be required for job types and/or jobs.

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.

Definition

The definition of this API is:

Web Service

Type

Description

Req?

Val?

<sp:SkillCreateRequest>

 

 

 

 

 <Version>?</Version> The current version of this API.(error)(error)

 

<SkillID>?</SkillID>

SkillID

Identifier for the skill.

(tick)

(tick)

 

<Desc>?</Desc>

 

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

(error)

(error)

</sp:SkillCreateRequest>

 

 

 

 

Return Structure

The API returns the standard return structure.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

  • SP_OK (0)
  • SP_SKILL_DESC_INVALID (199)
  • SP_SKILLID_NOT_SUPPLIED (213)
  • SP_SKILLID_ALREADY_EXISTS (229)
  • SP_SKILLID_INVALID (253)