Client LIST
query Parameters
sortSıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
limitBir sayfada gelecek Shipments adedi
pageHangi sayfadan başlanacağı
sinceIdYalnızca belirtilen id değerinden sonraki kayıtları getirir
idsÇoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
randomIdrandom_id
namename
qClient arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]
sArama anahtarı ile filtreleme.
Client LIST › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
nameClient adı.
idClient nesnesine ait benzersiz kimlik numarası.
randomIdClient için rastgele oluşturulmuş benzersiz kimlik.
secretClient gizli anahtarı. API erişimlerinde kullanılır.
Client'ın yönlendirme URI'ları.
Client için izin verilen yetkilendirme türleri.
createdAtClient nesnesinin oluşturulma zamanı.
updatedAtClient nesnesinin son güncellenme zamanı.
predefinedClient'ın ön tanımlı olup olmadığını belirtir
Client POST
Client POST › Request Body
nameClient adı.
idClient nesnesine ait benzersiz kimlik numarası.
randomIdClient için rastgele oluşturulmuş benzersiz kimlik.
secretClient gizli anahtarı. API erişimlerinde kullanılır.
Client'ın yönlendirme URI'ları.
Client için izin verilen yetkilendirme türleri.
createdAtClient nesnesinin oluşturulma zamanı.
updatedAtClient nesnesinin son güncellenme zamanı.
predefinedClient'ın ön tanımlı olup olmadığını belirtir
Client POST › Responses
Oluşturma işlemi (POST) başarı ile sonuçlandı.
nameClient adı.
idClient nesnesine ait benzersiz kimlik numarası.
randomIdClient için rastgele oluşturulmuş benzersiz kimlik.
secretClient gizli anahtarı. API erişimlerinde kullanılır.
Client'ın yönlendirme URI'ları.
Client için izin verilen yetkilendirme türleri.
createdAtClient nesnesinin oluşturulma zamanı.
updatedAtClient nesnesinin son güncellenme zamanı.
predefinedClient'ın ön tanımlı olup olmadığını belirtir
Client COUNT
query Parameters
sortSıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
limitBir sayfada gelecek Shipments adedi
pageHangi sayfadan başlanacağı
sinceIdYalnızca belirtilen id değerinden sonraki kayıtları getirir
idsÇoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
randomIdrandom_id
namename
qClient arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]
sArama anahtarı ile filtreleme.
Client COUNT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
total_countFiltrelere uyan toplam kayıt sayısı.
Client GET
path Parameters
id\d+ · requiredClient GET › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
nameClient adı.
idClient nesnesine ait benzersiz kimlik numarası.
randomIdClient için rastgele oluşturulmuş benzersiz kimlik.
secretClient gizli anahtarı. API erişimlerinde kullanılır.
Client'ın yönlendirme URI'ları.
Client için izin verilen yetkilendirme türleri.
createdAtClient nesnesinin oluşturulma zamanı.
updatedAtClient nesnesinin son güncellenme zamanı.
predefinedClient'ın ön tanımlı olup olmadığını belirtir
Client PUT
path Parameters
id\d+ · requiredClient PUT › Request Body
nameClient adı.
idClient nesnesine ait benzersiz kimlik numarası.
randomIdClient için rastgele oluşturulmuş benzersiz kimlik.
secretClient gizli anahtarı. API erişimlerinde kullanılır.
Client'ın yönlendirme URI'ları.
Client için izin verilen yetkilendirme türleri.
createdAtClient nesnesinin oluşturulma zamanı.
updatedAtClient nesnesinin son güncellenme zamanı.
predefinedClient'ın ön tanımlı olup olmadığını belirtir
Client PUT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
nameClient adı.
idClient nesnesine ait benzersiz kimlik numarası.
randomIdClient için rastgele oluşturulmuş benzersiz kimlik.
secretClient gizli anahtarı. API erişimlerinde kullanılır.
Client'ın yönlendirme URI'ları.
Client için izin verilen yetkilendirme türleri.
createdAtClient nesnesinin oluşturulma zamanı.
updatedAtClient nesnesinin son güncellenme zamanı.
predefinedClient'ın ön tanımlı olup olmadığını belirtir