Create city
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/cities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Country": "TÜRKİYE",
"Name": "ISTANBUL"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/cities");
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 \"Country\": \"TÜRKİYE\",\n \"Name\": \"ISTANBUL\"\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({Country: 'TÜRKİYE', Name: 'ISTANBUL'})
};
fetch('https://api.noyax.com/api/v1/definitions/cities', 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/cities"
payload = {
"Country": "TÜRKİYE",
"Name": "ISTANBUL"
}
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",
"CountryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Country": "TÜRKİYE",
"Name": "ISTANBUL",
"AreaCode": "216"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0514",
"Message": "Country not found.",
"Errors": [
{
"Code": "0514",
"Message": "Country not found."
}
]
}{
"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."
}
]
}Cities
Create city
Adds a city.
POST
/
api
/
v1
/
definitions
/
cities
Create city
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/cities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Country": "TÜRKİYE",
"Name": "ISTANBUL"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/cities");
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 \"Country\": \"TÜRKİYE\",\n \"Name\": \"ISTANBUL\"\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({Country: 'TÜRKİYE', Name: 'ISTANBUL'})
};
fetch('https://api.noyax.com/api/v1/definitions/cities', 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/cities"
payload = {
"Country": "TÜRKİYE",
"Name": "ISTANBUL"
}
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",
"CountryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Country": "TÜRKİYE",
"Name": "ISTANBUL",
"AreaCode": "216"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0514",
"Message": "Country not found.",
"Errors": [
{
"Code": "0514",
"Message": "Country not found."
}
]
}{
"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."
}
]
}Countryis required and must be a country of the company.Nameis required and must be unique within the country.
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) |
0511 | 400 | City Name is required |
0512 | 400 | The city name is already used in the same country; the response carries the existing record’s ID as ExistingId |
0513 | 400 | Country is required |
0514 | 400 | Country in Country not found |
Authorizations
Headers
Body
application/jsontext/jsonapplication/*+json
Response
Created