Overview

This web service retrieves a list of cost cards (PwsVersionedCostCardRef), based upon an external grouping identifier.

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

PwsGetCostCardsByExternalGroupingIdentifier
- serviceRequest: PwsGetCostCardsByExternalGroupingIdentifierRq
  - RequestId: Int32
  - SessionTicket: String
  - ExternalGroupingIdentifiers: Int32[]

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.	`AQAXIgeu3zqNKQ0tJ2+nww==`
ExternalGroupingIdentifiers	Int32[]	Yes	The external grouping identifier for one or more cost cards.	`1`

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:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetCostCardsByExternalGroupingIdentifier>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AQAXIgeu3zqNKQ0tJ2+nww==</req:SessionTicket>
            <tim:ExternalGroupingIdentifiers>
               <arr:int>1</arr:int>
            </tim:ExternalGroupingIdentifiers>
         </pws:serviceRequest>
      </pws:PwsGetCostCardsByExternalGroupingIdentifier>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetCostCardsByExternalGroupingIdentifierResponse
- PwsGetCostCardsByExternalGroupingIdentifierResult: PwsGetCostCardsByExternalGroupingIdentifierRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostCards: PwsVersionedCostCardRef[]

Response Elements

Element	Data Type	Description	Sample Data

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	`2025-02-10T19:59:05.9787755Z`
CostCards	PwsVersionedCostCardRef[]	This structure represents the unique key fields associated with identifying a Cost Card. Cost Cards can be identified with a CostCardUid.

Response Usage Example(s)

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetCostCardsByExternalGroupingIdentifierResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetCostCardsByExternalGroupingIdentifierResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2025-02-10T19:59:05.9787755Z</ServerTimestampUtc>
            <a:CostCards>
               <a:PwsVersionedCostCardRef>
                  <CostCardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <CostCardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504615064271</CostCardUid>
                  <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1</ReferenceId>
                  <a:Timestamp>AAAAABp6mnE=</a:Timestamp>
               </a:PwsVersionedCostCardRef>
            </a:CostCards>
         </PwsGetCostCardsByExternalGroupingIdentifierResult>
      </PwsGetCostCardsByExternalGroupingIdentifierResponse>
   </s:Body>
</s:Envelope>

PwsGetCostCardsByExternalGroupingIdentifier - Common Errors and Warnings

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

API Documentation

PwsGetCostCardsByExternalGroupingIdentifier