/
PwsGetContractLineItem

PwsGetContractLineItem

Owned by Bettina Borces
Last updated: about 10 hours ago

Overview


This web service retrieves a list of contract line item records (PwsContractLineItemElement), based upon a list of unique contract line item identifiers (PwsContractLineItemRef). 


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


PwsGetContractLineItem Request

Request Elements


Element

Data Type

Required?

Description

Sample Data

RequestId

Int32

No

Click here for more information.

1

SessionTicket

String

Yes 

Click here for more information.

Ad3Z5G23kLb35rVjXm+A3g==

ContractLineItemIdentities

PwsContractLineItemRef [1..100]

Yes

One or more (up to 100) contract line items to be retrieved.


Request Usage Example(s)


Example 01 
<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:PwsGetContractLineItem>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Ad3Z5G23kLb35rVjXm+A3g==</req:SessionTicket>
            <sch:ContractLineItemIdentities>
               <com:PwsContractLineItemRef>
                  <com:ContractLineItemCode>P001461-CL1</com:ContractLineItemCode>
               </com:PwsContractLineItemRef>
            </sch:ContractLineItemIdentities>
         </pws:serviceRequest>
      </pws:PwsGetContractLineItem>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetContractLineItem Response

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.


Status

RequestStatus

Click here for more information.


ServerTimestampUtc

DateTime

Click here for more information.


ContractLineItems

PwsContractLineItemElement [1..100]

The details of the contract line items that were fetched.


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetContractLineItemResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetContractLineItemResult 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/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-10-17T18:42:11.2996237Z</ServerTimestampUtc>
            <a:ContractLineItems xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsContractLineItemElement>
                  <b:ContractLineItemDetail>
                     <b:ContractLineItemCode>P001461-CL1</b:ContractLineItemCode>
                     <b:ContractLineItemId i:nil="true"/>
                     <b:ContractLineItemUid>1152921504607093184</b:ContractLineItemUid>
                     <b:ContractLineItemName>Web Services Contract Line Item</b:ContractLineItemName>
                     <b:EngagementIdentity>
                        <b:EngagementCode>P001461</b:EngagementCode>
                        <b:EngagementId i:nil="true"/>
                        <b:EngagementUid>1152921504607335359</b:EngagementUid>
                     </b:EngagementIdentity>
                     <b:CostContractTerms>C</b:CostContractTerms>
                     <b:DeferredRevenueOpeningBalanceEngCurrency>0</b:DeferredRevenueOpeningBalanceEngCurrency>
                     <b:DeferredRevenueOpeningBalanceEngGLCurrency>0</b:DeferredRevenueOpeningBalanceEngGLCurrency>
                     <b:HoldbackAmount i:nil="true"/>
                     <b:HoldbackPercent>0.1</b:HoldbackPercent>
                     <b:HoldbackType>P</b:HoldbackType>
                     <b:MaxCostContractAmount>5000</b:MaxCostContractAmount>
                     <b:MaxTimeContractAmount>100000</b:MaxTimeContractAmount>
                     <b:MinCostContractAmount i:nil="true"/>
                     <b:MinTimeContractAmount>100000</b:MinTimeContractAmount>
                     <b:RevenueEarnedByDate>2018-12-31T00:00:00Z</b:RevenueEarnedByDate>
                     <b:RevenueRecognitionMethod>P</b:RevenueRecognitionMethod>
                     <b:RevenueSchedule/>
                     <b:TimeContractTerms>F</b:TimeContractTerms>
                     <b:ContractTypeIdentity i:nil="true"/>
                     <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
                     <b:ModelContractedHoursAndOveragesFlag>false</b:ModelContractedHoursAndOveragesFlag>
                     <b:OverageProjectIdentity i:nil="true"/>
                     <b:PurchaseOrderNumber>PR-01</b:PurchaseOrderNumber>
                     <b:Timestamp>AAAAABCI2BI=</b:Timestamp>
                  </b:ContractLineItemDetail>
                  <b:LastFroTimeCardDate i:nil="true"/>
                  <b:LastRevenueRecognitionCutoffDate i:nil="true"/>
                  <b:Milestones/>
                  <b:RevenueCutoffDate>1753-01-01T00:00:00Z</b:RevenueCutoffDate>
               </b:PwsContractLineItemElement>
            </a:ContractLineItems>
         </PwsGetContractLineItemResult>
      </PwsGetContractLineItemResponse>
   </s:Body>
</s:Envelope>

PwsGetContractLineItem - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

105AtLeastOneItemNotFoundAt least one requested item was not found. The remaining items, if any, were returned.
54370NoPermissionToViewEngagementYou do not have appropriate permission to view this engagement.