Skip to content

Adding an organization

Add organization

This section guides you through the process of adding your organization to the API Library for Dutch Healthcare via our API.

Info

You can set the URL of your organization on GitHub or GitLab using the githubUrl and gitlabUrl properties. This URL will be used to retrieve the organization's avatar and display it on the organization page in the API Library for Dutch Healthcare.

POST https://api.zorgapis.nl/v1beta1/organizations HTTP/1.1
Content-Type: application/json

{
  "name": "Nictiz", // (1)!
  "description": "Nictiz is the Dutch competence center for electronic exchange of health and care information.",
  "website": "https://nictiz.nl/",
  "githubUrl": "https://github.com/Nictiz", // (2)!
  "emailAddress": "info@nictiz.nl",
  "phoneNumber": "+31 (0)70 317 3450",
  "address": {
    "street": "Oude Middenweg",
    "houseNumber": 55, // (3)!
    "addressLine2": "Office building Palazzo Giardino",
    "postalCode": "2491 AC",
    "city": "The Hague",
    "stateOrRegion": "South Holland",
    "country": "NL"
  }
}
  1. The name of the organization, must be unique.
  2. The URL of the organization on GitHub. For GitLab, use the gitlabUrl property.
  3. To set the house number addition (for example, 'A'), use the houseNumberAddition property.
HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad", // (1)!
  "name": "Nictiz",
  "description": "Nictiz is the Dutch competence center for electronic exchange of health and care information.",
  "website": "https://nictiz.nl/",
  "githubUrl": "https://github.com/Nictiz",
  "emailAddress": "info@nictiz.nl",
  "phoneNumber": "+31 (0)70 317 3450",
  "address": {
    "street": "Oude Middenweg",
    "houseNumber": 55,
    "addressLine2": "Office building Palazzo Giardino",
    "postalCode": "2491 AC",
    "city": "The Hague",
    "stateOrRegion": "South Holland",
    "country": "NL"
  }
}
  1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the organization by the API server.

Note

To learn more, view the API reference or fork our Postman Collection and explore our API.