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-onsapiscoperesponse-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: OnsApi Scopes and Clearances OpenAPI Specification Ons API…
  version: v0
tags:
- name: OnsApiScopeResponse
paths:
  /v0/authorization/scope_for_user:
    get:
      tags:
      - OnsApiScopeResponse
      summary: Retrieve current scope for a user in the context of an Ons Autorisatie right
      operationId: scopeForUser
      parameters:
      - name: user_id
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: right
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnsApiScopeResponse'
              examples:
                All clients are in scope:
                  $ref: '#/components/examples/AllClientsInScopeExample'
                Some clients are in scope:
                  $ref: '#/components/examples/SomeClientsInScopeExample'
  /v0/authorization/scope_for_employee:
    get:
      tags:
      - OnsApiScopeResponse
      summary: Retrieve current scope for an employee in the context of an Ons Autorisatie…
      operationId: scopeForEmployee
      parameters:
      - name: employee_id
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: right
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnsApiScopeResponse'
              examples:
                All clients are in scope:
                  $ref: '#/components/examples/AllClientsInScopeExample'
                Some clients are in scope:
                  $ref: '#/components/examples/SomeClientsInScopeExample'
components:
  schemas:
    OnsApiScopeResponse:
      type: object
      properties:
        userUuid:
          type: string
        employeeId:
          type: integer
          format: int64
        date:
          type: string
        clientIds:
          type: array
          items:
            type: integer
            format: int64
        all:
          type: boolean
  examples:
    AllClientsInScopeExample:
      description: All clients are in scope. The value of 'clientIds' will be an empty list, and the value of 'all' will be true.
      value:
        userUuid: string
        employeeId: 123
        date: '2024-01-01T00:00:00.000+01:00'
        clientIds: []
        all: true
    SomeClientsInScopeExample:
      description: Only some clients are in scope. The value of 'clientIds' will contain a list of all clients that are in scope, and the value of 'all' will be false.
      value:
        userUuid: string
        employeeId: 123
        date: '2024-01-01T00:00:00.000+01:00'
        clientIds:
        - 1
        - 2
        - 3
        all: false