PwsTimeCardDetail

Owned by Bettina Borces
Last updated: Jun 19, 2018 by Luke Wright

Overview


This structure contains the complete set of information about a time card. The structure is used both to retrieve detailed time card information and to pass information about a time card back to the server to get created or updated.

Format


PwsTimecardDetail
  • PwsTimecardDetail
    • 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
    • LocationClearFlag: Boolean
    • LocationIdentity: PwsLocationRef
    • ProjectIdentity: PwsProjectRef
    • ProjectRateTypeIdentity: PwsProjectRateTypeRef
    • ProjectTaskIdentity: PwsProjectTaskRef
    • RoleClearFlag: Boolean
    • RoleIdentity: PwsProjectRoleRef
    • Udf1: PwsUserDefinedFieldDetail
    • Udf1ClearFlag: Boolean
    • Udf2: PwsUserDefinedFieldDetail
    • Udf2ClearFlag: Boolean
    • ExternalGroupingIdentifier: Int32
    • ExternalGroupingIdentifierClearFlag: Boolean

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ReferenceId

String

No


Reference id (used to affiliate PwsSaveTimecardResult records with associated PwsTimeCardDetail 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

T

TimecardUid

Int64

On Insert: No

On Update: Yes


A unique and immutable identifier for a time card.

1152921504646141261

Description

String (1000)

No (unless the time card task type or project requires a description)


The time card description.

Initial research

DescriptionClearFlag

Boolean

No

false 

If set to 'true', the time card description will be cleared.

false

RejectedByUser

PwsUserRef

Yes (if the status = 'R')


The user who rejected the time card 

Note: This is only applicable if the status = 'R' for rejected 


RejectedReason

String (255)

Yes (if the status = 'R')


The reject reason associated with the time card.

Note: This is only applicable if the status = 'R' for rejected 


RejectedTimestamp

DateTime

Yes (if the status = 'R')


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


*** deprecated ***


WorkDate

DateTime

On Insert: Yes

On Update: No


The work date associated with the time card.

2018-03-05T00: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.

AAAAAA64Niw=

CardStatus

String

On Insert: Yes

On Update: No


The time card status

'D' for draft

'R' for rejected

'S' for submitted

'A' for approved

'B' for billed

S

LocationClearFlag

Boolean

No

false

If set to 'true', the time card location is cleared.

false

LocationIdentity

PwsLocationRef

On Insert: No (unless locations are required for time cards in the installation)

On Update: No


The location associated with the time card.


ProjectIdentity

PwsProjectRef

On Insert: Yes

On Update: No


The project associated with the time card.


ProjectRateTypeIdentity

PwsProjectRateTypeRef

On Insert: Yes

On Update: No


The project rate type associated with the time card.


ProjectTaskIdentity

PwsProjectTaskRef

On Insert: Yes

On Update: No


The project task associated with the time card.


RoleClearFlag

Boolean

No

false 

If set to 'true', the time card project role is cleared.

false

RoleIdentity

PwsProjectRoleRef

On Insert: Yes

On Update: No


The project role associated with time card.


Udf1

PwsUserDefinedFieldDetail

On Insert: No (unless the time card task type requires Udf1)

On Update: No  


The first user defined field associated with the time card.


Udf1ClearFlag

Boolean

No

false 

If set to 'true', the first user defined field is cleared.

false

Udf2

PwsUserDefinedFieldDetail

On Insert: No (unless the time card task type requires Udf2)

On Update: No  



The second user defined field associated with the time card.


Udf2ClearFlag

Boolean

No


If set to 'true', the second user defined field is cleared.

false

ExternalGroupingIdentifier

Int32

No

false 

This unique identifier allows users to group multiple time cards together, most commonly user for reporting purposes.


ExternalGroupingIdentifierClearFlag

Boolean

No

false 

If set to 'true', the external grouping identifier is cleared.


Usage Example(s)


Example 01 
                     <a:PwsTimecardDetail>
                        <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/">T</TimecardType>
                        <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504646141261</TimecardUid>
                        <a:Description>Initial research</a:Description>
                        <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-05T00:00:00Z</a:WorkDate>
                        <a:WorkMinutes>480</a:WorkMinutes>
                        <a:Timestamp>AAAAAA64Niw=</a:Timestamp>
                        <a:CardStatus>S</a:CardStatus>
                        <a:LocationClearFlag>false</a:LocationClearFlag>
                        <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:LocationId i:nil="true"/>
                           <b:LocationName>USA</b:LocationName>
                           <b:LocationUid>1152921504606855985</b:LocationUid>
                        </a:LocationIdentity>
                        <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ProjectCode>P001395-001</b:ProjectCode>
                           <b:ProjectId i:nil="true"/>
                           <b:ProjectUid>1152921504607412209</b:ProjectUid>
                        </a:ProjectIdentity>
                        <a:ProjectRateTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid>
                        </a:ProjectRateTypeIdentity>
                        <a:ProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectTaskId i:nil="true"/>
                           <b:ProjectTaskUid>1152921504608644258</b:ProjectTaskUid>
                        </a:ProjectTaskIdentity>
                        <a:RoleClearFlag>false</a:RoleClearFlag>
                        <a:RoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRoleId i:nil="true"/>
                           <b:ProjectRoleUid>1152921504609522500</b:ProjectRoleUid>
                        </a:RoleIdentity>
                        <a:Udf1 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>TC-Jira</b:UdfName>
                           <b:UdfUid>1152921504606857618</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>P</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue>
                              <b:CodeValue>SD-23</b:CodeValue>
                              <b:TextValue>2 laptops for demo</b:TextValue>
                              <b:UidValue>10022</b:UidValue>
                           </b:RelationValue>
                        </a:Udf1>
                        <a:Udf1ClearFlag>false</a:Udf1ClearFlag>
                        <a:Udf2 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>TC-Zendesk</b:UdfName>
                           <b:UdfUid>1152921504606857619</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>P</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </a:Udf2>
                        <a:Udf2ClearFlag>false</a:Udf2ClearFlag>
                        <a:ExternalGroupingIdentifier i:nil="true"/>
                        <a:ExternalGroupingIdentifierClearFlag>false</a:ExternalGroupingIdentifierClearFlag>
                     </a:PwsTimecardDetail>