openapi: 3.0.3
info:
  title: Autocomplete 2.0
  version: '1.0'
  description: >-
    Autocomplete 2.0 - Address completion.



    <b>Nutzungshinweise zur Swagger-UI:</b>



    Zuerst muss über die Token-Schnittstelle per BasicAuth (Benutzername und
    Passwort) ein neuer AccessToken generiert werden.


    Die BasicAuth-Informationen werden über den "Authorize"-Button mit
    Schlosssymbol ganz oben auf der rechten Seite

    oder rechts neben der Token-Schnittstelle eingegeben und per Login
    bestätigt.


    Der im Ergebnis der Anfrage enthaltene AccessToken kann kopiert werden und
    als Bearer-Token eingetragen werden (ebenfalls über

    das Schlosssymbol).


    Danach können Anfragen gegen die jeweiligen "Search-" und
    "Select"-Schnittstellen durchgeführt werden, solange der

    AccessToken gültig ist.


    Falls der AccessToken abgelaufen ist, muss über die Token-Schnittstelle ein
    neuer Token abgeholt werden und neu eingetragen

    werden.


    Dafür muss über das Schlosssymbol über den Logout-Button der alte
    Bearer-Token entfernt werden.
  contact:
    email: info@postdirekt.de
    name: Deutsche Post Direkt GmbH
    url: https://www.postdirekt.de
  license:
    name: Proprietary License
    url: https://www.postdirekt.de
security:
  - bearerAuth: []
servers:
  - description: Generated server url
    url: https://autocomplete2.postdirekt.de/autocomplete2
paths:
  /health-check:
    get:
      description: Returns statusCode 200 and a status message, if the application is up.
      operationId: healthCheck
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
      summary: Returns statusCode 200 and a message, if the application is up.
      tags:
        - Health
  /search/at/buildings:
    get:
      description: >-
        This endpoint returns all the matching AT buildings for the given postal
        code/city/street/houseNumberShort/combined part.
      operationId: getAtBuildings
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: short house number value
          in: query
          name: house_number_short
          required: false
          schema:
            default: ''
            type: string
        - description: the param combination
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AtBuildingDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: postal_code, city, ,
            street, house_number_short, combined].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching AT buildings for the given postal
        code/city/street/houseNumberShort/combined part
      tags:
        - ATAddressData
  /search/at/cities:
    get:
      description: >-
        This endpoint returns all the matching AT cities for the given city
        part.
      operationId: getAtCities
      parameters:
        - description: AT city value
          in: query
          name: city
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AtStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [city].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching AT cities for the given city part
      tags:
        - ATAddressData
  /search/at/postalcodes:
    get:
      description: >-
        This endpoint returns all the matching AT postal codes for the given
        postal code part.
      operationId: getAtPostalCodes
      parameters:
        - description: AT postal code value
          in: query
          name: postal_code
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AtStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [postal_code].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching AT postal codes for the given postal code part
      tags:
        - ATAddressData
  /search/at/postalcodes_cities:
    get:
      description: >-
        This endpoint returns all the matching AT postal code and city
        combinations for the given postal code/city/combined part.
      operationId: getAtPostalCodeCities
      parameters:
        - description: AT postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: AT city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: AT combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [postal_code, city].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching AT postal code and city combinations for the
        given postal code/city/combined part
      tags:
        - ATAddressData
  /search/at/postalcodes_cities_streets:
    get:
      description: >-
        This endpoint returns all the matching AT postal code, city and street
        combinations for the given postal code/city/street/combined part.
      operationId: getAtPostalCodeCityStreets
      parameters:
        - description: AT postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: AT city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: AT street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: AT combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AtStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: [postal_code, city,
            street].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching AT postal code, city and street combinations
        for the given postal code/city/street part
      tags:
        - ATAddressData
  /search/at/streets:
    get:
      description: >-
        This endpoint returns all the matching AT streets for the given street
        part.
      operationId: getAtStreets
      parameters:
        - description: AT street value
          in: query
          name: street
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AtStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [street].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching AT streets for the given street part
      tags:
        - ATAddressData
  /search/ch/buildings:
    get:
      description: >-
        This endpoint returns all the matching CH buildings for the given postal
        code/city/street/houseNumber/combined part.
      operationId: getChBuildings
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: house number value (with addition)
          in: query
          name: house_number
          required: false
          schema:
            default: ''
            type: string
        - description: the param combination
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ChBuildingDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: postal_code, city, ,
            street, house_number, combined].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching CH buildings for the given postal
        code/city/street/houseNumber/combined part
      tags:
        - CHAddressData
  /search/ch/cities:
    get:
      description: >-
        This endpoint returns all the matching CH cities for the given city
        part.
      operationId: getChCities
      parameters:
        - description: CH city value
          in: query
          name: city
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ChStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [city].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching CH cities for the given city part
      tags:
        - CHAddressData
  /search/ch/postalcodes:
    get:
      description: >-
        This endpoint returns all the matching CH postal codes for the given
        postal code part.
      operationId: getChPostalCodes
      parameters:
        - description: CH postal code value
          in: query
          name: postal_code
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ChStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [postal_code].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching CH postal codes for the given postal code part
      tags:
        - CHAddressData
  /search/ch/postalcodes_cities:
    get:
      description: >-
        This endpoint returns all the matching CH postal code and city
        combinations for the given postal code/city/combined part.
      operationId: getChPostalCodeCities
      parameters:
        - description: CH postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: CH city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: CH combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [postal_code, city].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching CH postal code and city combinations for the
        given postal code/city/combined part
      tags:
        - CHAddressData
  /search/ch/postalcodes_cities_streets:
    get:
      description: >-
        This endpoint returns all the matching CH postal code, city and street
        combinations for the given postal code/city/street/combined part.
      operationId: getChPostalCodeCityStreets
      parameters:
        - description: CH postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: CH city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: CH street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: CH combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ChStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: [postal_code, city,
            street].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching CH postal code, city and street combinations
        for the given postal code/city/street part
      tags:
        - CHAddressData
  /search/ch/streets:
    get:
      description: >-
        This endpoint returns all the matching CH streets for the given street
        part.
      operationId: getChStreets
      parameters:
        - description: CH street value
          in: query
          name: street
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ChStreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [street].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching CH streets for the given street part
      tags:
        - CHAddressData
  /search/de/buildings:
    get:
      description: >-
        This endpoint returns all the matching buildings for the given postal
        code/city/district/street/houseNumber/distributionCode/combined part.
      operationId: getBuildings
      parameters:
        - description: postal code  value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: district value
          in: query
          name: district
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: house number value (with addition)
          in: query
          name: house_number
          required: false
          schema:
            default: ''
            type: string
        - description: distribution code value
          in: query
          name: distribution_code
          required: false
          schema:
            default: ''
            type: string
        - description: the param combination
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/BuildingDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: postal_code, city,
            district, street, address_type, house_number, combined].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching buildings for the given postal
        code/city/district/street/houseNumber/distributionCode/combined part
      tags:
        - Buildings
  /search/de/bulkrecipients:
    get:
      description: >-
        This endpoint returns all the matching bulk recipients for the given
        bulk recipient name/postal code/city part.
      operationId: getBulkRecipients
      parameters:
        - description: bulk recipient name
          in: query
          name: bulk_recipient_name
          required: false
          schema:
            default: ''
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/BulkRecipientDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: bulk_recipient_name,
            postal_code, city].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching bulk recipients for the given bulk recipient
        name/postal code/city part
      tags:
        - Bulk Recipients
  /search/de/cities:
    get:
      description: This endpoint returns all the matching cities for the given city part.
      operationId: getCities
      parameters:
        - description: city value
          in: query
          name: city
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [city].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching cities for the given city part
      tags:
        - Streetcodes
  /search/de/districts:
    get:
      description: >-
        This endpoint returns all the matching districts for the given district
        part.
      operationId: getDistricts
      parameters:
        - description: district value
          in: query
          name: district
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [district].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching districts for the given district part
      tags:
        - Streetcodes
  /search/de/firstnames:
    get:
      description: >-
        This endpoint returns all the matching first names for the given first
        name part.
      operationId: getPersons
      parameters:
        - description: first name
          in: query
          name: first_name
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/FirstNameDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: first_name].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching first names for the given first name part
      tags:
        - Names
  /search/de/lastnames:
    get:
      description: >-
        This endpoint returns all the matching last names for the given last
        name part.
      operationId: getLastNames
      parameters:
        - description: last name
          in: query
          name: last_name
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/LastNameDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: last_name].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching last names for the given last name part
      tags:
        - Names
  /search/de/poboxes:
    get:
      description: >-
        This endpoint returns all the matching post office boxes for the given
        postal code/city part.
      operationId: getPostOfficeBoxes
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PostOfficeBoxDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: postal_code, city].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching post office boxes for the given postal
        code/city part
      tags:
        - Post Office Boxes
  /search/de/postalcodes:
    get:
      description: >-
        This endpoint returns all the matching postal codes for the given postal
        code part.
      operationId: getPostalCodes
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [postal_code].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching postal codes for the given postal code part
      tags:
        - Streetcodes
  /search/de/postalcodes_cities:
    get:
      description: >-
        This endpoint returns all the matching postal code and city combinations
        for the given postal code/city/combined part.
      operationId: getPostalCodeCities
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [postal_code, city].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching postal code and city combinations for the given
        postal code/city part
      tags:
        - Streetcodes
  /search/de/postalcodes_cities_districts:
    get:
      description: >-
        This endpoint returns all the matching postal code, city and district
        combinations for the given postal code/city/district/combined part.
      operationId: getPostalCodeCityDistricts
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: district value
          in: query
          name: district
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: [postal_code, city,
            district].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching postal code, city and district combinations for
        the given postal code/city/district part
      tags:
        - Streetcodes
  /search/de/postalcodes_cities_districts_streets:
    get:
      description: >-
        This endpoint returns all the matching postal code, city, district and
        street combinations for the given postal
        code/city/district/street/combined part.
      operationId: getPostalCodeCityDistrictStreets
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: district value
          in: query
          name: district
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: address type value
          in: query
          name: address_type
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: [postal_code, city,
            district, street, address_type].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching postal code, city, district and street
        combinations for the given postal code/city/district/street part
      tags:
        - Streetcodes
  /search/de/postalcodes_cities_streets:
    get:
      description: >-
        This endpoint returns all the matching postal code, city and street
        combinations for the given postal code/city/street/combined part.
      operationId: getPostalCodeCityStreets
      parameters:
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: address type value
          in: query
          name: address_type
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            At least one of these parameters must be set: [postal_code, city,
            street, address_type].
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: >-
        Returns all the matching postal code, city and street combinations for
        the given postal code/city/street part
      tags:
        - Streetcodes
  /search/de/streets:
    get:
      description: >-
        This endpoint returns all the matching streets for the given street
        part.
      operationId: getStreets
      parameters:
        - description: street value
          in: query
          name: street
          required: true
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/StreetcodeDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: [street].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching streets for the given street part
      tags:
        - Streetcodes
  /select/ch/buildings:
    get:
      description: This endpoint logs the selected CH building for the given uuid.
      operationId: logSelectedChBuildings
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code  value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: house number value (with addition)
          in: query
          name: house_number
          required: false
          schema:
            default: ''
            type: string
        - description: the param combination
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected CH building
      tags:
        - CHAddressData
  /select/ch/cities:
    get:
      description: This endpoint logs the selected CH city for the given uuid.
      operationId: logSelectedChCity
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: CH city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected CH city
      tags:
        - CHAddressData
  /select/ch/postalcodes:
    get:
      description: This endpoint logs the selected CH postal code for the given uuid.
      operationId: logSelectedChPostalCode
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: CH postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected CH postal code
      tags:
        - CHAddressData
  /select/ch/postalcodes_cities:
    get:
      description: This endpoint logs the selected CH postal code/city for the given uuid.
      operationId: logSelectedChPostalCodeCity
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: CH postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: CH city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected CH postal code/city
      tags:
        - CHAddressData
  /select/ch/postalcodes_cities_streets:
    get:
      description: >-
        This endpoint logs the selected CH postal code, city and street for the
        given uuid.
      operationId: logSelectedChPostalCodeCityStreet
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: CH postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: CH city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: CH street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: CH combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected CH postal code, city and street
      tags:
        - CHAddressData
  /select/ch/streets:
    get:
      description: This endpoint logs the selected CH street for the given uuid.
      operationId: logSelectedChStreet
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: CH street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected CH street
      tags:
        - CHAddressData
  /select/de/buildings:
    get:
      description: This endpoint logs the selected building for the given uuid.
      operationId: logSelectedBuildings
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: district value
          in: query
          name: district
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: house number value (with addition)
          in: query
          name: house_number
          required: false
          schema:
            default: ''
            type: string
        - description: distribution code value
          in: query
          name: distribution_code
          required: false
          schema:
            default: ''
            type: string
        - description: the param combination
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected building
      tags:
        - Buildings
  /select/de/bulkrecipients:
    get:
      description: This endpoint logs the selected bulk recipient for the given uuid.
      operationId: logSelectedBulkRecipient
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: bulk recipient name
          in: query
          name: bulk_recipient_name
          required: false
          schema:
            default: ''
            type: string
        - description: postal code  value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected bulk recipient
      tags:
        - Bulk Recipients
  /select/de/cities:
    get:
      description: This endpoint logs the selected city for the given uuid.
      operationId: logSelectedCity
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected city
      tags:
        - Streetcodes
  /select/de/districts:
    get:
      description: This endpoint logs the selected district for the given uuid.
      operationId: logSelectedDistrict
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: district value
          in: query
          name: district
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected district
      tags:
        - Streetcodes
  /select/de/poboxes:
    get:
      description: This endpoint logs the selected post office box for the given uuid.
      operationId: logSelectedPostOfficeBox
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: the post office box range
          in: query
          name: po_box_range
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected post office box
      tags:
        - Post Office Boxes
  /select/de/postalcodes:
    get:
      description: This endpoint logs the selected postal code for the given uuid.
      operationId: logSelectedPostalCode
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected postal code
      tags:
        - Streetcodes
  /select/de/postalcodes_cities:
    get:
      description: This endpoint logs the selected postal code/city for the given uuid.
      operationId: logSelectedPostalCodeCity
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected postal code/city
      tags:
        - Streetcodes
  /select/de/postalcodes_cities_districts:
    get:
      description: >-
        This endpoint logs the selected postal code, city and district for the
        given uuid.
      operationId: logSelectedPostalCodeCityDistrict
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: district value
          in: query
          name: district
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected postal code, city and district
      tags:
        - Streetcodes
  /select/de/postalcodes_cities_districts_streets:
    get:
      description: >-
        This endpoint logs the selected postal code, city, district and street
        for the given uuid.
      operationId: logSelectedPostalCodeCityDistrictStreet
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: district value
          in: query
          name: district
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: address type value
          in: query
          name: address_type
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected postal code, city, district and street
      tags:
        - Streetcodes
  /select/de/postalcodes_cities_streets:
    get:
      description: >-
        This endpoint logs the selected postal code, city and street for the
        given uuid.
      operationId: logSelectedPostalCodeCityStreet
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: postal code value
          in: query
          name: postal_code
          required: false
          schema:
            default: ''
            type: string
        - description: city value
          in: query
          name: city
          required: false
          schema:
            default: ''
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
        - description: address type value
          in: query
          name: address_type
          required: false
          schema:
            default: ''
            type: string
        - description: combined params
          in: query
          name: combined
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected postal code, city and street
      tags:
        - Streetcodes
  /select/de/streets:
    get:
      description: This endpoint logs the selected street for the given uuid.
      operationId: logSelectedStreet
      parameters:
        - description: uuid value
          in: query
          name: uuid
          required: true
          schema:
            type: string
        - description: street value
          in: query
          name: street
          required: false
          schema:
            default: ''
            type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Required String parameter 'uuid' is not present.
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Logs the selected street
      tags:
        - Streetcodes
  /token:
    get:
      description: >-
        Returns the access token and the token expire information in epoch
        seconds for the authenticated and authorized user.
      operationId: getTokenResponse
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TokenResponse'
          description: OK
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Not Acceptable - Unsupported content negotiation header
            (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      security:
        - basicAuth: []
      summary: >-
        This endpoint returns the access token and the token expire information
        in epoch seconds for the authenticated and authorized user.
      tags:
        - Token
components:
  schemas:
    AtBuildingDataResponse:
      properties:
        atBuildings:
          items:
            $ref: '#/components/schemas/AtBuildingDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    AtBuildingDTO:
      properties:
        city:
          type: string
        district:
          type: string
        houseNumber:
          type: string
        houseNumberShort:
          type: string
        postalCode:
          type: string
        state:
          type: string
        street:
          type: string
        streetShort:
          type: string
        uuid:
          type: string
      type: object
    AtStreetcodeDataResponse:
      properties:
        atStreetcodes:
          items:
            $ref: '#/components/schemas/AtStreetcodeDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    AtStreetcodeDTO:
      properties:
        city:
          type: string
        district:
          type: string
        postalCode:
          type: string
        state:
          type: string
        street:
          type: string
        streetShort:
          type: string
        uuid:
          type: string
      type: object
    BuildingDataResponse:
      properties:
        buildings:
          items:
            $ref: '#/components/schemas/BuildingDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    BuildingDTO:
      properties:
        city:
          type: string
        distributionCode:
          type: string
        district:
          type: string
        houseNumber:
          type: string
        postalCode:
          type: string
        street:
          type: string
        uuid:
          type: string
      type: object
    BulkRecipientDataResponse:
      properties:
        bulkrecipients:
          items:
            $ref: '#/components/schemas/BulkRecipientDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    BulkRecipientDTO:
      properties:
        bulkRecipientName:
          type: string
        city:
          type: string
        postalCode:
          type: string
        street:
          type: string
        uuid:
          type: string
      type: object
    ChBuildingDataResponse:
      properties:
        chBuildings:
          items:
            $ref: '#/components/schemas/ChBuildingDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    ChBuildingDTO:
      properties:
        canton:
          type: string
        city:
          type: string
        houseKey:
          type: string
        houseNumber:
          type: string
        languageCode:
          type: string
        municipality:
          type: string
        postalCode:
          type: string
        street:
          type: string
        uuid:
          type: string
      type: object
    ChStreetcodeDataResponse:
      properties:
        chStreetcodes:
          items:
            $ref: '#/components/schemas/ChStreetcodeDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    ChStreetcodeDTO:
      properties:
        canton:
          type: string
        city:
          type: string
        languageCode:
          type: string
        municipality:
          type: string
        postalCode:
          type: string
        street:
          type: string
        uuid:
          type: string
      type: object
    ErrorResponse:
      properties:
        errorMessage:
          description: The error message.
          example: An error message example.
          type: string
        errorStatus:
          description: The error status code description.
          example: '''Bad Request'''
          type: string
        errorStatusCode:
          description: The HTTP error status code.
          example: 400
          format: int32
          type: integer
      type: object
    FirstNameDataResponse:
      properties:
        firstnames:
          items:
            $ref: '#/components/schemas/FirstNameDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    FirstNameDTO:
      properties:
        firstName:
          type: string
        uuid:
          type: string
      type: object
    LastNameDataResponse:
      properties:
        lastnames:
          items:
            $ref: '#/components/schemas/LastNameDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    LastNameDTO:
      properties:
        lastName:
          type: string
        uuid:
          type: string
      type: object
    PostOfficeBoxDataResponse:
      properties:
        numFound:
          format: int64
          type: integer
        poboxes:
          items:
            $ref: '#/components/schemas/PostOfficeBoxDTO'
          type: array
      type: object
    PostOfficeBoxDTO:
      properties:
        city:
          type: string
        postalCode:
          type: string
        postOfficeBoxRange:
          type: string
        uuid:
          type: string
      type: object
    StreetcodeDataResponse:
      properties:
        addresses:
          items:
            $ref: '#/components/schemas/StreetcodeDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    StreetcodeDTO:
      properties:
        addressType:
          type: string
        city:
          type: string
        district:
          type: string
        postalCode:
          type: string
        street:
          type: string
        uuid:
          type: string
      type: object
    TokenResponse:
      properties:
        access_token:
          type: string
        expires_in_epoch_seconds:
          format: int64
          type: integer
      type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
