İl oluştur
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 '
{
"CountryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "ISTANBUL",
"AreaCode": "216"
}
'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 \"CountryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"Name\": \"ISTANBUL\",\n \"AreaCode\": \"216\"\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({
CountryId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
Name: 'ISTANBUL',
AreaCode: '216'
})
};
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 = {
"CountryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "ISTANBUL",
"AreaCode": "216"
}
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",
"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."
}
]
}İller
İl oluştur
Yeni il ekler.
POST
/
api
/
v1
/
definitions
/
cities
İl oluştur
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 '
{
"CountryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "ISTANBUL",
"AreaCode": "216"
}
'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 \"CountryId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"Name\": \"ISTANBUL\",\n \"AreaCode\": \"216\"\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({
CountryId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
Name: 'ISTANBUL',
AreaCode: '216'
})
};
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 = {
"CountryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "ISTANBUL",
"AreaCode": "216"
}
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",
"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."
}
]
}CountryIdzorunludur ve şirketteki bir ülkeye ait olmalıdır.Namezorunludur ve aynı ülke içinde benzersiz olmalıdır.
Yetkilendirmeler
Access token obtained from the Noyax auth service with your API key.
Başlıklar
İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan, güncellenen ve silinen kayıtların denetim alanlarına yazılır.
Gerekli aralık:
x >= 1Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma ve yazma işlemleri bu şirketle sınırlıdır.
Gerekli aralık:
x >= 1Muhasebe döneminin ID'si. Cari endpoint'lerinde isteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.
Gerekli aralık:
x >= 1Gövde
application/jsontext/jsonapplication/*+json
Yanıt
Created
İşlemin başarılı olup olmadığı.
Örnek:
true
Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir.
Örnek:
"0000"
Show child attributes
Show child attributes
Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir.