Residents

Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Residents

The residents in Address
Service.

POST /residents/{organizationId}/query

Description

Query residents by polygon, address, and the Additional Information field.

Get residents from Address service by address(PatternObjectFilter),
polygon(PolygonFilter), and additional field(PropertyFilter).

1    Will throw 401
Unauthorized error when the below verification failed:

a    Check feature NATIONAL_REGISTRY

b    Check feature FILTER_BY_IMPORT when the query condition includes umsPatterns

c    Check feature ADDITIONAL_INFORMATION when the query condition includes properties

2    If the given
parameters include property(additionalField) but there is no field selected for current organization in
EB-Admin, will not build a PropertyFilter. Otherwise, the organization set several fields and some of
the given fields are invalid, will ignore these fields.

Method

POST

Parameters

ParameterMandatoryTypeDefault ValueDescription

filters

Y

ResidentFiltersWrapper

residentFiltersWrapper which includes address/polygon/property filters.

page

N

Integer

1

Page to query

pageSize

N

Integer

25

Page size to query

 

Request Body

Request sample

Request Description

1    Support UMS
residents query with polygoins, so use ebsuite field “searchShapes” to transmit polygons data,
and add residents.searchBySearchShapes=true to represent UMS residents query to distinguish with normal
polygons query.

2    pattern has four
values: street, matrikkel, fastighetsnyckel, riksnyckel

Each type has related values (have different fields and validation)

patternvalues

sttreet

"kommune": required & numeric value
"gateid": required & numeric value
"husnr": optional & numeric value
"bokstav": optional & a letter, just one character
"apartmentid": optional & a combination of characters and numbers

matrikkel

"kommune": required & numeric value
"gnr": required & numeric value
"bnr": required & numeric value
"fnr": optional & numeric value

fastighetsnyckel

"snr":required & numeric value
"nr": optional & numeric value
"suffix": optional & a letter, just one character
"apartment": optional & a combination of characters and numbers

riksnyckel

"unr": required & numeric value

3    The properties could
include more additional fields.

entryType : Filter capability need be provided by
address-service.

owner_type (only supported in the
Norway region):

Value Description

R RESIDENT

B OWNER B as in the Norwegian "Boligeier". Property owners
of residential homes.

F VACATION F as in the Norwegian "Fritidsbolig" . Owners of
holiday houses (cabins etc.)

supported by propertyFilter

Vulnerable: Not supported in current address service. It is only
supported in company resident.

Response

200

Exceptions

HTTP Status CodeResponse Body

400

Missing or invalid request input.

401

Missing or invalid credentials.

500

Internal Error