diff --git a/docs/learn/standards/adding-a-communication-standard.md b/docs/learn/standards/adding-a-communication-standard.md index 6023b3d..eb6f978 100644 --- a/docs/learn/standards/adding-a-communication-standard.md +++ b/docs/learn/standards/adding-a-communication-standard.md @@ -2,7 +2,16 @@ ## Entity relationship diagram ---8<-- "learn/standards/snippets/communication-standard-entity-relationship-diagram.md" +``` mermaid +erDiagram + COMMUNICATION-STANDARD ||--o{ VERSION : contains + COMMUNICATION-STANDARD }o..|| ORGANIZATION : references +``` + +!!! info + + - Exactly one `COMMUNICATION-STANDARD` *contains* zero or more `VERSION` + - Zero or more `COMMUNICATION-STANDARD` *references* exactly one `ORGANIZATION` ## Add communication standard @@ -112,4 +121,60 @@ https://oas.zorgapis.nl/#tag/communication-standards/operation/updateCommunicationStandard){: target="_blank" } or fork our [Postman Collection]( https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } + and explore our API. + +## Get communication standards + +=== "Request" + + ```json + GET https://api.zorgapis.nl/v1beta1/communication-standards HTTP/1.1 + ``` + +=== "Response" + + ```json hl_lines="6 15" + HTTP/1.1 200 OK + Content-Type: application/json + + --8<-- "learn/standards/snippets/get-communication-standards_response.json" + ``` + + 1. The UUID of the [communication standard](#add-communication-standard). + 2. The UUID of the [main version](#set-communication-standard-main-version-request). + +!!! note + + To learn more, view the [API reference]( + https://oas.zorgapis.nl/#tag/communication-standards/operation/listCommunicationStandards){: target="_blank" } + or fork our [Postman Collection]( + https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } + and explore our API. + +## Get communication standard versions + +List all versions for the communication standard with id `#!js "05d8de10-1932-4e7f-badf-655c1a82fcc3"`: + +=== "Request" + + ```json + GET https://api.zorgapis.nl/v1beta1/communication-standard-versions + ?filter=eq(communicationStandardId,"05d8de10-1932-4e7f-badf-655c1a82fcc3") HTTP/1.1 + ``` + +=== "Response" + + ```json hl_lines="9" + HTTP/1.1 200 OK + Content-Type: application/json + + --8<-- "learn/standards/snippets/get-communication-standard-versions_response.json" + ``` + +!!! note + + To learn more, view the [API reference]( + https://oas.zorgapis.nl/#tag/communication-standard-versions/operation/listCommunicationStandardVersions){: target="_blank" } + or fork our [Postman Collection]( + https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } and explore our API. \ No newline at end of file diff --git a/docs/learn/standards/getting-communication-standards.md b/docs/learn/standards/getting-communication-standards.md deleted file mode 100644 index 9cd7a5d..0000000 --- a/docs/learn/standards/getting-communication-standards.md +++ /dev/null @@ -1,61 +0,0 @@ -# Getting communication standards - -## Entity relationship diagram - ---8<-- "learn/standards/snippets/communication-standard-entity-relationship-diagram.md" - -## Get communication standards - -=== "Request" - - ```json - GET https://api.zorgapis.nl/v1beta1/communication-standards HTTP/1.1 - ``` - -=== "Response" - - ```json hl_lines="6 15" - HTTP/1.1 200 OK - Content-Type: application/json - - --8<-- "learn/standards/snippets/get-communication-standards_response.json" - ``` - - 1. The UUID of the [communication standard](./adding-a-communication-standard.md#add-communication-standard). - 2. The UUID of the [main version](./adding-a-communication-standard.md#set-communication-standard-main-version-request). - -!!! note - - To learn more, view the [API reference]( - https://oas.zorgapis.nl/#tag/communication-standards/operation/listCommunicationStandards){: target="_blank" } - or fork our [Postman Collection]( - https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } - and explore our API. - -## Get communication standard versions - -List all versions for the communication standard with id `#!js "05d8de10-1932-4e7f-badf-655c1a82fcc3"`: - -=== "Request" - - ```json - GET https://api.zorgapis.nl/v1beta1/communication-standard-versions - ?filter=eq(communicationStandardId,"05d8de10-1932-4e7f-badf-655c1a82fcc3") HTTP/1.1 - ``` - -=== "Response" - - ```json hl_lines="9" - HTTP/1.1 200 OK - Content-Type: application/json - - --8<-- "learn/standards/snippets/get-communication-standard-versions_response.json" - ``` - -!!! note - - To learn more, view the [API reference]( - https://oas.zorgapis.nl/#tag/communication-standard-versions/operation/listCommunicationStandardVersions){: target="_blank" } - or fork our [Postman Collection]( - https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } - and explore our API. \ No newline at end of file diff --git a/docs/learn/standards/snippets/communication-standard-entity-relationship-diagram.md b/docs/learn/standards/snippets/communication-standard-entity-relationship-diagram.md deleted file mode 100644 index 3041317..0000000 --- a/docs/learn/standards/snippets/communication-standard-entity-relationship-diagram.md +++ /dev/null @@ -1,10 +0,0 @@ -``` mermaid -erDiagram - COMMUNICATION-STANDARD ||--o{ VERSION : contains - COMMUNICATION-STANDARD }o..|| ORGANIZATION : references -``` - -!!! info - - - Exactly one `COMMUNICATION-STANDARD` *contains* zero or more `VERSION` - - Zero or more `COMMUNICATION-STANDARD` *references* exactly one `ORGANIZATION` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1b3f182..dae7b42 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -145,7 +145,6 @@ nav: - Adding an API specification: learn/apis/adding-an-api-specification.md - Standards: - learn/standards/index.md - - Getting communication standards: learn/standards/getting-communication-standards.md - Adding a communication standard: learn/standards/adding-a-communication-standard.md - Agreements: - learn/agreements/index.md