Label Links

Product Label Links

In order for product information to appear automatically on the labels, a link will need to be created.
between the store product and the label. This API allows for the retreival of label links in addition to the
creation and deletion of links.

  • Method: GET
  • URL: https://madic-esl.markethubpulse.com/api/ProductLabelLink/GetByStore/

The method takes a single parameter via the url. Links 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/ProductLabelLink/GetByStore/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 label links. Each link will contain the following fields:

Name Type Description
OID GUID The unique system ID of the link in the database.
StoreOID GUID The unique system ID of the store the links are assigned to.
StoreID String The unique client ID of the store the links are assigned to.
ProductOID GUID The unique system ID of the product the links are assigned to.
ProductID String The unique client ID of the product the links are assigned to.
LabelOID GUID The unique system ID of the label in the database.
LabelID 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 link was last changed/deleted.
LastUpdatedBy String The user id of the last user to create/delete the link.
IsDeleted Bool A flag indicating if the link 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"
"ProductOID":"7E57443A-A738-4B4F-94D6-2E74A39DCBA6"
"ProductID":"PROD90121"
"LabelOID" : "C9D236FC-2E44-4926-8220-D1AA87C5AF3F"
"LabelID":"C12490881"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
},
{
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"ProductOID":"B5A47067-5015-4C48-9A58-E706351AD74B"
"ProductID":"PRD10014"
"LabelOID" : "E018C687-C2E5-4668-9D2A-817632E13219"
"LabelID":"C8902111"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:12:11.017"
"LastUpdatedBy":"testuser"
}
]

Sample Code

TODO
  • Method: GET
  • URL: https://madic-esl.markethubpulse.com/api/ProductLabelLink/GetByProduct/

This method accepts the StoreID and ProductID in the url via the GET method. The paramaters supplied should be a valid
ProductID and StoreID supplied which matches a product in the data backend. If any links are registerd against the
supplied product then the results will be returned as a list of Label links. A sample URL call for the store id
'DemoStore' and product id 'SampleProduct' would be as follows:
https://madic-esl.markethubpulse.com/api/ProductLabelLink/GetByProduct?StoreID=DemoStore&ProductID=SampleProduct

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
ProductID String The unique product id for the product within the system.
StoreID String The unique store id that the product is assigned to.

Once the request is successful the response will return an array/list of label links. Each link will contain the following fields:

Name Type Description
OID GUID The unique system ID of the link in the database.
StoreOID GUID The unique system ID of the store the links are assigned to.
StoreID String The unique client ID of the store the links are assigned to.
ProductOID GUID The unique system ID of the product the links are assigned to.
ProductID String The unique client ID of the product the links are assigned to.
LabelOID GUID The unique system ID of the label in the database.
LabelID 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 link was last changed/deleted.
LastUpdatedBy String The user id of the last user to create/delete the link.
IsDeleted Bool A flag indicating if the link 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"
"ProductOID":"7E57443A-A738-4B4F-94D6-2E74A39DCBA6"
"ProductID":"PROD90121"
"LabelOID" : "C9D236FC-2E44-4926-8220-D1AA87C5AF3F"
"LabelID":"C12490881"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
},
{
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"ProductOID":"B5A47067-5015-4C48-9A58-E706351AD74B"
"ProductID":"PRD10014"
"LabelOID" : "E018C687-C2E5-4668-9D2A-817632E13219"
"LabelID":"C8902111"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:12:11.017"
"LastUpdatedBy":"testuser"
}
]

Sample Code

TODO
  • Method: GET
  • URL: https://madic-esl.markethubpulse.com/api/ProductLabelLink/GetByProduct/

The method takes a single parameter via the url. Links are filtered by assigned label so the
Label needs to be passed in the last part of the url. So for example if the store is 'SampleLabelID'
then the url for the request would be as follows: https://madic-esl.markethubpulse.com/api/ProductLabelLink/GetByLabel/SampleLabelID

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 label links. Each link will contain the following fields:

Name Type Description
OID GUID The unique system ID of the link in the database.
StoreOID GUID The unique system ID of the store the links are assigned to.
StoreID String The unique client ID of the store the links are assigned to.
ProductOID GUID The unique system ID of the product the links are assigned to.
ProductID String The unique client ID of the product the links are assigned to.
LabelOID GUID The unique system ID of the label in the database.
LabelID 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 link was last changed/deleted.
LastUpdatedBy String The user id of the last user to create/delete the link.
IsDeleted Bool A flag indicating if the link 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"
"ProductOID":"7E57443A-A738-4B4F-94D6-2E74A39DCBA6"
"ProductID":"PROD90121"
"LabelOID" : "C9D236FC-2E44-4926-8220-D1AA87C5AF3F"
"LabelID":"C12490881"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:01:01.087"
"LastUpdatedBy":"testuser"
},
{
"OID":"4dcf0964-ba84-4a86-9618-0801c71ebc44",
"StoreOID":"50a4ae3d-7618-467f-8f09-118074bbf3bc"
"StoreID":"DemoStore"
"ProductOID":"B5A47067-5015-4C48-9A58-E706351AD74B"
"ProductID":"PRD10014"
"LabelOID" : "E018C687-C2E5-4668-9D2A-817632E13219"
"LabelID":"C8902111"
"IsDeleted": false
"LastUpdated":"2014-11-01T11:12:11.017"
"LastUpdatedBy":"testuser"
}
]

Sample Code

TODO
  • Method: POST
  • URL: https://madic-esl.markethubpulse.com/api/ProductLabelLink/Link/

This method accepts a label link. The link supplied should have a valid StoreID, ProductID and
LabelID. If a link does not exist for the combination then the link will be created. If a link already exists but has been deleted then the link is reactivated

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
ProductID String The unique product id for the product within the system.
StoreID String The unique store id that the product is assigned to.
Label String The unique label id. This is the labels physical ID.

Once the request is successful the response will return the new link and associated system IDs.

Name Type Description
StoreID String The unique client ID of the store the links are assigned to.
ProductID String The unique client ID of the product the links are assigned to.
LabelID String The unique label ID of the label. This is the physical ID of the electronic label.
Error Bool A flag indicating if the link has been creation has been successful.
ErrorMessage String If an error has occurred then this message will be populated.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
"StoreID":"DemoStore"
"ProductID":"PROD90121"
"LabelID":"C12490881"
"Error": false
"ErrorMessage":""
}

Sample Code

TODO
  • Method: POST
  • URL: https://madic-esl.markethubpulse.com/api/ProductLabelLink/DeLink/

This method accepts a label link. The link supplied should have a valid StoreID, ProductID and
LabelID. If a link exists for the combination then the link will be deleted. If a link does not exist then an error will be raised.

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
ProductID String The unique product id for the product within the system.
StoreID String The unique store id that the product is assigned to.
Label String The unique label id. This is the labels physical ID.

Once the request is successful the response will return information about the old link and the success status for the operation

Name Type Description
StoreID String The unique client ID of the store the links are assigned to.
ProductID String The unique client ID of the product the links are assigned to.
LabelID String The unique label ID of the label. This is the physical ID of the electronic label.
Error Bool A flag indicating if the link has been creation has been successful.
ErrorMessage String If an error has occurred then this message will be populated.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
"StoreID":"DemoStore"
"ProductID":"PROD90121"
"LabelID":"C12490881"
"Error": false
"ErrorMessage":""
}

Sample Code

TODO
;