Overview
This structure contains the complete set of information about a time off time card. The structure is used both to retrieve detailed time off time card information and to pass information about a time off time card back to the server to get updated.
Format
- PwsTimeOffCardDetail
- ReferenceId: String
- TimecardId: Int32
- TimecardType: String
- TimecardUid: Int64
- Description: String (1000)
- DescriptionClearFlag: Boolean
- RejectedByUser: PwsUserRef
- RejectedReason: String
- RejectedTimestamp: DateTime
- Status: TimeCardStatus
- WorkDate: DateTime
- WorkMinutes: Int32
- Timestamp: String
- CardStatus: String
- TimeOffReasonIdentity: PwsTimeOffReasonRef
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
ReferenceId | String |
|
| Reference id (used to affiliate PwsSaveTimecardResult records with associated PwsTimeOffCardDetail records). |
|
TimecardId | Int32 |
|
| The time card Id is a unique identifier for a time card. For internal use only. |
|
TimecardType | String |
|
| The time card type: 'T' for time card associated with a project 'R' for reported time off | R |
TimecardUid | Int64 |
|
| A unique and immutable identifier for a time card | 1152921504608460883 |
Description | String |
|
| The time off time card description |
|
DescriptionClearFlag | Boolean |
|
| If set to 'true', the time off time card description will be cleared | false |
RejectedByUser |
|
| The user who rejected the time off time card Note: This is only applicable if the status = 'R' for rejected |
| |
RejectedReason | String |
|
| The reject reason associated with the time off time card Note: This is only applicable if the status = 'R' for rejected |
|
RejectedTimestamp | DateTime |
|
| The date and time when the time off time card was rejected Note: This is only applicable if the status = 'R' for rejected |
|
Status | TimeCardStatus |
|
| The status is similar to the CardStatus, but holds more information to enable proper UI treatment. The possible UI workflow statuses are:
| Submitted |
WorkDate | DateTime |
|
| The work date associated with the time off time card (in UTC format) | 2018-03-06T00:00:00Z |
WorkMinutes | Int32 |
|
| The work minutes associated with the time card | 480 |
Timestamp | String |
|
| This is a Base64 encoded timestamp optionally utilized for time card locking | AAAAAA64Nlc= |
CardStatus | String |
|
| The time card status 'D' for draft 'R' for rejected 'S' for submitted 'A' for approved 'B' for billed | S |
TimeOffReasonIdentity |
|
| The identity of the time off reason associated with the time off time card |
|