# Preview a change to a layer

`POST https://evohub.io/api/v1/schedules/{id}/layers/{layerID}/revise/preview`

Part of the [On-Call API](https://docs.evohub.io/oncall.md) reference · operationId `previewScheduleLayerRevision`.

What `POST /api/v1/schedules/{id}/layers/{layerID}/revise` would do with
the same body, without storing anything: when the change would take
over, and the next six turns — the layer as it stands until then, the
changed layer after.

**Permission (API-key scope):** `oncall:schedule:write`.

## Authorization

Any one of:

- `bearerAuth` (oncall:schedule:write)
- `apiKeyHeader` (oncall:schedule:write)

Where:

- `bearerAuth`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `apiKeyHeader`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Path parameters

- `id` (string, required, example `5b1c7d2e-8f3a-4b9c-a0d1-e2f3a4b5c6d7`): The schedule's id.
- `layerID` (string, required, example `7c3d9e1f-2a4b-4c6d-8e0f-1a2b3c4d5e6f`): The layer's id. It must belong to the schedule in the path.

## Request body (required)

Content type: `application/json`

Type: `ScheduleLayerRevision`

A layer as it should be, and when that takes over. `name` and `rotation_type` are required. `rotation_start` is checked but not used; the changed layer starts at the moment the change takes over.

- `name` (string)
- `priority` (integer)
- `rotation_type` (RotationType, one of `daily`, `weekly`, `custom`)
- `rotation_unit` (string, one of `day`, `hour`): What `handoff_day` counts on a `custom` rotation; `day` when left out.
- `rotation_start` (string (date-time))
- `handoff_day` (integer): For a `custom` rotation, the days (1–365) or hours (1–168) each turn lasts.
- `handoff_weekday` (integer, min 0, max 6): The weekday a `weekly` rotation hands over on, 0 (Sunday) to 6. Left out, it hands over on the weekday `rotation_start` falls on.
- `handoff_time` (string): `HH:MM` on the schedule's clock.
- `restrict_to_weekdays` (array of integer)
- `restrict_start_time` (string)
- `restrict_end_time` (string)
- `user_ids` (array of string): The members in rota order, each once.
- `effective` (string, one of `now`, `after_current_shift`, `after_full_rotation`, `at`, default `after_current_shift`)
- `at` (string (date-time)): With `effective` `at`, the moment the change takes over; not in the past.
- `restart` (boolean, default `false`): Begin the new list at its first member instead of keeping the current holder.

## Responses

### 200 — When the change would take over, and the next six turns.

Content type: `application/json`

Type: `object`

- `data` (object, required)
  - `effective_at` (string (date-time), required)
  - `turns` (array of ScheduleTurn, required)
    - `layer_id` (string): The layer giving the turn (`preview` for a layer that is not stored yet).
    - `user_id` (string): Who holds the turn; empty in a preview with no members.
    - `start` (string (date-time))
    - `end` (string (date-time))
- `success` (boolean, required, value `true`)

### 400 — The body is invalid as for the change itself (`INVALID_BODY`, `VALIDATION_FAILED`).

Content type: `application/json`

Type: `ValidationError`

- `error` (object, required)
  - `code` (string, required, value `VALIDATION_FAILED`)
  - `message` (string, required)
  - `request_id` (string): The request's `X-Request-ID`. Quote it to support.
  - `details` (array of object, required)
    - `field` (string)
    - `message` (string)

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The request's `X-Request-ID`. Quote it to support.

### 403 — The key lacks the scope this endpoint needs (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The request's `X-Request-ID`. Quote it to support.

### 404 — No such schedule, or no such layer on it (`NOT_FOUND`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The request's `X-Request-ID`. Quote it to support.

### 409 — The layer has ended or has not started yet (`LAYER_NOT_IN_EFFECT`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The request's `X-Request-ID`. Quote it to support.

### 429 — Too many requests (`RATE_LIMITED`). Wait `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The request's `X-Request-ID`. Quote it to support.

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The request's `X-Request-ID`. Quote it to support.

## Example request

```bash
curl -X POST 'https://evohub.io/api/v1/schedules/5b1c7d2e-8f3a-4b9c-a0d1-e2f3a4b5c6d7/layers/7c3d9e1f-2a4b-4c6d-8e0f-1a2b3c4d5e6f/revise/preview' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "name": "Primary",
  "user_ids": [
    "0b8e6c1a-2f4d-4e9b-8a7c-3d5e6f708192",
    "9a7b5c3d-1e2f-4a6b-8c0d-2e4f6a8b0c1d"
  ],
  "effective": "after_full_rotation",
  "handoff_time": "09:00",
  "rotation_type": "weekly",
  "handoff_weekday": 1
}'
```