Skip to content

Registration Center APIs

Mosip-Ritesh edited this page Aug 2, 2019 · 41 revisions

This section details about the service APIs in the Registration center modules

Registration Centers API

POST /registrationcenters

Master data is required across the platform.

This service will create the list of Registration Centers which are used in the MOSIP platform.

Resource URL

POST /registrationcenters

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
name Yes Name of the registration center
centertypecode Yes Code of the center type
addressline1 Yes Line 1 of the address
addressline2 No Line 2 of the address
addressline3 No Line 3 of the address
locationcode Yes Code of the location of the registration center
longitude Yes Longitude of the registration center
latitude Yes Latitude of the registration center
contactphone No Contact phone number of the registration center
workinghours Yes Working hours of the registration center
perkioskprocesstime Yes Process time per kiosk in the registration center
centerstarttime Yes Office start time of the registration center
centerendtime Yes Office end time of the registration center
holidaylocationcode Yes Holiday location of the registration center
contactperson No Contact person of the registration center
lunchstarttime No Lunch start time of the registration center
lunchendtime No Lunch end time of the registration center
timezone No time zone of the registration center
lang_code Yes language code

Example Request

{
  "id": "string",
  "metadata": {},
  "request": [ {
    "addressLine1": "Avenue Ouzguita1",
    "addressLine2": "Rabat",
    "addressLine3": "Morocco",
    "centerEndTime": "17:00:00",
    "centerStartTime": "16:00:00",
    "centerTypeCode": "REG",
    "contactPerson": "Mick Donalds",
    "contactPhone": "803062069",
    "holidayLocationCode": "RBT",
    "langCode": "eng",
    "latitude": "33.9999",
    "locationCode": "10190",
    "longitude": "-6.815281",
    "lunchEndTime": "14:00:00",
    "lunchStartTime": "13:00:00",
    "name": "Center Youssoufial1eeeeeeee",
    "perKioskProcessTime": "00:15:00",
    "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
    "workingHours": "8:00:00"
  },
{
    "addressLine1": "Avenue Ouzguita1",
    "addressLine2": "Rabat",
    "addressLine3": "Morocco",
    "centerEndTime": "17:00:00",
    "centerStartTime": "09:00:00",
    "centerTypeCode": "REG",
    "contactPerson": "Mick Donalds",
    "contactPhone": "803062069",
    "holidayLocationCode": "RBT",
    "langCode": "ara",
    "latitude": "33.99999",
    "locationCode": "10190",
    "longitude": "-6.815281",
    "lunchEndTime": "14:00:00",
    "lunchStartTime": "13:00:00",
    "name": "المركز أ بن منصور",
    "perKioskProcessTime": "00:15:00",
    "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
    "workingHours": "8:00:00"
  },
  {
    "addressLine1": "Avenue Ouzguita1",
    "addressLine2": "Rabat",
    "addressLine3": "Morocco",
    "centerEndTime": "17:00:00",
    "centerStartTime": "09:00:00",
    "centerTypeCode": "REG",
    "contactPerson": "Mick Donalds",
    "contactPhone": "803062069",
    "holidayLocationCode": "RBT",
    "langCode": "fra",
    "latitude": "33.995612",
    "locationCode": "10190",
    "longitude": "-6.815281",
    "lunchEndTime": "14:00:00",
    "lunchStartTime": "13:00:00",
    "name": "Center Youssoufial2",
    "perKioskProcessTime": "00:15:00",
    "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
    "workingHours": "8:00:00"
  }],
  "requesttime": "2018-12-10T06:12:52.994Z",
  "version": "string"
}

Example Response

{
    "id": "string",
    "version": "string",
    "responsetime": "2019-07-01T09:42:19.401Z",
    "metadata": null,
    "response": {
        "registrationCenters": [
            {
                "id": "10025",
                "name": "Souk Khemiss Mograne",
                "centerTypeCode": "REG",
                "addressLine1": "Route N1",
                "addressLine2": "Mograne",
                "addressLine3": "Morocco",
                "latitude": "33.99999",
                "longitude": "-6.815281",
                "locationCode": "10190",
                "holidayLocationCode": "RBT",
                "contactPhone": "803062069",
                "workingHours": "8:00:00",
                "langCode": "eng",
                "numberOfKiosks": 0,
                "perKioskProcessTime": "00:15:00",
                "centerStartTime": "09:00:00",
                "centerEndTime": "17:00:00",
                "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
                "contactPerson": "Mario Speedwagon",
                "lunchStartTime": "13:00:00",
                "lunchEndTime": "14:00:00",
                "isActive": false,
                "createdBy": "zonal-admin",
                "createdDateTime": "2019-07-01T09:42:19.653Z",
                "updatedBy": null,
                "updatedDateTime": null,
                "isDeleted": null,
                "deletedDateTime": null
            },
            {
                "id": "10025",
                "name": "سوق الخميس مكرن",
                "centerTypeCode": "REG",
                "addressLine1": "الطريق N1",
                "addressLine2": "مڭرن",
                "addressLine3": "المغرب",
                "latitude": "33.99999",
                "longitude": "-6.815281",
                "locationCode": "10190",
                "holidayLocationCode": "RBT",
                "contactPhone": "803062069",
                "workingHours": "8:00:00",
                "langCode": "ara",
                "numberOfKiosks": 0,
                "perKioskProcessTime": "00:15:00",
                "centerStartTime": "09:00:00",
                "centerEndTime": "17:00:00",
                "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
                "contactPerson": "ماريو سبيدواجون",
                "lunchStartTime": "13:00:00",
                "lunchEndTime": "14:00:00",
                "isActive": false,
                "createdBy": "zonal-admin",
                "createdDateTime": "2019-07-01T09:42:19.730Z",
                "updatedBy": null,
                "updatedDateTime": null,
                "isDeleted": null,
                "deletedDateTime": null
            },
            {
                "id": "10025",
                "name": "Souk Khemiss Mograne",
                "centerTypeCode": "REG",
                "addressLine1": "la route N1",
                "addressLine2": "Mograne",
                "addressLine3": "Maroc",
                "latitude": "33.99999",
                "longitude": "-6.81666",
                "locationCode": "10190",
                "holidayLocationCode": "RBT",
                "contactPhone": "803062069",
                "workingHours": "8:00:00",
                "langCode": "fra",
                "numberOfKiosks": 0,
                "perKioskProcessTime": "00:15:00",
                "centerStartTime": "09:00:00",
                "centerEndTime": "17:00:00",
                "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
                "contactPerson": "Mick Donalds",
                "lunchStartTime": "13:00:00",
                "lunchEndTime": "14:00:00",
                "isActive": false,
                "createdBy": "zonal-admin",
                "createdDateTime": "2019-07-01T09:42:21.500Z",
                "updatedBy": null,
                "updatedDateTime": null,
                "isDeleted": null,
                "deletedDateTime": null
            }
        ]
    },
    "errors": null
}
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
KER-MSD-060 Error occurred while Inserting Registration Center details If any error occur from database
KER-MSD-303 Received data is not present in all Languages supported by MOSIP If all the mandatory data is not received in all the configured languages
KER-MSD-306 Records with duplicate language code found if records received contain duplicate language codes
KER-MSD-307 Latitude or Longitude must have minimum 4 digits after decimal If the Latitude and/or Longitude are in invalid format
KER-MSD-308 Center Lunch Start Time must be smaller than Center Lunch End Time If Center Lunch start time is bigger than Center Lunch End Time
KER-MSD-309 Center Start Time must be smaller than Center End Time If Center Start time is bigger than Center End Time

PUT /registrationcenters

Master data is required across the platform.

This service will update the list of Registration Centers which are used in the MOSIP platform.

Resource URL

PUT /registrationcenters

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
name Yes Name of the registration center
centertypecode Yes Code of the center type
addressline1 Yes Line 1 of the address
addressline2 No Line 2 of the address
addressline3 No Line 3 of the address
locationcode Yes Code of the location of the registration center
longitude Yes Longitude of the registration center
latitude Yes Latitude of the registration center
contactphone No Contact phone number of the registration center
workinghours Yes Working hours of the registration center
perkioskprocesstime Yes Process time per kiosk in the registration center
centerstarttime Yes Office start time of the registration center
centerendtime Yes Office end time of the registration center
holidaylocationcode Yes Holiday location of the registration center
isactive Yes Is the registration center active
contactperson No Contact person of the registration center
lunchstarttime No Lunch start time of the registration center
lunchendtime No Lunch end time of the registration center
timezone No time zone of the registration center
lang_code Yes language code

Example Request

{
  "id": "string",
  "metadata": {},
  "request": [ {
    "addressLine1": "Avenue Ouzguita1",
    "addressLine2": "Rabat",
    "addressLine3": "Morocco",
    "centerEndTime": "17:00:00",
    "centerStartTime": "09:00:00",
    "centerTypeCode": "REG",
    "contactPerson": "Mick Donalds",
    "contactPhone": "803062069",
    "holidayLocationCode": "RBT",
    "langCode": "eng",
   "id":"10022",
    "latitude": "-33.9999",
    "locationCode": "10190",
    "longitude": "-6.815281",
    "lunchEndTime": "14:00:00",
    "lunchStartTime": "13:00:00",
    "name": "Center Youssoufialvvvvv",
    "perKioskProcessTime": "00:15:00",
    "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
    "workingHours": "8:00:00",
    "isActive": false
  },
{
    "addressLine1": "Avenue Ouzguita2",
    "addressLine2": "Rabat",
    "addressLine3": "Morocco",
    "centerEndTime": "17:00:00",
    "centerStartTime": "09:00:00",
    "centerTypeCode": "REG",
    "contactPerson": "Mick Donalds",
    "contactPhone": "803062069",
    "holidayLocationCode": "RBT",
    "id": "10022",
    "langCode": "ara",
    "latitude": "33.995612",
    "locationCode": "10190",
    "longitude": "-6.815281",
    "lunchEndTime": "14:00:00",
    "lunchStartTime": "13:00:00",
    "name": "Center Youssoufial2vvvvv",
    "perKioskProcessTime": "00:15:00",
    "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
    "workingHours": "8:00:00",
    "isActive": false
  },
  {
    "addressLine1": "Avenue Ouzguita2",
    "addressLine2": "Rabat",
    "addressLine3": "Morocco",
    "centerEndTime": "17:00:00",
    "centerStartTime": "09:00:00",
    "centerTypeCode": "REG",
    "contactPerson": "Mick Donalds",
    "contactPhone": "803062069",
    "holidayLocationCode": "RBT",
    "langCode": "fra",
    "id":"10022",
    "latitude": "33.995612",
    "locationCode": "10190",
    "longitude": "-6.815281",
    "name": "Center Youssoufial2vvvvv",
    "perKioskProcessTime": "00:15:00",
    "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
    "workingHours": "8:00:00",
    "isActive": false
  }],
  "requesttime": "2018-12-10T06:12:52.994Z",
  "version": "string"
}

Example Response

{
    "id": "string",
    "version": "string",
    "responsetime": "2019-07-01T05:44:29.825Z",
    "metadata": null,
    "response": {
        "registrationCenters": [
            {
                "id": "10022",
                "name": "Center Youssoufialaaaa",
                "centerTypeCode": "REG",
                "addressLine1": "Avenue Ouzguita1",
                "addressLine2": "Rabat",
                "addressLine3": "Morocco",
                "latitude": "-33.9999",
                "longitude": "-6.815281",
                "locationCode": "10190",
                "holidayLocationCode": "RBT",
                "contactPhone": "803062069",
                "workingHours": "8:00:00",
                "langCode": "eng",
                "numberOfKiosks": 0,
                "perKioskProcessTime": "00:15:00",
                "centerStartTime": "09:00:00",
                "centerEndTime": "17:00:00",
                "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
                "contactPerson": "Mick Donalds",
                "lunchStartTime": "13:00:00",
                "lunchEndTime": "14:00:00",
                "isActive": false,
                "createdBy": "zonal-admin",
                "createdDateTime": "2019-06-28T08:24:11.204Z",
                "updatedBy": "zonal-admin",
                "updatedDateTime": "2019-07-01T05:44:30.448Z",
                "isDeleted": null,
                "deletedDateTime": null
            },
            {
                "id": "10022",
               "name": "سوق الخميس مكرن",
                "centerTypeCode": "REG",
                "addressLine1": "الطريق N1",
                "addressLine2": "مڭرن",
                "addressLine3": "المغرب",
                "latitude": "33.99999",
                "longitude": "-6.815281",
                "locationCode": "10190",
                "holidayLocationCode": "RBT",
                "contactPhone": "803062069",
                "workingHours": "8:00:00",
                "langCode": "ara",
                "numberOfKiosks": 0,
                "perKioskProcessTime": "00:15:00",
                "centerStartTime": "09:00:00",
                "centerEndTime": "17:00:00",
                "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
                "contactPerson": "ماريو سبيدواجون",
                "lunchStartTime": "13:00:00",
                "lunchEndTime": "14:00:00",
                "isActive": false,
                "createdBy": "zonal-admin",
                "createdDateTime": "2019-06-28T08:24:11.256Z",
                "updatedBy": "zonal-admin",
                "updatedDateTime": "2019-07-01T05:44:30.931Z",
                "isDeleted": null,
                "deletedDateTime": null
            },
            {
                "id": "10022",
                "name": "Souk Khemiss Mograne",
                "centerTypeCode": "REG",
                "addressLine1": "la route N1",
                "addressLine2": "Mograne",
                "addressLine3": "Maroc",
                "latitude": "33.99999",
                "longitude": "-6.81666",
                "locationCode": "10190",
                "holidayLocationCode": "RBT",
                "contactPhone": "803062069",
                "workingHours": "8:00:00",
                "langCode": "fra",
                "numberOfKiosks": 0,
                "perKioskProcessTime": "00:15:00",
                "centerStartTime": "09:00:00",
                "centerEndTime": "17:00:00",
                "timeZone": "(GTM+01:00) CENTRAL EUROPEAN TIME",
                "contactPerson": "Mick Donalds",
                "lunchStartTime": "13:00:00",
                "lunchEndTime": "14:00:00",
                "isActive": false,
                "createdBy": "zonal-admin",
                "createdDateTime": "2019-06-28T08:24:11.349Z",
                "updatedBy": "zonal-admin",
                "updatedDateTime": "2019-07-01T05:44:31.558Z",
                "isDeleted": null,
                "deletedDateTime": null
            }
        ],
        "notUpdatedRegCenters": []
    },
    "errors": null
}
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
KER-ATH-111 Error occurred while updating Registration Center details If any error occur from database
KER-MSD-303 Received data is not present in all Languages supported by MOSIP If all the mandatory data is not received in all the configured languages
KER-MSD-304 Center IDs received for all languages is not same If all the IDs received are not same for data in all the languages
KER-MSD-305 Center ID and Language Code combination is not unique in the request received If combination of Center ID and Language code in duplicate in request
KER-MSD-306 Records with duplicate language code found if records received contain duplicate language codes
KER-MSD-307 Latitude or Longitude must have minimum 4 digits after decimal If the Latitude and/or Longitude are in invalid format
KER-MSD-308 Center Lunch Start Time must be smaller than Center Lunch End Time If Center Lunch start time is bigger than Center Lunch End Time
KER-MSD-309 Center Start Time must be smaller than Center End Time If Center Start time is bigger than Center End Time

GET /registrationcenters

Master data is required across the platform.

This service will provides the service for the List of Registration Centers.

Resource URL

GET /registrationcenters

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": {
  "registrationcenters": [
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
	},
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
	}
   ]
 }
}

GET /registrationcenters/{id}/{languagecode}

Master data is required across the platform.

This service will provides the service for the List of Registration Centers.

Resource URL

GET /registrationcenters/{id}/{languagecode}

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": {
  "registrationcenters": [
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
	},
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
       	}
   ]
 }
}

GET /getregistrationcenterholidays/{languagecode}/{registrationcenterid}/{year}

This service will list of holidays for a particular registration center for that particular year.

Resource URL

GET /getregistrationcenterholidays/{languagecode}/{registrationcenterid}/{year}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
registrationcenterid Yes ID of the registration center
year Yes The year for which the list of holidays is listed

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
  "registrationcenter": [
	{
		"registrationcentername":"",
		"centertypecode":"",
		"addressline1":"",
		"addressline2":"",
		"addressline3 ":"",
		"longitude ":"",
		"latitude":"",
		"contactphone":"",
		"numberofkiosks":"",
		"workinghours":"",
		"perkioskprocesstime":"",
		"officestarttime":"",
		"officeendtime":"",
		"holidaylocationcode":"",
		"isactive":"",
		"centertype":"",
		"address":"",
		"workinghours":"",
		"contactnumber":"",
		"pincode":"",
		"locationcode":"",
		"holidays": [
			"holiday" : {
				"holidayID": "string",
				"holidayDate": "string",
				"holidayName": "string",
				"holidayDay": "string",	
				"holidayMonth": "string",
				"holidayYear": "string",
				"languagecode":"string"
			           }
		            ]		
	  }
     ]
   }
}

200

GET /getlocspecificregistrationcenters/{langcode}/{locationcode}

This service will return a list of enrollment center details based on the location code

Resource URL

GET /getlocspecificregistrationcenters/{langcode}/{locationcode}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
locationcode Yes The location code for which the list of enrollment centers are needed

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
  "registrationCenters": [
    {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "centerEndTime": "HH:mm:ss",
          "centerStartTime": "HH:mm:ss",
          "centerTypeCode": "string",
          "contactPerson": "string",
          "contactPhone": "string",
          "holidayLocationCode": "string",
          "id": "string",
          "isActive": true,
          "languageCode": "string",
          "latitude": "string",
          "locationCode": "string",
          "longitude": "string",
          "lunchEndTime": "HH:mm:ss",
          "lunchStartTime": "HH:mm:ss",
          "name": "string",
          "numberOfKiosks": 0,
          "perKioskProcessTime": "HH:mm:ss",
          "timeZone": "string",
          "workingHours": "string"
       }
   ]
 }
}

200

Description: OK

GET /getcoordinatespecificregistrationcenters/{languagecode}/{longitude}/{latitude}/{proximitydistance}

This service will return a list of enrollment center details based on the coordinates

Resource URL

GET /getcoordinatespecificregistrationcenters/{languagecode}/{longitude}/{latitude}/{proximitydistance}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
languagecode Yes Language code in Language code in ISO 639-2 format
longitude Yes The longitude for which the list of enrollment centers are needed
latitude Yes The latitude code for which the list of enrollment centers are needed
proximitydistance Yes The proximity diameter in meter

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
  "registrationcenter": [
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
	   }
     ]
  }
}

200

Description: Success

GET /registrationcentershistory/{id}/{languagecode}/{eff_dtimes}

This service will provides the service for the List of Registration Centers History.

Resource URL

GET /registrationcentershistory/{id}/{languagecode}/{eff_dtimes}

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":{
  "registrationcenters": [
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
	},
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
	}
    ]
  }
}

200

Description: Success

GET /getregistrationmachineusermappinghistory/{eff_dtimes}/{registrationcenterid}/{machineid}/{userid}

This service will provides the history of mappings of mapping History of Registration, Machine and User based on Registration Center ID, Machine ID, User ID, Date and Language Code

Resource URL

GET /getregistrationmachineusermappinghistory/{eff_dtimes}/{registrationcenterid}/{machineid}/{userid}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
languagecode Yes Language code in Language code in ISO 639-2 format
eff_dtimes Yes From which date this change is with effective 2018-11-02T05:20:31.075
registrationcenterid Yes ID of the registration center
machineid Yes ID of the machine

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response":{
  "registrationcenters": [
	{
		"registrationcenterid":"string",
		"machineid":"string",
		"userid":"string"
	},
	{
		"registrationcenterid":"string",
		"machineid":"string",
		"userid":"string"
	}
    ]
  }
}

200

Description: Success

GET /getlocspecificregistrationcenters/{hierarchylevel}/{textvalue}/{languagecode}

This service will return a list of enrollment center details based on hierarchy level, text value and language code

Resource URL

GET /getlocspecificregistrationcenters/{hierarchylevel}/{textvalue}/{languagecode}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
hierarchylevel Yes The hierarchy level for which the list of enrollment centers are needed
textvalue Yes This is a free text. The search will happen with the combination of heirarchy level, language code and this free text. The enrollment centers which satisfy these 3 criteria will be returned
languagecode Yes The enrollment center description will be returned in this language code

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response":{
  "registrationcenter": [
	{
			"registrationcentername":"",
			"centertypecode":"",
			"addressline1":"",
			"addressline2":"",
			"addressline3 ":"",
			"longitude ":"",
			"latitude":"",
			"contactphone":"",
			"numberofkiosks":"",
			"workinghours":"",
			"perkioskprocesstime":"",
			"officestarttime":"",
			"officeendtime":"",
			"holidaylocationcode":"",
			"isactive":"",
			"centertype":"",
			"address":"",
			"workinghours":"",
			"contactnumber":"",
			"pincode":"",
			"locationcode":""
	 }
     ]
  }
}

200

Description: Success

Failure 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-041 Error occured while fetching Registration Centers registration center fetch exception
KER-MSD-111 Error occurred while updating Registration Center details registration center update exception
KER-MSD-112 Error occurred while deleting Registration Center details registration center delete exception
KER-MSD-042 Registration Center not found registration center not found
KER-MSD-149 Cannot delete as dependency found dependency exception
KER-MSD-043 Invalid date format date time parse exception
KER-MSD-XXX start/end time Data not configured in database data to be validated with not found

Registration Center User Machine Mapping API

POST /registrationmachineusermappings

This service will create a Registration Center-User-Machine Mapping which are used in the MOSIP platform.

Resource URL

POST /registrationmachineusermappings

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
cntrId Yes Registration Center Id for request
machineId Yes Machine Id for request
usrId Yes User Id for request
isActive Yes Mapping is active or not

Example Request

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "requesttime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "request": {
    "cntrId": "RC001",
    "isActive": true,
    "machineId": "MC001",
    "usrId": "QC001"
  }
}

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
            "cntrId": "RC001",
            "machineId": "MC001",
            "usrId": "QC001"
            }
}

Response codes

200

Description: Success

GET /getregistrationmachineusermappinghistory/{effdtimes}/{registrationcenterid}/{machineid}/{userid}

This service will provides the service for the Center-User-Machine with their history.

Resource URL

GET /getregistrationmachineusermappinghistory/{effdtimes}/{registrationcenterid}/{machineid}/{userid}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
ID Yes Machine History Id
effdtimes Yes Effective Date and Time of the Machine
registrationcenterid Yes Registration Center Id
machineid Yes Machine Id
userid Yes User Id

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response":  {
      "registrationCenters": [
             {
              "cntrId": "string",
              "effectivetimes": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
              "isActive": true,
              "langCode": "string",
              "machineId": "string",
              "usrId": "string"
             }
        ]
    }
}

200

Description: Success

PUT /registrationmachineusermappings

This service will create or update a Registration Center-User-Machine Mapping which are used in the MOSIP platform.

Resource URL

PUT /registrationmachineusermappings

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
cntrId Yes Registration Center Id for request
machineId Yes Machine Id for request
usrId Yes User Id for request
isActive Yes Mapping is active or not

Example Request

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "requesttime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "request": {
      "cntrId": "RC001",
      "isActive": true,
      "langCode": "string",
      "machineId": "MC001",
      "usrId": "QC001"
  }
}

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
    "mapped": [
      {
        "cntrId": "string",
        "machineId": "string",
        "usrId": "string"
      }
    ],
    "notmapped": [
       {
        "cntrId": "string",
        "machineId": "string",
        "usrId": "string"
      }
    ]
  }
}

Response codes

201

Failure 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-078 Error occurred while inserting mapping of Center, User and Machine details registration center user machine mapping insert exception
KER-MSD-131 Registration Center, Machine and User Mapping not found registration center user machine not found
KER-MSD-108 Error occurred while deleting mapping of Center, User and Machine details registration center user machine delete exception
KER-MSD-136 Error occurred while updating mapping of Center, User and Machine details registration center user machine update exception

Registration Center Machine API

POST /registrationcentermachine

Master data is required across the platform.

This service will create the mapping of registration canter and machine in the RegistrationCenterMachine Master module.

Resource URL

POST /registrationcentermachine

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
machineId Yes Available machine id
regCenterId Yes Available registration center

Example Request

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "requesttime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "request": {
    "isActive": true,
    "langCode": "string",
    "machineId": "MC001",
    "regCenterId": "RC001"
  }
}

Example Response

 {
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": [{
      "errorCode": "string",
      "message": "string"
    }],
  "response": {
      "machineId": "string",
      "regCenterId": "string"
  }
}

Response codes

201

Description: Created

DELETE/registrationcentermachine/{regCenterId}/{machineId}

This service will provides the service for delete mapping of Center-Machine.

Resource URL

DELETE /registrationcentermachine/{regCenterId}/{machineId}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
regCenterId Yes Registration Center Id
machineId Yes Machine Id

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": [{
      "errorCode": "string",
      "message": "string"
    }],
  "response":  {
  "machineId": "MC001",
  "regCenterId": "RC001"
   }
}

200

Description: Success

Failure 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-074 Error occurred while inserting a mapping of Machine and Center registration center machine create exception
KER-MSD-114 Mapping for Machine and Center not found registration center machine data not found
KER-MSD-106 Error occurred while deleting a mapping of Machine and Center registration center machine delete exception

Registration Center Device API

POST /registrationcenterdevice

Master data is required across the platform.

This service will create the mapping of registration canter and device in the RegistrationCenterDevice Master module.

Resource URL

POST /registrationcenterdevice

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
deviceId Yes Available device id
regCenterId Yes Available registration center

Example Request

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "requesttime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "request": {
     "deviceId": "string",
    "isActive": true,
    "langCode": "string",
    "regCenterId": "string"
  }
}

Example Response

 {
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": [{
      "errorCode": "string",
      "message": "string"
    }],
  "response":   {
        "deviceId": "string",
        "regCenterId": "string"
  }
}

Response codes

201

Description: Created

DELETE/registrationcenterdevice/{regCenterId}/{deviceId}

This service will provides the service for delete mapping of Device-Machine.

Resource URL

DELETE /registrationcenterdevice/{regCenterId}/{deviceId}

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
regCenterId Yes Registration Center Id
deviceId Yes Device Id

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": [{
      "errorCode": "string",
      "message": "string"
    }],
  "response":   {
           "deviceId": "DV001",
          "regCenterId": "RC001"
    }
}

200

Description: Success

Failure 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-075 Error occurred while inserting a mapping of Device and Center registration center device create exception
KER-MSD-115 Mapping for Device and Center not found registration center device data not found
KER-MSD-105 Error occurred while deleting a mapping of Device and Center registration center device delete exception

Registration Center Machine Device API

POST /registrationcentermachinedevice

This service will create the mapping of registration center, machine and device in the RegistrationCenterMachineDevice Master module.

Resource URL

POST /registrationcentermachinedevice

Resource details

Resource Details Description
Response format JSON
Requires Authentication Yes

Parameters

Name Required Description Default Value Example
machineId Yes Available machine id
regCenterId Yes Available registration center
deviceId Yes Available device id

Example Request

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "requesttime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "request": {
    "deviceId": "string",
    "isActive": true,
    "langCode": "string",
    "machineId": "string",
    "regCenterId": "string"
  }
}

Example Response

 {
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": [{
      "errorCode": "string",
      "message": "string"
    }],
  "response":   {
   "deviceId": "string",
   "machineId": "string",
   "regCenterId": "string"
  }
}

Response codes

201

Description: Created

DELETE /registrationcentermachinedevice/{regcenterid}/{machineid}/{deviceid}

Master data is required across the platform.

This service will delete the mapping of registration center, machine and device in the RegistrationCenter-Machine-Device Master module.

Resource URL

DELETE /registrationcentermachinedevice/{regcenterid}/{machineid}/{deviceid}

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": [{
      "errorCode": "string",
      "message": "string"
    }],
  "response":  {
   "deviceId": "string",
   "machineId": "string",
   "regCenterId": "string"
  }
}

Response codes

200

Description: Success

Failure 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-076 Error occurred while inserting a mapping of Center, Machine and Device registration center machine device create exception
KER-MSD-107 Error occurred while deleting a mapping of Center, Machine and Device registration center machine device delete exception
KER-MSD-116 Mapping for Center, Machine and Device not found registration center machine device data not found exception

Registration Center search APIs

POST /registrationcenters/search

This service is for the registration centers search functionality. All the filter parameters are passed and the registration centers are searched and the matching results are returned.

Resource URL

POST /registrationcenters/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","startsWith","equals","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 start value -NA-
toValue No If the type is "between", this field is the end value -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 10
pageFetch This is the amount of records to be fetched 10 10

Example Request

{
	"id": "string",
	"metadata": {},
	"requesttime": "2018-12-10T06:12:52.994Z",
	"version": "string",
	"request": {
		"filters" : [
			{
				"columnName": "",
				"type": "",
				"value": "",  
				"fromValue": "",
				"toValue": "",
				"languageCode":""
			}
		],
		"sort":[
			{
				"sortfield":"string",
				"sorttype":"ASC"
			}
		],
		"pagination":{
			"pageStart":"number",
			"pageFetch":"number"
		}
		
	}
}

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
  "data": [
	{
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "administrativeZone": "string",
        "administrativeZoneCode": "string",
        "centerEndTime": "HH:mm:ss",
        "centerStartTime": "HH:mm:ss",
        "centerTypeCode": "string",
        "centerTypeName": "string",
        "city": "string",
        "cityCode": "string",
        "contactPerson": "string",
        "contactPhone": "string",
        "createdBy": "string",
        "devices": "number",
        "holidayLocation": "string",
        "holidayLocationCode": "string",
        "id": "string",
        "isActive": "boolean",
        "isDeleted": "boolean",
        "langCode": "string",
        "latitude": "string",
        "locationCode": "string",
        "longitude": "string",
        "lunchEndTime": "HH:mm:ss",
        "lunchStartTime": "HH:mm:ss",
        "machines": "number",
        "name": "string",
        "numberOfKiosks": "number",
        "perKioskProcessTime": "HH:mm:ss",
        "postalCode": "string",
        "province": "string",
        "provinceCode": "string",
        "region": "string",
        "regionCode": "string",
        "timeZone": "string",
        "updatedBy": "string",
        "users": "number",
        "workingHours": "string",
        "zone": "string",
        "zoneCode": "string"
      }
   ],
	"fromRecord" : "number",
	"toRecord":"number",
	"totalRecord":"number"
 }
}

Registration Center filter values

POST /registrationcenters/filtervalues

This service returns the filter values which are required in the dropdown entries of the filter screen.

Resource URL

POST /registrationcenters/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": {},
	"requesttime": "2018-12-10T06:12:52.994Z",
	"version": "string"
	"request": {
		"filters" : [
			{
				"columnName": ""
				"type": "unique"
			}
		],
		"languageCode": "string",
	}
}

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
  "filters": [
	{
		"fieldID": "string",
		"fieldCode":"string",
		"fieldValue": "string"
	}
   ]
 }
}

Registration Center Type Search APIs

POST /registrationcentertypes/search

This service is for the registration center types search functionality. All the filter parameters are passed and the registration center types are searched and the matching results are returned.

Resource URL

POST /registrationcentertypes/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 10
pageFetch This is the amount of records to be fetched 10 10

Filter Values

Filter Name Search Values
status ["contains","equals","startsWith"]

Example Request

{
	"id": "string",
	"metadata": {},
	"requesttime": "2018-12-10T06:12:52.994Z",
	"version": "string",
	"request": {
		"filters" : [
			{
				"columnName": "",
				"type": "in",
				"value": "", 
				"fromValue": "",
				"toValue": ""
			}
		],
		"sort":[
			{
				"sortfield":"string",
				"sorttype":"ASC"
			}
		],
		"pagination":{
			"pageStart":"number",
			"pageFetch":"number"
		},
		"languageCode":""
		
	}
}

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
  "registrationcentertypes": [
	{
		"code": "string",
                "langCode": "string",
                "name": "string",
                "descr": "string",
                "isActive": true
	}
   ],
	"fromRecord" : "number",
	"toRecord":"number",
	"totalRecord":"number"
 }
}

Registration Center Types Filter values

POST /regcentertypes/filtervalues

This service returns the filter values which are required in the dropdown entries of the filter screen.

Resource URL

POST /regcentertypes/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": {},
	"requesttime": "2018-12-10T06:12:52.994Z",
	"version": "string"
	"request": {
		"filters" : [
			{
				"columnName": "",
				"type": "unique"
			}
		],
		"languageCode": "string"
	}
}

Example Response

{
  "id": "string",
  "version": "string",
  "metadata": {},
  "responsetime": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
  "errors": null,
  "response": {
  "filters": [
	{
		"fieldID": "string",
		"fieldCode":"string",
		"fieldValue": "string"
	}
   ]
 }
}
Clone this wiki locally
You can’t perform that action at this time.