GET /api/v1/people/{id}/characters

personCharacters

needs catalog:read

curl https://api.acyka.cc/api/v1/people/52991/characters?lang=en&limit=10 \
  -H "Authorization: Bearer $ACYKA_TOKEN"

Asking #

In the address

field	type	what it is
`id`	`number`	the shikimori id

Narrowing it

field	type	what it is
`lang` may be absent	`string \| undefined`	which of a title's three names leads: `en` (romaji), `ru`, `ja`, `uk`, `uz`. Defaults to `en`.
`limit` may be absent	`number \| undefined`	how many rows, 1-100; 30 by default
`offset` may be absent	`number \| undefined`	where to carry on from

Answering #

200 Page<VoicedRole> a page: items, and total beside it

It pages by limit and offset. Every library has a paginator that walks it — see Paging, which is also where the reason it stops on a short page rather than on total is written down.

The shapes #

`VoicedRole` #

A character somebody voiced, and where.

field	type	what it is
`id`	`number`
`name`	`string`
`name_orig` may be absent	`string \| undefined`
`poster` may be absent	`string \| undefined`
`title`	`TitleCard`
`roles`	`string[]`

`TitleCard` #

A title as it appears in a list.

`id` is the shikimori id and is the only key this catalogue has ever had. It is a number here rather than a string, unlike the ids above: these are five and six digits and always will be, since they are somebody else's sequence and not ours to outgrow.

field	type	what it is
`id`	`number`
`title`	`string`
`title_orig` may be absent	`string \| undefined`
`poster` may be absent	`string \| undefined`
`year` may be absent	`number \| undefined`
`kind`	`string`	`tv` \| `movie` \| `ova` \| `ona` \| `special` \| `music`
`episodes`	`number`
`score` may be absent	`number \| undefined`	The one number a reader sees: what the people here think of it and what the outside number said, weighed against each other.

When it says no #

A refusal is { "message": "errors.something" } — a phrase name and never a sentence, because one screen can be read in five languages. Every library turns the name into a type, so you catch the class you can do something about. Errors has the list.