Create district
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/districts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"City": "İSTANBUL",
"Name": "KADIKÖY"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/districts");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"City\": \"İSTANBUL\",\n \"Name\": \"KADIKÖY\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({City: 'İSTANBUL', Name: 'KADIKÖY'})
};
fetch('https://api.noyax.com/api/v1/definitions/districts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/definitions/districts"
payload = {
"City": "İSTANBUL",
"Name": "KADIKÖY"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"City": "İSTANBUL",
"Country": "TÜRKİYE",
"Name": "KADIKÖY"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0523",
"Message": "City is required.",
"Errors": [
{
"Code": "0523",
"Message": "City is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Districts
Create district
Adds a district.
POST
/
api
/
v1
/
definitions
/
districts
Create district
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/districts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"City": "İSTANBUL",
"Name": "KADIKÖY"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/districts");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"City\": \"İSTANBUL\",\n \"Name\": \"KADIKÖY\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({City: 'İSTANBUL', Name: 'KADIKÖY'})
};
fetch('https://api.noyax.com/api/v1/definitions/districts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/definitions/districts"
payload = {
"City": "İSTANBUL",
"Name": "KADIKÖY"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"City": "İSTANBUL",
"Country": "TÜRKİYE",
"Name": "KADIKÖY"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0523",
"Message": "City is required.",
"Errors": [
{
"Code": "0523",
"Message": "City is required."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Cityis required and must be a city of the company.Nameis 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.| Code | HTTP | Meaning |
|---|---|---|
0002 | 400 | Request body could not be read (malformed JSON, wrong field type), or it contains a field the endpoint does not have |
0003 | 400 | A field exceeds its maximum length (the message names the field and the limit) |
0521 | 400 | District Name is required |
0522 | 400 | The district name is already used in the same city; the response carries the existing record’s ID as ExistingId |
0523 | 400 | City is required |
0524 | 400 | City in City not found |
0580 | 400 | A value given as text (a code or a name) matches more than one record; add the detail that tells them apart (for example City for a district, Country for a city) |
Authorizations
Headers
Body
application/jsontext/jsonapplication/*+json
Response
Created