Overview

This web service updates the approval workflow status for one or more cost cards.

Request Format

PwsSetCostCardApprovalWorkflowStatus Request

PwsSetCostCardApprovalWorkflowStatus
- serviceRequest: PwsSetCostCardApprovalWorkflowStatusRq
  - RequestId: Int32
  - SessionTicket: String
  - ApprovalWorkflowStatus: String
  - CostCardIdentities: PwsVersionedCostCardRef[]
  - RejectedReason: String
  - SendApprovalRejectionEmailFlag: Boolean

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.	AUmQP6quTuUK5v2QUR0fRw==
ApprovalWorkflowStatus	String	Yes		The approval workflow status 'D' for Draft 'R' for Rejected 'S' for Submitted 'A' for Approved	A
CostCardIdentities	PwsVersionedCostCardRef[]	Yes		This is the cost card identity or identities that will be updated with a new approval workflow status
RejectedReason	String	Yes (if the ApprovalWorkflowStatus is set to "R")		The reason the cost card was rejected. This is a required field if the ApprovalWorkflowStatus is set to "R".
SendApprovalRejectionEmailFlag	Boolean	No	false	If set to "true", an email will be sent informing the resource that the cost card has been rejected. Note: This is only applicable if the ApprovalWorkflowStatus is set to "R".

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:PwsSetCostCardApprovalWorkflowStatus>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AUmQP6quTuUK5v2QUR0fRw==</req:SessionTicket>
            <tim:ApprovalWorkflowStatus>A</tim:ApprovalWorkflowStatus>
            <tim:CostCardIdentities>
               <tim:PwsVersionedCostCardRef>
                  <com:CostCardUid>1152921504614151665</com:CostCardUid>
               </tim:PwsVersionedCostCardRef>
            </tim:CostCardIdentities>
         </pws:serviceRequest>
      </pws:PwsSetCostCardApprovalWorkflowStatus>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSetCostCardApprovalWorkflowStatus Response

PwsSetCostCardApprovalWorkflowStatusResponse
- PwsSetCostCardApprovalWorkflowStatusResult: PwsSetCostCardApprovalWorkflowStatusRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostCardIdentities: PwsCostCardRef[]

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	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-08-22T17:50:23.1025831Z
CostCardIdentities	PwsCostCardRef[]	The identity of the cost cards that have been updated.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSetCostCardApprovalWorkflowStatusResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSetCostCardApprovalWorkflowStatusResult 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-08-22T17:50:23.1025831Z</ServerTimestampUtc>
            <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCostCardRef>
                  <b:CostCardId i:nil="true"/>
                  <b:CostCardUid>1152921504614151665</b:CostCardUid>
                  <b:ReferenceId i:nil="true"/>
               </b:PwsCostCardRef>
            </a:CostCardIdentities>
         </PwsSetCostCardApprovalWorkflowStatusResult>
      </PwsSetCostCardApprovalWorkflowStatusResponse>
   </s:Body>
</s:Envelope>

PwsSetCostCardApprovalWorkflowStatus - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
19046	InvalidValueForCostCardApprovalWorkflowStatus	The specified value for cost card approval workflow status is invalid. Valid values are D for Draft, R for Rejected, S for Submitted and A for Approved.
19050	RejectedReasonRequiredWhenRejecting	A reject reason is required when rejecting cost cards.
65491	CostCardNotFound	CostCard not found
65723	StatusChangeCannotBeCompletedCostCardsChangedOrIneligible	Status change cannot be completed because one or more cards has changed or is ineligible.