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
- serviceRequest: PwsSetSkillGroupSortOrderRq
- RequestId: Int32
- SessionTicket: String
- Direction: Int16
- SkillGroupIdentity: PwsSkillGroupRef
- SkillVersionStamp: Int32
- SkipInactiveFlag: Boolean
- SortOrder: Int16
- serviceRequest: PwsSetSkillGroupSortOrderRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
Int32 | No | Click here for more information. | |||
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 | 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)
Response Format
- PwsSetSkillGroupSortOrderResponse
- PwsSetSkillGroupSortOrderResult: PwsSetSkillGroupSortOrderRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- SkillVersionStamp: Int32
- PwsSetSkillGroupSortOrderResult: PwsSetSkillGroupSortOrderRs
Response Elements
Element | Data Type | Description |
---|---|---|
Messages | The web service response status and message. Click here for more information | |
Int32 | Click here for more information. | |
RequestStatus | Click here for more information | |
DateTime | Click here for more information. | |
SkillVersionStamp | Int32 | The new skill version stamp. |
Response Usage Example(s)
Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
50007 | ItemHasBeenUpdated | Unable to complete request -- another user changed the data while you were editing. |