How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nedap Document API

The Document API from Nedap — 17 operation(s) for document.

Nedap Document API is one of 269 APIs that Nedap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 18 operations across 17 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 0.0.0.

Requests are made against a single base URL, https://api-development.ons.io.

18 operations 17 paths 5 schemas 14 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.0
Base URL
https://api.ons.io
Resource Areas
1

Paths & Operations 18

Across 17 paths, the API surfaces 18 operations — 14 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Document 18
POST
/t/documentsdeprecated
Create a document for a client.
DocumentAPI.create 1 param body → 200415
GET
/t/documentsdeprecated
Find the document corresponding to the given client and document id's
DocumentAPI.byClientIdAndDocumentId 2 params → 200405
GET
/t/documents/downloaddeprecated
Returns a stream of bytes representing the document, be sure to close the…
DocumentAPI.downloadByClientIdAndDocumentId 2 params → 200405
GET
/t/documents/by_client/{client_id}deprecated
Find all documents for a client
DocumentAPI.byClientIdAndEmployeeIdAndDate 4 params → 200
GET
/t/documents/by_client/{client_id}/all_archived_includeddeprecated
Find all active and archived documents
DocumentAPI.documentsByClientInPeriodIncludeArchived 6 params → 200404
PUT
/t/documents/update_status/{document_object_id}deprecated
Update the status of a document
DocumentAPI.updateStatus 2 params → 200
GET
/t/documents/x-stream-connect/datadeprecated
Return all Document models in a streaming manner
DocumentAPI.streamAll → 200400404500
GET
/t/documents/x-stream-connect/deletesdeprecated
Return all Document models which where deleted since the date given in the…
DocumentAPI.streamDeletes 1 param → 200400404500
GET
/t/documents/x-stream-connect/updatesdeprecated
Return all Document models which where updated since the date given in the…
DocumentAPI.streamUpdates 1 param → 200400404500
POST
/v0/administration/clients/{client_id}/documents
Create a document for a client.
postV0AdministrationClientsByClientIdDocuments 1 param body → 200415
GET
/v0/administration/clients/{client_id}/documents/{doc_id}
Find the document corresponding to the given client and document id's
getV0AdministrationClientsByClientIdDocumentsByDocId 2 params → 200405
GET
/v0/administration/clients/{client_id}/documents/{doc_id}/download
Returns a stream of bytes representing the document, be sure to close the…
getV0AdministrationClientsByClientIdDocumentsByDocIdDownload 2 params → 200405
GET
/v0/administration/clients/{client_id}/documents/all
Find all documents for a client
getV0AdministrationClientsByClientIdDocumentsAll 4 params → 200
GET
/v0/administration/clients/{client_id}/documents/all_archived_included
Find all active and archived documents
getV0AdministrationClientsByClientIdDocumentsAllArchivedIncluded 6 params → 200404
PUT
/v0/administration/documents/{document_object_id}/status
Update the status of a document
putV0AdministrationDocumentsByDocumentObjectIdStatus 2 params → 200
GET
/v0/xstream/documents/data
Return all Document models in a streaming manner
getV0XstreamDocumentsData → 200400404500
GET
/v0/xstream/documents/deletes
Return all Document models which where deleted since the date given in the…
getV0XstreamDocumentsDeletes 1 param → 200400404500
GET
/v0/xstream/documents/updates
Return all Document models which where updated since the date given in the…
getV0XstreamDocumentsUpdates 1 param → 200400404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Document (12 properties), ExpertiseProfile (8 properties), ExpertiseGroup (6 properties), list.DocumentList (1 property). Each schema is shown below with its type and property counts.

RightSelection
string
RightSelection enum (no description)
list.DocumentList
object
DocumentList model (no description)
1 property
ExpertiseGroup
object
Model is used to group {@link ExpertiseProfile}'s, with possibly other {@link ExpertiseGroup}'s as parent/children.
6 properties
Document
object
Document model (no description)
12 properties 2 required
ExpertiseProfile
object
Model is used to check to see if a person can be connected to a certain {@link HourType}.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nedap-document-api-openapi.yml Raw ↑

Other APIs Nedap publishes across the network.

Nedap Retail iD Cloud API
Nedap Address API
Nedap Admin.Background Image API
Nedap Admin.License API
Nedap Admin.Logo Image API
Nedap Admin.Timesheet Config API
Nedap Admin.Version API
Nedap Agbcode API
Nedap Agenda.Agenda Occurrence API
Nedap Agenda.Agenda Series API
Nedap Agenda.Client Absence Occurrence API
Nedap Agenda.Label API
Where this information came from

This is an independent, third-party profile of Nedap Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.