Overview

This web service retrieves a list of Role Types (PwsRoleTypeSummary), based on specified search criteria. The following parameters affect the list of role types retrieved:

QueryString: Find all role types matching specified string in the role type name.
IncludeInactiveFlag: If set to 'true', inactive role types will be included in the results. Otherwise, only role types that are considered active will be included.
RoleTypeIdentity: If specified, only the identified role type will be returned. QueryString and IncludeInativeFlag will be ignored.

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

PwsGetRoleTypeListRq

PwsGetRoleTypeListRq
- RequestId: Int32
- SessionTicket: String
- IncludeInactiveFlag: Boolean
- MaxRowsToReturn: Int32
- QueryString: String
- RoleTypeIdentity: PwsRoleTypeRef

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==
IncludeInactiveFlag	Boolean	No	false	If set to 'true', inactive role types will be included in the results. Otherwise, only role types that are considered active will be included.	true
MaxRowsToReturn	Int32	No		The maximum number of role types to be retrieved. This value is disregarded if a role type is specified in RoleTypeIdentity.	100
QueryString	String	No		A search string to narrow down the results. A role type will be included in the results if the search string matches the role type name. This value is disregarded if a project is specified in RoleTypeIdentity.
RoleTypeIdentity	PwsRoleTypeRef	No		May be specified to retrieve a single project summary. Click here for more information.

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:PwsGetRoleTypeList>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AS/RAku1pN9F58A3WQh3aw==</req:SessionTicket>
            <req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
            <req:MaxRowsToReturn>100</req:MaxRowsToReturn>
         </pws:serviceRequest>
      </pws:PwsGetRoleTypeList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetRoleTypeListRs

PwsGetRoleTypeListRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- RoleTypes: PwsRoleTypeSummary

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-21T17:18:58.7665125Z
RoleTypes	PwsRoleTypeSummary	The role type summary records that were fetched by the service. Click here for more information.

Response Usage Example(s)

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetRoleTypeListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetRoleTypeListResult 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-21T17:18:58.7665125Z</ServerTimestampUtc>
            <a:RoleTypes xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Administrator - USA</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846991</b:RoleTypeUid>
                  <b:Description>Administrator - USA</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Administrator - Canada</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847008</b:RoleTypeUid>
                  <b:Description>Administrator - Canada</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Administrator - Philippines</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847009</b:RoleTypeUid>
                  <b:Description>Administrator - Philippines</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Executive - USA</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846992</b:RoleTypeUid>
                  <b:Description>Executive - USA</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Executive - Canada</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846993</b:RoleTypeUid>
                  <b:Description>Executive - Canada</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Executive - Philippines</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846994</b:RoleTypeUid>
                  <b:Description>Executive - Philippines</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Subcontractor - OPA</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846980</b:RoleTypeUid>
                  <b:Description>Subcontractor - OPA</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Subcontractor - Disney</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846995</b:RoleTypeUid>
                  <b:Description>Subcontractor - Disney</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Sales - Canada</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846997</b:RoleTypeUid>
                  <b:Description>Sales - Canada</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Sales - Philippines</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846998</b:RoleTypeUid>
                  <b:Description>Sales - Philippines</b:Description>
                  <b:InactiveFlag>true</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>IT Team - USA</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846999</b:RoleTypeUid>
                  <b:Description>IT Team - USA</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>IT Team - Canada</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847000</b:RoleTypeUid>
                  <b:Description>IT Team - Canada</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Sales - USA</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606846996</b:RoleTypeUid>
                  <b:Description>Sales - USA</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>IT Team - Philippines</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847001</b:RoleTypeUid>
                  <b:Description>IT Team - Philippines</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Finance - USA</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847002</b:RoleTypeUid>
                  <b:Description>Finance - USA</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Finance - Canada</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847003</b:RoleTypeUid>
                  <b:Description>Finance - Canada</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Finance - Philippines</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847004</b:RoleTypeUid>
                  <b:Description>Finance - Philippines</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Management - USA</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847005</b:RoleTypeUid>
                  <b:Description>Management - USA</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Management - Canada</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847006</b:RoleTypeUid>
                  <b:Description>Management - Canada</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
               <b:PwsRoleTypeSummary>
                  <b:RoleTypeId i:nil="true"/>
                  <b:RoleTypeName>Management - Philippines</b:RoleTypeName>
                  <b:RoleTypeUid>1152921504606847007</b:RoleTypeUid>
                  <b:Description>Management - Philippines</b:Description>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsRoleTypeSummary>
            </a:RoleTypes>
         </PwsGetRoleTypeListResult>
      </PwsGetRoleTypeListResponse>
   </s:Body>
</s:Envelope>

PwsGetRoleTypeList - Common Errors and Warnings

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

API Documentation

PwsGetRoleTypeList

Analytics

Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsGetRoleTypeList - Common Errors and Warnings

Related content

PwsGetRoleTypeList

[data-colorid=zla06ovd9w]{color:#292a2e} html[data-color-mode=dark] [data-colorid=zla06ovd9w]{color:#d1d2d6}[data-colorid=wh30ppbnyy]{color:#292a2e} html[data-color-mode=dark] [data-colorid=wh30ppbnyy]{color:#d1d2d6}Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsGetRoleTypeList - Common Errors and Warnings

Related content

Overview