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.

Format

PwsResourceTimeOffCard

PwsResourceTimeOffCard
- ReferenceId: String
- TimecardId: Int32
- TimecardType: String
- TimecardUid: Int64
- Description: String
- DescriptionClearFlag: Boolean
- RejectedByUser: PwsUserRef
- RejectedReason: String
- RejectedTimestamp: DateTime
- Status: TimeCardStatus *** deprecated ***
- WorkDate: DateTime
- WorkMinutes: Int32
- Timestamp: String
- CardStatus: String
- TimeOffReasonIdentity: PwsTimeOffReasonRef
- ResourceIdentity: PwsResourceRef

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	PwsUserRef	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		* 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	PwsTimeOffReasonRef	On Insert: Yes On Update: No		The time off reason associated with the time off card.
ResourceIdentity	PwsResourceRef	On Insert: Yes On Update: No		The resource associated with the time off card.

Usage Elements

Example 01

           <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>