/displays/{id}
Retrieve detailed display information by ID, or updates the fields in the display (specified or all). Also allows you to delete display via DELETE method.
Adress: https://instance_name/api/v1.5/displays/{id}
Methods:
- GET — retrieve detailed display information by ID;
- PUT — update all display fields;
- PATCH — update some display fields.
- DELETE — delete display.
Content-type: application/json
- GET
- PUT
- PATCH
- DELETE
Path parameters
id string
Request example
curl –i –X GET
https://test.inspector-cloud.com/api/v1.5/displays/69/
-H ‘Authorization: Token <<your_token>>’
Response example
Response code: 200
{
"id": 69,
"name": "Н.НОВГОРОДПОВОЛЖЬЕ МАГНИТ РЦ ДЗЕРЖИНСК",
"planogram": 5,
"musthavelist": 4
}
Response definitions
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID.
musthavelist string
Must have list ID.
Path parameters
id string
Request body parameters
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID. Optional.
musthavelist string
Must have list ID. Optional.
Request example
curl –i –X PUT
https://test.inspector-cloud.com/api/v1.5/displays/69/
-H ‘Authorization: Token <<your_token>>’
-F "id=101" \
-F "name=КАРУСЕЛЬ 4000 Н.НОВГОРОД" \
-F "planogram=15" \
-F "musthavelist=3"
Response example
Response code: 200
{
"id": 101,
"name": "КАРУСЕЛЬ 4000 Н.НОВГОРОД",
"planogram": 15,
"musthavelist": 3
}
Path parameters
id string
Request example
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID. Optional.
musthavelist string
Must have list ID. Optional.
Request example
curl –i –X PATCH
https://test.inspector-cloud.com/api/v1.5/displays/69/
-H ‘Authorization: Token <<your_token>>’
-F "name=КАРУСЕЛЬ 4000 Н.НОВГОРОД" \
-F "planogram=15"
Response example
Response code: 200
{
"id": 69,
"name": "КАРУСЕЛЬ 4000 Н.НОВГОРОД",
"planogram": 15,
"musthavelist": 4
}
Path parameters
id string
Request example
curl –i –X DELETE
https://test.inspector-cloud.com/api/v1.5/displays/69/
-H ‘Authorization: Token <<your_token>>’
Response example
Response code: 200