0% found this document useful (0 votes)

1 views143 pages

Api Documentation

The Public Store REST API documentation provides a comprehensive overview of various endpoints for managing jobs, items, labels, and display pages. It includes details on URI schemes, security requirements, and specific API paths for creating, updating, and deleting jobs related to configurations and displays. Additionally, the documentation outlines response codes and schemas for each endpoint, ensuring users can effectively interact with the API.

Uploaded by

casasfcasas

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

1 views143 pages

Api Documentation

Uploaded by

casasfcasas

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

Public Store REST API

Documentation
Overview
Public Store REST API Documentation

Contact information
Contact : Pricer
Contact Email : info@[Link]

URI scheme
Host : [Link]
BasePath : /

Tags
• Config API: Job : Endpoint to fetch, configure and schedule jobs

• Core API: Display Page : Endpoint for displaying pages

• Core API: Flash : Endpoint for flashing either a list of labels or the labels linked to a list of items.
Results can be fetched asynchronously using the flash-result endpoint. The results are
automatically purged 6 hours after request submission or during server restart, which ever
happens first.

• Core API: Flash result : Endpoint for fetching results of requests for flashing multiple labels or
items

• Core API: Item : Endpoint to fetch, add and update items

• Core API: Item result : Endpoint to fetch results of item delete requests and item update requests

• Core API: Label : Endpoint for labels

• Core API: Label result : Endpoint for fetching results of link requests

• Core API: Scheduled item updates : Endpoint to fetch scheduled item updates

• File API: Fonts : Endpoint to fetch, delete and add label and poster fonts

• File API: Images : Endpoint to upload images

• Infra API: Basestations : Endpoint to fetch, add and update basestations

• Infra API: LinkDepartments : Endpoint to fetch, add and update LinkDepartments

• Infra API: Transmission Zones : Endpoint to fetch, add and update transmission zones

• Map API : Endpoint providing various map operations

1
Consumes
• application/json

Produces
• application/json

Security
Bearer
Type : apiKey
Name : Authorization
In : HEADER

Paths
Get all jobs

GET /api/public/config/v1/jobs

Description

Fetches all configured jobs

Responses

HTTP
Description Schema
Code
<
200 OK ApiPublicConfigV1
Job > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

2
Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create a Disable Transceivers job

POST /api/public/config/v1/jobs/disable-transceivers

Parameters

Type Name Description Schema

ApiPublicConfigV1Jo
bPostRequest«ApiPu
job
Body Configuration of the job to create blicConfigV1JobDisa
required
bleTransceiversPost
Request»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

3
Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create or update a Disable Transceivers job

PUT /api/public/config/v1/jobs/disable-transceivers/{jobId}

Parameters

Type Name Description Schema

jobId The ID or External ID of the job to create or
Path string
required update

ApiPublicConfigV1Jo
bPutRequest«ApiPub
job
Body Configuration of the job to create or update licConfigV1JobDisabl
required
eTransceiversPostRe
quest»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

4
HTTP
Description Schema
Code
404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update specified Disable Transceivers job

PATCH /api/public/config/v1/jobs/disable-transceivers/{jobId}

Description

Updates one job based on ID or External ID

Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to update string
required

ApiPublicConfigV1Jo
bPatchRequest«ApiP
job
Body job ublicConfigV1JobDis
optional
ableTransceiversPat
chRequest»

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

5
HTTP
Description Schema
Code
204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create a new Display Page job for Graphical labels

POST /api/public/config/v1/jobs/display-page-graphical

Parameters

Type Name Description Schema

ApiPublicConfigV1Jo
bPostRequest«ApiPu
job
Body Configuration of the job to create blicConfigV1JobDisp
required
layPageGraphicalPos
tRequest»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

6
HTTP
Description Schema
Code
ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update or create specified Display Page job for

Graphical labels

PUT /api/public/config/v1/jobs/display-page-graphical/{jobId}

Description

Updates or creates one job based on ID or External ID

Parameters

Type Name Description Schema

jobId The ID or External ID of the job to create or
Path string
required update

7
Type Name Description Schema
ApiPublicConfigV1Jo
bPutRequest«ApiPub
job
Body job licConfigV1JobDispla
optional
yPageGraphicalPutR
equest»

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update specified Display Page job for Graphical labels

PATCH /api/public/config/v1/jobs/display-page-graphical/{jobId}

Description

Updates one job based on ID or External ID

8
Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to update string
required

ApiPublicConfigV1Jo
bPatchRequest«ApiP
job
Body job ublicConfigV1JobDis
optional
playPageGraphicalP
atchRequest»

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create a new Display Page job for Segment labels

POST /api/public/config/v1/jobs/display-page-segment

Parameters

9
Type Name Description Schema
ApiPublicConfigV1Jo
bPostRequest«ApiPu
job
Body Configuration of the job to create blicConfigV1JobDisp
required
layPageSegmentPost
Request»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create or update a Display Page job for Segment labels

PUT /api/public/config/v1/jobs/display-page-segment/{jobId}

Parameters

10
Type Name Description Schema
jobId
Path The ID or External ID of the job to fetch string
required

ApiPublicConfigV1Jo
bPutRequest«ApiPub
job
Body Configuration of the job to create or update licConfigV1JobDispla
required
yPageSegmentPutRe
quest»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update specified Display Page job for Segment labels

PATCH /api/public/config/v1/jobs/display-page-segment/{jobId}

11
Description

Updates one job based on ID or External ID

Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to fetch string
required

ApiPublicConfigV1Jo
bPatchRequest«ApiP
job
Body job ublicConfigV1JobDis
optional
playPageSegmentPat
chRequest»

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create a new Generate Report job

POST /api/public/config/v1/jobs/generate-report

12
Parameters

Type Name Description Schema

ApiPublicConfigV1Jo
bPostRequest«ApiPu
job
Body Configuration of the job to create blicConfigV1JobGen
required
erateReportPostReq
uest»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create or update a new Generate Report job

PUT /api/public/config/v1/jobs/generate-report/{jobId}

13
Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to update string
required

ApiPublicConfigV1Jo
bPutRequest«ApiPub
job
Body Configuration of the job to create or update licConfigV1JobGener
required
ateReportPutReques
t»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update specified Generate Report job

14
PATCH /api/public/config/v1/jobs/generate-report/{jobId}

Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to update string
required

ApiPublicConfigV1Jo
bPatchRequest«ApiP
job
Body Configuration of the job to create ublicConfigV1JobGe
required
nerateReportPatchR
equest»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

15
Create a new Refresh All Linked ESLs job

POST /api/public/config/v1/jobs/refresh

Parameters

Type Name Description Schema

ApiPublicConfigV1Jo
bPostRequest«ApiPu
job
Body Configuration of the job to create blicConfigV1JobRefr
required
eshAllLinkedEslsReq
uest»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

Unknown basicAuth

16
Create or update a new Refresh All Linked ESLs job

PUT /api/public/config/v1/jobs/refresh/{jobId}

Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to update string
required

ApiPublicConfigV1Jo
bPutRequest«ApiPub
job
Body Configuration of the job to create or update licConfigV1JobRefres
required
hAllLinkedEslsRequ
est»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
201 OK
JobResponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

17
Type Name
Unknown basicAuth

Update specified Refresh All Linked ESLs job

PATCH /api/public/config/v1/jobs/refresh/{jobId}

Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to update string
required

ApiPublicConfigV1Jo
bPatchRequest«ApiP
job
Body Configuration of the job to create ublicConfigV1JobRef
required
reshAllLinkedEslsRe
quest»

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
JobResponse

ApiPublicConfigV1
202 Accepted
JobResponse

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Config API: Job

18
Security

Type Name
apiKey Bearer

Unknown basicAuth

Get single job

GET /api/public/config/v1/jobs/{jobId}

Description

Fetches one job based on ID or External ID

Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to fetch string
required

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
Job

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Config API: Job

Security

19
Type Name
apiKey Bearer

Unknown basicAuth

Delete a job

DELETE /api/public/config/v1/jobs/{jobId}

Description

Deletes one job based on ID or External ID

Parameters

Type Name Description Schema

jobId
Path The ID or External ID of the job to delete string
required

Responses

HTTP
Description Schema
Code
ApiPublicConfigV1
200 OK
Job

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Config API: Job

Security

Type Name
apiKey Bearer

20
Type Name
Unknown basicAuth

Display page

POST /api/public/core/v1/display-page/labels

Description

Show specific info page on each label.

Parameters

Type Name Description Schema

Display page
The configuration parameters for the display ApiPublicCoreV1Dis
Body request
page request. playPageRequest
optional

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1D
200 OK isplayPageResultR
esponse

201 Created No Content

400 Not valid pricer label barcode, duration, action or priority No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Label not found No Content

500 Unable to locate label No Content

Tags

• Core API: Display Page

21
Security

Type Name Scopes

apiKey Bearer global

Get flash results

GET /api/public/core/v1/flash-result/items/{requestId}

Description

Fetches the result of a flash items request specified by requestId

Parameters

Type Name Description Schema

requestId The id of the flash items request to fetch results
Path string
required for

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1F
200 OK lashItemsResultRe
sponse

400 requestId must be an integer No Content

401 Unauthorized No Content

403 Forbidden No Content

404 A flash request with that id can not be found No Content

Tags

• Core API: Flash result

Security

22
Type Name
apiKey Bearer

Unknown basicAuth

Get flash results

GET /api/public/core/v1/flash-result/labels/{requestId}

Description

Fetches the result of a flash labels request specified by requestId

Parameters

Type Name Description Schema

requestId The id of the flash labels request to fetch results
Path string
required for

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1F
200 OK lashLabelsResultR
esponse

400 requestId must be an integer No Content

401 Unauthorized No Content

403 Forbidden No Content

404 A flash request with that id can not be found No Content

Tags

• Core API: Flash result

Security

23
Type Name
apiKey Bearer

Unknown basicAuth

Flash items

POST /api/public/core/v1/flash/items

Description

Flashes labels linked to items in provided list

Parameters

Type Name Description Schema

request The request, containing list of items and flash ApiPublicCoreV1Flas
Body
optional configuration. hItemsRequest

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1F
200 OK lashItemsRespons
e

201 Created No Content

400 Duration cannot exceed 30 minutes No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Flash

24
Security

Type Name
apiKey Bearer

Unknown basicAuth

Flash labels

POST /api/public/core/v1/flash/labels

Description

Flashes all labels in provided list

Parameters

Type Name Description Schema

request The request, containing list of labels and flash ApiPublicCoreV1Flas
Body
optional configuration. hLabelsRequest

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1F
200 OK lashItemsRespons
e

201 Created No Content

400 Duration cannot exceed 30 minutes No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

25
Tags

• Core API: Flash

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get multiple items

GET /api/public/core/v1/items

Description

Fetches many items (paginated)

Parameters

Type Name Description Schema Default

limit The amount, i.e. how many items will be
Query integer (int32) 1000
optional returned. Currently restricted to 1000.

Level of detail in the projection of an

item. <ul> <li> S includes: <ul>
<li>id</li> <li>name</li> <li>price</li> </ul>
</li> <li> M includes: <ul> <li>All of S</li>
projection <li>itemGroup</li> <li>department</li>
Query enum (S, M, L) "S"
optional <li>presentation</li> <li>lastUpdated</li>
<li>validFrom</li> <li>sics</li>
<li>properties</li> </ul> </li> <li> L
includes: <ul> <li>All of M</li> <li>links</li>
</ul> </li></ul>

The offset to start at, 0-based. For example,

start specifying the start value 1000 with a limit
Query integer (int32) 0
optional of 500 will return 500 items starting at
position 1000.

26
Responses

HTTP
Description Schema
Code
<
200 OK ApiPublicCoreV1It
em > array

400 Page size limit exceeded No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Delete a list of items

DELETE /api/public/core/v1/items

Description

Deletes a list of items by itemId. Returns an id to the asynchronous delete request, which can
be used to query the items-result endpoint.

Parameters

Type Name Description Schema

request ApiPublicCoreV1Del
Body request
required eteItemsRequest

27
Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK emUpdateRespons
e

ApiPublicCoreV1It
202 delete request accepted emUpdateRespons
e

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update or add multiple items

PATCH /api/public/core/v1/items

Description

Updates the items in the system with the provided list of items Existing items will be updated.
New items will be added. Only populated fields will be updated. null or empty fields will
not clear the corresponding field of existing [Link] an id to the asynchronous update
request, which can be used to query the items-result endpoint.

Parameters

28
Type Name Description Schema
<
items A list of items to patch the existing list of items
Body ApiPublicCoreV1Ite
required with.
m > array

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK emUpdateRespons
e

ApiPublicCoreV1It
202 Update request accepted emUpdateRespons
e

204 No Content No Content

400 Id missing on one or more items No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes

• application/json

Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get item delete results

29
GET /api/public/core/v1/items-delete-result/{requestId}

Description

Fetches the result of an delete request specified by requestId

Parameters

Type Name Description Schema Default

requestId The id of the item delete request to fetch
Path string
required results for

excludeItem
Optional parameter for excluding results
Query Results boolean "false"
for individual items
optional

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK emDeleteResultRe
sponse

400 requestId must be an integer No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Item result

Security

Type Name
apiKey Bearer

Unknown basicAuth

30
Get item update results

GET /api/public/core/v1/items-result/{requestId}

Description

Fetches the result of an update request specified by requestId

Parameters

Type Name Description Schema Default

requestId The id of the item update request to fetch
Path string
required results for

excludeItem
Optional parameter for excluding results
Query Results boolean "false"
for individual items
optional

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK emUpdateResultR
esponse

400 requestId must be an integer No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Item result

Security

Type Name
apiKey Bearer

31
Type Name
Unknown basicAuth

Get single item

GET /api/public/core/v1/items/{itemId}

Description

Fetches 1 item specified by itemId

Parameters

Type Name Description Schema Default

itemId
Path The id of the item to fetch string
required

Level of detail in the projection of an

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK
em

401 Unauthorized No Content

403 Forbidden No Content

404 Item not found No Content

32
Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Delete single item

DELETE /api/public/core/v1/items/{itemId}

Description

Deletes by itemId. Returns an id to the asynchronous delete request, which can be used to
query the items-result endpoint.

Parameters

Type Name Description Schema

itemId
Path The id of the item to delete string
required

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK emUpdateRespons
e

ApiPublicCoreV1It
202 delete request accepted emUpdateRespons
e

204 No Content No Content

401 Unauthorized No Content

33
HTTP
Description Schema
Code
403 Forbidden No Content

Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update or add single item

PATCH /api/public/core/v1/items/{itemId}

Description

Updates or adds the item specified by itemId. Only populated fields will be updated. null or
empty fields will not clear the corresponding field of the existing item. Returns an id to
the asynchronous update request, which can be used to query the items-result endpoint.

Parameters

Type Name Description Schema

itemId
Path The id of the item to update string
required

item ApiPublicCoreV1Ite
Body The item data to patch the existing item with.
required m

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK emUpdateRespons
e

34
HTTP
Description Schema
Code
ApiPublicCoreV1It
202 Update request accepted emUpdateRespons
e

204 No Content No Content

400 itemId Parameter mismatch No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Flash single item

POST /api/public/core/v1/items/{itemId}/flash

Description

Flash all labels, linked to a single item, that have the capability to flash. The response will contain
individual flash status for each label. Note that an empty list of labels in the response means that no
labels are linked to the specified item.

Parameters

Type Name Description Schema

itemId
Path The id of the item to flash string
optional

35
Type Name Description Schema
configuration The configuration parameters for the flash item ApiPublicCoreV1Flas
Body
optional request. hConfiguration

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1F
200 OK
lashItemResponse

201 Created No Content

400 Duration cannot exceed 30 minutes No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Item not found No Content

Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Unlink all labels with given item

DELETE /api/public/core/v1/items/{itemId}/links

Description

Unlink all labels, based on item id

36
Parameters

Type Name Description Schema

itemId
Path The item id to unlink string
optional

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1L
200 OK
abelResponse

204 No Content No Content

400 Not a valid tem id No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Item not found No Content

500 Unable to locate label No Content

Tags

• Core API: Item

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update item image for a page

POST /api/public/core/v1/items/{itemId}/page/{pageIndex}

37
Description

Update the image on the page of an item.

# Example usage, note the @ before the file path

curl
'[Link]
ge/0?resize=0' -F 'imageFile=@/path/to/[Link]'

This will upload the image to item 13 on page 0 without resizing, which in turn update all labels
that are displaying the given item.

Parameters

Type Name Description Schema

The id of the item of which to update the image.

If the item does not exist and

itemId
Path SystemParameters.ITEM_MUST_EXIST is true, an string
optional
error will be thrown. If the item does not exist
and SystemParameters.ITEM_MUST_EXIST is false,
the item will be created.

The index of the page of the item to update.

pageIndex Values are between 0 and 127 inclusive. If there
Path integer (int32)
optional is no such page for the given image size, an
error will be thrown.

Whether or not to resize the image. Valid values

If NO_RESIZE is selected, then at most one image

will be updated. For MAINTAIN_ASPECT_RATIO and
FORCED_FIT all the existing image item properties
for the given page will be updated. If the value
does not correspond to a valid option, an error
will be thrown.

38
Type Name Description Schema
FormDat imageFile
The raw image data file
a optional

Responses

HTTP
Description Schema
Code
The request was accepted.
ApiPublicCoreV1It
200 An object with a request id is returned, and you can use the request emUpdateRespons
id to check on the status of the request. See e
/api/public/core/v1/items-result/{requestId}.

201 Created No Content

There was an error in the request. See message field in the response
400 No Content
for details.

401 Missing or invalid authentication No Content

403 Forbidden No Content

404 Item does not exist, and ITEM_MUST_EXIST is set to true No Content

Unexpected internal server error. See message field in the response

500 No Content
for details.

Consumes

• multipart/form-data

Tags

• Core API: Item

Security

Type Name Scopes

apiKey Bearer global

39
Get all labels

GET /api/public/core/v1/labels

Description

Fetches all labels with links

Parameters

Type Name Description Schema Default

limit The amount, i.e. how many labels will be
Query integer (int32) 1000
optional returned.

Level of detail in the projection of an

label. <ul> <li> S includes: <ul>
<li>barcode</li> <li>modelName</li>
<li>plLocation</li> <li>links</li> </ul> </li>
<li> M includes: <ul> <li>All of S</li>
<li>plState</li> <li>batteryState</li>
<li>lowBatteryDate</li> </ul> </li> <li> L
includes: <ul> <li>All of M</li>
projection
Query <li>lastTrxList</li> enum (S, M, L) "S"
optional
<li>hardwareRevision</li>
<li>lastDisplayUpdate</li>
<li>batteryStateChanged</li>
<li>batteryStateLastConfirmed</li>
<li>batteryStateFirstEnteredLow</li>
<li>firstLinked</li> <li>lastLinked</li>
<li>lastUpdate</li> <li>lastOkUpdate</li>
</ul> </li></ul>

The offset to start at, 0-based. For example,

start specifying the start value 1000 with a limit
Query integer (int32) 0
optional of 500 will return 500 labels starting at
position 1000.

Responses

40
HTTP
Description Schema
Code
<
200 OK ApiPublicCoreV1L
abel > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Link labels

PATCH /api/public/core/v1/labels

Description

Link labels to items as per defined in the provided list Returns an id to the asynchronous
update request, which can be used to query the links-result endpoint.

Parameters

Type Name Description Schema

<
labels
Body A list of labels with links ApiPublicCoreV1Lab
required
el > array

41
Responses

HTTP
Description Schema
Code
ApiPublicCoreV1L
202 Accepted
abelResponse

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

500 Unable to save incoming request to disk No Content

Consumes

• application/json

Produces

• application/json

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get link results

GET /api/public/core/v1/labels-result/{requestId}

Description

Fetches the result of a link request specified by requestId

42
Parameters

Type Name Description Schema

requestId
Path The id of the link request to fetch results for string
optional

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1L
200 OK abelResultRespons
e

400 requestId must be an integer No Content

401 Unauthorized No Content

403 Forbidden No Content

404 A link request with that id can not be found No Content

Tags

• Core API: Label result

Security

Type Name
apiKey Bearer

Unknown basicAuth

Link a single label synchronously

POST /api/public/core/v1/labels/link-single

Description

This operation is synchronous and thereby bypasses the backoffice system and its queues.

43
Parameters

Type Name Description Schema Default

The timeout in milliseconds for how long to
wait for a synchronous response to the link
timeout
Query request. If the operation is not completed integer (int32) 500
optional
before the timeout is reached, PENDING
will be returned.

label A representation of the link that should be ApiPublicCoreV1Si

Body
optional created between an item and a label. ngleLinkRequest

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1L
200 OK
abelResult

201 Created No Content

400 Request must contain exactly one link No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

44
Get all models available and their compatible label
types

GET /api/public/core/v1/labels/models

Responses

HTTP
Description Schema
Code
ApiLabelModelRes
200 OK
ponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get all models available for specified barcode or label

type

GET /api/public/core/v1/labels/models/{barcodeOrLabelType}

Parameters

45
Type Name Description Schema
barcodeOrLab
Barcode of the label or the label type. As
Path elType string
example: '1318' or 'N4241010922213188'
optional

Responses

HTTP
Description Schema
Code
ApiLabelModelRes
200 OK
ponse

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get a label with specified barcode

GET /api/public/core/v1/labels/{barcode}

Description

Fetches the label with links

Parameters

46
Type Name Description Schema Default
barcode
Path barcode string
required

Level of detail in the projection of an

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1L
200 OK
abel

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

Tags

• Core API: Label

47
Security

Type Name
apiKey Bearer

Unknown basicAuth

Display page

POST /api/public/core/v1/labels/{barcode}/display-page

Description

Show specific info page on specified label.

Parameters

Type Name Description Schema

barcode
Path The barcode of the label string
optional

display page ApiPublicCoreV1Dis

The configuration parameters for the show page
Body request playPageConfigurati
request.
optional on

Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

400 Not a valid pricer label barcode No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Label not found No Content

48
Tags

• Core API: Label

Security

Type Name Scopes

apiKey Bearer global

Flash single label

POST /api/public/core/v1/labels/{barcode}/flash

Description

Flashes one label based on barcode

Parameters

Type Name Description Schema

barcode
Path The barcode of the label to flash string
optional

configuration The configuration parameters for the flash label ApiPublicCoreV1Flas

Body
optional request. hConfiguration

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1F
200 OK lashLabelRespons
e

201 Created No Content

400 Not a valid pricer label barcode No Content

401 Unauthorized No Content

403 Forbidden No Content

49
HTTP
Description Schema
Code
404 Label not found No Content

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Flash single label with department

POST /api/public/core/v1/labels/{barcode}/flash-with-department

Description

Flashes one label based on barcode

Parameters

Type Name Description Schema

barcode
Path The barcode of the label to flash string
optional

ApiPublicCoreV1Flas
configuration The configuration parameters for the flash label
Body hWithDepartmentCo
optional request.
nfiguration

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1F
200 OK lashLabelRespons
e

50
HTTP
Description Schema
Code
201 Created No Content

400 Not a valid pricer label barcode No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Label not found No Content

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Unlink single label

DELETE /api/public/core/v1/labels/{barcode}/links

Description

Unlink one label based on barcode

Parameters

Type Name Description Schema

barcode
Path The barcode of the label to unlink string
optional

Responses

51
HTTP
Description Schema
Code
ApiPublicCoreV1L
200 OK
abelResponse

204 No Content No Content

400 Not a valid pricer label barcode No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Unlink single item on the label

DELETE /api/public/core/v1/labels/{barcode}/links/{displayPosition}

Description

Unlink one item, based on link index, on the label based on barcode

Parameters

Type Name Description Schema

barcode
Path The barcode of the label to unlink string
optional

displayPositio
Path n The index of the item on label integer (int32)
optional

52
Responses

HTTP
Description Schema
Code
ApiPublicCoreV1L
200 OK
abelResponse

204 No Content No Content

400 Not a valid pricer label barcode No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Label not found No Content

Tags

• Core API: Label

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get scheduled updates for multiple items

GET /api/public/core/v1/scheduled-item-updates

Description

Fetches scheduled updates for many items (paginated)

Parameters

Type Name Description Schema Default

The amount, i.e. how many items
limit
Query scheduled updates will be returned for. integer (int32) 1000
optional
Currently restricted to 1000.

53
Type Name Description Schema Default
The offset to start at, 0-based. For example,
start specifying the start value 1000 with a limit
Query integer (int32) 0
optional of 500 will return 500 items starting at
position 1000.

Responses

HTTP
Description Schema
Code
<
200 OK ApiScheduledItem
UpdateList > array

400 Page size limit exceeded No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Core API: Scheduled item updates

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get scheduled item updates for single item

GET /api/public/core/v1/scheduled-item-updates/{itemId}

Description

Fetches all scheduled updates for 1 item specified by itemId

54
Parameters

Type Name Description Schema

itemId
Path The id of the item to fetch scheduled updates for string
required

Responses

HTTP
Description Schema
Code
ApiPublicCoreV1It
200 OK
em

401 Unauthorized No Content

403 Forbidden No Content

404 Item not found No Content

Tags

• Core API: Scheduled item updates

Security

Type Name
apiKey Bearer

Unknown basicAuth

Add a font

POST /api/public/file/v1/fonts

Parameters

Type Name Description Schema

FormDat font
Font file to be added file
a required

55
Responses

HTTP
Description Schema
Code
200 OK string

201 CREATED string

400 Font file already exists No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• multipart/form-data

Tags

• File API: Fonts

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get all fonts

GET /api/public/file/v1/fonts

Description

Fetches all fonts metadata (without the actual fonts data)

Responses

56
HTTP
Description Schema
Code
<
200 OK ApiPublicFileV1Fo
nt > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Produces

• application/json

Tags

• File API: Fonts

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get font file

GET /api/public/file/v1/fonts/{fileName}

Description

Fetches the font file

Parameters

Type Name Description Schema

fileName
Path Filename of font string
required

57
Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

400 File name is invalid No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Font not found No Content

Produces

• */*

Tags

• File API: Fonts

Security

Type Name
apiKey Bearer

Unknown basicAuth

Delete a font

DELETE /api/public/file/v1/fonts/{fileName}

Parameters

Type Name Description Schema

fileName
Path Filename of font string
required

Responses

58
HTTP
Description Schema
Code
200 OK ResponseEntity

204 No Content No Content

400 File name is invalid No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Font not found No Content

Produces

• */*

Tags

• File API: Fonts

Security

Type Name
apiKey Bearer

Unknown basicAuth

Upload images

POST /api/public/file/v1/images

Parameters

Type Name Description Schema Default

Path to new images. If no path is specified
filePath
Query your files will be uploaded in the following string "/"
optional
directory: /

59
Type Name Description Schema Default
Images to save. Allowed formats are: jpg,
FormDa images < file >
bmp, gif, png, jpeg. Maximum image size is:
ta required array(multi)
20MB

Responses

HTTP
Description Schema
Code
201 CREATED No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• File API: Images

Security

Type Name
apiKey Bearer

Unknown basicAuth

Add new basestation

POST /api/public/infra/v1/basestations

Parameters

Type Name Description Schema

Basestation to
The needed information to create a new
Body add AddBasestation
basestation
optional

60
Responses

HTTP
Description Schema
Code
201 CREATED No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

List basestations

GET /api/public/infra/v1/basestations

Description

Lists basestations and any connected transceivers. Optionally filtered by basestation status and/or
transceiver status

Parameters

Type Name Description Schema

bsStatusFilter An optional comma separated list of basestation
Query string
optional statuses to filter on

trxStatusFilte
An optional comma separated list of transceiver
Query r string
statuses to filter on
optional

61
Responses

HTTP
Description Schema
Code
< ApiBasestation >
200 OK
array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Accept a TLS basestation

POST /api/public/infra/v1/basestations/commands/accept

Parameters

Type Name Description Schema

Basestation to
Body accept The needed information to accept a basestation AcceptBasestation
optional

Responses

HTTP
Description Schema
Code
201 Created No Content

62
HTTP
Description Schema
Code
204 No content No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Reject a TLS basestation

POST /api/public/infra/v1/basestations/commands/reject

Parameters

Type Name Description Schema

Basestation to
Body reject The needed information to reject a basestation AcceptBasestation
optional

Responses

HTTP
Description Schema
Code
201 Created No Content

204 No content No Content

63
HTTP
Description Schema
Code
401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Fetch a basestation

GET /api/public/infra/v1/basestations/{name-or-hwid}

Parameters

Type Name Description Schema

name-or-hwid
Path Hardware id or name of basestation string
optional

Responses

HTTP
Description Schema
Code
200 OK ApiBasestation

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

64
Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update or create a basestation

PUT /api/public/infra/v1/basestations/{name-or-hwid}

Parameters

Type Name Description Schema

name-or-hwid
Path Hardware id or name of basestation string
optional

Basestation to
update or The needed information to update or create a
Body UpdateBasestation
create basestation
optional

Responses

HTTP
Description Schema
Code
200 OK string

201 CREATED string

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

65
Produces

• application/json

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Delete a basestation

DELETE /api/public/infra/v1/basestations/{name-or-hwid}

Parameters

Type Name Description Schema

name-or-hwid
Path Hardware id or name of basestation string
required

Responses

HTTP
Description Schema
Code
204 No content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Infra API: Basestations

Security

66
Type Name
apiKey Bearer

Unknown basicAuth

Reboot a basestation

POST /api/public/infra/v1/basestations/{name-or-hwid}/commands/reboot

Parameters

Type Name Description Schema

name-or-hwid
Path Hardware id or name of basestation string
optional

Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

67
Get all transceivers of basestation

GET /api/public/infra/v1/basestations/{name-or-hwid}/transceivers

Parameters

Type Name Description Schema

name-or-hwid
Path Hardware id or name of basestation string
optional

Responses

HTTP
Description Schema
Code
< TransceiverInfo
200 OK
> array

401 Unauthorized No Content

403 Forbidden No Content

404 No basestation found No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Get specific transceiver of basestation and port

GET /api/public/infra/v1/basestations/{name-or-hwid}/transceivers/{port}

68
Parameters

Type Name Description Schema

name-or-hwid
Path Hardware id or name of basestation string
optional

port
Path Port of transceiver integer (int32)
optional

Responses

HTTP
Description Schema
Code
200 OK TransceiverInfo

401 Unauthorized No Content

403 Forbidden No Content

404 No basestation or transceiver found on port No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Update a transceivers location

PUT /api/public/infra/v1/basestations/{name-or-hwid}/transceivers/{port}

Parameters

69
Type Name Description Schema
name-or-hwid
Path Hardware id or name of basestation string
optional

port
Path Port of transceiver integer (int32)
optional

transceiverLo
Body cation transceiverLocation TransceiverLocation
required

Responses

HTTP
Description Schema
Code
200 Transceiver location updated No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 No basestation or transceiver found on port No Content

Tags

• Infra API: Basestations

Security

Type Name
apiKey Bearer

Unknown basicAuth

Create new link department

POST /api/public/infra/v1/link-departments

70
Parameters

Type Name Description Schema

Change the link-department which is backoffice

PUT /api/public/infra/v1/link-departments/back-office

Parameters

Type Name Description Schema

changeBackOf
Body fice changeBackOffice ChangeBackOffice
required

Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: LinkDepartments

73
Security

Type Name
apiKey Bearer

Unknown basicAuth

Fetch linkdepartment with id

GET /api/public/infra/v1/link-departments/{id}

Parameters

Type Name Description Schema

id
Path Id of linkdepartment string
optional

Responses

HTTP
Description Schema
Code
GetLinkDepartme
200 OK
ntRequest

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: LinkDepartments

Security

Type Name
apiKey Bearer

Unknown basicAuth

74
Update a link department

PUT /api/public/infra/v1/link-departments/{id}

Parameters

Type Name Description Schema

id
Path Id of link department string
optional

Link
department to
The needed information to update or create a AddLinkDepartment
Body update or
link department Request
create
optional

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

201 CREATED ResponseEntity

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: LinkDepartments

Security

Type Name
apiKey Bearer

Unknown basicAuth

75
Delete a link department

DELETE /api/public/infra/v1/link-departments/{id}

Parameters

Type Name Description Schema

id
Path Id of link department string
required

Responses

HTTP
Description Schema
Code
204 No content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Infra API: LinkDepartments

Security

Type Name
apiKey Bearer

Unknown basicAuth

Add new transmission zone

POST /api/public/infra/v1/transmission-zones

Parameters

76
Type Name Description Schema
Transmission
The information needed to create a
Body zone to add TransmissionZone
transmission zone
required

Responses

HTTP
Description Schema
Code
201 CREATED No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: Transmission Zones

Security

Type Name
apiKey Bearer

Unknown basicAuth

List transmission zones

GET /api/public/infra/v1/transmission-zones

Responses

HTTP
Description Schema
Code
200 OK < string > array

401 Unauthorized No Content

77
HTTP
Description Schema
Code
403 Forbidden No Content

404 Not Found No Content

Tags

• Infra API: Transmission Zones

Security

Type Name
apiKey Bearer

Unknown basicAuth

Delete a transmission zone

DELETE /api/public/infra/v1/transmission-zones/{name}

Parameters

Type Name Description Schema

name
Path Name of a transmission zone string
required

Responses

HTTP
Description Schema
Code
204 No content No Content

401 Unauthorized No Content

403 Forbidden No Content

Tags

• Infra API: Transmission Zones

78
Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store

GET /api/public/map/v1/geo-store

Description

An endpoint to retrieve the full geo store object.

Responses

HTTP
Description Schema
Code
200 OK GeoStore

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/default-shelf-length

79
GET /api/public/map/v1/geo-store/default-shelf-length

Description

An endpoint to retrieve the default shelf length of the geo store.

Responses

HTTP
Description Schema
Code
200 OK number (float)

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/default-shelf-length

PUT /api/public/map/v1/geo-store/default-shelf-length

Description

An endpoint to set the default shelf length of the geo store.

Parameters

80
Type Name Description Schema
defaultShelfL
Body ength defaultShelfLength number (float)
required

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors

GET /api/public/map/v1/geo-store/floors

Description

An endpoint to retrieve the floors of the geo store.

Responses

81
HTTP
Description Schema
Code
200 OK < GeoFloor > array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}

GET /api/public/map/v1/geo-store/floors/{id}

Description

An endpoint to retrieve a specific floor of the geo [Link] 'id' represents the floor id,
starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

Responses

82
HTTP
Description Schema
Code
200 OK GeoFloor

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/blueprint-map-
layer

GET /api/public/map/v1/geo-store/floors/{id}/blueprint-map-layer

Description

An endpoint to retrieve the Geo floor layer of a specific floor id of the geo [Link] 'id'
represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

Responses

83
HTTP
Description Schema
Code
200 OK GeoFloorLayer

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/blueprint-map-
layer

PUT /api/public/map/v1/geo-store/floors/{id}/blueprint-map-layer

Description

An endpoint to update the Geo floor layer of a specific floor id of the geo [Link] 'id'
represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

blueprintMap
Body Layer blueprintMapLayer GeoFloorLayer
required

84
Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/[Link]

POST /api/public/map/v1/geo-store/floors/{id}/[Link]

Description

An endpoint to replace the current blueprint map image (*.png) of a specific floor id of the geo
[Link] the POST method, the endpoint will replace the current blueprint map
[Link] 'id' represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

85
Type Name Description Schema
FormDat image
image file
a required

Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• multipart/form-data

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/[Link]

GET /api/public/map/v1/geo-store/floors/{id}/[Link]

Description

An endpoint to retrieve the blueprint map image (*.png) of a specific floor id of the geo
[Link] 'id' represents the floor id, starting with 0.

86
Parameters

Type Name Description Schema

id
Path id integer (int32)
required

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/floor-
boundary

GET /api/public/map/v1/geo-store/floors/{id}/floor-boundary

Description

An endpoint to retrieve the floor boundary of a specific floor id of the geo [Link] 'id'
represents the floor id, starting with 0.

87
Parameters

Type Name Description Schema

id
Path id integer (int32)
required

Responses

HTTP
Description Schema
Code
GeoStoreFloorBou
200 OK
ndary

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/floor-
boundary

PUT /api/public/map/v1/geo-store/floors/{id}/floor-boundary

Description

An endpoint to update the floor boundary of a specific floor id of the geo [Link] boundary
polygon must contain atleast 3 edges and vertices each, and the number of vertices must equal the
number of [Link] 'id' represents the floor id, starting with 0.

88
Parameters

Type Name Description Schema

id
Path id integer (int32)
required

floorBoundar
GeoStoreFloorBound
Body y floorBoundary
ary
required

Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/graphical-map-
layer

GET /api/public/map/v1/geo-store/floors/{id}/graphical-map-layer

89
Description

An endpoint to retrieve the graphical map layer of a specific floor id of the geo [Link] 'id'
represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

Responses

HTTP
Description Schema
Code
200 OK GeoFloorLayer

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/graphical-map-
layer

PUT /api/public/map/v1/geo-store/floors/{id}/graphical-map-layer

90
Description

An endpoint to update the graphical map layer of a specific floor id of the geo [Link] 'id'
represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

graphicalMap
Body Layer graphicalMapLayer GeoFloorLayer
required

Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/[Link]

91
POST /api/public/map/v1/geo-store/floors/{id}/[Link]

Description

An endpoint to replace the current graphical map image (*.png) of a specific floor id of the geo
[Link] the POST method, the endpoint will replace the current graphical map
[Link] 'id' represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

FormDat image
image file
a required

Responses

HTTP
Description Schema
Code
200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

• multipart/form-data

Tags

• Map API

Security

92
Type Name
apiKey Bearer

Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/[Link]

GET /api/public/map/v1/geo-store/floors/{id}/[Link]

Description

An endpoint to retrieve the graphical map image (*.png) of a specific floor id of the geo
[Link] 'id' represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

93
Type Name
Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/obstacles

GET /api/public/map/v1/geo-store/floors/{id}/obstacles

Description

An endpoint to retrieve the obstacles of a specific floor id of the geo [Link] 'id' represents
the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

Responses

HTTP
Description Schema
Code
<
200 OK GeoStorePolygon
> array

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

Security

Type Name
apiKey Bearer

94
Type Name
Unknown basicAuth

/api/public/map/v1/geo-store/floors/{id}/obstacles

PUT /api/public/map/v1/geo-store/floors/{id}/obstacles

Description

An endpoint to completely replace the obstacles of a specific floor id of the geo store. The obstacles
will replace the existing list of obstacles . An empty list will delete the current [Link]
obstacle must contain atleast 3 edges and vertices each, and the number of vertices must equal the
number of obstacles. Parameter 'id' represents the floor id, starting with 0.

Parameters

Type Name Description Schema

id
Path id integer (int32)
required

floorObstacle
< GeoStorePolygon >
Body s floorObstacles
array
required

Responses

HTTP
Description Schema
Code
200 OK ResponseEntity

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Tags

• Map API

95
Security

Type Name
apiKey Bearer

Unknown basicAuth

Definitions
AcceptBasestation
Name Description Schema
alias The alias of the basestation
string
optional Example : "ABC"

hwId The hardware ID of the basestation

string
optional Example : "Z3808050001150461"

The name of the basestation. Name must be 1-2 capital

name
letters string
optional
Example : "A"

transmissionZ
The name of an existing transmission zone
one string
Example : "YourZoneName"
optional

AddBasestation
Name Description Schema
address The network address of the basestation
string
optional Example : "[Link]:4000"

alias The alias of the basestation

string
optional Example : "ABC"

The name of the basestation. Name must be 1-2 capital

name
letters string
optional
Example : "A"

96
Name Description Schema
transmissionZ
The name of an existing transmission zone
one string
Example : "YourZoneName"
optional

AddLinkDepartmentRequest
Name Description Schema
alias The alias of the link department
string
optional Example : "ABC"

basestationNa The name of the basestation. Name must be 1-2 capital

me letters string
optional Example : "A"

Determines if the link department should be back office or

isBackoffice
not boolean
optional
Example : false

transceivers A list of all TRX ports included in this link department < integer (int32) >
optional Example : [ 1, 3 ] array

ApiBasestation
A class representing a basestation

Name Description Schema

The ip address of the basestation. Optionally a COM port for
address
E3 basestations string
optional
Example : "[Link]"

alias The alias of the basestation

string
optional Example : "ABC"

hardwareId The hardware ID of the basestation

string
optional Example : "Z3808050001150461"

name The name of the basestation

string
optional Example : "A"

softwareId The software ID of the basestation

string
optional Example : "B5007045046010510"

97
Name Description Schema
status The status of the basestation enum (OK,
optional Example : "OK" PENDING, FAULTY)

tlsInfo
Information about TLS basestation TlsInfo
optional

transceivers < ApiTransceiver >

The list of transceivers connected to the basestation
optional array

transmissionZ
one The Transmission Zone of the basestation string
optional

enum (E32, nTRX,

type The type of the basestation
E3,
optional Example : "E32"
STORELINKOAP1)

ApiLabelModelResponse
List of ModelInfos

Name Schema
models
< ModelInfo > array
optional

ApiPublicConfigV1Job
A class representing a scheduled job

Name Description Schema

enabled enabled
boolean
optional Example : true

externalId External ID of the job

string
optional Example : "A12"

frequency ApiPublicConfigV1Jo
Frequency
optional bFrequency

id ID of the job
integer (int32)
optional Example : 1

98
Name Description Schema
enum
(BACKUP_DATA,
DISPLAY_PAGE_SEG
MENT,
GENERATE_REPORT,
CHECK_ESL_BATTER
Y, ESL_AUDIT,
ESL_AUDIT_CLASSIC
, PURGE_DATA,
CREATE_PFI,
REFRESH_LINKED_E
SLS,
REFRESH_DM_SCRE
EN,
DISPLAY_PAGE_GRA
jobType The type of job
PHICAL,
optional Example : "BACKUP"
GENERATE_IR_POS_
DATA,
FINGERPRINT_CALI
BRATION,
GENERATE_ARTICLE
_GROUPS,
DISABLE_TRANSCEI
VERS,
CHECK_FIRMWARE_
DM,
ESL_FIRMWARE_UP
GRADE,
GENERATE_TRANS
MISSION_REDUNDA
NCY_DATA)

lastRun Last time the job was run

string
optional Example : "2020-08-16T11:45:51+01:00"

name Name of the job

string
optional Example : "Weekly Job"

nextRun Next time the job will run

duration The duration in minutes to show the info page
integer (int32)
required Example : 30

linkDepartme Which link departments to use for broadcasting the

nts command < string > array
optional Example : [ "A01", "A03" ]

frequency ApiPublicConfigV1Jo
Frequency of the job
required bFrequency

name Name of the job

string
required Example : "Weekly job"

ApiPublicConfigV1Jo
parameters
Extra configuration parameters bRefreshAllLinkedEs
required
lsRequest

start Start time for the job

string
required Example : "2020-08-16T11:45:51+01:00"

ApiPublicConfigV1JobRefreshAllLinkedEslsRequest
Type : object

<
items ApiPublicCoreV1Dis
A list of status entries on items level
optional playPageResult >
array

status enum (COMPLETED,

The overall status of the display page request
optional IN_PROGRESS)

ApiPublicCoreV1FlashConfiguration
The options for a flash request

Name Description Schema

Color of LED in RGB format without blanks: #ff0000 or
rgb(255,0,0). The color will be set to closest supported color.
color
Supported colors: GREEN, RED, BLUE, CYAN, MAGENTA, string
optional
YELLOW, WHITE.
Example : "#ff00ff"

The flash duration in seconds. Defaults to 4. 0 (zero) means

stop flashing. Accepted values are all between 0-1800. The
flash duration behaviour of DM and segment labels differs
a bit. When flashing a DM label the duration will be
duration
according to the given duration. For segment labels the integer (int32)
optional
duration will be the ceiling value in relation to: 0, 4, 8, 30,
60, 300, 900, 1800 in seconds. So the duration 61 will flash
for 300 sec.
Example : 4

115
Name Description Schema
Flash type. Possible values 10 - Low, 20 - Semi-low, 30 -
flashType enum (10, 20, 30, 40,
Semi-Strong-Strobe, 40 - Strong-Strobe, 50 - Strong.
optional 50)
Example : 10

realTime <Some good explanation here> Defaults to true.

boolean
optional Example : true

ApiPublicCoreV1FlashItemResponse
A class representing the response to a flash item request

requestId The flash items request id. Used as input to the flash-result
integer (int64)
optional endpoint

117
ApiPublicCoreV1FlashItemsResult
A class representing the results of a flash items request

Name Description Schema

itemId
The id of the item for which to flash the labels linked to it string
optional

<
labels ApiPublicCoreV1Flas
List of linked labels and status of the requests to flash them
optional hLabelsResult >
array

status
The overall status of the flash items request string
optional

ApiPublicCoreV1FlashItemsResultResponse
A class containing the response to a flash items status request

Name Description Schema

<
items
A list of status entries on items level ApiPublicCoreV1Flas
optional
hItemsResult > array

status enum (COMPLETED,

The overall status of the flash request
optional IN_PROGRESS)

ApiPublicCoreV1FlashLabelResponse
A class representing the response to a flash label request

118
Name Description Schema
enum (UNKNOWN,
SUCCESS,
SUCCESS_REQUEST_
DROPPED_DUE_TO_
ROAMING,
ERROR_NOT_LINKE
D,
ERROR_FLASH_NOT
_SUPPORTED_BY_ES
L,
result
The result of the flash led request ERROR_INVALID_BA
optional
RCODE,
ERROR_INVALID_DE
PARTMENT,
ERROR_DEPARTME
NT_HAS_NO_TRX,
ERROR_DEPARTME
NT_WITH_INVALID_
TRX_GROUP,
ERROR_UNKNOWN_
DEVICE_TYPE)

ApiPublicCoreV1FlashLabelsRequest
A class representing the request to a flash all labels in the provided list

Name Description Schema

barcodes
The barcodes of the labels to flash < string > array
optional

configuration ApiPublicCoreV1Flas
The options for flashing the labels
optional hConfiguration

ApiPublicCoreV1FlashLabelsResult
A class representing the results of a flash labels request

Name Description Schema

barcode
The barcode of the label string
optional

119
Name Description Schema
status
The current status of the flash request string
optional

ApiPublicCoreV1FlashLabelsResultResponse
A class containing the response to a flash labels status request

Name Description Schema

<
flashResults ApiPublicCoreV1Flas
A list of status entries on barcode level
optional hLabelsResult >
array

status enum (COMPLETED,

The overall status of the flash request
optional IN_PROGRESS)

ApiPublicCoreV1FlashWithDepartmentConfiguration
The options for a flash request

Name Description Schema

The flash duration in seconds. Defaults to 4. 0 (zero) means

Flash type. Possible values 10 - Low, 20 - Semi-low, 30 -

flashType enum (10, 20, 30, 40,
Semi-Strong-Strobe, 40 - Strong-Strobe, 50 - Strong.
optional 50)
Example : 10

120
Name Description Schema
linkDepartme
The link department ID or alias
nt string
Example : "A01"
optional

realTime <Some good explanation here> Defaults to true.

boolean
optional Example : true

ApiPublicCoreV1Item
Representation of an item

Name Description Schema

department Department
string
optional Example : "Fruit & vegetables"

itemGroup Item group

string
optional Example : "Fruit"

itemId Unique id of an item

string
required Example : "1"

itemName Name of an item

string
optional Example : "Apples"

lastUpdated
Timestamp representing when the item was last updated
optional string
Example : "2019-12-16T10:36:37+01:00[Europe/Berlin]"
read-only

links <
optional List of linked labels ApiPublicCoreV1Lin
read-only k > array

presentation Presentation. Also known as IPF

string
optional Example : "NORMAL"

price Price of an item

string
optional Example : "0.99"

properties < string, string >

Map of custom item properties
optional map

121
Name Description Schema
sics List of secondary item codes
< string > array
optional Example : [ "0001", "01" ]

validFrom Timestamp used for scheduling a future update

string
optional Example : "2019-12-24 10:00:00"

Name Description Schema

barcode Label barcode
string
required Example : "B4633390467213197"

batteryState
optional Battery state string
read-only

batteryStateC
hanged
Battery state changed time string
optional
read-only

batteryStateFi
rstEnteredLo
w Battery state first entered low time string
optional
read-only

batteryStateL
astConfirmed
Battery state last confirmed time string
optional
read-only

124
Name Description Schema
firstLinked
optional First linked time string
read-only

hardwareRevi
Hardware version
sion
Minimum value : -128 integer (int32)
optional
Maximum value : 127
read-only

lastDisplayUp
date
Last display updated time string
optional
read-only

lastLinked
optional Last linked time string
read-only

lastOkUpdate
optional Last ok update time string
read-only

lastTrxList
optional Trx list string
read-only

lastUpdate
optional Last update time string
read-only

linkDepartme
Link department
nt string
Example : "A01"
optional

<
links
List of links ApiPublicCoreV1Lin
optional
k > array

lowBatteryDat
e
Low battery date string
optional
read-only

125
Name Description Schema
modelName The name of the linked model
string
optional Example : "SmartTAG Power S Red"

plLocation Pricer label location

string
optional Example : ""

plState
optional State of the label string
read-only

ApiPublicCoreV1LabelResponse
A class wrapping the id of a link request

Name Description Schema

requestId The link request id. Used as input to the links-result
integer (int64)
optional endpoint

ApiPublicCoreV1LabelResult
A class representing the results of a link request

Name Description Schema

barcode
The barcode of the label string
optional

itemId
The item id string
optional

The current status of the link request The value of the

status status field can be in one of the three following categories:
string
optional * Successful: Either SUCCESS or starting with SUCCESS_ *
Pending: PENDING * Failed: Starting with ERROR_

ApiPublicCoreV1LabelResultResponse
A class containing the response to a link status request

126
Name Description Schema
<
results
A list of status entries on barcode level ApiPublicCoreV1Lab
optional
elResult > array

status enum (COMPLETED,

The overall status of the link request
optional IN_PROGRESS)

ApiPublicCoreV1Link
A class representing a link between a label and an item

Name Description Schema

barcode The barcode of the linked label
string
required Example : "B4633390467213197"

displayPositio The position of the item on the label. 0-based. For single
n item labels always equal to 0 integer (int32)
optional Example : 0

facings The number of facings for the link

string
optional Example : ""

itemId The id of the linked item

string
required Example : "1"

ApiPublicCoreV1SingleLinkRequest
A class representing a label with one link

Name Description Schema

barcode Label barcode
string
required Example : "B4633390467213197"

displayPositio The position of the item on the label. 0-based. For single
n item labels always equal to 0 integer (int32)
optional Example : 0

facings The number of facings for the link

string
optional Example : ""

127
Name Description Schema
itemId The id of the linked item
string
required Example : "1"

linkDepartme
Link department
nt string
Example : "A01"
optional

modelName The name of the ESL model to use

string
optional Example : "SmartTAG Power S Red"

plLocation Pricer label location

string
optional Example : ""

ApiPublicFileV1Font
A class representing a font

Name Description Schema

createdTime
The time when the font was added string (date-time)
optional

modifiedTime
The time when the font was last updated string (date-time)
optional

name Font name

string
required Example : "[Link]"

ApiScheduledItemUpdate
Representation of a scheduled update of an item. Contains only the fields that will be updated.

Name Description Schema

department Department
string
optional Example : "Fruit & vegetables"

itemGroup Item group

string
optional Example : "Fruit"

itemName Name of an item

string
optional Example : "Apples"

128
Name Description Schema
presentation Presentation. Also known as IPF
string
optional Example : "NORMAL"

price Price of an item

string
optional Example : "0.99"

properties < string, string >

Map of custom item properties
optional map

validFrom Timestamp used for scheduling a future update

string
optional Example : "2019-12-24 10:00:00"

ApiScheduledItemUpdateList
A container element for a list of scheduled updates for one specific item

Name Description Schema

itemId Unique id of an item
string
required Example : "1"

<
updates
The list of scheduled updates. ApiScheduledItemU
optional
pdate > array

ApiTransceiver
A class representing a transceiver

Name Description Schema

basestationNa The name of the basestation that this transceiver is
me connected to string
optional Example : "A"

< enum
errors Errors
(LOW_THRESHOLD_
optional Example : [ "LOW_THRESHOLD_VALUE" ]
VALUE) > array

hardwareId The hardware ID of the transceiver

string
optional Example : "F2804360211250600"

129
Name Description Schema
The port number of the basestation that this transceiver is
port
connected to. Starts at 1 integer (int32)
optional
Example : 1

softwareId The software ID of the transceiver

string
optional Example : "A5649085060000150"

enum (OK,
status The status of the transceiver
PENDING, FAULTY,
optional Example : "OK"
WARNING)

type The type of transceiver

string
optional Example : "TRX50"

< enum
warnings Warnings
(LED_CHAIN_BROKE
optional Example : [ "LED_CHAIN_BROKEN" ]
N) > array

ChangeBackOffice
Name Description Schema
id The id of the new link department back office
string
optional Example : "2"

CreateLinkDepartmentResponse
Name Schema
id
string
optional

File
Name Schema
absolute
boolean
optional

absoluteFile
File
optional

130
Name Schema
absolutePath
string
optional

canonicalFile
File
optional

canonicalPath
string
optional

directory
boolean
optional

executable
boolean
optional

file
boolean
optional

freeSpace
integer (int64)
optional

hidden
boolean
optional

lastModified
integer (int64)
optional

name
string
optional

parent
string
optional

parentFile
File
optional

path
string
optional

readable
boolean
optional

131
Name Schema
totalSpace
integer (int64)
optional

usableSpace
integer (int64)
optional

writable
boolean
optional

FilterProvider
Type : object

GeoEdgeData
Name Schema
id
string
optional

linkable
boolean
optional

name
string
optional

shelfLength
number (float)
optional

GeoFloor
Name Schema
blueprintMapLayer
GeoFloorLayer
optional

floorBoundary
GeoStoreFloorBoundary
optional

floorObstacles
< GeoStorePolygon > array
optional

132
Name Schema
graphicalMapLayer
GeoFloorLayer
optional

GeoFloorLayer
Name Schema
height
number (float)
optional

width
number (float)
optional

x
number (float)
optional

y
number (float)
optional

GeoMappingPoint
Name Schema
mappedPoint
GeoStorePosition
optional

pricerPoint
GeoStorePosition
optional

GeoMappingPoints
Name Schema
a
GeoMappingPoint
optional

b
GeoMappingPoint
optional

c
GeoMappingPoint
optional

133
GeoStore
Name Schema
defaultShelfLength
number (float)
optional

floors
< GeoFloor > array
optional

enum (MAP_TYPE_2D, MAP_TYPE_2D_BLUEPRINT,

mapType
MAP_TYPE_2_5D_DROP_SHADOW,
optional
MAP_TYPE_2_5D_PARALLAX_EFFECT)

storeRotation
number (float)
optional

transformations
< GeoTransformation > array
optional

GeoStoreFloorBoundary
Name Schema
polygon
< GeoStorePosition > array
optional

GeoStorePolygon
Name Schema
edges
< GeoEdgeData > array
optional

polygon
< GeoStorePosition > array
optional

GeoStorePosition
Name Schema
floor
integer (int32)
optional

134
Name Schema
x
number (float)
optional

y
number (float)
optional

GeoTransformation
Name Schema
mappingPoints
< string, GeoMappingPoints > map
optional

name
string
optional

GetLinkDepartmentRequest
Name Description Schema
alias The alias of the link department
string
optional Example : "ABC"

id The id of the link department

string
optional Example : "AA01"

Determines if the link department should be back office or

isBackoffice
not boolean
optional
Example : false

transceivers A list of all TRX ports included in this link department < integer (int32) >
optional Example : [ 1, 3 ] array

InputStream
Type : object

MappingJacksonValue

135
Name Schema
filters
FilterProvider
optional

value
object
optional

ModelInfo
Model and compatible label types

Name Description Schema

labelTypes A list of compatible label types < integer (int32) >
optional Example : [ 1314, 1316 ] array

name The name of the model

string
optional Example : "SmartTAG HD Fruits"

Position
Name Schema
floor
integer (int32)
optional

section
integer (int32)
optional

shelf
string
optional

x
number (double)
optional

y
number (double)
optional

Resource

136
Name Schema
description
string
optional

file
File
optional

filename
string
optional

inputStream
InputStream
optional

open
boolean
optional

readable
boolean
optional

uri
URI
optional

url
URL
optional

ResponseEntity
Name Schema
body
object
optional

137
Name Schema
enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS,
102 PROCESSING, 103 CHECKPOINT, 200 OK, 201
CREATED, 202 ACCEPTED, 203
NON_AUTHORITATIVE_INFORMATION, 204
NO_CONTENT, 205 RESET_CONTENT, 206
PARTIAL_CONTENT, 207 MULTI_STATUS, 208
ALREADY_REPORTED, 226 IM_USED, 300
MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302
FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER,
304 NOT_MODIFIED, 305 USE_PROXY, 307
TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT,
400 BAD_REQUEST, 401 UNAUTHORIZED, 402
PAYMENT_REQUIRED, 403 FORBIDDEN, 404
NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406
NOT_ACCEPTABLE, 407
PROXY_AUTHENTICATION_REQUIRED, 408
REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411
LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413
PAYLOAD_TOO_LARGE, 413
statusCode REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG,
optional 414 REQUEST_URI_TOO_LONG, 415
UNSUPPORTED_MEDIA_TYPE, 416
REQUESTED_RANGE_NOT_SATISFIABLE, 417
EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419
INSUFFICIENT_SPACE_ON_RESOURCE, 420
METHOD_FAILURE, 421 DESTINATION_LOCKED, 422
UNPROCESSABLE_ENTITY, 423 LOCKED, 424
FAILED_DEPENDENCY, 425 TOO_EARLY, 426
UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED,
429 TOO_MANY_REQUESTS, 431
REQUEST_HEADER_FIELDS_TOO_LARGE, 451
UNAVAILABLE_FOR_LEGAL_REASONS, 500
INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED,
502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504
GATEWAY_TIMEOUT, 505
HTTP_VERSION_NOT_SUPPORTED, 506
VARIANT_ALSO_NEGOTIATES, 507
INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509
BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED,
511 NETWORK_AUTHENTICATION_REQUIRED)

statusCodeValue
integer (int32)
optional

138
StreamingResponseBody
Type : object

TlsInfo
Name Description Schema
enum
acceptance The level of acceptance (NOT_ACCEPTED,
optional Example : "ACCEPTED" ACCEPTED,
REJECTED)

enum
trustLevel The status of the basestation (NO_CERTIFICATE,
optional Example : "TRUSTED" NOT_TRUSTED,
TRUSTED)

TransceiverAddress
Name Schema
cableIndex
integer (int32)
optional

hwCableIndex
integer (int32)
optional

hwPortNo
integer (int32)
optional

portNo
integer (int32)
optional

trxAddress
string
optional

TransceiverInfo
Name Schema
address
TransceiverAddress
optional

139
Name Schema
basestationName
string
optional

cableDelay
integer (int32)
optional

failTime
string (date-time)
optional

faultyDueToThreshold
boolean
optional

hwId
string
optional

hwStatus
string
optional

iqOffset
string
optional

ledChainStatus
string
optional

location
TransceiverLocation
optional

parType
string
optional

state
enum (BOOT, APPLICATION, FAULTY)
optional

swId
string
optional

threshold
integer (int32)
optional

thresholdMultiplier
integer (int32)
optional

140
Name Schema
type
string
optional

TransceiverLocation
Name Schema
height
number (float)
optional

position
Position
optional

rotation
number (float)
optional

TransmissionZone
Name Description Schema
name The name of a transmission zone. Cannot contain comma ,
string
optional Example : "YourZoneName"

URI
Name Schema
absolute
boolean
optional

authority
string
optional

fragment
string
optional

host
string
optional

opaque
boolean
optional

141
Name Schema
path
string
optional

port
integer (int32)
optional

query
string
optional

rawAuthority
string
optional

rawFragment
string
optional

rawPath
string
optional

rawQuery
string
optional

rawSchemeSpecificPart
string
optional

rawUserInfo
string
optional

scheme
string
optional

schemeSpecificPart
string
optional

userInfo
string
optional

URL
Name Schema
authority
string
optional

142
Name Schema
content
object
optional

defaultPort
integer (int32)
optional

file
string
optional

host
string
optional

path
string
optional

port
integer (int32)
optional

protocol
string
optional

query
string
optional

ref
string
optional

userInfo
string
optional

UpdateBasestation
Name Description Schema
address The network address of the basestation
string
optional Example : "[Link]:4000"

alias The alias of the basestation

string
optional Example : "ABC"

transmissionZ
The name of an existing transmission zone
one string
Example : "YourZoneName"
optional

143

Understanding HTTP Headers and X-Prefix
No ratings yet
Understanding HTTP Headers and X-Prefix
12 pages
Protocol Implementation and Sockets Guide
No ratings yet
Protocol Implementation and Sockets Guide
18 pages
Web API Basics: Understanding HTTP
No ratings yet
Web API Basics: Understanding HTTP
15 pages
ADAM-3600 RESTful API Specification
No ratings yet
ADAM-3600 RESTful API Specification
53 pages
About Digital Conference System TS-D1100 Seriese External Control
No ratings yet
About Digital Conference System TS-D1100 Seriese External Control
5 pages
Administering Oracle Application Server Security
No ratings yet
Administering Oracle Application Server Security
1 page
Juniper Steel Belted RADIUS
No ratings yet
Juniper Steel Belted RADIUS
906 pages
Configuring Apache Virtual Hosts
No ratings yet
Configuring Apache Virtual Hosts
2 pages
Blue Prism 7.0 - Web APIs
No ratings yet
Blue Prism 7.0 - Web APIs
29 pages
Mura CMS Template Structure Guide
100% (1)
Mura CMS Template Structure Guide
52 pages
Joomla CMS Web Services API Specification
No ratings yet
Joomla CMS Web Services API Specification
36 pages
Understanding Apache 2.0 Features
No ratings yet
Understanding Apache 2.0 Features
28 pages
Initialize Zend Framework 1 Project
No ratings yet
Initialize Zend Framework 1 Project
4 pages
AppArmor's Role in Apache Security
No ratings yet
AppArmor's Role in Apache Security
4 pages
PSR Tutorial GPT
No ratings yet
PSR Tutorial GPT
9 pages
PHP 82 Migration and Code Quality Guide
No ratings yet
PHP 82 Migration and Code Quality Guide
2 pages
CodeIgniter 4 Framework Dependencies List
No ratings yet
CodeIgniter 4 Framework Dependencies List
40 pages
REST API Best Practices 5pages
No ratings yet
REST API Best Practices 5pages
5 pages
Apache vs IIS: Key Differences Explained
No ratings yet
Apache vs IIS: Key Differences Explained
30 pages
Delphi Informant: November 2001 Edition
No ratings yet
Delphi Informant: November 2001 Edition
35 pages
Application Packaging PDF
0% (1)
Application Packaging PDF
69 pages
Programming the PixelPusher Guide
No ratings yet
Programming the PixelPusher Guide
10 pages
Programming The Pixel Pusher
No ratings yet
Programming The Pixel Pusher
10 pages
MARS API Specification V1.2
No ratings yet
MARS API Specification V1.2
19 pages
Secret Server Architecture & Sizing Guide
No ratings yet
Secret Server Architecture & Sizing Guide
12 pages
Laravel FW-PHP s01
No ratings yet
Laravel FW-PHP s01
29 pages
Apache VirtualHost Configuration Guide
No ratings yet
Apache VirtualHost Configuration Guide
4 pages
Introduction to Apache Web Server 2.0
No ratings yet
Introduction to Apache Web Server 2.0
2 pages
Setting Up LAMP on CentOS & Ubuntu
No ratings yet
Setting Up LAMP on CentOS & Ubuntu
56 pages
Build A Web (PHP) Application
No ratings yet
Build A Web (PHP) Application
18 pages
Unit-1 - Introduction To WEB
No ratings yet
Unit-1 - Introduction To WEB
18 pages
Creating and Starting Managed Servers
No ratings yet
Creating and Starting Managed Servers
3 pages
Notes 2
No ratings yet
Notes 2
16 pages
PHP Docker Setup with MySQL Guide
No ratings yet
PHP Docker Setup with MySQL Guide
27 pages
PHP Setup and Configuration Guide
No ratings yet
PHP Setup and Configuration Guide
6 pages
How To Deploy and Run A War File in XAMPP Tomcat
No ratings yet
How To Deploy and Run A War File in XAMPP Tomcat
11 pages
PHP Installation Guide for Beginners
No ratings yet
PHP Installation Guide for Beginners
6 pages
Java Servlets: Dynamic Web Responses
No ratings yet
Java Servlets: Dynamic Web Responses
113 pages
Agigo Frontend Development Overview
No ratings yet
Agigo Frontend Development Overview
14 pages
Pexip Apps Administrator Guide v37
No ratings yet
Pexip Apps Administrator Guide v37
74 pages
En
No ratings yet
En
67 pages
WCM API Scenarios
No ratings yet
WCM API Scenarios
44 pages
Introduction To AEM and Frontend Basics
No ratings yet
Introduction To AEM and Frontend Basics
16 pages
PHP Coding Standards and Conventions
No ratings yet
PHP Coding Standards and Conventions
14 pages
Best Practices for ASP.NET Data Security
No ratings yet
Best Practices for ASP.NET Data Security
90 pages
Programming Style Guide
No ratings yet
Programming Style Guide
4 pages
Software Engineering Documentation Standards
No ratings yet
Software Engineering Documentation Standards
50 pages
Software Engineering Documentation Standards
No ratings yet
Software Engineering Documentation Standards
50 pages
Migrating To PHP 5.3
100% (1)
Migrating To PHP 5.3
29 pages
PD 03 01 General - Coding - Standards
No ratings yet
PD 03 01 General - Coding - Standards
43 pages
Laravel Framework Overview 2020
No ratings yet
Laravel Framework Overview 2020
4 pages
Understanding ASP and IIS Basics
No ratings yet
Understanding ASP and IIS Basics
13 pages
Overview of Apache Felix OSGi Framework
No ratings yet
Overview of Apache Felix OSGi Framework
2 pages
Starting and Stopping Apache Server
No ratings yet
Starting and Stopping Apache Server
4 pages
XAMPP Virtual Host Setup Guide
No ratings yet
XAMPP Virtual Host Setup Guide
7 pages
Setting Up Eclipse with Tomcat
No ratings yet
Setting Up Eclipse with Tomcat
8 pages
Apache 2.4.10 Mysql 5.6.20 PHP 5.5.15 Phpmyadmin 4.2.7.1 Filezilla FTP Server 0.9.41 7.0.42 Strawberry Perl 5.16.3.1 Portable Xampp Control Panel 3.2
No ratings yet
Apache 2.4.10 Mysql 5.6.20 PHP 5.5.15 Phpmyadmin 4.2.7.1 Filezilla FTP Server 0.9.41 7.0.42 Strawberry Perl 5.16.3.1 Portable Xampp Control Panel 3.2
2 pages
Mastering PHP Namespaces Quickly
No ratings yet
Mastering PHP Namespaces Quickly
2 pages
Installing XAMPP on Windows 11
No ratings yet
Installing XAMPP on Windows 11
17 pages
WSO2 API Manager: Publishing Guide
No ratings yet
WSO2 API Manager: Publishing Guide
18 pages
Heartbreak and Healing in Pop Lyrics
No ratings yet
Heartbreak and Healing in Pop Lyrics
57 pages
Organic Manure Project Report
No ratings yet
Organic Manure Project Report
16 pages
Overview of Himachal Pradesh
No ratings yet
Overview of Himachal Pradesh
83 pages
Big Data Analytics in Banking Sector
No ratings yet
Big Data Analytics in Banking Sector
19 pages
Baker Hughes Scale Inhibitor Overview
No ratings yet
Baker Hughes Scale Inhibitor Overview
1 page
Networking Experience of Xavier Abril
No ratings yet
Networking Experience of Xavier Abril
2 pages
MTM Internship Experience Report
No ratings yet
MTM Internship Experience Report
79 pages
SAP Solution Manager Starter Pack Guide
No ratings yet
SAP Solution Manager Starter Pack Guide
4 pages
SLAC Proposal for Effective Reading Strategies
100% (12)
SLAC Proposal for Effective Reading Strategies
8 pages
Data Science Unit I Overview and Tools
No ratings yet
Data Science Unit I Overview and Tools
83 pages
Instructions For Trade Planning Spreadsheet
No ratings yet
Instructions For Trade Planning Spreadsheet
2 pages
Chords and Intercepted Arcs Explained
No ratings yet
Chords and Intercepted Arcs Explained
22 pages
Paul M. Kurowski - Finite Element Analysis For Design Engineers-SAE International (2023)
No ratings yet
Paul M. Kurowski - Finite Element Analysis For Design Engineers-SAE International (2023)
287 pages
Food Adulterants in Chemistry Project
No ratings yet
Food Adulterants in Chemistry Project
19 pages
National Environmental Legislation Overview
No ratings yet
National Environmental Legislation Overview
10 pages
Bearing Degradation from Electrical Currents
No ratings yet
Bearing Degradation from Electrical Currents
14 pages
Solvent-Free Essential Oil Extraction
No ratings yet
Solvent-Free Essential Oil Extraction
6 pages
Recombinant Protein Production in Pichia Pastoris
No ratings yet
Recombinant Protein Production in Pichia Pastoris
16 pages
Human Embryology Overview and Notes
No ratings yet
Human Embryology Overview and Notes
19 pages
Tax Invoice for Tyre Shoppe India
No ratings yet
Tax Invoice for Tyre Shoppe India
1 page
Spotlight (Magazine) !!!!!!!!!
100% (2)
Spotlight (Magazine) !!!!!!!!!
70 pages
Soil Laboratory Report: NTT 00167
No ratings yet
Soil Laboratory Report: NTT 00167
7 pages
JEE Main 2022 Chemistry Memory-Based Solutions
100% (1)
JEE Main 2022 Chemistry Memory-Based Solutions
9 pages
Understanding Tessellation Types
No ratings yet
Understanding Tessellation Types
13 pages
Computer-Aided Translation Management Tools
No ratings yet
Computer-Aided Translation Management Tools
28 pages
IntelliBin: Smart Waste Management Solution
No ratings yet
IntelliBin: Smart Waste Management Solution
1 page
Quik Card Id Datasheet en
No ratings yet
Quik Card Id Datasheet en
2 pages
Overview of Operations Research Applications
No ratings yet
Overview of Operations Research Applications
37 pages
What Is The Most Common Reason That Employers Transfer Employees
No ratings yet
What Is The Most Common Reason That Employers Transfer Employees
10 pages