Versions Compared

Key

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

Overview

This web service retrieves a list of skill summary records (PwsSkillSummaryElement), based on specified search criteria. The following parameters affect the list of lists retrieved:

...

If both SkillGroupIdentity and SkillIdentity are specified, the specified skill must belong to the specified skill group, otherwise the request will fail.

Request Format

Panel
titlePwsGetSkillList PwsGetSkillGroupList Request
  • PwsGetSkillListPwsGetSkillGroupList

Request Elements

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.


IncludeInactiveFlag

Boolean

No

flase

false

If set to 'true',

skills

skill groups that are set to inactive will be included in the results. Otherwise, only

skills

skill groups that are considered active will be included.

true


MaxRowsToReturn

Int32

No


The maximum number of

skills

skill groups to be retrieved. This value is disregarded if a skill group is specified in

SkillIdentity

SkillGroupIdentity.

10

QueryString

String

No



Find all skills matching specified string in skill group's name.

Database


SkillGroupIdentity

PwsSkillGroupRef

No



If specified, return

all skills in

only the specified group.

SkillIdentity

PwsSkillRef

No

If specified, return only the specified skill.


Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetSkillGroupList>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AUQnUBfR4twqQVdcrh4+jA==</req:SessionTicket>
            <req:MaxRowsToReturn>2</req:MaxRowsToReturn>
            <!--Optional:-->
            <req:SkillGroupIdentity>
               <com:SkillGroupName>Technology</com:SkillGroupName>
            </req:SkillGroupIdentity>
         </pws:serviceRequest>
      </pws:PwsGetSkillGroupList>
   </soapenv:Body>
</soapenv:Envelope>

...


Response Format

Panel
titlePwsGetSkillList PwsGetSkillGroupList Response

Response Elements

Element

Data Type

Description

Messages

PwsMessage[]

The web service response status and message. Click here for more information

ResponseId

Int32

Click here for more information.

Status

RequestStatus

Click here for more information

ServerTimestampUtc

DateTime

Click here for more information.

SkillsSkillGroups

PwsSkillSummaryElementPwsSkillGroupSummaryElement[]

This contains the basic set of information about each of the returned skillsskill groups. 


Response Usage Example(s)

...