Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This web service retrieves a an expense document cost cards card (PwsCostCardElement), based upon a unique cost card identifier  identifier (PwsCostCardRef), or an expense document (PwsExpenseDocumentRef), or a resource identity (PwsResourceRef).

Request Format


Panel
titlePwsGetExpenseDocumentCostCard Request

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.

AeB+IjyAtjb5x8rPrBUjXA==

CostCardIdentity

PwsCostCardRef

Yes


The cost card to be retrieved


ExpenseDocumentIdentity

PwsExpenseDocumentRef

Yes


The expense document associated with the cost card

(s)

. This must match the expense document of the specified cost card.


ResourceIdentity

PwsResourceRef

No

The resource associated with the cost card(s)


** This field has been deprecated.


Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<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:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetExpenseDocumentCostCard>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AeB+IjyAtjb5x8rPrBUjXA==</req:SessionTicket>
            <tim:CostCardIdentity>
               <com:CostCardUid>1152921504614515296</com:CostCardUid>
            </tim:CostCardIdentity>
            <tim:ExpenseDocumentIdentity>
               <com:DocumentNumber>ER00721</com:DocumentNumber>
               <com:ExpenseDocumentUid>1152921504607683575</com:ExpenseDocumentUid>
            </tim:ExpenseDocumentIdentity>
            <!--tim:ResourceIdentity>
               <com:ResourceDisplayName>Jack Spratt</com:ResourceDisplayName>
               <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
               <com:ResourceUid>1152921504607111573</com:ResourceUid>
            </tim:ResourceIdentity-->
         </pws:serviceRequest>
      </pws:PwsGetExpenseDocumentCostCard>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsGetExpenseDocumentCostCard 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

1

Status

RequestStatus

Click here for more information

Ok

ServerTimestampUtc

DateTime

Click here for more information

2018-02-27T16:18:08.8608287Z

CostCard

PwsCostCardElement

The complete set of information about a cost card (less any subordinate entities)


ExpenseDocumentTimestamp

String

This is a Base64 encoded timestamp utilized for expense document locking


Location

PwsLocationSummary

The location associatied with the cost card


Receipts

PwsReceiptDetail[]

The receipt(s) associated with the cost card


...


ErrorNumber

ErrorCode

ErrorText

19004ExpenseDocumentNotSpecifiedForRetrieveNo expense document was specified for retrieval.
19008CostCardNotSpecifiedForRetrieveNo cost card was specified for retrieval.