Nedap

Nedap Location Assignment Residence API

The LocationAssignmentResidence API from Nedap — 6 operation(s) for locationassignmentresidence.

Documentation GitHub OpenAPI

Operations 8

POST /t/location_assignment_residences Create LocationAssignmentResidence #

GET /t/location_assignment_residences/{id} Return the Location Assignment Residence corresponding to the given id #

PUT /t/location_assignment_residences/{id} Updates the given LocationAssignmentResidence #

GET /t/location_assignment_residences/by_careorder/{care_order_object_id} Find a list of locationAssignmentResidences based on the careorderobjectid #

POST /v0/administration/location_assignment_residences Create LocationAssignmentResidence #

GET /v0/administration/location_assignment_residences/{id} Return the Location Assignment Residence corresponding to the given id #

PUT /v0/administration/location_assignment_residences/{id} Updates the given LocationAssignmentResidence #

GET /v0/administration/location_assignment_residences/by_careorder/{care_order_object_id} Find a list of locationAssignmentResidences based on the careorderobjectid #

Documentation

📖

Documentation

https://ons-api.nl/english/english.html

📖

APIReference

https://ons-api.nl/english/technical/APIS.html

📖

GettingStarted

https://ons-api.nl/english/integration_process/Integration_process.html

📖

Authentication

https://ons-api.nl/english/technical/Certificate_requirements.html

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/nedap/refs/heads/main/openapi/nedap-locationassignmentresidence-api-openapi.yml

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-locationassignmentresidence-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Nedap Location Assignment Residence API
  version: 0.0.0
  description: 'Operations tagged LocationAssignmentResidence 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: LocationAssignmentResidence
paths:
  /t/location_assignment_residences:
    post:
      tags:
      - LocationAssignmentResidence
      summary: Create LocationAssignmentResidence
      operationId: LocationAssignmentResidenceAPI.create
      requestBody:
        description: LocationAssignmentResidence to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationAssignmentResidence'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationAssignmentResidence'
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/location_assignment_residences
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/location_assignment_residences/{id}:
    get:
      tags:
      - LocationAssignmentResidence
      summary: Return the Location Assignment Residence corresponding to the given id
      operationId: LocationAssignmentResidenceAPI.byId
      parameters:
      - name: id
        in: path
        description: used for selecting LocationAssignmentResidence
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationAssignmentResidence'
        '404':
          description: Location assignment residence not found
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/location_assignment_residences/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    put:
      tags:
      - LocationAssignmentResidence
      summary: Updates the given LocationAssignmentResidence
      operationId: LocationAssignmentResidenceAPI.update
      parameters:
      - name: id
        in: path
        description: used for selecting LocationAssignmentResidence
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: LocationAssignmentResidence to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationAssignmentResidence'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationAssignmentResidence'
        '404':
          description: Location assignment residence not found
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/location_assignment_residences/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/location_assignment_residences/by_careorder/{care_order_object_id}:
    get:
      tags:
      - LocationAssignmentResidence
      summary: Find a list of locationAssignmentResidences based on the careorderobjectid
      operationId: LocationAssignmentResidenceAPI.byCareOrder
      parameters:
      - name: care_order_object_id
        in: path
        description: Techincal identifcation of a careorder
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.LocationAssignmentResidenceList'
      x-replaced-by: /v0/administration/location_assignment_residences/by_careorder/{care_order_object_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /v0/administration/location_assignment_residences:
    post:
      tags:
      - LocationAssignmentResidence
      summary: Create LocationAssignmentResidence
      operationId: LocationAssignmentResidenceAPI.create
      requestBody:
        description: LocationAssignmentResidence to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationAssignmentResidence'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationAssignmentResidence'
      x-cupido-common-method: true
      x-replacement-for:
      - /t/location_assignment_residences
    servers:
    - url: https://api-development.ons.io
  /v0/administration/location_assignment_residences/{id}:
    get:
      tags:
      - LocationAssignmentResidence
      summary: Return the Location Assignment Residence corresponding to the given id
      operationId: LocationAssignmentResidenceAPI.byId
      parameters:
      - name: id
        in: path
        description: used for selecting LocationAssignmentResidence
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationAssignmentResidence'
        '404':
          description: Location assignment residence not found
      x-cupido-common-method: true
      x-replacement-for:
      - /t/location_assignment_residences/{id}
    put:
      tags:
      - LocationAssignmentResidence
      summary: Updates the given LocationAssignmentResidence
      operationId: LocationAssignmentResidenceAPI.update
      parameters:
      - name: id
        in: path
        description: used for selecting LocationAssignmentResidence
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: LocationAssignmentResidence to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationAssignmentResidence'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationAssignmentResidence'
        '404':
          description: Location assignment residence not found
      x-cupido-common-method: true
      x-replacement-for:
      - /t/location_assignment_residences/{id}
    servers:
    - url: https://api-development.ons.io
  /v0/administration/location_assignment_residences/by_careorder/{care_order_object_id}:
    get:
      tags:
      - LocationAssignmentResidence
      summary: Find a list of locationAssignmentResidences based on the careorderobjectid
      operationId: LocationAssignmentResidenceAPI.byCareOrder
      parameters:
      - name: care_order_object_id
        in: path
        description: Techincal identifcation of a careorder
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.LocationAssignmentResidenceList'
      x-replacement-for:
      - /t/location_assignment_residences/by_careorder/{care_order_object_id}
    servers:
    - url: https://api-development.ons.io
components:
  schemas:
    LocationAssignmentResidence:
      type: object
      allOf:
      - $ref: '#/components/schemas/LocationAssignment'
      properties:
        careOrderObjectId:
          type: integer
          description: 'The careorder where this locationassignment belongs to.

            This is needed to be able to create a declaration based on locationassignments'
          format: int64
        hourTypeObjectId:
          type: integer
          description: 'The kind of care that is given using this locationassignment. Example: GGZ verblijf licht

            This is needed to be able to create a declaration based on locationassignments'
          format: int64
        productObjectId:
          type: integer
          description: 'Deprecated since: 14-03-2019 - use hourTypeObjectId instead.'
          format: int64
          deprecated: true
      description: LocationAssignmentResidence model (no description)
      example:
        id: 1
        beginDate: '2012-08-02'
        beginTime: '10:11:00.000'
        endDate: '2012-08-02'
        endTime: '12:13:00.000'
        clientObjectId: 1
        locationObjectId: 1
        moveDate: '2012-08-02'
        locationAssignmentType: MAIN
        residence: false
        mainLocation: true
        medicineLocation: true
        careOrderObjectId: 1
        hourTypeObjectId: 1
        productObjectId: 1
      xml:
        name: locationAssignmentResidence
    list.LocationAssignmentResidenceList:
      type: object
      properties:
        locationAssignmentResidences:
          type: array
          items:
            $ref: '#/components/schemas/LocationAssignmentResidence'
      description: LocationAssignmentResidenceList model (no description)
      example:
        locationAssignmentResidences:
        - id: 1
          beginDate: '2012-08-02'
          beginTime: '10:11:00.000'
          endDate: '2012-08-02'
          endTime: '12:13:00.000'
          clientObjectId: 2
          locationObjectId: 3
          moveDate: '2012-08-02'
          locationAssignmentType: MAIN
          residence: false
          mainLocation: true
          medicineLocation: false
    LocationAssignmentType:
      enum:
      - STANDARD
      - MAIN
      - MEDICINE
      - GGZ
      - WAITING_LIST
      type: string
      description: LocationAssignmentType enum (no description)
      example: STANDARD
    LocationAssignment:
      type: object
      properties:
        id:
          type: integer
          format: int64
          x-cupido-id: true
        beginDate:
          type: string
          format: date
        beginTime:
          type: string
          format: time
        endDate:
          type: string
          format: date
        endTime:
          type: string
          format: time
        clientObjectId:
          type: integer
          format: int64
        locationObjectId:
          type: integer
          format: int64
        moveDate:
          type: string
          format: date
        locationAssignmentType:
          $ref: '#/components/schemas/LocationAssignmentType'
        residence:
          type: boolean
          description: Indicates if the client resides at this location
        mainLocation:
          type: boolean
          description: 'Deprecated since: 14-03-2019 - use locationAssignmentType instead'
          deprecated: true
        medicineLocation:
          type: boolean
          description: 'Deprecated since: 14-03-2019 - use locationAssignmentType instead'
          deprecated: true
      description: LocationAssignment model (no description)
      example:
        id: 1
        beginDate: '2012-08-02'
        beginTime: '10:11:00.000'
        endDate: '2012-08-02'
        endTime: '12:13:00.000'
        clientObjectId: 2
        locationObjectId: 3
        moveDate: '2012-08-02'
        locationAssignmentType: MAIN
        residence: false
        mainLocation: true
        medicineLocation: false
      xml:
        name: locationAssignment
x-refined-from:
- nedap-ons-deprecated-openapi-original.json
- nedap-ons-openapi-original.json