PwsSetSkillGroupSortOrder

Overview

 This web service allows users to set the skill group sort order. The sort order can be set absolutely, or the skill group can be moved up or down in the list.

Request Format

PwsSetSkillGroupSortOrder Request
  • PwsSetSkillGroupSortOrder
    • serviceRequest: PwsSetSkillGroupSortOrderRq

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.


Direction

Int16

Either "Direction" OR "SortOrder" must be specified


If negative, skill is moved up one position; if positive, down one position. Omit to specify sort position absolutely.


SkillGroupIdentity

PwsSkillGroupRef

Yes


This identifies the skill group to be moved.


SkillVersionStamp

Int32

No


Version stamp for optimistic locking. Any time a skill or skill group is updated, this version stamp will be changed in the database. The PwsGetSkillGroup service returns this value, and if echoed back here, and it does not match the current version stamp, that indicates that the skill group or skill data has been changed. The request will fail.


SkipInactiveFlag

Boolean

No


If set to "true", the request will skip the inactive skill groups (skill groups with no active skills). Applies when using Direction to move the skill group up or down.    true

SortOrder

Int16

Either "Direction" OR "SortOrder" must be specified


The order of the skill group among the skill groups. The base order number is 1. 

3

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:PwsSetSkillGroupSortOrder>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AUQnUBfR4twqQVdcrh4+jA==</req:SessionTicket>
            <!--Optional:-->
            <!--req:Direction>+1</req:Direction-->
            <req:SkillGroupIdentity>
               <com:SkillGroupName>Technology</com:SkillGroupName>
            </req:SkillGroupIdentity>
            <!--Optional:-->
            <req:SortOrder>2</req:SortOrder>
         </pws:serviceRequest>
      </pws:PwsSetSkillGroupSortOrder>
   </soapenv:Body>
</soapenv:Envelope>


Response Format

PwsSetSkillGroupSortOrder 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.

SkillVersionStamp

Int32

The new skill version stamp.


Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSetSkillGroupSortOrderResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSetSkillGroupSortOrderResult 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-12T15:47:41.4754255Z</ServerTimestampUtc>
            <a:SkillVersionStamp>14</a:SkillVersionStamp>
         </PwsSetSkillGroupSortOrderResult>
      </PwsSetSkillGroupSortOrderResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

ErrorNumberErrorCodeErrorText
50007ItemHasBeenUpdatedUnable to complete request -- another user changed the data while you were editing.