Nedap

Nedap Hermes.Contact Method API

The hermes.ContactMethod API from Nedap — 4 operation(s) for hermes.contactmethod.

GitHub OpenAPI

Operations 4

GET /t/clients/{client_id}/contact_method Return the hermes contact method of a Client corresponding to the given id #
POST /t/clients/{client_id}/contact_methods/set_primary_type Set primary contact method for client by given contact method type and… #
GET /v0/notification/clients/{client_id}/contact_method Return the hermes contact method of a Client corresponding to the given id #
POST /v0/notification/clients/{client_id}/contact_methods/set_primary_type Set primary contact method for client by given contact method type and… #

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-hermes-contactmethod-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-hermes-contactmethod-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

nedap-hermes-contactmethod-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nedap Hermes.Contact Method API
  version: 0.0.0
  description: 'Operations tagged hermes.ContactMethod 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: hermes.ContactMethod
paths:
  /t/clients/{client_id}/contact_method:
    get:
      tags:
      - hermes.ContactMethod
      summary: Return the hermes contact method of a Client corresponding to the given id
      operationId: hermes.ContactMethodAPI.byClientId
      parameters:
      - name: client_id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hermes.ContactMethod'
      x-replaced-by: /v0/notification/clients/{client_id}/contact_method
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/clients/{client_id}/contact_methods/set_primary_type:
    post:
      tags:
      - hermes.ContactMethod
      summary: Set primary contact method for client by given contact method type and…
      operationId: hermes.ContactMethodAPI.setPrimaryType
      parameters:
      - name: client_id
        in: path
        description: client id.
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: object to set the client's notification settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hermes.ContactMethodConfig'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hermes.ContactMethod'
      x-replaced-by: /v0/notification/clients/{client_id}/contact_methods/set_primary_type
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /v0/notification/clients/{client_id}/contact_method:
    get:
      tags:
      - hermes.ContactMethod
      summary: Return the hermes contact method of a Client corresponding to the given id
      operationId: hermes.ContactMethodAPI.byClientId
      parameters:
      - name: client_id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hermes.ContactMethod'
      x-replacement-for:
      - /t/clients/{client_id}/contact_method
    servers:
    - url: https://api-development.ons.io
  /v0/notification/clients/{client_id}/contact_methods/set_primary_type:
    post:
      tags:
      - hermes.ContactMethod
      summary: Set primary contact method for client by given contact method type and…
      operationId: hermes.ContactMethodAPI.setPrimaryType
      parameters:
      - name: client_id
        in: path
        description: client id.
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: object to set the client's notification settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hermes.ContactMethodConfig'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hermes.ContactMethod'
      x-replacement-for:
      - /t/clients/{client_id}/contact_methods/set_primary_type
    servers:
    - url: https://api-development.ons.io
components:
  schemas:
    hermes.CareProviderSettings:
      type: object
      properties:
        enabled:
          type:
          - boolean
          - 'null'
        defaultTemplateSet:
          type:
          - string
          - 'null'
        defaultContactMethod:
          type:
          - string
          - 'null'
      description: CareProviderSettings model (no description)
      example:
        enabled: true
        defaultTemplateSet: junior
        defaultContactMethod: Email
    hermes.ContactMethod:
      type: object
      properties:
        recipient:
          allOf:
          - $ref: '#/components/schemas/hermes.Recipient'
          description: The  method belongs to a recipient
        careProviderSettings:
          $ref: '#/components/schemas/hermes.CareProviderSettings'
        enabled:
          type: boolean
        subscribed:
          type: boolean
        type:
          type: string
        value:
          type: string
        status:
          type: string
        templateSet:
          type: string
      description: ContactMethod model (no description)
      example:
        recipient:
          clientId: 1
          clientUuid: abca58ed-0138-4aec-87c6-5d391e98161b
          employeeId: 1
        careProviderSettings:
          enabled: true
          defaultTemplateSet: junior
          defaultContactMethod: Email
        enabled: true
        subscribed: false
        type: SMS
        value: '0600123456'
        status: validated
        templateSet: adult
    hermes.Recipient:
      type:
      - object
      - 'null'
      properties:
        clientId:
          type:
          - integer
          - 'null'
          format: int64
        clientUuid:
          type:
          - string
          - 'null'
        employeeId:
          type:
          - integer
          - 'null'
          format: int64
      description: The  method belongs to a recipient
      example:
        clientId: 1
        clientUuid: abca58ed-0138-4aec-87c6-5d391e98161b
        employeeId: 1
    hermes.ContactMethodConfig:
      required:
      - type
      - allowNotifications
      type: object
      properties:
        type:
          type: string
          description: 'Type of contact method, e.g. email or sms


            <pre>

            Possible values:

            SMS

            Email

            </pre>'
        allowNotifications:
          type: boolean
          description: Allows Ons Notificaties to send notifications for this type of contact method
      description: This class is used to update notification settings for Clients.
      example:
        type: SMS
        allowNotifications: true
x-refined-from:
- nedap-ons-deprecated-openapi-original.json
- nedap-ons-openapi-original.json