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 Dossier.Report API

The dossier.Report API from Nedap — 52 operation(s) for dossier.report.

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

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 56 operations across 52 paths, and defines 14 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.

56 operations 52 paths 14 schemas 2 DELETE42 GET6 POST6 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 56

Across 52 paths, the API surfaces 56 operations — 2 DELETE, 42 GET, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

dossier.Report 56
POST
/t/dossier/reportsdeprecated
Create Report
dossier.ReportAPI.create 2 params body → 200400
GET
/t/dossier/reports/{id}deprecated
Return the Report corresponding to the given id
dossier.ReportAPI.byId 3 params → 200404
PUT
/t/dossier/reports/{id}deprecated
Updates the given Report
dossier.ReportAPI.update 3 params body → 200400
DELETE
/t/dossier/reports/{id}deprecated
Deletes the Report with given id
dossier.ReportAPI.delete 3 params → 200204404
GET
/t/dossier/reports/{report_id}/childrendeprecated
Returns all the reactions for a given report
dossier.ReportAPI.childrenByReportId 1 param → 200
GET
/t/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id}deprecated
Returns all reports filtered by care plan entry without applying HTML esaping
dossier.ReportAPI.findByCarePlanEntryUnescaped 4 params → 200
GET
/t/dossier/reports/by_care_plan_entry/{care_plan_entry_id}deprecated
Returns all reports filtered by care plan entry with HTML escaping applied to…
dossier.ReportAPI.findByCarePlanEntry 4 params → 200
GET
/t/dossier/reports/by_datedeprecated
Returns all reports filtered by date
dossier.ReportAPI.findByDate 4 params → 200
GET
/t/dossier/reports/by_demand/{demand_id}deprecated
Returns all reports filtered by demand id
dossier.ReportAPI.findByDemand 3 params → 200
GET
/t/dossier/reports/by_episode/{episode_id}deprecated
Returns all reports filtered by episode id
dossier.ReportAPI.findByEpisode 2 params → 200
GET
/t/dossier/reports/by_report_link/{report_link_id}deprecated
Returns all reports filtered by report link id
dossier.ReportAPI.findByReportLink 2 params → 200
GET
/t/dossier/reports/by_restrictive_measure/{restrictive_measure_id}deprecated
Returns all reports filtered by restrictive measures id
dossier.ReportAPI.findByRestrictiveMeasure 2 params → 200
GET
/t/dossier/reports/by_uuid/{uuid}deprecated
Return the Report corresponding to the given uuid
dossier.ReportAPI.byUuid 3 params → 200404
GET
/t/dossier/reports/last_report_authorizationsdeprecated
Return the child Reports of a Report corresponding to the given id
dossier.ReportAPI.lastReportAuthorizationsByClientIdAndEmployeeId 4 params → 200400
GET
/t/dossier/reports/search_by_clientdeprecated
Searches for Reports for the Client (corresponding to the given id)
dossier.ReportAPI.searchByClient 19 params → 200304400
POST
/t/dossier/reports/soap/reportdeprecated
Create a SOAP report where each soap-part (optionally) has it's own…
dossier.ReportAPI.createSoapReport 2 params body → 200400
PUT
/t/dossier/reports/soap/report/{id}deprecated
Updates a SOAP report where each soap-part (optionally) has it's own…
dossier.ReportAPI.updateSoapReport 3 params body → 200400
POST
/t/dossier/authorized/clients/{client_id}/reportsdeprecated
Create Report. Authorization is done in dossier controller this points to
dossier.ReportAPI.authorizedCreate 1 param body → 200
PUT
/t/dossier/authorized/clients/{client_id}/reports/{report_id}deprecated
Update Report. Authorization is done in dossier controller this points to
dossier.ReportAPI.authorizedUpdate 2 params body → 200
GET
/t/dossier/authorized/clients/{client_id}/reports/search_by_clientdeprecated
Return Reports, filtered by params Authorization is done in dossier controller…
dossier.ReportAPI.authorizedSearchByClient 16 params → 200
GET
/t/dossier/authorized/clients/{client_id}/reports/search_by_client_with_updated_sincedeprecated
Return Reports with updated since option, filtered by params Authorization is…
dossier.ReportAPI.authorizedSearchByClientWithUpdatedSince 17 params → 200
GET
/t/dossier/clients/{client_id}/reports/vital_signs_reportsdeprecated
Lists vital signs from reports
dossier.ReportAPI.vitalSignsReports 1 param → 200
GET
/t/dossier/authorized/reports/with_actionsdeprecated
Return reports that have actions created by user or for user's expertise
dossier.ReportAPI.withActions 4 params → 200
GET
/t/dossier/authorized/reports/with_actions_summarydeprecated
Return a count of reports that have actions created by user or for user's…
dossier.ReportAPI.withActionsSummary 3 params → 200
GET
/t/dossier/authorized/clients/{client_id}/reports/unfiltered_search_by_clientdeprecated
Return Reports Unfiltered, filtered by params Authorization is done in dossier…
dossier.ReportAPI.authorizedUnfilteredSearchByClient 16 params → 200
GET
/t/dossier/reports/by_next_dossier_report_link/{report_link_id}deprecated
Returns report by next dossier report link
dossier.ReportAPI.findByNextDossierReportLink 1 param → 200
GET
/t/dossier/reports/x-stream-connect/datadeprecated
Return all Report models in a streaming manner
dossier.ReportAPI.streamAll → 200400404500
GET
/t/dossier/reports/x-stream-connect/updatesdeprecated
Return all Report models which were updated since the date given in the request
dossier.ReportAPI.streamUpdates 1 param → 200400404500
POST
/v0/administration/dossier/reports
Create Report
postV0AdministrationDossierReports 2 params body → 200400
GET
/v0/administration/dossier/reports/{id}
Return the Report corresponding to the given id
getV0AdministrationDossierReportsById 3 params → 200404
PUT
/v0/administration/dossier/reports/{id}
Updates the given Report
putV0AdministrationDossierReportsById 3 params body → 200400
DELETE
/v0/administration/dossier/reports/{id}
Deletes the Report with given id
deleteV0AdministrationDossierReportsById 3 params → 200204404
GET
/v0/administration/dossier/reports/{report_id}/children
Returns all the reactions for a given report
getV0AdministrationDossierReportsByReportIdChildren 1 param → 200
GET
/v0/administration/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id}
Returns all reports filtered by care plan entry without applying HTML esaping
getV0AdministrationDossierReportsByCarePlanEntryUnescapedByCarePlanEntryId 4 params → 200
GET
/v0/administration/dossier/reports/by_care_plan_entry/{care_plan_entry_id}
Returns all reports filtered by care plan entry with HTML escaping applied to…
getV0AdministrationDossierReportsByCarePlanEntryByCarePlanEntryId 4 params → 200
GET
/v0/administration/dossier/reports/by_date/{valid_from}...{valid_to}
Returns all reports filtered by date
getV0AdministrationDossierReportsByDateByValidFrom}{validTo 4 params → 200
GET
/v0/administration/dossier/reports/by_demand/{demand_id}
Returns all reports filtered by demand id
getV0AdministrationDossierReportsByDemandByDemandId 3 params → 200
GET
/v0/administration/dossier/reports/by_episode/{episode_id}
Returns all reports filtered by episode id
getV0AdministrationDossierReportsByEpisodeByEpisodeId 2 params → 200
GET
/v0/administration/dossier/reports/by_report_link/{report_link_id}
Returns all reports filtered by report link id
getV0AdministrationDossierReportsByReportLinkByReportLinkId 2 params → 200
GET
/v0/administration/dossier/reports/by_restrictive_measure/{restrictive_measure_id}
Returns all reports filtered by restrictive measures id
getV0AdministrationDossierReportsByRestrictiveMeasureByRestrictiveMeasureId 2 params → 200
GET
/v0/administration/dossier/reports/by_uuid/{uuid}
Return the Report corresponding to the given uuid
getV0AdministrationDossierReportsByUuidByUuid 3 params → 200404
GET
/v0/administration/dossier/reports/last_report_authorizations
Return the child Reports of a Report corresponding to the given id
getV0AdministrationDossierReportsLastReportAuthorizations 4 params → 200400
GET
/v0/administration/dossier/reports/search_by_client
Searches for Reports for the Client (corresponding to the given id)
getV0AdministrationDossierReportsSearchByClient 19 params → 200304400
POST
/v0/administration/dossier/reports/soap/report
Create a SOAP report where each soap-part (optionally) has it's own…
postV0AdministrationDossierReportsSoapReport 2 params body → 200400
PUT
/v0/administration/dossier/reports/soap/report/{id}
Updates a SOAP report where each soap-part (optionally) has it's own…
putV0AdministrationDossierReportsSoapReportById 3 params body → 200400
POST
/v0/dossier/back_channel/authorized/clients/{client_id}/reports
Create Report. Authorization is done in dossier controller this points to
postV0DossierBackChannelAuthorizedClientsByClientIdReports 1 param body → 200
PUT
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/{report_id}
Update Report. Authorization is done in dossier controller this points to
putV0DossierBackChannelAuthorizedClientsByClientIdReportsByReportId 2 params body → 200
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client
Return Reports, filtered by params Authorization is done in dossier controller…
getV0DossierBackChannelAuthorizedClientsByClientIdReportsSearchByClient 16 params → 200
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client_with_updated_since
Return Reports with updated since option, filtered by params Authorization is…
getV0DossierBackChannelAuthorizedClientsByClientIdReportsSearchByClientWithUpdatedSince 17 params → 200
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/vital_signs_reports
Lists vital signs from reports
getV0DossierBackChannelAuthorizedClientsByClientIdReportsVitalSignsReports 1 param → 200
GET
/v0/dossier/back_channel/authorized/reports/with_actions
Return reports that have actions created by user or for user's expertise
getV0DossierBackChannelAuthorizedReportsWithActions 4 params → 200
GET
/v0/dossier/back_channel/authorized/reports/with_actions_summary
Return a count of reports that have actions created by user or for user's…
getV0DossierBackChannelAuthorizedReportsWithActionsSummary 3 params → 200
GET
/v0/dossier/back_channel/unauthorized/clients/{client_id}/reports/unfiltered_search_by_client
Return Reports Unfiltered, filtered by params Authorization is done in dossier…
getV0DossierBackChannelUnauthorizedClientsByClientIdReportsUnfilteredSearchByClient 16 params → 200
GET
/v0/dossier/back_channel/unauthorized/reports/by_next_dossier_report_link/{report_link_id}
Returns report by next dossier report link
getV0DossierBackChannelUnauthorizedReportsByNextDossierReportLinkByReportLinkId 1 param → 200
GET
/v0/xstream/reports/data
Return all Report models in a streaming manner
getV0XstreamReportsData → 200400404500
GET
/v0/xstream/reports/updates
Return all Report models which were updated since the date given in the request
getV0XstreamReportsUpdates 1 param → 200400404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are dossier.Report (28 properties), ExpertiseProfile (8 properties), dossier.SoapReportEntry (5 properties), dossier.ReportVitalSignList (5 properties). Each schema is shown below with its type and property counts.

ExpertiseProfile
object
Model is used to check to see if a person can be connected to a certain {@link HourType}.
8 properties
dossier.ReportLinkType
string
ReportLinkType enum (no description)
dossier.ReportEntry
object
ReportEntry model (no description)
5 properties
dossier.ReportAuthorization
object
Only present when dossier.Report.confidential == true, then: - In the case of SOEP-reports (reportType 315), contains all disciplines that can see any of the S…
4 properties
AuditedBase
object
AuditedBase model (no description)
3 properties
dossier.SoapReportEntry
object
SoapReportEntry model (no description)
5 properties
dossier.Report
object
The report for which this report right applies
28 properties 1 required
dossier.list.ReportList
object
ReportList model (no description)
1 property
dossier.ReportVitalSign
object
Vital sign from a report
5 properties
dossier.list.ReportAuthorizationList
object
ReportAuthorizationList model (no description)
1 property
dossier.ReportAction
object
ReportAction model (no description)
2 properties
dossier.ReportVitalSignList
object
List of vital signs
5 properties
dossier.ReportsWithActionsSummary
object
ReportsWithActionsSummary model (no description)
2 properties
dossier.ReportFilter
string
ReportFilter model (no description)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nedap-dossier-report-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 Dossier.Report 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.