Get list of Dh Divisions

  • 1 minute(s) read
Prev Next
Get
/dh-division/

Operation is used to get a list of Dh Divisions.

Dh Division data can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security
API Key
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.

Minimum1
__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))+++
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 supports structured queries. Example: orderby=creator,-creation_date

Responses
200

A result response object

Expand All
object
Next
string (url)

Url to next page of the list if applicable. (Null if none)

Prev
string (url)

Url to previous page of the list if applicable. (Null if none)

Results
Array of object (DhDivision)

List of fetched Dh Divisions

object
area_id
object (DhArea)
mslink
integer

Primary key

name
string

Name

created_by
string

Creator

created_ts
string (date-time)

Date created

location
string (ewkt)

Geographical location

mslink
integer

Primary key

name
string

Name

remarks
string

Remarks

updated_by
string

Updated by

updated_ts
string (date-time)

Date updated

Total
integer

Total number of Dh Division objects in the list

401

Authentication credentials are missing or invalid

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

Detailed description of error