TeamWherx

TeamWherx(TW), uzak çalışan ekiplerinizi ve genel iş operasyonlarınızı ofisten daha etkili bir şekilde yönetmenize yardımcı olan hepsi bir arada bir hizmet yönetim platformudur. Bulut tabanlı bir çözüm olan TW, uzaktan veri toplamayı sağlar ve bunu web uygulaması panosu aracılığıyla görüntüleyerek yöneticilere daha yüksek verimlilik, üretkenlik ve daha düşük maliyetler için daha akıllı stratejiler oluşturmak ve mobil iş gücülerini koordine etmek için ihtiyaç duydukları ek içgörüleri sağlar.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet	Class	Bölgeler
Copilot Studio	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD)
Logic Apps	Standart	Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD)
Power Apps	Premium	Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD)
Power Automate	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD)

İletişim
İsim	Actsoft Desteği
URL	https://www.actsoft.com/self-help-wizards
E-posta	support@actsoft.com

Bağlayıcı Meta Verileri
Publisher	Actsoft
Web sitesi	https://actsoft.com
Gizlilik ilkesi	https://www.actsoft.com/privacy
Kategoriler	Verimli -lik

Bağlayıcı Açıklaması:

TeamWherx, dijital form bilgileri, çalışan zaman tutma bilgileri oluşturup yakalamanıza ve bir gönderim sistemiyle iş siparişlerini yönetmenize olanak tanır.

Ayrıntılı Açıklama

TeamWherx bağlayıcısı, kullanıcıların birden çok platform arasında bağlanmasına ve bilgi alışverişinde bulunmasına olanak tanır. İşlem akışları oluşturmak, diğer şirket içi uygulamalarınızı yönlendirmek ve güçlü analizler hakkında bilgi vermek için verilerinize animasyon uygulayabilirsiniz. up-toanlık eyleme dönüştürülebilir verilere erişimle günlük, haftalık veya aylık süreçlerinizi otomatikleştirin ve kolaylaştırın.

## Önkoşullar

Bu bağlayıcıyı kullanmak için aşağıdakilere ihtiyacınız olacaktır:

TeamWherx hesabı
TeamWherx API anahtarı
Microsoft Power Apps veya Power Automate planı

## Kimlik bilgilerini alma

API Geliştirici portalı

Bağlayıcıya erişmek için önce API Geliştirici portalı için bir kullanıcı adı ve parola ayarlamanız ve Müşteri API'sine abone olmanız gerekir:

Uygulamanın içinden Yönetim>Ayarları>APIKurulumu'na gidin.
Kimlik Bilgileri Oluştur'u seçin.
Uygun alanlara adınızı ve soyadınızı girin.
E-posta adresinizi E-postaadresi alanına girin.
Kaydet ve e-posta daveti'ni seçin. Ardından, parola oluşturma yönergeleri için e-postanıza bakın.
Davet e-postasının içine girdikten sonra ParolaSeç'e tıklayın. Bu, parola oluşturmanıza olanak tanıyan bir iletişim kutusu açar.
Parolayı kaydet'i seçin.
Geliştirici portalına devam etmek için uygulamanın içinden Yönetim>Ayarları>Geliştirici portalına gidin'egidin.
Geliştirici portalında Ürünler'i ve ardından MüşteriAPI'sini seçin.
Abone Ol'u seçin.

API Anahtarı

Artık kayıtlı bir API kullanıcısı olduğunuz için anahtar olarak adlandırılan alfasayısal bir sıra sizin için oluşturulmuştur. API'deki verilerinizle çalışmak için bu anahtara ihtiyacınız olacaktır.

API Anahtarınızı bulmak için:

Geliştirici portalı menüsünden Ürünler'i seçin. Lisansınızda bulunan API ürünleri görüntülenir.
'Bu ürün için X aboneliğiniz var' bölümünden Müşteri API'sinin sürümünü seçin.
Aboneliğiniz için Birincil anahtarın yanındaki Göster'i seçin.
Alanın içeriğini seçin, sağ tıklayın ve Kopyala'yı seçin. Anahtar artık panonuza kaydedilir ve yapıştırmaya hazır olur.

## Bağlayıcınızı kullanmaya başlama

Akışlarım>Yeni akış'a gidin ve otomatik bulut akışı'na tıklayın.
Otomatik bulut akışı oluştur iletişim kutusunda Akışı el ile tetikle'yi seçin.
Akışınızı adlandırın veya sistemin otomatik olarak bir akış oluşturmasına izin verin.
Akışınız için bir tetikleyici arayın ve seçin.
Oluştur’u seçin.
Arama alanında TeamWherx bağlayıcısını arayın ve seçin.
Bağlayıcıyla gerçekleştirmek istediğiniz eylemi bulun.

Sistem, seçtiğiniz eylemi gerçekleştirmek için gereken tüm uygulamalarda oturum açmanızı ister ve zaten oturum açmış olduğunuz işlemleri atlar.

Bağlayıcı alanına yeni bağlayıcınız için bir ad girin.
Ardından API anahtarınızı girin.
Oluştur’u seçin. İşlem akışınızdaki ilk adım, akış çizelgesindeki ilk 'kutu' olarak görüntülenir.
Bağlayıcı işlem akışınıza daha fazla eylem ve adım eklemeye devam etmek için Yeni adım'ı seçin.
Kaydet'i seçin.

**Bağlayıcıyı kullanma - Sipariş durumu yoklaması örneği
** Aşağıdaki yönergelerde, çalışma sayfasına satır eklemek için nasıl bir işlem akışı oluşturulacağı ve sipariş durumu güncelleştirildiğinde siparişi güncelleştiren çalışanın tanımlayıcı verilerinin nasıl eklendiği gösterilir.

Bağlayıcılar'a gidin.
[TeamWherx] bağlayıcısını arayın ve seçin.
Eylemler listesinden Sipariş durumları yoklaması'nı seçin.
Bağlantı adı alanına yeni bağlantınız için bir ad girin.
Ardından API anahtarınızı girin.
Oluştur’u seçin. İşlem akışınızdaki ilk adım, akış çizelgesindeki ilk 'kutu' olarak görüntülenir.

Bağlantı akışınızın adımlarındaki her eylem iletişim kutusunda, gerçekleştirilen eylemi denetlemek için özelleştirebileceğiniz özellik alanları bulunur.

Örnekten devam edersek, Forms alan değerlerinin görüntülenmesini isteyip istemediğinizi seçin (excludeFormData parametresi).
Bağlantı için X-API sürümünü seçin.
Sipariş durumu değiştirildiğinde gerçekleşmesini istediğiniz eylemi ayarlamak için Sonraki adım'ı seçin.
İşlem seçin iletişim kutusunda, uygulamayı ve ardından istenen eylemi bulmak için arama alanını kullanın. Örneğin, bir sipariş durumu her değiştiğinde Google çalışma sayfasına satır eklemek istiyorsanız, eylem için GoogleE-Tablolar'ı ve ardından Satırekle'yi seçersiniz.
Ardından gelen Satırekle iletişim kutusunda Dosya alanına tıklayın ve sonuçlarınızı içerecek dosyayı seçin.
Çalışma sayfası alanında veri çalışma sayfası türünü seçin. Dinamik olarak görüntülenen alanlar, çalışma sayfasındaki veri sütunlarıdır.
Her sütunun alanına tıklayın ve Sipariş durumu yoklama özellikleri listesinden bir özellik seçin. İsterseniz, belirli bir özelliği bulmak için arama alanını da kullanabilirsiniz.
Her sütun alanına birden fazla özellik girebilirsiniz; Olay sütununda StatusLabel'i seçin, bir tire ekleyin ve ardından StatusStartDate'ı seçin. Bu, her sipariş durumu güncelleştirmesi için Durum Etiketi ve Durum Başlangıç Tarihi'nin yeni satırdaki Olay sütununa yazılacağı anlamına gelir.
Yeni adım'ı seçin. Bir kenara not olarak, yeni bir adım eklemek için ok bağlayıcısının üzerine gelip tıklayabilirsiniz
İşlem seçin iletişim kutusunda TeamWherx bağlayıcısını yeniden seçin ve ardından eylem için istemci oluştur'u seçin.

Yine, iletişim kutusunda görüntülenen her alan Google E-Tablolar elektronik tablosundaki bir sütunu temsil eder. Sipariş durumu yoklama özellikleri listesini etkinleştirmek için her alana tıklayın ve istediğiniz özellikleri seçin.

Bu örnekte, sipariş durumunu güncelleştiren çalışanı tanımlamak için Ad alanı olarak EmployeeNumber'ı seçin.
GroupName'i seçin ve Ad alanına da ekleyin.
Kaydet'i seçin.

Şimdi, bir sipariş durumu her güncelleştirildiğinde elektronik tablonuzu çalışan numarası ve ilişkili grubuyla güncelleştirecek bir işlem akışı oluşturdunuz.

## Bilinen sorunlar ve sınırlamalar

Tüm uç noktalar için ses dosyası ikili yüklemeleri (POST) yalnızca MP4 ile sınırlıdır.
Tarih-saat bilgisi gerektiren tüm uç noktaların tarihleri, aşağıdaki örnekte olduğu gibi RFC3339 yönergelere göre belirtilmelidir: 2021-09-22T02:36:56.52Z. Zaman damgasında tam saniyelerin belirtilmesi gerekmez; 00 kabul edilebilir.

## Yaygın hatalar ve çözümler

Oluşabilecek yaygın hata örnekleri, yanıt kodları ve düzeltmeler API Geliştiricileri Portalı'nda bulunabilir:

Encore- https://developer.wfmplatform.com/

## SSS

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:


Varsayılan	Bağlantı oluşturmak için parametreler.	Tüm bölgeler	Paylaşılamaz

Temerrüt

Geçerli: Tüm bölgeler

Bağlantı oluşturmak için parametreler.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim	Türü	Description	Gerekli
API Anahtarı	securestring	Bu API için API Anahtarı	Doğru

Azaltma Sınırları

Name	Çağrılar	Yenileme Dönemi
Bağlantı başına API çağrıları	100	60 saniye

Eylemler

Abonelik durumunu sıfırlar	Abonelik durumunu durum = 1 ("Çalışıyor") olarak değiştirir.
Aboneliklerin listesini alma	Web kancası aboneliklerinin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak SubscriptionId değerine göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
Aracı güncelleştirme	Bir aracı kimliğine göre güncelleştirin.
Araç listesi alma	Bir araç listesi alır.
Araç oluşturma	Bir araç oluşturur.
Bir aracı devre dışı bırakma	Kimliğine göre bir aracı devre dışı bırakın.
Bir aracı etkinleştirme	Bir aracı kimlikle etkinleştirin.
Bir aracı kısmi güncelleştirme	Bir aracı kimlikle kısmi güncelleştirme.
Bir aracı silme	Kimliğine göre bir aracı silin.
Bölge oluşturma	Yeni bir coğrafi bölge oluşturur.
Coğrafi bölge alma	Kimliğine göre bir coğrafi bölge alır.
Coğrafi konumların listesini alma	Coğrafi konumların listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını ve bölge koordinatlarının ölçüm olup olmadığını belirtebilirsiniz. Sonuçlar otomatik olarak Ada göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
Coğrafi konumu silme	Var olan bir coğrafi konumu kimliğine göre siler.
CustomListID'ye göre özel liste alanları listesi alma	CustomListID kullanarak tek bir özel listenin alan listesini alır.
CustomListID tarafından özel liste verileri alma	CustomListID kullanarak tek bir özel listedeki tüm veri kayıtlarını alır. Sonuçlar sütuna göre sıralanır ve sayfalama desteklenir. Hata: 404 - sağlanan customListId için özel liste yok.
Ek dosyasını karşıya yükleme	Form dosyası eklerini karşıya yüklemek için bu seçeneği kullanın. İkili boyut 25 MB ile sınırlıdır. Tek dosyalı çok parçalı/form-veri isteği bekleniyor.
Form alma	Bir formu kimliğine göre alır.
Form listesini alma	Aşağıda gösterilen istek parametrelerinden filtrelerden herhangi birini kullanarak form listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar, SubmittedTime'a göre ve azalan düzende otomatik olarak sıralanır. Sıralama parametreleri yapılandırılamaz.
Form oluşturma	Yeni bir form ekler.
GPS veri akışı ile Web kancası geri çağırma	Bu örnek yöntem, gpsdata/subscribe tarafından müşteri tarafından sağlanan URL'yi kullanarak veri akışını geri göndermek için kullanılır.
GPS veri girişlerini alma	Belirtilen tarih aralığı için GPS veri girişlerini alır. Ayrıca bir devam belirteci ve sonraki veri bölümünü almak için bir bağlantı döndürür. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Silinen kullanıcıların/araçların pozisyonları iade edilmez. Ancak, veriler istendiğinde ve daha sonra kaldırıldığında kullanıcı/araç mevcutsa, bir devamlılık belirteci tarafından istenen kullanıcı/araç verileri döndürülür. Sonuçlar otomatik olarak UtcTime'a göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
GPS veri web kancası aboneliğini kaldırma	Bir GPS verisi web kancası aboneliğini kimliğine göre siler.
GPS verilerine abone ol web kancası	Yeni GPS İzleme verileri (GPS konumları) web kancası ekler. Web kancaları, belirtilen URL'de oluşan GPS konumlarını almanıza olanak sağlar.
İkili dosyayı karşıya yükleme	Form görüntülerini ve ses dosyalarını karşıya yüklemek için bu seçeneği kullanın. İkili boyut 10 MB ile sınırlıdır. Desteklenen dosya türleri şunlardır: JPEG, PNG ve MP4.
İkincil sürümü alma	API'nin geçerli ikincil sürümünü döndürür.
İstemci alma	İstemci nesnesini kimliğine göre alır.
İstemci oluşturma	Yeni bir istemci oluşturur.
İstemci silme	Var olan bir istemciyi kimliğine göre siler.
İstemcilerin listesini alma	İstemcilerin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak Ada göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
İstemciyi güncelleştirme	Mevcut bir istemciyi güncelleştirir.
Kimliğine göre araç alma	Kimliğine göre tek bir araç alır.
Kimliğine göre özel olay tanımı alma	Kimliğine göre tek bir özel olay tanımı alır.
Kullanıcı alma	Bir kullanıcıyı kimliğine göre alır.
Kullanıcı oluşturma	Yeni bir kullanıcı oluşturur.
Kullanıcıların listesini alma	Kullanıcıların listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak UserId değerine göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
Kullanıcının bir bölümünü güncelleştirme	Kullanıcı özelliklerinin bir bölümünü güncelleştirir.
Kullanıcıyı devre dışı bırakma	Mevcut bir kullanıcıyı kimliğine göre devre dışı bırakır.
Kullanıcıyı etkinleştirme	Mevcut bir kullanıcıyı kimliğine göre etkinleştirir.
Kullanıcıyı güncelleştirme	Mevcut bir kullanıcıyı güncelleştirir.
Mevcut bir coğrafi konumu güncelleştirme	Mevcut bir coğrafi konumu kimliğine göre güncelleştirir.
Olay akışı ile web kancası geri çağırma	Bu örnek yöntem, olaylar/abone olun tarafından müşteri tarafından sağlanan URL kullanılarak olay veri akışını geri göndermek için kullanılır.
Olay web kancası abonelik durumunu sıfırlar	Abonelik durumunu durum = 1 ("Çalışıyor") olarak değiştirir.
Olay web kancası aboneliklerinin listesini alma	Olay web kancası aboneliklerinin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak SubscriptionId değerine göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
Olaylar web kancası aboneliğini kaldırma	Olay web kancası aboneliğini kimliğine göre siler.
Olaylar web kancasına abone olma	Yeni olaylar web kancası aboneliği ekler. Web kancaları, belirtilen URL'de gerçekleşen şirket olaylarıyla ilgili otomatik bildirimler almanıza olanak tanır.
Olayların listesini alma	Belirli bir zaman aralığına ait olayların listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Belirli olayları almak için olay türüne göre filtreleyin. Çalışan araçla ilişkiliyse, çalışan için araç olayları iade edilebilir.
Olayı gönderme	Olayı gönderir.
Sipariş alma	Var olan bir siparişi kimliğine göre alır.
Sipariş durumunu güncelleştirme	Mevcut sipariş durumunu değiştirir.
Sipariş oluşturma	Yeni bir sipariş ekler.
Siparişi güncelleştirme	Mevcut bir siparişi güncelleştirir.
Siparişlerin listesini alma	Aşağıda gösterilen istek parametrelerindeki filtreleri kullanarak siparişlerin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak Client.Name göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
Yolculukların listesini alma	Belirli bir zaman aralığı için seyahatlerin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak StartUtcTIme'ye göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
Zaman tutma girdilerinin listesini alma	Tarih aralığına göre zaman tutma girdilerinin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak ClockInTime, timekeepingStatusId ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.
Zaman tutma girdisi alma	Kimliğine göre bir girdi alır.
Özel liste kaydı oluşturma veya güncelleştirme	Özel liste veri kaydını oluşturur veya güncelleştirir. Benzersiz sütunun değeri atlanabilir, ancak varsa sorgu parametresindeki Benzersiz Kimlik değeriyle eşleşmelidir.
Özel liste kaydını silme	Özel listedeki mevcut kaydı customListId ve kimliğiyle siler. id - özel liste kaydının benzersiz değeridir. Hata: 404 - customListId veya kimlik bulunamadı.
Özel liste tanımlarını alma	Özel Liste tanımı listesini alır. Tanım listesi, mevcut tüm özel listeler için CustomListID, Name ve Version içerir.
Özel listeden tek kayıt alma	CustomListId ve benzersiz sütun değeri tarafından bulunan tek bir özel liste veri kaydını alır. Hata: 404 - sağlanan customListId ve benzersiz sütun değeri için özel liste kaydı yok
Özel olay tanımlarının listesini alma	Özel olay tanımlarının listesini alır.
Özel olay tanımı oluşturma veya güncelleştirme	Özel bir olay tanımı oluşturur veya güncelleştirir.
Özel olay tanımını silme	Özel olay tanımını siler.

Abonelik durumunu sıfırlar

İşlem Kimliği:: TrackingController_ResetSubscriptionHealthStatus

Abonelik durumunu durum = 1 ("Çalışıyor") olarak değiştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
subscriptionId	subscriptionId	True	integer	Abonelik kimliği.

Aboneliklerin listesini alma

İşlem Kimliği:: TrackingController_GetSubscriptions

Web kancası aboneliklerinin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak SubscriptionId değerine göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Döndürülenler

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Aracı güncelleştirme

İşlem Kimliği:: VehicleController_UpdateVehicle

Bir aracı kimliğine göre güncelleştirin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
Sayı	Number		string
İsim	Name		string
Türü	Type		string
Etiket	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Yapmak	Make		string
Yıl	Year		integer
Model	Model		string
Renk	Color		string
VİN	VIN		string
IsActive	IsActive		boolean
CihazTürü	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

response: integer

Araç listesi alma

İşlem Kimliği:: VehicleController_GetVehicles

Bir araç listesi alır.

Parametreler

Name	Anahtar	Tür	Description
pageNumber	pageNumber	integer	Sayfa numarası.
pageSize	pageSize	integer	Sayfadaki en fazla öğe sayısı. Varsayılan = 1000. Maksimum değer = 2000.
activeOnly	activeOnly	boolean	true ise - yalnızca etkin araçları döndürür. Varsayılan değer = false.

Döndürülenler

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Araç oluşturma

İşlem Kimliği:: VehicleController_CreateVehicle

Bir araç oluşturur.

Parametreler

Name	Anahtar	Tür
Sayı	Number	string
İsim	Name	string
Türü	Type	string
Etiket	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Yapmak	Make	string
Yıl	Year	integer
Model	Model	string
Renk	Color	string
VİN	VIN	string
IsActive	IsActive	boolean
CihazTürü	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Bir aracı devre dışı bırakma

İşlem Kimliği:: VehicleController_Deactivate

Kimliğine göre bir aracı devre dışı bırakın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

response: integer

Bir aracı etkinleştirme

İşlem Kimliği:: VehicleController_Activate

Bir aracı kimlikle etkinleştirin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

response: integer

Bir aracı kısmi güncelleştirme

İşlem Kimliği:: VehicleController_PartialUpdateVehicle

Bir aracı kimlikle kısmi güncelleştirme.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
			object
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Bir aracı silme

İşlem Kimliği:: VehicleController_Delete

Kimliğine göre bir aracı silin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Bölge oluşturma

İşlem Kimliği:: GeofenceController_CreateGeofence

Yeni bir coğrafi bölge oluşturur.

Parametreler

Name	Anahtar	Tür	Description
GroupNames	GroupNames	array of string	GeofenceCreateApiModel'in GroupPath'leri.
Enlem	Latitude	double
Boylam	Longitude	double
İsim	Name	string	GeofenceApiModelBase adı.
Türü	Type	string	GeofenceApiModel türü.
Shape	Shape	integer	Şekil: Daire için 0, çokgen için 1.
Enlem	Latitude	double
Boylam	Longitude	double
Adres satırı 1	AddressLine1	string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2	string	Bu LocationApiModel'in AddressLine2.
City	City	string	LocationApiModel şehri.
BölgeAdı	RegionName	string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode	string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode	string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName	string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode	string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode	string	LocationApiModel'in Bölge Kodu.
Yarıçap	Radius	double	GeofenceApiModel'in yarıçapı.
UseGeofenceAddress	UseGeofenceAddress	boolean	GeofenceApiModel'in UseGeofenceAddress.
useMetric	useMetric	boolean	Ölçüm sistemini kullan veya kullanma.
coğrafi kod	geocode	boolean	Adres coğrafi olarak kodlanmış olmalı veya kodlanmamalıdır.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Coğrafi bölge alma

İşlem Kimliği:: GeofenceController_GetGeofence

Kimliğine göre bir coğrafi bölge alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	integer	Geofence Kimliği.
useMetric	useMetric		boolean	Ölçüm sistemini kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.Geofence.GeofenceApiModel

Coğrafi konumların listesini alma

İşlem Kimliği:: GeofenceController_GetGeofences

Coğrafi konumların listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını ve bölge koordinatlarının ölçüm olup olmadığını belirtebilirsiniz. Sonuçlar otomatik olarak Ada göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Tür	Description
pageNumber	pageNumber	integer	Başlangıç sayfası numarası. Varsayılan değer 1'dir.
pageSize	pageSize	integer	Sayfa boyutu. Varsayılan değer 500'dür.
useMetric	useMetric	boolean	Ölçüm sistemini kullan veya kullanma.

Döndürülenler

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Coğrafi konumu silme

İşlem Kimliği:: GeofenceController_DeleteGeofence

Var olan bir coğrafi konumu kimliğine göre siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	integer	Geofence Kimliği.

CustomListID'ye göre özel liste alanları listesi alma

İşlem Kimliği:: CustomListController_GetById

CustomListID kullanarak tek bir özel listenin alan listesini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
customListId	customListId	True	integer	Özel liste kimliği.

Döndürülenler

Özel Liste Modeli.

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

CustomListID tarafından özel liste verileri alma

İşlem Kimliği:: CustomListController_GetCustomList

CustomListID kullanarak tek bir özel listedeki tüm veri kayıtlarını alır.

Sonuçlar sütuna göre sıralanır ve sayfalama desteklenir.

Hata:

404 - sağlanan customListId için özel liste yok.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
customListId	customListId	True	integer	Özel liste kimliği.
pageNumber	pageNumber		integer	Başlangıç sayfası numarası.
pageSize	pageSize		integer	Sayfa boyutu.

Döndürülenler

Özel liste sütunu veri dizisi için kapsayıcı.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Ek dosyasını karşıya yükleme

İşlem Kimliği:: BinaryController_UploadAttachment

Form dosyası eklerini karşıya yüklemek için bu seçeneği kullanın. İkili boyut 25 MB ile sınırlıdır. Tek dosyalı çok parçalı/form-veri isteği bekleniyor.

Döndürülenler

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Form alma

İşlem Kimliği:: FormController_GetFormAsync

Bir formu kimliğine göre alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	integer	Form kimliği.

Döndürülenler

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Form listesini alma

İşlem Kimliği:: FormController_GetFormsAsync

Aşağıda gösterilen istek parametrelerinden filtrelerden herhangi birini kullanarak form listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar, SubmittedTime'a göre ve azalan düzende otomatik olarak sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
submittedStartDate	submittedStartDate	True	date-time	Gönderilen formun başlangıç tarihi.
submittedEndDate	submittedEndDate	True	date-time	Gönderilen formun bitiş tarihi.
apiModuleId	apiModuleId		string	Form modülü kimliği.
çalışanNumarası	employeeNumber		string	Çalışan numarası.
Incelendi	reviewed		boolean	Yalnızca gözden geçirilmiş formları alır veya almaz. Varsayılan değer tümü için null'tır.
pageNumber	pageNumber		integer	Başlangıç sayfa numarası. Varsayılan değer 1'dir.
pageSize	pageSize		integer	Sayfa boyutu. Varsayılan değer 1000’dir.

Döndürülenler

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Form oluşturma

İşlem Kimliği:: FormController_PostFormAsync

Yeni bir form ekler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
ApiModuleId	ApiModuleId		string	Bu CreateStandaloneFormApiModel ile ilişkili ApiModule kimliği.
Incelendi	Reviewed		boolean	Bu CreateStandaloneFormApiModel gözden geçirmesinin durumu.
UserId	UserId		integer	Kullanıcının Kullanıcı Kimliği.
EmployeeNumber	EmployeeNumber		string	Kullanıcının çalışan numarası.
SubmittedTime	SubmittedTime	True	date-time	CreateStandaloneFormApiModel'in gönderildiği zamanın belirli bir noktası.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
ApiFieldId	ApiFieldId	True	string	API Alan Kimliği.
Değer	Value	True		FormFieldDataApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "Sign" alan değeri biçimi (ikili başvuru): { "BinaryId": dize // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	İkili verilerin yakalandığı zaman. Biçim - uzaklık dahil olmak üzere tarih-saat (RFC3339 tarih-saat olarak).
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
ApiFieldId	ApiFieldId	True	string	API Alan Kimliği.
Değer	Value	True		FormFieldDataApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "Sign" alan değeri biçimi (ikili başvuru): { "BinaryId": dize // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	İkili verilerin yakalandığı zaman. Biçim - uzaklık dahil olmak üzere tarih-saat (RFC3339 tarih-saat olarak).

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

GPS veri akışı ile Web kancası geri çağırma

İşlem Kimliği:: TrackingController_subscribe_callback

Bu örnek yöntem, gpsdata/subscribe tarafından müşteri tarafından sağlanan URL'yi kullanarak veri akışını geri göndermek için kullanılır.

Parametreler

Name	Anahtar	Tür	Description
Kimlik	Id	string	WebHookSubscriptionParamsApiModel adresini içeren URL.
DeviceId	DeviceId	string	Abonelikle ilişkili GpsDeviceDto Kimliği.
CihazTürü	DeviceType	integer	GpsDeviceDto türü: Ahize(0), CalAmp(1), Geotab (2), Xirgo (3).
Zaman Damgası	Timestamp	date-time	Yerel ve Uzaklık ile ISO biçimi.
Şirket Kimliği	CompanyId	integer	Şirket Kimliği.
UserId	UserId	integer	Kullanıcı Kimliği.
Araç Kimliği	VehicleId	integer	Araç Kimliği.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Bir kullanıcının araca bağlı olup olmadığı.
LocationProvider	LocationProvider	string	Konum sağlayıcısı adı.
Lat	Lat	double	Enlem.
Lon	Lon	double	Boylam.
AccuracyFt	AccuracyFt	double	Konum doğruluğu (Ayaklar).
AltitudeFt	AltitudeFt	double	Yükseklik (Feet).
Heading	Heading	integer	Pusula yönü derece olarak.
SpeedMph	SpeedMph	double	Hareket hızı (Mph).
BatteryStatus	BatteryStatus	integer	Pil durumu: Şarj değil(0), Şarj Etme(1).
BatteryLevel	BatteryLevel	integer	Yüzde olarak pil düzeyi.
ActivityState	ActivityState	integer	Etkinlik durumu: Staying(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Cihaz şu anda ağa bağlı mı?
Rssi	Rssi	integer	Alınan Sinyal Gücü Göstergesi.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (Mil).
VOdoMl	VOdoMl	double	Araç kilometre sayacı (Mil).

Döndürülenler

response: object

GPS veri girişlerini alma

İşlem Kimliği:: TrackingController_GetGpsData

Belirtilen tarih aralığı için GPS veri girişlerini alır. Ayrıca bir devam belirteci ve sonraki veri bölümünü almak için bir bağlantı döndürür. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz.

Silinen kullanıcıların/araçların pozisyonları iade edilmez. Ancak, veriler istendiğinde ve daha sonra kaldırıldığında kullanıcı/araç mevcutsa, bir devamlılık belirteci tarafından istenen kullanıcı/araç verileri döndürülür.

Sonuçlar otomatik olarak UtcTime'a göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Tür	Description
fromDate	fromDate	date-time	Tarih aralığı başlangıcı. Öneri: Lütfen küçük tarih aralıkları yerine büyük tarih aralıklarını (>=4 saat) kullanın.
toDate	toDate	date-time	Tarih aralığı sonu. Öneri: Lütfen küçük tarih aralıkları yerine büyük tarih aralıklarını (>=4 saat) kullanın.
çalışanNumarası	employeeNumber	string	Çalışan numarası.
Vin	vin	string	Aracın VIN numarası.
useMetric	useMetric	boolean	Ölçüm sistemini kullan veya kullanma.
token	token	string	İlk çağrı tarafından döndürülen ve ardışık çağrıda kullanılacak devamlılık belirteci.

Döndürülenler

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

GPS veri web kancası aboneliğini kaldırma

İşlem Kimliği:: TrackingController_RemoveGpsDataFeedSubscription

Bir GPS verisi web kancası aboneliğini kimliğine göre siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
subscriptionId	subscriptionId	True	string	Silinecek abonelik kimliği.

GPS verilerine abone ol web kancası

İşlem Kimliği:: TrackingController_SubscribeToGpsDataFeed

Yeni GPS İzleme verileri (GPS konumları) web kancası ekler. Web kancaları, belirtilen URL'de oluşan GPS konumlarını almanıza olanak sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bağlantı	Url		string	WebHookSubscriptionParamsApiModel adresini içeren URL.
SecurityToken	SecurityToken		string	Bu WebHookSubscriptionParamsApiModel ile ilişkili Güvenlik Belirteci.

Döndürülenler

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

İkili dosyayı karşıya yükleme

İşlem Kimliği:: BinaryController_UploadBinary

Form görüntülerini ve ses dosyalarını karşıya yüklemek için bu seçeneği kullanın. İkili boyut 10 MB ile sınırlıdır. Desteklenen dosya türleri şunlardır: JPEG, PNG ve MP4.

Döndürülenler

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

İkincil sürümü alma

İşlem Kimliği:: VersionController_Get

API'nin geçerli ikincil sürümünü döndürür.

İstemci alma

İşlem Kimliği:: ClientController_Get

İstemci nesnesini kimliğine göre alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	İstemci Kimliği.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.Client.ReadClientApiModel

İstemci oluşturma

İşlem Kimliği:: ClientController_Create

Yeni bir istemci oluşturur.

Parametreler

Name	Anahtar	Tür	Description
ExternalId	ExternalId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım Kimliği.
FieldIndex	FieldIndex	integer	Alan dizini.
Değer	Value		Alan değeri.
İsim	Name	string	İstemcinin adı.
Enlem	Latitude	double
Boylam	Longitude	double
Adres satırı 1	AddressLine1	string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2	string	Bu LocationApiModel'in AddressLine2.
City	City	string	LocationApiModel şehri.
BölgeAdı	RegionName	string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode	string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode	string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName	string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode	string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode	string	LocationApiModel'in Bölge Kodu.
İsim	Name	string	ContactApiModel'in adı.
Telefon Numarası	PhoneNumber	string	ContactApiModel'in Telefon Numarası.
E-posta	Email	string	ContactApiModel'in e-postası.
coğrafi kod	geocode	boolean	Adres coğrafi olarak kodlanmış olmalı veya kodlanmamalıdır.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

İstemci silme

İşlem Kimliği:: ClientController_Delete

Var olan bir istemciyi kimliğine göre siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	İstemci Kimliği.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

İstemcilerin listesini alma

İşlem Kimliği:: ClientController_GetClients

İstemcilerin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak Ada göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
pageNumber	pageNumber		integer	Başlangıç sayfası numarası.
pageSize	pageSize		integer	Sayfa boyutu.

Döndürülenler

response: array of CustomerAPI.Models.Client.ReadClientApiModel

İstemciyi güncelleştirme

İşlem Kimliği:: ClientController_Update

Mevcut bir istemciyi güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
ExternalId	ExternalId		string	İstemci - API Uzantısı Özelliği için Dış Kullanım Kimliği.
FieldIndex	FieldIndex		integer	Alan dizini.
Değer	Value			Alan değeri.
İsim	Name		string	İstemcinin adı.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
İsim	Name		string	ContactApiModel'in adı.
Telefon Numarası	PhoneNumber		string	ContactApiModel'in Telefon Numarası.
E-posta	Email		string	ContactApiModel'in e-postası.
coğrafi kod	geocode		boolean	Adres coğrafi olarak kodlanmış olmalı veya kodlanmamalıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Kimliğine göre araç alma

İşlem Kimliği:: VehicleController_GetVehicle

Kimliğine göre tek bir araç alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Araç Veri Modeli.

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

Kimliğine göre özel olay tanımı alma

İşlem Kimliği:: EventController_Get

Kimliğine göre tek bir özel olay tanımı alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Olay tanımı kimliği.

Döndürülenler

Özel Olay Tanımı Modeli.

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Kullanıcı alma

İşlem Kimliği:: UserController_Get

Bir kullanıcıyı kimliğine göre alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.User.ReadUserApiModel

Kullanıcı oluşturma

İşlem Kimliği:: UserController_Create

Yeni bir kullanıcı oluşturur.

Parametreler

Name	Anahtar	Tür	Description
Kullanıcı adı	UserName	string	Kullanıcının UserName'i.
Şifre	Password	password	Kullanıcının parolası.
GroupName	GroupName	string	Kullanıcı Grubunun Adı.
İlk İsim	FirstName	string	Kullanıcının adı.
Soyadı	LastName	string	Kullanıcının soyadı.
EmployeeNumber	EmployeeNumber	string	Kullanıcının çalışan numarası.
E-posta	Email	string	Kullanıcının e-posta adresi.
Telefon	Phone	string	Kullanıcının telefon numarası.
RoleId	RoleId	integer	Kullanıcının RoleId değeri - (Yönetici: 1, Kullanıcı: 3, Power User: 5).
IsActive	IsActive	boolean	Kullanıcının etkin durumu.
EPTTEnabled	EPTTEnabled	boolean	Kullanıcı için Gelişmiş Konuşmaya Gönder özelliğinin durumu: boole.
EPTTNumber	EPTTNumber	string	Kullanıcı: dize için Gelişmiş Konuşmaya Gönder özelliğinin telefon numarası.
EPTTWebMDN	EPTTWebMDN	string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan telefon numarası - Kodiak tarafından sağlanır.
EPTTToken	EPTTToken	string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan API Belirteci - Kodiak tarafından sağlanır.
GPSEnabled	GPSEnabled	boolean	Kullanıcı için GPS Özelliğinin Durumu.
MobileOnly	MobileOnly	boolean	CAB için masaüstü web uygulaması erişiminin durumu - (WebApp Erişimi Yok: True, Tam Uygulama Erişimi: False).
LicenseType	LicenseType	integer	Kullanıcıya atanan Lisans Türü: - Undefined için 0, Normal için 1, WebOnly için 2 ve Çalışan için 3.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Kullanıcıların listesini alma

İşlem Kimliği:: UserController_GetUsers

Kullanıcıların listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak UserId değerine göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
pageNumber	pageNumber		integer	Başlangıç sayfası numarası. Varsayılan değer 1'dir.
pageSize	pageSize		integer	Sayfa boyutu. Varsayılan değer 500'dür.

Döndürülenler

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Kullanıcının bir bölümünü güncelleştirme

İşlem Kimliği:: UserController_PartialUpdate

Kullanıcı özelliklerinin bir bölümünü güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
			object
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Kullanıcıyı devre dışı bırakma

İşlem Kimliği:: UserController_Deactivate

Mevcut bir kullanıcıyı kimliğine göre devre dışı bırakır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Kullanıcıyı etkinleştirme

İşlem Kimliği:: UserController_Activate

Mevcut bir kullanıcıyı kimliğine göre etkinleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Kullanıcıyı güncelleştirme

İşlem Kimliği:: UserController_Update

Mevcut bir kullanıcıyı güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
Kullanıcı adı	UserName		string	Kullanıcının UserName'i.
Şifre	Password		password	Kullanıcının parolası.
GroupName	GroupName		string	Kullanıcı Grubunun Adı.
İlk İsim	FirstName		string	Kullanıcının adı.
Soyadı	LastName		string	Kullanıcının soyadı.
EmployeeNumber	EmployeeNumber		string	Kullanıcının çalışan numarası.
E-posta	Email		string	Kullanıcının e-posta adresi.
Telefon	Phone		string	Kullanıcının telefon numarası.
RoleId	RoleId		integer	Kullanıcının RoleId değeri - (Yönetici: 1, Kullanıcı: 3, Power User: 5).
IsActive	IsActive		boolean	Kullanıcının etkin durumu.
EPTTEnabled	EPTTEnabled		boolean	Kullanıcı için Gelişmiş Konuşmaya Gönder özelliğinin durumu: boole.
EPTTNumber	EPTTNumber		string	Kullanıcı: dize için Gelişmiş Konuşmaya Gönder özelliğinin telefon numarası.
EPTTWebMDN	EPTTWebMDN		string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan telefon numarası - Kodiak tarafından sağlanır.
EPTTToken	EPTTToken		string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan API Belirteci - Kodiak tarafından sağlanır.
GPSEnabled	GPSEnabled		boolean	Kullanıcı için GPS Özelliğinin Durumu.
MobileOnly	MobileOnly		boolean	CAB için masaüstü web uygulaması erişiminin durumu - (WebApp Erişimi Yok: True, Tam Uygulama Erişimi: False).
LicenseType	LicenseType		integer	Kullanıcıya atanan Lisans Türü: - Undefined için 0, Normal için 1, WebOnly için 2 ve Çalışan için 3.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Mevcut bir coğrafi konumu güncelleştirme

İşlem Kimliği:: GeofenceController_UpdateGeofence

Mevcut bir coğrafi konumu kimliğine göre güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	integer	Geofence Kimliği.
GroupNames	GroupNames		array of string	GeofenceUpdateApiModel'in GroupPath'leri.
Enlem	Latitude		double
Boylam	Longitude		double
İsim	Name		string	GeofenceApiModelBase adı.
Türü	Type		string	GeofenceApiModel türü.
Shape	Shape		integer	Şekil: Daire için 0, çokgen için 1.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
Yarıçap	Radius		double	GeofenceApiModel'in yarıçapı.
UseGeofenceAddress	UseGeofenceAddress		boolean	GeofenceApiModel'in UseGeofenceAddress.
useMetric	useMetric		boolean	Ölçüm sistemini kullan veya kullanma.
coğrafi kod	geocode		boolean	Adres coğrafi olarak kodlanmış olmalı veya kodlanmamalıdır.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Olay akışı ile web kancası geri çağırma

İşlem Kimliği:: EventController_subscribe_callback

Bu örnek yöntem, olaylar/abone olun tarafından müşteri tarafından sağlanan URL kullanılarak olay veri akışını geri göndermek için kullanılır.

Parametreler

Name	Anahtar	Tür	Description
Kimlik	Id	string	WebHookSubscriptionParamsApiModel adresini içeren URL.
EtkinlikTürü	EventType	integer
EventCode	EventCode	string
EventTime	EventTime	date-time	Yerel ve Uzaklık ile ISO biçimi.
DeviceId	DeviceId	string	Abonelikle ilişkili GpsDeviceDto Kimliği.
CihazTürü	DeviceType	integer	GpsDeviceDto türü: Ahize (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Kullanıcı Kimliği.
Araç Kimliği	VehicleId	integer	Araç Kimliği.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Bir kullanıcının araca bağlı olup olmadığı.
Lat	Lat	double	Enlem.
Lon	Lon	double	Boylam.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Olay parametreleri.

Döndürülenler

response: object

Olay web kancası abonelik durumunu sıfırlar

İşlem Kimliği:: EventController_ResetSubscriptionHealthStatus

Abonelik durumunu durum = 1 ("Çalışıyor") olarak değiştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
subscriptionId	subscriptionId	True	integer	Abonelik kimliği.

Olay web kancası aboneliklerinin listesini alma

İşlem Kimliği:: EventController_GetSubscriptions

Olay web kancası aboneliklerinin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak SubscriptionId değerine göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Döndürülenler

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Olaylar web kancası aboneliğini kaldırma

İşlem Kimliği:: EventController_RemoveEventDataFeedSubscription

Olay web kancası aboneliğini kimliğine göre siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
subscriptionId	subscriptionId	True	string	Silinecek abonelik kimliği.

Olaylar web kancasına abone olma

İşlem Kimliği:: EventController_SubscribeToEventDataFeed

Yeni olaylar web kancası aboneliği ekler. Web kancaları, belirtilen URL'de gerçekleşen şirket olaylarıyla ilgili otomatik bildirimler almanıza olanak tanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bağlantı	Url		string	WebHookSubscriptionParamsApiModel adresini içeren URL.
SecurityToken	SecurityToken		string	Bu WebHookSubscriptionParamsApiModel ile ilişkili Güvenlik Belirteci.

Döndürülenler

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Olayların listesini alma

İşlem Kimliği:: EventController_GetEvents

Belirli bir zaman aralığına ait olayların listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz.

Belirli olayları almak için olay türüne göre filtreleyin. Çalışan araçla ilişkiliyse, çalışan için araç olayları iade edilebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
fromDate	fromDate	True	date-time	Tarih aralığı başlangıcı.
toDate	toDate	True	date-time	Tarih aralığı sonu.
çalışanNumarası	employeeNumber		string	Çalışan numarası.
vehicleNumber	vehicleNumber		string	Araç numarası.
pageNumber	pageNumber		integer	Başlangıç sayfası numarası.
pageSize	pageSize		integer	Sayfa boyutu.
eventType	eventType		integer	Olay türüne göre filtreleyin. çalışan numarası belirtildi: UserEvents(0) - yalnızca kullanıcı olayları. VehicleEvents(1) - sensör olayları dahil olmak üzere yalnızca araç olayları. ExternalEvents(2) - yalnızca dış olaylar. araç numarası belirtilir: UserEvents(0) - Yok. VehicleEvents(1) - sensör olayları dahil olmak üzere yalnızca araç olayları. ExternalEvents(2) - yalnızca dış olaylar. Ne çalışan numarası ne de araç numarası belirtilmemiştir: UserEvents(0) - yalnızca kullanıcı olayları. VehicleEvents(1) - sensör olayları dahil olmak üzere yalnızca araç olayları. ExternalEvents(2) - yalnızca dış olaylar.

Döndürülenler

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Olayı gönderme

İşlem Kimliği:: EventController_Post

Olayı gönderir.

Parametreler

Name	Anahtar	Tür	Description
EventDefinitionId	EventDefinitionId	string	Olay Tanımı Kimliği.
EmployeeNumber	EmployeeNumber	string	Çalışan numarası.
Araç Numarası	VehicleNumber	string	Araç numarası.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto seri numarası.
Enlem	Latitude	double
Boylam	Longitude	double
Adres satırı 1	AddressLine1	string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2	string	Bu LocationApiModel'in AddressLine2.
City	City	string	LocationApiModel şehri.
BölgeAdı	RegionName	string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode	string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode	string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName	string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode	string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode	string	LocationApiModel'in Bölge Kodu.
Time	Time	date-time
Parametreler	Parameters	object	Olay parametreleri.

Sipariş alma

İşlem Kimliği:: OrderController_GetOrder

Var olan bir siparişi kimliğine göre alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
include-status-history	include-status-history		string	True ise, yanıt bu siparişin tüm durum geçmişini ve form verilerini içerir.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.Order.OrderApiModel

Sipariş durumunu güncelleştirme

İşlem Kimliği:: OrderController_ChangeStatus

Mevcut sipariş durumunu değiştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
EmployeeNumber	EmployeeNumber	True	string	Bu NewOrderStatusApiModel'i oluşturan Kullanıcının EmployeeNumber değeri.
StatusLabel	StatusLabel	True	string	Bu NewOrderStatusApiModel ile ilişkili StatusLabel için etiket içeriği.
StatusStartDateTime	StatusStartDateTime	True	date-time	Bu NewOrderStatusApiModel Durumunun başlatıldığı zamanın belirli bir noktasında.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Sipariş oluşturma

İşlem Kimliği:: OrderController_Create

Yeni bir sipariş ekler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
OluşturmaTarihZaman	CreatedDateTime		date-time	Bu CreateUpdateOrderApiModel'in oluşturulduğu noktada.
ExternalClientId	ExternalClientId	True	string	İstemci - API Uzantısı Özelliği için Dış Kullanım Kimliği.
ServiceType	ServiceType	True	string	Bu CreateUpdateOrderApiModel ile ilişkili hizmet türü.
ExternalOrderId	ExternalOrderId		string	İstemci - API Uzantısı Özelliği için Dış Kullanım OrderId değeri.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
İsim	Name		string	ContactApiModel'in adı.
Telefon Numarası	PhoneNumber		string	ContactApiModel'in Telefon Numarası.
E-posta	Email		string	ContactApiModel'in e-postası.
DueDate	DueDate		date-time	Bu BaseUpdateOrderApiModel'in tamamlanmasının zamanı geldi (v1.3'te kullanımdan kaldırıldı).
StartTime	StartTime		date-time	Bu BaseUpdateOrderApiModel'in başlaması gereken belirli bir nokta (v1.3'te kullanıma sunulmuştur).
EndTime	EndTime		date-time	Bu BaseUpdateOrderApiModel'in bitmesi gereken belirli bir nokta (v1.3'te kullanıma sunulmuştur).
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
EmployeeNumber	EmployeeNumber	True	string	Bu NewOrderStatusApiModel'i oluşturan Kullanıcının EmployeeNumber değeri.
StatusLabel	StatusLabel	True	string	Bu NewOrderStatusApiModel ile ilişkili StatusLabel için etiket içeriği.
StatusStartDateTime	StatusStartDateTime	True	date-time	Bu NewOrderStatusApiModel Durumunun başlatıldığı zamanın belirli bir noktasında.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
FieldIndex	FieldIndex		integer	Alan dizini.
Değer	Value			Alan değeri.
coğrafi kod	geocode		boolean	Adres coğrafi olarak kodlanmış olmalı veya kodlanmamalıdır.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Siparişi güncelleştirme

İşlem Kimliği:: OrderController_Update

Mevcut bir siparişi güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Dış veya iç kimlik, use-external-id parametresindeki değere bağlıdır.
ExternalOrderId	ExternalOrderId		string	İstemci - API Uzantısı Özelliği için Dış Kullanım OrderId değeri.
IsClosed	IsClosed		boolean	UpdateOrderApiModel'in kapalı olup olmadığını gösteren durum.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
İsim	Name		string	ContactApiModel'in adı.
Telefon Numarası	PhoneNumber		string	ContactApiModel'in Telefon Numarası.
E-posta	Email		string	ContactApiModel'in e-postası.
DueDate	DueDate		date-time	Bu BaseUpdateOrderApiModel'in tamamlanmasının zamanı geldi (v1.3'te kullanımdan kaldırıldı).
StartTime	StartTime		date-time	Bu BaseUpdateOrderApiModel'in başlaması gereken belirli bir nokta (v1.3'te kullanıma sunulmuştur).
EndTime	EndTime		date-time	Bu BaseUpdateOrderApiModel'in bitmesi gereken belirli bir nokta (v1.3'te kullanıma sunulmuştur).
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
EmployeeNumber	EmployeeNumber	True	string	Bu NewOrderStatusApiModel'i oluşturan Kullanıcının EmployeeNumber değeri.
StatusLabel	StatusLabel	True	string	Bu NewOrderStatusApiModel ile ilişkili StatusLabel için etiket içeriği.
StatusStartDateTime	StatusStartDateTime	True	date-time	Bu NewOrderStatusApiModel Durumunun başlatıldığı zamanın belirli bir noktasında.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
Enlem	Latitude		double
Boylam	Longitude		double
Adres satırı 1	AddressLine1		string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2		string	Bu LocationApiModel'in AddressLine2.
City	City		string	LocationApiModel şehri.
BölgeAdı	RegionName		string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode		string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode		string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName		string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode		string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode		string	LocationApiModel'in Bölge Kodu.
Başlık	Caption	True	string
Değer	Value			UpdateFormFieldApiModel değeri. "NFC" alan değeri biçimi: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } "Kamera" alan değeri biçimi (ikili başvuru): { "BinaryId": dize, // Karşıya yüklenen görüntünün ikili kimliği (bkz. ikili API'yi karşıya yükleme) "Not": dize // Başvuruda bulunılan görüntü için not } "İmza" alan değeri biçimi (ikili başvuru): { "BinaryId": karşıya yüklenen görüntünün dizesi // İkili Kimliği (bkz. ikili API'yi karşıya yükleme) } "Ses" alan değeri biçimi (ikili başvuru): { "BinaryId": string, // Karşıya yüklenen bir sesin ikili kimliği (bkz. ikili API'yi karşıya yükleme) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Belirli bir noktaya değer yakalandı.
FieldIndex	FieldIndex		integer	Alan dizini.
Değer	Value			Alan değeri.
coğrafi kod	geocode		boolean	Adres coğrafi olarak kodlanmış olmalı veya kodlanmamalıdır.
use-external-id	use-external-id		boolean	Dış kimlik kullan veya kullanma.

Döndürülenler

Body: CustomerAPI.Models.ReturnIdApiModel

Siparişlerin listesini alma

İşlem Kimliği:: OrderController_GetOrders

Aşağıda gösterilen istek parametrelerindeki filtreleri kullanarak siparişlerin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak Client.Name göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
dueDateFrom	dueDateFrom	True	date-time	Son tarih başlangıç tarihine göre filtreleyin.
dueDateTo	dueDateTo	True	date-time	Son tarih bitiş tarihine göre filtreleyin.
çalışanNumarası	employeeNumber		string	Çalışan numarasına göre filtreleyin.
pageNumber	pageNumber		integer	Başlangıç Sayfası numarası (varsayılan 1).
pageSize	pageSize		integer	Sayfa boyutu (varsayılan 500).

Döndürülenler

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Yolculukların listesini alma

İşlem Kimliği:: TrackingController_GetTrips

Belirli bir zaman aralığı için seyahatlerin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak StartUtcTIme'ye göre ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
fromDate	fromDate	True	date-time	Tarih aralığı başlangıcı. Öneri: Lütfen küçük tarih aralıkları yerine büyük tarih aralıklarını (>=4 saat) kullanın.
toDate	toDate	True	date-time	Tarih aralığı sonu. Öneri: Lütfen küçük tarih aralıkları yerine büyük tarih aralıklarını (>=4 saat) kullanın.
çalışanNumarası	employeeNumber		string	Çalışan numarası.
Vin	vin		string	Aracın VIN numarası.
pageNumber	pageNumber		integer	Başlangıç sayfası numarası. Varsayılan değer 1'dir.
pageSize	pageSize		integer	Sayfa boyutu. Varsayılan değer 1000’dir.
useMetric	useMetric		boolean	Ölçüm sistemini kullan veya kullanma.

Döndürülenler

response: array of CustomerAPI.Models.Tracking.TripApiModel

Zaman tutma girdilerinin listesini alma

İşlem Kimliği:: TimekeepingController_GetTimekeepingDataList

Tarih aralığına göre zaman tutma girdilerinin listesini alır. Döndürülen sayfa sayısını ve sayfa başına öğe sayısını belirtebilirsiniz. Sonuçlar otomatik olarak ClockInTime, timekeepingStatusId ve artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
fromDate	fromDate	True	date-time	Başlangıç tarihi.
toDate	toDate	True	date-time	Bitiş tarihi.
çalışanNumarası	employeeNumber		string	Çalışan numarası.
onaylı	approved		boolean	Yalnızca onaylanan giriş için filtreleyin.
closedOnly	closedOnly		boolean	Yalnızca kapalı giriş için filtreleyin.
excludeFormData	excludeFormData		boolean	Form verilerini dışlamak için filtreleyin.
pageNumber	pageNumber		integer	Başlangıç Sayfası numarası (varsayılan 1).
pageSize	pageSize		integer	Sayfa boyutu (varsayılan 1000).

Döndürülenler

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Zaman tutma girdisi alma

İşlem Kimliği:: TimekeepingController_GetTimekeepingEntryAsync

Kimliğine göre bir girdi alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Kaydın kimliği.

Döndürülenler

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Özel liste kaydı oluşturma veya güncelleştirme

İşlem Kimliği:: CustomListController_PutRecord

Özel liste veri kaydını oluşturur veya güncelleştirir. Benzersiz sütunun değeri atlanabilir, ancak varsa sorgu parametresindeki Benzersiz Kimlik değeriyle eşleşmelidir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
customListId	customListId	True	integer	Özel liste kimliği.
kimlik	id	True	string	Benzersiz değer.
ColumnIndex	ColumnIndex		integer	Özel liste sütun dizini.
Başlık	Caption		string	Özel liste sütun başlığı.
Değer	Value			Özel liste sütun değeri.

Özel liste kaydını silme

İşlem Kimliği:: CustomListController_DeleteRecord

Özel listedeki mevcut kaydı customListId ve kimliğiyle siler.

id - özel liste kaydının benzersiz değeridir.

Hata:

404 - customListId veya kimlik bulunamadı.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
customListId	customListId	True	integer	Özel liste kimliği.
kimlik	id	True	string	Benzersiz değer.

Özel liste tanımlarını alma

İşlem Kimliği:: CustomListController_Get

Özel Liste tanımı listesini alır. Tanım listesi, mevcut tüm özel listeler için CustomListID, Name ve Version içerir.

Döndürülenler

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Özel listeden tek kayıt alma

İşlem Kimliği:: CustomListController_GetSingleRecord

CustomListId ve benzersiz sütun değeri tarafından bulunan tek bir özel liste veri kaydını alır.

Hata:

404 - sağlanan customListId ve benzersiz sütun değeri için özel liste kaydı yok

Parametreler

Name	Anahtar	Gerekli	Tür	Description
customListId	customListId	True	integer	Özel liste kimliği.
kimlik	id	True	string	Benzersiz değer.

Döndürülenler

Özel liste sütunu veri dizisi için kapsayıcı.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Özel olay tanımlarının listesini alma

İşlem Kimliği:: EventController_GetList

Özel olay tanımlarının listesini alır.

Döndürülenler

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Özel olay tanımı oluşturma veya güncelleştirme

İşlem Kimliği:: EventController_Put

Özel bir olay tanımı oluşturur veya güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Olay tanımı kimliği.
İsim	Name		string
ReverseGeocode	ReverseGeocode		boolean
İsim	Name		string
Türü	Type		integer
Başlık	Caption		string
Gerekli	Required		boolean

Özel olay tanımını silme

İşlem Kimliği:: EventController_Delete

Özel olay tanımını siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
kimlik	id	True	string	Olay tanımı kimliği.

Tetikleyiciler

Form veri yoklaması	Forms API yoklama uç noktası, uygulamanızın son zamanlarda gönderilen tek başına formları sürekli yoklamasını ve işlemesini sağlar. Entegrasyon: Bu uç nokta, yoklama tetikleyicisi tümleştirmesi olarak Microsoft Flow ile kullanıma uygun şekilde tasarlanmıştır. Alternatif olarak, herhangi bir dili kullanarak kendi özel tümleştirmenizi geliştirebilirsiniz. Kullanım: Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır: HTTP Yanıt kodu 200 - Son gönderilen form kayıtları var; yanıt gövdesi form verilerini görüntüler. HTTP Yanıt kodu 202 - Son gönderilen kayıt yok; yanıt gövdesi boş olacaktır. Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır: Konum - Sonraki isteğin URL'si. Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur. Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. Formların istekte eksik olmadığından emin olmak için gereken parametreleri içerdiğinden URL'ye daha fazla parametre eklemeyin. Sonuçlar otomatik olarak ModifiedUtc ve ardından FormHeaderId ölçütüne göre artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz. ModifiedUtc tanımı: iç zaman etiketi = en son form veri değişikliği zamanı.
Sipariş durumları yoklaması	Sipariş Durumları API'sinin yoklama uç noktası, uygulamanızın siparişlerde yapılan son değişiklikleri sürekli yoklamasını ve işlemesini sağlar. Entegrasyon: Bu uç nokta, yoklama tetikleyicisi tümleştirmesi olarak Microsoft Flow ile kullanıma uygun şekilde tasarlanmıştır. Alternatif olarak, herhangi bir dili kullanarak kendi özel tümleştirmenizi geliştirebilirsiniz. Kullanım: Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır: HTTP Yanıt kodu 200 - Son değiştirilen sipariş durumu kayıtları var; yanıt gövdesi sipariş durumu verilerini görüntüler HTTP Yanıt kodu 202 - Son gönderilen kayıt yok; yanıt gövdesi boş olacaktır. Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır: Konum - Sonraki isteğin URL'si. Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur. Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. Sipariş durumlarının istekte eksik olmadığından emin olmak için gerekenleri içerdiğinden URL'ye daha fazla parametre eklemeyin. Sonuçlar ModifiedUtc ve ardından StatusId değerine göre artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz. ModifiedUtc tanımı: iç saat etiketi = en son sipariş durumu veri değişikliğinin zamanı.
Sipariş yoklaması	Orders API yoklama uç noktası, uygulamanızın siparişlerde yapılan son değişiklikleri sürekli yoklamasını ve işlemesini sağlar. Entegrasyon: Bu uç nokta, yoklama tetikleyicisi tümleştirmesi olarak Microsoft Flow ile kullanıma uygun şekilde tasarlanmıştır. Alternatif olarak, herhangi bir dili kullanarak kendi özel tümleştirmenizi geliştirebilirsiniz. Kullanım: Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır: HTTP Yanıt kodu 200 - Son değiştirilen siparişler mevcut; yanıt gövdesi sipariş verilerini görüntüler. HTTP Yanıt kodu 202 - Yakın zamanda değiştirilen sipariş yok; yanıt gövdesi boş olacaktır. Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır: Konum - Sonraki isteğin URL'si. Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur. Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. Sipariş değişikliklerinin istekte eksik olmadığından emin olmak için gereken parametreleri içerdiğinden URL'ye daha fazla parametre eklemeyin. Sonuçlar otomatik olarak ModifiedUtc ve ardından OrderId değerlerine göre artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz. ModifiedUtc tanımı: iç saat etiketi = en son sipariş veri değişikliğinin zamanı.
Zaman tutma yoklaması	Zaman Tutma API'sinin yoklama uç noktası, uygulamanızın son gönderilen zaman tutma girdilerini sürekli olarak yoklamasını ve işlemesini sağlar. Entegrasyon: Bu uç nokta, yoklama tetikleyicisi tümleştirmesi olarak Microsoft Flow ile kullanıma uygun şekilde tasarlanmıştır. Alternatif olarak, herhangi bir dili kullanarak kendi özel tümleştirmenizi geliştirebilirsiniz. Kullanım: Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır: HTTP Yanıt kodu 200 - Son gönderilen zaman tutma kayıtları var; yanıt gövdesi, zaman tutma girdi verilerini görüntüler. HTTP Yanıt kodu 202 - Son gönderilen kayıt yok; yanıt gövdesi boş olacaktır. Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır: Konum - Sonraki isteğin URL'si. Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur. Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. İSTEKte zaman tutma girdilerinin eksik olmadığından emin olmak için gerekenleri içerdiğinden URL'ye daha fazla parametre eklemeyin. Sonuçlar otomatik olarak ModifiedUtc ve timekeepingStatusId ve sonra artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz. ModifiedUtc tanımı: iç zaman etiketi = en son zaman tutma durumu değişikliğinin zamanı.

Form veri yoklaması

İşlem Kimliği:: FormController_Poll

Forms API yoklama uç noktası, uygulamanızın son zamanlarda gönderilen tek başına formları sürekli yoklamasını ve işlemesini sağlar.

Entegrasyon:

Bu uç nokta, yoklama tetikleyicisi tümleştirmesi olarak Microsoft Flow ile kullanıma uygun şekilde tasarlanmıştır. Alternatif olarak, herhangi bir dili kullanarak kendi özel tümleştirmenizi geliştirebilirsiniz.

Kullanım:

Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır:

HTTP Yanıt kodu 200 - Son gönderilen form kayıtları var; yanıt gövdesi form verilerini görüntüler.
HTTP Yanıt kodu 202 - Son gönderilen kayıt yok; yanıt gövdesi boş olacaktır.

Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır:

Konum - Sonraki isteğin URL'si.
Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur.

Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. Formların istekte eksik olmadığından emin olmak için gereken parametreleri içerdiğinden URL'ye daha fazla parametre eklemeyin.

Sonuçlar otomatik olarak ModifiedUtc ve ardından FormHeaderId ölçütüne göre artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

ModifiedUtc tanımı: iç zaman etiketi = en son form veri değişikliği zamanı.

Döndürülenler

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Sipariş durumları yoklaması

İşlem Kimliği:: OrderController_StatusPoll

Sipariş Durumları API'sinin yoklama uç noktası, uygulamanızın siparişlerde yapılan son değişiklikleri sürekli yoklamasını ve işlemesini sağlar.

Entegrasyon:

Kullanım:

Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır:

HTTP Yanıt kodu 200 - Son değiştirilen sipariş durumu kayıtları var; yanıt gövdesi sipariş durumu verilerini görüntüler
HTTP Yanıt kodu 202 - Son gönderilen kayıt yok; yanıt gövdesi boş olacaktır.

Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır:

Konum - Sonraki isteğin URL'si.
Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur.

Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. Sipariş durumlarının istekte eksik olmadığından emin olmak için gerekenleri içerdiğinden URL'ye daha fazla parametre eklemeyin.

Sonuçlar ModifiedUtc ve ardından StatusId değerine göre artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

ModifiedUtc tanımı: iç saat etiketi = en son sipariş durumu veri değişikliğinin zamanı.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
excludeFormData	excludeFormData		boolean	True ise, FieldValues her zaman boş bir dizi olur.

Döndürülenler

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Sipariş yoklaması

İşlem Kimliği:: OrderController_Poll

Orders API yoklama uç noktası, uygulamanızın siparişlerde yapılan son değişiklikleri sürekli yoklamasını ve işlemesini sağlar.

Entegrasyon:

Kullanım:

Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır:

HTTP Yanıt kodu 200 - Son değiştirilen siparişler mevcut; yanıt gövdesi sipariş verilerini görüntüler.
HTTP Yanıt kodu 202 - Yakın zamanda değiştirilen sipariş yok; yanıt gövdesi boş olacaktır.

Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır:

Konum - Sonraki isteğin URL'si.
Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur.

Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. Sipariş değişikliklerinin istekte eksik olmadığından emin olmak için gereken parametreleri içerdiğinden URL'ye daha fazla parametre eklemeyin.

Sonuçlar otomatik olarak ModifiedUtc ve ardından OrderId değerlerine göre artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

ModifiedUtc tanımı: iç saat etiketi = en son sipariş veri değişikliğinin zamanı.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
excludeFormData	excludeFormData		boolean	True ise, OrderFormFields her zaman boş bir dizi olacaktır.
excludeCustomFieldData	excludeCustomFieldData		boolean	True ise CustomFields döndürülmeyecektir.

Döndürülenler

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

Zaman tutma yoklaması

İşlem Kimliği:: TimekeepingController_Poll

Zaman Tutma API'sinin yoklama uç noktası, uygulamanızın son gönderilen zaman tutma girdilerini sürekli olarak yoklamasını ve işlemesini sağlar.

Entegrasyon:

Kullanım:

Tipik bir senaryoda, bu uç noktaya yapılan ilk istek herhangi bir parametre sağlamamalıdır. İki (2) olası başarılı yanıt vardır:

HTTP Yanıt kodu 200 - Son gönderilen zaman tutma kayıtları var; yanıt gövdesi, zaman tutma girdi verilerini görüntüler.
HTTP Yanıt kodu 202 - Son gönderilen kayıt yok; yanıt gövdesi boş olacaktır.

Her iki durumda da yanıtta iki (2) önemli üst bilgi vardır:

Konum - Sonraki isteğin URL'si.
Retry-After - Sonraki istek için saniye cinsinden önerilen zaman aralığı. Örneğin, alınacak veriler varsa, Retry-After üst bilgisinin değeri 1 veya 60 olur. Alınacak veri yoksa, Retry-After üst bilgisinin değeri 300 olur.

Not: Bunlar yalnızca önerilen değerlerdir. Uygulamanız gereksinimlerinize bağlı olarak farklı bir sıklıkta yoklamayı seçebilir. İlk istek sonrasında, izleyen tüm istekler en son yanıtın Konum üst bilgisinde sağlanan URL'yi kullanmalıdır. İSTEKte zaman tutma girdilerinin eksik olmadığından emin olmak için gerekenleri içerdiğinden URL'ye daha fazla parametre eklemeyin.

Sonuçlar otomatik olarak ModifiedUtc ve timekeepingStatusId ve sonra artan düzende sıralanır. Sıralama parametreleri yapılandırılamaz.

ModifiedUtc tanımı: iç zaman etiketi = en son zaman tutma durumu değişikliğinin zamanı.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
excludeFormData	excludeFormData		boolean	True ise, ClockInFormData ve ClockOutFormData her zaman null olur.

Döndürülenler

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Tanımlar

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Name	Yol	Tür	Description
Kimlik	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Name	Yol	Tür	Description
Kimlik	Id	integer	İstemcinin kimliği.
ExternalId	ExternalId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım Kimliği.
CreatedUtc	CreatedUtc	date-time	İstemcinin oluşturulduğu özgün nokta.
ModifiedUtc	ModifiedUtc	date-time	İstemcinin güncelleştirilmiş olduğu son nokta.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
İsim	Name	string	İstemcinin adı.
Adres	Address	CustomerAPI.Models.LocationApiModel
İletişim	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name	Yol	Tür	Description
FieldIndex	FieldIndex	integer	Alan dizini.
Başlık	Caption	string	Alan başlığı.
Veri Türü	DataType	integer	Alan veri türü.
DateTimeFormat	DateTimeFormat	integer	DateTime biçimi.
Değer	Value		Alan değeri.

CustomerAPI.Models.LocationApiModel

Name	Yol	Tür	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Adres satırı 1	AddressLine1	string	Bu LocationApiModel'in AddressLine1.
Adres Satırı 2	AddressLine2	string	Bu LocationApiModel'in AddressLine2.
City	City	string	LocationApiModel şehri.
BölgeAdı	RegionName	string	LocationApiModel'in Bölge Adı.
Posta Kodu	PostalCode	string	LocationApiModel'in Posta Kodu.
Ülke Kodu	CountryCode	string	ISO 3166-1 alfa-2 kodu.
SubRegionName	SubRegionName	string	LocationApiModel'in AltBölgesi.
SubRegionCode	SubRegionCode	string	LocationApiModel'in Alt Bölge Kodu.
RegionCode	RegionCode	string	LocationApiModel'in Bölge Kodu.

CustomerAPI.Models.Client.ContactApiModel

Name	Yol	Tür	Description
İsim	Name	string	ContactApiModel'in adı.
Telefon Numarası	PhoneNumber	string	ContactApiModel'in Telefon Numarası.
E-posta	Email	string	ContactApiModel'in e-postası.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Name	Yol	Tür	Description
Enlem	Latitude	double
Boylam	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Name	Yol	Tür	Description
Kimlik	Id	integer	Nesne Kimliği.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Özel Liste Tanımı Liste Öğesi API Modeli tanımlar.

Name	Yol	Tür	Description
CustomListId	CustomListId	integer	Özel Liste Kimliği.
İsim	Name	string	Özel Liste Adı.
Sürüm	Version	string	Özel Liste Sürümü.

CustomerAPI.Models.CustomLists.CustomListApiModel

Özel Liste Modeli.

Name	Yol	Tür	Description
CustomListId	CustomListId	integer	Özel Liste Kimliği.
İsim	Name	string	Özel Liste Adı.
Sürüm	Version	string	Özel Liste Sürümü.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Özel Liste tanımı API modelini tanımlar.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Özel Liste tanımı API modelini tanımlar.

Name	Yol	Tür	Description
Kolonlar	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Özel Liste Sütunları.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Benzersiz Sütun Dizini.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Özel Liste Tanımı Sütun API Modeli tanımlar.

Name	Yol	Tür	Description
Index	Index	integer	Sütun Dizini.
Veri Türü	DataType	integer	DataType Sütunu (Metin: 0, Sayısal: 1, Tarih: 2, Saat: 3, Tarih Saat: 4, E-posta: 5).
İsim	Name	string	Sütun Adı.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Özel liste sütunu veri dizisi için kapsayıcı.

Name	Yol	Tür	Description
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Veri içeren sütun dizisi.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Bu model özel liste sütun değerini tanımlar.

Name	Yol	Tür	Description
ColumnIndex	ColumnIndex	integer	Özel liste sütun dizini.
Başlık	Caption	string	Özel liste sütun başlığı.
Değer	Value		Özel liste sütun değeri.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Özel Olay Tanımı Modeli.

Name	Yol	Tür
Kimlik	Id	string
İsim	Name	string
ReverseGeocode	ReverseGeocode	boolean
Parametreler	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Name	Yol	Tür
İsim	Name	string
Türü	Type	integer
Başlık	Caption	string
Gerekli	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Name	Yol	Tür	Description
EventId	EventId	integer	Olay Kimliği.
EtkinlikTürü	EventType	integer
EventCode	EventCode	string	Olay kodu.
EventTime	EventTime	date-time	Yerel ve Uzaklık ile ISO biçimi.
User	User	CustomerAPI.Models.UserReferenceApiModel
Araç	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Etkinleştirilirse olayın aracı kullanıcı atamıştır.
Yer	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	Dış olay tanımı kimliği.
EventParams	EventParams	object	Olay parametreleri.

CustomerAPI.Models.UserReferenceApiModel

Name	Yol	Tür	Description
UserId	UserId	integer	Kullanıcının Kullanıcı Kimliği.
İlk İsim	FirstName	string	Kullanıcının adı.
Soyadı	LastName	string	Kullanıcının soyadı.
EmployeeNumber	EmployeeNumber	string	Kullanıcının çalışan numarası.
GroupName	GroupName	string	Kullanıcıya atanan Grubun adı.

CustomerAPI.Models.ReadVehicleApiModel

Name	Yol	Tür	Description
Araç Kimliği	VehicleId	integer	BaseVehicleApiModel kimliği.
İsim	Name	string	BaseVehicleApiModel'in adı.
VİN	VIN	string	BaseVehicleApiModel'in Araç Kimlik Numarası.
Cihaz İsmi	DeviceName	string	BaseVehicleApiModel ile ilişkili GpsDeviceDto adı.
Seri Numarası	SerialNumber	string	BaseVehicleApiModel seri numarası.
GroupName	GroupName	string	BaseVehicleApiModel'in GroupName değeri.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Name	Yol	Tür	Description
GeofenceId	GeofenceId	integer	Geofence kimliği.
İsim	Name	string	Geofence adı.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name	Yol	Tür	Description
Abonelik Numarası	SubscriptionId	string	WebHookSubscriptionResultApiModel kimliği.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name	Yol	Tür	Description
Abonelik Numarası	SubscriptionId	string
Bağlantı	Url	string
Statü	Status	integer	Abonelik durumu - (Çalışıyor: 1, Durduruldu: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name	Yol	Tür	Description
Kimlik	Id	integer	Bu StandaloneFormApiModel ile ilişkilendirilmiş kimlik - (Eski açıklama: FormHeaderId).
Form Kimliği	FormId	integer	Bu StandaloneFormApiModel tarafından başvuruda bulunılan Formun kimliği.
Form Adı	FormName	string	Bu StandaloneFormApiModel tarafından başvuruda bulunılan Formun adı.
EntryNumber	EntryNumber	string	Form veri giriş numarası.
Incelendi	Reviewed	boolean	Bu StandaloneFormApiModel gözden geçirmesinin durumu.
User	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	StandaloneFormApiModel'in gönderildiği zamanın belirli bir noktası.
StartTime	StartTime	date-time	StandaloneFormApiModel'in başlatıldığında belirli bir noktaya gelin.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Bu StandaloneFormApiModel ile ilişkilendirilmiş Alanların listesi.
ApiModuleId	ApiModuleId	string	Bu StandaloneFormApiModel ile ilişkili ApiModule kimliği.
SharedUrl	SharedUrl	string	Bu StandaloneFormApiModel'in paylaşılan URL'si.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	Form gözden geçirme zamanı

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name	Yol	Tür	Description
Yinelenebilir öğeler	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Kimlik	Id	string	FormFieldDataApiModel kimliği.
Değer	Value		FormFieldDataApiModel değeri.
DisplayValue	DisplayValue		FormFieldDataApiModel'in DisplayValue değeri.
CapturedTime	CapturedTime	date-time	Zaman içindeki nokta değeri FormFieldDataApiModel tarafından yakalandı.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Başlık	Caption	string	FormFieldDataApiModel'in resim yazısı içeriği.
ApiFieldId	ApiFieldId	string	FormFieldDataApiModel apiField kimliği.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name	Yol	Tür	Description
Kimlik	Id	string	FormFieldDataApiModel kimliği.
Değer	Value		FormFieldDataApiModel değeri.
DisplayValue	DisplayValue		FormFieldDataApiModel'in DisplayValue değeri.
CapturedTime	CapturedTime	date-time	Zaman içindeki nokta değeri FormFieldDataApiModel tarafından yakalandı.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Başlık	Caption	string	FormFieldDataApiModel'in resim yazısı içeriği.
ApiFieldId	ApiFieldId	string	FormFieldDataApiModel apiField kimliği.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name	Yol	Tür	Description
GeofenceId	GeofenceId	integer	GeofenceApiModel'in GeofenceId değeri.
CreatedUtc	CreatedUtc	date-time	GeofenceApiModel'in CreatedUtc.
ModifiedUtc	ModifiedUtc	date-time	GeofenceApiModel'in ModifiedUtc.
GroupNames	GroupNames	array of string	GeofenceApiModel'in GroupPath'leri.
İsim	Name	string	GeofenceApiModelBase adı.
Türü	Type	string	GeofenceApiModel türü.
Shape	Shape	integer	Şekil: Daire için 0, çokgen için 1.
Adres	Address	CustomerAPI.Models.LocationApiModel
Yarıçap	Radius	double	GeofenceApiModel'in yarıçapı.
UseGeofenceAddress	UseGeofenceAddress	boolean	GeofenceApiModel'in UseGeofenceAddress.

Actsoft.Core.Geo.LatLon

Name	Yol	Tür	Description
Enlem	Latitude	double
Boylam	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name	Yol	Tür	Description
GeofenceId	GeofenceId	integer	GeofenceApiModel'in GeofenceId değeri.
CreatedUtc	CreatedUtc	date-time	GeofenceApiModel'in CreatedUtc.
ModifiedUtc	ModifiedUtc	date-time	GeofenceApiModel'in ModifiedUtc.
GroupNames	GroupNames	array of string	GeofenceApiModel'in GroupPath'leri.
Poligon	Polygon	array of Actsoft.Core.Geo.LatLon	Çokgen noktalar. Şekil 1'e eşit olduğunda doldurulmalıdır.
İsim	Name	string	GeofenceApiModelBase adı.
Türü	Type	string	GeofenceApiModel türü.
Shape	Shape	integer	Şekil: Daire için 0, çokgen için 1.
Adres	Address	CustomerAPI.Models.LocationApiModel
Yarıçap	Radius	double	GeofenceApiModel'in yarıçapı.
UseGeofenceAddress	UseGeofenceAddress	boolean	GeofenceApiModel'in UseGeofenceAddress.

CustomerAPI.Models.Order.OrderListItemApiModel

Name	Yol	Tür	Description
SiparişNo	OrderId	integer	OrderBaseApiModel kimliği.
ExternalOrderId	ExternalOrderId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım OrderId değeri.
DueDate	DueDate	date-time	Bu OrderBaseApiModel'in tamamlanması gereken süre (v1.3'te kullanım dışı).
StartTime	StartTime	date-time	Bu OrderBaseApiModel'in başlaması gereken belirli bir nokta (v1.3'te kullanıma sunulmuştur).
EndTime	EndTime	date-time	Bu OrderBaseApiModel'in tamamlanması gereken süre (v1.3'te kullanıma sunulmuştur).
ServiceType	ServiceType	string	Bu OrderBaseApiModel ile ilişkili ServiceType.
CreatedUTCDate	CreatedUTCDate	date-time	Bu OrderBaseApiModel'in oluşturulduğu belirli bir noktaya gelin.
Sipariş Numarası	OrderNumber	string	Bu OrderBaseApiModel ile ilişkili Sipariş Numarası.
IsClosed	IsClosed	boolean	OrderBaseApiModel'in kapalı olup olmadığını gösteren durum.
Statü	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım Kimliği.
ClientId	ClientId	integer	İstemci - API Uzantısı Özelliği için iç Kullanım Kimliği.
Müşteri	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Bu OrderBaseApiModel ile İlişkili ApiService kimliği.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Özel alanlar modül sürümü.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Name	Yol	Tür	Description
StatusIndex	StatusIndex	integer	OrderStatusApiModel dizini.
DurumTürü	StatusType	integer	Sipariş durumu: Yeni sipariş için 0, sevk edilenler için 1, devam eden için 2, tamamlanmak üzere 3 ve iptal edilenler için 4.
StatusLabel	StatusLabel	string	OrderStatusApiModel'in içeriğini etiketle.
StatusId	StatusId	integer	OrderStatusApiModel kimliği.
StatusStartDateTime	StatusStartDateTime	date-time	OrderStatusApiModel'in Başlangıç zamanının üzerine gelin.
User	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Name	Yol	Tür	Description
GroupNames	GroupNames	array of string	İstemci grubu hiyerarşik adları.
İsim	Name	string	İstemcinin adı.
Adres	Address	CustomerAPI.Models.LocationApiModel
İletişim	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Name	Yol	Tür	Description
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Bu OrderApiModel ile İlişkili OrderStatusListItems Listesi.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
SiparişNo	OrderId	integer	OrderBaseApiModel kimliği.
ExternalOrderId	ExternalOrderId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım OrderId değeri.
DueDate	DueDate	date-time	Bu OrderBaseApiModel'in tamamlanması gereken süre (v1.3'te kullanım dışı).
StartTime	StartTime	date-time	Bu OrderBaseApiModel'in başlaması gereken belirli bir nokta (v1.3'te kullanıma sunulmuştur).
EndTime	EndTime	date-time	Bu OrderBaseApiModel'in tamamlanması gereken süre (v1.3'te kullanıma sunulmuştur).
ServiceType	ServiceType	string	Bu OrderBaseApiModel ile ilişkili ServiceType.
CreatedUTCDate	CreatedUTCDate	date-time	Bu OrderBaseApiModel'in oluşturulduğu belirli bir noktaya gelin.
Sipariş Numarası	OrderNumber	string	Bu OrderBaseApiModel ile ilişkili Sipariş Numarası.
IsClosed	IsClosed	boolean	OrderBaseApiModel'in kapalı olup olmadığını gösteren durum.
Statü	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım Kimliği.
ClientId	ClientId	integer	İstemci - API Uzantısı Özelliği için iç Kullanım Kimliği.
Müşteri	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Bu OrderBaseApiModel ile İlişkili ApiService kimliği.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Özel alanlar modül sürümü.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name	Yol	Tür	Description
StatusStartDateTime	StatusStartDateTime	date-time	Bu OrderStatusHistoryListItemApiModel Durumunun başlatıldığı belirli bir noktaya gelin.
StatusEndDateTime	StatusEndDateTime	date-time	Bu OrderStatusHistoryListItemApiModel Durumunun sona ererken belirli bir noktaya gelindi.
StatusId	StatusId	integer	Bu OrderStatusHistoryListItemApiModel ile ilişkili kimlik.
StatusIndex	StatusIndex	integer	Bu OrderStatusHistoryListItemApiModel ile ilişkili dizin.
StatusLabel	StatusLabel	string	Bu OrderStatusHistoryListItemApiModel ile ilişkili etiket içeriği.
DurumTürü	StatusType	integer	Sipariş durumu: Yeni sipariş için 0, sevk edilenler için 1, devam eden için 2, tamamlanmak üzere 3 ve iptal edilenler için 4.
ExternalOrderId	ExternalOrderId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım OrderId değeri.
SiparişNo	OrderId	integer	Bu OrderStatusHistoryListItemApiModel ile ilişkili OrderId.
User	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	Bu OrderStatusHistoryListItemApiModel ile ilişkili ApiService kimliği.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Name	Yol	Tür	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
SiparişNo	OrderId	integer	OrderBaseApiModel kimliği.
ExternalOrderId	ExternalOrderId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım OrderId değeri.
DueDate	DueDate	date-time	Bu OrderBaseApiModel'in tamamlanması gereken süre (v1.3'te kullanım dışı).
StartTime	StartTime	date-time	Bu OrderBaseApiModel'in başlaması gereken belirli bir nokta (v1.3'te kullanıma sunulmuştur).
EndTime	EndTime	date-time	Bu OrderBaseApiModel'in tamamlanması gereken süre (v1.3'te kullanıma sunulmuştur).
ServiceType	ServiceType	string	Bu OrderBaseApiModel ile ilişkili ServiceType.
CreatedUTCDate	CreatedUTCDate	date-time	Bu OrderBaseApiModel'in oluşturulduğu belirli bir noktaya gelin.
Sipariş Numarası	OrderNumber	string	Bu OrderBaseApiModel ile ilişkili Sipariş Numarası.
IsClosed	IsClosed	boolean	OrderBaseApiModel'in kapalı olup olmadığını gösteren durum.
Statü	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	İstemci - API Uzantısı Özelliği için Dış Kullanım Kimliği.
ClientId	ClientId	integer	İstemci - API Uzantısı Özelliği için iç Kullanım Kimliği.
Müşteri	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Bu OrderBaseApiModel ile İlişkili ApiService kimliği.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Özel alanlar modül sürümü.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Name	Yol	Tür	Description
Kimlik	Id	integer	Timekeeping girişinin kimliği (eski açıklama: RootSubmittedStatusId).
User	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Kullanıcı sisteme giriş yaparken belirli bir noktaya gelin.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Kullanıcı sistemden çıkış yaparken belirli bir noktaya gelin.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Bu Zaman Tutma girdisi için toplam saat sayısı.
TotalBreakHours	TotalBreakHours	double	Bu Zaman Tutma girdisi için toplam kesme (çalışma dışı) saat sayısı.
NetHours	NetHours	double	Bu Zaman Tutma girişi için ücretlendirilebilen toplam saat sayısı.
Onaylandı	Approved	boolean	Bu Zaman Tutma girdisi için Gözetmen onayının durumu.
Tatili	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
ŞirketModuleId	CompanyModuleId	integer	Bu Zaman Tutma girdisini göndermek için kullanılan Şirket Modülünün kimliği.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name	Yol	Tür	Description
Kimlik	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Başlangıç saati.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Bitiş saati.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Saat cinsinden süre. EndTime null olduğunda null olabilir.
DurumTürü	StatusType	integer	Durum türü: Mola için 1 ve öğle yemeği için 2.
StartLabel	StartLabel	string	Başlangıç etiketi.
EndLabel	EndLabel	string	Bitiş etiketi.
Başlık	Caption	string	Başlık.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Name	Yol	Tür
ŞirketModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Name	Yol	Tür
_Binbaşı	_Major	integer
_Küçük	_Minor	integer
_Yapmak	_Build	integer
_Revizyon	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Name	Yol	Tür	Description
User	User	CustomerAPI.Models.UserReferenceApiModel
Araç	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Bu TripApiModel Durumunun başlatıldığı noktada.
EndTime	EndTime	date-time	Bu TripApiModel Durumunun sona ererken belirli bir noktaya gelindi.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence	StartPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence	EndPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime	TotalStopTime	double	Bu TripApiModel ile ilişkili saat cinsinden durdurma süresi miktarı.
TotalIdleTime	TotalIdleTime	double	Bu TripApiModel ile ilişkili saat cinsinden boşta kalma süresi miktarı.
TotalDuration	TotalDuration	double	Bu TripApiModel ile ilişkili saat cinsinden tam süre.
Mesafe	Distance	double	Bu TripApiModel ile ilişkili yerelleştirilmiş birimlerde seyahat edilen mesafe.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name	Yol	Tür	Description
Kayıtlar	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
DevamToken	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name	Yol	Tür	Description
User	User	CustomerAPI.Models.UserReferenceApiModel
Araç	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	Bu GpsDataRecordApiModel ile ilişkili TimeTag.
Yer	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Bölge Sınırı	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Hız	Speed	double	Bu GpsDataRecordApiModel ile ilişkili hareket hızı.
Heading	Heading	double	Bu GpsDataRecordApiModel ile ilişkili derecelerde pusula yönü.
Statü	Status	integer	OrderBaseApiModel ile ilişkili ApiMovementStatus - (Durduruldu: 1, Boşta: 2, Taşıma: 3, NotTracking: 4) : OrderStatusApiModel.
DurumZamanı	StatusTime	string	Bu GpsDataRecordApiModel Durumunun ayarlandığı noktada.
Mesafe	Distance	double	Bu TripApiModel ile ilişkili yerelleştirilmiş birimlerde kat edilen mesafe.
Ateşleme	IgnitionOn	boolean	Bu GpsDataRecordApiModel ile ilişkili araç ateşleme durumu.
LocationProvider	LocationProvider	integer	Bu GpsDataRecordApiModel ile ilişkili Api Konum Sağlayıcısı - (GPS: 1, Ağ: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name	Yol	Tür	Description
Kullanıcı adı	UserName	string	Kullanıcının UserName'i.
UserId	UserId	integer	Kullanıcının kimlik değeri.
GroupName	GroupName	string	Kullanıcı Grubunun Adı.
İlk İsim	FirstName	string	Kullanıcının adı.
Soyadı	LastName	string	Kullanıcının soyadı.
EmployeeNumber	EmployeeNumber	string	Kullanıcının çalışan numarası.
E-posta	Email	string	Kullanıcının e-posta adresi.
Telefon	Phone	string	Kullanıcının telefon numarası.
RoleId	RoleId	integer	Kullanıcının RoleId değeri - (Yönetici: 1, Kullanıcı: 3, Power User: 5).
IsActive	IsActive	boolean	Kullanıcının etkin durumu.
EPTTEnabled	EPTTEnabled	boolean	Kullanıcı için Gelişmiş Konuşmaya Gönder özelliğinin durumu: boole.
EPTTNumber	EPTTNumber	string	Kullanıcı: dize için Gelişmiş Konuşmaya Gönder özelliğinin telefon numarası.
EPTTWebMDN	EPTTWebMDN	string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan telefon numarası - Kodiak tarafından sağlanır.
EPTTToken	EPTTToken	string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan API Belirteci - Kodiak tarafından sağlanır.
GPSEnabled	GPSEnabled	boolean	Kullanıcı için GPS Özelliğinin Durumu.
MobileOnly	MobileOnly	boolean	CAB için masaüstü web uygulaması erişiminin durumu - (WebApp Erişimi Yok: True, Tam Uygulama Erişimi: False).
LicenseType	LicenseType	integer	Kullanıcıya atanan Lisans Türü: - Undefined için 0, Normal için 1, WebOnly için 2 ve Çalışan için 3.

CustomerAPI.Models.User.ReadUserListItemApiModel

Name	Yol	Tür	Description
UserId	UserId	integer	Kullanıcının kimlik değeri.
İlk İsim	FirstName	string	Kullanıcının adı.
Soyadı	LastName	string	Kullanıcının soyadı.
EmployeeNumber	EmployeeNumber	string	Kullanıcının çalışan numarası.
E-posta	Email	string	Kullanıcının e-posta adresi.
Telefon	Phone	string	Kullanıcının telefon numarası.
RoleId	RoleId	integer	Kullanıcının RoleId değeri - (Yönetici: 1, Kullanıcı: 3, Power User: 5).
IsActive	IsActive	boolean	Kullanıcının etkin durumu.
EPTTEnabled	EPTTEnabled	boolean	Kullanıcı için Gelişmiş Konuşmaya Gönder özelliğinin durumu: boole.
EPTTNumber	EPTTNumber	string	Kullanıcı: dize için Gelişmiş Konuşmaya Gönder özelliğinin telefon numarası.
EPTTWebMDN	EPTTWebMDN	string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan telefon numarası - Kodiak tarafından sağlanır.
EPTTToken	EPTTToken	string	Kodiak EPTT sisteminde Kullanıcının Kimliğini Doğrulamak için kullanılan API Belirteci - Kodiak tarafından sağlanır.
GPSEnabled	GPSEnabled	boolean	Kullanıcı için GPS Özelliğinin Durumu.
MobileOnly	MobileOnly	boolean	CAB için masaüstü web uygulaması erişiminin durumu - (WebApp Erişimi Yok: True, Tam Uygulama Erişimi: False).
LicenseType	LicenseType	integer	Kullanıcıya atanan Lisans Türü: - Undefined için 0, Normal için 1, WebOnly için 2 ve Çalışan için 3.

CustomerAPI.Models.Vehicles.VehicleReadApi

Araç Veri Modeli.

Name	Yol	Tür
InternalId	InternalId	integer
Sayı	Number	string
İsim	Name	string
Türü	Type	string
Etiket	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Yapmak	Make	string
Yıl	Year	integer
Model	Model	string
Renk	Color	string
VİN	VIN	string
IsActive	IsActive	boolean
CihazTürü	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

tamsayı

Bu, 'integer' temel veri türüdür.

object

Bu , 'object' türüdür.

Aracılığıyla paylaş

TeamWherx

Bağlantı oluşturma

Temerrüt

Azaltma Sınırları

Eylemler

Abonelik durumunu sıfırlar

Parametreler

Aboneliklerin listesini alma

Döndürülenler

Aracı güncelleştirme

Parametreler

Döndürülenler

Araç listesi alma

Parametreler

Döndürülenler

Araç oluşturma

Parametreler

Döndürülenler

Bir aracı devre dışı bırakma

Parametreler

Döndürülenler

Bir aracı etkinleştirme

Parametreler

Döndürülenler

Bir aracı kısmi güncelleştirme

Parametreler

Döndürülenler

Bir aracı silme

Parametreler

Bölge oluşturma

Parametreler

Döndürülenler

Coğrafi bölge alma

Parametreler

Döndürülenler

Coğrafi konumların listesini alma

Parametreler

Döndürülenler

Coğrafi konumu silme

Parametreler

CustomListID'ye göre özel liste alanları listesi alma

Parametreler

Döndürülenler

CustomListID tarafından özel liste verileri alma

Parametreler

Döndürülenler

Ek dosyasını karşıya yükleme

Döndürülenler

Form alma

Parametreler

Döndürülenler

Form listesini alma

Parametreler

Döndürülenler

Form oluşturma

Parametreler

Döndürülenler

GPS veri akışı ile Web kancası geri çağırma

Parametreler

Döndürülenler

GPS veri girişlerini alma

Parametreler

Döndürülenler

GPS veri web kancası aboneliğini kaldırma

Parametreler

GPS verilerine abone ol web kancası

Parametreler

Döndürülenler

İkili dosyayı karşıya yükleme

Döndürülenler

İkincil sürümü alma

İstemci alma

Parametreler

Döndürülenler

İstemci oluşturma

Parametreler

Döndürülenler

İstemci silme

Parametreler