Overview

This web service allows users to set the role type sort order by moving a role type up or down the on the role type list.

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

PwsSetRoleTypeSortOrder Request

PwsSetRoleTypeSortOrder
- serviceRequest: PwsSetRoleTypeSortOrderRq
  - RequestId: Int32
  - SessionTicket: String
  - Direction: Int16
  - RoleTypeIdentity: PwsRoleTypeRef
  - SkipInactiveFlag: Boolean
  - SortOrder: Int16
  - Timestamp: String

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	AS/RAku1pN9F58A3WQh3aw==
Direction	Int16	Either "Direction" OR "SortOrder" must be specified		The direction and slots in which the Role Type should be moved (i.e. +1 = 1 up, -1 = 1 down)	1
RoleTypeIdentity	PwsRoleTypeRef	Yes		This structure uniquely identifies the role type that is being moved
SkipInactiveFlag	Boolean	Yes	false	If set to 'true' any inactive role types will be skipped in calculating the position of the role type being moved	false
SortOrder	Int16	Either "Direction" OR "SortOrder" must be specified		The sort order of the role type, among the role types defined for the account.
Timestamp	String	No		This is a Base64 encoded timestamp optionally utilized for user locking.

Request Usage Example(s)

Request Example

<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:PwsSetRoleTypeSortOrder>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AS/RAku1pN9F58A3WQh3aw==</req:SessionTicket>
            <req:Direction>1</req:Direction>
            <req:RoleTypeIdentity>
               <com:RoleTypeName>Sales - USA</com:RoleTypeName>
            </req:RoleTypeIdentity>
            <req:SkipInactiveFlag>false</req:SkipInactiveFlag>
         </pws:serviceRequest>
      </pws:PwsSetRoleTypeSortOrder>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSetRoleTypeSortOrder Response

PwsSetRoleTypeSortOrderResponse
- PwsSetRoleTypeSortOrderResult: PwsSetRoleTypeSortOrderRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Timestamp: String

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information.	1
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information	2022-10-21T15:13:35.9789888Z
Timestamp	String	This is a Base64 encoded timestamp optionally utilized for user locking.

Response Usage Example(s)

Response Example

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSetRoleTypeSortOrderResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSetRoleTypeSortOrderResult 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2022-10-21T15:13:35.9789888Z</ServerTimestampUtc>
            <a:Timestamp>AAAAACA3Ilg=</a:Timestamp>
         </PwsSetRoleTypeSortOrderResult>
      </PwsSetRoleTypeSortOrderResponse>
   </s:Body>
</s:Envelope>

PwsRoleTypeSortOrder - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

API Documentation

PwsSetRoleTypeSortOrder

Analytics