Location Retrieval

LocationRetrievalResponse

object
locationOne Of
required
CircleAreaobject
Show Child Parameters
assessedAtstring(date-time)required

Time when the location was assessed

Example:2026-02-05T10:30:00Z

Example

CircleArea

object
typestringrequired

Allowed values:circle

centerobjectrequired
Show Child Parameters
radiusMetersnumber(double)required

Example:500

Example

PolygonArea

object
typestringrequired

Allowed values:polygon

coordinatesarray[object]required

List of polygon vertices

>= 3 items

Show Child Parameters
Example

Error

object
statusintegerrequired

Example:400

codestringrequired

Example:INVALID_ARGUMENT

messagestringrequired

Example:Invalid request

Example