> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/omnitron-openapis/districts.md).

# Districts

## Retrieve District

> Retrieve a specific District by ID

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/{id}/":{"get":{"summary":"Retrieve District","description":"Retrieve a specific District by ID","tags":["Districts"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"District retrieved successfully","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/District"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Update District

> Update a specific District by ID

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/{id}/":{"put":{"summary":"Update District","description":"Update a specific District by ID","tags":["Districts"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/District"}}}},"responses":{"200":{"description":"District updated"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Delete District

> Delete a specific District by ID

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/{id}/":{"delete":{"summary":"Delete District","description":"Delete a specific District by ID","tags":["Districts"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"responses":{"204":{"description":"District deleted successfully"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Partial Update District

> Partial update a specific District by ID

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/{id}/":{"patch":{"summary":"Partial Update District","description":"Partial update a specific District by ID","tags":["Districts"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/District"}}}},"responses":{"200":{"description":"District updated"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Retrieve District with details

> Retrieve a specific District by ID with details

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"DistrictDetailed":{"allOf":[{"$ref":"#/components/schemas/District"}],"properties":{"city":{"$ref":"#/components/schemas/City"},"township":{"$ref":"#/components/schemas/Township"}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/{id}/detailed/":{"get":{"summary":"Retrieve District with details","description":"Retrieve a specific District by ID with details","tags":["Districts"],"parameters":[{"$ref":"#/components/parameters/id_path"}],"responses":{"200":{"description":"District retrieved successfully with details","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DistrictDetailed"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## List Districts

> List Districts

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"name__exact":{"name":"name__exact","in":"query","required":false,"description":"Filters by exact name","schema":{"type":"string"}},"mapping__integration_type":{"name":"mapping__integration_type","in":"query","description":"Filter by integration mapping object's integration type","required":false,"schema":{"type":"string","enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]}},"mapping__code__exact":{"name":"mapping__code__exact","in":"query","description":"Filter by integration mapping object's code","required":false,"schema":{"type":"string"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"postcode":{"name":"postcode","in":"query","required":false,"description":"Filter by Postcode","schema":{"type":"string"}}},"schemas":{"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/":{"get":{"summary":"List Districts","description":"List Districts","tags":["Districts"],"parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/name__exact"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/mapping__code__exact"},{"$ref":"#/components/parameters/hyper"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/postcode"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","description":"Next page URL","nullable":true},"previous":{"type":"string","description":"Previous page URL","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/District"}}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Create District

> Create District

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/":{"post":{"summary":"Create District","description":"Create District","tags":["Districts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/District"}}}},"responses":{"201":{"description":"District Created","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/District"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## List Districts with details

> List Districts with details

```json
{"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"name__exact":{"name":"name__exact","in":"query","required":false,"description":"Filters by exact name","schema":{"type":"string"}},"mapping__integration_type":{"name":"mapping__integration_type","in":"query","description":"Filter by integration mapping object's integration type","required":false,"schema":{"type":"string","enum":["hepsiburada","hepsiburadaads","n11","web","external_company","gittigidiyor","trendyol","ups","morhipo","morhipoV2","amazon","b2c_direct","allegro","akinon","ay_cargo","aliexpress","emag","yurtici","ciceksepeti","fancourier","diva","hana","gordumaldim","pazarama","flo","dpd","cdek","turkcellds","sales_channel","kolay_gelsin","sameday","sendeo","cargus","dataeva","speedy","modanisa"]}},"mapping__code__exact":{"name":"mapping__code__exact","in":"query","description":"Filter by integration mapping object's code","required":false,"schema":{"type":"string"}},"hyper":{"name":"hyper","in":"query","description":"Activate id to hyperlink the response data.","required":false,"schema":{"type":"boolean"}},"city":{"name":"city_id","in":"query","required":false,"description":"Filter by City ID","schema":{"type":"integer","minimum":1}},"township":{"name":"township_id","in":"query","required":false,"description":"Filter by Township ID","schema":{"type":"integer","minimum":1}},"postcode":{"name":"postcode","in":"query","required":false,"description":"Filter by Postcode","schema":{"type":"string"}}},"schemas":{"DistrictDetailed":{"allOf":[{"$ref":"#/components/schemas/District"}],"properties":{"city":{"$ref":"#/components/schemas/City"},"township":{"$ref":"#/components/schemas/Township"}}},"District":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","readOnly":true,"description":"Primary key of the district"},"name":{"type":"string","format":"string","description":"District Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"township":{"type":"integer","format":"int64","description":"Related Township ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"},"zipcode":{"type":"string","format":"string","description":"Zipcode"}},"required":["city","township","name"]},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"City ID"},"name":{"type":"string","format":"string","description":"City Name"},"created_date":{"type":"string","format":"date-time","description":"Creation Date","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Last Modification Date","readOnly":true},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"country":{"type":"integer","format":"int64","description":"Related Country ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"priority":{"type":"integer","format":"int64","description":"Priority"},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["country","name"]},"Township":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","description":"Primary key of the township"},"name":{"type":"string","format":"string","description":"Township Name"},"is_active":{"type":"boolean","description":"Is it active? (True/False)"},"city":{"type":"integer","format":"int64","description":"Related City ID"},"translations":{"type":"object","description":"A dynamic object holding translations for different languages","additionalProperties":{"type":"string"},"readOnly":true},"postcode":{"type":"string","format":"string","description":"Postcode"}},"required":["city","name"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/districts/detailed/":{"get":{"summary":"List Districts with details","description":"List Districts with details","tags":["Districts"],"parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/name__exact"},{"$ref":"#/components/parameters/mapping__integration_type"},{"$ref":"#/components/parameters/mapping__code__exact"},{"$ref":"#/components/parameters/hyper"},{"$ref":"#/components/parameters/city"},{"$ref":"#/components/parameters/township"},{"$ref":"#/components/parameters/postcode"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","description":"Next page URL","nullable":true},"previous":{"type":"string","description":"Previous page URL","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/DistrictDetailed"}}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/omnitron-openapis/districts.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
