Property Registry

Property Registry APIs

Create new properties, update or search existing properties.

create

post
/assessment/_create
Body
Responses
200

OK

*/*
post
/assessment/_create

plainsearch

post
/assessment/_plainsearch
Query parameters
assessmentNumbersstring[]Optional
financialYearstringOptional
idsstring[]Optional
limitinteger · int64Optional
offsetinteger · int64Optional
propertyIdsstring[]Optional
statusstring · enumOptionalPossible values:
tenantIdstringRequired
Body
Responses
200

OK

*/*
post
/assessment/_plainsearch

search

post
/assessment/_search
Query parameters
assessmentNumbersstring[]Optional
financialYearstringOptional
idsstring[]Optional
limitinteger · int64Optional
offsetinteger · int64Optional
propertyIdsstring[]Optional
statusstring · enumOptionalPossible values:
tenantIdstringRequired
Body
Responses
200

OK

*/*
post
/assessment/_search

update

post
/assessment/_update
Body
Responses
200

OK

*/*
post
/assessment/_update

_addAlternateNumber

post
/property/_addAlternateNumber
Body
Responses
200

OK

*/*
post
/property/_addAlternateNumber

create

post
/property/_create
Body
Responses
200

OK

*/*
post
/property/_create

encryptOldData

post
/property/_encryptOldData
Query 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

*/*
post
/property/_encryptOldData

propertyMigration

post
/property/_migration
Query 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
post
/property/_migration

plainsearch

post
/property/_plainsearch
Query 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

*/*
post
/property/_plainsearch

search

post
/property/_search
Query 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

*/*
post
/property/_search

update

post
/property/_update
Body
Responses
200

OK

*/*
post
/property/_update

fuzzySearch

post
/property/fuzzy/_search
Query 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

*/*
post
/property/fuzzy/_search

Last updated

Was this helpful?