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.
...
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
ReferenceId | String |
No | Reference id (used to affiliate PwsSaveTimecardResult records with associated PwsTimeOffCardDetail records). |
TimecardId | Int32 |
No |
The time card Id is a unique identifier for a time card. For internal use only. |
| |
TimecardType | String |
No |
The time card type: 'T' for time card associated with a project 'R' for reported time off This will always be 'R' for PwsTimeOffCardDetail records. | R | |
TimecardUid | Int64 |
No | A unique and immutable identifier for a time card. | 1152921504608460883 | |
Description | String |
No |
The time off time card description. |
DescriptionClearFlag | Boolean |
No | If set to 'true', the time off time card description will be |
cleared. Applies when saving time off cards. | false |
RejectedByUser |
N/A |
The user who rejected the time off time |
card. Note: This is only applicable if the status = 'R' for rejected |
Ignored on save. | |
RejectedReason | String |
N/A | The reject reason associated with the time off time card. Note: This is only applicable if the status = 'R' for rejected |
Ignored on save. | |
RejectedTimestamp | DateTime |
N/A |
The date and time when the time off time card was rejected. Note: This is only applicable if the status = 'R' for rejected |
WorkDate
DateTime
Ignored on save. | |
Status | TimeCardStatus |
The status is similar to the CardStatus, but holds more information to enable proper UI treatment. The possible UI workflow statuses are:
- Draft
- Rejected
- Submitted
- Approved
- Draft-okay
- Draft-error
- remove-on-save
- Draft-save-UI-defective
- Draft-submit-UI-defective
Submitted*** This field has been deprecated. | |||||
WorkDate | DateTime | On Insert: Yes On Update: No | The work date associated with the time off time card (in UTC format). | 2018-03-06T00:00:00Z | |
WorkMinutes | Int32 |
On Insert: Yes On Update: No | The work minutes associated with the time |
card. | 480 |
Timestamp | String |
No |
This is a Base64 encoded timestamp optionally utilized for time card |
locking. | AAAAAA64Nlc= |
CardStatus | String |
N/A | The time card status 'D' for draft 'R' for rejected 'S' for submitted 'A' for approved 'B' for billed Ignored on save. | S | |
TimeOffReasonIdentity |
On Insert: Yes On Update: No | The identity of the time off reason associated with the time off time card |
. |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<a:PwsTimeOffCardDetail>
<ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">R</TimecardType>
<TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608460883</TimecardUid>
<a:Description i:nil="true"/>
<a:DescriptionClearFlag>false</a:DescriptionClearFlag>
<a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:RejectedReason i:nil="true"/>
<a:RejectedTimestamp i:nil="true"/>
<a:Status>Submitted</a:Status>
<a:WorkDate>2018-03-06T00:00:00Z</a:WorkDate>
<a:WorkMinutes>480</a:WorkMinutes>
<a:Timestamp>AAAAAA64Nlc=</a:Timestamp>
<a:CardStatus>S</a:CardStatus>
<a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:TimeOffReasonId i:nil="true"/>
<b:TimeOffReasonName>Vacation</b:TimeOffReasonName>
<b:TimeOffReasonUid>1152921504606858293</b:TimeOffReasonUid>
</a:TimeOffReasonIdentity>
</a:PwsTimeOffCardDetail> |