Overview

This web service deletes a specified expense document cost card (PwsCostCardRef).

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

PwsDeleteExpenseDocumentCostCard Request

PwsDeleteExpenseDocumentCostCard
- serviceRequest: PwsDeleteExpenseDocumentCostCardRq
  - RequestId: Int32
  - SessionTicket: String
  - Comments: String (255)
  - CostCardIdentity: PwsCostCardRef
  - ExpenseDocumentIdentity: PwsExpenseDocumentRef
  - ExpenseDocumentTimestamp: String
  - ResourceIdentity: PwsResourceRef (deprecated)

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.	AUL1Tsqbhar4SWXC5j9T+w==
Comments	String (255)	No	Cost Card deletion comments	Request 01
CostCardIdentity	PwsCostCardRef	Yes	The cost card identity to be deleted
ExpenseDocumentIdentity	PwsExpenseDocumentRef	Yes	The expense document the cost card resides under
ExpenseDocumentTimestamp	String	No	This is a Base64 encoded timestamp utilized for expense document locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsGetExpenseDocument. This will cause the request to fail if any change has been made between invocations of PwsGetExpenseDocument and PwsDeleteExpenseDocumentCostCard.
ResourceIdentity	PwsResourceRef	No	** This field has been deprecated

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:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteExpenseDocumentCostCard>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AUL1Tsqbhar4SWXC5j9T+w==</req:SessionTicket>
            <tim:Comments>Request 01</tim:Comments>
            <tim:CostCardIdentity>
               <com:CostCardUid>1152921504614515300</com:CostCardUid>
            </tim:CostCardIdentity>
            <tim:ExpenseDocumentIdentity>
               <com:DocumentNumber>ER00722</com:DocumentNumber>
            </tim:ExpenseDocumentIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteExpenseDocumentCostCard>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteExpenseDocumentCostCard Response

PwsDeleteExpenseDocumentCostCardResponse
- PwsDeleteExpenseDocumentCostCardResult: PwsDeleteExpenseDocumentCostCardRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ExpenseDocumentTimestamp: String

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-03-01T16:07:45.595844Z
ExpenseDocumentTimestamp	String	This is a Base64 encoded timestamp utilized for expense document locking.	AAAAAA64Ku8=

Response Usage Example(s)

Exampe 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteExpenseDocumentCostCardResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteExpenseDocumentCostCardResult 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/">2018-03-01T16:07:45.595844Z</ServerTimestampUtc>
            <a:ExpenseDocumentTimestamp>AAAAAA64Ku8=</a:ExpenseDocumentTimestamp>
         </PwsDeleteExpenseDocumentCostCardResult>
      </PwsDeleteExpenseDocumentCostCardResponse>
   </s:Body>
</s:Envelope>

PwsDeleteExpenseDocumentCostCard - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
19024	CostCardNotSpecifiedForDelete	A specified engagement identity was incomplete. Each engagement identity must specify either an engagement id, and engagement uid or an engagement code.
19037	ExpenseDocumentNotSpecifiedForDeleteCostCard	Expense document identity is required.
65200	CostCardHasBeenChanged	Cost card has been changed by another user.
65374	CostCardHasBeenDeleted	One or more referenced cost card(s) have been deleted.
65489	CostCardRefInvalid	CostCardRef is required
65491	CostCardNotFound	CostCard not found
65672	OneOrMoreCostCardsCannotBeDeleted	One or more cost cards cannot be deleted.