PwsGetRoleType

Overview


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

Request Format


PwsGetRoleTypeRq
  • 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)


Request
<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>


Response Format


PwsGetRoleTypeRs

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)


Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetRoleTypeResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetRoleTypeResult 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-21T18:23:01.5012354Z</ServerTimestampUtc>
            <a:RoleTypes xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsRoleTypeElement>
                  <b:RoleTypeDetail>
                     <b:RoleTypeId i:nil="true"/>
                     <b:RoleTypeName>Finance - USA</b:RoleTypeName>
                     <b:RoleTypeUid>1152921504606847002</b:RoleTypeUid>
                     <b:Description>A finance department is the unit of a business responsible for obtaining and handling any monies on behalf of the organization. The department controls the income and expenditure in addition to ensuring effective business running with minimum disruptions.</b:Description>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:AllocationFraction>1</b:AllocationFraction>
                     <b:BaseRatesOnTitleClearFlag>false</b:BaseRatesOnTitleClearFlag>
                     <b:BaseRatesOnTitleIdentity>
                        <b:DepartmentIdentity>
                           <b:DepartmentId i:nil="true"/>
                           <b:DepartmentName>Finance Team</b:DepartmentName>
                           <b:DepartmentUid>1152921504606854185</b:DepartmentUid>
                        </b:DepartmentIdentity>
                        <b:TitleId i:nil="true"/>
                        <b:TitleName>Level 3</b:TitleName>
                        <b:TitleUid>1152921504606876415</b:TitleUid>
                     </b:BaseRatesOnTitleIdentity>
                     <b:CostCenterCriteria xmlns:c="http://projectorpsa.com/CommonServices/">
                        <c:PwsCostCenterCriteria>
                           <c:CascadeFlag>false</c:CascadeFlag>
                           <c:CostCenterIdentity>
                              <b:CostCenterId i:nil="true"/>
                              <b:CostCenterName>Finance Team (USA)</b:CostCenterName>
                              <b:CostCenterNumber>Finance Team (USA)</b:CostCenterNumber>
                              <b:CostCenterUid>1152921504606867364</b:CostCenterUid>
                           </c:CostCenterIdentity>
                        </c:PwsCostCenterCriteria>
                     </b:CostCenterCriteria>
                     <b:CostCenterCriteriaClearFlag>false</b:CostCenterCriteriaClearFlag>
                     <b:CostCenterIdentity>
                        <b:CostCenterId i:nil="true"/>
                        <b:CostCenterName>Finance Team (USA)</b:CostCenterName>
                        <b:CostCenterNumber>Finance Team (USA)</b:CostCenterNumber>
                        <b:CostCenterUid>1152921504606867364</b:CostCenterUid>
                     </b:CostCenterIdentity>
                     <b:DescriptionClearFlag>false</b:DescriptionClearFlag>
                     <b:Keywords i:nil="true"/>
                     <b:KeywordsCriteriaClearFlag>false</b:KeywordsCriteriaClearFlag>
                     <b:LocationCriteriaClearFlag>false</b:LocationCriteriaClearFlag>
                     <b:LocationIdentities>
                        <b:PwsLocationRef>
                           <b:LocationId i:nil="true"/>
                           <b:LocationName>USA - Massachusetts</b:LocationName>
                           <b:LocationUid>1152921504606855985</b:LocationUid>
                        </b:PwsLocationRef>
                     </b:LocationIdentities>
                     <b:LocationIdentity>
                        <b:LocationId i:nil="true"/>
                        <b:LocationName>USA - Massachusetts</b:LocationName>
                        <b:LocationUid>1152921504606855985</b:LocationUid>
                     </b:LocationIdentity>
                     <b:NewRoleTypeName i:nil="true"/>
                     <b:ResourceTypeClearFlag>false</b:ResourceTypeClearFlag>
                     <b:ResourceTypeCriteriaClearFlag>false</b:ResourceTypeCriteriaClearFlag>
                     <b:ResourceTypeIdentities/>
                     <b:ResourceTypeIdentity>
                        <b:ResourceTypeCode>FTE</b:ResourceTypeCode>
                        <b:ResourceTypeId i:nil="true"/>
                        <b:ResourceTypeName>Full Time Employee</b:ResourceTypeName>
                        <b:ResourceTypeUid>1152921504606847348</b:ResourceTypeUid>
                     </b:ResourceTypeIdentity>
                     <b:SkillCriteria/>
                     <b:SkillCriteriaClearFlag>false</b:SkillCriteriaClearFlag>
                     <b:SortOrder>26</b:SortOrder>
                     <b:Timestamp>AAAAACA3IpM=</b:Timestamp>
                     <b:TitleCriteriaClearFlag>false</b:TitleCriteriaClearFlag>
                     <b:TitleIdentities>
                        <b:PwsTitleRef>
                           <b:DepartmentIdentity>
                              <b:DepartmentId i:nil="true"/>
                              <b:DepartmentName>Finance Team</b:DepartmentName>
                              <b:DepartmentUid>1152921504606854185</b:DepartmentUid>
                           </b:DepartmentIdentity>
                           <b:TitleId i:nil="true"/>
                           <b:TitleName>Level 1</b:TitleName>
                           <b:TitleUid>1152921504606875475</b:TitleUid>
                        </b:PwsTitleRef>
                        <b:PwsTitleRef>
                           <b:DepartmentIdentity>
                              <b:DepartmentId i:nil="true"/>
                              <b:DepartmentName>Finance Team</b:DepartmentName>
                              <b:DepartmentUid>1152921504606854185</b:DepartmentUid>
                           </b:DepartmentIdentity>
                           <b:TitleId i:nil="true"/>
                           <b:TitleName>Level 2</b:TitleName>
                           <b:TitleUid>1152921504606876414</b:TitleUid>
                        </b:PwsTitleRef>
                        <b:PwsTitleRef>
                           <b:DepartmentIdentity>
                              <b:DepartmentId i:nil="true"/>
                              <b:DepartmentName>Finance Team</b:DepartmentName>
                              <b:DepartmentUid>1152921504606854185</b:DepartmentUid>
                           </b:DepartmentIdentity>
                           <b:TitleId i:nil="true"/>
                           <b:TitleName>Level 3</b:TitleName>
                           <b:TitleUid>1152921504606876415</b:TitleUid>
                        </b:PwsTitleRef>
                     </b:TitleIdentities>
                     <b:TitleIdentity>
                        <b:DepartmentIdentity>
                           <b:DepartmentId i:nil="true"/>
                           <b:DepartmentName>Finance Team</b:DepartmentName>
                           <b:DepartmentUid>1152921504606854185</b:DepartmentUid>
                        </b:DepartmentIdentity>
                        <b:TitleId i:nil="true"/>
                        <b:TitleName>Level 1</b:TitleName>
                        <b:TitleUid>1152921504606875475</b:TitleUid>
                     </b:TitleIdentity>
                  </b:RoleTypeDetail>
               </b:PwsRoleTypeElement>
            </a:RoleTypes>
         </PwsGetRoleTypeResult>
      </PwsGetRoleTypeResponse>
   </s:Body>
</s:Envelope>


PwsGetRoleType - Common Errors and Warnings