Cities

Retrieve City

get

Retrieve a specific City by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

City retrieved successfully

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

Update City

put

Update a specific City by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
idintegerRead-onlyOptional

City ID

namestring · stringRequired

City Name

Example: Istanbul
created_datestring · date-timeRead-onlyOptional

Creation Date

modified_datestring · date-timeRead-onlyOptional

Last Modification Date

is_activebooleanOptional

Is it active? (True/False)

Example: true
countryinteger · int64Required

Related Country ID

priorityinteger · int64Optional

Priority

Example: 1
postcodestring · stringOptional

Postcode

Example: 34000
Responses
chevron-right
200

City updated

No content

put
/api/v1/cities/{id}/

No content

Delete City

delete

Delete a specific City by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

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

No content

Partial Update City

patch

Partial update a specific City by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
idintegerRead-onlyOptional

City ID

namestring · stringRequired

City Name

Example: Istanbul
created_datestring · date-timeRead-onlyOptional

Creation Date

modified_datestring · date-timeRead-onlyOptional

Last Modification Date

is_activebooleanOptional

Is it active? (True/False)

Example: true
countryinteger · int64Required

Related Country ID

priorityinteger · int64Optional

Priority

Example: 1
postcodestring · stringOptional

Postcode

Example: 34000
Responses
chevron-right
200

City updated

No content

patch
/api/v1/cities/{id}/

No content

Retrieve City with details

get

Retrieve a specific City by ID with details

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

City retrieved successfully with details

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

List Cities

get

List Cities

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.

priorityintegerOptional

Filter by priority

Example: 1
country_idinteger · min: 1Optional

Filter by County ID

country__name__exactstringOptional

Filter by Country Name

country__code__exactstringOptional

Filter by Country Code

country__mapping__code__exactstringOptional

Filter by country's integration mapping object's code

country__mapping__integration_typeall ofOptional

Filter by country's integration mapping object's integration type

string · enumOptionalPossible values:
postcodestringOptional

Filter by Postcode

Responses
chevron-right
200

OK

application/json
get
/api/v1/cities/

Create City

post

Create City

Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional

City ID

namestring · stringRequired

City Name

Example: Istanbul
created_datestring · date-timeRead-onlyOptional

Creation Date

modified_datestring · date-timeRead-onlyOptional

Last Modification Date

is_activebooleanOptional

Is it active? (True/False)

Example: true
countryinteger · int64Required

Related Country ID

priorityinteger · int64Optional

Priority

Example: 1
postcodestring · stringOptional

Postcode

Example: 34000
Responses
post
/api/v1/cities/

List Cities with details

get

List Cities 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.

priorityintegerOptional

Filter by priority

Example: 1
country_idinteger · min: 1Optional

Filter by County ID

country__name__exactstringOptional

Filter by Country Name

country__code__exactstringOptional

Filter by Country Code

country__mapping__code__exactstringOptional

Filter by country's integration mapping object's code

country__mapping__integration_typeall ofOptional

Filter by country's integration mapping object's integration type

string · enumOptionalPossible values:
postcodestringOptional

Filter by Postcode

Responses
chevron-right
200

OK

application/json
get
/api/v1/cities/detailed/

Create mapping for City

get

Create mapping for City

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

Mapping created successfully

application/json
get
/api/v1/create_mapping/

Get mappings for City

get

Get mappings for City

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

Mapping collected successfully

application/json
get
/api/v1/get_mappings/

Get integration mapping types for City

get

Get integration mapping types for City

Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

Integration Mapping Types collected successfully

application/json
get
/api/v1/get_integration_mapping_types/

Last updated

Was this helpful?