Skip to content

Commit

Permalink
Update adding-a-communication-standard.md
Browse files Browse the repository at this point in the history
  • Loading branch information
avanbremen committed Sep 30, 2024
1 parent c032af5 commit 0b6405d
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 73 deletions.
67 changes: 66 additions & 1 deletion docs/learn/standards/adding-a-communication-standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
61 changes: 0 additions & 61 deletions docs/learn/standards/getting-communication-standards.md

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0b6405d

Please sign in to comment.