Registration Center APIs

This section contains details about the service APIs in the Registration Center Masterdata module

• Registration Centers API
• Registration Center - Device Mapping API
• Registration Center - Machine Mapping API
• Registration Center - User - Machine Mapping API
• Registration Center - Machine - Device API
• Registration Center - Search API
• Registration Center - Filter values
• Registration Center Type - Search API
• Registration Center Type - Filter values
• Create/Update API
• Search API

Registration Centers API

These APIs includes create, update and fetch APIs. Create and Update API is used by the Administrator Portal for the Create and Update Center functionality. Fetch APIs are used by Pre-Registration to display the List of Registration Centers on the UI for an Applicant to select and book appointments. Registration processor also uses the fetch API to validate if a packet is generated in an Authorized Registration Center or not.

• POST /registrationcenters
• PUT /registrationcenters
• GET /registrationcenters
• GET /registrationcenters/{id}/{languagecode}
• GET /getregistrationcenterholidays/{languagecode}/{registrationcenterid}/{year}
• GET /getlocspecificregistrationcenters/{langcode}/{locationcode}
• GET /getcoordinatespecificregistrationcenters/{languagecode}/{longitude}/{latitude}/{proximitydistance}
• GET /registrationcentershistory/{id}/{languagecode}/{eff_dtimes}
• GET /getregistrationmachineusermappinghistory/{eff_dtimes}/{registrationcenterid}/{machineid}/{userid}
• GET /getlocspecificregistrationcenters/{hierarchylevel}/{textvalue}/{languagecode}

POST /registrationcenters

This service will create the list of Registration Centers which are used in the MOSIP platform. Please find the steps to create primary/secondary languages

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

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

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
id	Yes	Id of the registration center		Incase of Primary empty and Generated id incase of Secondary
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
numberOfKiosks	No	Number of Kiosks

Example Request

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

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

GET /registrationcenters/{id}/{languagecode}

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

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

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

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

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

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

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 hierarchy 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

200

Description: Success

Failure Response:

Failure details

Error Code	Error Message	Error Description
KER-MSD-041	Error occurred 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

These APIs includes map and un-map API. Both these APIs are used by the Administrator Portal for the Create and Remove Center-Machine Mapping functionality.

• POST /registrationmachineusermappings
• GET /getregistrationmachineusermappinghistory/{effdtimes}/{registrationcenterid}/{machineid}/{userid}
• PUT /registrationmachineusermappings

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

Example Response

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

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

Example Response

Response codes

201

Failure Response:

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

These APIs includes map and un-map API. Both these APIs are used by the Administrator Portal for the Create and Remove Center-Machine Mapping functionality.

• POST /registrationcentermachine
• DELETE /registrationcentermachine/{regCenterId}/{machineId}

POST /registrationcentermachine

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

Example Response

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

200

Description: Success

Failure Response:

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

These APIs includes map and un-map API. Both these APIs are used by the Administrator Portal for the Create and Remove Center-Device Mapping functionality.

• GET /registrationcenterdevice/map/{regCenterId}/{deviceId}
• PUT /registrationcenterdevice/unmap/{deviceId}/{regCenterId}

GET /registrationcenterdevice/map/{regCenterId}/{deviceId}

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

Resource URL

GET /registrationcenterdevice/map/{regCenterId}/{deviceId}

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

https://mosip.io/v1/masterdata/registrationcenterdevice/map/10001/4cb310e3-965a-4afd-a28e-0db6b3db5423

Example Response

Response codes

200

Failure Response:

Failure details

Error Code	Error Message	Error Description
KER-MSD-411	Admin not authorized to map/un-map this Registration Center	when user zone doesn't belong to the same zone of center
KER-MSD-415	Admin not authorized to map/un-map this Device	when user zone doesn't belong to the same zone of device
KER-MSD-418	Cannot map as the Registration Center/Device is Decommissioned	When center/device trying to map is decomissioned
KER-MSD-419	Cannot map the Device as it is mapped to another Registration Center	When the center/device are already mapped to center
KER-MSD-416	Device cannot be mapped to the Center as Center and Device does not belong to the same Administrative Zone	When the device doesn't belong to same category

PUT /registrationcenterdevice/unmap/{deviceId}/{regCenterId}

This service will provides the service for un map the mapping of Device and Registration Center.

Resource URL

PUT /registrationcenterdevice/unmap/{deviceId}/{regCenterId}

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

Request

Example Response

Failure Response:

Failure details

Error Code	Error Message	Error Description
KER-MSD-411	Admin not authorized to map/un-map this Registration Center	when user zone doesn't belong to the same zone of center
KER-MSD-415	Admin not authorized to map/un-map this Device	when user zone doesn't belong to the same zone of device
KER-MSD-435	Device Id %s - Center Id %s mapping does not exist	when center/device trying to unmap doesn't exist
KER-MSD-434	Device-Registration Center un-mapping already exist	When the center/device mapping already exists
KER-MSD-416	Device cannot be mapped to the Center as Center and Device does not belong to the same Administrative Zone	When the device doesn't belong to same category
KER-MSD-436	Error occurred while mapping Device to Registration Center	Exception while mapping device to registration center

Registration Center Machine Device API

These APIs includes map, un-map and fetch mapping APIs. The Map and Un-Map APIs are used to create/remove Center-Machine-Device mapping.

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

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

Example Response

Response codes

201

Description: Created

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

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

Response codes

200

Description: Success

Failure Response:

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

This API is used by the Administrator Portal to fetch the list of Registration Centers based on a given filter criteria to display the list of Registration Centers on the Portal UI.

• POST /registrationcenters/search

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