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 (PwsSkillSummaryPwsSkillSummaryElement), based on specified search criteria. The following parameters affect the list of lists retrieved:

  • QueryString:  IncludeInactiveFlag: Searches within skill group name and skill name. Any skill containing this string in the skill name, or that is part of a skill group whose name contains this string is included.
  • IncludeInactiveFlag: If false, inactive skills are excluded from the results.
  • SkillGroupIdentity: If specified, only skills in the specified skill group are included. Note QueryString and IncludeInactiveFlag are ignored if SkillGroupIdentity is specified.
  • SkillIdentity: If specified, only the specified skill is included. Note QueryString and IncludeInactiveFlag are ignored if SkillIdentity is specified.

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 Request

...

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

If set to 'true', skills that are set to inactive will be included in the results. Otherwise, only skills that are considered active will be included.

true

MaxRowsToReturn

Int32

No


The maximum number of skills to be retrieved. This value is disregarded if a skill is specified in SkillIdentity.

10

QueryString

String

No


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

Database

SkillGroupIdentity

PwsSkillGroupRef

No


If neither SkillGroupIdentity nor SkillIdentity is specified, return all skills will be included in the responsespecified group. 


SkillIdentity

PwsSkillRef

Nosee above


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:PwsGetSkillList>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AQztUvxG5aNFjPJheSuItw==</req:SessionTicket>
            <!--Optional:-->
            <req:IncludeInactiveFlag>1</req:IncludeInactiveFlag>
            <!--Optional:-->
            <req:MaxRowsToReturn>50</req:MaxRowsToReturn>
            <req:SkillGroupIdentity>
               <com:SkillGroupName>Vertical Expertise</com:SkillGroupName>
            </req:SkillGroupIdentity>
         </pws:serviceRequest>
      </pws:PwsGetSkillList>
   </soapenv:Body>
</soapenv:Envelope>

...

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.

Skills

PwsSkillSummaryElement[]

This contains the basic set of information about a skilleach of the returned skills. 


Response Usage Example(s)

...