Timercancelnormal
Parameter | Type | Description |
---|---|---|
[IN] Parameters described in Overview | ||
Action | String | [IN] Identifier for the list requested |
Input | String | [IN] timesheet entry number |
Response | XML/JSON | [OUT] An XML tree / JSON string containing the success or error response |
Description
Calling the timesheets API with an action of timercancelnormal cancels a paused timer for the timesheet entry no and retrieves a response containing the entry no for the timer cancelled, the current timer status for that entry no, the elapsed time (seconds) for the cancelled timer and the normal time previously entered. If the timer cancelled has zero time the entry no will be deleted and the response will contain variable_timesheettimerstatusnormal="DELETED"
Replace "normal" with "ot1" or "ot2" to access the overtime timers instead.
Return Values
Response – Success or error response.
The structure of the response is:
<Responses>
<Success>
<SuccessText/>
<Data>
<tspending_uuid>1FE31E624E78AD47AED0B162D48A642E</tspending_uuid>
</Data>
<Data>
<tspending_entryno>466</tspending_entryno>
</Data>
<Data>
<variable_timesheettimerstatusnormal__tspending_entryno>
ALLOWED
</variable_timesheettimerstatusnormal__tspending_entryno>
</Data>
<Data>
<variable_timesheettimerelapsednormal__tspending_entryno>
226
</variable_timesheettimerelapsednormal__tspending_entryno>
</Data>
</Success>
</Responses>
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"tspending_uuid": "90CB61F8DED2894FB469F1C9ED3BDE8F",
"tspending_entryno": 466,
"tspending_hoursnormal": 0.25,
"variable_timesheettimerelapsednormal__tspending_entryno": 0,
"variable_timesheettimerstatusnormal__tspending_entryno": "ALLOWED"
}
]
}