Displays
Methods allow you to get a complete list or a specific display in Eyrene, view information about them, update all fields, or only select display fields. Also, you can delete the display by ID.
Retrieve a list of displays.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format.
- limitstringDescriptionNumber of results to return per page.
- offsetstringDescriptionThe initial index from which to return the results.
curl –i –X GET
https://test.eyrene.com/api/v1.5/displays/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
–F "limit=2" \
–F "offset=0" {
"count":2,
"next":"http://example.com",
"previous":null,
"results":[
{
"id":29,
"name":"Windmill , SIA, Veikals",
"musthavelist":null
},
{
"id":4,
"name":"SPARTAN.lv",
"musthavelist":6
},
{
"id":3,
"name":"Riela Latvia",
"musthavelist":5
},
{
"id":37,
"name":"Hermess",
"musthavelist":null
}
]
}Response parameters​
count integer
The number of displays.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about displays:
- id string Unique ID.
- name string Human-readable name.
- planogram string Planogram ID. Optional.
- musthavelist string Must-have list ID. Optional

Сreate a new display.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format.
- idstringDescriptionUnique ID.
- namestringDescriptionHuman-readable name.
- planogramstringDescriptionPlanogram ID.
- musthaveliststringDescriptionMust have list ID.
curl –i –X POST
https://test.eyrene.com/api/v1.5/displays/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
-F "id=458" \
-F "name=Hermess" \
-F "planogram=45" \
-F "musthavelist=5"{
"result": "CREATED"
}Retrieve detailed information about the display by ID.
- idstringrequiredDescriptionDisplay ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format.
curl –i –X GET
https://test.eyrene.com/api/v1.5/displays/69/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ {
"id":69,
"name":"Hermess",
"planogram":5,
"musthavelist":4
}Response parameters
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.

Update all fields of the display.


- idstringrequiredDescriptionDisplay ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format.
- idstringDescriptionUnique ID.
- namestringDescriptionHuman-readable name.
- planogramstringDescriptionPlanogram ID.
- musthaveliststringDescriptionMust have list ID.
curl –i –X PUT
https://test.inspector-cloud.com/api/v1.5/displays/69/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
-F "id=101" \
-F "name"="Hermess" \
-F "planogram"="15" \
-F "musthavelist"="3"{
"id":101,
"name":"Hermess",
"planogram":15,
"musthavelist":3
}​Response parameters
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.

Update some of the fields in the display.
- idstringrequiredDescriptionDisplay ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format.
- idstringDescriptionUnique ID.
- namestringDescriptionHuman-readable name.
- planogramstringDescriptionPlanogram ID.
- musthaveliststringDescriptionMust have list ID.
curl –i –X PATCH
https://test.eyrene.com/api/v1.5/displays/69/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
-F "name"="Hermess" \
-F "planogram"="15"{
"id":69,
"name":"Hermess",
"planogram":15,
"musthavelist":4
}Response parameters​

id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.

Delete display by ID.
- idstringrequiredDescriptionDisplay ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format.
curl –i –X DELETE
https://test.eyrene.com/api/v1.5/displays/69/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’{
"result":"OK"
}