This section contains details about the service APIs in the Machine Master data module
Machines API These APIs include create, update, and fetch APIs. Create and Update API is used by the Administrator Portal for the Create and Update Machine functionality. Fetch APIs are used by Registration Processor to validate the Machine data received in packet to make sure the packet is generated in an authorized Machine.
Machine Types Master API These APIs include Create, Update, Search and Filter API which the Administrator Portal uses. Create and Update API is used for the Create and Update Machine Type functionality. Search API is used by the portal to fetch the list of Machine Types based on a filter criterion to display the list of Machine Types on the UI and Filter API is used by the portal to populate Machine Type Filter Drop downs on the Portal UI.
These APIs include Create, Update, Search and Filter API which are used by the Administrator Portal. Create and Update API is used for the Create and Update Machine Specification functionality. Search API is used by the portal to fetch the list of Machine Specification based on a filter criterion to display the list of Machine Specification on the UI and Filter API is used to populate Machine Specification Filter Drop downs on the Portal UI.
Machines Master API
This service will create the list of Machines which are used in the MOSIP platform. The record needs to be created in primary and secondary language with the same ID so that it becomes active.
POST https://{base_url}/v1/masterdata/machines
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Response Code: 200 (OK)
Example Response
Response Code: 200 (OK)
This service will provide the service to fetch the complete List of machines with the machine details.
GET https://{base_url}/v1/masterdata/machines
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Response
Response Code: 200 (OK)
GET /machines/{languagecode}
This service will provide the service to fetch the List of machines with the machine details based on the language.
GET https://{base_url}/v1/masterdata/machines/{lang_Code}
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Response
Response Code: 200 (OK)
GET /machineshistory/{id}/{languagecode}/{eff_dtimes}
This service will provide a service that will verify if a machine (id) was active at a particular time (eff_dtime).
GET https://{base_url}/v1/masterdata/machineshistories/{id}/{lang_code}/{eff_dtimes}
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Response
Response Code : 200 (OK)
DELETE /machines/{id}
This service will delete the machines.
DELETE https://dev.mosip.net/v1/masterdata/machines/decommission/{id}
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Response
Response Code : 200 (OK)
This service will update existing machines.
PUT /machines
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
Failure Response
Response Code : 200 (OK)
Failure details
Error Code
Error Message
Error Description
POST /machines/search
This service is for the machine search functionality. All the filter parameters are passed and the machines are searched and the matching results are returned.
POST /machines/search
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Please find the filter columns used in search
Example Request
Example Response
Response Code : 200 (OK)
POST /machines/filtervalues
This service returns the filter values which are required in the dropdown entries of the filter screen.
POST /machines/filtervalues
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
GET /machines/mappedmachines/{regCenterId}
This service will fetch all the machines mapped to a registration center.
POST https://{base_url}/v1/masterdata/machines/mappedmachines/{reg_center_id}?direction=DESC&orderBy={field_name}&pageNumber=1&pageSize=10
Resource details
Resource Details
Description
Query Parameters
Name
Required
Description
Default Value
Example
-NA-
Success Response
Response Code : 200 (OK)
Failure Response
Machine Types Master API
POST /machinetypes
This service will create the list of Machine types which are used in the MOSIP platform.
POST /machinetypes
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
Failure details
Error Code
Error Message
Error Description
PUT /machinetypes
This service will update the list of Machine types which are used in the MOSIP platform.
PUT /machinetypes
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
Failure details
Error Code
Error Message
Error Description
GET /machinetypes
This service will provides the service to fetch the complete List of machine types with the machine details.
GET /machinetypes
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Response
Response Code : 200 (OK)
GET /machinetypes/{languagecode}
This service will provides the service to fetch the List of machines with the machine details based on the language code.
GET /machinetypes/{languagecode}
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Response
Response Code : 200 (OK)
Failure Response
Response Code : 200 (OK)
Failure details
Error Code
Error Message
Error Description
POST /machinetypes/search
This service is for the machine type search functionality. All the filter parameters are passed and the machines types are searched and the matching results are returned.
POST /machinetypes/search
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Please find the filter columns used in search
Example Request
Example Response
Response Code : 200 (OK)
POST /machinetypes/filtervalues
This service returns the filter values which are required in the dropdown entries of the filter screen.
POST /machinetypes/filtervalues
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
Machine Specifications
POST /machinespecifications
This service will create a Machine Specification which are used in the MOSIP platform.
POST /machinespecifications
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
PUT /machinespecifications
This service will update a Machine Specification which are used in the MOSIP platform.
PUT /machinespecifications
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
DELETE /machinespecifications/{id}
This service deletes a Machine Specification from the Machine Specifications master module.
DELETE /machinespecifications/{id}
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Response
GET /machinespecifications
This service will provides the list of all Machine Specifications in all languages.
GET /machinespecifications
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
GET /machinespecifications/{lang_code}
This service will provides the list of all Machine Specifications in a specific language.
GET /machinespecifications/{lang_code}
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response
Response Code : 200 (OK)
Failure Response
Response Code : 200 (OK)
Failure details
Error Code
Error Message
Error Description
POST /machinespecifications/search
This service is for the machine specifications search functionality. All the filter parameters are passed and the machines specifications are searched and the matching results are returned.
POST /machinespecifications/search
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Please find the filter columns used in search
Example Request
Example Response
Response Code : 200 (OK)
POST /machinespecifications/filtervalues
This service returns the filter values which are required in the dropdown entries of the filter screen.
POST /machinespecifications/filtervalues
Resource details
Resource Details
Description
Name
Required
Description
Default Value
Example
Example Request
Example Response