This page contains detail about the Device type and Device subtype API's.
Device Types
POST /devicetypes
This service will create the Device Types which are used in the MOSIP platform.
Resource URL
POST /devicetypes
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
description of the device type
Example Request
{
"id": "string",
"metadata": {},
"request": {
"code": "DeviceTypeCode",
"name": "Finger",
"descr": "Device Type Finger"
},
"requesttime": "2018-12-10T06:12:52.994Z",
"version": "string"
}
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "2018-12-10T06:12:52.994Z",
"errors": null,
"response": [
{
"code": "Finger",
"name": "Device Type Finger"
}
],
}
Response Code: 200 Ok
Error 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
If unauthorized role detected
If no role/invalid token is detected
GET /devicetypes/{code}
This service will provides the service to get the device types.
Resource URL
GET /devicetypes/{code}
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"errors": null,
"response": {
"code": "DeviceTypeCode",
"name": "Finger",
"descr": "Device Type Finger",
"isActive": true,
"createdBy": "superadmin",
"createdDateTime": "2019-07-26T12:18:40.718Z",
"updatedBy": null,
"updatedDateTime": null,
"isDeleted": null,
"deletedDateTime": null
}
}
Response Code: 200 Ok
Error 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
If unauthorized role detected
If no role/invalid token is detected
Requiered Device Type details Not Found
PUT /devicetypes
This service will update the Device Types which are used in the MOSIP platform.
Resource URL
PUT /devicetypes
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
description of the device type
Example Request
{
"id": "string",
"metadata": {},
"request": {
"code": "DeviceTypeCode",
"name": "Finger",
"descr": "Device Type Finger"
},
"requesttime": "2018-12-10T06:12:52.994Z",
"version": "string"
}
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "2018-12-10T06:12:52.994Z",
"errors": null,
"response": [
{
"code": "DeviceTypeCode",
"name": "Finger"
}
],
}
Response Code: 200 Ok
Error 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
If unauthorized role detected
If no role/invalid token is detected
Requiered Device Type details Not Found
DELETE /devicetypes/{code}
This service will provides the service to delete the device types.
Resource URL
DELETE /devicetypes/{code}
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"errors": null,
"response": {
"code": "DeviceTypeCode"
}
}
Response Code: 200 Ok
Error 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
If unauthorized role detected
If no role/invalid token is detected
Requiered Device Type details Not Found
Device Subtypes
POST /devicesubtypes
This service will create the Device Subtypes which are used in the MOSIP platform.
Resource URL
POST /devicesubtypes
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
code of the device subtype
devicetype code of the device subtype
name of the device subtype
description of the device subtype
Example Request
{
"id": "string",
"metadata": {},
"request": {
"code": "DeviceSubtypeCode",
"deviceTypeCode": "DevicetypeCode",
"name": "Finger Slab",
"descr": "Finger Slab Description"
},
"requesttime": "2018-12-10T06:12:52.994Z",
"version": "string"
}
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "2018-12-10T06:12:52.994Z",
"errors": null,
"response": [
{
"code": "DeviceSubtypeCode",
"name": "Finger Slab"
}
],
}
Response Code: 200 Ok
Error 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
If unauthorized role detected
If no role/invalid token is detected
GET /devicesubtypes/{code}
This service will provides the service to get the device subtypes.
Resource URL
GET /devicesubtypes/{code}
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"errors": null,
"response": {
"code": "DeviceSubtypeCode",
"deviceTypeCode": "DevicetypeCode",
"name": "Finger Slab",
"descr": "Finger Slab Description",
"isActive": true,
"createdBy": "superadmin",
"createdDateTime": "2019-07-26T12:18:40.718Z",
"updatedBy": null,
"updatedDateTime": null,
"isDeleted": null,
"deletedDateTime": null
}
}
Response Code: 200 Ok
Error 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
If unauthorized role detected
If no role/invalid token is detected
PUT /devicesubtypes
This service will update the Device Subtypes which are used in the MOSIP platform.
Resource URL
PUT /devicesubtypes
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
code of the device subtype
devicetype code of the device subtype
name of the device subtype
description of the device subtype
Example Request
{
"id": "string",
"metadata": {},
"request": {
"code": "DeviceSubtypeCode",
"deviceTypeCode": "DevicetypeCode",
"name": "Finger Slab",
"descr": "Finger Slab Description"
},
"requesttime": "2018-12-10T06:12:52.994Z",
"version": "string"
}
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "2018-12-10T06:12:52.994Z",
"errors": null,
"response": [
{
"code": "DeviceSubtypeCode",
"name": "Finger Slab"
}
],
}
Error Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"errors": [
{
"errorCode": "string",
"message": "string"
}
],
"response": null
}
Failure details
Error Code
Error Message
Error Description
If unauthorized role detected
If no role/invalid token is detected
DELETE /devicesubtypes/{code}
This service will provides the service to delete the device subtypes.
Resource URL
DELETE /devicesubtypes/{code}
Resource details
Resource Details
Description
Parameters
Name
Required
Description
Default Value
Example
Example Response
Success Response
{
"id": "string",
"version": "string",
"metadata": {},
"responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"errors": null,
"response": {
"code": "DeviceSubtypeCode"
}
}
Response Code: 200 Ok
Error 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
If unauthorized role detected
If no role/invalid token is detected