Skip to content
MoltaroMoltaroMoltaro Docs

Return one geo zone.

GET
/api/workspace/admin/geo-zone-sets/{zoneSetId}/zones/{zoneId}
curl --request GET \
  --url https://example.com/api/workspace/admin/geo-zone-sets/example/zones/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
zoneSetId
required
string
zoneId
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Full geo zone configuration and current geometry when one has been assigned.

object
Id
string
nullable
GeoZoneSetId
string
nullable
ParentGeoZoneId
string
nullable
Name
string
nullable
Key
string
nullable
Description
string
nullable
Enabled
boolean
Priority
integer format: int32
SortOrder
integer format: int32
Geometry

Current geometry and provenance payload for a geo zone.

object
SourceKind
integer format: int32
Allowed values: 0 1 2
BoundaryProvider
integer format: int32
Allowed values: 0 1 2 3 4 99
AdministrativeBoundaryType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 99
ProviderBoundaryId
string
nullable
ProviderPlaceId
string
nullable
ProviderDisplayName
string
nullable
ProviderRevision
string
nullable
ProviderMetadataJson
string
nullable
GeoJson
string
nullable
Bounds

Bounding box for a WGS84 geometry.

object
MinLatitude
number format: double
MinLongitude
number format: double
MaxLatitude
number format: double
MaxLongitude
number format: double
Centroid

Latitude and longitude pair in WGS84 decimal degrees.

object
Latitude
number format: double
Longitude
number format: double
RevisionNumber
integer format: int32
UpdatedAt
string format: date-time
nullable
UpdatedByUserId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Geometry": {
      "SourceKind": 0,
      "BoundaryProvider": 0,
      "AdministrativeBoundaryType": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

Full geo zone configuration and current geometry when one has been assigned.

object
Id
string
nullable
GeoZoneSetId
string
nullable
ParentGeoZoneId
string
nullable
Name
string
nullable
Key
string
nullable
Description
string
nullable
Enabled
boolean
Priority
integer format: int32
SortOrder
integer format: int32
Geometry

Current geometry and provenance payload for a geo zone.

object
SourceKind
integer format: int32
Allowed values: 0 1 2
BoundaryProvider
integer format: int32
Allowed values: 0 1 2 3 4 99
AdministrativeBoundaryType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 99
ProviderBoundaryId
string
nullable
ProviderPlaceId
string
nullable
ProviderDisplayName
string
nullable
ProviderRevision
string
nullable
ProviderMetadataJson
string
nullable
GeoJson
string
nullable
Bounds

Bounding box for a WGS84 geometry.

object
MinLatitude
number format: double
MinLongitude
number format: double
MaxLatitude
number format: double
MaxLongitude
number format: double
Centroid

Latitude and longitude pair in WGS84 decimal degrees.

object
Latitude
number format: double
Longitude
number format: double
RevisionNumber
integer format: int32
UpdatedAt
string format: date-time
nullable
UpdatedByUserId
string
nullable
RowVersion
string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Geometry": {
      "SourceKind": 0,
      "BoundaryProvider": 0,
      "AdministrativeBoundaryType": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}