| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | tspending.json | |
| General | Yes | Parameters described in overview | see overview | Structure of an API call |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | See below | |
| Identifier | Yes | TS pending ID | tspending=714 | |
| Input | Yes | JSON string | See below |
The action parameter is constructed as follows:
| Timer Action | Time Type | Action Parameter |
|---|---|---|
| Start | normal | timerstartnormal |
| ot1 | timerstartot1 | |
| ot2 | timerstartot2 | |
| Pause | normal | timerpausenormal |
| ot1 | timerpauseot1 | |
| ot2 | timerpauseot2 | |
| Resume | normal | timerresumenormal |
| ot1 | timerresumeot1 | |
| ot2 | timerresumeot2 | |
| Stop | normal | timerstopnormal |
| ot1 | timerstopot1 | |
| ot2 | timerstopot2 | |
| Cancel | normal | timercancelnormal |
| ot1 | timercancelot1 | |
| ot2 | timercancelot2 | |
| Discard | normal | timerdiscardnormal |
| ot1 | timerdiscardot1 | |
| ot2 | timerdiscardot2 | |
| Remove | normal | timerremovenormal |
| ot1 | timerremoveot1 | |
| ot2 | timerremoveot2 | |
| Elapsed | normal | timerelapsednormal |
| ot1 | timerelapsedot1 | |
| ot2 | timerelapsedot2 |
Example request:
http://<SERVER>/jsonapi/tspending.json?user=user&password=user&version=3.9&tspending=1023&action=timerstartnormal
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "",
"warningmessage": "",
"success": true,
"synapiversion": 3.8,
"data": [
{
"tspUuid": "235B775146784B1CBC8FAB6719F45873",
"tspEntryNo": 1023,
"tspTimerStartDateNormal": "2020-11-14",
"tspTimerStatusNormal": "RUNNING"
}
]
}