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.VolumeAnnotations.List

Contents

Description

Gets the volume annotations for a volume and layer.

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

Synopsis

REST Resource

type LayersVolumeAnnotationsListResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> (QueryParam "contentVersion" Text :> (QueryParam "startOffset" Text :> (QueryParam "locale" Text :> (QueryParam "showDeleted" Bool :> (QueryParam "volumeAnnotationsVersion" Text :> (QueryParam "updatedMax" Text :> (QueryParam "updatedMin" Text :> (QueryParam "endOffset" Text :> (QueryParam "source" Text :> (QueryParam "pageToken" Text :> (QueryParam "endPosition" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "startPosition" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumeannotations))))))))))))))))))) Source

A resource alias for books.layers.volumeAnnotations.list method which the LayersVolumeAnnotationsList request conforms to.

Creating a Request

layersVolumeAnnotationsList Source

Arguments

:: Text

lvalContentVersion

-> Text

lvalVolumeId

-> Text

lvalLayerId

-> LayersVolumeAnnotationsList 

Creates a value of LayersVolumeAnnotationsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data LayersVolumeAnnotationsList Source

Gets the volume annotations for a volume and layer.

See: layersVolumeAnnotationsList smart constructor.

Instances

Request Lenses

lvalStartOffSet :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

The start offset to start retrieving data from.

lvalLocale :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

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

lvalContentVersion :: Lens' LayersVolumeAnnotationsList Text Source

The content version for the requested volume.

lvalShowDeleted :: Lens' LayersVolumeAnnotationsList (Maybe Bool) Source

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

lvalVolumeAnnotationsVersion :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

The version of the volume annotations that you are requesting.

lvalUpdatedMax :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

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

lvalUpdatedMin :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

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

lvalEndOffSet :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

The end offset to end retrieving data from.

lvalVolumeId :: Lens' LayersVolumeAnnotationsList Text Source

The volume to retrieve annotations for.

lvalSource :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

String to identify the originator of this request.

lvalPageToken :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

The value of the nextToken from the previous page.

lvalEndPosition :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

The end position to end retrieving data from.

lvalLayerId :: Lens' LayersVolumeAnnotationsList Text Source

The ID for the layer to get the annotations.

lvalMaxResults :: Lens' LayersVolumeAnnotationsList (Maybe Word32) Source

Maximum number of results to return

lvalStartPosition :: Lens' LayersVolumeAnnotationsList (Maybe Text) Source

The start position to start retrieving data from.