Cari parametre tanımı oluştur
curl --request POST \
--url https://api.noyax.com/api/v1/customers/parameter-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "Segment",
"Type": 0
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/parameter-definitions");
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 \"Name\": \"Segment\",\n \"Type\": 0\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({Name: 'Segment', Type: 0})
};
fetch('https://api.noyax.com/api/v1/customers/parameter-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/parameter-definitions"
payload = {
"Name": "Segment",
"Type": 0
}
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",
"Name": "Segment",
"Type": 0
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1901",
"Message": "Parameter definition Name is required.",
"Errors": [
{
"Code": "1901",
"Message": "Parameter definition Name 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."
}
]
}Parametre tanımları
Cari parametre tanımı oluştur
Yeni cari parametre tanımı ekler.
POST
/
api
/
v1
/
customers
/
parameter-definitions
Cari parametre tanımı oluştur
curl --request POST \
--url https://api.noyax.com/api/v1/customers/parameter-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "Segment",
"Type": 0
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/parameter-definitions");
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 \"Name\": \"Segment\",\n \"Type\": 0\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({Name: 'Segment', Type: 0})
};
fetch('https://api.noyax.com/api/v1/customers/parameter-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/parameter-definitions"
payload = {
"Name": "Segment",
"Type": 0
}
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",
"Name": "Segment",
"Type": 0
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1901",
"Message": "Parameter definition Name is required.",
"Errors": [
{
"Code": "1901",
"Message": "Parameter definition Name 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."
}
]
}Name zorunludur ve şirket içinde benzersiz olmalıdır. Type, cari parametrelerindeki Value alanının formatını belirler ve oluşturulduktan sonra da değiştirilebilir:
| Tip | Anlamı | Örnek Value |
|---|---|---|
0 | Metin | "Öncelikli" |
1 | Evet/Hayır | true |
2 | Tam sayı | 12 |
3 | Ondalık sayı | 12.5 |
4 | Tarih | "2026-09-17" |
5 | Saat | "14:30" |
6 | Tarih ve saat | "2026-09-17T14:30:00" |
Hata kodları
Bu endpoint’in dönebileceği kodlar. Her endpoint için geçerli olan genel hatalar (kimlik doğrulama, yetki, istek header’ları, istek limitleri) burada tekrarlanmaz.| Kod | HTTP | Anlamı |
|---|---|---|
0002 | 400 | İstek gövdesi okunamadı (bozuk JSON, alan tipi uyumsuz) ya da endpoint’te olmayan bir alan içeriyor |
0003 | 400 | Alan azami uzunluğu aşıyor (mesajda alan adı ve sınır yazar) |
1901 | 400 | Name zorunlu |
1902 | 400 | Tanım adı şirkette kullanılıyor; yanıtta var olan kaydın ID’si ExistingId olarak döner |
1903 | 400 | Type 0-6 arasında olmalı |
Yetkilendirmeler
Başlıklar
Gövde
application/jsontext/jsonapplication/*+json
Yanıt
Created