Introduction

The GetImage service delivers a selected image from within a layer at the desired resolution level. Users have the ability of resizing the image if needed. While this service is very similar to ExtractImages; here are some of the main differences:

GetImage is faster because it returns images that are not orthorectified, projected or rotated.
GetImage always returns the full image, even at all variable resolutions.
ExtractImages can return cropped images.

Because of these differences GetImage’s primary function is to produce thumbnail images of discrete images.

Technical Details

The GetImage service is accessed by providing imagename and layer. The image resolution can be modified by providing either zoom or width/height. Because the full image is always returned, if the width/height aspect ratio differs from the original image, white pixels will be used to fill the discrepancy. GetImage does not utilize a DTM nor require a world-to-pixel polygon to be produced and therefore the returned images are neither orthorectified, projected or rotated. Because imagename is a mandatory input parameter this service is generally secondary to another service that provides the imagename (e.g. FindImage).

Output Image Specifications:

jfif (jpeg) file format
Variable image resolution (dependent on input layer and zoom or width/height options

Base URL

This service will answer to requests on following URLs:

Ordered as http REST parameters (mandatory parameters only):
https://api.gic.org/images/GetImage/{imagename}/{layer}?token={token}
Base URL with parameters defined as a mix of REST and Key Value Pairs
- zoom
  https://api.gic.org/images/GetImage/{imagename}/{layer}/{zoom}&token={token}
- width/height
  https://api.gic.org/images/GetImage/{imagename}/{layer}?width={width}&height={height}&token={token}
Base URL with all parameters defined:
- zoom
  https://api.gic.org/images/GetImage?imagename={imagename}&layer={layer}&zoom={zoom}&token={token}
- width/height
  https://api.gic.org/images/GetImage?imagename={imagename}&layer={layer}&width={width}&height={height}&token={token}

Parameters

Parameter	Parameter Type	Data Type	Description	Example Format	Notes

Parameter	Parameter Type	Data Type	Description	Example Format	Notes
Mandatory:
`imagename`	Ordered REST (1st) - or - Key Value Pair (KVP)	string	Only the image referred to by this parameter will be returned.	Ordered REST: `/2020~us-mi-muskegon-2020~images~NW_20200821_135309_86_32A6ECB8CFDBBB8_rgb` KVP: `imagename=2020~us-mi-muskegon-2020~images~NW_20200821_135309_86_32A6ECB8CFDBBB8_rgb`	The `imagename` can be obtained through a service that provides metadata (e.g. FindImage). The corresponding metadata field is called `image_id`.
`layer`	Ordered REST (2nd) - or - Key Value Pair	string	The layer(s) with which to search for coverage. If no layer is defined, coverage from all layers will be returned. `bluesky-ultra-g` Urban data collected by Geomni in North America (7.5 GSD) `bluesky-ultra` Urban data collected with Osprey North America (7.5cm GSD) bluesky-ultra-europe Urban data collected with Osprey in Europe (7.5 GSD) `bluesky-ultra-oceania` Urban data collected with Osprey in Oceania (7.5 GSD) `bluesky-ultra-japan` Urban data collected with Osprey in Japan (7.5 GSD) `urban-r` Urban data collected with Osprey (7.5 GSD) `bluesky-high` Wide area data collected with Condor in North America (15cm GSD) `bluesky-high-europe` Wide area data collected with Condor in Europe (15cm GSD) `graysky-g` Gray Sky events collected by Geomni in North America `graysky` Gray Sky events collected with Ultracam sensors in North America	Ordered REST: `/bluesky-high` KVP: `layer=bluesky-high`	It is possible that images from different layers may have the same file name. The imagery/content will be different.
`token`	Key Value Pair	string	The token used to authenticate the requests.	`token={token}`	Use the Authenticate Service to receive a token.
Optional - Method of defining image resolution: `zoom` or `width`/`height`. Only one method can be used per call.
zoom
`zoom`	Ordered REST (3rd) - or - Key Value Pair	integer	The zoom level of the returned image. 0 = Full Resolution 1 = 1/4 Resolution 2 = 1/16 Resolution 3 = 1/64 Resolution … 12 = 1/4192546 Resolution - Maximum Zoom	Ordered REST: `/0` KVP: `zoom=0`
width/height
`width`	Key Value Pair	integer	`Width` resizes the image to a desired pixel width. If `width` is defined, `height` must also be defined.	`width=300`
`height`	Key Value Pair	integer	`Height` resizes the image to a desired pixel height. If `height` is defined, `width` must also be defined.	`height=300`

Examples

PJ Hoffmaster State Park, Michigan - Demonstrating zoom
https://api.gic.org//images/GetImage/2020~us-mi-muskegon-2020~images~E_20200821_135253_57_32A6ECB8DE90BF6_rgb/bluesky-ultra/4

Parameter	Value

Parameter	Value
`imagename`	`2020~us-mi-muskegon-2020~images~E_20200821_135253_57_32A6ECB8DE90BF6_rgb`
`layer`	`bluesky-ultra`
`zoom`	`4`
`token`	`{token}`

Success

Error

JSON Error message.

________________________________________________________________________________________

Holland, Michigan - Demonstrating width and height
https://api.gic.org//images/GetImage/2019~us-mi-holland_leica-2019~images~NS_20190505_192620_61_32AC703326C02B3_rgb/bluesky-ultra-g?width=800&height=600

Parameter	Value

Parameter	Value
`imagename`	`2019~us-mi-holland_leica-2019~images~NS_20190505_192620_61_32AC703326C02B3_rgb`
`layer`	`bluesky-ultra-g`
`width`	`800`
`height`	`600`