Postman - Create A New Location and\or New Group

Purpose: To show how to create a new location and to show how to create a new group.

Precondition:

Generate an Access token

*Note: The route is the same for creating a new location and for creating a new group. In the body is where you will specify if you want to create a new location or a new group.

1.) Route

https://api.qa.eu.noah-es.com/:tenantId/api/PatientGroups

:tenantid is a variable I set.

2.) Params

the only Param is the :tenantid variable.

3.) Headers

a.) X-API-Version - set to 1.0, the Noah ES API Version. The X-Api-Version needs to be set. At this time 1.0 is the only version, so this is what I have set.

b.) X-Idempotent-ID must be unique.

4.) Body

a.) Location

{
  "name": "Noah ES Location 3",
  "type": "Location",
  "description": null,
  "address1": null,
  "address2": null,
  "address3": null,
  "postalCode": null,
  "city": null,
  "province": null,
  "country": null,
  "phoneNumber": null,
  "emailAddress": null,
  "websiteURL": null
}

b.) New Group

{
  "name": "Noah ES Patient Group 3",
  "type": "PatientGroup",
  "description": null,
  "address1": null,
  "address2": null,
  "address3": null,
  "postalCode": null,
  "city": null,
  "province": null,
  "country": null,
  "phoneNumber": null,
  "emailAddress": null,
  "websiteURL": null
}

4.) Results

You should get a Status: 200 OK message.

a. ) Below is the data the is returned for a successful post to create a new location.

{
    "patientGroupId": "716c7ff5-c0e0-4132-9c93-bd7e535e0578",
    "created": "2023-11-08T17:43:46.9Z",
    "updated": "2023-11-08T17:43:46.9Z",
    "name": "Noah ES Location 3",
    "type": "Location",
    "description": null,
    "address1": null,
    "address2": null,
    "address3": null,
    "postalCode": null,
    "city": null,
    "province": null,
    "country": null,
    "phoneNumber": null,
    "emailAddress": null,
    "websiteURL": null
}

b.) Below is the data the is returned for a successful post to create a new group.