A site's mode

A site's mode, what turning hard mode on still needs, and what each mode does.

# A site's mode

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-hard

`GET /api/v1/sites/{site}/hard`

A site's mode, what turning hard mode on still needs, and what each mode does.

## Parameters

- `site` (in path, needed): A site's id or name

## The answer

200, `HardView`: A site's mode and what turning hard mode on still needs (MO-02).

- `banner` (integer or null): The banner version being shown, if one is.
- `checklist` (list of object, needed)
- `compare` (list of ModeLine, needed): What each mode does, line by line (MO-07).
- `holds` (list of Held, needed): Rows hard mode holds for the site, table by table.
- `mode` (string, needed): `easy` or `hard`.
- `policy_text` (string, needed): The paragraph for the site's privacy policy.
- `reading` (string, needed): The reading of the law the site is set up for: `strict` or `cnil`.
- `ready` (boolean, needed): Every step but the last is done: it can be turned on.
- `settings` (object, needed)
- `site` (string, needed)

## Asking

```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/hard \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```

Parameters

sitein the address

neededA site's id or name

The answer

Status 200

HardView A site's mode and what turning hard mode on still needs (MO-02).

banner

integer or nullThe banner version being shown, if one is.

checklist

list of objectneeded

compare

list of ModeLineneededWhat each mode does, line by line (MO-07).

holds

list of HeldneededRows hard mode holds for the site, table by table.

mode

stringneeded`easy` or `hard`.

policy_text

stringneededThe paragraph for the site's privacy policy.

reading

stringneededThe reading of the law the site is set up for: `strict` or `cnil`.

ready

booleanneededEvery step but the last is done: it can be turned on.

settings

objectneeded

site

stringneeded

Asking

curl https://tidekeeper.eu/api/v1/sites/example.org/hard \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"

const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/hard", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());