Versions Compared

Key

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

Overview


This web service retrieves a list of role type element records, based upon a list of unique role type identifiers (PwsRoleTypeRef).


Info
titleRate 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


Panel
titlePwsGetRoleTypeRq
  • PwsGetRoleTypeRq
    • RequestId: Int32
    • SessionTicket: String
    • RoleTypeIdentities: PwsRoleTypeRef

Request Elements


Element

Data Type

Required?

Default

Description


RequestId

Int32

No


Click here for more information

1

SessionTicket

String

Yes


Click here for more information

AS/RAku1pN9F58A3WQh3aw==

RoleTypeIdentities

PwsRoleTypeRef[]

Yes


The identities of the role type to be retrieved


Request Usage Example(s)


Code Block
languagexml
titleRequest
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:PwsGetRoleType>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AS/RAku1pN9F58A3WQh3aw==</req:SessionTicket>
            <req:RoleTypeIdentities>
               <com:PwsRoleTypeRef>
                  <com:RoleTypeName>Finance - USA</com:RoleTypeName>
               </com:PwsRoleTypeRef>
            </req:RoleTypeIdentities>
         </pws:serviceRequest>
      </pws:PwsGetRoleType>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsGetRoleTypeRs

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-21T18:23:01.5012354Z

RoleTypes

PwsRoleTypeElement[]

The details of the projects that were fetched. Click here for more information.


Response Usage Example(s)

...