Overview
This structure contains the complete set of information about a time off card. The structure is used both to retrieve detailed time off card information and to pass information about a time off 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 PwsSaveTimeCardsAndRto records with associated PwsResourceTimeOffCard records). |
| ||
TimecardId | Int32 | No |
The time card Id is a unique identifier for a time off card. For internal use only. |
TimecardType | String | On Insert: Yes On Update: No |
The time card type: 'T' for time card associated with a project 'R' for reported time off In this case, the value will always be "R". | R | ||
TimecardUid | Int64 | On Insert: No On Update: Yes |
A unique and immutable identifier for a time off card | ||
Description | String | On Insert: No (unless the time card task type requires a description) On Update: No |
The time off card description. | Spring Vacation | |||
DescriptionClearFlag | Boolean | No | false | If set to 'true', the time off card description will be |
cleared. | false | |
RejectedByUser | On Insert: No (unless the status = 'R') On Update: No |
The user who rejected the time |
card. Note: This is only applicable if the status = 'R' for |
rejected. | ||
RejectedReason | String | On Insert: No (unless the status = 'R') On Update: No |
The reject reason associated with the time card. Note: This is only applicable if the status = 'R' for |
rejected. |
RejectedTimestamp | DateTime | On Insert: No (unless the status = 'R') On Update: No |
The date and time when the time card was rejected. Note: This is only applicable if the status = 'R' for |
rejected. | ||
Status | TimeCardStatus | On Insert: |
No On Update: No |
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 card. | 2018-03-15T00:00:00.000Z | ||
WorkMinutes | Int32 | On Insert: Yes On Update: No |
The work minutes associated with the time off |
card. | 480 | |
Timestamp | String | No |
This is a Base64 encoded timestamp optionally utilized for time off card |
locking. | ||
CardStatus | String | On Insert: Yes On Update: No |
The time card status: 'D' for draft 'R' for rejected 'S' for submitted 'A' for approved | S | ||
TimeOffReasonIdentity | On Insert: Yes On Update: No |
The time off reason associated with the time off card |
. | ||
ResourceIdentity | On Insert: Yes On Update: No |
The resource associated with the time off |
card. |
Usage Elements
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tim:SaveTimeOffCards>
<tim:PwsResourceTimeOffCard>
<com:TimecardType>R</com:TimecardType>
<tim:Description>Spring Vacation</tim:Description>
<tim:DescriptionClearFlag>false</tim:DescriptionClearFlag>
<tim:Status>Submitted</tim:Status>
<tim:WorkDate>2018-03-15T00:00:00.000Z</tim:WorkDate>
<tim:WorkMinutes>480</tim:WorkMinutes>
<tim:CardStatus>S</tim:CardStatus>
<tim:TimeOffReasonIdentity>
<com:TimeOffReasonName>Vacation</com:TimeOffReasonName>
</tim:TimeOffReasonIdentity>
<tim:ResourceIdentity>
<com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
</tim:ResourceIdentity>
</tim:PwsResourceTimeOffCard>
</tim:SaveTimeOffCards> |