Skip to main content
POST
Create Zone Set

Authorizations

Authorization
string
header
required

Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.

Path Parameters

pingid
string
required

Body

zone_scheme
string
required

Name of the zone scheme the zone set uses, e.g. 'zone_scheme:zurich:v1'; one of the policy terms config's available_zone_schemes.

name
string

Defaults to the zone scheme's label. A number is added if the submission already has the name, unless that zone set's zoning failed: then it's taken over.

Maximum string length: 100

Response

created_time
string<date-time>
required
read-only
modified_time
string<date-time> | null
required
read-only
name
string
required
Maximum string length: 100
status
enum<string>
required
read-only

Whether the zone set's zones have been assigned to the submission's locations: P (pending), I (in progress), C (completed; refresh the locations to see them) or F (failed, see status_message).

  • P - Pending
  • I - In Progress
  • C - Completed
  • F - Failed
Available options:
P,
I,
C,
F
uuid
string<uuid> | null
required
read-only

UUID of the zone set

zone_scheme
string
required

Name of the zone scheme the zone set uses, e.g. 'zone_scheme:zurich:v1'.

Maximum string length: 100
location_count
integer | null

How many locations were zoned.

Required range: -2147483648 <= x <= 2147483647
status_message
string | null

Why zoning the locations failed.