Comment on page

Machine APIs

This section contains detail about the service APIs in the Machine Master data module
​Machines API These APIs includes 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 includes 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 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.
​Machine Specification API 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
​POST /machines​
​GET /machines​
​GET /machines/{languagecode}​
​GET /machineshistory/{id}/{languagecode}/{eff_dtimes}​
​DELETE /machines/{id}​
​PUT /machines​
​POST /machines/search​
​POST /machines/filtervalues​
​GET /machines/mappedmachines/{regCenterId}​
POST /machines
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.
Resource URL
POST https://{base_url}/v1/masterdata/machines
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
id
Yes
Id of the machine
​
​
ipAddress
No
IP Address of the machine
​
​
isActive
Yes
Is the machine active?
​
​
langCode
Yes
Language code of the machine
​
​
macAddress
No
Mac Address of the machine
​
​
machineSpecId
Yes
Machine specification Id of the machine
​
​
name
Yes
Name of the machine
​
​
publicKey
Yes
Public Key of the machine
​
​
serialNum
Yes
Serial number of the machine
​
​
validityDateTime
No
Validity date of machine
​
​
zoneCode
Yes
Zone code of machine
​
​
Example Request
{
  "id": "string",
  "metadata": {},
  "request": {
    "id": "string",
    "ipAddress": "192.168.0.150",
    "isActive": true,
    "langCode": "eng",
    "macAddress": "E8-6A-64-1F-27-E7",
    "machineSpecId": "1001",
    "name": "a2ml30847",
    "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAq5TnNAD1FMWWektYigmUMGw+MtNqjqLWaOZU9focDPT+nwMdw9vOs6S+Szw9Vd+zKVQ3AWkRSyfVD0qxHsPX5N6M6eS/UXvz72WF336MbbInfwzNP+uGfkprMQMt5qg21/rPSqWPU1NA9xN8lO2uPmUH4JNRBGRyvq6X1ETTDhqPsuKDwl9ciBScCMJxf/0bv2Dx7yI8lvYUaApqpoHNbBGVgDcq4f/KRZIU2kO0Ng1ESbj6D5fm0F8ZmFx3NVCKaSbBC8NUeltIRJ6+c9Csw1o23WSFTotViWeIDelsfQDq+tMmx9i9qlX3bcPZdcb7g2wm+4cywK1K5oOf3BEBxwIDAQAB",
    "regCenterId": "10005",
    "serialNum": "NM5328114630",
    "validityDateTime": "2020-10-01T05:47:13.367Z",
    "zoneCode": "CST"
  },
  "requesttime": "2018-12-10T06:12:52.994Z",
  "version": "string"
}
Response Code : 200 (OK)
Example Response
{
  "id": "string",
  "version": "string",
  "responsetime": "2020-10-01T05:52:44.871Z",
  "metadata": null,
  "response": {
    "isActive": false,
    "createdBy": "110005",
    "createdDateTime": "2020-10-01T05:52:44.894Z",
    "updatedBy": null,
    "updatedDateTime": null,
    "isDeleted": null,
    "deletedDateTime": null,
    "id": "10000",
    "name": "a2ml30847",
    "serialNum": "NM5328114630",
    "macAddress": "E8-6A-64-1F-27-E7",
    "ipAddress": "192.168.0.150",
    "machineSpecId": "1001",
    "langCode": "eng",
    "validityDateTime": "2020-10-01T05:47:13.367Z"
  },
  "errors": null
}
Response Code : 200 (OK)
GET /machines
This service will provides the service to fetch the complete List of machines with the machine details.
Resource URL
GET https://{base_url}/v1/masterdata/machines
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
-NA-
​
​
​
​
Example Response
{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
    "machines": [
      {
        "id": "10001",
        "name": "a2ml30846",
        "serialNum": "NM5328114630",
        "macAddress": "E8-6A-64-1F-27-E6",
        "ipAddress": "192.168.0.150",
        "machineSpecId": "1001",
        "regCenterId": "10001",
        "langCode": "eng",
        "isActive": true,
        "validityDateTime": null
      }
	]
  }
}
Response Code : 200 (OK)
GET /machines/{languagecode}
This service will provides the service to fetch the List of machines with the machine details based on the language.
Resource URL
GET https://{base_url}/v1/masterdata/machines/{lang_Code}
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
languagecode
Yes
Machine Languge Code
​
​
Example Response
{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
    "machines": [
	  {
        "id": "10001",
        "name": "a2ml30846",
        "serialNum": "NM5328114630",
        "macAddress": "E8-6A-64-1F-27-E6",
        "ipAddress": "192.168.0.150",
        "machineSpecId": "1001",
        "regCenterId": "10001",
        "langCode": "eng",
        "isActive": true,
        "validityDateTime": null
      }
	]
  }
}
Response Code : 200 (OK)
GET /machineshistory/{id}/{languagecode}/{eff_dtimes}
This service will provides the service will verify if a machine (id) was active at a particular time (eff_dtime).
Resource URL
GET https://{base_url}/v1/masterdata/machineshistories/{id}/{lang_code}/{eff_dtimes}
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
ID
Yes
Machine History Id
​
​
languagecode
Yes
Language code for the Machine
​
​
eff_dtimes
Yes
Effective Date and Time of the Machine
​
​
Example Response
{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
    "machineHistoryDetails": [
      {
        "id": "10001",
        "name": "a2ml30846",
        "serialNum": "NM5328114630",
        "ipAddress": "192.168.0.150",
        "macAddress": "E8-6A-64-1F-27-E6",
        "machineSpecId": "1001",
        "langCode": "eng",
        "isActive": true,
        "effectDateTime": "2020-10-01T04:21:44.587Z",
        "validityDateTime": null
      }
    ]
  }
}
Response Code : 200 (OK)
DELETE /machines/{id}
This service will delete the machines.
Resource URL
DELETE https://dev.mosip.net/v1/masterdata/machines/decommission/{id}
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
machineId
Yes
The machineId
​
​
Example Response
{
  "id": null,
  "version": null,
  "responsetime": "2020-10-04T17:14:36.127Z",
  "metadata": null,
  "response": {
    "id": "10001"
  },
  "errors": null
}
Response Code : 200 (OK)
PUT /machines
This service will update existing machines.
Resource URL
PUT /machines
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
id
Yes
Id of the machine
​
​
name
Yes
Name of the machine
​
​
machineSpecId
Yes
Machine specification Id of the machine
​
​
serialNum
Yes
Serial number of the machine
​
​
langCode
Yes
Language code of the machine
​
​
ipAddress
No
Ip Address of the machine
​
​
isActive
Yes
Is the machine active?
​
​
validityDateTime
Yes
Validity date of machine
​
​
zoneCode
Yes
Zone code of machine
​
​
Example Request
{
  "id": "string",
  "metadata": {},
  "request": {
    "id": "10000",
    "ipAddress": "192.168.0.150",
    "isActive": true,
    "langCode": "ara",
    "macAddress": "E8-6A-64-1F-27-E7",
    "machineSpecId": "1001",
    "name": "a2ml30847",
    "regCenterId": "10005",
    "serialNum": "string",
    "validityDateTime": "2020-10-01T05:47:13.367Z",
    "zoneCode": "BSN"
  },
  "requesttime": "2018-12-10T06:12:52.994Z",
  "version": "string"
}
Example Response
{
  "id": "string",
  "version": "string",
  "responsetime": "2020-10-01T06:04:48.156Z",
  "metadata": null,
  "response": {
    "isActive": true,
    "createdBy": "110005",
    "createdDateTime": "2020-10-01T05:52:44.894Z",
    "updatedBy": "110005",
    "updatedDateTime": "2020-10-01T06:04:48.176Z",
    "isDeleted": null,
    "deletedDateTime": null,
    "id": "10000",
    "name": "a2ml30847",
    "serialNum": "string",
    "macAddress": "E8-6A-64-1F-27-E7",
    "ipAddress": "192.168.0.150",
    "machineSpecId": "1001",
    "langCode": "ara",
    "validityDateTime": "2020-10-01T05:47:13.367Z"
  },
  "errors": null
}
Response Code : 200 (OK)
Failure Response
{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": [{
      "errorCode": "string",
      "message": "string"
    }],
  "response": null
}
Response Code : 200 (OK)
Failure details
Error Code
Error Message
Error Description
KER-MSD-029
Error occured while fetching Machines
Fetch Issue
KER-MSD-063
Error occurred while inserting Machine details
Insertion Issue
KER-MSD-030
Machine not Found
Data Not Found
KER-MSD-087
Error occurred while updating Machine details
Update Issue
KER-MSD-088
Error occurred while deleting Machine details
Deletion Issue
KER-MSD-148
Cannot delete as dependency found
Deletion Issue because of dependency
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.
Resource URL
POST /machines/search
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
filters
No
Array of the filter applied. In case of "list" screen, this array will be empty
-NA-
​
columnName
No
The column name in the JSON response
-NA-
​
type
No
The value have to be in ["contains","equals",”startsWith”,"between"]
-NA-
​
value
No
Value or id selected in the filter by the end user
-NA-
​
fromValue
No
If the type is "between", this field is the value of the start range
-NA-
​
toValue
No
If the type is "between", this field is the value of the end range
-NA-
​
languagecode
Yes
Language code in Language code in ISO 639-2 format
​
​
sort
No
This is an array of the sort field and type
​
​
sortfield
The field on which the sort is applied
​
modifiedDate
​
sorttype
This should be either of ['ASC','DESC']
​
ASC
​
pagination
The pagination parameter object
​
​
​
pageStart
This is the start index
0
0
​
pageFetch
This is the amount of records to be fetched
10
10
​
Filter Values
Please find the filter columns used in search
1.name
2.id
3.macAddress
4.serialNum
5.machineSpecId
6.ipAddress
7.langCode
8.regCenterId
Example Request
{
  "id": "string",
  "metadata": {},
  "request": {
    "filters": [
      {
        "columnName": "id",
        "fromValue": null,
        "toValue": null,
        "type": "equals",
        "value": "10000"
      }
    ],
    "languageCode": "ara",
    "pagination": {
      "pageFetch": 10,
      "pageStart": 0
    },
    "sort": [
      {
        "sortField": "name",
        "sortType": "ASC"
      }
    ]
  },
  "requesttime": "2018-12-10T06:12:52.994Z",
  "version": "string"
}
Example Response
{
  "id": "string",
  "version": "string",
  "responsetime": "2020-10-01T06:08:35.133Z",
  "metadata": null,
  "response": {
    "fromRecord": 1,
    "toRecord": 1,
    "totalRecord": 1,
    "data": [
      {
        "isActive": true,
        "createdBy": "110005",
        "createdDateTime": "2020-10-01T05:54:02.667Z",
        "updatedBy": "110005",
        "updatedDateTime": "2020-10-01T06:08:20.040Z",
        "isDeleted": null,
        "deletedDateTime": null,
        "id": "10000",
        "name": "a2ml30847",
        "serialNum": "string",
        "macAddress": "E8-6A-64-1F-27-E7",
        "ipAddress": "192.168.0.150",
        "machineSpecId": "1001",
        "langCode": "ara",
        "validityDateTime": "2020-10-01T05:47:13.367Z",
        "regCenterId": "10005",
        "zoneCode": "BSN",
        "zone": "بنسليمان",
        "machineTypeName": "الحاسوب",
        "mapStatus": "مركز مهدية"
      }
    ]
  },
  "errors": null
}
Response Code : 200 (OK)
POST /machines/filtervalues
This service returns the filter values which are required in the dropdown entries of the filter screen.
Resource URL
POST /machines/filtervalues
Resource details
Resource Details
Description
Response format
JSON
Requires Authentication
Yes
Parameters
Name
Required
Description
Default Value
Example
filters
No
Array of the filter applied. In case of "list" screen, this array will be empty
-NA-
​
columnName
No
The column name in the JSON response
-NA-
​
type
No
The value have to be in ["unique","all"]
unique
unique
languagecode
Yes
Language code in Language code in ISO 639-2 format
​
​
Example Request
{
  "id": "string",
  "metadata": {},
  "request": {
    "filters": [
      {
        "columnName": "zoneCode",
        "text": "S",
        "type": "unique"
      }
    ],
    "languageCode": "eng"
  },
  "requesttime": "2018-12-10T06:12:52.994Z",
  "version": "string"
}
Example Response
{
  "id": "string",
  "version": "string",
  "responsetime": "2020-10-01T06:14:25.624Z",
  "metadata": null,
  "response": {
    "filters": [
      {
        "fieldID": "zoneCode",
        "fieldValue": "BSN",
        "fieldCode": "10000"
      },
      {
        "fieldID": "zoneCode",
        "fieldValue": "CST",
        "fieldCode": "10005"
      }
    ]
  },
  "errors": null
}
Response Code : 200 (OK)
GET /machines/mappedmachines/{regCenterId}
This service will fetch all the machines mapped to a registration center.
Resource URL
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
Response format
JSON
Requires Authentication
Yes
Query Parameters
Name
Required
Description
Default Value
Example
direction
No
ASC or DESC
​
​
orderBy
No
Column Name
​
​
pageNumber
No
Page Number
1
​
pageSize
No
Page Size
10
​
Request Body
-NA-
Response Body
Success Response
{
  "id": null,
  "version": null,
  "responsetime": "2020-10-04T17:34:33.334Z",
  "metadata": null,
  "response": {
    "pageNo": 1,
    "pageSize": 10,
    "sort": {
      "sorted": true,
      "unsorted": false
    },
    "totalItems": 1,
    "totalPages": 1,
    "data": [
      {
        "isActive": true,
        "createdBy": "superadmin",
        "createdDateTime": "2020-10-01T04:21:44.266Z",
        "updatedBy": null,
        "updatedDateTime": null,
        "isDeleted": null,
        "deletedDateTime": null,
        "regCentId": "10002",
        "id": "10032",
        "name": "a2ml29106",
        "serialNum": "FB5962911665",
        "macAddress": "38-BA-F8-53-C7-8F",
        "ipAddress": "192.168.0.358",
        "machineSpecId": "1001",
        "langCode": "fra"
      }
    ]
  },
  "errors": null
}
Response Code : 200 (OK)
Failure Response
{
  "id": null,
  "version": null,
  "responsetime": "2020-10-04T17:36:11.928Z",
  "metadata": null,
  "response": null,
  "errors": [
    {
      "errorCode": "KER-MSD-030",
      "message": "Machine not Found"
    }
  ]
}
Machine Types Master API
​POST /machinetypes​
​PUT /machinetypes​
​GET /machinetypes​
​GET /machinetypes/{languagecode}​
​POST /machinetypes/search​
​POST /machinetypes/filtervalues​
POST /machinetypes
This service will create the list of Machine types which are used in the MOSIP platform.
Resource URL
POST /machinetypes
Resource details

Name	Required	Description
id	Yes	Id of the machine
ipAddress	No	IP Address of the machine
isActive	Yes	Is the machine active?
langCode	Yes	Language code of the machine
macAddress	No	Mac Address of the machine
machineSpecId	Yes	Machine specification Id of the machine
name	Yes	Name of the machine
publicKey	Yes	Public Key of the machine
serialNum	Yes	Serial number of the machine
validityDateTime	No	Validity date of machine
zoneCode	Yes	Zone code of machine

Name	Required	Description
ID	Yes	Machine History Id
languagecode	Yes	Language code for the Machine
eff_dtimes	Yes	Effective Date and Time of the Machine

Error Code	Error Message	Error Description
KER-MSD-029	Error occured while fetching Machines	Fetch Issue
KER-MSD-063	Error occurred while inserting Machine details	Insertion Issue
KER-MSD-030	Machine not Found	Data Not Found
KER-MSD-087	Error occurred while updating Machine details	Update Issue
KER-MSD-088	Error occurred while deleting Machine details	Deletion Issue
KER-MSD-148	Cannot delete as dependency found	Deletion Issue because of dependency

Name	Required	Description	Default Value
filters	No	Array of the filter applied. In case of "list" screen, this array will be empty	-NA-
columnName	No	The column name in the JSON response	-NA-
type	No	The value have to be in ["contains","equals",”startsWith”,"between"]	-NA-
value	No	Value or id selected in the filter by the end user	-NA-
fromValue	No	If the type is "between", this field is the value of the start range	-NA-
toValue	No	If the type is "between", this field is the value of the end range	-NA-
languagecode	Yes	Language code in Language code in ISO 639-2 format
sort	No	This is an array of the sort field and type
sortfield	The field on which the sort is applied		modifiedDate
sorttype	This should be either of ['ASC','DESC']		ASC
pagination	The pagination parameter object
pageStart	This is the start index	0	0
pageFetch	This is the amount of records to be fetched	10	10

Name	Required	Description	Default Value
direction	No	ASC or DESC
orderBy	No	Column Name
pageNumber	No	Page Number	1
pageSize	No	Page Size	10