gogol-books-0.0.1: Google Books SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Books.Layers.AnnotationData.List

Contents

Description

Gets the annotation data for a volume and layer.

See: Books API Reference for books.layers.annotationData.list.

Synopsis

REST Resource

type LayersAnnotationDataListResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> ("data" :> (QueryParam "contentVersion" Text :> (QueryParam "w" (Textual Int32) :> (QueryParam "scale" (Textual Int32) :> (QueryParam "locale" Text :> (QueryParam "updatedMax" Text :> (QueryParam "updatedMin" Text :> (QueryParams "annotationDataId" Text :> (QueryParam "source" Text :> (QueryParam "h" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AnnotationsData)))))))))))))))))) Source

A resource alias for books.layers.annotationData.list method which the LayersAnnotationDataList request conforms to.

Creating a Request

Request Lenses

ladlW :: Lens' LayersAnnotationDataList (Maybe Int32) Source

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

ladlScale :: Lens' LayersAnnotationDataList (Maybe Int32) Source

The requested scale for the image.

ladlLocale :: Lens' LayersAnnotationDataList (Maybe Text) Source

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

ladlContentVersion :: Lens' LayersAnnotationDataList Text Source

The content version for the requested volume.

ladlUpdatedMax :: Lens' LayersAnnotationDataList (Maybe Text) Source

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

ladlUpdatedMin :: Lens' LayersAnnotationDataList (Maybe Text) Source

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

ladlAnnotationDataId :: Lens' LayersAnnotationDataList [Text] Source

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

ladlVolumeId :: Lens' LayersAnnotationDataList Text Source

The volume to retrieve annotation data for.

ladlSource :: Lens' LayersAnnotationDataList (Maybe Text) Source

String to identify the originator of this request.

ladlH :: Lens' LayersAnnotationDataList (Maybe Int32) Source

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

ladlPageToken :: Lens' LayersAnnotationDataList (Maybe Text) Source

The value of the nextToken from the previous page.

ladlLayerId :: Lens' LayersAnnotationDataList Text Source

The ID for the layer to get the annotation data.

ladlMaxResults :: Lens' LayersAnnotationDataList (Maybe Word32) Source

Maximum number of results to return