Versions Compared

Key

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

Overview

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

  • QueryString: Searches within skill group name and skill name. Any skill group 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 skill groups (skill groups that contain no active skills) are excluded from the results.
  • SkillGroupIdentity: If specified, only skills in the specified skill group are is 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.

...

  • specified

...

  • .

Request Format

Panel
titlePwsGetSkillGroupList Request
  • PwsGetSkillGroupList

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

false

If set to 'true', skill groups that are

set to

considered inactive will be included in the results. Otherwise, only skill groups that are considered active will be included. Active skill groups contain at least one active skill.


MaxRowsToReturn

Int32

No


The maximum number of skill groups to be retrieved. This value is disregarded if a skill group is specified in SkillGroupIdentity.


QueryString

String



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


SkillGroupIdentity

PwsSkillGroupRef



If specified, return only the specified group.


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>

...

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.

SkillGroups

PwsSkillGroupSummaryElement[]

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


Response Usage Example(s)

...