Property Registry
Property Registry APIs
Create new properties, update or search existing properties.
Query parameters
assessmentNumbersstring[]Optional
financialYearstringOptional
idsstring[]Optional
limitinteger · int64Optional
offsetinteger · int64Optional
propertyIdsstring[]Optional
statusstring · enumOptionalPossible values:
tenantIdstringRequired
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/assessment/_plainsearchQuery parameters
assessmentNumbersstring[]Optional
financialYearstringOptional
idsstring[]Optional
limitinteger · int64Optional
offsetinteger · int64Optional
propertyIdsstring[]Optional
statusstring · enumOptionalPossible values:
tenantIdstringRequired
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/assessment/_searchQuery parameters
acknowledgementIdsstring[]Optional
auditbooleanOptional
creationReasonstring[]Optional
doorNostringOptional
fromDateinteger · int64Optional
isCitizenbooleanOptional
isInboxSearchbooleanOptional
isRequestForCountbooleanOptional
isRequestForOldDataEncryptionbooleanOptional
isSearchInternalbooleanOptional
limitinteger · int64Optional
localitystringOptional
mobileNumberstringOptional
namestringOptional
offsetinteger · int64Optional
oldPropertyIdstringOptional
oldpropertyidsstring[]Optional
ownerIdsstring[]Optional
propertyIdsstring[]Optional
statusarray · enumOptionalPossible values:
tenantIdstringOptional
tenantIdsstring[]Optional
toDateinteger · int64Optional
uuidsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/property/_encryptOldDataQuery parameters
accountIdstringOptional
addressidsstring[]Optional
asOnDateinteger · int64Optional
documentidsstring[]Optional
doorNostringOptional
financialYearstringOptional
idsstring[]Optional
limitinteger · int64Optional
localitystringOptional
mobileNumberstringOptional
namestringOptional
offsetinteger · int64Optional
oldpropertyidsstring[]Optional
owneridsstring[]Optional
propertyDetailStatusstring · enumOptionalPossible values:
propertyDetailidsstring[]Optional
propertyIdstringOptional
statusesarray · enumOptionalPossible values:
tenantIdstringOptional
unitidsstring[]Optional
userNamestringOptional
Body
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/property/_migrationQuery parameters
acknowledgementIdsstring[]Optional
auditbooleanOptional
creationReasonstring[]Optional
doorNostringOptional
fromDateinteger · int64Optional
isCitizenbooleanOptional
isInboxSearchbooleanOptional
isRequestForCountbooleanOptional
isRequestForOldDataEncryptionbooleanOptional
isSearchInternalbooleanOptional
limitinteger · int64Optional
localitystringOptional
mobileNumberstringOptional
namestringOptional
offsetinteger · int64Optional
oldPropertyIdstringOptional
oldpropertyidsstring[]Optional
ownerIdsstring[]Optional
propertyIdsstring[]Optional
statusarray · enumOptionalPossible values:
tenantIdstringOptional
tenantIdsstring[]Optional
toDateinteger · int64Optional
uuidsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/property/_plainsearchQuery parameters
acknowledgementIdsstring[]Optional
auditbooleanOptional
creationReasonstring[]Optional
doorNostringOptional
fromDateinteger · int64Optional
isCitizenbooleanOptional
isInboxSearchbooleanOptional
isRequestForCountbooleanOptional
isRequestForOldDataEncryptionbooleanOptional
isSearchInternalbooleanOptional
limitinteger · int64Optional
localitystringOptional
mobileNumberstringOptional
namestringOptional
offsetinteger · int64Optional
oldPropertyIdstringOptional
oldpropertyidsstring[]Optional
ownerIdsstring[]Optional
propertyIdsstring[]Optional
statusarray · enumOptionalPossible values:
tenantIdstringOptional
tenantIdsstring[]Optional
toDateinteger · int64Optional
uuidsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/property/_searchQuery parameters
acknowledgementIdsstring[]Optional
auditbooleanOptional
creationReasonstring[]Optional
doorNostringOptional
fromDateinteger · int64Optional
isCitizenbooleanOptional
isInboxSearchbooleanOptional
isRequestForCountbooleanOptional
isRequestForOldDataEncryptionbooleanOptional
isSearchInternalbooleanOptional
limitinteger · int64Optional
localitystringOptional
mobileNumberstringOptional
namestringOptional
offsetinteger · int64Optional
oldPropertyIdstringOptional
oldpropertyidsstring[]Optional
ownerIdsstring[]Optional
propertyIdsstring[]Optional
statusarray · enumOptionalPossible values:
tenantIdstringOptional
tenantIdsstring[]Optional
toDateinteger · int64Optional
uuidsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
/property/fuzzy/_searchLast updated
Was this helpful?