Facility Management API icon

Facility Management API

1.0.x
(0 reviews)

Facility Management API

This API is used for receiving and creating the facility related information in ICS.

Introduction

The Facility Management API is secured by OAuth token validation, allowing customer to access any or all the following depending on the API use case:

Overview

The Facility Management API is a REST-based solution that deals in a secure and convenient way to access facility's data.

Facility Management API is secured by Mule OAuth

The Facility Management API provides information about Facility Management details from the ICS. It has below endpoints

/ping: This endpoint returns API health.

This endpoint consists of GET method, which gives the health status of the API.

/facilities/strains: This endpoint will get/create strain in ICS.

This endpoint consists of GET and POST method which is used to create and return a strain in ICS.

GET: This method is used to fetch strains created within a facility based on specified query parameters.

POST: This method is used to create new strain in ICS

/facilities/drivers: This endpoint will get/create drivers in ICS.

This endpoint consists of GET and POST method which is used to create and return a driver in ICS.

GET: This method is used to fetch drivers created within a facility based on specified query parameters.

POST: This method is used to create new driver in ICS

/facilities/products: This endpoint will get/create products in ICS.

This endpoint consists of GET and POST method which is used to create and return a product in ICS.

GET: This method is used to fetch products created within a facility based on specified query parameters.

POST: This method is used to create new product in ICS

/facilities/vehicles: This endpoint will get/create vehicles in ICS.

This endpoint consists of GET and POST method which is used to create and return a vehicle in ICS.

GET: This method is used to fetch vehicles created within a facility based on specified query parameters.

POST: This method is used to create new vehicle in ICS

/facilities/buildings: This endpoint will get/create buildings in ICS.

This endpoint consists of GET and POST method which is used to create and return a building in ICS.

GET: This method is used to fetch buildings created within a facility based on specified query parameters.

POST: This method is used to create new building in ICS

/facilities/rooms: This endpoint will get/create rooms in ICS.

This endpoint consists of GET and POST method which is used to create and return a room in ICS.

GET: This method is used to fetch rooms created within a facility based on specified query parameters.

POST: This method is used to create new room in ICS

/facilities/sections: This endpoint will get/create sections in ICS.

This endpoint consists of GET and POST method which is used to create and return a section in ICS.

GET: This method is used to fetch sections created within a facility based on specified query parameters.

POST: This method is used to create new section in ICS

/facilities/zones: This endpoint will get/create zones in ICS.

This endpoint consists of GET and POST method which is used to create and return a zone in ICS.

GET: This method is used to fetch zones created within a facility based on specified query parameters.

POST: This method is used to create new zone in ICS

Key features and benefits

The following are features and benefits of the Facility Management API:

  1. Provides access to account details including token validation and initiates/retrieves for a Facility Management API.
  2. Puts your customers in control of their data sharing permissions and grants through our Security.
How it works

The following diagram illustrates how the Facility Management API works

resources/facilityApi-bbda5926-5de2-4792-a124-4182e7763730.PNG

  1. The customer sends client ID and Secret requesting authorization token to access Mule API.
  2. Mule API sends the secure token.
  3. The customer enters their secure token and valid Json request for Facility Management.
  4. Mule OAuth provider processes the customer credentials and token to determine the authorization.
  5. If the access is successful, the request is passed from Mule Api to ICS.
  6. Response received from ICS is captured.
  7. Mule API sends the response back to the customer in Json format.
  8. If there is any error in the flow or validation error, Mule API handles and reverts the specific error with the customer along with standard error codes.

Validations:

  1. sourceSystem is a required field for all endpoint operations (GET & POST) which will fetch facility information internally through API.
  2. In case of drivers record uniqueness will be ensured by driver's license.
  3. In case of vehicles record uniqueness will be ensured by licensePlateNumber
  4. In case of products itemId field will create unique record/s in ICS and it expects source side item id of the respective product.
  5. There will not be two/more buildings of same name within a facility.
  6. There will not be two/more rooms of same name within a building.
  7. There will not be two/more zones of same name within a room.
  8. There will not be two/more sections of same name within a zone.
  9. Facility GET and POST operations are not supported as a part of this API.

Reviews