v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-135137125.7 KB
layers

Gets the annotation data for a volume and layer.

get/books/v1/volumes/{volumeId}/layers/{layerId}/data

Path parameters

volumeIdstring required

The volume to retrieve annotation data for.

layerIdstring required

The ID for the layer to get the annotation data.

Query parameters

contentVersionstring required

The content version for the requested volume.

annotationDataIdstring[]

The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.

hinteger

The requested pixel height for any images. If height is provided width must also be provided.

localestring

The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

maxResultsinteger

Maximum number of results to return

pageTokenstring

The value of the nextToken from the previous page.

scaleinteger

The requested scale for the image.

sourcestring

String to identify the originator of this request.

updatedMaxstring

RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

updatedMinstring

RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

winteger

The requested pixel width for any images. If width is provided height must also be provided.

Response

Successful response