Replace one geo zone.

PUT

/api/workspace/admin/geo-zone-sets/{zoneSetId}/zones/{zoneId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/admin/geo-zone-sets/example/zones/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Name\": \"example\", \"Key\": \"example\", \"Description\": \"example\", \"Enabled\": true, \"ParentGeoZoneId\": \"example\", \"Priority\": 1, \"SortOrder\": 1, \"Geometry\": { \"SourceKind\": 0, \"BoundaryProvider\": 0, \"AdministrativeBoundaryType\": 0, \"ProviderBoundaryId\": \"example\", \"ProviderPlaceId\": \"example\", \"ProviderDisplayName\": \"example\", \"ProviderRevision\": \"example\", \"ProviderMetadataJson\": \"example\", \"GeoJson\": \"example\" }, \"ChangeReason\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"ClearGeometry\": true }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/geo-zone-sets/example/zones/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Name":"example","Key":"example","Description":"example","Enabled":true,"ParentGeoZoneId":"example","Priority":1,"SortOrder":1,"Geometry":{"SourceKind":0,"BoundaryProvider":0,"AdministrativeBoundaryType":0,"ProviderBoundaryId":"example","ProviderPlaceId":"example","ProviderDisplayName":"example","ProviderRevision":"example","ProviderMetadataJson":"example","GeoJson":"example"},"ChangeReason":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ClearGeometry":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/admin/geo-zone-sets/example/zones/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Name": "example", "Key": "example", "Description": "example", "Enabled": true, "ParentGeoZoneId": "example", "Priority": 1, "SortOrder": 1, "Geometry": { "SourceKind": 0, "BoundaryProvider": 0, "AdministrativeBoundaryType": 0, "ProviderBoundaryId": "example", "ProviderPlaceId": "example", "ProviderDisplayName": "example", "ProviderRevision": "example", "ProviderMetadataJson": "example", "GeoJson": "example" }, "ChangeReason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ClearGeometry": true }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

zoneSetId

required

string

zoneId

required

string

Query Parameters

access_token

string

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

Request Body

Request payload for replacing a geo zone.

object

Name

string

nullable

Key

string

nullable

Description

string

nullable

Enabled

boolean

ParentGeoZoneId

string

nullable

Priority

integer format: int32

SortOrder

integer format: int32

Geometry

Editable geometry and source metadata 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

ChangeReason

string

nullable

RowVersion

string format: uuid

nullable

ClearGeometry

When true, remove the current editable geometry and return the zone to draft geometry status.

boolean

Responses

200

application/json

object

Data

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

object

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
    }
  ]
}

400

Bad Request

application/json

object

Data

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

object

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

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

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

object

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
    }
  ]
}

409

Conflict

application/json

object

Data

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

object

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
    }
  ]
}

Replace one geo zone.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated