Nedap Client Address API

The ClientAddress API from Nedap — 8 operation(s) for clientaddress.

Operations 10

POST /t/client_addresses Create ClientAddress #
GET /t/client_addresses/{id} Return the Client Address corresponding to the given id #
PUT /t/client_addresses/{id} Update ClientAddress #
GET /t/client_addresses/x-stream-connect/data Return all ClientAddress models in a streaming manner #
GET /t/client_addresses/x-stream-connect/updates Return all ClientAddress models which where updated since the date given in the… #
POST /v0/administration/client_addresses Create ClientAddress #
GET /v0/administration/client_addresses/{id} Return the Client Address corresponding to the given id #
PUT /v0/administration/client_addresses/{id} Update ClientAddress #
GET /v0/xstream/client_addresses/data Return all ClientAddress models in a streaming manner #
GET /v0/xstream/client_addresses/updates Return all ClientAddress models which where updated since the date given in the… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nedap-clientaddress-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nedap-clientaddress-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nedap Client Address API
  version: 0.0.0
  description: 'Operations tagged ClientAddress across 2 of this provider''s published API definitions: nedap-ons-deprecated-openapi-original.json, nedap-ons-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-development.ons.io
tags:
- name: ClientAddress
paths:
  /t/client_addresses:
    post:
      tags:
      - ClientAddress
      summary: Create ClientAddress
      operationId: ClientAddressAPI.create
      requestBody:
        description: ClientAddress to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientAddress'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: ClientAddress must have a client, or validation errors
        '404':
          description: Client not found
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/client_addresses
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/client_addresses/{id}:
    get:
      tags:
      - ClientAddress
      summary: Return the Client Address corresponding to the given id
      operationId: ClientAddressAPI.byId
      parameters:
      - name: id
        in: path
        description: used for selecting ClientAddress
        required: true
        schema:
          type: integer
          format: int64
      - name: include_access_info
        in: query
        description: Include residence access information
        schema:
          type: boolean
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '404':
          description: Address or ClientAddress not found
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/client_addresses/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    put:
      tags:
      - ClientAddress
      summary: Update ClientAddress
      operationId: ClientAddressAPI.update
      parameters:
      - name: id
        in: path
        description: used for selecting ClientAddress
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: ClientAddress to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientAddress'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: ClientAddress must have a client, or validation errors
        '404':
          description: ClientAddress not found
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/client_addresses/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/client_addresses/x-stream-connect/data:
    get:
      tags:
      - ClientAddress
      summary: Return all ClientAddress models in a streaming manner
      operationId: ClientAddressAPI.streamAll
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.ClientAddressList'
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: Could not parse request parameter
        '404':
          description: Resource not found
        '500':
          description: Unspecified internal error
      x-cupido-common-method: true
      x-replaced-by: /v0/xstream/client_addresses/data
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/client_addresses/x-stream-connect/updates:
    get:
      tags:
      - ClientAddress
      summary: Return all ClientAddress models which where updated since the date given in the…
      operationId: ClientAddressAPI.streamUpdates
      parameters:
      - name: since
        in: query
        required: true
        schema:
          type: string
          format: date-time
        example: '2014-12-29T00:00:00.000'
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.ClientAddressList'
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: Could not parse request parameter
        '404':
          description: Resource not found
        '500':
          description: Unspecified internal error
      x-cupido-common-method: true
      x-replaced-by: /v0/xstream/client_addresses/updates
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /v0/administration/client_addresses:
    post:
      tags:
      - ClientAddress
      summary: Create ClientAddress
      operationId: ClientAddressAPI.create
      requestBody:
        description: ClientAddress to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientAddress'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: ClientAddress must have a client, or validation errors
        '404':
          description: Client not found
      x-cupido-common-method: true
      x-replacement-for:
      - /t/client_addresses
    servers:
    - url: https://api-development.ons.io
  /v0/administration/client_addresses/{id}:
    get:
      tags:
      - ClientAddress
      summary: Return the Client Address corresponding to the given id
      operationId: ClientAddressAPI.byId
      parameters:
      - name: id
        in: path
        description: used for selecting ClientAddress
        required: true
        schema:
          type: integer
          format: int64
      - name: include_access_info
        in: query
        description: Include residence access information
        schema:
          type: boolean
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '404':
          description: Address or ClientAddress not found
      x-cupido-common-method: true
      x-replacement-for:
      - /t/client_addresses/{id}
    put:
      tags:
      - ClientAddress
      summary: Update ClientAddress
      operationId: ClientAddressAPI.update
      parameters:
      - name: id
        in: path
        description: used for selecting ClientAddress
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: ClientAddress to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientAddress'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: ClientAddress must have a client, or validation errors
        '404':
          description: ClientAddress not found
      x-cupido-common-method: true
      x-replacement-for:
      - /t/client_addresses/{id}
    servers:
    - url: https://api-development.ons.io
  /v0/xstream/client_addresses/data:
    get:
      tags:
      - ClientAddress
      summary: Return all ClientAddress models in a streaming manner
      operationId: ClientAddressAPI.streamAll
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.ClientAddressList'
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: Could not parse request parameter
        '404':
          description: Resource not found
        '500':
          description: Unspecified internal error
      x-cupido-common-method: true
      x-replacement-for:
      - /t/client_addresses/x-stream-connect/data
    servers:
    - url: https://api-development.ons.io
  /v0/xstream/client_addresses/updates:
    get:
      tags:
      - ClientAddress
      summary: Return all ClientAddress models which where updated since the date given in the…
      operationId: ClientAddressAPI.streamUpdates
      parameters:
      - name: since
        in: query
        required: true
        schema:
          type: string
          format: date-time
        example: '2014-12-29T00:00:00.000'
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.ClientAddressList'
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/ClientAddress'
        '400':
          description: Could not parse request parameter
        '404':
          description: Resource not found
        '500':
          description: Unspecified internal error
      x-cupido-common-method: true
      x-replacement-for:
      - /t/client_addresses/x-stream-connect/updates
    servers:
    - url: https://api-development.ons.io
components:
  schemas:
    list.ClientAddressList:
      type: object
      properties:
        clientAddresses:
          type: array
          items:
            $ref: '#/components/schemas/ClientAddress'
          xml:
            name: clientAddress
      description: ClientAddressList model (no description)
      example:
        clientAddresses:
        - id: 1
          beginDate: '2010-02-16'
          endDate: '2010-02-17'
          homeNumber: 4
          homeNumberExtension: a
          poBoxNumber: 123a
          street: Parallelweg
          city: Enschede
          zipcode: 7513KC
          municipality: Enschede
          country: Netherlands
          telephoneNumber: 053-1234567
          telephoneCountryCode: '+31'
          telephoneNumber2: 053-1234567
          telephoneCountryCode2: '+31'
          faxNumber: 053-1234567
          email: mike.wazowski@nedap.com
          type: residence address
          typeString: local
          residentType: '0'
          personType: '1'
          personTypeString: client
          roomNumber: '1'
          locationDescription: Afdeling noord
          updatedAt: '2016-01-01T12:00:00.000+01:00'
          createdAt: '2016-01-01T12:00:00.000+01:00'
          latitude: 52.1
          longitude: 6.9
          clientId: 2
          situationDescription: Test
      xml:
        name: clientAddresses
    ClientAddress:
      type: object
      allOf:
      - $ref: '#/components/schemas/Address'
      properties:
        clientId:
          type: integer
          format: int64
      description: ClientAddress model (no description)
      example:
        id: 1
        beginDate: '2010-02-16'
        endDate: '2010-02-17'
        homeNumber: 4
        homeNumberExtension: a
        poBoxNumber: 123a
        street: Parallelweg
        city: Enschede
        zipcode: 7513KC
        municipality: Enschede
        country: Netherlands
        telephoneNumber: 053-1234567
        telephoneCountryCode: '+31'
        telephoneNumber2: 053-1234567
        telephoneCountryCode2: '+31'
        faxNumber: 053-1234567
        email: mike.wazowski@nedap.com
        type: residence address
        typeString: local
        residentType: '0'
        personType: '1'
        personTypeString: client
        roomNumber: '1'
        locationDescription: Afdeling noord
        updatedAt: '2016-01-01T12:00:00.000+01:00'
        createdAt: '2016-01-01T12:00:00.000+01:00'
        latitude: 52.1
        longitude: 6.9
        clientId: 2
        situationDescription: Test
        residenceAccessInfo: Test
      xml:
        name: clientAddress
    Address:
      type: object
      properties:
        id:
          type: integer
          format: int64
          x-cupido-id: true
        beginDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        homeNumber:
          type: integer
          format: int32
        homeNumberExtension:
          type: string
        poBoxNumber:
          type: string
        street:
          type: string
        city:
          type: string
        zipcode:
          type: string
        municipality:
          type: string
        country:
          type: string
        telephoneNumber:
          type: string
        telephoneCountryCode:
          type: string
        telephoneNumber2:
          type: string
        telephoneCountryCode2:
          type: string
        faxNumber:
          type: string
        email:
          type: string
        type:
          type: string
          description: '0: Unknown

            1: Living

            2: Postal

            3: Residence

            4: Temporary

            50: Sleuteladres

            98: Other

            100: Factuuradres'
        typeString:
          type: string
        residentType:
          type: string
          description: '0: Unknown

            1: One-family house

            2: Upstairs apartment

            3: Ground floor apartment

            4: Apartment or flat

            5: Apartment or flat, with elevator between floors

            6: Houseboat

            7: Trailer

            8: WLZ organisation (with stay facilities)

            9: Homeless

            11: Assisted living

            12: WLZ organisation

            13: ZVW organisation

            14: WMO organisation

            21: asylum seekers center

            31: Correctional Institution

            99: Other'
        personType:
          type: string
          description: '1: Client

            2: Employee

            3: Relation

            4: Careprovider

            5: Unit'
        personTypeString:
          type: string
        roomNumber:
          type: string
        locationDescription:
          type: string
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        situationDescription:
          type: string
          description: Toelichting woonsituatie
        residenceAccessInfo:
          type: string
          description: Informatie over toegang tot de woning
      description: Address model.
      example:
        id: 1
        beginDate: '2010-02-16'
        endDate: '2010-02-17'
        homeNumber: 4
        homeNumberExtension: b
        poBoxNumber: 123a
        street: Parallelweg
        city: Groenlo
        zipcode: 7513KC
        municipality: Enschede
        country: Netherlands
        telephoneNumber: 053-1234567
        telephoneCountryCode: '+31'
        telephoneNumber2: 053-1234567
        telephoneCountryCode2: '+31'
        faxNumber: 053-1234567
        email: mike.wazowski@nedap.com
        type: '3'
        typeString: residence address
        residentType: '?'
        personType: '1'
        personTypeString: client
        roomNumber: '1'
        locationDescription: Afdeling noord
        updatedAt: '2016-01-01T12:00:00.000+01:00'
        createdAt: '2016-01-01T12:00:00.000+01:00'
        latitude: 52.1
        longitude: 6.9
        situationDescription: Woont bij ex
        residenceAccessInfo: Sleutel ligt onder de blauwe bloempot
x-refined-from:
- nedap-ons-deprecated-openapi-original.json
- nedap-ons-openapi-original.json