Algolytics DQ – online API

Algolytics Technologies Sp. z o.o.
DQ-online v1.0

Table of Contents

For more Algolytics products visit us at https://algolytics.com/.

Overview

API for online and automatic address data cleaning.

User operations

Clean rows

Method POST
Path /api/scenario/code/remote/score?name=dqonline_auth&key=31b1108c-c2b3-4b7d-99f1-6b83def1c6a0

A method for cleaning given rows of raw data. The order of the input rows is preserved in the output array. There are restrictions on combining address data properties, see Restrictions on combining address data properties for more details. All fields in the output structure are optional and depend on the process parameters.

HTTP status codes

Status code Usage
200 OK The request completed successfully.
207 Multi-Status There were errors cleansing some records. Records for which processing error has occurred may be partially cleansed. Such records will contain the [error] object in the resulting JSON object.
401 Unauthorized The request has not been applied because it lacks valid authentication credentials for the target resource.
400 Bad Request The request was malformed. The response body will include an error providing further information.
415 Unsupported Media Type The request entity has a media type which the server does not support.
503 Service Unavailable The request was well-formed but data cleansing is currently unavailable due to maintenance.
5xx Unexpected Server Error The server failed to fulfill an apparently valid request. If an unspecified error in range 500-599 occurred contact our support at support@algolytics.pl.

Request structure

Table 13. Request headers
Name Description
Accept: application/json;charset=UTF-8
Content-Type application/json;charset=UTF-8

 

Table 14. Request fields
Path Type Description
secret_key String An authorization token obtained by the registration e-mail
query.inputRows Array An array of input rows to be processed
query.processParameters Object Parameters configuring the data cleansing process
query.inputRows[].postalCode String [Optional] Postal code
query.inputRows[].cityName String [Optional] City name
query.inputRows[].streetName String [Optional] Street name
query.inputRows[].streetNumber String [Optional] Street number
query.inputRows[].apartmentNumber String [Optional] Apartment number
query.inputRows[].streetNumberAndApartmentNumber String [Optional] Concatenation of the street number and apartment number (alternative to separate fields: streetNumber, apartmentNumber)
query.inputRows[].streetNameAndStreetNumberAndApartmentNumber String [Optional] Concatenation of the street name, street number and apartment number (alternative to separate fields: streetName, streetNumber, apartmentNumber)
query.inputRows[].voivodeshipName String [Optional] Voivodeship name
query.inputRows[].countyName String [Optional] County name
query.inputRows[].communeName String [Optional] Commune name
query.inputRows[].generalData String [Optional] Concatenation of all address information available
query.processParameters.activeModules Array Modules that will be used to process input data. Available values are:

“ADDRESSES” (enables address processing)

query.processParameters.includeSymbolicNames Boolean Enabling this option includes symbolic names (GUS TERYT identifiers) for cities, streets and communes on the output
query.processParameters.includeGusZones Boolean Enabling this option includes GUS statistical region and census circuit information on the output
query.processParameters.includeGeographicCoordinates Boolean Enabling this option includes geographic coordinates (latitude and longitude) on the output
query.processParameters.includeBuildingsInfo Boolean Enabling this option includes number of flats and residents of the buildings on the output
query.processParameters.includeDiagnosticInfo Boolean Enabling this option includes detailed information about the status of matching and geocoding on the output

Response structure

Table 15. Response headers
Name Description
Content-Type application/json;charset=UTF-8

 

Table 16. Response fields
Path Type Description
result.response Array An array of output rows containing the cleansed data
result.response[].cityName String Cleaned city name.

Requires [ADDRESSES] module

result.response[].cityDistrictName String Cleaned city district name.

Requires [ADDRESSES] module

result.response[].streetAttribute String Street attribute (e.g. ul., al., pl.).

Requires [ADDRESSES] module

result.response[].streetName String Cleaned street name (without street attribute).

Requires [ADDRESSES] module

result.response[].streetNameMajorPart String The main part of the street name (e.g. the surname of the patron).

Requires [ADDRESSES] module

result.response[].streetNameMinorPart String A less important part of the street name (does not always exist, e.g. the first name of the patron).

Requires [ADDRESSES] module

result.response[].streetNumber String Cleaned street number.

Requires [ADDRESSES] module

result.response[].apartmentNumber String Cleaned apartment number.

Requires [ADDRESSES] module

result.response[].numberOfApartments Number Number of apartments according to the GUS.

Requires [ADDRESSES] module

result.response[].numberOfJuridicalPersons Number Number of juridical persons and organizational units located in a given building according to the REGON register.

Requires [ADDRESSES] module

result.response[].postalCode String Cleaned postal code with NN-NNN format where N is a digit (0-9).

Requires [ADDRESSES] module

result.response[].communeName String Cleaned commune name.

Requires [ADDRESSES] module

result.response[].countyName String Cleaned county name.

Requires [ADDRESSES] module

result.response[].voivodeshipName String Cleaned voivodeship name.

Requires [ADDRESSES] module

result.response[].citySymbol String Symbolic name for city (GUS TERYT identifier).

Requires [ADDRESSES] module and [includeSymbolicNames] option enabled

result.response[].cityDistrictSymbol String Symbolic name for city district (GUS TERYT identifier).

Requires [ADDRESSES] module and [includeSymbolicNames] option enabled

result.response[].streetSymbol String Symbolic name for street (GUS TERYT identifier).

Requires [ADDRESSES] module and [includeSymbolicNames] option enabled

result.response[].communeSymbol String Commune code with XXYYZZ format where XX is voivodship code, YY is county within voivodship code, ZZ is commune within county code.

Requires [ADDRESSES] module and [includeSymbolicNames] option enabled

result.response[].communeTypeName String Name of the commune type, one of: “gmina miejska”, “gmina wiejska”, “część miejska gminy miejsko-wiejskiej”, “część wiejska gminy miejsko-wiejskiej”.

Requires [ADDRESSES] module and [includeSymbolicNames] option enabled

result.response[].communeTypeSymbol Number Numeric symbol of the commune type, one of: 1 (for gmina miejska), 2 (for gmina wiejska), 4 (for część miejska gminy miejsko-wiejskiej), 5 (for część wiejska gminy miejsko-wiejskiej).

Requires [ADDRESSES] module and [includeSymbolicNames] option enabled

result.response[].statisticalRegionSymbol String Commune code, along with its type and statistical region in the given format: XXYYZZTRRRRRRRR where XXYYZZ is [communeSymbol], T is [communeTypeSymbol], RRRRRRRR is 8-digit statistical region code (GUS TERYT identifier).

Requires [ADDRESSES] module and [includeGusZones] option enabled

result.response[].censusCircuitSymbol String Commune code, along with its type, statistical region and census circuit within this region in the given format: XXYYZZTRRRRRRRRC where XXYYZZTRRRRRRRR is [statisticalRegionSymbol], C is census circuit within statistical region code (GUS TERYT identifier).

Requires [ADDRESSES] module and [includeGusZones] option enabled

result.response[].numberOfInhabitedApartmentsByGUS Number Number of inhabited apartments according to the GUS.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfInhabitantsByGUS Number Number of inhabitants according to the GUS.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfInhabitedApartmentsByPESEL Number Number of inhabited apartments according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfInhabitantsByPESEL Number Number of inhabitants according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomen Number Number of female inhabitants according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMen Number Number of male inhabitants according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_0_4_yearsOld Number Number of female inhabitants between 0 and 4 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_5_9_yearsOld Number Number of female inhabitants between 5 and 9 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_10_14_yearsOld Number Number of female inhabitants between 10 and 14 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_15_19_yearsOld Number Number of female inhabitants between 15 and 19 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_20_24_yearsOld Number Number of female inhabitants between 20 and 24 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_25_29_yearsOld Number Number of female inhabitants between 25 and 29 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_30_34_yearsOld Number Number of female inhabitants between 30 and 34 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_35_39_yearsOld Number Number of female inhabitants between 35 and 39 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_40_44_yearsOld Number Number of female inhabitants between 40 and 44 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_45_49_yearsOld Number Number of female inhabitants between 45 and 49 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_50_54_yearsOld Number Number of female inhabitants between 50 and 54 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_55_59_yearsOld Number Number of female inhabitants between 55 and 59 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_60_64_yearsOld Number Number of female inhabitants between 60 and 64 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_65_69_yearsOld Number Number of female inhabitants between 65 and 69 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenBetween_70_74_yearsOld Number Number of female inhabitants between 70 and 74 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfWomenOver_75_yearsOld Number Number of female inhabitants over 75 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_0_4_yearsOld Number Number of male inhabitants between 0 and 4 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_5_9_yearsOld Number Number of male inhabitants between 5 and 9 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_10_14_yearsOld Number Number of male inhabitants between 10 and 14 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_15_19_yearsOld Number Number of male inhabitants between 15 and 19 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_20_24_yearsOld Number Number of male inhabitants between 20 and 24 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_25_29_yearsOld Number Number of male inhabitants between 25 and 29 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_30_34_yearsOld Number Number of male inhabitants between 30 and 34 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_35_39_yearsOld Number Number of male inhabitants between 35 and 39 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_40_44_yearsOld Number Number of male inhabitants between 40 and 44 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_45_49_yearsOld Number Number of male inhabitants between 45 and 49 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_50_54_yearsOld Number Number of male inhabitants between 50 and 54 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_55_59_yearsOld Number Number of male inhabitants between 55 and 59 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_60_64_yearsOld Number Number of male inhabitants between 60 and 64 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_65_69_yearsOld Number Number of male inhabitants between 65 and 69 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenBetween_70_74_yearsOld Number Number of male inhabitants between 70 and 74 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].numberOfMenOver_75_yearsOld Number Number of male inhabitants over 75 years old according to the PESEL register provided by the Ministry of Digitization.

Requires [ADDRESSES] module and [includeBuildingsInfo] option enabled

result.response[].statuses String Concatenation of matching and geocoding statuses in the given format: “<category:result>” or “<category>” where the category can take one of the values: “przypisanie niejednoznaczne“, “zmiana nazwy miejscowości“, “zmiana nazwy ulicy“, “dopasowanie“, “geokodowanie“.

Requires [ADDRESSES] module and [includeDiagnosticInfo] option enabled

result.response[].longitude Number East longitude degree value.

Requires [ADDRESSES] module and [includeGeographicCoordinates] option enabled

result.response[].latitude Number North latitude degree value.

Requires [ADDRESSES] module and [includeGeographicCoordinates] option enabled

result.response[].error Object Object indicating that an error occurred while processing the given row. Contains details about the error
result.response[].error.message String An error message explaining that the input row was incorrect or an unexpected application error occurred
result.response[].error.status String Numeric error representation. The following codes are provided:

“001” – null input row,

“002” – violation of Restrictions on combining address data properties,

“500” – unexpected server error

Example

curl -X POST   ‘https://server.address/api/scenario/code/remote/score?name=dqonline_auth&key=31b1108c-c2b3-4b7d-99f1-6b83def1c6a0′   -H ‘Accept: application/json;charset=UTF-8′   -H ‘Cache-Control: no-cache’   -H ‘Connection: keep-alive’   -H ‘Content-Type: application/json’   -d ‘{ 

    “query”: { 

        “inputRows“: [ 

            { 

                “cityName“: ” Warszawa  “, 

                “streetName“:”PRZESKOK”, 

                “streetNumber”:”2″, 

                “postalCode”:”00-031″ 

            }, 

            { 

               “generalData“: “Przeskok 2 |00031 Warszawa” 

            }, 

            { 

               “generalData“: “eygyg oeirioewo hduehdue Przeskok 2 Warszawa wuehwhd ewudheu “ 

            } 

        ], 

        “processParameters“: { 

            “activeModules“: [ 

                “ADDRESSES” 

            ], 

            “includeSymbolicNames“: true, 

            “includeGusZones“: true, 

            “includeGeographicCoordinates“: true, 

            “includeBuildingsInfo“: true, 

            “includeDiagnosticInfo“: true 

        } 

    }, 

    “secret_key“: “*****“ 

}’ 
{ 

    "name": "dqonline_auth", 

    "beginTime": "2019-07-12T10:53:27.429882Z", 

    "endTime": "2019-07-12T10:53:27.956312Z", 

    "result": { 

        "response": [ 

            { 
"statuses": "", 
"cityName": "Warszawa", 
"citySymbol": "0918123", 
"cityDistrictName": "Mokotów", 
"cityDistrictSymbol": "0918130", 
"streetName": "Stanisława Żaryna", 
"streetSymbol": "36771", 
"streetAttribute": "ul.", 
"streetNameMajorPart": "Żaryna", 
"streetNameMinorPart": "Stanisława", 
"postalCode": "02-593", 
"streetNumber": "2A", 
"voivodeshipName": "mazowieckie", 
"countyName": "Warszawa", 
"communeName": "Warszawa", 
"communeSymbol": "146501", 
"communeTypeSymbol": 1, 
"communeTypeName": "gmina miejska", 
"numberOfApartments": 0, 
"numberOfInhabitedApartmentsByGUS": 0, 
"numberOfInhabitedApartmentsByPESEL": 0, 
"numberOfInhabitantsByGUS": 0, 
"numberOfInhabitantsByPESEL": 0, 
"numberOfMen": 0, 
"numberOfMenBetween_0_4_yearsOld": 0, 
"numberOfMenBetween_5_9_yearsOld": 0, 
"numberOfMenBetween_10_14_yearsOld": 0, 
"numberOfMenBetween_15_19_yearsOld": 0, 
"numberOfMenBetween_20_24_yearsOld": 0, 
"numberOfMenBetween_25_29_yearsOld": 0, 
"numberOfMenBetween_30_34_yearsOld": 0, 
"numberOfMenBetween_35_39_yearsOld": 0, 
"numberOfMenBetween_40_44_yearsOld": 0, 
"numberOfMenBetween_45_49_yearsOld": 0, 
"numberOfMenBetween_50_54_yearsOld": 0, 
"numberOfMenBetween_55_59_yearsOld": 0, 
"numberOfMenBetween_60_64_yearsOld": 0, 
"numberOfMenBetween_65_69_yearsOld": 0, 
"numberOfMenBetween_70_74_yearsOld": 0, 
"numberOfMenOver_75_yearsOld": 0, 
"numberOfWomen": 0, 
"numberOfWomenBetween_0_4_yearsOld": 0, 
"numberOfWomenBetween_5_9_yearsOld": 0, 
"numberOfWomenBetween_10_14_yearsOld": 0, 
"numberOfWomenBetween_15_19_yearsOld": 0, 
"numberOfWomenBetween_20_24_yearsOld": 0, 
"numberOfWomenBetween_25_29_yearsOld": 0, 
"numberOfWomenBetween_30_34_yearsOld": 0, 
"numberOfWomenBetween_35_39_yearsOld": 0, 
"numberOfWomenBetween_40_44_yearsOld": 0, 
"numberOfWomenBetween_45_49_yearsOld": 0, 
"numberOfWomenBetween_50_54_yearsOld": 0, 
"numberOfWomenBetween_55_59_yearsOld": 0, 
"numberOfWomenBetween_60_64_yearsOld": 0, 
"numberOfWomenBetween_65_69_yearsOld": 0, 
"numberOfWomenBetween_70_74_yearsOld": 0, 
"numberOfWomenOver_75_yearsOld": 0, 
"numberOfJuridicalPersons": 8 

            }, 

            { 
"statuses": "", 
"cityName": "Warszawa", 
"citySymbol": "0918123", 
"cityDistrictName": "Mokotów", 
"cityDistrictSymbol": "0918130", 
"streetName": "Stanisława Żaryna", 
"streetSymbol": "36771", 
"streetAttribute": "ul.", 
"streetNameMajorPart": "Żaryna", 
"streetNameMinorPart": "Stanisława", 
"postalCode": "02-593", 
"streetNumber": "2A", 
"voivodeshipName": "mazowieckie", 
"countyName": "Warszawa", 
"communeName": "Warszawa", 
"communeSymbol": "146501", 
"communeTypeSymbol": 1, 
"communeTypeName": "gmina miejska", 
"numberOfApartments": 0, 
"numberOfInhabitedApartmentsByGUS": 0, 
"numberOfInhabitedApartmentsByPESEL": 0, 
"numberOfInhabitantsByGUS": 0, 
"numberOfInhabitantsByPESEL": 0, 
"numberOfMen": 0, 
"numberOfMenBetween_0_4_yearsOld": 0, 
"numberOfMenBetween_5_9_yearsOld": 0, 
"numberOfMenBetween_10_14_yearsOld": 0, 
"numberOfMenBetween_15_19_yearsOld": 0, 
"numberOfMenBetween_20_24_yearsOld": 0, 
"numberOfMenBetween_25_29_yearsOld": 0, 
"numberOfMenBetween_30_34_yearsOld": 0, 
"numberOfMenBetween_35_39_yearsOld": 0, 
"numberOfMenBetween_40_44_yearsOld": 0, 
"numberOfMenBetween_45_49_yearsOld": 0, 
"numberOfMenBetween_50_54_yearsOld": 0, 
"numberOfMenBetween_55_59_yearsOld": 0, 
"numberOfMenBetween_60_64_yearsOld": 0, 
"numberOfMenBetween_65_69_yearsOld": 0, 
"numberOfMenBetween_70_74_yearsOld": 0, 
"numberOfMenOver_75_yearsOld": 0, 
"numberOfWomen": 0, 
"numberOfWomenBetween_0_4_yearsOld": 0, 
"numberOfWomenBetween_5_9_yearsOld": 0, 
"numberOfWomenBetween_10_14_yearsOld": 0, 
"numberOfWomenBetween_15_19_yearsOld": 0, 
"numberOfWomenBetween_20_24_yearsOld": 0, 
"numberOfWomenBetween_25_29_yearsOld": 0, 
"numberOfWomenBetween_30_34_yearsOld": 0, 
"numberOfWomenBetween_35_39_yearsOld": 0, 
"numberOfWomenBetween_40_44_yearsOld": 0, 
"numberOfWomenBetween_45_49_yearsOld": 0, 
"numberOfWomenBetween_50_54_yearsOld": 0, 
"numberOfWomenBetween_55_59_yearsOld": 0, 
"numberOfWomenBetween_60_64_yearsOld": 0, 
"numberOfWomenBetween_65_69_yearsOld": 0, 
"numberOfWomenBetween_70_74_yearsOld": 0, 
"numberOfWomenOver_75_yearsOld": 0, 
"numberOfJuridicalPersons": 8 

            }, 

            { 
"statuses": "", 
"cityName": "Warszawa", 
"citySymbol": "0918123", 
"cityDistrictName": "Mokotów", 
"cityDistrictSymbol": "0918130", 
"streetName": "Stanisława Żaryna", 
"streetSymbol": "36771", 
"streetAttribute": "ul.", 
"streetNameMajorPart": "Żaryna", 
"streetNameMinorPart": "Stanisława", 
"postalCode": "02-593", 
"streetNumber": "2A", 
"voivodeshipName": "mazowieckie", 
"countyName": "Warszawa", 
"communeName": "Warszawa", 
"communeSymbol": "146501", 
"communeTypeSymbol": 1, 
"communeTypeName": "gmina miejska", 
"numberOfApartments": 0, 
"numberOfInhabitedApartmentsByGUS": 0, 
"numberOfInhabitedApartmentsByPESEL": 0, 
"numberOfInhabitantsByGUS": 0, 
"numberOfInhabitantsByPESEL": 0, 
"numberOfMen": 0, 
"numberOfMenBetween_0_4_yearsOld": 0, 
"numberOfMenBetween_5_9_yearsOld": 0, 
"numberOfMenBetween_10_14_yearsOld": 0, 
"numberOfMenBetween_15_19_yearsOld": 0, 
"numberOfMenBetween_20_24_yearsOld": 0, 
"numberOfMenBetween_25_29_yearsOld": 0, 
"numberOfMenBetween_30_34_yearsOld": 0, 
"numberOfMenBetween_35_39_yearsOld": 0, 
"numberOfMenBetween_40_44_yearsOld": 0, 
"numberOfMenBetween_45_49_yearsOld": 0, 
"numberOfMenBetween_50_54_yearsOld": 0, 
"numberOfMenBetween_55_59_yearsOld": 0, 
"numberOfMenBetween_60_64_yearsOld": 0, 
"numberOfMenBetween_65_69_yearsOld": 0, 
"numberOfMenBetween_70_74_yearsOld": 0, 
"numberOfMenOver_75_yearsOld": 0, 
"numberOfWomen": 0, 
"numberOfWomenBetween_0_4_yearsOld": 0, 
"numberOfWomenBetween_5_9_yearsOld": 0, 
"numberOfWomenBetween_10_14_yearsOld": 0, 
"numberOfWomenBetween_15_19_yearsOld": 0, 
"numberOfWomenBetween_20_24_yearsOld": 0, 
"numberOfWomenBetween_25_29_yearsOld": 0, 
"numberOfWomenBetween_30_34_yearsOld": 0, 
"numberOfWomenBetween_35_39_yearsOld": 0, 
"numberOfWomenBetween_40_44_yearsOld": 0, 
"numberOfWomenBetween_45_49_yearsOld": 0, 
"numberOfWomenBetween_50_54_yearsOld": 0, 
"numberOfWomenBetween_55_59_yearsOld": 0, 
"numberOfWomenBetween_60_64_yearsOld": 0, 
"numberOfWomenBetween_65_69_yearsOld": 0, 
"numberOfWomenBetween_70_74_yearsOld": 0, 
"numberOfWomenOver_75_yearsOld": 0, 
"numberOfJuridicalPersons": 8 

            }, 

            { 
"statuses": "", 
"cityName": "Stanisława", 
"citySymbol": "0285617", 
"postalCode": "62-704", 
"streetNumber": "2A", 
"voivodeshipName": "wielkopolskie", 
"countyName": "turecki", 
"communeName": "Kawęczyn", 
"communeSymbol": "302704", 
"communeTypeSymbol": 2, 
"communeTypeName": "gmina wiejska" 

            }, 

            { 
"statuses": "", 
"cityName": "Warszawa", 
"citySymbol": "0918123", 
"cityDistrictName": "Mokotów", 
"cityDistrictSymbol": "0918130", 
"streetName": "Stanisława Żaryna", 
"streetSymbol": "36771", 
"streetAttribute": "ul.", 
"streetNameMajorPart": "Żaryna", 
"streetNameMinorPart": "Stanisława", 
"postalCode": "02-593", 
"streetNumber": "2A", 
"voivodeshipName": "mazowieckie", 
"countyName": "Warszawa", 
"communeName": "Warszawa", 
"communeSymbol": "146501", 
"communeTypeSymbol": 1, 
"communeTypeName": "gmina miejska", 
"numberOfApartments": 0, 
"numberOfInhabitedApartmentsByGUS": 0, 
"numberOfInhabitedApartmentsByPESEL": 0, 
"numberOfInhabitantsByGUS": 0, 
"numberOfInhabitantsByPESEL": 0, 
"numberOfMen": 0, 
"numberOfMenBetween_0_4_yearsOld": 0, 
"numberOfMenBetween_5_9_yearsOld": 0, 
"numberOfMenBetween_10_14_yearsOld": 0, 
"numberOfMenBetween_15_19_yearsOld": 0, 
"numberOfMenBetween_20_24_yearsOld": 0, 
"numberOfMenBetween_25_29_yearsOld": 0, 
"numberOfMenBetween_30_34_yearsOld": 0, 
"numberOfMenBetween_35_39_yearsOld": 0, 
"numberOfMenBetween_40_44_yearsOld": 0, 
"numberOfMenBetween_45_49_yearsOld": 0, 
"numberOfMenBetween_50_54_yearsOld": 0, 
"numberOfMenBetween_55_59_yearsOld": 0, 
"numberOfMenBetween_60_64_yearsOld": 0, 
"numberOfMenBetween_65_69_yearsOld": 0, 
"numberOfMenBetween_70_74_yearsOld": 0, 
"numberOfMenOver_75_yearsOld": 0, 
"numberOfWomen": 0, 
"numberOfWomenBetween_0_4_yearsOld": 0, 
"numberOfWomenBetween_5_9_yearsOld": 0, 
"numberOfWomenBetween_10_14_yearsOld": 0, 
"numberOfWomenBetween_15_19_yearsOld": 0, 
"numberOfWomenBetween_20_24_yearsOld": 0, 
"numberOfWomenBetween_25_29_yearsOld": 0, 
"numberOfWomenBetween_30_34_yearsOld": 0, 
"numberOfWomenBetween_35_39_yearsOld": 0, 
"numberOfWomenBetween_40_44_yearsOld": 0, 
"numberOfWomenBetween_45_49_yearsOld": 0, 
"numberOfWomenBetween_50_54_yearsOld": 0, 
"numberOfWomenBetween_55_59_yearsOld": 0, 
"numberOfWomenBetween_60_64_yearsOld": 0, 
"numberOfWomenBetween_65_69_yearsOld": 0, 
"numberOfWomenBetween_70_74_yearsOld": 0, 
"numberOfWomenOver_75_yearsOld": 0, 
"numberOfJuridicalPersons": 8 

            }, 

            { 
"statuses": "", 
"cityName": "Warszawa", 
"citySymbol": "0918123", 
"cityDistrictName": "Mokotów", 
"cityDistrictSymbol": "0918130", 
"streetName": "Stanisława Żaryna", 
"streetSymbol": "36771", 
"streetAttribute": "ul.", 
"streetNameMajorPart": "Żaryna", 
"streetNameMinorPart": "Stanisława", 
"postalCode": "02-593", 
"streetNumber": "2A", 
"voivodeshipName": "mazowieckie", 
"countyName": "Warszawa", 
"communeName": "Warszawa", 
"communeSymbol": "146501", 
"communeTypeSymbol": 1, 
"communeTypeName": "gmina miejska", 
"numberOfApartments": 0, 
"numberOfInhabitedApartmentsByGUS": 0, 
"numberOfInhabitedApartmentsByPESEL": 0, 
"numberOfInhabitantsByGUS": 0, 
"numberOfInhabitantsByPESEL": 0, 
"numberOfMen": 0, 
"numberOfMenBetween_0_4_yearsOld": 0, 
"numberOfMenBetween_5_9_yearsOld": 0, 
"numberOfMenBetween_10_14_yearsOld": 0, 
"numberOfMenBetween_15_19_yearsOld": 0, 
"numberOfMenBetween_20_24_yearsOld": 0, 
"numberOfMenBetween_25_29_yearsOld": 0, 
"numberOfMenBetween_30_34_yearsOld": 0, 
"numberOfMenBetween_35_39_yearsOld": 0, 
"numberOfMenBetween_40_44_yearsOld": 0, 
"numberOfMenBetween_45_49_yearsOld": 0, 
"numberOfMenBetween_50_54_yearsOld": 0, 
"numberOfMenBetween_55_59_yearsOld": 0, 
"numberOfMenBetween_60_64_yearsOld": 0, 
"numberOfMenBetween_65_69_yearsOld": 0, 
"numberOfMenBetween_70_74_yearsOld": 0, 
"numberOfMenOver_75_yearsOld": 0, 
"numberOfWomen": 0, 
"numberOfWomenBetween_0_4_yearsOld": 0, 
"numberOfWomenBetween_5_9_yearsOld": 0, 
"numberOfWomenBetween_10_14_yearsOld": 0, 
"numberOfWomenBetween_15_19_yearsOld": 0, 
"numberOfWomenBetween_20_24_yearsOld": 0, 
"numberOfWomenBetween_25_29_yearsOld": 0, 
"numberOfWomenBetween_30_34_yearsOld": 0, 
"numberOfWomenBetween_35_39_yearsOld": 0, 
"numberOfWomenBetween_40_44_yearsOld": 0, 
"numberOfWomenBetween_45_49_yearsOld": 0, 
"numberOfWomenBetween_50_54_yearsOld": 0, 
"numberOfWomenBetween_55_59_yearsOld": 0, 
"numberOfWomenBetween_60_64_yearsOld": 0, 
"numberOfWomenBetween_65_69_yearsOld": 0, 
"numberOfWomenBetween_70_74_yearsOld": 0, 
"numberOfWomenOver_75_yearsOld": 0, 
"numberOfJuridicalPersons": 8 

            }, 

            { 
"statuses": "", 
"cityName": "Warszawa", 
"citySymbol": "0918123", 
"cityDistrictName": "Wesoła", 
"cityDistrictSymbol": "0921728", 
"streetName": "Jana Pawła II", 
"streetSymbol": "07123", 
"streetAttribute": "ul.", 
"streetNameMajorPart": "Jana Pawła II", 
"postalCode": "05-077", 
"streetNumber": "20", 
"voivodeshipName": "mazowieckie", 
"countyName": "Warszawa", 
"communeName": "Warszawa", 
"communeSymbol": "146501", 
"communeTypeSymbol": 1, 
"communeTypeName": "gmina miejska", 
"numberOfApartments": 1, 
"numberOfInhabitedApartmentsByGUS": 1, 
"numberOfInhabitedApartmentsByPESEL": 1, 
"numberOfInhabitantsByGUS": 3, 
"numberOfInhabitantsByPESEL": 2, 
"numberOfMen": 1, 
"numberOfMenBetween_0_4_yearsOld": 0, 
"numberOfMenBetween_5_9_yearsOld": 0, 
"numberOfMenBetween_10_14_yearsOld": 0, 
"numberOfMenBetween_15_19_yearsOld": 0, 
"numberOfMenBetween_20_24_yearsOld": 0, 
"numberOfMenBetween_25_29_yearsOld": 0, 
"numberOfMenBetween_30_34_yearsOld": 0, 
"numberOfMenBetween_35_39_yearsOld": 0, 
"numberOfMenBetween_40_44_yearsOld": 0, 
"numberOfMenBetween_45_49_yearsOld": 0, 
"numberOfMenBetween_50_54_yearsOld": 0, 
"numberOfMenBetween_55_59_yearsOld": 0, 
"numberOfMenBetween_60_64_yearsOld": 0, 
"numberOfMenBetween_65_69_yearsOld": 0, 
"numberOfMenBetween_70_74_yearsOld": 1, 
"numberOfMenOver_75_yearsOld": 0, 
"numberOfWomen": 1, 
"numberOfWomenBetween_0_4_yearsOld": 0, 
"numberOfWomenBetween_5_9_yearsOld": 0, 
"numberOfWomenBetween_10_14_yearsOld": 0, 
"numberOfWomenBetween_15_19_yearsOld": 0, 
"numberOfWomenBetween_20_24_yearsOld": 0, 
"numberOfWomenBetween_25_29_yearsOld": 0, 
"numberOfWomenBetween_30_34_yearsOld": 0, 
"numberOfWomenBetween_35_39_yearsOld": 0, 
"numberOfWomenBetween_40_44_yearsOld": 0, 
"numberOfWomenBetween_45_49_yearsOld": 0, 
"numberOfWomenBetween_50_54_yearsOld": 0, 
"numberOfWomenBetween_55_59_yearsOld": 0, 
"numberOfWomenBetween_60_64_yearsOld": 0, 
"numberOfWomenBetween_65_69_yearsOld": 0, 
"numberOfWomenBetween_70_74_yearsOld": 1, 
"numberOfWomenOver_75_yearsOld": 0, 
"numberOfJuridicalPersons": 0 

            } 

        ] 

    }, 

    "error": null, 

    "sceuid": "4f63ab8f-bb0b-4131-bdfb-6a34e0a9d6ad" 

} 

Restrictions on combining address data properties

It is forbidden to pass different properties, but with the same information (e.g. streetName and streetNameAndStreetNumberAndApartmentNumber both contain street name information). Therefore, the following groups of mutually exclusive properties can be distinguished:

  • generalData | streetNameAndStreetNumberAndApartmentNumber | streetName
  • generalData | streetNameAndStreetNumberAndApartmentNumber | streetNumberAndApartmentNumber | streetNumber
  • generalData | streetNameAndStreetNumberAndApartmentNumber | streetNumberAndApartmentNumber | apartmentNumber
  • generalData | postalCode
  • generalData | cityName
  • generalData | voivodeshipName
  • generalData | countyName
  • generalData | communeName

Only one property from each group can be present at a time. Violation of these restrictions results in an 002 [error].

Additionals

We can customize DQ to return additional information according to Your needs. For more information contact our support at support@algolytics.pl.

Last updated 2019-04-08 07:39:06 PDT