MOSIP Docs 1.1.5
GitHubCommunityTech Blogs
  • Home
  • Architecture
    • Guiding Principles
    • MOSIP Architecture
      • Technology Stack
    • MOSIP and Data
      • Naming Standards
      • Data-Model
    • Privacy & Security
      • Cryptography in MOSIP
    • Anonymous Profiling Support
  • Modules
    • Pre-Registration
      • Pre-Registration Functionality
      • UI Specification for Pre-registration
      • Pre-Registration Configuration
    • Registration
      • Registration Functionality
      • Registration Packet
      • Registration Client Setup
      • First User Registration and Onboarding
      • Guide to Configure MOSIP for Biometrics
      • Guide to On-board Biometric Devices
      • Device Integration Specifications
      • UI Specification for Registration Client
    • Registration Processor
      • Registration Processor Functionality
      • Deduplication and Manual Adjudication
      • MOSIP ID Object Definition
    • ID Repository
    • ID Authentication
      • ID Authentication Functionality
    • Resident Services
      • Resident Services Functionality
    • Partner Management
      • Partner Management Functionality
      • MOSIP Partner Secure Communication
      • Partner Self Service Portal
    • Administration
      • Admin Services Functionality
      • Download Card
    • Kernel
      • Audit Manager Functionality
        • Admin Service Audits
        • Resident Service Audits
        • Partner Management Audits
        • Registration Client Audits
        • Registration Processor Audits
        • ID Repository Audits
        • ID Authentication Audits
        • Pre-registration Audits
      • Authentication and Authorization Functionality
      • Auth Adapter
      • Auth Implementation
      • Common Services Functionality
      • Data Services Functionality
      • Master Data Services Functionality
      • UIN and VID Generation Service Functionality
      • VID Generator
  • Biometrics
    • ABIS
    • Biometric SDK
    • MDS Specification
    • Biometric Specification
    • CBEFF XML
    • Compliance Tool Kit
  • Build & Deploy
    • Sandbox Installer
    • Deployment Architectures
    • Cell Based Deployment Architecture
    • Hardware Security Module HSM Specifications
    • Hardware Sizing
    • Customizations for a Country
    • Other Installation Guides
      • Steps to Install and Configure HDFS
      • Steps to Install and use PostgreSQL Version 10.2 on RHEL 7.5
      • Steps to Install Clam AntiVirus Version 0.101.0
      • Steps to Install Keycloak Standalone Server
    • Services in MOSIP
  • Glossary
  • Contribute
    • Call for Contribution
    • Contributor's Guide
    • Code of Conduct
    • Issue Reporting Guideline
    • Coding Standards
      • Auth Angular User Guide
      • Auth SpringBoot User Guide
      • Gitub Workflow
      • MOSIP Java Coding Standards
      • MOSIP REST API guidelines
      • Registration Client UI Developer Document
      • Registration Client Developer Documentation
      • Security Tools
    • Testing
      • Test Rig Design
      • Tester Documentation
      • Testing Attachments Kernel
  • APIs
    • ABIS APIs
    • Admin APIs
    • AuthN and AuthZ APIs
    • Biometric SDK APIs
    • BlacklistedWords APIs
    • Common APIs
    • Device APIs
    • Device Type and Subtype APIs
    • Device Management APIs
    • Document APIs
    • Dynamic Fields APIs
    • Holiday APIs
    • ID Authentication APIs
    • ID Repository APIs
    • ID Schema APIs
    • Kernel APIs
    • Machine APIs
    • Master Data Biometric APIs
    • Packet APIs
    • Packet Manager APIs
    • Partner Management Service APIs
    • Pre Registration APIs
    • Registration Center APIs
    • Registration Processor APIs
    • Resident Service APIs
    • Sync Data APIs
    • Template APIs
    • Zone APIs
  • Older Releases
    • Release Notes 1.1.5
      • Enhancements
      • Defect Fixes
      • Patches
        • Patch 1.1.5.5
        • Patch 1.1.5.5-P1
    • Release Notes 1.1.4
      • Enhancements
      • Defect Fixes
    • Release Notes 1.1.3
      • Features
      • Bug Fixes
    • Release Notes 1.1.2
      • Features
      • Bug Fixes
    • Release Notes 1.1.1
      • Bug Fixes
      • Artifact Version
    • Release Notes 1.1.0
      • Features
      • Bug Fixes
      • 1.2.0 Features
      • Artifact Version
    • Release Notes 1.0.6
    • Release Notes 1.0.5
    • Release Notes 1.0.0
      • Features
    • Release Notes 0.9.0
  • Roadmap
    • Roadmap Activities
  • Revision History
  • License
Powered by GitBook
On this page
  • Device Types
  • POST /devicetypes
  • GET /devicetypes/{code}
  • PUT /devicetypes
  • DELETE /devicetypes/{code}
  • Device Subtypes
  • POST /devicesubtypes
  • GET /devicesubtypes/{code}
  • PUT /devicesubtypes
  • DELETE /devicesubtypes/{code}

Was this helpful?

Export as PDF
  1. APIs

Device Type and Subtype APIs

PreviousDevice APIsNextDevice Management APIs

Last updated 3 years ago

Was this helpful?

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

{
  "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

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

{
  "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

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

{
  "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

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

{
  "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

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

{
  "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

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

{
  "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

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

{
  "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

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

{
  "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

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

Device Types
Device Subtypes
POST /devicetypes
GET /devicetypes/{code}
PUT /devicetypes
DELETE /devicetypes/{code}
POST /devicesubtypes
GET /devicesubtypes/{code}
PUT /devicesubtypes
DELETE /devicesubtypes/{code}