/
PwsGetSkillGroupList

PwsGetSkillGroupList

Overview


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

  • QueryString: Searches within skill group name. Any skill group containing this string in the skill group name is included.
  • IncludeInactiveFlag: If false, inactive skill groups (skill groups that contain no active skills) are excluded from the results.
  • SkillGroupIdentity: If specified, only the specified skill group is included. Note QueryString and IncludeInactiveFlag are ignored if SkillGroupIdentity is specified.


Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


PwsGetSkillGroupList 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 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)


Example 01
<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>
Example 02
<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>

         </pws:serviceRequest>
      </pws:PwsGetSkillGroupList>
   </soapenv:Body>
</soapenv:Envelope>


Response Format


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.

SkillGroups

PwsSkillGroupSummaryElement[]

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

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetSkillGroupListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetSkillGroupListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Message 136: This request was executed against the Staging [appst.projectorpsa.com] environment.</b:AdditionalErrorText>
                  <b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
                  <b:ErrorNumber>136</b:ErrorNumber>
                  <b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
                  <b:Type>Information</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2023-01-11T21:45:14.2727423Z</ServerTimestampUtc>
            <a:SkillGroups xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsSkillGroupSummaryElement>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:SkillGroupSummary>
                     <b:SkillGroupId i:nil="true"/>
                     <b:SkillGroupName>Technology</b:SkillGroupName>
                     <b:SkillGroupUid>1152921504606850400</b:SkillGroupUid>
                  </b:SkillGroupSummary>
               </b:PwsSkillGroupSummaryElement>
            </a:SkillGroups>
         </PwsGetSkillGroupListResult>
      </PwsGetSkillGroupListResponse>
   </s:Body>
</s:Envelope>
Example 02
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetSkillGroupListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetSkillGroupListResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsMessage>
                  <b:AdditionalErrorText i:nil="true"/>
                  <b:ErrorCode>RowCountExceeded</b:ErrorCode>
                  <b:ErrorNumber>104</b:ErrorNumber>
                  <b:ErrorText>Not all data rows were returned by this request because the specified row count was smaller than the total number of rows available.</b:ErrorText>
                  <b:Type>Warning</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
               <b:PwsMessage>
                  <b:AdditionalErrorText>Message 136: This request was executed against the Staging [appst.projectorpsa.com] environment.</b:AdditionalErrorText>
                  <b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
                  <b:ErrorNumber>136</b:ErrorNumber>
                  <b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
                  <b:Type>Information</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2023-01-11T21:48:44.596272Z</ServerTimestampUtc>
            <a:SkillGroups xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsSkillGroupSummaryElement>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:SkillGroupSummary>
                     <b:SkillGroupId i:nil="true"/>
                     <b:SkillGroupName>Technology</b:SkillGroupName>
                     <b:SkillGroupUid>1152921504606850400</b:SkillGroupUid>
                  </b:SkillGroupSummary>
               </b:PwsSkillGroupSummaryElement>
               <b:PwsSkillGroupSummaryElement>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:SkillGroupSummary>
                     <b:SkillGroupId i:nil="true"/>
                     <b:SkillGroupName>Certification</b:SkillGroupName>
                     <b:SkillGroupUid>1152921504606850615</b:SkillGroupUid>
                  </b:SkillGroupSummary>
               </b:PwsSkillGroupSummaryElement>
            </a:SkillGroups>
         </PwsGetSkillGroupListResult>
      </PwsGetSkillGroupListResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

ErrorNumberErrorCodeErrorText
50024EntityNotFoundSkill Group was not found. Another user may have deleted it.

Related content