# Create location in zone

Canonical page: https://docs.ovok.com/slim-apis/zones/create-location-in-zone

| Method | Path |
| --- | --- |
| `POST` | `/v1/slim/zones/:zoneId/locations` |

[Authentication](/authentication) · [Access policies](/access-policies)

Creates a location (a FHIR `Location`) inside a zone. The new location's managing organization is the zone.

**Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `Location:create` and `Device:update` (admins and super admins skip this check).
**Scope:** The location is created in the caller's project (from the token). A super-admin caller may pass `?projectId=<uuid>` to create it in that project instead; the project must exist. The zone must belong to the project in use, its parent project, or one of its sub-projects.

## Request [#request]

### Path parameters [#path-parameters]

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `zoneId` | `string (uuid)` | Yes | Zone (organization) id. |

### Query parameters [#query-parameters]

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `projectId` | `string (uuid)` | No | Create the location in this project. Super admins only. Must name an existing project. |

### Body [#body]

The body is strict: a field that is not listed here fails validation.

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | Yes | Location name. At least 1 character. Must be unique. |
| `floor` | `string` | No | Floor code. |
| `room` | `string` | No | Room code. |
| `bed` | `string` | No | Bed code. |

## Behaviour [#behaviour]

- `name` is required and must be unique among the locations your token can search.
- `floor`, `room` and `bed` are optional. When at least one is set, no other location in the zone may have the same floor, room and bed. A location with none of them is checked by name only.
- The location is created with no devices or residents. Assign them with `PUT /v1/slim/zones/{zoneId}/locations/{locationId}`.
- A location-created entry is added to the change history. A failure to write that entry does not fail the request.
- The response is the new location, in the same shape as `GET /v1/slim/location/{id}`.

## Example [#example]

```bash
curl -X POST 'https://api.sandbox.ovok.com/v1/slim/zones/1e6b8d30-2c4f-4a95-8d7e-b0a2c4e6f918/locations' \
  -H "Authorization: Bearer ${OVOK_TOKEN}" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Room 101 Bed 1",
    "floor": "1",
    "room": "101",
    "bed": "1"
  }'
```

## Successful response [#successful-response]

`201` — Location created in zone.

```json
{
  "id": "5d2a9c64-7e1b-4830-b6f5-9a3c1e8d7b02",
  "name": "Room 101 Bed 1",
  "floor": "1",
  "room": "101",
  "bed": "1",
  "organizationId": "1e6b8d30-2c4f-4a95-8d7e-b0a2c4e6f918",
  "organizationName": "Zone A"
}
```

The body is the created location, as `GET /v1/slim/location/{id}` returns it.

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string (uuid)` | Location id. |
| `name` | `string` | Location name. Empty string when the location has none. |
| `floor` | `string` | Floor code. Left out when not set. |
| `room` | `string` | Room code. Left out when not set. |
| `bed` | `string` | Bed code. Left out when not set. |
| `organizationId` | `string (uuid)` | Zone id. Left out when the location has no zone. |
| `organizationName` | `string` | Zone name. Left out when the location has no zone. |
| `deviceId` | `string[]` | Ids of every device at the location. Left out when there is none. |
| `deviceName` | `string` | Alphabetically first name among the devices at the location. Left out when there is none. |
| `patientId` | `string (uuid)` | Resident on the first device at the location that has one. Left out when there is none. |
| `patientName` | `string` | That resident's name. Left out when there is none. |

## Errors [#errors]

| Status | Meaning |
| --- | --- |
| [`401`](/errors/unauthenticated) | Bearer token is missing, invalid or expired. |
| [`403`](/errors/forbidden) | You are not a practitioner, admin or System Owner, you lack `Location:create` or `Device:update`, `projectId` is set by a caller who is not a super admin, your session has no project, or the zone is outside your project tree or carries no project. |
| [`404`](/errors/not-found) | No zone with this `zoneId` exists. |
| [`409`](/errors/conflict) | A location with the same floor, room and bed already exists in this zone. The body names it in `existingLocationId` and `existingLocationName`. |
| [`422`](/errors/validation-failed) | `zoneId` is not a UUID, the body fails validation, `projectId` is not a UUID or names no project, or a location with the same name already exists. |
