Admin Master Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Admin Master for CRUD

zone-user-controller

updateapUserZone

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (ZoneUserPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"zoneCode": "string",
"userId": "string",
"isActive": true,
"langCode": "string"
}
}

mapUserZone

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (ZoneUserDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"zoneCode": "string",
"userId": "string",
"langCode": "string",
"isActive": true
}
}

updateapUserZoneStatus

query Parameters

isActive required	boolean
userId required	string

Responses

deleteMapUserZone

path Parameters

userid required	string
zonecode required	string

Responses

searchZoneUserMapping

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getHistoryByUserIdAndTimestamp

path Parameters

userid required	string
eff_dtimes required	string

Responses

zone-controller

getZoneNameBasedOnUserIDAndLangCode

query Parameters

userID required	string
langCode required	string

Responses

getSubZones

path Parameters

langCode

required

string

Responses

getLeafZonesBasedOnZoneCode

path Parameters

langCode

required

string

Responses

getLeafZones

path Parameters

langCode

required

string

Responses

getZoneHierarchy

path Parameters

langCode

required

string

Responses

zoneFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

authorizeZone

query Parameters

rid

required

string

Responses

working-day-controller

updateWorkingDays

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (WorkingDaysPutRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"name": "string",
"daySeq": 0,
"globalWorking": true
}
}

updateWorkingDaysStatus

query Parameters

code required	string
isActive required	boolean

Responses

getWorkingays

path Parameters

registrationCenterID required	string
langCode required	string

Responses

getWorkingDaysByLangCode

path Parameters

langCode

required

string

Responses

getWeekDays

path Parameters

registrationCenterId required	string
langCode required	string

Responses

valid-document-controller

createValidDocument

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (ValidDocumentDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"docTypeCode": "string",
"docCategoryCode": "string",
"langCode": "string",
"isActive": true
}
}

getValidDocumentByLangCode

path Parameters

langCode

required

string

Responses

deleteValidDocuemnt

path Parameters

doccategorycode required	string
doctypecode required	string

Responses

getValidDocumentByDocCategoryCode

path Parameters

docCategoryCode required	string
langCode required	string

Responses

unmapDocCategoryAndDocType

path Parameters

doccategorycode required	string [ 1 .. 36 ] characters
doctypecode required	string [ 1 .. 36 ] characters

Responses

searchValidDocument

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

mapDocCategoryAndDocType

path Parameters

doccategorycode required	string [ 1 .. 36 ] characters
doctypecode required	string [ 1 .. 36 ] characters

Responses

categoryTypeFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllValidDocument

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

user-details-controller

getUsersDetails

query Parameters

roleName	string
pageStart	integer <int32> Default: 0
pageFetch	integer <int32> Default: 0
firstName	string
lastName	string
userName	string

Responses

getUsers

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 1
orderBy	string Default: "cr_dtimes"
direction	string Default: "DESC"

Responses

getUserById

path Parameters

id

required

string

Responses

deleteUserRegCenter Deprecated

path Parameters

id

required

string

Responses

searchUsersDetails Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

updateUserRegCenter

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserDetailsPutReqDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"statusCode": "string",
"regCenterId": "string",
"isActive": true,
"langCode": "string"
}
}

mapUserRegCenter

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UserDetailsDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"statusCode": "string",
"regCenterId": "string",
"isActive": true,
"langCode": "string"
}
}

updateUserRegCenterStatus

query Parameters

isActive required	boolean
id required	string

Responses

deleteUserRegCenterMapping

path Parameters

id

required

string

Responses

serachUserCenterMappingDetails

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

user-details-history-controller

getTitlesBylangCode

path Parameters

id required	string
eff_dtimes required	string

Responses

ui-spec-controller

updateUISpec

query Parameters

id

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UISpecDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"identitySchemaId": "string",
"domain": "string",
"type": "string",
"title": "string",
"description": "string",
"jsonspec": { }
}
}

defineUISpec

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UISpecDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"identitySchemaId": "string",
"domain": "string",
"type": "string",
"title": "string",
"description": "string",
"jsonspec": { }
}
}

deleteUISpec

query Parameters

id

required

string

Responses

getLatestPublishedSchema

path Parameters

domain

required

string

query Parameters

version	number <double> Default: 0
type	string
identitySchemaVersion	number <double> Default: 0

Responses

publishUISpec

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (UISpecPublishDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"effectiveFrom": "2019-08-24T14:15:22Z"
}
}

getAllUISpecs

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "cr_dtimes"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

title-controller

getAllTitles

Responses

updateTitle

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TitleDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"titleName": "string",
"titleDescription": "string",
"isActive": true,
"langCode": "string"
}
}

saveTitle

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TitleDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"titleName": "string",
"titleDescription": "string",
"isActive": true,
"langCode": "string"
}
}

getTitlesBylangCode_1

path Parameters

langcode

required

string

Responses

deleteTitle

path Parameters

code

required

string

Responses

searchTitles

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

filterTemplates

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getTitles

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

template-type-controller

createTemplateType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TemplateTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"description": "string",
"isActive": true
}
}

getTemplateFileFormatLangCode

path Parameters

langcode

required

string

Responses

getTemplateTypeCodeandLangCode

path Parameters

code required	string
langcode required	string

Responses

template-controller

getAllTemplate

Responses

updateTemplate

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TemplatePutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"description": "string",
"isActive": true,
"fileFormatCode": "string",
"model": "string",
"fileText": "string",
"moduleId": "string",
"moduleName": "string",
"templateTypeCode": "string",
"langCode": "string"
}
}

createTemplate

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TemplateDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"description": "string",
"fileFormatCode": "string",
"model": "string",
"fileText": "string",
"moduleId": "string",
"moduleName": "string",
"templateTypeCode": "string",
"langCode": "string",
"isActive": true
}
}

updateTemplateStatus

query Parameters

isActive required	boolean
id required	string

Responses

getAllTemplateBylangCode

path Parameters

langcode

required

string

Responses

getAllTemplateBylangCodeAndTemplateTypeCode

path Parameters

langcode required	string
templatetypecode required	string

Responses

deleteTemplate

path Parameters

id

required

string

Responses

getAllTemplateByTemplateTypeCode

path Parameters

code

required

string

Responses

searchTemplates

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMissingTemplateDetails

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

filterTemplates_1

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getTemplates

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

template-file-format-controller

getTemplateFileFormatLangCode_1 Deprecated

path Parameters

langcode

required

string

Responses

updateDevice

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TemplateFileFormatPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"description": "string",
"isActive": true,
"langCode": "string"
}
}

createTemplateFileFormat

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TemplateFileFormatDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

updateFileFormatStatus

query Parameters

isActive required	boolean
code required	string

Responses

deleteDocumentCategory

path Parameters

code

required

string

Responses

getTemplateFileFormatCodeandLangCode

path Parameters

code required	string
langcode required	string

Responses

getTemplateFileFormatCodeandLangCode_1

path Parameters

code required	string
langcode required	string

Responses

getTemplateFileFormatLangCode_2 Deprecated

path Parameters

langcode

required

string

Responses

registration-center-type-controller

updateRegistrationCenterType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RegistrationCenterTypePutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"name": "string",
"isActive": true,
"descr": "string"
}
}

createRegistrationCenterType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RegistrationCenterTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"name": "string",
"descr": "string",
"isActive": true
}
}

updateRegistrationCenterTypeStatus

query Parameters

isActive required	boolean
code required	string

Responses

deleteRegistrationCenterType

path Parameters

code

required

string

Responses

searchRegistrationCenterType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMissingRegistrationCentersTypesDetails

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

registrationCenterTypeFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllRegistrationCenterTypes

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

registration-center-history-controller

getRegistrationCentersHistory

path Parameters

registrationCenterId required	string
langcode required	string
effectiveDate required	string

Responses

registration-center-controller

getAllRegistrationCentersDetails

Responses

updateRegistrationCenterAdmin

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RegCenterPutReqDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"langCode": "string",
"numberOfKiosks": 0,
"contactPerson": "string",
"centerTypeCode": "string",
"latitude": "string",
"longitude": "string",
"locationCode": "string",
"holidayLocationCode": "string",
"contactPhone": "string",
"workingHours": "string",
"isActive": true,
"perKioskProcessTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"centerStartTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"centerEndTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"lunchStartTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"lunchEndTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"timeZone": "string",
"zoneCode": "string",
"workingNonWorkingDays": {"property1": true,
"property2": true
},
"exceptionalHolidayPutPostDto": [{"exceptionHolidayDate": "string",
"exceptionHolidayName": "string",
"exceptionHolidayReson": "string"
}
]
}
}

createRegistrationCenter

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RegCenterPostReqDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"langCode": "string",
"contactPerson": "string",
"isActive": true,
"centerTypeCode": "string",
"latitude": "string",
"longitude": "string",
"locationCode": "string",
"holidayLocationCode": "string",
"contactPhone": "string",
"workingHours": "string",
"perKioskProcessTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"centerStartTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"centerEndTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"lunchStartTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"lunchEndTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"timeZone": "string",
"zoneCode": "string",
"workingNonWorkingDays": {"property1": true,
"property2": true
},
"exceptionalHolidayPutPostDto": [{"exceptionHolidayDate": "string",
"exceptionHolidayName": "string",
"exceptionHolidayReson": "string"
}
],
"numberOfKiosks": 0
}
}

updateRegistrationCenterAdminStatus

query Parameters

isActive required	boolean
id required	string

Responses

deleteRegistrationCenter

path Parameters

registrationCenterId

required

string

Responses

getRegistrationCenterByHierarchyLevelAndTextAndlangCode

path Parameters

langcode required	string
hierarchylevel required	integer <int32>
name required	string

Responses

getRegistrationCenterByHierarchyLevelAndListTextAndlangCode

path Parameters

langcode required	string
hierarchylevel required	integer <int32>

query Parameters

name

required

Array of strings

Responses

getSpecificRegistrationCenterById

path Parameters

id required	string
langcode required	string

Responses

validateTimestamp

path Parameters

id required	string
langCode required	string
timestamp required	string

Responses

searchRegistrationCenter

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getRegistrationCenterByHierarchyLevelAndTextAndlangCodePaginated

path Parameters

langcode required	string
hierarchylevel required	integer <int32>
name required	string

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

updateRegistrationCenterNonLanguageSpecifi

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RegCenterNonLanguageSpecificPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"numberOfKiosks": 0,
"contactPerson": "string",
"centerTypeCode": "string",
"latitude": "string",
"longitude": "string",
"locationCode": "string",
"holidayLocationCode": "string",
"contactPhone": "string",
"workingHours": "string",
"perKioskProcessTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"centerStartTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"centerEndTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"lunchStartTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"lunchEndTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"timeZone": "string",
"zoneCode": "string",
"workingNonWorkingDays": {"property1": true,
"property2": true
},
"exceptionalHolidayPutPostDto": [{"exceptionHolidayDate": "string",
"exceptionHolidayName": "string",
"exceptionHolidayReson": "string"
}
]
}
}

getMissingRegistrationCentersDetails

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

updateRegistrationCenterLanguageSpecifi

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RegCenterLanguageSpecificPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"langCode": "string",
"contactPerson": "string"
}
}

registrationCenterFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

decommissionRegCenter

path Parameters

regCenterID

required

string

Responses

getAllExistingRegistrationCentersDetails

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

getCenterSpecificToZone

path Parameters

langcode required	string
zonecode required	string

Responses

getRegistrationCenterHolidays

path Parameters

langcode required	string
registrationcenterid required	string
year required	integer <int32>

Responses

getRegistrationCenterDetailsByLocationCode

path Parameters

langcode required	string
locationcode required	string

Responses

getCoordinateSpecificRegistrationCenters

path Parameters

langcode required	string
longitude required	number <double>
latitude required	number <double>
proximitydistance required	integer <int32>

Responses

registration-center-device-history-controller

getRegCentDevHistByregCentIdDevIdEffTime

path Parameters

regcenterid required	string
deviceid required	string
effdatetimes required	string

Responses

registered-device-controller

signedRegisteredDevice Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RegisteredDevicePostDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"deviceData": "string"
}
}

deRegisterDevice Deprecated

query Parameters

deviceCode required	string
statusCode required	string

Responses

deRegisterDevice_1 Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeRegisterDevicePostDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"device": "string"
}
}

possible-values-controller

getAllValuesOfField

path Parameters

fieldName

required

string

query Parameters

langCode

required

string

Responses

packet-rejection-reason-controller

getAllReasons

Responses

getReasonsBasedOnReasonCatgCodeAndlangCode

path Parameters

reasoncategorycode required	string
langcode required	string

Responses

createReasonLists

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (ReasonListDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"rsnCatCode": "string",
"langCode": "string",
"isActive": true
}
}

createReasonCategories

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PostReasonCategoryDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

packet-workflow-controller

searchPacket

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

resumePacket

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PacketWorkflowResumeRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"workflowId": "string",
"workflowAction": "string"
}
}

mosip-device-service-controller

udpateMOSIPDeviceService Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MOSIPDeviceServicePUTDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"swVersion": "string",
"deviceProviderId": "string",
"regDeviceTypeCode": "string",
"isActive": true,
"regDeviceSubCode": "string",
"make": "string",
"model": "string",
"swCreateDateTime": "2019-08-24T14:15:22Z",
"swExpiryDateTime": "2019-08-24T14:15:22Z",
"swBinaryHash": "string"
}
}

createMOSIPDeviceService Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MOSIPDeviceServiceDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"swVersion": "string",
"deviceProviderId": "string",
"regDeviceTypeCode": "string",
"regDeviceSubCode": "string",
"make": "string",
"model": "string",
"swCreateDateTime": "2019-08-24T14:15:22Z",
"swExpiryDateTime": "2019-08-24T14:15:22Z",
"swBinaryHash": "string",
"isActive": true
}
}

module-controller

getModuleLangCode

path Parameters

langcode

required

string

Responses

getModuleIdandLangCode

path Parameters

id required	string
langcode required	string

Responses

machine-type-controller

updateMachineType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MachineTypePutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"isActive": true,
"name": "string",
"description": "string"
}
}

createMachineType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MachineTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"name": "string",
"description": "string",
"isActive": true
}
}

updateMachineTypeStatus

query Parameters

code required	string
isActive required	boolean

Responses

searchMachineType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

machineTypesFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllMachineTypes

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

machine-specification-controller

updateMachineSpecification

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MachineSpecificationPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"brand": "string",
"isActive": true,
"model": "string",
"machineTypeCode": "string",
"minDriverversion": "string",
"description": "string",
"langCode": "string"
}
}

createMachineSpecification

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MachineSpecificationDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"brand": "string",
"model": "string",
"machineTypeCode": "string",
"minDriverversion": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

updateMachineSpecificationStatus

query Parameters

id required	string
isActive required	boolean

Responses

deleteMachineSpecification

path Parameters

id

required

string

Responses

searchMachineSpecification

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

machineSpecificationFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllMachineSpecifications

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

machine-history-controller

getMachineHistoryIdLangEff

path Parameters

id required	string
langcode required	string
effdatetimes required	string

Responses

getMachineHistoryIdLangEff_1

path Parameters

id required	string
langcode required	string
effdatetimes required	string

Responses

machine-controller

getMachineAll

Responses

updateMachienAdmin

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MachinePutReqDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"serialNum": "string",
"isActive": true,
"macAddress": "string",
"ipAddress": "string",
"machineSpecId": "string",
"langCode": "string",
"validityDateTime": "2019-08-24T14:15:22Z",
"zoneCode": "string",
"regCenterId": "string",
"publicKey": "string",
"signPublicKey": "string"
}
}

createMachine

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (MachinePostReqDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"serialNum": "string",
"macAddress": "string",
"ipAddress": "string",
"machineSpecId": "string",
"langCode": "string",
"isActive": true,
"validityDateTime": "2019-08-24T14:15:22Z",
"zoneCode": "string",
"regCenterId": "string",
"publicKey": "string",
"signPublicKey": "string"
}
}

updateMachienStatus

query Parameters

id required	string
isActive required	boolean

Responses

getMachineIdById

path Parameters

id

required

string

Responses

deleteMachine

path Parameters

id

required

string

Responses

searchMachine

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMachinesByRegistrationCenter

path Parameters

regCenterId

required

string

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 1
orderBy	string Default: "cr_dtimes"
direction	string Default: "DESC"

Responses

machineFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

decommissionMachine

path Parameters

machineId

required

string

Responses

location-controller

updateLocationHierarchyDetails

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (LocationPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"hierarchyLevel": 0,
"hierarchyName": "string",
"parentLocCode": "string",
"isActive": true,
"langCode": "string"
}
}

createLocationHierarchyDetails

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (LocationCreateDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"hierarchyLevel": 0,
"hierarchyName": "string",
"parentLocCode": "string",
"langCode": "string",
"isActive": true
}
}

updateLocationStatus

query Parameters

code required	string
isActive required	boolean

Responses

deleteLocationHierarchyDetails

path Parameters

locationcode

required

string

Responses

getLocationHierarchyByLangCode

path Parameters

locationcode required	string
langcode required	string

Responses

getLocationHierarchyDetails

path Parameters

langcode

required

string

Responses

validateLocationName

path Parameters

locationname

required

string

Responses

searchLocation

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMissingLocationDetails

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

getLocationDataByHierarchyName

path Parameters

hierarchyname

required

string

Responses

getLocationCodeByLangCode

path Parameters

langcode

required

string

Responses

getLocationDetailsByLangCode

path Parameters

locationcode required	string
langcode required	string

Responses

getImmediateChildrenByLocCodeAndLangCode

path Parameters

locationcode required	string
langcode required	string

Responses

locationFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getLocations

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

location-hierarchy-controller

getLocationHierarchyLevel

query Parameters

lastUpdated

string

Responses

getLocationHierarchyLevelAndLangCode

path Parameters

level required	integer <int32>
langcode required	string

Responses

getModuleLangCode_1

path Parameters

langcode

required

string

Responses

language-controller

getAllLaguages

Responses

updateLanguage

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (LanguagePutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"family": "string",
"isActive": true,
"nativeName": "string"
}
}

saveLanguage

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (LanguageDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"family": "string",
"nativeName": "string",
"isActive": true
}
}

updateLanguageStatus

query Parameters

code required	string
isActive required	boolean

Responses

deleteLanguage

path Parameters

code

required

string

Responses

individual-type-controller

getAllIndividualTypes Deprecated

Responses

updateIndividualType Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (IndividualTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"name": "string",
"isActive": true
}
}

createIndividualType Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (IndividualTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"name": "string",
"isActive": true
}
}

searchIndividuals Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

individualsFilterValues Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getIndividualTypes Deprecated

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

id-type-controller

createIdType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (IdTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"descr": "string",
"name": "string",
"langCode": "string",
"isActive": true
}
}

getIdTypesByLanguageCode

path Parameters

langcode

required

string

Responses

schema-controller

updateSchema

query Parameters

id

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (IdentitySchemaDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"title": "string",
"description": "string",
"schema": "string"
}
}

createSchema

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (IdentitySchemaDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"title": "string",
"description": "string",
"schema": "string"
}
}

deleteSchema

query Parameters

id

required

string

Responses

publishSchema

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (IdSchemaPublishDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"effectiveFrom": "2019-08-24T14:15:22Z"
}
}

getLatestPublishedSchema_1

query Parameters

schemaVersion	number <double> Default: 0
domain	string
type	string

Responses

getAllSchema

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "cr_dtimes"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

holiday-controller

getAllHolidays

Responses

updateHoliday

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (HolidayUpdateDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"holidayId": 0,
"locationCode": "string",
"holidayDate": "2019-08-24",
"holidayName": "string",
"holidayDesc": "string",
"isActive": true,
"langCode": "string"
}
}

saveHoliday

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (HolidayDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"locationCode": "string",
"holidayDate": "2019-08-24",
"holidayName": "string",
"holidayDesc": "string",
"langCode": "string",
"isActive": true,
"holidayId": 0
}
}

deleteHoliday

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (HolidayIdDeleteDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"locationCode": "string",
"holidayDate": "2019-08-24"
}
}

updateHolidayStatus

query Parameters

holidayId required	string
isActive required	boolean

Responses

getAllHolidayById

path Parameters

holidayid

required

integer <int32>

Responses

getAllHolidayByIdAndLangCode

path Parameters

holidayid required	integer <int32>
langcode required	string

Responses

searchMachine_1

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMissingHolidayDetails

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

holidayFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getHolidays

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

registration-center-user-machine-history-controller

getRegistrationCentersMachineUserMapping

path Parameters

effdtimes required	string
registrationcenterid required	string
machineid required	string
userid required	string

Responses

biometric-attribute-controller

getBiometricAttributesByBiometricType

path Parameters

langcode required	string
biometrictypecode required	string

Responses

createBiometricAttribute

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (BiometricAttributeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"biometricTypeCode": "string",
"langCode": "string",
"isActive": true
}
}

applicant-type-controller

getApplicantType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"attributes": [{"attribute": "string",
"value": { }
}
]
}
}

gender-type-controller

getAllGenderType Deprecated

Responses

updateGenderType Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (GenderTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"genderName": "string",
"langCode": "string",
"isActive": true
}
}

saveGenderType Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (GenderTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"genderName": "string",
"langCode": "string",
"isActive": true
}
}

getGenderBylangCode Deprecated

path Parameters

langcode

required

string

Responses

deleteGenderType Deprecated

path Parameters

code

required

string

Responses

valdiateGenderName Deprecated

path Parameters

gendername

required

string

Responses

searchGenderTypes Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

genderFilterValues Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllGenders Deprecated

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

foundational-trust-provider-controller

updateFoundationalTrustProvider Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FoundationalTrustProviderPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"address": "string",
"email": "string",
"contactNo": "string",
"certAlias": "string",
"isActive": true
}
}

registerFoundationalTrustProvider Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FoundationalTrustProviderDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"address": "string",
"email": "string",
"contactNo": "string",
"certAlias": "string",
"isActive": true
}
}

exceptional-holiday-controller

getExceptionalHolidaysWithoutLangCode

path Parameters

registrationCenterId

required

string

Responses

getExceptionalHolidays

path Parameters

registrationCenterId required	string
langCode required	string

Responses

dynamic-field-controller

getAllDynamicFields

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
langCode	string
lastUpdated	string

Responses

updateDynamicField

query Parameters

id

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DynamicFieldPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"langCode": "string",
"dataType": "string",
"description": "string",
"fieldVal": { }
}
}

createDynamicField

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DynamicFieldDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"langCode": "string",
"dataType": "string",
"description": "string",
"fieldVal": { }
}
}

updateDynamicFieldStatus

query Parameters

isActive required	boolean
id required	string

Responses

deleteDynamicField

path Parameters

id

required

string

Responses

searchDynamicFields

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMissingDynamicFields

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

dynamicFieldFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getDistinctDynamicFields

Responses

getDistinctDynamicFieldsBasedOnLang

path Parameters

langCode

required

string

Responses

updateAllDynamicFieldStatus

query Parameters

isActive required	boolean
fieldName required	string

Responses

deleteAllDynamicField

path Parameters

fieldName

required

string

Responses

document-type-controller

updateDocumentType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DocumentTypePutReqDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"isActive": true,
"langCode": "string"
}
}

createDocumentType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DocumentTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

updateDocumentTypeStatus

query Parameters

isActive required	boolean
code required	string

Responses

getAllDocumentTypeByLaguageCode

path Parameters

langcode

required

string

Responses

getDoucmentTypesForDocumentCategoryAndLangCode

path Parameters

langcode required	string
documentcategorycode required	string

Responses

deleteDocumentType

path Parameters

code

required

string

Responses

searchDocumentType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMissingDocumentTypeDetails

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

documentTypeFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllDocumentTypes

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

document-category-controller

getAllDocumentCategory

Responses

updateDocumentCategory

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DocumentCategoryPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"isActive": true,
"langCode": "string"
}
}

createDocumentCategory

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DocumentCategoryDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

updateDocumentCategoryStatus

query Parameters

isActive required	boolean
code required	string

Responses

getAllDocumentCategoryByLaguageCode

path Parameters

langcode

required

string

Responses

deleteDocumentCategory_1

path Parameters

code

required

string

Responses

getDocumentCategoryByCodeAndLangCode

path Parameters

code required	string
langcode required	string

Responses

searchDocCategories

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getMissingDocumentCategoryDetails

path Parameters

langcode

required

string

query Parameters

fieldName

string

Responses

docCategoriesFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllDocCategories

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

device-type-controller

updateDeviceType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeviceTypePutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"isActive": true,
"name": "string",
"description": "string"
}
}

createDeviceType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeviceTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"langCode": "string",
"name": "string",
"description": "string",
"isActive": true
}
}

updateDeviceTypeStatus

query Parameters

isActive required	boolean
code required	string

Responses

deviceTypeSearch

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

deviceTypeFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getAllDeviceTypes

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

device-specification-controller

getDeviceSpecificationByLanguageCode Deprecated

path Parameters

langcode

required

string

Responses

updateDeviceSpecification

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeviceSpecificationPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"brand": "string",
"model": "string",
"deviceTypeCode": "string",
"minDriverversion": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

createDeviceSpecification

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeviceSpecificationDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"brand": "string",
"model": "string",
"deviceTypeCode": "string",
"minDriverversion": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

updateDeviceSpecificationStatus

query Parameters

isActive required	boolean
id required	string

Responses

deleteDeviceSpecification

path Parameters

id

required

string

Responses

deviceSpecificationSearch

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

deviceSpecificationFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

getDeviceSpecificationByLanguageCodeAndDeviceTypeCode

path Parameters

langcode required	string
devicetypecode required	string

Responses

getDeviceSpecificationByLanguageCodeAndDeviceTypeCode_1

path Parameters

langcode required	string
devicetypecode required	string

Responses

getAllDeviceSpecifications

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

getDeviceSpecificationByLanguageCode_1 Deprecated

path Parameters

langcode

required

string

Responses

device-history-controller

getDeviceHistoryIdLangEff

path Parameters

id required	string
langcode required	string
effdatetimes required	string

Responses

device-controller

updateDevice_1

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DevicePutReqDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"name": "string",
"serialNum": "string",
"deviceSpecId": "string",
"macAddress": "string",
"ipAddress": "string",
"langCode": "string",
"isActive": true,
"validityDateTime": "2019-08-24T14:15:22Z",
"zoneCode": "string",
"regCenterId": "string"
}
}

createDevice

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeviceDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"serialNum": "string",
"deviceSpecId": "string",
"macAddress": "string",
"ipAddress": "string",
"langCode": "string",
"isActive": true,
"validityDateTime": "2019-08-24T14:15:22Z",
"zoneCode": "string",
"regCenterId": "string"
}
}

updateDeviceStatus

query Parameters

isActive required	boolean
id required	string

Responses

getDeviceLang

path Parameters

langCode

required

string

Responses

getDeviceLangCodeAndDeviceType

path Parameters

langCode required	string
deviceType required	string

Responses

deleteDevice

path Parameters

id

required

string

Responses

searchDevice

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDtoWithoutLangCode)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

getDevicesByRegistrationCenter

path Parameters

regCenterId

required

string

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
orderBy	string Default: "cr_dtimes"
direction	string Default: "DESC"

Responses

deviceFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

decommissionDevice

path Parameters

deviceId

required

string

Responses

device-provider-management-controller

validateDeviceProvider Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (ValidateDeviceDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"deviceCode": "string",
"digitalId": {"serialNo": "string",
"dp": "string",
"dpId": "string",
"make": "string",
"model": "string",
"deviceSubType": "string",
"type": "string",
"dateTime": "string"
},
"deviceServiceVersion": "string",
"timeStamp": "string",
"purpose": "string"
}
}

device-provider-controller

updateDeviceProvider Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeviceProviderPutDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"vendorName": "string",
"address": "string",
"email": "string",
"contactNumber": "string",
"certificateAlias": "string"
}
}

createDeviceProvider Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DeviceProviderDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"vendorName": "string",
"address": "string",
"email": "string",
"contactNumber": "string",
"certificateAlias": "string",
"isActive": true
}
}

device-register-controller

deRegisterDevice_2 Deprecated

query Parameters

devicecode required	string
statuscode required	string

Responses

deRegisterDevice_3 Deprecated

path Parameters

deviceCode

required

string

Responses

application-config-controller

getConfigValues

Responses

getAllApplication_1 Deprecated

Responses

blocklisted-words-controller

updateBlockListedWord

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (BlockListedWordsUpdateDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"word": "string",
"oldWord": "string",
"langCode": "string",
"isActive": true,
"description": "string"
}
}

createBlockListedWord

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (BlocklistedWordsDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"word": "string",
"langCode": "string",
"description": "string",
"isActive": true
}
}

updateBlockListedWordStatus

query Parameters

isActive required	boolean
word required	string

Responses

deleteBlockListedWord

path Parameters

word

required

string

Responses

getAllBlockListedWordByLangCode

path Parameters

langcode

required

string

Responses

validateWords

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (BlocklistedWordListRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"blocklistedwords": ["string"
]
}
}

searchBlockListedWords

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"languageCode": "string"
}
}

blockListedWordsFilterValues

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"languageCode": "string",
"optionalFilters": [{"value": "string",
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

updateBlockListedWordExceptWord

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (BlocklistedWordsDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"word": "string",
"langCode": "string",
"description": "string",
"isActive": true
}
}

getAllBlocklistedWords

query Parameters

pageNumber	integer <int32> Default: 0
pageSize	integer <int32> Default: 10
sortBy	string Default: "createdDateTime"
orderBy	string Default: "desc" Enum: "asc" "desc"

Responses

biometric-type-controller

getAllBiometricTypes

Responses

createBiometricType

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (BiometricTypeDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

getAllBiometricTypesByLanguageCode

path Parameters

langcode

required

string

Responses

getBiometricTypeByCodeAndLangCode

path Parameters

code required	string
langcode required	string

Responses

application-controller

getAllApplication Deprecated

Responses

createApplication Deprecated

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (ApplicationDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"code": "string",
"name": "string",
"description": "string",
"langCode": "string",
"isActive": true
}
}

getAllApplicationByLanguageCode Deprecated

path Parameters

langcode

required

string

Responses

getApplicationByCodeAndLanguageCode Deprecated

path Parameters

code required	string
langcode required	string

Responses

applicant-valid-document-controller

getApplicantValidDocument

path Parameters

applicantId

required

string

query Parameters

languages

required

Array of strings

Home

Admin Master Service (1.0)

zone-user-controller

updateapUserZone

Request Body schema: application/json

Responses

Request samples

mapUserZone

Request Body schema: application/json

Responses

Request samples

updateapUserZoneStatus

query Parameters

Responses

deleteMapUserZone

path Parameters

Responses

searchZoneUserMapping

Request Body schema: application/json

Responses

Request samples

getHistoryByUserIdAndTimestamp

path Parameters

Responses

zone-controller

getZoneNameBasedOnUserIDAndLangCode

query Parameters

Responses

getSubZones

path Parameters

Responses

getLeafZonesBasedOnZoneCode

path Parameters

Responses

getLeafZones

path Parameters

Responses

getZoneHierarchy

path Parameters

Responses

zoneFilterValues

Request Body schema: application/json

Responses

Request samples

authorizeZone

query Parameters

Responses

working-day-controller

updateWorkingDays

Request Body schema: application/json

Responses

Request samples

updateWorkingDaysStatus

query Parameters

Responses

getWorkingays

path Parameters

Responses

getWorkingDaysByLangCode

path Parameters

Responses

getWeekDays

path Parameters

Responses

valid-document-controller

createValidDocument

Request Body schema: application/json

Responses

Request samples

getValidDocumentByLangCode

path Parameters

Responses

deleteValidDocuemnt

path Parameters

Responses

getValidDocumentByDocCategoryCode

path Parameters

Responses

unmapDocCategoryAndDocType

path Parameters