Overview
This web service updates the approval workflow status for one or more time cards.
Request Format
- PwsSetTimeCardApprovalWorkflowStatusRq
- RequestId: Int32
- SessionTicket: String
- ApprovalWorkflowStatus: String
- RejectedReason: String
- SendRejectionEmailFlag: Boolean
- TimeCardIdentities: PwsVersionedTimecardRef[]
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 | Yes | This is the time card identity or identities that will be updated with a new approval workflow status |
Request Usage Example(s)
Response Format
- PwsSetTimeCardApprovalWorkflowStatusRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- TimeCardIdentities: PwsTimeCardRef[]
Response Elements
Element | Data Type | Default | Description | Sample Data |
---|---|---|---|---|
Messages |
| 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 |
| The identity of the time cards that have been updated. |
Response Usage Example(s)
PwsSetTimeCardApprovalWorkflowStatus - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
20050 | InvalidValueForTimeCardApprovalWorkflowStatus | The 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. |
20051 | InvalidValueForTimeCardType | The specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off. |
64222 | SpecifiedTimeCardDoesNotExist | The specified time card does not exist. |