Skip to content

Commit

Permalink
Update adding-a-trust-framework.md
Browse files Browse the repository at this point in the history
  • Loading branch information
avanbremen committed Sep 30, 2024
1 parent 0b6405d commit d7de480
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 73 deletions.
67 changes: 66 additions & 1 deletion docs/learn/agreements/adding-a-trust-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@

## Entity relationship diagram

--8<-- "learn/agreements/snippets/trust-framework-entity-relationship-diagram.md"
``` mermaid
erDiagram
TRUST-FRAMEWORK ||--o{ VERSION : contains
TRUST-FRAMEWORK }o..|| ORGANIZATION : references
```

!!! info

- Exactly one `TRUST-FRAMEWORK` *contains* zero or more `VERSION`
- Zero or more `TRUST-FRAMEWORK` *references* exactly one `ORGANIZATION`

## Add trust framework

Expand Down Expand Up @@ -112,4 +121,60 @@
https://oas.zorgapis.nl/#tag/trust-frameworks/operation/updateTrustFramework){: target="_blank" }
or fork our [Postman Collection](
https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" }
and explore our API.

## Get trust frameworks

=== "Request"

```json
GET https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1
```

=== "Response"

```json hl_lines="6 15"
HTTP/1.1 200 OK
Content-Type: application/json

--8<-- "learn/agreements/snippets/get-trust-frameworks_response.json"
```

1. The UUID of the [trust framework](#add-trust-framework).
2. The UUID of the [main version](#set-trust-framework-main-version-request).

!!! note

To learn more, view the [API reference](
https://oas.zorgapis.nl/#tag/trust-frameworks/operation/listTrustFrameworks){: target="_blank" }
or fork our [Postman Collection](
https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" }
and explore our API.

## Get trust framework versions

List all versions for the trust framework with id `#!js "3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae"`:

=== "Request"

```json
GET https://api.zorgapis.nl/v1beta1/trust-framework-versions
?filter=eq(trustFrameworkId,"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae") HTTP/1.1
```

=== "Response"

```json hl_lines="9"
HTTP/1.1 200 OK
Content-Type: application/json

--8<-- "learn/agreements/snippets/get-trust-framework-versions_response.json"
```

!!! note

To learn more, view the [API reference](
https://oas.zorgapis.nl/#tag/trust-framework-versions/operation/listTrustFrameworkVersions){: 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/agreements/getting-trust-frameworks.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 @@ -148,7 +148,6 @@ nav:
- Adding a communication standard: learn/standards/adding-a-communication-standard.md
- Agreements:
- learn/agreements/index.md
- Getting trust frameworks: learn/agreements/getting-trust-frameworks.md
- Adding a trust framework: learn/agreements/adding-a-trust-framework.md
- Play:
- play/index.md
Expand Down

0 comments on commit d7de480

Please sign in to comment.