Versions Compared

Old Version 7

changes.mady.by.user Bettina Borces

Saved on

compared with

New Version Current

changes.mady.by.user Luke Wright

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This web service saves changes to time cards and time off cards. This service should be used to save changes to existing time cards or insert new time cards or to delete time cards. The service is written such that a failure to save or update a time card or time off card, will not prevent the saving of other changes, however any failure to save will prevent the submit from occurring, even if the service requests it. Individual errors processing time cards or time off cards are reported in the response.It can create new cards or update existing cards. Depending on the AbortOnFailureFlag setting, the service will either fail completely if any card cannot be saved (AbortOnFailureFlag = 'true'), or it will save the cards it is able to save successfully, and skip the others (AbortOnFailureFlag = 'false'). In either case, the response will include details of any errors. 

Request Format


Panel
titlePwsSaveTimeCardsAndRto Request
  • PwsSaveTimeCardsAndRto
    • serviceRequest: PwsSaveTimeCardsAndRtoRq
      • RequestId: Int32
      • SessionTicket: String
      • AdministratorComments: String
      • CalculateApproverFlag: Boolean *** deprecated ***
      • CalculateRevalueValuesFlag: Boolean *** deprecated ***
      • InsertIfNotFoundOnUpdateFlag: Boolean
      • PreserveTimeCardStatusFlag: Boolean  *** deprecated ***
      • SaveTimeCards: PwsResourceTimeCard[]
      • SaveTimeOffCards: PwsResourceTimeOffCard[]
      • SendNotificationEmailFlag: Boolean
      • AbortOnFailureFlag: Boolean

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32



Click here for more information.

1

SessionTicket

String



Click here for more information.

AdASLLZalvehjm71D72agw==

AdministratorComments

String



Administrator comments for entering time on behalf of others .

Save Time Cards or Reported Time Off

CalculateApproverFlag

Boolean

*** deprecated ***


*** deprecated ***


CalculateRevalueValuesFlag

Boolean

*** deprecated ***


*** deprecated *** 


InsertIfNotFoundOnUpdateFlag

Boolean


false 

If set to 'true', the specified time card if a card is encountered that attempt to update a time or time off time card details will be inserted as card that does not exist, a new time card or time off time card if it does not currently existcard wlil be inserted. Otherwise, this will trigger an error.

false 

PreserveTimeCardStatusFlag

Boolean

 *** deprecated ***


*** deprecated *** 


SaveTimeCards

PwsResourceTimecard[]



The details of the time card cards to be saved / updated.


SaveTimeOffCards

PwsResourceTimeOffCard[]



The details of the time off time card cards to be saved / updated .


SendNotificationEmailFlag

Boolean



If set to 'true', a notification email will be sent to the resource associated with the time card. This is applicable only when entering time on behalf of others.

false

AbortOnFailureFlag

Boolean



If set to 'true' a failure to save or update a time card or time off card, will prevent the saving of other changes.

true

Request Usage Example(s)

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

1

Status

RequestStatus

Click here for more information.

Ok 

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-14T14:42:01.0557418Z

TimeOffCardResults

PwsSaveTimeOffCardItemResult[]

The results from saving a time off card(or attempting to save) time off cards. For failed saves, this includes details on the specific error.


TimecardResults

PwsSaveTimecardItemResult[]

The results from saving a time off card(or attempting to save) time cards. For failed saves, this includes details on the specific error.


Response Usage Example(s)

...