1 Introduction
2 Technical Details
- 2.1 Data Dictionary
3 GetPropertyInformation
- 3.1 Base URL
- 3.2 Parameters
4 GetStatus
- 4.1 Base URL
- 4.2 Parameters
5 Download
- 5.1 Base URL
- 5.2 Parameters
6 Examples
7 See Also
8 External Resources

Introduction

The GetPropertyInformation service will take a lat/lon coordinate and return a metadata response (JSON or xml) for a single parcel with associated property attributes including building structures and their respective attributes and footprint geometry.

Assess insurable property features and condition
Display building footprints
Property feature change detection

This is a transactional service; each requests will be billed against the agreed upon rate and aggregated into a billing cycle. Please contact Customer Advocacy at support@vexcelgroup.com.

Technical Details

The Property Information service provides access to computer-generated property information on a parcel basis. Some attributes are parcel-specific while most are building-specific. All numeric units are metric as either meters or square meters (Imperial is now available as an option with unit-system). Property information can be generated against bluesky-ultra or bluesky-high, it is being precomputed in select locations (see table below) and is available on-demand worldwide. On-Demand requests for structure attributes are available worldwide wherever imagery exists. On-Demand requests for property attributes are limited by parcel availability. We will be continually indexing property information and parcel data to expand our coverage.

Property Information precomputed shortly after imagery is published. For bluesky-ultra and bluesky-ultra-r all AOIs are precomputed. bluesky-high is precomputed only in locations in which there is no bluesky-ultra or bluesky-ultra-r coverage within the previous 12 months.

When a request is made to GetPropertyInformation, the response will vary depending on if the property has been precomputed or not:

Precomputed - The property attributes are cached in a database; the property information will return in the REST body with little delay.
On-Demand - The property information is not cached in a database but can be calculated on-demand (with the permit-on-demand parameter). The REST body will return a request_id and indicate that the property is not immediately available, and a user will have two options to receive the property information: Callback URL or Download Service. Additionally, the GetStatus service can be used to query the status of an On-Demand request.
1. Callback URL - If a callback url was provided, Vexcel will send the property information to the callback url as soon as it is computed. This will require a user to have a callback server with which to listen for callback responses. See the External Resources section for more information.
2. Download Service - This is a multi-service process in which a user will use the provided request_id to download the property information via the Download service.

Location	Precomputed using:		*On-Demand containing:**
Location	bluesky-ultra	bluesky-high	Structure Attributes	Property Attributes
United States
Canada
Puerto Rico
Australia France (including Corsica) New Zealand Spain England, Scotland, Wales
Germany				North Rhine Westphalia Other Regions TBD
Italy				Some Regions Available
Rest of World				(more countries will be added)

Last updated: May 2023

*where imagery coverage exists

Data Dictionary

The following list contains the available objects available from this service.

There may be slight variations in object names.
New objects are occasionally added. Previously precomputed properties may not contain new objects.
Properties that are not pre-computed will return back null in the property features response

Object							Description	Unit or Possible Values

Object							Description	Unit or Possible Values
structures	{ Each building in a separate object	footprint	area				Area of the building footprint	Meters
		footprint	wkt				Geometry of the building footprint (WKT Polygon)
		ground_elevation	value				Ground elevation, derived from DTM, measured at the center of a bounding box surrounding the structure geometry.	Meters
		metadata	camera_technology				Type of camera used for imagery collection
			gsd				Ground sample distance (average pixel size)	Meters
			image_id				The name of the source image
			version				Version of the Auto GPE pipeline used to produce this property information.
			layer_name				Layer name of the source imagery
		primaryStructure					Identifies if the building is the primary structure on the property	true, false
		roof_condition	value				Condition of the roof. 5 - Roof is in great condition - No visible signs of defects. It looks new 4 - Roof is in good condition - Minimal signs of defects. Defects are cosmetic and do not affect the function and safety of the roof. 3 - Roof is in fair condition - Discoloration and damage are present but not as pronounced as scores 1 and 2. Defects may affect the function and safety of the roof if not addressed. 2 - Roof is in poor condition - Pronounced signs of defects that affect the function and safety of the roof. the damage is primarily at the barrier or surface materials. 1 - Roof is in bad condition - Pronounced signs of defects that significantly affect the function and safety of the roof. The damage is beyond the barrier or surface materials.	1 to 5
		roof_condition_report	discolorated	detected			Whether the network detected any discoloration	true, false
				percentage			Percentage of detected discoloration that covers the roof	Percentage (0 - 100)
				score			A confidence score for the detection	0 to 1
				types	algae_staining	detected	Whether algae staining was detected	true, false
						percentage	Percentage of the full roof that has detected algae staining	Percentage (0 - 100)
						score	A confidence score for the detection	0 to 1
					vent_staining	detected	Whether vent staining was detected	true, false
						percentage	Percentage of the full roof that has detected vent staining	Percentage (0 - 100)
						score	A confidence score for the detection	0 to 1
					water_pooling	detected	Whether water pooling was detected	true, false
						percentage	Percentage of the full roof that has detected water pooling	Percentage (0 - 100)
						score	A confidence score for the detection	0 to 1
			Debris	detected			Whether debris was detected	true, false
				percentage			Percentage of the full roof that was covered by debris	Percentage (0 - 100)
				score			A confidence score for the detection	0 to 1
			Missing Material	detected			Whether missing material was detected	true, false
				percentage			Percentage of the full roof that has detected missing material	Percentage (0 - 100)
				score			A confidence score for the detection	0 to 1
			Tarp	detected			Whether a tarp was detected	true, false
				percentage			Percentage of the full roof that is covered by tarp	Percentage (0 - 100)
				score			A confidence score for the detection	0 to 1
		roof_material	class				Predominant material used for the roof	shingle, tile, metal, shake, gravel, membrane
		roof_material	score				A confidence score for the detection	0 to 1
		roof_shape	value				Predominant architectural style used for the roof. hip = all sides slope down, gable = two opposing sides slope down, flat = less than 2/12 slope	hip, gable, flat
		roof_shape	score				A confidence score for the detection	0 to 1
		roof_solar	value				Indicates whether the roof contains one or more solar panels	Solar panel, No solar panel
		roof_solar	score				A confidence score for the detection	0 to 1
		roof_elements	ac_unit	count			A count of air conditioning units found on the roof
			chimney	count			A count of chimneys found on the roof
			roof_vent	count			A count of roof vents found on the roof
			satellite_dish	count			a count of satellite dishes found on the roof
			skylight	count			A count of skylights found on the roof
		tree_cover	percent				Percentage of structure covered by trees	Percentage (0 - 100)
		roof_top_location	wkt				Centroid of the building footprint (WKT Point)
		defensible_space	image	image_id			Name of the image
			image	region_contained			Indicates whether the image contains the full 100 ft buffer surrounding the building. If false, values are reported for areas with imagery coverage.	true, false
			report *DSx formulas below	DSB5			A percentage representing how much of the region within 5 ft around a structure contains other structures.	Percentage (0 - 100+)
				DST5			A percentage representing how much of the region within 5 ft around and over a structure contain trees.	Percentage (0 - 100+)
				DSB30			A percentage representing how much of the region within 30 ft around a structure contains other structures.	Percentage (0 - 100+)
				DST30			A percentage representing how much of the region within 30 ft around and over a structure contain trees.	Percentage (0 - 100+)
				DSB100			A percentage representing how much of the region within 100 ft around a structure contains other structures.	Percentage (0 - 100+)
				DST100			A percentage representing how much of the region within 100 ft around and over a structure contain trees.	Percentage (0 - 100+)
				DSB200			A percentage representing how much of the region within 200 ft around a structure contains other structures.	Percentage (0 - 100+)
				DST200			A percentage representing how much of the region within 200 ft around and over a structure contain trees.	Percentage (0 - 100+)
			status				Whether the report generation was successful or not	SUCCESS, FAIL
			status_msg				Description of the failure if status:fail
		roof_elevation	value				Elevation of the roof_top_location above sea level derived from DSM	Meters
		roof_height	value				Height of the roof_top_location above ground. Measured by subtracting DTM from DSM at roof_top_location	Meters
capture_date							Capture date of the source image.	YYYY-MM-DD
ortho_date_estimate							The estimated date of the pixels comprising the source ortho image.	MMM DD, YYY
property_features	parcel_wkt						Geometry of the parcel boundary (WKT Polygon). ⓘ Sourced from a 3rd party, accuracy may vary.
	sport_court Basketball, tennis, etc.	detected					Whether the network detected sport_court(s) on the property	true, false
	sport_court Basketball, tennis, etc.	score					A confidence score for the detection	0 to 1
	playground Swingset, jungle gym etc.	detected					Whether the network detected playground(s) on the property	true, false
	playground Swingset, jungle gym etc.	score					A confidence score for the detection	0 to 1
	deck Elevated, outdoor floor/platform	detected					Whether the network detected deck(s) on the property	true, false
		score					A confidence score for the detection	0 to 1
		area April 2023					The total surface area of the detected deck(s) areas within a parcel	sqft
	hardscapes paved surfaces	area					The total surface area of the detected hardscape areas within a parcel	sqft
	hardscapes paved surfaces	percent					The percentage of the total parcel area that has been detected as hardscape.	Percentage (0 - 100)
	trampoline Trampoline	detected					Whether the network detected trampoline(s) on the property	true, false
	trampoline Trampoline	score					A confidence score for the detection	0 to 1
	enclosure Screen-made structure, like a pool enclosure	detected					Whether the network detected enclosure(s) on the property	true, false
	enclosure Screen-made structure, like a pool enclosure	score					A confidence score for the detection	0 to 1
	pool Swimming pool, above or below ground	detected					Whether the network detected pool(s) on the property	true, false
		score					A confidence score for the detection	0 to 1
		types	above_ground	area			The surface area of the above ground pool	sqft
				detected			Whether the network detected an above ground pool	true, false
				distance			The shortest distance from the edge of the above ground pool to the primary structure	ft
				score			A confidence score for the detection	0 to 1
			hot_tub	area			The surface area of the above hot tub	sqft
				detected			Whether the network detected a hot tub	true, false
				distance			The shortest distance from the edge of the above hot tub to the primary structure	ft
				score			A confidence score for the detection	0 to 1
			in_ground	area			The surface area of the in-ground pool	sqft
				detected			Whether the network detected an in-ground pool	true, false
				distance			The shortest distance from the edge of the in-ground pool to the primary structure	ft
				score			A confidence score for the detection	0 to 1
	water_slide Slide associated with a pool	detected					Whether the network detected waterslide(s) on the property	true, false
	water_slide Slide associated with a pool	score					A confidence score for the detection	0 to 1
	diving_board Diving board associated with a pool	detected					Whether the network detected diving board(s) on the property	true, false
	diving_board Diving board associated with a pool	score					A confidence score for the detection	0 to 1
	vehicle Vehicles found on the property	count					A count of vehicles found on the property
		detected					Whether the network detected a vehicle on the property	true, false
		score					A confidence score for the detection	0 to 1
		types	automobile	detected			Whether the network detected an automobile on the property	true, false
				count			A count of automobiles found on the property
				score			A confidence score for the detection	0 to 1
			boat	detected			Whether the network detected a boat on the property	true, false
				count			A count of boats found on the property
				score			A confidence score for the detection	0 to 1
	parcel_tree_cover						Percentage of parcel covered by trees.	Percentage (0 - 100)
inside_parcel							Whether the requested_wkt falls within the parcel_wkt	true, false
requested_wkt							Geographic point used to query for a property (WKT Point)

*Defensible Space Percentage Formulas:

Use the diagram to the right and the formulas below to understand the percentage calculations of each DSx value:

DSB5 = [Area of buildings in zones A, B] / [Area of zone B]

DST5 = [Area of trees in zones A, B] / [Area of zone B]

DSB30 = [Area of buildings in zones A, B, C] / [Area of zone B, C]

DST30 = [Area of trees in zones A, B, C] / [Area of zone B, C]

DSB100 = [Area of buildings in zones A, B, C, D] / [Area of zone B, C, D]

DST100 = [Area of trees in zones A, B, C, D] / [Area of zone B, C, D]

DSB200 = [Area of buildings in zones A, B, C, D, E] / [Area of zone B, C, D, E]

DST200 = [Area of trees in zones A, B, C, D, E] / [Area of zone B, C, D, E]

GetPropertyInformation

This service is used to request property information for a parcel and/or structure. All requests must begin with this service. If the requested property has been pre-computed, the results will be returned via the response body. If the property must be computed on-demand the results will be returned via either the user-defined callbackURL or the Download service.

Base URL

This service will answer requests on the following URL (mandatory parameters only):

https://api.gic.org/property/GetPropertyInformation?wkt={wkt}&token={token}

Parameters

Parameter	Parameter Type	Data Type	Description	Example Format	Notes

Parameter	Parameter Type	Data Type	Description	Example Format
Mandatory:
`wkt`	Key Value Pair (KVP)	String	The “well-known-text” (WKT) representation of the requested point or polygon.	`wkt=POINT(-82.71344369293386 27.85861704973314)` `wkt=POLYGON((-87.02784238738897 33.229561586085204,-87.02378688735845 33.229561586085204,-87.02378688735845 33.22722819148422,-87.02784238738897 33.22722819148422,-87.02784238738897 33.229561586085204))`
`token`	Key Value Pair (KVP)	String	The token used to authenticate the request.	`token={token}`
Optional:
`callbackUrl`	Key Value Pair (KVP)	String	The client provided URL with which a response will be sent in the instance where the property information has not been precomputed. After property information computation the response will be sent to the callback URL.	`callbackUrl=https://example.com/callback`
`externalRequestId`	Key Value Pair (KVP)	String	A client provided ID to be used exclusively by the client for the client’s internal indexing and data management purposes. This ID will not be used by Vexcel.
`property-features`	Key Value Pair (KVP)	String	Allows a user to select which feature of a property record to return. Other information within the parcel will be omitted from the response. Multiple options must be separated by comma. undefined - default - returns all available objects of a property record. `structure-geometry` - returns only the structure geometry object (building footprint wkt) `structure-attributes` - returns only the objects within the structures object, excluding the structure geometry. `parcel-attributes` - returns only the objects within the properties object.	`property-features=parcel-attributes`
`format`	Key Value Pair (KVP)	String	The format of the response `json` - default - JavaScript Object Notation `xml` - Extensible Markup Language	`format=json`
`calculateHeights`	Key Value Pair (KVP)	String	Returns the `roof_height` (above ground) and `roof_elevation` (above sea level) for each structure. Both values are measured in meters. true - include `roof_height` and `roof_elevation` in the response false - will not include `roof_height` and `roof_elevation`	`calculateHeights=true`
`layer`	Key Value Pair (KVP)	String	The imagery layer from which to derive the property information and building footprints. `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-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	`layer=bluesky-high`
`aoi`	Key Value Pair (KVP)	String	The identifier of the Area of Interest (AOI) which contains the imagery from which to derive the property information and building footprints.	`aoi=us-ca-losangeles-2021`
`orientationsource`	Key Value Pair (KVP)	String	The imagery type from which to derive property information.	`orientationsource=ortho`
`usecache`	Key Value Pair (KVP)	Boolean	Determines if the request may come from cache or if an on-demand computation is required.	`usecache=true`
`unit-system`	Key Value Pair (KVP)	String	Determines the unitary system in which values are returned.	`unit-system=imperial`
`suppliedparcel`	Key Value Pair (KVP)	String	Enables the end user to provide a geometry (in wkt `POLYGON()` format) from which parcel attributes will be calculated. This is useful for locations where Vexcel does not have access to parcel data or where the end-user would prefer to use a specific geometry for the parcel attribute calculations.	`suppliedparcel=POLYGON((-105.151810 39.968170,-105.151381 39.968170,-105.151381 39.967964,-105.151810 39.967964,-105.151810 39.968170))`
`permit-on-demand`	Key Value Pair (KVP)	Boolean	Determines if a request my trigger an on-demand computation if it cannot fulfilled by our database.	`permit-on-demand=false`
Optional (Only available for precomputed properties):
`search_radius`	Key Value Pair (KVP)	String	The radius in meters with which to search for the nearest intersecting property.	`search_radius=15`
`requiredAttributes`	Key Value Pair (KVP)	String	Defining `requiredAttributes` will force GetPropertyInformation to search for the nearest property containing attributes matching this list. Using this parameter requires that `search_radius` also be defined. All keywords must be separated by with a comma.	`requiredAttributes=deck,roof_material=membrane` `requiredAttributes=pool,pool_score>0.8`
`maxrecords`	Key Value Pair (KVP)	Integer	The maximum number of records that will be returned. By default only one record will be returned. If defined the service will attempt to return properties up to the maximum number. If this parameter is present, properties will be returned within an array.	`maxrecords=3`

GetStatus

This service is used to check on the computation status of a previous on-demand GetPropertyInformation call. This service can be called repeatedly until a status is provided. When the status is “Complete” the property information will be returned via either the user-defined callbackURL or the Download service.

Base URL

This service will answer requests on the following URL:

https://api.gic.org/property/GetStatus?requestId={requestId}&token={token}

Parameters

Parameter	Parameter Type	Data Type	Description	Example Format	Notes

Parameter	Parameter Type	Data Type	Description	Example Format
Mandatory:
`requestId`	Key Value Pair	String	A unique identifier for a GetPropertyInformation call. Found in the GetPropertyInformation response BODY	`requestId=2173f474-ece3-4c81-a934-38b130171c7c`
`token`	Key Value Pair (KVP)	String	The token used to authenticate the request.	`token={token}`

Download

This service is used to receive the results of an on-demand GetPropertyInformation call. The response will be stored temporarily (roughly a week) and should not be relied upon for long-term access.

Base URL

This service will answer to the requests on the following URL:
https://api.gic.org/property/Download?requestId={requestId}&token={token}

Parameters

Parameter	Parameter Type	Data Type	Description	Example Format	Notes

Parameter	Parameter Type	Data Type	Description	Example Format
Mandatory:
`requestId`	Key Value Pair	String	A unique identifier for a GetPropertyInformation call. Found in the GetPropertyInformation response BODY	`requestId=2173f474-ece3-4c81-a934-38b130171c7c`
`token`	Key Value Pair (KVP)	String	The token used to authenticate the request.	`token={token}`

Examples

Neighborhood in Knoxville, Tennessee - cached property information request property-features=structure-geometry, format=xml,

URL:
https://api.gic.org/property/GetPropertyInformation?wkt=POINT(-83.88721614672113 35.9600755614104)&format=xml&property-features=structure-geometry&token={token}

Response:

<ortho_date_estimate>May 20, 2022 12:00:00 AM</ortho_date_estimate><inside_parcel>true</inside_parcel><structures><primaryStructure>true</primaryStructure><footPrint><area>540.2845307967305</area><wkt>POLYGON((-83.88743063829281 35.960249534937944,-83.88727882413394 35.960257284258894,-83.88727218410212 35.960162330239,-83.88723348088834 35.96016411912269,-83.88723507693358 35.96018694313603,-83.88717868097031 35.96018954976654,-83.8871782021356 35.96018270219292,-83.88715011285561 35.96018396531366,-83.88714753459975 35.960147094759705,-83.88713903725147 35.96013884119355,-83.88714187657392 35.96012792464477,-83.88712766984106 35.96012858127368,-83.88712691281476 35.960114487869646,-83.88711973413105 35.96011474274069,-83.8871167794248 35.960072488417175,-83.88712563081754 35.960072079310734,-83.88712229350007 35.960024353378806,-83.88717412398127 35.96002155651298,-83.88717234685178 35.959996142542344,-83.88729393482208 35.959989581435245,-83.88730139423113 35.96007740464342,-83.88728465021744 35.96007817856652,-83.88728535440815 35.96008824867469,-83.8874255723061 35.96008176760627,-83.88743612001129 35.96023259823232,-83.88742947537104 35.96023290536122,-83.88743063829281 35.960249534937944))</wkt></footPrint></structures><requested_wkt>POINT(-83.88721614672113 35.9600755614104)</requested_wkt><request_id>null</request_id>

Geometric representation of the footprint wkt:

________________________________________________________________________________________

Neighborhood in Dijon, France, Europe - on-demand request, single structure, callback URL method, callbackUrl, externalRequestId, property-features=structure-attributes

GetPropertyInformation Call:
1. URL: https://api.gic.org/property/GetPropertyInformation?wkt=POINT(5.057357 47.323763)&callbackUrl=&http://fakecallback1234.com&externalRequestId=SampleID1234&property-features=structure-attributes&format=json&token={token}
2. Response: HTTP 200: {"status":200,"message":"The job was launched. Please, wait for the asynchronous response.","requestId":"74d0ce5a-738f-43e1-8669-9edcb854f21d"}
GetStatus Call (Optional):
1. URL: https://api.gic.org/property/GetStatus?requestId=74d0ce5a-738f-43e1-8669-9edcb854f21d
2. Responses:
  1. Computation Incomplete: HTTP 200: {status: "InProgress"}
  2. Computation Complete: HTTP 200: {"status":"Completed"}
  3. Computation Failed: HTTP 200 {"status": "Failed"}
Receive response at callback URL:
1. As soon as computation is complete the results will be sent to the callbackUrl in the form of an HTML file containing the output file in the desired format:

GET /property/GetPropertyInformation?wkt=POINT(-113.462401 53.515842)&format=json&property-features=structure-attributes&callbackUrl=http%3A%2F%2Ffakecallback1234.com&externalRequestId=SampleID1234 HTTP/1.1
Host: api.gic.org

HTTP/1.1 200
content-type:	application/json;charset=ISO-8859-1
content-length:	1656
access-control-allow-credentials:	true
access-control-allow-headers:	DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization
access-control-allow-methods:	GET, PUT, POST, DELETE, PATCH, OPTIONS
access-control-allow-origin:	*
access-control-max-age:	1728000
date:	Mon, 23 Oct 2023 17:33:09 GMT
x-cache:	Miss from cloudfront
via:	1.1 9dcf1f784090d97aac2d38aa49e628e2.cloudfront.net (CloudFront)
x-amz-cf-pop:	EWR53-C3
x-amz-cf-id:	WRzoxcpyEw10RE0J3i9WB94qmancG1EIHcBwuQEKb46mlsnxYNzNeQ==
{"structures":[{"roof_condition_report":{"Missing Material":{"detected":null,"percentage":null,"score":null},"Tarp":{"detected":null,"percentage":null,"score":null},"debris":{"detected":false,"percentage":0.0,"score":0.0},"discolorated":{"types":{"algae_staining":{"detected":true,"percentage":0.02,"score":0.37},"vent_staining":{"detected":false,"percentage":0.0,"score":0.0},"water_pooling":{"detected":false,"percentage":0.0,"score":0.0}},"detected":true,"percentage":0.02,"score":0.37}},"roof_condition":{"value":3.0,"precise_value":3.38},"roof_elements":{"ac_unit":{"count":0.0},"chimney":{"count":3.0},"roof_vent":{"count":2.0},"satellite_dish":{"count":0.0},"skylight":{"count":4.0}},"ground_elevation":{"value":248.1072},"metadata":{"camera_technology":"UltraCam_Osprey_4.1_f120","gsd":0.07264414528829058,"image_id":null,"version":"3.73.1","layer_name":"bluesky-ultra-europe","is_ortho_image":true,"aoi":null},"primaryStructure":true,"roof_material":{"score":0.9,"class":"metal"},"roof_shape":{"value":"gable","score":0.0},"roof_solar":{"value":"false","score":0.0},"tree_cover":{"percent":0.0},"roof_top_location":{"wkt":"POINT (5.0573742266058916 47.3237529793339462)"},"defensible_space":{"image":{"image_id":"Ortho_fr-bfc-dijon-2023_539015_367421_7_7_20_bluesky-ultra-europe","regionContained":false},"report":{"DSB5":null,"DSB30":27.0,"DSB100":27.0,"DSB200":null,"DST5":null,"DST30":12.0,"DST100":20.0,"DST200":null},"status":"SUCCESS"}}],"ortho_date_estimate":"May 31, 2023 12:00:00 AM","inside_parcel":true,"requested_wkt":"POINT(5.057357 47.323763)","request_id":"74d0ce5a-738f-43e1-8669-9edcb854f21d","external_request_id":"SampleID1234"}

Neighborhood in San Diego - asynchronous request, two buildings, format=json, Download service method (no callbackUrl)

First GetPropertyInformation Call:
1. URL: https://api.gic.org/property/GetPropertyInformation?wkt=POINT(-117.14516226412331 32.99079940586982)&format=json
2. Response: HTTP 200: {"status":0,"message":"The job was launched. Please, wait for the asynchronous response.","requestId":"2173f474-ece3-4c81-a934-38b130171c7c"}
GetStatus Query
1. URL: https://api.gic.org/property/GetStatus?requestId=2173f474-ece3-4c81-a934-38b130171c7c
2. Responses:
  1. Computation Incomplete: HTTP 200: {status: "InProgress"}
  2. Computation Complete: HTTP 200: {"status":"Completed"}
  3. Computation Failed: HTTP 200 {"status":"Failed"}
Download Call:
1. URL: https://api.gic.org/property/Download?requestId=2173f474-ece3-4c81-a934-38b130171c7c
2. Response: Sample Metadata file:

{
  "structures": [
    {
      "footPrint": {
        "area": 13361,
        "wkt": "POLYGON ((-117.1455547984834595 32.9908428350415406, -117.1455525384822494 32.9908829541825170, -117.1455385967880147 32.9908887357295910, -117.1455056971612834 32.9909508299514727, -117.1454818489732759 32.9909763919832102, -117.1454890242768556 32.9909811462173650, -117.1454523030882058 32.9910243965658054, -117.1454377214079017 32.9910357941814283, -117.1454186058909954 32.9910416407254772, -117.1453268645572052 32.9910371789585142, -117.1453056088109150 32.9910474139053278, -117.1452810996457998 32.9910826133111215, -117.1452686571265502 32.9910896228359789, -117.1452398004295787 32.9910881141046275, -117.1451707632001984 32.9910645556127236, -117.1451124041277865 32.9910617172579492, -117.1450889840947127 32.9910457580404852, -117.1450729003878024 32.9910141807791177, -117.1450534981738372 32.9909957715438935, -117.1450322864704106 32.9909947398727610, -117.1449953291024713 32.9909752708996535, -117.1449898024073093 32.9909554007394732, -117.1449688943376373 32.9909226184908988, -117.1449711320288998 32.9908899439436354, -117.1449937511715405 32.9908444411844215, -117.1450005267916197 32.9908420580681678, -117.1450338272025675 32.9908436777062164, -117.1450493033897260 32.9908506022571260, -117.1450881421782100 32.9908785582676813, -117.1450825890433407 32.9908840373776329, -117.1451109981085352 32.9909059513927545, -117.1451318114583700 32.9909069636771477, -117.1451622379287159 32.9908882464166453, -117.1451557676637805 32.9908807765603456, -117.1452000174199952 32.9908456069801872, -117.1452172134619758 32.9908148619258341, -117.1452787077841009 32.9907810725064792, -117.1453193976594065 32.9907413123584732, -117.1453482530329353 32.9907428218191754, -117.1454263371524860 32.9907692627572544, -117.1454479899180541 32.9907814538613380, -117.1455005396592526 32.9908269046143516, -117.1455421378213231 32.9908422193166970, -117.1455547984834595 32.9908428350415406))"
      },
      "ground_elevation": {
        "value": 584
      },
      "metadata": {
        "camera_technology": "UltraCam_Osprey_4.1_f120",
        "gsd": 2.74,
.
.
.

External Resources

Callback - Callback (computer programming)

Vexcel API Documentation

GetPropertyInformation - v1.4

Introduction

Technical Details

Data Dictionary

GetPropertyInformation

Base URL

Parameters

GetStatus

Base URL

Parameters

Download

Base URL

Parameters

Examples

See Also

External Resources