Versions Compared

Key

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

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.

...

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)


Code Block
languagexml
titleRequest Example
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: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>

...

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)

...

...

ErrorNumber

...

ErrorCode

...