Put On Stop
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | clients.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Action | Yes | The action to perform | action=stop_on | |
| Identifier | Yes | Client ID or UUID | client=1/P0909 |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/clients.json?&version=6&action=stop_on&client=1/P0909
Example request (legacy username/password):
http://<SERVER>/jsonapi/clients.json?&version=6&action=stop_on&client=1/P0909&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "Organisation on stop flag changed. ",
"warningmessage": "",
"success": true
}