Districts

Retrieve District

get

Retrieve a specific District by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

District retrieved successfully

application/json
get
/api/v1/districts/{id}/

Update District

put

Update a specific District by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
Responses
chevron-right
200

District updated

No content

put
/api/v1/districts/{id}/

No content

Delete District

delete

Delete a specific District by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
delete
/api/v1/districts/{id}/

No content

Partial Update District

patch

Partial update a specific District by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
Responses
chevron-right
200

District updated

No content

patch
/api/v1/districts/{id}/

No content

Retrieve District with details

get

Retrieve a specific District by ID with details

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

District retrieved successfully with details

application/json
get
/api/v1/districts/{id}/detailed/

List Districts

get

List Districts

Authorizations
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
chevron-right
200

OK

application/json
get
/api/v1/districts/

Create District

post

Create District

Authorizations
AuthorizationstringRequired
Body
Responses
post
/api/v1/districts/

List Districts with details

get

List Districts with details

Authorizations
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
chevron-right
200

OK

application/json
get
/api/v1/districts/detailed/

Last updated

Was this helpful?