Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Gets the volume annotation.
See: Books API Reference for books.layers.volumeAnnotations.get
.
- type LayersVolumeAnnotationsGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> ("annotations" :> (Capture "annotationId" Text :> (QueryParam "locale" Text :> (QueryParam "source" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumeannotation))))))))))
- layersVolumeAnnotationsGet :: Text -> Text -> Text -> LayersVolumeAnnotationsGet
- data LayersVolumeAnnotationsGet
- lvagLocale :: Lens' LayersVolumeAnnotationsGet (Maybe Text)
- lvagAnnotationId :: Lens' LayersVolumeAnnotationsGet Text
- lvagVolumeId :: Lens' LayersVolumeAnnotationsGet Text
- lvagSource :: Lens' LayersVolumeAnnotationsGet (Maybe Text)
- lvagLayerId :: Lens' LayersVolumeAnnotationsGet Text
REST Resource
type LayersVolumeAnnotationsGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> ("layers" :> (Capture "layerId" Text :> ("annotations" :> (Capture "annotationId" Text :> (QueryParam "locale" Text :> (QueryParam "source" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumeannotation)))))))))) Source
A resource alias for books.layers.volumeAnnotations.get
method which the
LayersVolumeAnnotationsGet
request conforms to.
Creating a Request
layersVolumeAnnotationsGet Source
Creates a value of LayersVolumeAnnotationsGet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data LayersVolumeAnnotationsGet Source
Gets the volume annotation.
See: layersVolumeAnnotationsGet
smart constructor.
Request Lenses
lvagLocale :: Lens' LayersVolumeAnnotationsGet (Maybe Text) Source
The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
lvagAnnotationId :: Lens' LayersVolumeAnnotationsGet Text Source
The ID of the volume annotation to retrieve.
lvagVolumeId :: Lens' LayersVolumeAnnotationsGet Text Source
The volume to retrieve annotations for.
lvagSource :: Lens' LayersVolumeAnnotationsGet (Maybe Text) Source
String to identify the originator of this request.
lvagLayerId :: Lens' LayersVolumeAnnotationsGet Text Source
The ID for the layer to get the annotations.