Sign in

v1

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

Gets the volume annotations for a volume and layer.

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

Path parameters

volumeIdstring required

The volume to retrieve annotations for.

layerIdstring required

The ID for the layer to get the annotations.

Query parameters

contentVersionstring required

The content version for the requested volume.

endOffsetstring

The end offset to end retrieving data from.

endPositionstring

The end position to end retrieving data from.

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.

showDeletedboolean

Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

sourcestring

String to identify the originator of this request.

startOffsetstring

The start offset to start retrieving data from.

startPositionstring

The start position to start retrieving data from.

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).

volumeAnnotationsVersionstring

The version of the volume annotations that you are requesting.

Response

Successful response