Introduction

GetCoverageInfo will take an input point or polygon and return an array of image orientations grouped by date and layer for the intersecting discrete imagery. While the the metadata attributes returned by GetCoverageInfo are the same as full-service metadata services like FindImageInPoint/FindImageInPolygon, these services differ in the following ways:

FindImageInPoint/Polygon provides all metadata attributes, grouped by image_id
GetCoverageInfo provides date, layer and orientation attributes grouped by date/layer

This distinction makes GetCoverageInfo useful when a user is interested in knowing general discrete coverage information about a given location and intends on using that information to refine further queries with services such as FindImageInPoint/Polygon, etc.

Technical Details

GetCoverageInfo outputs a metadata file that contains date, layer and orientation values for each collection event that intersects the point/polygon. The output file can be delivered as a json or jsonp.

Metadata attributes:

Date
Layer
Orientations

N - Oblique North
S - Oblique South
E - Oblique East
W - Oblique West
NN - Nadir, North-up
NS - Nadir, South-up
NE - Nadir, East-up
NW - Nadir, West-up
I - Nadir, Infrared

Base URL

This service will answer to requests on following URLs:

Ordered as http REST parameters (mandatory parameters only):
https://api.gic.org/metadata/GetCoverageInfo/{wkt}?token={token}
Base URL with parameters defined as a mix of REST and Key Value Pairs
https://api.gic.org/metadata/GetCoverageInfo/{wkt}/{layers}?format={format}&epsg={epsg}&jsonpFunction={jsonpFunction}&token={token}
Base URL with all parameters defined:
https://api.gic.org/metadata/GetCoverageInfo?wkt={wkt}&layers={layers}&format={format}&epsg={epsg}&jsonpFunction={jsonpFunction}&token={token}

Parameters

Parameter	Parameter Type	Data Type	Description	Format Example	Notes

Parameter	Parameter Type	Data Type	Description	Format Example	Notes
Mandatory:
`wkt`	Ordered REST (1st) - or - Key Value Pair (KVP)	string	The well-known-text (WKT) representation of the requested point or polygon. Metadata will be returned for any image that intersects this WKT.	Ordered REST: `/POLYGON((-88.268531 30.704939, -88.264239 30.704939, -88.264239 30.700806,-88.268531 30.700806, -88.268531 30.704939))` KVP: `wkt=POLYGON((-88.268531 30.704939, -88.264239 30.704939, -88.264239 30.700806,-88.268531 30.700806, -88.268531 30.704939))`	If the polygon is too large the query will result in a `400: “Geometry is too big to compute”` error
`token`	Key Value Pair	double	The token used to authenticate the requests.	`token={token}`	Use the Authenticate Service to receive a token. A token will temporarily be stored in cache and may be omitted on subsequent calls.
Optional:
`layers`	Ordered REST (2nd) - or - Key Value Pair (KVP)	string	The layer(s) with which to search for coverage over the given wkt point or polygon. 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-europe` Urban data collected with Osprey in Europe (7.5 GSD) `bluesky-ultra-oceania` Urban data collecgted 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 Condor (7.5 GSD) `bluesky-high` Wide area data collected with Condor in North America (20cm GSD) `bluesky-high-europe` Wide area data collected with Condor in Europe (20cm GSD) `graysky-g` Gray Sky events collected by Geomni in North America `graysky` Gray Sky events collected with Ultracam sensors in North America	`layers=bluesky-high`	It is possible that images from different layers may have the same file name. The imagery/content will be different.
`format`	Key Value Pair	string	The Format of the response. `json` - default - JavaScript Object Notation `jsonp` - JavaScript Object Notation with Padding	`format=json`	The jsonp padding can be defined with the use of the jsonpFunction parameter.
`epsg`	Key Value Pair	integer	The EPSG code determines the projection of the provided wkt point or polygon.	`epsg=4326`
`jsonPFunction`	Key Value Pair	String	The customizable name of the padding function for `format=jsonp` calls. If left undefined, the default name is VexcelFunction.	`jsonpFunction={CustomName}`	This parameter is only available if format=jsonp

Examples

Suburban Mobile Alabama - Demonstrating mandatory parameters
https://api.gic.org/metadata/GetCoverageInfo?wkt=POLYGON((-88.268531 30.704939, -88.264239 30.704939, -88.264239 30.700806,-88.268531 30.700806, -88.268531 30.704939))&token={token}

Parameter	Value

Parameter	Value
`wkt`	`POLYGON((-88.268531 30.704939, -88.264239 30.704939, -88.264239 30.700806,-88.268531 30.700806, -88.268531 30.704939))`
`token`	`{token}`

Response:

[
    {
        "date": "2021-11-19T18:30:53",
        "layer": "bluesky-high",
        "orientations": [
            "I",
            "NE",
            "NW"
        ]
    },
    {
        "date": "2023-02-19T17:11:44",
        "layer": "bluesky-ultra",
        "orientations": [
            "E",
            "I",
            "N",
            "NN",
            "NS",
            "S",
            "W"
        ]
    },
    {
        "date": "2020-01-08T19:34:51",
        "layer": "bluesky-ultra-g",
        "orientations": [
            "E",
            "I",
            "N",
            "NN",
            "NS",
            "S",
            "W"
        ]
    },
    {
        "date": "2020-10-31T18:53:47",
        "layer": "graysky",
        "orientations": [
            "I",
            "NW"
        ]
    },
    {
        "date": "2019-10-28T21:02:47",
        "layer": "graysky-g",
        "orientations": [
            "E",
            "I",
            "N",
            "NN",
            "NS",
            "S",
            "W"
        ]
    }
]

________________________________________________________________________________________

Port of Pensacola, Pensacola Florida - Demonstrating wkt=point, layers, format=jsonp, jsonpFormat
https://api.gic.org/metadata/GetCoverageInfo/POINT(-87.209520 30.404678)?layers=bluesky-ultra,bluesky-high&format=jsonp&jsonpFunction=SampleName&token={token}

Parameter	Value

Parameter	Value
`wkt`	`POINT(-87.209520 30.404678)`
`layers`	`bluesky-ultra, bluesky-high`
`format`	`jsonp`
`jsonpFunction`	`SampleName`

Response:

function SampleName() {return [{"date":"2022-03-25T20:54:01","layer":"bluesky-high","orientations":["I","NN","NS"]},{"date":"2023-02-19T20:30:35","layer":"bluesky-ultra","orientations":["E","I","N","NE","NN","NS","NW","S","W"]}];}

________________________________________________________________________________________

Hard Rock Casino, Biloxi Mississippi - Demonstrating format=json, epsg
https://api.gic.org/metadata/GetCoverageInfo?wkt=POINT(-88.887932 30.392263)&format=json&epsg=4326&token={token}

Parameter	Value

Parameter	Value
`wkt`	`POINT(-88.887932 30.392263)`
`format`	`json`
`epsg`	`4326`

Response:

[
    {
        "date": "2021-11-14T17:14:06",
        "layer": "bluesky-high",
        "orientations": [
            "I",
            "NW"
        ]
    },
    {
        "date": "2022-03-23T21:26:27",
        "layer": "bluesky-ultra",
        "orientations": [
            "E",
            "I",
            "N",
            "NE",
            "NW",
            "S",
            "W"
        ]
    },
    {
        "date": "2018-10-18T16:41:21",
        "layer": "bluesky-ultra-g",
        "orientations": [
            "E",
            "NW",
            "S",
            "W"
        ]
    },
    {
        "date": "2020-10-31T19:03:08",
        "layer": "graysky",
        "orientations": [
            "E",
            "I",
            "N",
            "NE",
            "NW",
            "S",
            "W"
        ]
    }
]

Vexcel API Documentation

GetCoverageInfo Service - v1.4

Analytics

Introduction

Technical Details

Base URL

Parameters

Examples

See Also

Related content