FindImages Service - v1.4

Owned by Scott Jonker
Mar 11, 2024
3 min read

Introduction

The FindImages Service takes a list of one or more discreteIds and returns metadata for the requested discrete images. While several services (e.g. FindImageInPoint or FindImageInPolygon) will identify discrete images and provide full metadata, this service is useful if you already have discreteIds but do not have full metadata.

Technical Details

The output metadata can be provided in three formats, xml, json or jsonp. The discreteIds parameter refers to the image_id value in the metadata.

Output Tile Specifications:

  • Metadata Formats (xml, json, jsonp)

Detailed information about the metadata can be found in Discrete Image Metadata.

Base URL

This service will answer to requests on following URLs:

  • Mandatory parameters only
    https://api.gic.org/metadata/FindImages?discreteIds={discreteIds}&token={token}

  • All parameters - Defined as Key Value Pairs
    https://api.gic.org/metadata/FindImages?discreteIds={discreteIds}&format={format}&jsonpFunction={jsonpFunction}&token={token}

Parameters

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Mandatory:

discreteIds

Key Value Pair (KVP)

string

The ID(s) for the discrete image(s) in JSON format ([], [,], [““], [“,”])

discreteIds=%5B%22W_20191106_165639_383137065AC3BF7%22,%22W_20191106_165719_383137420E9544D%22%5D

discreteIds refers to the image_id value in the metadata.

You will need to decode the symbols for this service to work:

[ = %5B

]= %5D

" = %22

token

Key Value Pair

string

The token used to authenticate the requests.

token={token}

Optional:

format

Key Value Pair

string

Format of the response.

xml - Extensible Markup Language

json - JavaScript Object Notation

jsonp - JavaScript Object Notation with Padding

format=xml

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}

Examples

Demonstrating all parameters
https://api.gic.org/metadata/FindImages?discreteIds=%5B%22W_20191106_165639_383137065AC3BF7%22,%22W_20191106_165719_383137420E9544D%22%5D&format=jsonp&token={token}

Parameter

Value

Parameter

Value

discreteIds

W_20191106_165639_383137065AC3BF7, W_20191106_165719_383137420E9544D

format

jsonp

jsonpFunction

SampleName

token

{token}

 

Metadata Results Sample:

function SampleName() {return [ { "gsd": 0.05561273091005823, "image_id": "W_20191106_165639_383137065AC3BF7", "processing_date": "2019-12-05T13:10:42", "processing_toolset_version": "3.3.0", "capture_date": "2019-11-06T16:56:39", "original_image_name": "Images/20191106151536/Cam2_back/002_0105_00001314.jpg", "original_shot_id": "002_0105_00001314", "flight_line_id": "0105", "utm_zone": "17N", "camera_pos_x": 380930.401, "camera_pos_y": 4011251.339, "camera_z": 1804.224, "ground_z": 634.860107, "omega": 0.016114, "phi": 0.794142, "kappa": 1.553532, "centre_wkt": "POINT(379752.087835334 4011270.00079464)", "centre_wkt_latlon": "POINT(-82.33820589 36.23883956)", "bbox_wkt": "POLYGON((379421.322485143 4010951.4964114,379459.93591641 4011589.18911131,379992.999829378 4011527.62666,379957.336578943 4010999.3317392,379421.322485143 4010951.4964114))", "bbox_wkt_latlon": "POLYGON((-82.34183691 36.23592762,-82.34150553 36.24168003,-82.33556501 36.24119153,-82.33588078 36.23642551,-82.34183691 36.23592762))", "orientation": "W", . . .
function SampleName() {return [ { "gsd": 0.05561273091005823, "image_id": "W_20191106_165639_383137065AC3BF7", "processing_date": "2019-12-05T13:10:42", "processing_toolset_version": "3.3.0", "capture_date": "2019-11-06T16:56:39", "original_image_name": "Images/20191106151536/Cam2_back/002_0105_00001314.jpg", "original_shot_id": "002_0105_00001314", "flight_line_id": "0105", "utm_zone": "17N", "camera_pos_x": 380930.401, "camera_pos_y": 4011251.339, "camera_z": 1804.224, "ground_z": 634.860107, "omega": 0.016114, "phi": 0.794142, "kappa": 1.553532, "centre_wkt": "POINT(379752.087835334 4011270.00079464)", "centre_wkt_latlon": "POINT(-82.33820589 36.23883956)", "bbox_wkt": "POLYGON((379421.322485143 4010951.4964114,379459.93591641 4011589.18911131,379992.999829378 4011527.62666,379957.336578943 4010999.3317392,379421.322485143 4010951.4964114))", "bbox_wkt_latlon": "POLYGON((-82.34183691 36.23592762,-82.34150553 36.24168003,-82.33556501 36.24119153,-82.33588078 36.23642551,-82.34183691 36.23592762))", "orientation": "W", "projectname": "USTNJOH1909", "copyrightsentence": "GEOMNI", "processingcenter": "", "layername": "bluesky-ultra-g", "dtmfile": "", "cameratechnology": "LEICA", "projectext": "1912339/TNJOH_B02", "raster_size_width": 10336, "raster_size_height": 7788, "pixel_size": 0.0052, "focal_length": 156, "pp0_x": 0, "pp0_y": 0, "k0": 0, "k1": 0, "k2": 0, "k3": 0, "p1": 0, "p2": 0, "b1": 0, "b2": 0, "camera_name": "01_JPEG_NONROTATED_CAM2_BACK", "id": 149472003, "max_zoom": 0, "min_zoom": 3, "tile_size_x": 256, "tile_size_y": 256, "relationPolygonInImage": 0, "relationImageInPolygon": 0 }, { "gsd": 0.05676820319869748, "image_id": "W_20191106_165719_383137420E9544D", "processing_date": "2019-12-05T13:10:19", "processing_toolset_version": "3.3.0", "capture_date": "2019-11-06T16:57:19", "original_image_name": "Images/20191106151536/Cam2_back/002_0105_00001326.jpg", "original_shot_id": "002_0105_00001326", "flight_line_id": "0105", "utm_zone": "17N", "camera_pos_x": 383602.449, "camera_pos_y": 4011218.817, "camera_z": 1804.73499, "ground_z": 610.979126, "omega": 0.015837, "phi": 0.794063, "kappa": 1.553939, "centre_wkt": "POINT(382401.898316848 4011237.50708952)", "centre_wkt_latlon": "POINT(-82.30871901 36.23887287)", "bbox_wkt": "POLYGON((381985.277519291 4010897.01611931,381983.017557534 4011590.44909093,382681.323463476 4011490.06761568,382687.915454258 4010981.68193729,381985.277519291 4010897.01611931))", "bbox_wkt_latlon": "POLYGON((-82.31330304 36.23575315,-82.31343275 36.24200293,-82.30564795 36.24118323,-82.3054984 36.23660183,-82.31330304 36.23575315))", "orientation": "W", "projectname": "USTNJOH1909", "copyrightsentence": "GEOMNI", "processingcenter": "", "layername": "bluesky-ultra-g", "dtmfile": "", "cameratechnology": "LEICA", "projectext": "1912339/TNJOH_B02", "raster_size_width": 10336, "raster_size_height": 7788, "pixel_size": 0.0052, "focal_length": 156, "pp0_x": 0, "pp0_y": 0, "k0": 0, "k1": 0, "k2": 0, "k3": 0, "p1": 0, "p2": 0, "b1": 0, "b2": 0, "camera_name": "01_JPEG_NONROTATED_CAM2_BACK", "id": 149471326, "max_zoom": 0, "min_zoom": 3, "tile_size_x": 256, "tile_size_y": 256, "relationPolygonInImage": 0, "relationImageInPolygon": 0 } ]; }

 

Discrete Images (Returned by the GetImages Service):

https://api.gic.org//images/GetImage/W_20191106_165639_383137065AC3BF7/bluesky-ultra-g?zoom=0

 

Need help? Create a support ticket | support@vexcelgroup.com