Label Management API
home
Label Management API (Under Development)
This API is used for extracting fields from ICS to generate the Plant, Batch and Package labels by source systems.
Overview
The Label Management API is a REST-based solution that deals in a secure and convenient way to access label data.
It is secured by OAuth provider and it has below endpoints
/ping: This endpoint returns API health.
This endpoint consists of GET method, which gives the health status of the API.
/labels: This endpoint will get label information from ICS system.
This endpoint consists of GET method which returns fields required to generate the labels for plants, batches and packages.
GET: This method is used to fetch label information within a facility based on specified query parameters.
- sourceSystem: Required parameter for the specific facility.
- icsPlantId : comma seperated ICS plant Ids (Plant Name). It is used for plant labels.
- icsBatchId : comma seperated ICS batch Ids (Batch Name). It is used for plant, batch or package labels.
- icsPackageId : comma seperated ICS package Ids (Package Name). It is used for package labels.
- sourceSystemPlantId : comma seperated source system plant Ids. It is used for plant labels.
- sourceSystemBatchId : comma seperated source system batch Ids. It is used for plant, batch or package labels.
- sourceSystemPackageId : comma seperated source system package Ids. It is used for package labels.
- labelType : It is required parameter to extract specific label data. Allowed values are - plant, batch, package.
- category : It is non mandatory parameter to extract specific package label information. Allowed values are - flower, derived.
- pageNumber : provide the pageNumber if records are more than 20.
Key features and benefits
The following are features and benefits of the Label Management API:
- Provides access to account details including token validation
- Puts your customers in control of their data sharing permissions and grants through API security.
How it works
The following diagram illustrates how the Label Management API works
<<< Add flow diagram >>>
- The customer sends client ID and Secret requesting authorization token to access the API.
- Mule token API sends the access token.
- The customer enters their secure token and valid query parameter request to the API.
- Mule OAuth provider processes the customer credentials and token to determine the authorization.
- If the access is successful, the request is processed through the API to ICS system.
- Mule API returns the response to the customer in JSON format.
- If there is any error in the flow or validation error, Mule API handles and reverts the specific error to the customer along with standard error codes.
Validations:
- Records to the specific source system will be accessed and return to source.
- Based on labelType, API return the plant, batch, package data.
- For plant labels use one of following parameter and priority is set as - sourceSystemBatchId, sourceSystemPlantId, icsBatchId, icsPlantId.
- For batch labels use one of following parameter and priority is set as - sourceSystemBatchId, icsBatchId.
- For package labels use one of following parameter and priority is set as - sourceSystemBatchId, sourceSystemPackageId, icsBatchId, icsPackageId.