Get list of Subregions

2 minute(s) read

Prev Next

Get

/subregions/

Operation is used to get a list of subregions.

Subregion list can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security

API Key: Token

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

offset

integer

Offset to start returning results.

Minimum0

limit

integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Minimum1

srs

string

Coordinate system used to transform location fields in API responses. This parameter does not apply to locations sent in request query parameters or request bodies.

For locations in requests, use EWKT with SRID. If EWKT is provided without SRID, the system default SRID will be used.

Example: srs=epsg:4326

__any of the object fields__

string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
For numerics: gt, lt, gte, lte, isnull
For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

orderby

string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not support structured queries. Example: orderby=creator,-creation_date

Responses

200

A result response object.

{
  "Next": null,
  "Previous": null,
  "Results": [
    {
      "id": 21,
      "identifier": "Default",
      "name": "Default"
    }
  ],
  "Total": 1
}

Expand All

object

string (url)

Url to next page of Subregion list. Null if No next page exist

string (url)

Url to previous page of Subregion list. Null if No previous page exist

Results

Array of object (Subregion)

List of fetched Tasks

object

Information about Subregion

integer

Subregion primary key

identifier

string

System generated identifier for subregion.

list_url

string (url)

Url to fetch all subregions

name

string

Name of subregion

network_type

object (SAttribute)

SAttribute

description

string

Attribute description

groupname

string

Group name of constant

integer

Unique id of constant

list_url

string (url)

Url to fetch SAttributes by groupname

name

string

Attribute name

numValue

number (float)

Numeric value

orderno

integer

Order number

txtValue

string

Human readable textual representation

Total

integer

Total number of Subregions

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

Standard error response payload

details

string

Detailed description of error

Documentation Index

Get list of Subregions