Store Labels
The store label API allows you to register physical labels for a specified store. The API allows for theretrieval of labels at a store level in addition to the creation and deletion/de-registering of labels.
- Method: GET
- URL: https://madic-esl.markethubpulse.com/api/Label/Get/
The method takes a single parameter via the url. Labels are filtered at a store level so the
store id needs to be passed in the last part of the url. So for example if the store is 'SampleStore'
then the url for the request would be as follows: https://madic-esl.markethubpulse.com/api/product/Get/SampleStore
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Once the request is successful the response will return an array/list of labels. Each label will contain the following fields:
| Name | Type | Description |
|---|---|---|
| OID | GUID | The unique system ID of the label in the database. |
| StoreOID | GUID | The unique system ID of the store the labels are assigned to. |
| StoreID | String | The unique client ID of the store the labels are assigned to. |
| Label | String | The unique label ID of the label. This is the physical ID of the electronic label. |
| LastUpdated | Datetime | The date and time that the label was last changed/deleted. |
| LastUpdatedBy | String | The user id of the last user to create/delete the label. |
| IsDeleted | Bool | A flag indicating if the label has been deleted or is active. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C12490881"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
},
{
"OID":"c8d5fe04-c586-4dae-9a62-4f30226b4379",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C144556771
"IsDeleted": false
"LastUpdated":"2014-11-01T11:15:01.087"
"LastUpdatedBy":"testuser"
}
]
Sample Code
- Method: POST
- URL: https://madic-esl.markethubpulse.com/api/Label/Create/
The method takes a single label object and adds it to the database if it does not already exist or
will update it if it already exists. The label must at the very least have a valid label id and store id specified
in order for the label to be added to the database.
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Body Format
| Name | Type | Description |
|---|---|---|
| Label | String | The unique label id for the label. This is the physical label id. |
| StoreID | String | The unique store id that the label is assigned to. |
Response
| Name | Type | Description |
|---|---|---|
| OID | GUID | The unique system ID of the label in the database. |
| StoreOID | GUID | The unique system ID of the store the labels are assigned to. |
| StoreID | String | The unique client ID of the store the labels are assigned to. |
| Label | String | The unique label ID of the label. This is the physical ID of the electronic label. |
| LastUpdated | Datetime | The date and time that the label was last changed/deleted. |
| LastUpdatedBy | String | The user id of the last user to create/delete the label. |
| IsDeleted | Bool | A flag indicating if the label has been deleted or is active. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C12490881"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
"Error": false
"ErrorMessage":""
}
Sample Code
- Method: POST
- URL: https://madic-esl.markethubpulse.com/api/Label/Delete/
The method takes a single label object and removes it from the database.
The label must at the very least have a valid label id and store id specified
in order for the label to deleted. If the label ID and store ID combination must exists or
the request will return a error.
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Body Format
| Name | Type | Description |
|---|---|---|
| Label | String | The unique label id for the label. This is the physical label id. |
| StoreID | String | The unique store id that the label is assigned to. |
Response
| Name | Type | Description |
|---|---|---|
| OID | GUID | The unique system ID of the label in the database. |
| StoreOID | GUID | The unique system ID of the store the labels are assigned to. |
| StoreID | String | The unique client ID of the store the labels are assigned to. |
| Label | String | The unique label ID of the label. This is the physical ID of the electronic label. |
| LastUpdated | Datetime | The date and time that the label was last changed/deleted. |
| LastUpdatedBy | String | The user id of the last user to create/delete the label. |
| IsDeleted | Bool | A flag indicating if the label has been deleted or is active. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C12490881"
"IsDeleted": true
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
"Error": false
"ErrorMessage":""
}
Sample Code
- Method: GET
- URL: https://madic-esl.markethubpulse.com/api/Label/GetLinked/
The method takes a single parameter via the url. Labels are filtered at a store level so the
store id needs to be passed in the last part of the url. So for example if the store is 'SampleStore'
then the url for the request would be as follows: https://madic-esl.markethubpulse.com/api/product/GetLinked/SampleStore
The list of labels returned is all registered labels which have at least one valid product linked to the label.
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Once the request is successful the response will return an array/list of labels. Each label will contain the following fields:
| Name | Type | Description |
|---|---|---|
| OID | GUID | The unique system ID of the label in the database. |
| StoreOID | GUID | The unique system ID of the store the labels are assigned to. |
| StoreID | String | The unique client ID of the store the labels are assigned to. |
| Label | String | The unique label ID of the label. This is the physical ID of the electronic label. |
| LastUpdated | Datetime | The date and time that the label was last changed/deleted. |
| LastUpdatedBy | String | The user id of the last user to create/delete the label. |
| IsDeleted | Bool | A flag indicating if the label has been deleted or is active. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C12490881"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
},
{
"OID":"c8d5fe04-c586-4dae-9a62-4f30226b4379",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C144556771
"IsDeleted": false
"LastUpdated":"2014-11-01T11:15:01.087"
"LastUpdatedBy":"testuser"
}
]
Sample Code
- Method: GET
- URL: https://madic-esl.markethubpulse.com/api/Label/GetUnLinked/
The method takes a single parameter via the url. Labels are filtered at a store level so the
store id needs to be passed in the last part of the url. So for example if the store is 'SampleStore'
then the url for the request would be as follows: https://madic-esl.markethubpulse.com/api/product/GetUnLinked/SampleStore
The list of labels returned is all registered labels which have at least one valid product linked to the label.
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Once the request is successful the response will return an array/list of labels. Each label will contain the following fields:
| Name | Type | Description |
|---|---|---|
| OID | GUID | The unique system ID of the label in the database. |
| StoreOID | GUID | The unique system ID of the store the labels are assigned to. |
| StoreID | String | The unique client ID of the store the labels are assigned to. |
| Label | String | The unique label ID of the label. This is the physical ID of the electronic label. |
| LastUpdated | Datetime | The date and time that the label was last changed/deleted. |
| LastUpdatedBy | String | The user id of the last user to create/delete the label. |
| IsDeleted | Bool | A flag indicating if the label has been deleted or is active. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C12490881"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
},
{
"OID":"c8d5fe04-c586-4dae-9a62-4f30226b4379",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"Label":"C144556771
"IsDeleted": false
"LastUpdated":"2014-11-01T11:15:01.087"
"LastUpdatedBy":"testuser"
}
]
Sample Code
- Method: GET
- URL: https://madic-esl.markethubpulse.com/api/Label/GetLabelInfo/
The method takes a 2 parameters parameter via the url, the Store ID and the label ID.
So for example if the store is 'SampleStore' and the label id is 'B0056782'
then the url for the request would be as follows: https://madic-esl.markethubpulse.com/api/Label/GetLabelInfo?storeid=SampleStore&labelid=B0056782
The list of labels returned is all registered labels which have at least one valid product linked to the label.
Request Headers
| Header Field Name | Value |
|---|---|
| Accept | application/json or application/xml |
| Authorisation | Basic authentication with base 64 encoded credentials e.g. "Basic dGVzdHVzZXI6dGVzdHBhc3N3b3Jk". See EndPoint & Authorisation for more information. |
Once the request is successful the response will return an array/list of labels. Each label will contain the following fields:
| Name | Type | Description |
|---|---|---|
| AccessPointId | Integer | The unique ID tof the access point that the label is connected to. |
| ConnectionStatus | String | The connection status of the label. Normally 'OFFLINE' or 'ONLINE'. |
| CurrentPage | Integer | The page that the label is currently displaying. Zero is the default/first page of the label. |
| ErrorCode | Integer | The error code (if any) for the last update to the label. |
| ErrorCodeDescription | String | Description of the last label error (if there was an update failure). |
| FirmwareVersion | String | The version of the firmware installed on the label |
| HardwareErrorCode | String | The error code of the error if an update failed due to a hardware problem. |
| HardwareErrorMessage | String | The description of a hardware error message if an update failed due to a hardware problem. |
| IsDeleted | Boolean | Indiciates if the label has been deleted from the system (True = Deleted, False = Active) |
| LabelID | String | The Unique ID of the label |
| LastUpdated | Date Time | The last know status update of the label |
| Lqi | Int | System connection quality value |
| Page | Int | The page number that the label is currently on. |
| PowerStatus | String | The power status of the battery in the label. This is normally 'GOOD','LOW', 'BAD' or 'UNKNOWN'. |
| Rssi | Int | System connection quality value |
| SecurityStatus | String | The security status of the label. This is normally 'AES128','UNSUPPORTED', 'KEY_UNSET','NO_PIN' or 'UNKNOWN'. |
| Status | String | The status of the last attempted update on the label. |
| SyncQuality | int | Indicates the quality of the connection between the APN and the label. |
| TaskID | String | ID provided with the last update to the label |
| TaskType | String | The last task completed by the label, e.g. 'IMAGE','REFRESH_DISPLAY','PING','SWITCH_PAGE', etc. |
| Type | String | Indicates the label size and type |
| UpdatedAt | Datetime | The last time the label was physically updated or performed a task |
| WakeupTime | Datetime | The last time the label was detected in the ESL network. If the label is currently online this value should be recent, otherwise it will be the last time the label was seen before going offline. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"LabelID":"C400A789",
"Type":"G1 4.4 red",
"WakeUpTime":"2016-04-19T15:13:00.297+01:00",
"FirmwareVersion":"3.0.3",
"SecurityStatus":"NO_PIN",
"PowerStatus":"GOOD",
"SyncQuality":251,
"LabelErrors":128,
"HardwareErrorMessage":"Display failure during update",
"CurrentPage":"0","Rssi":-59,"Lqi":10,
"AccessPointId":13226,
"ConnectionStatus":"ONLINE",
"TaskID":"ONLINE",
"TaskType":"IMAGE","Page":0,
"Status":"SUCCESSFUL",
"ErrorCode":0,
"ErrorCodeDescription":"",
"UpdatedAt":"2016-04-13T05:15:56.569+01:00",
"LastUpdated":"2016-04-19T14:22:14.97",
"IsDeleted":false
}
