ImageMetadata Service - v1.4


Introduction

This service will take an image ID and return the image’s full metadata. This service is similar to FindImages, FindImagesInPoint, and FindImagesInPolygon services but assumes you already know the image ID and need to extract metadata. FindImages will offer the added functionality of returning metadata for a list of image_ids.


Technical Details

This service will return metadata in a downloadable text file in xml, json or jsonp format.

Output Tile Specifications:

  • File formats:

    • xml

    • json

    • jsonp


Base URL

This service will answer to requests on following URL

https://api.gic.org/metadata/ImageMetadata?format={format}&discreteId={discreteId}&token={token}

or

https://api.gic.org/metadata/ImageMetadata/{format}/{discreteId}?token={token}


Parameters

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Parameter

Parameter Type

Data Type

Description

Example Format

Notes

Mandatory:

format

Ordered REST (1st) - or - Key Value Pair (KVP)

String

The format of the response file.

xml - Extensible Markup Language
json - JavaScript Object Notation
jsonp - JavaScript Object Notation with Padding

Ordered REST: /xml
KVP: format=xml

The jsonp padding can be defined with the use of the jsonpFunction parameter.

discreteId

Ordered REST (2nd) - or - Key Value Pair

String

The ID for the discrete image. Referred to as image_id in the metadata.

Ordered REST: /W_20191106_170026_3831630359E6C2A
KVP: discreteId=W_20191106_170026_3831630359E6C2A

Use a service like FindImagesInPoint or FindImagesInPolygon to identify DiscreteId.

token

Key Value Pair

String

The token used to authenticate the requests.

token={token}

Use the Authenticate Service to receive a token.

Optional:

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

Rock and Roll Hall of Fame - Cleveland, Ohio - Demonstrating mandatory parameters
https://api.gic.org/metadata/ImageMetadata/json/2020~us-oh-westlake-2020~images~2827-lvl02-oblique-left_rgb?token={token}

Table of Parameters

Parameter

Value

Parameter

Value

format

json

discreteId

2020~us-oh-westlake-2020~images~2827-lvl02-oblique-left_rgb

token

{token}

 

Discrete Image Representation from GetImage Service

https://api.gic.org/images/GetImage/2020~us-oh-westlake-2020~images~2827-lvl02-oblique-left_rgb/bluesky-ultra/0?token={token}

Metadata Output

{ "gsd": 0.06835918705367408, "image_id": "2020~us-oh-westlake-2020~images~2827-lvl02-oblique-left_rgb", "processing_date": "2021-05-05T01:51:37", "processing_toolset_version": "3.3.0", "capture_date": "2020-08-17T13:37:59", "original_image_name": "oblique/2827-lvl02-oblique-left.jpg", "original_shot_id": "2827-Lvl02-Oblique-Left", "flight_line_id": "1", "utm_zone": "17N", "camera_pos_x": 442061.1262, "camera_pos_y": 4594472.4779, "camera_z": 1325.19617, "ground_z": 181.330948, "omega": 0.784957722951479, "phi": -0.004072112635515836, "kappa": -0.010008459606064286, "centre_wkt": "POINT(442066.533630153 4595497.80593134)", "centre_wkt_latlon": "POINT(-81.69421765 41.50901623)", "bbox_wkt": "POLYGON((441755.480029396 4596075.31933151,442387.563879089 4596062.18570423,442266.875694516 4595114.86736567,441855.81292413 4595128.30173378,441755.480029396 4596075.31933151))", "bbox_wkt_latlon": "POLYGON((-81.69800062 41.5141952,-81.69042502 41.51412263,-81.6917804 41.50558165,-81.69670686 41.50567292,-81.69800062 41.5141952))", "orientation": "N", "projectname": "us-oh-westlake-2020", "copyrightsentence": "VEXCEL_IMAGING_INC", "processingcenter": "", "layername": "bluesky-ultra", "dtmfile": "", "cameratechnology": "UltraCam_Osprey_Mark_3_Premium", "projectext": "us-oh-westlake-2020", "raster_size_width": 7700, "raster_size_height": 10300, "pixel_size": 0.0052, "focal_length": 123, "pp0_x": 1.239954884136695e-15, "pp0_y": 6.75, "k0": 0, "k1": 0, "k2": 0, "k3": 0, "p1": 0, "p2": 0, "b1": 0, "b2": 0, "camera_name": "UltraCam_Osprey_Mark_3_Premium", "id": 297387554, "max_zoom": 0, "min_zoom": 3, "tile_size_x": 256, "tile_size_y": 256, "relationPolygonInImage": 0, "relationImageInPolygon": 0 }

________________________________________________________________________________________

Pro Football Hall of Fame - Canton, Ohio - Demonstrating jsonp and jsonpFunction
https://api.gic.org/metadata/ImageMetadata/jsonp/2021~us-oh-canton-2021~images~NW_20210629_141953_88_38140976641F2A6_rgb?jsonpFunction=SampleName&token={token}

Table of Parameters

Parameter

Value

Parameter

Value

format

jsonp

discreteId

2021~us-oh-canton-2021~images~NW_20210629_141953_88_38140976641F2A6_rgb

jsonpFunction

SampleName

token

{token}

 

Discrete Image Representation from GetImage Service

https://api.gic.org/images/GetImage/2021~us-oh-canton-2021~images~NW_20210629_141953_88_38140976641F2A6_rgb/bluesky-ultra/4?token={token}

Metadata Output

function SampleName() {return { "gsd": 0.0721228980666554, "image_id": "2021~us-oh-canton-2021~images~NW_20210629_141953_88_38140976641F2A6_rgb", "processing_date": "2021-08-30T14:46:43", "processing_toolset_version": "3.3.0", "capture_date": "2021-06-29T14:19:53", "original_image_name": "GeoTiff/8534-lvl02-color.tif", "original_shot_id": "8534-lvl02-color", "flight_line_id": "1", "utm_zone": "17N", "camera_pos_x": 466763.5014, "camera_pos_y": 4519426.959, "camera_z": 1864.45654296875, "ground_z": 337.6020812988281, "omega": -0.0006419332070048966, "phi": -0.001858077138837398, "kappa": 1.5596264230846404, "centre_wkt": "POINT(466766.37299518473 4519425.971986997)", "centre_wkt_latlon": "POINT(-81.39412085 40.82518511)", "bbox_wkt": "POLYGON((466255.33310002997 4518694.683109396,466270.8278180586 4520169.98734999,467277.1605855663 4520157.077301692,467264.58530936256 4518677.86931023,466255.33310002997 4518694.683109396))", "bbox_wkt_latlon": "POLYGON((-81.40014159 40.81857658,-81.40003771 40.83186719,-81.3881019 40.83179166,-81.38817334 40.818466,-81.40014159 40.81857658))", "orientation": "NW", "projectname": "us-oh-canton-2021", "copyrightsentence": "VEXCEL_IMAGING_INC", "processingcenter": "", "layername": "bluesky-ultra", "dtmfile": "", "cameratechnology": "UltraCam_Osprey_4.1_f120", "projectext": "us-oh-canton-2021", "raster_size_width": 20544, "raster_size_height": 14016, "pixel_size": 0.00376, "focal_length": 79.6, "pp0_x": 0, "pp0_y": 0, "k0": 0, "k1": 0, "k2": 0, "k3": 0, "p1": 0, "p2": 0, "b1": 0, "b2": 0, "camera_name": "UltraCam_Osprey_4.1_f120", "id": 613323497, "max_zoom": 0, "min_zoom": 7, "tile_size_x": 256, "tile_size_y": 256, "relationPolygonInImage": 0, "relationImageInPolygon": 0 }; }

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