Overview

This web service retrieves a list of project rate types (PwsProjectProjectRateTypes), based upon a list of unique project identifiers (PwsProjectRef).

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

PwsGetProjectRateTypes
- serviceRequest: PwsGetProjectRateTypesRq
  - RequestId: Int32
  - SessioniTicket: String
  - ProjectIdentities: PwsProjectRef [1-100]

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.	`1`
SessionTicket	String	Yes	Click here for more information.	`ATUC0KEAX/LXdlo0d76EoQ==`
ProjectIdentities	PwsProjectRef [1-100]	Yes	This structure represents the unique key fields associated with identifying a project. Projects can be identified by ProjectCode or ProjectUid. When specifying a PwsProjectRef as an input to a web service, you may specify one or both the ProjectCode and/or ProjectUid. However, if you do specify both, they must both refer to the same project or the project reference will not be considered valid. When a PwsProjectRef is returned in the response to a web service, both the ProjectCode and ProjectUid will be populated, and guaranteed to refer to a single project.

Request Usage Example(s)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetProjectRateTypes>
        <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>ATUC0KEAX/LXdlo0d76EoQ==</req:SessionTicket>
            <sch:ProjectIdentities>
               <com:PwsProjectRef>
                  <com:ProjectCode>E001057-P001</com:ProjectCode>
               </com:PwsProjectRef>
            </sch:ProjectIdentities>
         </pws:serviceRequest>
      </pws:PwsGetProjectRateTypes>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetProjectRateTypesResponse

PwsGetProjectRateTypesResult: PwsGetProjectRateTypesRs
- Messages: PwsMessage [1-100]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- RateTypesByProject: PwsProjectProjectRateTypes

Response Elements

Element	Data Type	Description	Sample Data

Element	Data Type	Description	Sample Data
Messages	PwsMessage [1-100]	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information.	`1`
Status	RequestStatus	Result of this request. Click here for more information.	`Ok`
ServerTimestampUtc	DateTime	This is the UTC time when request completes. Click here for more information.	`2024-10-11T16:10:12.8606346Z`
RateTypesByProject	PwsProjectRateTypeRef	This structure represents the unique key fields associated with identifying a project rate type.

Response Usage Example(s)

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectRateTypesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectRateTypesResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" 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:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2024-10-11T16:10:12.8606346Z</ServerTimestampUtc>
            <a:RateTypesByProject xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsProjectProjectRateTypes>
                  <b:ProjectIdentity>
                     <b:ProjectCode>E001057-P001</b:ProjectCode>
                     <b:ProjectId i:nil="true"/>
                     <b:ProjectUid>1152921504607670227</b:ProjectUid>
                  </b:ProjectIdentity>
                  <b:ProjectRateTypes>
                     <b:PwsProjectRateTypeElement>
                        <b:ProjectRateTypeDetail>
                           <b:ExternalSystemIdentifier>20</b:ExternalSystemIdentifier>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607828299</b:ProjectRateTypeUid>
                           <b:ProjectRateTypeName>Not Chargeable</b:ProjectRateTypeName>
                           <b:BillingAdjustedDiscountPercent i:nil="true"/>
                           <b:BillingAdjustedHourlyRate>0</b:BillingAdjustedHourlyRate>
                           <b:ContractDiscountPercent i:nil="true"/>
                           <b:ContractHourlyRate>0</b:ContractHourlyRate>
                           <b:SortOrder>1</b:SortOrder>
                           <b:StandardRateTypeIdentity>
                              <b:StandardRateTypeCode>NC</b:StandardRateTypeCode>
                              <b:StandardRateTypeId i:nil="true"/>
                              <b:StandardRateTypeName>Not Chargeable</b:StandardRateTypeName>
                              <b:StandardRateTypeUid>1152921504606847726</b:StandardRateTypeUid>
                           </b:StandardRateTypeIdentity>
                           <b:NewExternalSystemIdentifier i:nil="true"/>
                        </b:ProjectRateTypeDetail>
                     </b:PwsProjectRateTypeElement>
                     <b:PwsProjectRateTypeElement>
                        <b:ProjectRateTypeDetail>
                           <b:ExternalSystemIdentifier>30</b:ExternalSystemIdentifier>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607828300</b:ProjectRateTypeUid>
                           <b:ProjectRateTypeName>Overtime (1.5x)</b:ProjectRateTypeName>
                           <b:BillingAdjustedDiscountPercent i:nil="true"/>
                           <b:BillingAdjustedHourlyRate>150</b:BillingAdjustedHourlyRate>
                           <b:ContractDiscountPercent i:nil="true"/>
                           <b:ContractHourlyRate>150</b:ContractHourlyRate>
                           <b:SortOrder>2</b:SortOrder>
                           <b:StandardRateTypeIdentity>
                              <b:StandardRateTypeCode>OT1.5</b:StandardRateTypeCode>
                              <b:StandardRateTypeId i:nil="true"/>
                              <b:StandardRateTypeName>Overtime (1.5x)</b:StandardRateTypeName>
                              <b:StandardRateTypeUid>1152921504606847727</b:StandardRateTypeUid>
                           </b:StandardRateTypeIdentity>
                           <b:NewExternalSystemIdentifier i:nil="true"/>
                        </b:ProjectRateTypeDetail>
                     </b:PwsProjectRateTypeElement>
                     <b:PwsProjectRateTypeElement>
                        <b:ProjectRateTypeDetail>
                           <b:ExternalSystemIdentifier>40</b:ExternalSystemIdentifier>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607828301</b:ProjectRateTypeUid>
                           <b:ProjectRateTypeName>Overtime (2x)</b:ProjectRateTypeName>
                           <b:BillingAdjustedDiscountPercent i:nil="true"/>
                           <b:BillingAdjustedHourlyRate>200</b:BillingAdjustedHourlyRate>
                           <b:ContractDiscountPercent i:nil="true"/>
                           <b:ContractHourlyRate>200</b:ContractHourlyRate>
                           <b:SortOrder>3</b:SortOrder>
                           <b:StandardRateTypeIdentity>
                              <b:StandardRateTypeCode>OT2</b:StandardRateTypeCode>
                              <b:StandardRateTypeId i:nil="true"/>
                              <b:StandardRateTypeName>Overtime (2x)</b:StandardRateTypeName>
                              <b:StandardRateTypeUid>1152921504606847728</b:StandardRateTypeUid>
                           </b:StandardRateTypeIdentity>
                           <b:NewExternalSystemIdentifier i:nil="true"/>
                        </b:ProjectRateTypeDetail>
                     </b:PwsProjectRateTypeElement>
                     <b:PwsProjectRateTypeElement>
                        <b:ProjectRateTypeDetail>
                           <b:ExternalSystemIdentifier>10</b:ExternalSystemIdentifier>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607828298</b:ProjectRateTypeUid>
                           <b:ProjectRateTypeName>Regular</b:ProjectRateTypeName>
                           <b:BillingAdjustedDiscountPercent i:nil="true"/>
                           <b:BillingAdjustedHourlyRate>100</b:BillingAdjustedHourlyRate>
                           <b:ContractDiscountPercent i:nil="true"/>
                           <b:ContractHourlyRate>100</b:ContractHourlyRate>
                           <b:SortOrder>4</b:SortOrder>
                           <b:StandardRateTypeIdentity>
                              <b:StandardRateTypeCode>Reg</b:StandardRateTypeCode>
                              <b:StandardRateTypeId i:nil="true"/>
                              <b:StandardRateTypeName>Regular</b:StandardRateTypeName>
                              <b:StandardRateTypeUid>1152921504606847729</b:StandardRateTypeUid>
                           </b:StandardRateTypeIdentity>
                           <b:NewExternalSystemIdentifier i:nil="true"/>
                        </b:ProjectRateTypeDetail>
                     </b:PwsProjectRateTypeElement>
                     <b:PwsProjectRateTypeElement>
                        <b:ProjectRateTypeDetail>
                           <b:ExternalSystemIdentifier>50</b:ExternalSystemIdentifier>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607828302</b:ProjectRateTypeUid>
                           <b:ProjectRateTypeName>Special Rate</b:ProjectRateTypeName>
                           <b:BillingAdjustedDiscountPercent i:nil="true"/>
                           <b:BillingAdjustedHourlyRate>110</b:BillingAdjustedHourlyRate>
                           <b:ContractDiscountPercent i:nil="true"/>
                           <b:ContractHourlyRate>110</b:ContractHourlyRate>
                           <b:SortOrder>5</b:SortOrder>
                           <b:StandardRateTypeIdentity>
                              <b:StandardRateTypeCode>SR</b:StandardRateTypeCode>
                              <b:StandardRateTypeId i:nil="true"/>
                              <b:StandardRateTypeName>Special Rate</b:StandardRateTypeName>
                              <b:StandardRateTypeUid>1152921504606851133</b:StandardRateTypeUid>
                           </b:StandardRateTypeIdentity>
                           <b:NewExternalSystemIdentifier i:nil="true"/>
                        </b:ProjectRateTypeDetail>
                     </b:PwsProjectRateTypeElement>
                  </b:ProjectRateTypes>
               </b:PwsProjectProjectRateTypes>
            </a:RateTypesByProject>
         </PwsGetProjectRateTypesResult>
      </PwsGetProjectRateTypesResponse>
   </s:Body>
</s:Envelope>

PwsGetProjectRateTypes - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText

ErrorNumber	ErrorCode	ErrorText
105	AtLeastOneItemNotFound	At least one requested item was not found. The remaining items, if any, were returned.