Device Type and Subtype APIs
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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
code | Yes | code of the device type | ||
name | Yes | name of the device type | ||
descr | No | description of the device type |
Example Request
Example Response
Success Response
Response Code: 200 Ok
Error Response
Response Code: 200 Ok
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | 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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
-NA- |
Example Response
Success Response
Response Code: 200 Ok
Error Response
Response Code: 200 Ok
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | If no role/invalid token is detected |
KER-MDS-003 | Requiered Device Type details Not Found | Device code is 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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
code | Yes | code of the device type | ||
name | No | name of the device type | ||
descr | No | description of the device type |
Example Request
Example Response
Success Response
Response Code: 200 Ok
Error Response
Response Code: 200 Ok
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | If no role/invalid token is detected |
KER-MDS-003 | Requiered Device Type details Not Found | Device code is 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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
-NA- |
Example Response
Success Response
Response Code: 200 Ok
Error Response
Response Code: 200 Ok
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | If no role/invalid token is detected |
KER-MDS-003 | Requiered Device Type details Not Found | Device code is 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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
code | Yes | code of the device subtype | ||
deviceTypeCode | Yes | devicetype code of the device subtype | ||
name | Yes | name of the device subtype | ||
descr | No | description of the device subtype |
Example Request
Example Response
Success Response
Response Code: 200 Ok
Error Response
Response Code: 200 Ok
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | 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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
-NA- |
Example Response
Success Response
Response Code: 200 Ok
Error Response
Response Code: 200 Ok
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | 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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
code | Yes | code of the device subtype | ||
deviceTypeCode | Yes | devicetype code of the device subtype | ||
name | Yes | name of the device subtype | ||
descr | No | description of the device subtype |
Example Request
Example Response
Success Response
Error Response
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | 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 |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
-NA- |
Example Response
Success Response
Response Code: 200 Ok
Error Response
Response Code: 200 Ok
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-500 | Internal Server Error | If system error occurs |
KER-ATH-403 | Forbidden | If unauthorized role detected |
KER-ATH-401 | Authentication Failed | If no role/invalid token is detected |
Last updated