Skip to main content
POST
Create district
  • City is required and must be a city of the company.
  • Name is required and must be unique within the city.

Error codes

Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional; if sent, it is written to created records.

Required range: x >= 1

Body

City
null | string
required

Required. City name from GET /api/v1/definitions/cities. Cannot be changed after the district is created.

Example:

"İSTANBUL"

Name
null | string
required

Required. District name, unique within the city. At most 50 characters.

Example:

"KADIKÖY"

Country
null | string

Country name of the city. Required when the same city name exists in more than one country.

Example:

"TÜRKİYE"

Response

Created

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required
Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.