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 | ||
|---|---|---|
| ||
|
...
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 | The details of the time card cards to be saved / updated. | ||||
SaveTimeOffCards | 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)
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-14T14:42:01.0557418Z |
TimeOffCardResults | 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 | 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)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 19093 | UnexpectedTimeCardType | Unexpected value for TimeCardType. Valid values are T or R. |
| 20001 | TimeCardStartDateRequired | The range start date must be specified. |
| 20002 | TimeCardEndDateRequired | The range end date must be specified. |
| 20003 | InvalidValueForTimeCardStartDate | The specified start date must be expressed as midnight UTC on the desired date. |
| 20004 | InvalidValueForTimeCardEndDate | The specified end date must be expressed as midnight UTC on the desired date. |
| 20028 | TimeCardErrors | One or more time cards or time off cards could not be saved. |
| 20033 | TimeCardIdentitiesRequired | One or more time card identities must be specified. |
| 20037 | TimeCardSplitPercentOutOfRange | The specified split percentage is out of range. Please specify a value greater than 0% and less than 100%. |
| 20050 | InvalidValueForTimeCardApprovalWorkflowStatus | The specified value for time card approval workflow status is invalid. Valid values are D for Draft, R for Rejected, S for Submitted, A for Approved, I for Invoiced (draft), B for Billed and M for Missing. Values of I, B and M are only valid when querying for existing data. |
| 20051 | InvalidValueForTimeCardType | The specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off. |
| 64161 | TimeCardResourceMismatch | The specified resource is not the same resource as is currently associated with the time card. |
| 64182 | TimecardHasBeenChanged | Time card has been changed by another user. |
| 64220 | InvalidTimeCard | A specified time card identity was incomplete. Each time card identity must specify either a time card id or time card uid. |
| 64222 | SpecifiedTimeCardDoesNotExist | The specified time card does not exist. |
| 64237 | UnexpectedErrorSavingTimeCard | There was an unexpected error while trying to save a time card. |
| 64239 | TimeCardWorkDateRequired | Work date is required for new time cards. |
| 64240 | InvalidValueForTimeCardWorkMinutes | The value specified for work minutes must be non-negative. |
| 64244 | UnableToUpdateTimeCard | This time card could not be updated. |
| 64294 | UnexpectedTimeCardUdfValue | Unexpected UDF value provided (UDF metadata may have changed) |
| 64295 | TimeCardWorkDateOutOfRange | Specified work date outside of supported date range. |
| 64299 | OneOrMoreTimeCardsNotFound | One or more time cards does not exist. |
| 64314 | CannotChangeStatusOfFroTimecards | Cannot change the status of for reporting only time cards. |
| 64318 | CannotChangeSubmittedTimecardsApClosed | Cannot save changes to submitted time card because the accounting period is closed for time. |
| 64332 | TimeCardHasBeenDeleted | Referenced time card is deleted. |
| 64333 | TimeOffCardHasBeenDeleted | Referenced time off card is deleted. |
| 64334 | SaveCardTimeCardHasBeenDeleted | Referenced time card is deleted. |
| 64335 | NoPermissionToSaveTimeCard | You do not have permission to save time card. |
| 64338 | SplitCardTimeCardHasBeenDeleted | Referenced time card is deleted. |
| 64340 | SubmitCardTimeCardHasBeenDeleted | Referenced time card is deleted. |