Districts

Retrieve District

get

Retrieve a specific District by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

District retrieved successfully

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/districts/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/districts/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "postcode": "34000",
  "zipcode": "34000",
  "created_date": "2026-01-19T16:16:54.120Z",
  "modified_date": "2026-01-19T16:16:54.120Z"
}

Update District

put

Update a specific District by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

Responses

200

District updated

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put

/api/v1/districts/{id}/

HTTPcURLJavaScriptPython

PUT /api/v1/districts/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "postcode": "34000",
  "zipcode": "34000",
  "modified_date": "2026-01-19T16:16:54.120Z"
}

No content

Delete District

delete

Delete a specific District by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

District deleted successfully

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete

/api/v1/districts/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/districts/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Partial Update District

patch

Partial update a specific District by ID

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

Responses

200

District updated

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

/api/v1/districts/{id}/

HTTPcURLJavaScriptPython

PATCH /api/v1/districts/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "postcode": "34000",
  "zipcode": "34000",
  "modified_date": "2026-01-19T16:16:54.120Z"
}

No content

Retrieve District with details

get

Retrieve a specific District by ID with details

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

District retrieved successfully with details

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/districts/{id}/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/districts/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "city": 1,
  "township": 1,
  "pk": 1,
  "name": "Davutpasa",
  "is_active": true,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "postcode": "34000",
  "zipcode": "34000",
  "created_date": "2026-01-19T16:16:54.120Z",
  "modified_date": "2026-01-19T16:16:54.120Z"
}

List Districts

get

List Districts

Authorizations

Token

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

name__exactstringOptional

Filters by exact name

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

city_idinteger · min: 1Optional

Filter by City ID

township_idinteger · min: 1Optional

Filter by Township ID

postcodestringOptional

Filter by Postcode

Responses

200

OK

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/districts/

HTTPcURLJavaScriptPython

GET /api/v1/districts/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-01-19T16:16:54.120Z",
      "modified_date": "2026-01-19T16:16:54.120Z"
    }
  ]
}

Create District

post

Create District

Authorizations

Token

AuthorizationstringRequired

Body

application/json

Responses

201

District Created

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/districts/

HTTPcURLJavaScriptPython

POST /api/v1/districts/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "postcode": "34000",
  "zipcode": "34000",
  "modified_date": "2026-01-19T16:16:54.120Z"
}

{
  "pk": 1,
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "postcode": "34000",
  "zipcode": "34000",
  "created_date": "2026-01-19T16:16:54.120Z",
  "modified_date": "2026-01-19T16:16:54.120Z"
}

List Districts with details

get

List Districts with details

Authorizations

Token

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

name__exactstringOptional

Filters by exact name

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

city_idinteger · min: 1Optional

Filter by City ID

township_idinteger · min: 1Optional

Filter by Township ID

postcodestringOptional

Filter by Postcode

Responses

200

OK

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/districts/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/districts/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "name": "Davutpasa",
      "is_active": true,
      "city": 1,
      "township": 1,
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "postcode": "34000",
      "zipcode": "34000",
      "created_date": "2026-01-19T16:16:54.120Z",
      "modified_date": "2026-01-19T16:16:54.120Z"
    }
  ]
}