# Suggest Zipcode All

> The Suggest Zipcode All endpoint returns every house-number range for a city, street, or house number, with its parity and range type.

The Suggest Zipcode All endpoint returns every **house-number range** for a city, street, or house number, with its parity and range type.

## Endpoint

`POST https://{host}:{port}/Egon/api/suggest/zipcodeAll`

Replace `{host}` and `{port}` with the address of your Egon instance.

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `token` | String | Yes | Authentication token sent in the `token` request header. |

## Request

Processing options, entity ID, and house-number parameters.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `par` | Object | Yes | Processing parameters, candidate limits, and country context |
| `par.iso2` | String | No | Country code, ISO 3166-1 alpha-2. One of `iso2` or `iso3` is **required**. |
| `par.iso3` | String | No | Country code, ISO 3166-1 alpha-3. One of `iso2` or `iso3` is **required**. |
| `par.max_candidates` | Number | No | Maximum number of candidates to extract. Default value: `10` |
| `data` | Object | Yes | Search criteria for full postal code lookup |
| `data.city_id` | Number | No | ID of the city |
| `data.street_id` | Number | No | ID of the street |
| `data.hn` | Number | No | House number |
| `data.zipcode` | String | No | Postal code |

### Example request

```bash
curl -X POST "https://{host}:{port}/Egon/api/suggest/zipcodeAll" \
  -H "token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"par":{"iso3":"ITA"},"data":{"street_id":"38000093621"}}'
```

## Response

House-number range results, parity codes, postal codes, and system status.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | Object | No |  |
| `data.results` | Array | No | Array of candidate matches returned by the suggestion engine |
| `data.results.zipcode` | String | No | Postal code |
| `data.results.hn_start` | String | No | Range starting house number |
| `data.results.hn_end` | String | No | Range ending house number |
| `data.results.exp_start` | String | No | Range starting exponent |
| `data.results.exp_end` | String | No | Range ending exponent |
| `data.results.parity` | String | No | Parity: `E` for even and `O` for odd |
| `data.results.range_type` | String | No | Range type: `0` for house number and `2` for kilometer indication |
| `system` | Object | No | System error and execution status |
| `system.ret_code` | Number | No | Code: 0 no blocking error, <> 0 blocking error code |
| `system.des_ret_code` | String | No | Description |

### Example responses

**HTTP 200: Valid response**

House-number range results, parity codes, postal codes, and system status.

```json
{
  "data": {
    "results": [
      {
        "zipcode": "20124",
        "hn_start": "2",
        "hn_end": "80",
        "parity": "E",
        "range_type": "0"
      },
      {
        "zipcode": "20125",
        "hn_start": "90",
        "hn_end": "132",
        "parity": "E",
        "range_type": "0"
      },
      {
        "zipcode": "20159",
        "hn_start": "1",
        "hn_end": "147",
        "parity": "O",
        "range_type": "0"
      }
    ]
  },
  "system": {
    "ret_code": 0,
    "des_ret_code": "Ok"
  }
}
```

**HTTP 200: Missing par**

The par object is missing.

```json
{
  "system": {
    "ret_code": 1,
    "des_ret_code": "par not found"
  }
}
```

**HTTP 200: Missing iso2 and iso3**

Iso2 or Iso3 field is missing.

```json
{
  "system": {
    "ret_code": 1,
    "des_ret_code": "iso2 or iso3 parameter not found"
  }
}
```

**HTTP 200: Invalid iso2**

The iso2 value is not valid.

```json
{
  "system": {
    "ret_code": 1,
    "des_ret_code": "iso2 not found"
  }
}
```

**HTTP 200: Invalid iso3**

The iso3 value is not valid.

```json
{
  "system": {
    "ret_code": 1,
    "des_ret_code": "iso3 not found"
  }
}
```

**HTTP 200: Missing data**

The data object is missing.

```json
{
  "system": {
    "ret_code": 1,
    "des_ret_code": "data not found"
  }
}
```

**HTTP 200: Missing token**

The token request header is missing.

```json
{
  "system": {
    "ret_code": 1,
    "des_ret_code": "token not found"
  }
}
```

**HTTP 200: Invalid token**

The token is invalid.

```json
{
  "system": {
    "ret_code": 1,
    "des_ret_code": "token not valid"
  }
}
```