Districts

get

This method retrieves district data, including name, status of activity, and related geographical identifiers like city and township.

Authorizations
Query parameters
cityintegerOptional

Query parameter city used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

namestringOptional

Query parameter name used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

postcodestringOptional

Query parameter postcode used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

townshipintegerOptional

Query parameter township used to filter results based on specific conditions.

translationsany | nullableOptional

Query parameter translations used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/districts/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "city": 1,
      "created_date": "2025-06-27T09:42:08.484Z",
      "id": 1,
      "is_active": true,
      "modified_date": "2025-06-27T09:42:08.484Z",
      "name": "text",
      "postcode": "text",
      "township": 1,
      "translations": null
    }
  ]
}
get

This method retrieves district data, including name, status of activity, and related geographical identifiers like city and township. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this district.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/districts/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "city": 1,
  "created_date": "2025-06-27T09:42:08.484Z",
  "id": 1,
  "is_active": true,
  "modified_date": "2025-06-27T09:42:08.484Z",
  "name": "text",
  "postcode": "text",
  "township": 1,
  "translations": null
}
PreviousDeleted ItemsNextFavourite Products

Was this helpful?