Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview


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

Request Format


PwsSetTimeCardApprovalWorkflowStatusRq

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.

Ad0gaqAh34T3anLQ/dUmpQ==

ApprovalWorkflowStatus

String(1)

Yes


The approval workflow status

D for Draft

R for Rejected

S for Submitted

A for Approved

R

RejectedReason

String

Yes (if the ApprovalWorkflowStatus is set to "R")


The reason the time card was rejected. This is a required field if the ApprovalWorkflowStatus is set to "R".

"Please review the date"

SendRejectionEmailFlag

Boolean

No

false

If set to "true", an email will be sent informing the resource that a time card has been rejected. Note: This is only applicable if the ApprovalWorkflowStatus is set to "R".

true

TimeCardIdentities

PwsVersionedTimecardRef[]

Yes


This is the time card identity or identities that will be updated with a new approval workflow status



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:PwsSetTimeCardApprovalWorkflowStatus>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AUmQP6quTuUK5v2QUR0fRw==</req:SessionTicket>
            <tim:ApprovalWorkflowStatus>R</tim:ApprovalWorkflowStatus>
            <tim:RejectedReason>Please review date</tim:RejectedReason>
            <tim:SendRejectionEmailFlag>true</tim:SendRejectionEmailFlag>
            <tim:TimeCardIdentities>
               <tim:PwsVersionedTimecardRef>
                  <com:TimecardType>T</com:TimecardType>
                  <com:TimecardUid>1152921504648551406</com:TimecardUid>
               </tim:PwsVersionedTimecardRef>
            </tim:TimeCardIdentities>
         </pws:serviceRequest>
      </pws:PwsSetTimeCardApprovalWorkflowStatus>
   </soapenv:Body>
</soapenv:Envelope>



Response Format


PwsSetTimeCardApprovalWorkflowStatusRs


Response Elements


Element

Data Type

Default

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-08-22T15:47:59.7075527Z

TimeCardIdentities

PwsTimeCardRef[]

 

 The identity of the time cards that have been updated.


Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSetTimeCardApprovalWorkflowStatusResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSetTimeCardApprovalWorkflowStatusResult 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-22T15:47:59.7075527Z</ServerTimestampUtc>
            <a:TimeCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsTimecardRef>
                  <b:ReferenceId i:nil="true"/>
                  <b:TimecardId i:nil="true"/>
                  <b:TimecardType>T</b:TimecardType>
                  <b:TimecardUid>1152921504648551406</b:TimecardUid>
               </b:PwsTimecardRef>
            </a:TimeCardIdentities>
         </PwsSetTimeCardApprovalWorkflowStatusResult>
      </PwsSetTimeCardApprovalWorkflowStatusResponse>
   </s:Body>
</s:Envelope>

PwsSetTimeCardApprovalWorkflowStatus - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

20050InvalidValueForTimeCardApprovalWorkflowStatusThe specified value for time card approval workflow status is invalid. Valid values are D for Draft, R for Rejected, S for Submitted, A for Approved, I for Invoiced (draft), B for Billed and M for Missing. Values of I, B and M are only valid when querying for existing data.
20051InvalidValueForTimeCardTypeThe specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off.
64222SpecifiedTimeCardDoesNotExistThe specified time card does not exist.
  • No labels