TeamWherx

TeamWherx(TW) to platforma zarządzania usługami typu all-in-one, która pomaga efektywniej zarządzać zdalnymi zespołami pracowników i ogólnymi operacjami biznesowymi z dala od biura. Jako rozwiązanie oparte na chmurze usługa TW umożliwia zdalne zbieranie danych i wyświetla je za pośrednictwem pulpitu nawigacyjnego aplikacji internetowej, zapewniając menedżerom dodatkowe szczegółowe informacje potrzebne do tworzenia inteligentniejszych strategii zwiększenia wydajności, produktywności i obniżenia kosztów przy jednoczesnym koordynowaniu pracowników mobilnych.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt
Name	Pomoc techniczna firmy Actsoft
adres URL	https://www.actsoft.com/self-help-wizards
Email	support@actsoft.com

Metadane łącznika
Publisher	Actsoft
Witryna internetowa	https://actsoft.com
Zasady ochrony prywatności	https://www.actsoft.com/privacy
Kategorie	Produktywność

Opis łącznika:

TeamWherx umożliwia tworzenie i przechwytywanie informacji o formularzach cyfrowych, informacji o czasach pracowników i zarządzanie zleceniami pracy za pomocą systemu wysyłania.

Szczegółowy opis

Łącznik TeamWherx umożliwia użytkownikom łączenie się i wymianę informacji między wieloma platformami. Możesz animować dane, aby tworzyć przepływy procesów, napędzać inne aplikacje wewnętrzne i informować o zaawansowanych analizach. Automatyzowanie i usprawnianie codziennych, cotygodniowych lub miesięcznych procesów z dostępem do up-to— momentowych danych z możliwością działania.

## Wymagania wstępne

Aby użyć tego łącznika, potrzebne są następujące elementy:

Konto TeamWherx
Klucz interfejsu API TeamWherx
Plan usługi Microsoft Power Apps lub Power Automate

## Jak uzyskać poświadczenia

Portal deweloperów interfejsu API

Aby uzyskać dostęp do łącznika, musisz najpierw skonfigurować nazwę użytkownika i hasło dla portalu deweloperów interfejsu API i zasubskrybować interfejs API klienta:

W aplikacji przejdź do pozycji Ustawieniaadministracyjne>Konfiguracja>interfejsu API.
Wybierz pozycję Utwórz poświadczenia.
Wprowadź swoje imię i nazwisko w odpowiednich polach.
Wprowadź swój adres e-mail w polu Adres e-mail.
Wybierz pozycję Zapisz i wyślij wiadomość e-mail z zaproszeniem. Następnie sprawdź swój adres e-mail, aby uzyskać instrukcje dotyczące tworzenia hasła.
Po przejściu do wiadomości e-mail z zaproszeniem kliknij pozycję Wybierzhasło, co spowoduje otwarcie okna dialogowego umożliwiającego utworzenie hasła.
Wybierz pozycję Zapisz hasło.
Aby przejść do portalu deweloperów, w aplikacji przejdź do pozycjiUstawienia>administracyjne>Przejdźdo portalu deweloperów.
W portalu deweloperów wybierz pozycję Produkty, a następnie wybierz pozycję Interfejs APIklienta.
Wybierz pozycję Subskrybuj.

Klucz API

Teraz, gdy jesteś zarejestrowanym użytkownikiem interfejsu API, sekwencją alfanumeryczną nazywaną kluczem, została wygenerowana. Ten klucz będzie potrzebny do pracy z danymi w interfejsie API.

Aby zlokalizować klucz interfejsu API:

Wybierz pozycję Produkty z menu Portal deweloperów. Zostaną wyświetlone produkty interfejsu API dostępne w licencji.
Wybierz wersję interfejsu API klienta w obszarze "Masz subskrypcje X do tego produktu".
Wybierz pozycję Pokaż obok klucza podstawowego dla subskrypcji.
Wybierz zawartość pola, kliknij prawym przyciskiem myszy i wybierz polecenie Kopiuj. Klucz jest teraz zapisywany w schowku i gotowy do wklejenia.

## Wprowadzenie do łącznika

Przejdź do pozycji Moje przepływy>Nowy przepływ, a następnie wybierz pozycję Zautomatyzowany przepływ w chmurze.
Wybierz pozycję Ręcznie wyzwól przepływ z okna dialogowego Tworzenie zautomatyzowanego przepływu w chmurze.
Nadaj przepływowi nazwę lub pozwól systemowi automatycznie wygenerować ten przepływ.
Wyszukaj i wybierz wyzwalacz przepływu.
Wybierz pozycję Utwórz.
W polu wyszukiwania wyszukaj i wybierz łącznik TeamWherx.
Znajdź akcję, którą chcesz wykonać za pomocą łącznika.

System wyświetli monit o zalogowanie się do wszystkich aplikacji wymaganych do wykonania wybranej akcji, pomijając wszystkie już zalogowane.

Wprowadź nazwę nowego łącznika w polu Łącznik.
Następnie wprowadź klucz interfejsu API.
Wybierz pozycję Utwórz. Pierwszy krok przepływu procesu jest wyświetlany jako pierwszy "pole" w schemacie blokowym.
Wybierz pozycję Nowykrok , aby kontynuować dodawanie kolejnych akcji i kroków do przepływu procesu łącznika.
Wybierz pozycję Zapisz.

**Korzystanie z łącznika — przykład sondy stanu zamówienia
** W poniższych instrukcjach pokazano, jak utworzyć przepływ procesu w celu wstawienia wierszy w arkuszu i wstawić dane identyfikujące pracownika, który zaktualizował zamówienie po zaktualizowaniu stanu zamówienia.

Przejdź do pozycji Łączniki.
Wyszukaj i wybierz łącznik [TeamWherx].
Wybierz pozycję Sondowanie stanów zamówienia z listy akcji.
Wprowadź nazwę nowego połączenia w polu Nazwa połączenia .
Następnie wprowadź klucz interfejsu API.
Wybierz pozycję Utwórz. Pierwszy krok przepływu procesu jest wyświetlany jako pierwszy "pole" w schemacie blokowym.

Każde okno dialogowe akcji w krokach przepływu połączenia będzie zawierać pola właściwości, które można dostosować, aby kontrolować wykonaną akcję.

Kontynuując przykład, wybierz, czy mają być wyświetlane wartości pól Formularze (parametr excludeFormData).
Wybierz wersję interfejsu X-API dla połączenia.
Wybierz pozycję Następny krok , aby ustawić akcję, którą chcesz wykonać po zmianie stanu zamówienia.
W oknie dialogowym Wybieranie operacji użyj pola wyszukiwania, aby zlokalizować aplikację, a następnie odpowiednią akcję. Jeśli na przykład chcesz wstawić wiersz w arkuszu Google za każdym razem, gdy stan zamówienia zostanie zmieniony, wybierz pozycję Arkusze Google, a następnie pozycję Wstawwiersz dla akcji.
W wyświetlonym poniżej oknie dialogowym Wstawianiewiersza kliknij w polu Plik i wybierz plik, który będzie zawierać wyniki.
W polu Arkusz wybierz typ arkusza danych . Pola, które są wyświetlane dynamicznie, to kolumny danych w arkuszu.
Kliknij pole dla każdej kolumny i wybierz właściwość z listy właściwości sondy Stanu zamówienia . Możesz też użyć pola wyszukiwania, aby znaleźć określoną właściwość.
Możesz wprowadzić więcej niż jedną właściwość w każdym polu kolumny; w kolumnie Zdarzenie wybierz pozycję StatusLabel, wstaw kreskę, a następnie wybierz pozycję StatusStartDate. Oznacza to, że dla każdej aktualizacji stanu zamówienia etykieta stanu i data rozpoczęcia stanu będą zapisywane w kolumnie Zdarzenie w nowym wierszu.
Wybierz pozycję Nowykrok. Na bok możesz zawsze umieścić wskaźnik myszy i kliknąć łącznik strzałki, aby wstawić nowy krok
W oknie dialogowym Wybieranie operacji ponownie wybierz łącznik TeamWherx, a następnie utwórz klienta dla akcji.

Ponownie każde pole wyświetlane w oknie dialogowym będzie reprezentować kolumnę w arkuszu kalkulacyjnym Arkuszy Google. Kliknij każde pole, aby aktywować listę właściwości sondy stanu zamówienia , a następnie wybierz żądane właściwości.

W tym przykładzie wybierz pozycję EmployeeNumber w polu Nazwa , aby zidentyfikować pracownika, który zaktualizował stan zamówienia.
Wybierz pozycję GroupName (Nazwa grupy ) i wstaw ją również do pola Nazwa .
Wybierz pozycję Zapisz.

Teraz został utworzony przepływ procesu, który zaktualizuje arkusz kalkulacyjny przy użyciu numeru pracownika i skojarzonej z nią grupy za każdym razem, gdy stan zamówienia zostanie zaktualizowany.

## Znane problemy i ograniczenia

Przekazywanie binarne pliku audio (POST) dla wszystkich punktów końcowych jest ograniczone tylko do mp4.
Daty dla wszystkich punktów końcowych, które wymagają informacji o dacie i godzinie, muszą być określone zgodnie z wytycznymi RFC3339, jak w poniższym przykładzie: 2021-09-22T02:36:56.52Z. Nie jest konieczne określenie dokładnych sekund w znaczniku czasu; 00 jest akceptowalne.

## Typowe błędy i środki zaradcze

Przykłady typowych błędów, które mogą wystąpić, kody odpowiedzi i poprawki można znaleźć w portalu deweloperów interfejsu API:

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

## — często zadawane pytania

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:


Wartość domyślna	Parametry tworzenia połączenia.	Wszystkie regiony	Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name	Typ	Description	Wymagane
Klucz interfejsu API	securestring	Klucz interfejsu API dla tego interfejsu API	Prawda

Limity ograniczania

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Aktualizowanie części użytkownika	Aktualizuje część właściwości użytkownika.
Aktualizowanie istniejącego geofencingu	Aktualizuje istniejący geofencing według jego identyfikatora.
Aktualizowanie klienta	Aktualizuje istniejącego klienta.
Aktualizowanie pojazdu	Zaktualizuj pojazd według identyfikatora.
Aktualizowanie stanu zamówienia	Zmienia istniejący stan zamówienia.
Aktualizowanie użytkownika	Aktualizuje istniejącego użytkownika.
Aktualizowanie zamówienia	Aktualizuje istniejące zamówienie.
Aktywowanie pojazdu	Aktywuj pojazd według identyfikatora.
Aktywowanie użytkownika	Aktywuje istniejącego użytkownika według jego identyfikatora.
Anulowanie subskrypcji elementu webhook danych GPS	Usuwa subskrypcję elementu webhook danych GPS według jego identyfikatora.
Anulowanie subskrypcji zdarzeń webhook	Usuwa subskrypcję webhook zdarzeń według jego identyfikatora.
Częściowa aktualizacja pojazdu	Częściowe aktualizowanie pojazdu według identyfikatora.
Dezaktywacja pojazdu	Dezaktywuj pojazd według identyfikatora.
Dezaktywowanie użytkownika	Dezaktywuje istniejącego użytkownika według jego identyfikatora.
Pobieranie klienta	Pobiera obiekt klienta według jego identyfikatora.
Pobieranie listy formularzy	Pobiera listę formularzy przy użyciu dowolnych filtrów z poniższych parametrów żądania. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są automatycznie sortowane według funkcji SubmittedTime i w kolejności malejącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy geofencingów	Pobiera listę geofencingów. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę, a także określić, czy współrzędne geofencingu są metrykami. Wyniki są automatycznie sortowane według nazwy i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy klientów	Pobiera listę klientów. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są automatycznie sortowane według nazwy i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy niestandardowych definicji zdarzeń	Pobiera listę niestandardowych definicji zdarzeń.
Pobieranie listy niestandardowych pól listy według identyfikatora CustomListID	Pobiera listę pól dla pojedynczej listy niestandardowej przy użyciu identyfikatora CustomListID.
Pobieranie listy podróży	Pobiera listę podróży dla określonego okresu. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według wartości StartUtcTIme i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy pojazdów	Pobiera listę pojazdów.
Pobieranie listy subskrypcji	Pobiera listę subskrypcji webhook. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według identyfikatora Subskrypcji i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy subskrypcji zdarzeń webhook	Pobiera listę subskrypcji zdarzeń webhook. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według identyfikatora Subskrypcji i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy użytkowników	Pobiera listę użytkowników. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są automatycznie sortowane według identyfikatora UserId i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy wpisów utrzymywania czasu	Pobiera listę wpisów utrzymywania czasu na podstawie zakresu dat. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według clockInTime, a następnie według wartości TimekeepingStatusId i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy zamówień	Pobiera listę zamówień przy użyciu filtrów z parametrów żądania przedstawionych poniżej. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według Client.Name i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie listy zdarzeń	Pobiera listę zdarzeń dla określonego okresu. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Filtruj według typu zdarzenia, aby uzyskać określone zdarzenia. Zdarzenia pojazdu mogą być zwracane dla pracownika, jeśli pracownik jest skojarzony z pojazdem.
Pobieranie niestandardowej definicji zdarzenia według identyfikatora	Pobiera pojedynczą niestandardową definicję zdarzenia według identyfikatora.
Pobieranie niestandardowych danych listy według identyfikatora CustomListID	Pobiera wszystkie rekordy danych z jednej listy niestandardowej przy użyciu identyfikatora CustomListID. Wyniki są sortowane według kolumn, a stronicowanie jest obsługiwane. Błędy: 404 — nie ma listy niestandardowej dla podanego identyfikatora customListId.
Pobieranie niestandardowych definicji listy	Pobiera listę definicji listy niestandardowej. Lista definicji zawiera identyfikator CustomListID, Name i Version dla wszystkich istniejących list niestandardowych.
Pobieranie pojedynczego rekordu z listy niestandardowej	Pobiera pojedynczy rekord danych listy niestandardowej znaleziony przez identyfikator CustomListId i unikatową wartość kolumny. Błędy: 404 — nie ma niestandardowego rekordu listy dla podanego identyfikatora customListId i unikatowej wartości kolumny
Pobieranie użytkownika	Pobiera użytkownika według jego identyfikatora.
Pobieranie wpisów danych GPS	Pobiera wpisy danych GPS dla określonego zakresu dat. Zwraca również token kontynuacji i link, aby pobrać następną część danych. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Pozycje usuniętych użytkowników/pojazdów nie są zwracane. Jeśli jednak użytkownik/pojazd istniał, gdy zażądano danych i został później usunięty, zostaną zwrócone dane dla użytkownika/pojazdu żądanego przez token kontynuacji. Wyniki są sortowane automatycznie według czasu UtcTime i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.
Pobieranie zamówienia	Pobiera istniejące zamówienie według jego identyfikatora.
Przekazywanie pliku binarnego	Użyj tej opcji, aby przekazać obrazy formularzy i pliki audio. Rozmiar pliku binarnego jest ograniczony do 10 MB. Obsługiwane typy plików to: JPEG, PNG i MP4.
Przekazywanie pliku załącznika	Użyj tej opcji, aby przekazać załączniki plików formularza. Rozmiar pliku binarnego jest ograniczony do 25 MB. Oczekiwano żądania danych wieloczęściowych/formularzy z pojedynczym plikiem.
Przesyłanie zdarzenia	Przesyła zdarzenie.
Resetuje stan subskrypcji	Zmienia stan subskrypcji na stan = 1 ("Uruchomiono").
Resetuje stan subskrypcji elementu webhook zdarzeń	Zmienia stan subskrypcji na stan = 1 ("Uruchomiono").
Subskrybowanie elementu webhook danych GPS	Dodaje nowe dane śledzenia GPS (pozycje GPS) web hook. Web hooks umożliwiają odbieranie pozycji GPS występujących na określonym adresie URL.
Subskrybowanie zdarzeń webhook	Dodaje nową subskrypcję elementu Web Hook zdarzeń. Web hooks umożliwiają odbieranie automatycznych powiadomień o zdarzeniach firmowych występujących w określonym adresie URL.
Tworzenie formularza	Dodaje nowy formularz.
Tworzenie geofencingu	Tworzy nowy geofencing.
Tworzenie klienta	Tworzy nowego klienta.
Tworzenie lub aktualizowanie niestandardowego rekordu listy	Tworzy lub aktualizuje niestandardowy rekord danych listy. Wartość unikatowej kolumny można pominąć, ale jeśli istnieje, powinna być zgodna z unikatową wartością identyfikatora w parametrze zapytania.
Tworzenie lub aktualizowanie niestandardowej definicji zdarzenia	Tworzy lub aktualizuje niestandardową definicję zdarzenia.
Tworzenie pojazdu	Tworzy pojazd.
Tworzenie użytkownika	Tworzy nowego użytkownika.
Tworzenie zamówienia	Dodaje nowe zamówienie.
Usuwanie geofencingu	Usuwa istniejący geofencing według jego identyfikatora.
Usuwanie klienta	Usuwa istniejącego klienta według jego identyfikatora.
Usuwanie niestandardowego rekordu listy	Usuwa istniejący rekord na liście niestandardowej według identyfikatora customListId i identyfikatora. id — jest unikatową wartością niestandardowego rekordu listy. Błędy: 404 — nie znaleziono identyfikatora customListId lub identyfikatora.
Usuwanie niestandardowej definicji zdarzenia	Usuwa niestandardową definicję zdarzenia.
Usuwanie pojazdu	Usuń pojazd według identyfikatora.
Uzyskiwanie formularza	Pobiera formularz według jego identyfikatora.
Uzyskiwanie geofencingu	Pobiera geofencing według jego identyfikatora.
Uzyskiwanie pojazdu według identyfikatora	Pobiera pojedynczy pojazd według identyfikatora.
Uzyskiwanie wersji pomocniczej	Zwraca bieżącą wersję pomocniczą interfejsu API.
Uzyskiwanie wpisu czasowego	Pobiera wpis według jego identyfikatora.
Wywołanie zwrotne elementu webhook z kanałem informacyjnym zdarzeń	Ta przykładowa metoda jest używana przez zdarzenia/subskrybowanie do publikowania źródła danych zdarzeń z powrotem przy użyciu podanego adresu URL klienta.
Wywołanie zwrotne elementu webhook z źródłem danych GPS	Ta przykładowa metoda jest używana przez gpsdata/subskrybuj do publikowania zwrotnego źródła danych przy użyciu podanego adresu URL klienta.

Aktualizowanie części użytkownika

Identyfikator operacji:: UserController_PartialUpdate

Aktualizuje część właściwości użytkownika.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
			object
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizowanie istniejącego geofencingu

Identyfikator operacji:: GeofenceController_UpdateGeofence

Aktualizuje istniejący geofencing według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	integer	Identyfikator geofencingu.
Nazwy grupy	GroupNames		array of string	GroupPaths obiektu GeofenceUpdateApiModel.
Szerokość	Latitude		double
Długość	Longitude		double
Name	Name		string	Nazwa bazy danych GeofenceApiModelBase.
Typ	Type		string	Typ elementu GeofenceApiModel.
Shape	Shape		integer	Kształt: 0 dla okręgu i 1 dla wielokąta.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Promień	Radius		double	Promień obiektu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress elementu GeofenceApiModel.
useMetric	useMetric		boolean	Użyj systemu metryk lub nie.
geokodowanie	geocode		boolean	Adres powinien być geokodowany lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizowanie klienta

Identyfikator operacji:: ClientController_Update

Aktualizuje istniejącego klienta.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
ExternalId	ExternalId		string	Identyfikator użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
FieldIndex	FieldIndex		integer	Indeks pola.
Wartość	Value			Wartość pola.
Name	Name		string	Nazwa klienta.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Name	Name		string	Nazwa modelu ContactApiModel.
Numer Telefonu	PhoneNumber		string	PhoneNumber of the ContactApiModel.
Email	Email		string	Adres e-mail contactApiModel.
geokodowanie	geocode		boolean	Adres powinien być geokodowany lub nie.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizowanie pojazdu

Identyfikator operacji:: VehicleController_UpdateVehicle

Zaktualizuj pojazd według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
Number	Number		string
Name	Name		string
Typ	Type		string
Tag	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
Nazwa grupy	GroupName		string
TimeZone	TimeZone		string
Robić	Make		string
Rok	Year		integer
Model	Model		string
Kolor	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
Typ urządzenia	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

response: integer

Aktualizowanie stanu zamówienia

Identyfikator operacji:: OrderController_ChangeStatus

Zmienia istniejący stan zamówienia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
Numer pracownika	EmployeeNumber	True	string	EmployeeNumber użytkownika, który utworzył ten NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etykieta zawartości elementu StatusLabel skojarzonego z tą pozycją NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	W momencie uruchomienia tego stanu NewOrderStatusApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizowanie użytkownika

Identyfikator operacji:: UserController_Update

Aktualizuje istniejącego użytkownika.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
Nazwa użytkownika	UserName		string	UserName użytkownika.
Hasło	Password		password	Hasło użytkownika.
Nazwa grupy	GroupName		string	Nazwa grupy użytkownika.
Imię (pierwsze)	FirstName		string	Imię użytkownika.
Nazwisko	LastName		string	Nazwisko użytkownika.
Numer pracownika	EmployeeNumber		string	Numer pracownika użytkownika.
Email	Email		string	Adres e-mail użytkownika.
Telefon	Phone		string	Numer telefonu użytkownika.
Identyfikator roli	RoleId		integer	RoleId użytkownika — (administrator: 1, użytkownik: 3, użytkownik: 5).
IsActive	IsActive		boolean	Aktywny stan użytkownika.
EPTTEnabled	EPTTEnabled		boolean	Stan rozszerzonej funkcji wypychania do rozmowy dla użytkownika: wartość logiczna.
Numer EPTT	EPTTNumber		string	Numer telefonu dla rozszerzonej funkcji wypychania do rozmowy dla użytkownika: ciąg.
EPTTWebMDN	EPTTWebMDN		string	Numer telefonu używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
EPTTToken	EPTTToken		string	Token interfejsu API używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
GPSEnabled	GPSEnabled		boolean	Stan funkcji GPS dla użytkownika.
MobileOnly	MobileOnly		boolean	Stan dostępu aplikacji internetowej klasycznej dla pliku CAB — (brak dostępu do aplikacji internetowej: prawda, pełny dostęp do aplikacji: fałsz).
Typ licencji	LicenseType		integer	Typ licencji przypisanej do użytkownika: - 0 dla niezdefiniowanych, 1 dla zwykłych, 2 dla webonly i 3 dla pracownika.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizowanie zamówienia

Identyfikator operacji:: OrderController_Update

Aktualizuje istniejące zamówienie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
ExternalOrderId	ExternalOrderId		string	Identyfikator OrderId użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
IsClosed	IsClosed		boolean	Stan wyświetlany, jeśli element UpdateOrderApiModel został zamknięty.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Name	Name		string	Nazwa modelu ContactApiModel.
Numer Telefonu	PhoneNumber		string	PhoneNumber of the ContactApiModel.
Email	Email		string	Adres e-mail contactApiModel.
Data ukończenia	DueDate		date-time	Ten element BaseUpdateOrderApiModel ma zostać ukończony (przestarzałe w wersji 1.3).
StartTime	StartTime		date-time	Ten element BaseUpdateOrderApiModel powinien zostać uruchomiony (wprowadzony w wersji 1.3).
EndTime	EndTime		date-time	Punkt w czasie ten element BaseUpdateOrderApiModel powinien zakończyć się (wprowadzony w wersji 1.3).
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
Numer pracownika	EmployeeNumber	True	string	EmployeeNumber użytkownika, który utworzył ten NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etykieta zawartości elementu StatusLabel skojarzonego z tą pozycją NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	W momencie uruchomienia tego stanu NewOrderStatusApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
FieldIndex	FieldIndex		integer	Indeks pola.
Wartość	Value			Wartość pola.
geokodowanie	geocode		boolean	Adres powinien być geokodowany lub nie.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Aktywowanie pojazdu

Identyfikator operacji:: VehicleController_Activate

Aktywuj pojazd według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

response: integer

Aktywowanie użytkownika

Identyfikator operacji:: UserController_Activate

Aktywuje istniejącego użytkownika według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Anulowanie subskrypcji elementu webhook danych GPS

Identyfikator operacji:: TrackingController_RemoveGpsDataFeedSubscription

Usuwa subskrypcję elementu webhook danych GPS według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscriptionId	True	string	Identyfikator subskrypcji do usunięcia.

Anulowanie subskrypcji zdarzeń webhook

Identyfikator operacji:: EventController_RemoveEventDataFeedSubscription

Usuwa subskrypcję webhook zdarzeń według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscriptionId	True	string	Identyfikator subskrypcji do usunięcia.

Częściowa aktualizacja pojazdu

Identyfikator operacji:: VehicleController_PartialUpdateVehicle

Częściowe aktualizowanie pojazdu według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
			object
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Dezaktywacja pojazdu

Identyfikator operacji:: VehicleController_Deactivate

Dezaktywuj pojazd według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

response: integer

Dezaktywowanie użytkownika

Identyfikator operacji:: UserController_Deactivate

Dezaktywuje istniejącego użytkownika według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Pobieranie klienta

Identyfikator operacji:: ClientController_Get

Pobiera obiekt klienta według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator klienta.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.Client.ReadClientApiModel

Pobieranie listy formularzy

Identyfikator operacji:: FormController_GetFormsAsync

Pobiera listę formularzy przy użyciu dowolnych filtrów z poniższych parametrów żądania. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są automatycznie sortowane według funkcji SubmittedTime i w kolejności malejącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
submittedStartDate	submittedStartDate	True	date-time	Data rozpoczęcia przesłanego formularza.
submittedEndDate	submittedEndDate	True	date-time	Data zakończenia przesłanego formularza.
apiModuleId	apiModuleId		string	Identyfikator modułu formularza.
numerPracownika	employeeNumber		string	Numer pracownika.
Napisał(a) recenzję	reviewed		boolean	Pobiera tylko przeglądane formularze. Wartość domyślna to null dla wszystkich.
pageNumber	pageNumber		integer	Numer strony początkowej. Wartość domyślna to 1.
pageSize	pageSize		integer	Rozmiar strony. Wartość domyślna to 1000.

Zwraca

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Pobieranie listy geofencingów

Identyfikator operacji:: GeofenceController_GetGeofences

Pobiera listę geofencingów. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę, a także określić, czy współrzędne geofencingu są metrykami. Wyniki są automatycznie sortowane według nazwy i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Typ	Opis
pageNumber	pageNumber	integer	Numer strony początkowej. Wartość domyślna to 1.
pageSize	pageSize	integer	Rozmiar strony. Wartość domyślna to 500.
useMetric	useMetric	boolean	Użyj systemu metryk lub nie.

Zwraca

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Pobieranie listy klientów

Identyfikator operacji:: ClientController_GetClients

Pobiera listę klientów. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są automatycznie sortowane według nazwy i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
pageNumber	pageNumber		integer	Numer strony początkowej.
pageSize	pageSize		integer	Rozmiar strony.

Zwraca

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Pobieranie listy niestandardowych definicji zdarzeń

Identyfikator operacji:: EventController_GetList

Pobiera listę niestandardowych definicji zdarzeń.

Zwraca

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Pobieranie listy niestandardowych pól listy według identyfikatora CustomListID

Identyfikator operacji:: CustomListController_GetById

Pobiera listę pól dla pojedynczej listy niestandardowej przy użyciu identyfikatora CustomListID.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
customListId	customListId	True	integer	Identyfikator listy niestandardowej.

Zwraca

Niestandardowy model listy.

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

Pobieranie listy podróży

Identyfikator operacji:: TrackingController_GetTrips

Pobiera listę podróży dla określonego okresu. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według wartości StartUtcTIme i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
fromDate	fromDate	True	date-time	Początek zakresu dat. Zalecenie: użyj zakresów dat big date (>=4 godziny) zamiast małych zakresów dat.
toDate	toDate	True	date-time	Koniec zakresu dat. Zalecenie: użyj zakresów dat big date (>=4 godziny) zamiast małych zakresów dat.
numerPracownika	employeeNumber		string	Numer pracownika.
Vin	vin		string	Numer VIN pojazdu.
pageNumber	pageNumber		integer	Numer strony początkowej. Wartość domyślna to 1.
pageSize	pageSize		integer	Rozmiar strony. Wartość domyślna to 1000.
useMetric	useMetric		boolean	Użyj systemu metryk lub nie.

Zwraca

response: array of CustomerAPI.Models.Tracking.TripApiModel

Pobieranie listy pojazdów

Identyfikator operacji:: VehicleController_GetVehicles

Pobiera listę pojazdów.

Parametry

Nazwa	Klucz	Typ	Opis
pageNumber	pageNumber	integer	Numer strony.
pageSize	pageSize	integer	Maksymalna liczba elementów na stronie. Wartość domyślna : 1000. Wartość maksymalna = 2000.
activeOnly	activeOnly	boolean	jeśli wartość true — zwraca tylko aktywne pojazdy. Wartość domyślna = false.

Zwraca

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Pobieranie listy subskrypcji

Identyfikator operacji:: TrackingController_GetSubscriptions

Pobiera listę subskrypcji webhook. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według identyfikatora Subskrypcji i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Zwraca

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Pobieranie listy subskrypcji zdarzeń webhook

Identyfikator operacji:: EventController_GetSubscriptions

Pobiera listę subskrypcji zdarzeń webhook. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według identyfikatora Subskrypcji i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Zwraca

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Pobieranie listy użytkowników

Identyfikator operacji:: UserController_GetUsers

Pobiera listę użytkowników. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są automatycznie sortowane według identyfikatora UserId i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
pageNumber	pageNumber		integer	Numer strony początkowej. Wartość domyślna to 1.
pageSize	pageSize		integer	Rozmiar strony. Wartość domyślna to 500.

Zwraca

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Pobieranie listy wpisów utrzymywania czasu

Identyfikator operacji:: TimekeepingController_GetTimekeepingDataList

Pobiera listę wpisów utrzymywania czasu na podstawie zakresu dat. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według clockInTime, a następnie według wartości TimekeepingStatusId i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
fromDate	fromDate	True	date-time	Data rozpoczęcia.
toDate	toDate	True	date-time	Data zakończenia.
numerPracownika	employeeNumber		string	Numer pracownika.
zatwierdzony	approved		boolean	Filtruj tylko dla zatwierdzonego wpisu.
closedOnly	closedOnly		boolean	Filtruj tylko dla zamkniętego wpisu.
excludeFormData	excludeFormData		boolean	Filtruj pod kątem wykluczania danych formularza.
pageNumber	pageNumber		integer	Numer strony początkowej (wartość domyślna 1).
pageSize	pageSize		integer	Rozmiar strony (domyślnie 1000).

Zwraca

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Pobieranie listy zamówień

Identyfikator operacji:: OrderController_GetOrders

Pobiera listę zamówień przy użyciu filtrów z parametrów żądania przedstawionych poniżej. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę. Wyniki są sortowane automatycznie według Client.Name i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
dueDateFrom	dueDateFrom	True	date-time	Filtruj według daty rozpoczęcia daty ukończenia.
dueDateTo	dueDateTo	True	date-time	Filtruj według daty zakończenia daty ukończenia.
numerPracownika	employeeNumber		string	Filtruj według numeru pracownika.
pageNumber	pageNumber		integer	Numer strony początkowej (wartość domyślna 1).
pageSize	pageSize		integer	Rozmiar strony (domyślnie 500).

Zwraca

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Pobieranie listy zdarzeń

Identyfikator operacji:: EventController_GetEvents

Pobiera listę zdarzeń dla określonego okresu. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę.

Filtruj według typu zdarzenia, aby uzyskać określone zdarzenia. Zdarzenia pojazdu mogą być zwracane dla pracownika, jeśli pracownik jest skojarzony z pojazdem.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
fromDate	fromDate	True	date-time	Początek zakresu dat.
toDate	toDate	True	date-time	Koniec zakresu dat.
numerPracownika	employeeNumber		string	Numer pracownika.
vehicleNumber	vehicleNumber		string	Numer pojazdu.
pageNumber	pageNumber		integer	Numer strony początkowej.
pageSize	pageSize		integer	Rozmiar strony.
eventType	eventType		integer	Filtruj według typu zdarzenia. określono numer pracownika: UserEvents(0) — tylko zdarzenia użytkownika. VehicleEvents(1) — tylko zdarzenia pojazdów, w tym zdarzenia czujnika. ExternalEvents(2) — tylko zdarzenia zewnętrzne. określono numer pojazdu: UserEvents(0) — N/A. VehicleEvents(1) — tylko zdarzenia pojazdów, w tym zdarzenia czujnika. ExternalEvents(2) — tylko zdarzenia zewnętrzne. Nie określono ani numeru pracownika, ani numeru pojazdu: UserEvents(0) — tylko zdarzenia użytkownika. VehicleEvents(1) — tylko zdarzenia pojazdów, w tym zdarzenia czujnika. ExternalEvents(2) — tylko zdarzenia zewnętrzne.

Zwraca

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Pobieranie niestandardowej definicji zdarzenia według identyfikatora

Identyfikator operacji:: EventController_Get

Pobiera pojedynczą niestandardową definicję zdarzenia według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator definicji zdarzenia.

Zwraca

Niestandardowy model definicji zdarzeń.

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Pobieranie niestandardowych danych listy według identyfikatora CustomListID

Identyfikator operacji:: CustomListController_GetCustomList

Pobiera wszystkie rekordy danych z jednej listy niestandardowej przy użyciu identyfikatora CustomListID.

Wyniki są sortowane według kolumn, a stronicowanie jest obsługiwane.

Błędy:

404 — nie ma listy niestandardowej dla podanego identyfikatora customListId.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
customListId	customListId	True	integer	Identyfikator listy niestandardowej.
pageNumber	pageNumber		integer	Numer strony początkowej.
pageSize	pageSize		integer	Rozmiar strony.

Zwraca

Kontener dla niestandardowej tablicy danych kolumn listy.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Pobieranie niestandardowych definicji listy

Identyfikator operacji:: CustomListController_Get

Pobiera listę definicji listy niestandardowej. Lista definicji zawiera identyfikator CustomListID, Name i Version dla wszystkich istniejących list niestandardowych.

Zwraca

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Pobieranie pojedynczego rekordu z listy niestandardowej

Identyfikator operacji:: CustomListController_GetSingleRecord

Pobiera pojedynczy rekord danych listy niestandardowej znaleziony przez identyfikator CustomListId i unikatową wartość kolumny.

Błędy:

404 — nie ma niestandardowego rekordu listy dla podanego identyfikatora customListId i unikatowej wartości kolumny

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
customListId	customListId	True	integer	Identyfikator listy niestandardowej.
id	id	True	string	Unikatowa wartość.

Zwraca

Kontener dla niestandardowej tablicy danych kolumn listy.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Pobieranie użytkownika

Identyfikator operacji:: UserController_Get

Pobiera użytkownika według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.User.ReadUserApiModel

Pobieranie wpisów danych GPS

Identyfikator operacji:: TrackingController_GetGpsData

Pobiera wpisy danych GPS dla określonego zakresu dat. Zwraca również token kontynuacji i link, aby pobrać następną część danych. Można określić liczbę zwracanych stron oraz liczbę elementów na stronę.

Pozycje usuniętych użytkowników/pojazdów nie są zwracane. Jeśli jednak użytkownik/pojazd istniał, gdy zażądano danych i został później usunięty, zostaną zwrócone dane dla użytkownika/pojazdu żądanego przez token kontynuacji.

Wyniki są sortowane automatycznie według czasu UtcTime i w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

Parametry

Nazwa	Klucz	Typ	Opis
fromDate	fromDate	date-time	Początek zakresu dat. Zalecenie: użyj zakresów dat big date (>=4 godziny) zamiast małych zakresów dat.
toDate	toDate	date-time	Koniec zakresu dat. Zalecenie: użyj zakresów dat big date (>=4 godziny) zamiast małych zakresów dat.
numerPracownika	employeeNumber	string	Numer pracownika.
Vin	vin	string	Numer VIN pojazdu.
useMetric	useMetric	boolean	Użyj systemu metryk lub nie.
kod przedpłaty	token	string	Token kontynuacji zwracany przez początkowe wywołanie i jest używany w kolejnym wywołaniu.

Zwraca

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Pobieranie zamówienia

Identyfikator operacji:: OrderController_GetOrder

Pobiera istniejące zamówienie według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
include-status-history	include-status-history		string	Jeśli wartość true, odpowiedź będzie zawierać wszystkie dane historii stanu i formularza dla tego zamówienia.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Body: CustomerAPI.Models.Order.OrderApiModel

Przekazywanie pliku binarnego

Identyfikator operacji:: BinaryController_UploadBinary

Użyj tej opcji, aby przekazać obrazy formularzy i pliki audio. Rozmiar pliku binarnego jest ograniczony do 10 MB. Obsługiwane typy plików to: JPEG, PNG i MP4.

Zwraca

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Przekazywanie pliku załącznika

Identyfikator operacji:: BinaryController_UploadAttachment

Użyj tej opcji, aby przekazać załączniki plików formularza. Rozmiar pliku binarnego jest ograniczony do 25 MB. Oczekiwano żądania danych wieloczęściowych/formularzy z pojedynczym plikiem.

Zwraca

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Przesyłanie zdarzenia

Identyfikator operacji:: EventController_Post

Przesyła zdarzenie.

Parametry

Nazwa	Klucz	Typ	Opis
EventDefinitionId	EventDefinitionId	string	Identyfikator definicji zdarzenia.
Numer pracownika	EmployeeNumber	string	Numer pracownika.
Numer pojazdu	VehicleNumber	string	Numer pojazdu.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto numer seryjny.
Szerokość	Latitude	double
Długość	Longitude	double
Adres1	AddressLine1	string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2	string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City	string	Miasto locationApiModel.
Nazwa regionu	RegionName	string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode	string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode	string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode	string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode	string	Kod regionu lokalizacjiApiModel.
Time	Time	date-time
Parametry	Parameters	object	Parametry zdarzenia.

Resetuje stan subskrypcji

Identyfikator operacji:: TrackingController_ResetSubscriptionHealthStatus

Zmienia stan subskrypcji na stan = 1 ("Uruchomiono").

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscriptionId	True	integer	Identyfikator subskrypcji.

Resetuje stan subskrypcji elementu webhook zdarzeń

Identyfikator operacji:: EventController_ResetSubscriptionHealthStatus

Zmienia stan subskrypcji na stan = 1 ("Uruchomiono").

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscriptionId	True	integer	Identyfikator subskrypcji.

Subskrybowanie elementu webhook danych GPS

Identyfikator operacji:: TrackingController_SubscribeToGpsDataFeed

Dodaje nowe dane śledzenia GPS (pozycje GPS) web hook. Web hooks umożliwiają odbieranie pozycji GPS występujących na określonym adresie URL.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
URL	Url		string	Adres URL zawierający adres elementu WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token zabezpieczający skojarzony z tym elementem WebHookSubscriptionParamsApiModel.

Zwraca

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Subskrybowanie zdarzeń webhook

Identyfikator operacji:: EventController_SubscribeToEventDataFeed

Dodaje nową subskrypcję elementu Web Hook zdarzeń. Web hooks umożliwiają odbieranie automatycznych powiadomień o zdarzeniach firmowych występujących w określonym adresie URL.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
URL	Url		string	Adres URL zawierający adres elementu WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token zabezpieczający skojarzony z tym elementem WebHookSubscriptionParamsApiModel.

Zwraca

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Tworzenie formularza

Identyfikator operacji:: FormController_PostFormAsync

Dodaje nowy formularz.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator apiModuleId	ApiModuleId		string	Identyfikator modułu ApiModule skojarzonego z tym elementem CreateStandaloneFormApiModel.
Napisał(a) recenzję	Reviewed		boolean	Stan przeglądu tego elementu CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId użytkownika.
Numer pracownika	EmployeeNumber		string	Numer pracownika użytkownika.
Przesłany czas	SubmittedTime	True	date-time	Punkt w czasie przesłania elementu CreateStandaloneFormApiModel.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Identyfikator ApiFieldId	ApiFieldId	True	string	Identyfikator pola interfejsu API.
Wartość	Value	True		Wartość elementu FormFieldDataApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Sign" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Czas przechwytywania danych binarnych. Format — data/godzina (jako data/godzina w RFC3339), w tym przesunięcie.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Identyfikator ApiFieldId	ApiFieldId	True	string	Identyfikator pola interfejsu API.
Wartość	Value	True		Wartość elementu FormFieldDataApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Sign" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Czas przechwytywania danych binarnych. Format — data/godzina (jako data/godzina w RFC3339), w tym przesunięcie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Tworzenie geofencingu

Identyfikator operacji:: GeofenceController_CreateGeofence

Tworzy nowy geofencing.

Parametry

Nazwa	Klucz	Typ	Opis
Nazwy grupy	GroupNames	array of string	GroupPaths obiektu GeofenceCreateApiModel.
Szerokość	Latitude	double
Długość	Longitude	double
Name	Name	string	Nazwa bazy danych GeofenceApiModelBase.
Typ	Type	string	Typ elementu GeofenceApiModel.
Shape	Shape	integer	Kształt: 0 dla okręgu i 1 dla wielokąta.
Szerokość	Latitude	double
Długość	Longitude	double
Adres1	AddressLine1	string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2	string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City	string	Miasto locationApiModel.
Nazwa regionu	RegionName	string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode	string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode	string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode	string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode	string	Kod regionu lokalizacjiApiModel.
Promień	Radius	double	Promień obiektu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress elementu GeofenceApiModel.
useMetric	useMetric	boolean	Użyj systemu metryk lub nie.
geokodowanie	geocode	boolean	Adres powinien być geokodowany lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Tworzenie klienta

Identyfikator operacji:: ClientController_Create

Tworzy nowego klienta.

Parametry

Nazwa	Klucz	Typ	Opis
ExternalId	ExternalId	string	Identyfikator użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
FieldIndex	FieldIndex	integer	Indeks pola.
Wartość	Value		Wartość pola.
Name	Name	string	Nazwa klienta.
Szerokość	Latitude	double
Długość	Longitude	double
Adres1	AddressLine1	string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2	string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City	string	Miasto locationApiModel.
Nazwa regionu	RegionName	string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode	string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode	string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode	string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode	string	Kod regionu lokalizacjiApiModel.
Name	Name	string	Nazwa modelu ContactApiModel.
Numer Telefonu	PhoneNumber	string	PhoneNumber of the ContactApiModel.
Email	Email	string	Adres e-mail contactApiModel.
geokodowanie	geocode	boolean	Adres powinien być geokodowany lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Tworzenie lub aktualizowanie niestandardowego rekordu listy

Identyfikator operacji:: CustomListController_PutRecord

Tworzy lub aktualizuje niestandardowy rekord danych listy. Wartość unikatowej kolumny można pominąć, ale jeśli istnieje, powinna być zgodna z unikatową wartością identyfikatora w parametrze zapytania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
customListId	customListId	True	integer	Identyfikator listy niestandardowej.
id	id	True	string	Unikatowa wartość.
ColumnIndex	ColumnIndex		integer	Niestandardowy indeks kolumny listy.
Napisy	Caption		string	Niestandardowy podpis kolumny listy.
Wartość	Value			Wartość kolumny listy niestandardowej.

Tworzenie lub aktualizowanie niestandardowej definicji zdarzenia

Identyfikator operacji:: EventController_Put

Tworzy lub aktualizuje niestandardową definicję zdarzenia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator definicji zdarzenia.
Name	Name		string
ReverseGeocode	ReverseGeocode		boolean
Name	Name		string
Typ	Type		integer
Napisy	Caption		string
Wymagane	Required		boolean

Tworzenie pojazdu

Identyfikator operacji:: VehicleController_CreateVehicle

Tworzy pojazd.

Parametry

Nazwa	Klucz	Typ
Number	Number	string
Name	Name	string
Typ	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
Nazwa grupy	GroupName	string
TimeZone	TimeZone	string
Robić	Make	string
Rok	Year	integer
Model	Model	string
Kolor	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Typ urządzenia	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Tworzenie użytkownika

Identyfikator operacji:: UserController_Create

Tworzy nowego użytkownika.

Parametry

Nazwa	Klucz	Typ	Opis
Nazwa użytkownika	UserName	string	UserName użytkownika.
Hasło	Password	password	Hasło użytkownika.
Nazwa grupy	GroupName	string	Nazwa grupy użytkownika.
Imię (pierwsze)	FirstName	string	Imię użytkownika.
Nazwisko	LastName	string	Nazwisko użytkownika.
Numer pracownika	EmployeeNumber	string	Numer pracownika użytkownika.
Email	Email	string	Adres e-mail użytkownika.
Telefon	Phone	string	Numer telefonu użytkownika.
Identyfikator roli	RoleId	integer	RoleId użytkownika — (administrator: 1, użytkownik: 3, użytkownik: 5).
IsActive	IsActive	boolean	Aktywny stan użytkownika.
EPTTEnabled	EPTTEnabled	boolean	Stan rozszerzonej funkcji wypychania do rozmowy dla użytkownika: wartość logiczna.
Numer EPTT	EPTTNumber	string	Numer telefonu dla rozszerzonej funkcji wypychania do rozmowy dla użytkownika: ciąg.
EPTTWebMDN	EPTTWebMDN	string	Numer telefonu używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
EPTTToken	EPTTToken	string	Token interfejsu API używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
GPSEnabled	GPSEnabled	boolean	Stan funkcji GPS dla użytkownika.
MobileOnly	MobileOnly	boolean	Stan dostępu aplikacji internetowej klasycznej dla pliku CAB — (brak dostępu do aplikacji internetowej: prawda, pełny dostęp do aplikacji: fałsz).
Typ licencji	LicenseType	integer	Typ licencji przypisanej do użytkownika: - 0 dla niezdefiniowanych, 1 dla zwykłych, 2 dla webonly i 3 dla pracownika.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Tworzenie zamówienia

Identyfikator operacji:: OrderController_Create

Dodaje nowe zamówienie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Data i czas utworzenia	CreatedDateTime		date-time	Punkt w czasie utworzenia elementu CreateUpdateOrderApiModel.
ExternalClientId	ExternalClientId	True	string	Identyfikator użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
ServiceType	ServiceType	True	string	Typ usługi skojarzony z tym elementem CreateUpdateOrderApiModel.
ExternalOrderId	ExternalOrderId		string	Identyfikator OrderId użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Name	Name		string	Nazwa modelu ContactApiModel.
Numer Telefonu	PhoneNumber		string	PhoneNumber of the ContactApiModel.
Email	Email		string	Adres e-mail contactApiModel.
Data ukończenia	DueDate		date-time	Ten element BaseUpdateOrderApiModel ma zostać ukończony (przestarzałe w wersji 1.3).
StartTime	StartTime		date-time	Ten element BaseUpdateOrderApiModel powinien zostać uruchomiony (wprowadzony w wersji 1.3).
EndTime	EndTime		date-time	Punkt w czasie ten element BaseUpdateOrderApiModel powinien zakończyć się (wprowadzony w wersji 1.3).
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
Numer pracownika	EmployeeNumber	True	string	EmployeeNumber użytkownika, który utworzył ten NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etykieta zawartości elementu StatusLabel skojarzonego z tą pozycją NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	W momencie uruchomienia tego stanu NewOrderStatusApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
Szerokość	Latitude		double
Długość	Longitude		double
Adres1	AddressLine1		string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2		string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City		string	Miasto locationApiModel.
Nazwa regionu	RegionName		string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode		string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode		string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode		string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode		string	Kod regionu lokalizacjiApiModel.
Napisy	Caption	True	string
Wartość	Value			Wartość elementu UpdateFormFieldApiModel. Format wartości pola "NFC": { "Type": number, // 0 — Text "Payload": object, // Should be text for Type = 0 } Format wartości pola "Aparat" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) "Uwaga": ciąg // Uwaga dla przywoływanego obrazu } Format wartości pola "Signature" (odwołanie binarne): { "BinaryId": ciąg // Identyfikator binarny przekazanego obrazu (zobacz przekazywanie interfejsu API binarnego) } Format wartości pola "Audio" (odwołanie binarne): { "BinaryId": ciąg, // Identyfikator binarny przekazanego dźwięku (zobacz przekazywanie interfejsu API binarnego) "DurationSeconds": number // Audio duration in seconds }
Przechwycony czas	CapturedTime		date-time	Przechwycono wartość punktu w czasie.
FieldIndex	FieldIndex		integer	Indeks pola.
Wartość	Value			Wartość pola.
geokodowanie	geocode		boolean	Adres powinien być geokodowany lub nie.

Zwraca

Body: CustomerAPI.Models.ReturnIdApiModel

Usuwanie geofencingu

Identyfikator operacji:: GeofenceController_DeleteGeofence

Usuwa istniejący geofencing według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	integer	Identyfikator geofencingu.

Usuwanie klienta

Identyfikator operacji:: ClientController_Delete

Usuwa istniejącego klienta według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator klienta.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Usuwanie niestandardowego rekordu listy

Identyfikator operacji:: CustomListController_DeleteRecord

Usuwa istniejący rekord na liście niestandardowej według identyfikatora customListId i identyfikatora.

id — jest unikatową wartością niestandardowego rekordu listy.

Błędy:

404 — nie znaleziono identyfikatora customListId lub identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
customListId	customListId	True	integer	Identyfikator listy niestandardowej.
id	id	True	string	Unikatowa wartość.

Usuwanie niestandardowej definicji zdarzenia

Identyfikator operacji:: EventController_Delete

Usuwa niestandardową definicję zdarzenia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator definicji zdarzenia.

Usuwanie pojazdu

Identyfikator operacji:: VehicleController_Delete

Usuń pojazd według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Uzyskiwanie formularza

Identyfikator operacji:: FormController_GetFormAsync

Pobiera formularz według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	integer	Identyfikator formularza.

Zwraca

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Uzyskiwanie geofencingu

Identyfikator operacji:: GeofenceController_GetGeofence

Pobiera geofencing według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	integer	Identyfikator geofencingu.
useMetric	useMetric		boolean	Użyj systemu metryk lub nie.

Zwraca

Body: CustomerAPI.Models.Geofence.GeofenceApiModel

Uzyskiwanie pojazdu według identyfikatora

Identyfikator operacji:: VehicleController_GetVehicle

Pobiera pojedynczy pojazd według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator zewnętrzny lub wewnętrzny zależy od wartości w parametrze use-external-id.
use-external-id	use-external-id		boolean	Użyj identyfikatora zewnętrznego lub nie.

Zwraca

Model danych pojazdu.

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

Uzyskiwanie wersji pomocniczej

Identyfikator operacji:: VersionController_Get

Zwraca bieżącą wersję pomocniczą interfejsu API.

Uzyskiwanie wpisu czasowego

Identyfikator operacji:: TimekeepingController_GetTimekeepingEntryAsync

Pobiera wpis według jego identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
id	id	True	string	Identyfikator rekordu.

Zwraca

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Wywołanie zwrotne elementu webhook z kanałem informacyjnym zdarzeń

Identyfikator operacji:: EventController_subscribe_callback

Ta przykładowa metoda jest używana przez zdarzenia/subskrybowanie do publikowania źródła danych zdarzeń z powrotem przy użyciu podanego adresu URL klienta.

Parametry

Nazwa	Klucz	Typ	Opis
Id	Id	string	Adres URL zawierający adres elementu WebHookSubscriptionParamsApiModel.
Typ Wydarzenia	EventType	integer
Kod zdarzenia	EventCode	string
Czas Wydarzenia	EventTime	date-time	Format ISO z formatem lokalnym i przesunięciem.
DeviceId	DeviceId	string	GpsDeviceDto Id skojarzony z subskrypcją.
Typ urządzenia	DeviceType	integer	GpsDeviceDto typ: Słuchawka (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Identyfikator użytkownika.
VehicleId	VehicleId	integer	Identyfikator pojazdu.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Czy użytkownik jest połączony z pojazdem.
Lat	Lat	double	Szerokość geograficzna.
Lon	Lon	double	Długość.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Parametry zdarzenia.

Zwraca

response: object

Wywołanie zwrotne elementu webhook z źródłem danych GPS

Identyfikator operacji:: TrackingController_subscribe_callback

Ta przykładowa metoda jest używana przez gpsdata/subskrybuj do publikowania zwrotnego źródła danych przy użyciu podanego adresu URL klienta.

Parametry

Nazwa	Klucz	Typ	Opis
Id	Id	string	Adres URL zawierający adres elementu WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GpsDeviceDto Id skojarzony z subskrypcją.
Typ urządzenia	DeviceType	integer	GpsDeviceDto typ: Słuchawka(0), CalAmp(1), Geotab (2), Xirgo (3).
Sygnatura czasowa	Timestamp	date-time	Format ISO z formatem lokalnym i przesunięciem.
Identyfikator firmy	CompanyId	integer	Identyfikator firmy.
UserId	UserId	integer	Identyfikator użytkownika.
VehicleId	VehicleId	integer	Identyfikator pojazdu.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Czy użytkownik jest połączony z pojazdem.
LocationProvider	LocationProvider	string	Nazwa dostawcy lokalizacji.
Lat	Lat	double	Szerokość geograficzna.
Lon	Lon	double	Długość.
DokładnośćFt	AccuracyFt	double	Dokładność położenia (stopy).
Wysokośćft	AltitudeFt	double	Wysokość (stopy).
Heading	Heading	integer	Kierunek kompasu w stopniach.
SpeedMph	SpeedMph	double	Szybkość ruchu (Mph).
BatteryStatus	BatteryStatus	integer	Stan baterii: Brak ładowania (0), ładowanie (1).
BatteryLevel	BatteryLevel	integer	Poziom baterii w procentach.
ActivityState	ActivityState	integer	Stan działania: Pobyt (1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Czy urządzenie jest obecnie połączone z siecią.
Rssi	Rssi	integer	Odebrano wskaźnik siły sygnału.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (Mile).
VOdoMl	VOdoMl	double	Odometr pojazdu (mile).

Zwraca

response: object

Wyzwalacze

Ankieta czasowa	Punkt końcowy sondowania interfejsu API pomiaru czasu umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnio przesłanych wpisów czasowych. Integracja: Ten punkt końcowy jest przeznaczony do pracy z usługą Microsoft Flow jako integracją wyzwalacza sondowania. Alternatywnie możesz opracować własną integrację niestandardową przy użyciu dowolnego języka. Użycie: W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi: Kod odpowiedzi HTTP 200 — istnieją ostatnio przesłane rekordy czasowe; Treść odpowiedzi wyświetli dane wpisu czasowego. Kod odpowiedzi HTTP 202 — nie istnieją ostatnio przesłane rekordy; Treść odpowiedzi będzie pusta. W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki: Location — adres URL następnego żądania. Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300. Uwaga: są to tylko zalecane wartości — aplikacja może wybrać sondę z inną częstotliwością w zależności od wymagań. Po pierwszym żądaniu wszystkie kolejne żądania powinny używać adresu URL podanego w nagłówku Lokalizacja najnowszej odpowiedzi. Nie dodawaj więcej parametrów do adresu URL, ponieważ zawiera już te, które są niezbędne do zapewnienia, że w żądaniu nie brakuje wpisów utrzymywania czasu. Wyniki są sortowane automatycznie według modifiedUtc, a następnie według timekeepingStatusId, a następnie w kolejności rosnącej. Nie można konfigurować parametrów sortowania. ModifiedUtc definicja: wewnętrzny tag czasu = czas ostatniej zmiany stanu czasomierza.
Ankieta danych formularza	Punkt końcowy sondowania interfejsu API formularzy umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnio przesłanych formularzy autonomicznych. Integracja: Ten punkt końcowy jest przeznaczony do pracy z usługą Microsoft Flow jako integracją wyzwalacza sondowania. Alternatywnie możesz opracować własną integrację niestandardową przy użyciu dowolnego języka. Użycie: W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi: Kod odpowiedzi HTTP 200 — istnieją ostatnio przesłane rekordy formularzy; Treść odpowiedzi wyświetli dane formularza. Kod odpowiedzi HTTP 202 — nie istnieją ostatnio przesłane rekordy; Treść odpowiedzi będzie pusta. W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki: Location — adres URL następnego żądania. Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300. Uwaga: są to tylko zalecane wartości — aplikacja może wybrać sondę z inną częstotliwością w zależności od wymagań. Po pierwszym żądaniu wszystkie kolejne żądania powinny używać adresu URL podanego w nagłówku Lokalizacja najnowszej odpowiedzi. Nie dodawaj więcej parametrów do adresu URL, ponieważ zawiera już niezbędne parametry wymagane do zapewnienia braku formularzy w żądaniu. Wyniki są sortowane automatycznie według modifiedUtc, a następnie według FormHeaderId w kolejności rosnącej. Nie można konfigurować parametrów sortowania. ModifiedUtc definicja: wewnętrzny tag czasu = czas ostatniej zmiany danych formularza.
Sonda stanów zamówienia	Punkt końcowy sondowania interfejsu API stanu zamówienia umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnich zmian w zamówieniach. Integracja: Ten punkt końcowy jest przeznaczony do pracy z usługą Microsoft Flow jako integracją wyzwalacza sondowania. Alternatywnie możesz opracować własną integrację niestandardową przy użyciu dowolnego języka. Użycie: W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi: Kod odpowiedzi HTTP 200 — ostatnio zmienione rekordy stanu zamówienia istnieją; Treść odpowiedzi wyświetli dane stanu zamówienia Kod odpowiedzi HTTP 202 — nie istnieją ostatnio przesłane rekordy; Treść odpowiedzi będzie pusta. W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki: Location — adres URL następnego żądania. Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300. Uwaga: są to tylko zalecane wartości — aplikacja może wybrać sondę z inną częstotliwością w zależności od wymagań. Po pierwszym żądaniu wszystkie kolejne żądania powinny używać adresu URL podanego w nagłówku Lokalizacja najnowszej odpowiedzi. Nie dodawaj więcej parametrów do adresu URL, ponieważ zawiera już te, które są niezbędne do zapewnienia, że w żądaniu nie brakuje stanów zamówienia. Wyniki są sortowane według modifiedUtc, a następnie według StatusId w kolejności rosnącej. Nie można konfigurować parametrów sortowania. ModifiedUtc definicja: wewnętrzny tag czasu = czas zmiany najnowszych danych stanu zamówienia.
Sonda zamówień	Punkt końcowy sondowania interfejsu API zamówień umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnich zmian w zamówieniach. Integracja: Ten punkt końcowy jest przeznaczony do pracy z usługą Microsoft Flow jako integracją wyzwalacza sondowania. Alternatywnie możesz opracować własną integrację niestandardową przy użyciu dowolnego języka. Użycie: W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi: Kod odpowiedzi HTTP 200 — ostatnio zmienione zamówienia istnieją; Treść odpowiedzi wyświetli dane zamówienia. Kod odpowiedzi HTTP 202 — nie istnieją ostatnio zmienione zamówienia; Treść odpowiedzi będzie pusta. W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki: Location — adres URL następnego żądania. Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300. Uwaga: są to tylko zalecane wartości — aplikacja może wybrać sondę z inną częstotliwością w zależności od wymagań. Po pierwszym żądaniu wszystkie kolejne żądania powinny używać adresu URL podanego w nagłówku Lokalizacja najnowszej odpowiedzi. Nie dodawaj większej liczby parametrów do adresu URL, ponieważ zawiera on już niezbędne parametry wymagane do zapewnienia, że w żądaniu nie brakuje zmian kolejności. Wyniki są automatycznie sortowane według modifiedUtc, a następnie według OrderId w kolejności rosnącej. Nie można konfigurować parametrów sortowania. ModifiedUtc definicja: wewnętrzny tag czasu = czas zmiany najnowszych danych zamówienia.

Ankieta czasowa

Identyfikator operacji:: TimekeepingController_Poll

Punkt końcowy sondowania interfejsu API pomiaru czasu umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnio przesłanych wpisów czasowych.

Integracja:

Ten punkt końcowy jest przeznaczony do pracy z usługą Microsoft Flow jako integracją wyzwalacza sondowania. Alternatywnie możesz opracować własną integrację niestandardową przy użyciu dowolnego języka.

Użycie:

W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi:

Kod odpowiedzi HTTP 200 — istnieją ostatnio przesłane rekordy czasowe; Treść odpowiedzi wyświetli dane wpisu czasowego.
Kod odpowiedzi HTTP 202 — nie istnieją ostatnio przesłane rekordy; Treść odpowiedzi będzie pusta.

W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki:

Location — adres URL następnego żądania.
Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300.

Uwaga: są to tylko zalecane wartości — aplikacja może wybrać sondę z inną częstotliwością w zależności od wymagań. Po pierwszym żądaniu wszystkie kolejne żądania powinny używać adresu URL podanego w nagłówku Lokalizacja najnowszej odpowiedzi. Nie dodawaj więcej parametrów do adresu URL, ponieważ zawiera już te, które są niezbędne do zapewnienia, że w żądaniu nie brakuje wpisów utrzymywania czasu.

Wyniki są sortowane automatycznie według modifiedUtc, a następnie według timekeepingStatusId, a następnie w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

ModifiedUtc definicja: wewnętrzny tag czasu = czas ostatniej zmiany stanu czasomierza.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
excludeFormData	excludeFormData		boolean	Jeśli wartość true, ClockInFormData i ClockOutFormData zawsze będą mieć wartość null.

Zwraca

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Ankieta danych formularza

Identyfikator operacji:: FormController_Poll

Punkt końcowy sondowania interfejsu API formularzy umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnio przesłanych formularzy autonomicznych.

Integracja:

Użycie:

W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi:

Kod odpowiedzi HTTP 200 — istnieją ostatnio przesłane rekordy formularzy; Treść odpowiedzi wyświetli dane formularza.
Kod odpowiedzi HTTP 202 — nie istnieją ostatnio przesłane rekordy; Treść odpowiedzi będzie pusta.

W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki:

Location — adres URL następnego żądania.
Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300.

Uwaga: są to tylko zalecane wartości — aplikacja może wybrać sondę z inną częstotliwością w zależności od wymagań. Po pierwszym żądaniu wszystkie kolejne żądania powinny używać adresu URL podanego w nagłówku Lokalizacja najnowszej odpowiedzi. Nie dodawaj więcej parametrów do adresu URL, ponieważ zawiera już niezbędne parametry wymagane do zapewnienia braku formularzy w żądaniu.

Wyniki są sortowane automatycznie według modifiedUtc, a następnie według FormHeaderId w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

ModifiedUtc definicja: wewnętrzny tag czasu = czas ostatniej zmiany danych formularza.

Zwraca

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Sonda stanów zamówienia

Identyfikator operacji:: OrderController_StatusPoll

Punkt końcowy sondowania interfejsu API stanu zamówienia umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnich zmian w zamówieniach.

Integracja:

Użycie:

W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi:

Kod odpowiedzi HTTP 200 — ostatnio zmienione rekordy stanu zamówienia istnieją; Treść odpowiedzi wyświetli dane stanu zamówienia
Kod odpowiedzi HTTP 202 — nie istnieją ostatnio przesłane rekordy; Treść odpowiedzi będzie pusta.

W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki:

Location — adres URL następnego żądania.
Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300.

Wyniki są sortowane według modifiedUtc, a następnie według StatusId w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

ModifiedUtc definicja: wewnętrzny tag czasu = czas zmiany najnowszych danych stanu zamówienia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
excludeFormData	excludeFormData		boolean	Jeśli wartość true, wartości FieldValues zawsze będą pustą tablicą.

Zwraca

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Sonda zamówień

Identyfikator operacji:: OrderController_Poll

Punkt końcowy sondowania interfejsu API zamówień umożliwia aplikacji ciągłe sondowanie i przetwarzanie ostatnich zmian w zamówieniach.

Integracja:

Użycie:

W typowym scenariuszu pierwsze żądanie do tego punktu końcowego nie powinno zawierać żadnych parametrów. Istnieją dwie (2) możliwe pomyślne odpowiedzi:

Kod odpowiedzi HTTP 200 — ostatnio zmienione zamówienia istnieją; Treść odpowiedzi wyświetli dane zamówienia.
Kod odpowiedzi HTTP 202 — nie istnieją ostatnio zmienione zamówienia; Treść odpowiedzi będzie pusta.

W obu przypadkach w odpowiedzi znajdują się dwa (2) ważne nagłówki:

Location — adres URL następnego żądania.
Retry-After — zalecany interwał czasu w sekundach dla następnego żądania. Jeśli na przykład istnieją dane do pobrania, nagłówek Retry-After będzie miał wartość 1 lub 60. Jeśli nie ma danych do pobrania, wartość nagłówka Retry-After będzie wynosić 300.

Uwaga: są to tylko zalecane wartości — aplikacja może wybrać sondę z inną częstotliwością w zależności od wymagań. Po pierwszym żądaniu wszystkie kolejne żądania powinny używać adresu URL podanego w nagłówku Lokalizacja najnowszej odpowiedzi. Nie dodawaj większej liczby parametrów do adresu URL, ponieważ zawiera on już niezbędne parametry wymagane do zapewnienia, że w żądaniu nie brakuje zmian kolejności.

Wyniki są automatycznie sortowane według modifiedUtc, a następnie według OrderId w kolejności rosnącej. Nie można konfigurować parametrów sortowania.

ModifiedUtc definicja: wewnętrzny tag czasu = czas zmiany najnowszych danych zamówienia.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
excludeFormData	excludeFormData		boolean	Jeśli wartość true, pole OrderFormFields będzie zawsze pustą tablicą.
excludeCustomFieldData	excludeCustomFieldData		boolean	Jeśli wartość true, pola niestandardowe nie zostaną zwrócone.

Zwraca

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

Definicje

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Nazwa	Ścieżka	Typ	Opis
Id	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Nazwa	Ścieżka	Typ	Opis
Id	Id	integer	Identyfikator klienta.
ExternalId	ExternalId	string	Identyfikator użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
CreatedUtc	CreatedUtc	date-time	Oryginalny punkt w czasie, w którym został utworzony klient.
ModifiedUtc	ModifiedUtc	date-time	Ostatni punkt w czasie, w którym klient został zaktualizowany.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Name	Name	string	Nazwa klienta.
Address	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Nazwa	Ścieżka	Typ	Opis
FieldIndex	FieldIndex	integer	Indeks pola.
Napisy	Caption	string	Podpis pola.
Typ danych	DataType	integer	Typ danych pola.
DateTimeFormat	DateTimeFormat	integer	Format daty/godziny.
Wartość	Value		Wartość pola.

CustomerAPI.Models.LocationApiModel

Nazwa	Ścieżka	Typ	Opis
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Adres1	AddressLine1	string	AddressLine1 tej lokalizacjiApiModel.
AdresLinia2	AddressLine2	string	AddressLine2 tej lokalizacjiApiModel.
Miejscowość	City	string	Miasto locationApiModel.
Nazwa regionu	RegionName	string	Nazwa regionu locationApiModel.
Kod pocztowy	PostalCode	string	Kod pocztowy elementu LocationApiModel.
Kod kraju	CountryCode	string	Kod ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion lokalizacjiApiModel.
SubRegionCode	SubRegionCode	string	SubRegion Code obiektu LocationApiModel.
Kod regionu	RegionCode	string	Kod regionu lokalizacjiApiModel.

CustomerAPI.Models.Client.ContactApiModel

Nazwa	Ścieżka	Typ	Opis
Name	Name	string	Nazwa modelu ContactApiModel.
Numer Telefonu	PhoneNumber	string	PhoneNumber of the ContactApiModel.
Email	Email	string	Adres e-mail contactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Nazwa	Ścieżka	Typ	Opis
Szerokość	Latitude	double
Długość	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Nazwa	Ścieżka	Typ	Opis
Id	Id	integer	Identyfikator obiektu.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Definiuje niestandardowy model interfejsu API elementu listy definicji listy.

Nazwa	Ścieżka	Typ	Opis
Identyfikator listy niestandardowej	CustomListId	integer	Identyfikator listy niestandardowej.
Name	Name	string	Nazwa listy niestandardowej.
wersja	Version	string	Wersja listy niestandardowej.

CustomerAPI.Models.CustomLists.CustomListApiModel

Niestandardowy model listy.

Nazwa	Ścieżka	Typ	Opis
Identyfikator listy niestandardowej	CustomListId	integer	Identyfikator listy niestandardowej.
Name	Name	string	Nazwa listy niestandardowej.
wersja	Version	string	Wersja listy niestandardowej.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Definiuje niestandardowy model interfejsu API definicji listy.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Definiuje niestandardowy model interfejsu API definicji listy.

Nazwa	Ścieżka	Typ	Opis
Kolumny	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Kolumny listy niestandardowej.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Unikatowy indeks kolumny.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Definiuje niestandardowy model interfejsu API kolumn definicji listy.

Nazwa	Ścieżka	Typ	Opis
Index	Index	integer	Indeks kolumny.
Typ danych	DataType	integer	Typ danych kolumny (tekst: 0, liczbowy: 1, data: 2, godzina: 3, data/godzina: 4, adres e-mail: 5).
Name	Name	string	Nazwa kolumny.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Kontener dla niestandardowej tablicy danych kolumn listy.

Nazwa	Ścieżka	Typ	Opis
KolumnyWartości	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Tablica kolumn z danymi.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Ten model definiuje niestandardową wartość kolumny listy.

Nazwa	Ścieżka	Typ	Opis
ColumnIndex	ColumnIndex	integer	Niestandardowy indeks kolumny listy.
Napisy	Caption	string	Niestandardowy podpis kolumny listy.
Wartość	Value		Wartość kolumny listy niestandardowej.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Niestandardowy model definicji zdarzeń.

Nazwa	Ścieżka	Typ
Id	Id	string
Name	Name	string
ReverseGeocode	ReverseGeocode	boolean
Parametry	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Nazwa	Ścieżka	Typ
Name	Name	string
Typ	Type	integer
Napisy	Caption	string
Wymagane	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Nazwa	Ścieżka	Typ	Opis
EventId	EventId	integer	Identyfikator zdarzenia.
Typ Wydarzenia	EventType	integer
Kod zdarzenia	EventCode	string	Kod zdarzenia.
Czas Wydarzenia	EventTime	date-time	Format ISO z formatem lokalnym i przesunięciem.
User	User	CustomerAPI.Models.UserReferenceApiModel
Pojazd	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Jeśli to ustawienie zostało włączone, pojazd zdarzenia ma przypisanego użytkownika.
Lokalizacja	Location	CustomerAPI.Models.LocationApiModel
Podstawowageofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	Identyfikator definicji zdarzenia zewnętrznego.
EventParams	EventParams	object	Parametry zdarzenia.

CustomerAPI.Models.UserReferenceApiModel

Nazwa	Ścieżka	Typ	Opis
UserId	UserId	integer	UserId użytkownika.
Imię (pierwsze)	FirstName	string	Imię użytkownika.
Nazwisko	LastName	string	Nazwisko użytkownika.
Numer pracownika	EmployeeNumber	string	Numer pracownika użytkownika.
Nazwa grupy	GroupName	string	Nazwa grupy przypisanej do użytkownika.

CustomerAPI.Models.ReadVehicleApiModel

Nazwa	Ścieżka	Typ	Opis
VehicleId	VehicleId	integer	Identyfikator modelu BaseVehicleApiModel.
Name	Name	string	Nazwa modelu BaseVehicleApiModel.
VIN	VIN	string	Numer identyfikacyjny pojazdu BaseVehicleApiModel.
Nazwa urządzenia	DeviceName	string	Nazwa GpsDeviceDto skojarzonej z modelem BaseVehicleApiModel.
SerialNumber	SerialNumber	string	Numer seryjny modelu BaseVehicleApiModel.
Nazwa grupy	GroupName	string	GroupName elementu BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Nazwa	Ścieżka	Typ	Opis
Identyfikator geofencingu	GeofenceId	integer	Identyfikator geofencingu.
Name	Name	string	Nazwa geofencingu.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Nazwa	Ścieżka	Typ	Opis
Identyfikator subskrypcji	SubscriptionId	string	Identyfikator elementu WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Nazwa	Ścieżka	Typ	Opis
Identyfikator subskrypcji	SubscriptionId	string
URL	Url	string
Status	Status	integer	Stan subskrypcji — (Uruchomione: 1, Zatrzymano: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Nazwa	Ścieżka	Typ	Opis
Id	Id	integer	Identyfikator skojarzony z tym standaloneFormApiModel — (starszy komentarz: FormHeaderId).
Identyfikator formularza	FormId	integer	Identyfikator formularza, do których odwołuje się ten element StandaloneFormApiModel.
Nazwa formularza	FormName	string	Nazwa formularza, do których odwołuje się ten standaloneFormApiModel.
Numer wpisu	EntryNumber	string	Numer wpisu danych formularza.
Napisał(a) recenzję	Reviewed	boolean	Stan przeglądu tego standaloneFormApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel
Przesłany czas	SubmittedTime	date-time	Punkt w czasie przesłania modelu StandaloneFormApiModel.
StartTime	StartTime	date-time	Punkt w czasie uruchomienia modelu StandaloneFormApiModel.
Przesłanelokalizacja	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Lista pól skojarzonych z tym standaloneFormApiModel.
Identyfikator apiModuleId	ApiModuleId	string	Identyfikator modułu ApiModule skojarzonego z tym elementem StandaloneFormApiModel.
SharedUrl	SharedUrl	string	Udostępniony adres URL tego elementu StandaloneFormApiModel.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	Czas przeglądu formularza

CustomerAPI.Models.Forms.FormFieldDataApiModel

Nazwa	Ścieżka	Typ	Opis
Powtarzalne	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id	Id	string	Identyfikator modelu FormFieldDataApiModel.
Wartość	Value		Wartość elementu FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue elementu FormFieldDataApiModel.
Przechwycony czas	CapturedTime	date-time	Wartość punktu w czasie została przechwycona przez model FormFieldDataApiModel.
Przechwyconalokacja	CapturedLocation	CustomerAPI.Models.LocationApiModel
Napisy	Caption	string	Podpis zawartości elementu FormFieldDataApiModel.
Identyfikator ApiFieldId	ApiFieldId	string	Identyfikator pola ApiField modelu FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Nazwa	Ścieżka	Typ	Opis
Id	Id	string	Identyfikator modelu FormFieldDataApiModel.
Wartość	Value		Wartość elementu FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue elementu FormFieldDataApiModel.
Przechwycony czas	CapturedTime	date-time	Wartość punktu w czasie została przechwycona przez model FormFieldDataApiModel.
Przechwyconalokacja	CapturedLocation	CustomerAPI.Models.LocationApiModel
Napisy	Caption	string	Podpis zawartości elementu FormFieldDataApiModel.
Identyfikator ApiFieldId	ApiFieldId	string	Identyfikator pola ApiField modelu FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Nazwa	Ścieżka	Typ	Opis
Identyfikator geofencingu	GeofenceId	integer	GeofenceId elementu GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc obiektu GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc elementu GeofenceApiModel.
Nazwy grupy	GroupNames	array of string	GroupPaths obiektu GeofenceApiModel.
Name	Name	string	Nazwa bazy danych GeofenceApiModelBase.
Typ	Type	string	Typ elementu GeofenceApiModel.
Shape	Shape	integer	Kształt: 0 dla okręgu i 1 dla wielokąta.
Address	Address	CustomerAPI.Models.LocationApiModel
Promień	Radius	double	Promień obiektu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress elementu GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Nazwa	Ścieżka	Typ	Opis
Szerokość	Latitude	double
Długość	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Nazwa	Ścieżka	Typ	Opis
Identyfikator geofencingu	GeofenceId	integer	GeofenceId elementu GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc obiektu GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc elementu GeofenceApiModel.
Nazwy grupy	GroupNames	array of string	GroupPaths obiektu GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Punkty wielokątne. Powinien być wypełniony, gdy kształt ma wartość 1.
Name	Name	string	Nazwa bazy danych GeofenceApiModelBase.
Typ	Type	string	Typ elementu GeofenceApiModel.
Shape	Shape	integer	Kształt: 0 dla okręgu i 1 dla wielokąta.
Address	Address	CustomerAPI.Models.LocationApiModel
Promień	Radius	double	Promień obiektu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress elementu GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Nazwa	Ścieżka	Typ	Opis
IdentyfikatorZamówienia	OrderId	integer	Identyfikator elementu OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Identyfikator OrderId użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
Data ukończenia	DueDate	date-time	Ten element OrderBaseApiModel ma zostać ukończony (przestarzałe w wersji 1.3).
StartTime	StartTime	date-time	Punkt w czasie ten element OrderBaseApiModel powinien zostać uruchomiony (wprowadzony w wersji 1.3).
EndTime	EndTime	date-time	Ten element OrderBaseApiModel ma zostać ukończony (wprowadzony w wersji 1.3).
ServiceType	ServiceType	string	ServiceType skojarzony z tym elementem OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Punkt w czasie utworzenia elementu OrderBaseApiModel.
Numer zamówienia	OrderNumber	string	Numer zamówienia skojarzony z tym elementem OrderBaseApiModel.
IsClosed	IsClosed	boolean	Stan wyświetlany, jeśli element OrderBaseApiModel jest zamknięty.
Status	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Identyfikator użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
ClientId	ClientId	integer	wewnętrzny identyfikator użycia dla właściwości Rozszerzenia interfejsu API klienta.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
Identyfikator apiServiceId	ApiServiceId	string	Identyfikator usługi ApiService skojarzonej z tym elementem OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Wersja modułu pola niestandardowego.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Powtarzalność	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Nazwa	Ścieżka	Typ	Opis
StatusIndex	StatusIndex	integer	Indeks elementu OrderStatusApiModel.
Typ stanu	StatusType	integer	Stan zamówienia: 0 dla nowego zamówienia, 1 dla wysłanego, 2 w toku, 3 do ukończenia i 4 w przypadku anulowania.
StatusLabel	StatusLabel	string	Etykieta zawartości Elementu OrderStatusApiModel.
Identyfikator stanu	StatusId	integer	Identyfikator elementu OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Punkt w czasie rozpoczęcia elementu OrderStatusApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Nazwa	Ścieżka	Typ	Opis
Nazwy grupy	GroupNames	array of string	Nazwy hierarchiczne grup klientów.
Name	Name	string	Nazwa klienta.
Address	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Nazwa	Ścieżka	Typ	Opis
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Lista elementów OrderStatusListItems skojarzonych z tym modelem OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
IdentyfikatorZamówienia	OrderId	integer	Identyfikator elementu OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Identyfikator OrderId użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
Data ukończenia	DueDate	date-time	Ten element OrderBaseApiModel ma zostać ukończony (przestarzałe w wersji 1.3).
StartTime	StartTime	date-time	Punkt w czasie ten element OrderBaseApiModel powinien zostać uruchomiony (wprowadzony w wersji 1.3).
EndTime	EndTime	date-time	Ten element OrderBaseApiModel ma zostać ukończony (wprowadzony w wersji 1.3).
ServiceType	ServiceType	string	ServiceType skojarzony z tym elementem OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Punkt w czasie utworzenia elementu OrderBaseApiModel.
Numer zamówienia	OrderNumber	string	Numer zamówienia skojarzony z tym elementem OrderBaseApiModel.
IsClosed	IsClosed	boolean	Stan wyświetlany, jeśli element OrderBaseApiModel jest zamknięty.
Status	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Identyfikator użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
ClientId	ClientId	integer	wewnętrzny identyfikator użycia dla właściwości Rozszerzenia interfejsu API klienta.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
Identyfikator apiServiceId	ApiServiceId	string	Identyfikator usługi ApiService skojarzonej z tym elementem OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Wersja modułu pola niestandardowego.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Powtarzalność	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Nazwa	Ścieżka	Typ	Opis
StatusStartDateTime	StatusStartDateTime	date-time	Punkt w czasie został uruchomiony stan OrderStatusHistoryListItemApiModel.
StatusEndDateTime	StatusEndDateTime	date-time	Punkt w czasie ten stan OrderStatusHistoryListItemApiModel został zakończony.
Identyfikator stanu	StatusId	integer	Identyfikator skojarzony z tym elementem OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Indeks skojarzony z tym elementem OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Oznacz zawartość skojarzoną z tym elementem OrderStatusHistoryListItemApiModel.
Typ stanu	StatusType	integer	Stan zamówienia: 0 dla nowego zamówienia, 1 dla wysłanego, 2 w toku, 3 do ukończenia i 4 w przypadku anulowania.
ExternalOrderId	ExternalOrderId	string	Identyfikator OrderId użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
IdentyfikatorZamówienia	OrderId	integer	OrderId skojarzony z tym Elementem OrderStatusHistoryListItemApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
Identyfikator apiServiceId	ApiServiceId	string	Identyfikator usługi ApiService skojarzonej z tym elementem OrderStatusHistoryListItemApiModel.
Wartości pól	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Nazwa	Ścieżka	Typ	Opis
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
IdentyfikatorZamówienia	OrderId	integer	Identyfikator elementu OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Identyfikator OrderId użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
Data ukończenia	DueDate	date-time	Ten element OrderBaseApiModel ma zostać ukończony (przestarzałe w wersji 1.3).
StartTime	StartTime	date-time	Punkt w czasie ten element OrderBaseApiModel powinien zostać uruchomiony (wprowadzony w wersji 1.3).
EndTime	EndTime	date-time	Ten element OrderBaseApiModel ma zostać ukończony (wprowadzony w wersji 1.3).
ServiceType	ServiceType	string	ServiceType skojarzony z tym elementem OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Punkt w czasie utworzenia elementu OrderBaseApiModel.
Numer zamówienia	OrderNumber	string	Numer zamówienia skojarzony z tym elementem OrderBaseApiModel.
IsClosed	IsClosed	boolean	Stan wyświetlany, jeśli element OrderBaseApiModel jest zamknięty.
Status	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Identyfikator użycia zewnętrznego dla właściwości Rozszerzenia interfejsu API klienta.
ClientId	ClientId	integer	wewnętrzny identyfikator użycia dla właściwości Rozszerzenia interfejsu API klienta.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
Identyfikator apiServiceId	ApiServiceId	string	Identyfikator usługi ApiService skojarzonej z tym elementem OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Wersja modułu pola niestandardowego.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Powtarzalność	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Nazwa	Ścieżka	Typ	Opis
Id	Id	integer	Identyfikator wpisu czasowego (starszy komentarz: RootSubmittedStatusId).
User	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Punkt w czasie, gdy użytkownik był taktowany do systemu.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Punkt w czasie, gdy użytkownik zegara z systemu.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Łączna liczba godzin dla tego wpisu czasowego.
TotalBreakHours	TotalBreakHours	double	Całkowita liczba godzin przerwania (bez pracy) dla tego wpisu czasowego.
NetHours	NetHours	double	Łączna liczba godzin naliczanych za ten wpis czasowy.
Zatwierdzony	Approved	boolean	Stan zatwierdzenia nadzorcy dla tego wpisu czasowego.
Przerwy	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
Identyfikator elementu CompanyModuleId	CompanyModuleId	integer	Identyfikator modułu firmy użytego do przesłania tego wpisu czasowego.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Nazwa	Ścieżka	Typ	Opis
Id	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Godzina rozpoczęcia.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Czas zakończenia.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Czas trwania w godzinach. Może to być wartość null, jeśli wartość EndTime ma wartość null.
Typ stanu	StatusType	integer	Typ stanu: 1 na przerwę i 2 na lunch.
Etykieta początkowa	StartLabel	string	Rozpocznij etykietę.
EndLabel	EndLabel	string	Etykieta końcowa.
Napisy	Caption	string	Podpis.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Nazwa	Ścieżka	Typ
Identyfikator elementu CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
Wartości pól	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Nazwa	Ścieżka	Typ
_Major	_Major	integer
_Małoletni	_Minor	integer
_Budować	_Build	integer
_Rewizja	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Nazwa	Ścieżka	Typ	Opis
User	User	CustomerAPI.Models.UserReferenceApiModel
Pojazd	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Punkt w czasie uruchomienia tego stanu TripApiModel.
EndTime	EndTime	date-time	Punkt w czasie ten stan TripApiModel został zakończony.
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	Ilość czasu zatrzymania w godzinach skojarzonych z tą aplikacją TripApiModel.
TotalIdleTime	TotalIdleTime	double	Ilość czasu bezczynności w godzinach skojarzonych z tym modelem TripApiModel.
TotalDuration	TotalDuration	double	Pełny czas w godzinach skojarzenia z tym modelem TripApiModel.
Odległość	Distance	double	Odległość podróży w zlokalizowanych jednostkach skojarzonych z tym TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Nazwa	Ścieżka	Typ	Opis
Rekordy	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Nazwa	Ścieżka	Typ	Opis
User	User	CustomerAPI.Models.UserReferenceApiModel
Pojazd	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
Znacznik czasu	TimeTag	date-time	TimeTag skojarzony z tym Elementem GpsDataRecordApiModel.
Lokalizacja	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Wirtualne ogrodzenie	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Szybkość	Speed	double	Szybkość ruchu skojarzonego z tym GpsDataRecordApiModel.
Heading	Heading	double	Kierunek kompasu w stopniach skojarzonych z tym GpsDataRecordApiModel.
Status	Status	integer	ApiMovementStatus skojarzony z elementem OrderBaseApiModel — (Zatrzymano: 1, Bezczynność: 2, Przenoszenie: 3, NotTracking: 4) : OrderStatusApiModel.
Czas aktualizacji statusu	StatusTime	string	Punkt w czasie ustawiono ten stan GpsDataRecordApiModel.
Odległość	Distance	double	Odległość podróżować w zlokalizowanych jednostkach skojarzonych z tym TripApiModel.
Stacyjka	IgnitionOn	boolean	Stan zapłonu pojazdu skojarzonego z tym GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Dostawca lokalizacji interfejsu API skojarzony z tym GpsDataRecordApiModel - (GPS: 1, sieć: 2).

CustomerAPI.Models.User.ReadUserApiModel

Nazwa	Ścieżka	Typ	Opis
Nazwa użytkownika	UserName	string	UserName użytkownika.
UserId	UserId	integer	Wartość identyfikatora użytkownika.
Nazwa grupy	GroupName	string	Nazwa grupy użytkownika.
Imię (pierwsze)	FirstName	string	Imię użytkownika.
Nazwisko	LastName	string	Nazwisko użytkownika.
Numer pracownika	EmployeeNumber	string	Numer pracownika użytkownika.
Email	Email	string	Adres e-mail użytkownika.
Telefon	Phone	string	Numer telefonu użytkownika.
Identyfikator roli	RoleId	integer	RoleId użytkownika — (administrator: 1, użytkownik: 3, użytkownik: 5).
IsActive	IsActive	boolean	Aktywny stan użytkownika.
EPTTEnabled	EPTTEnabled	boolean	Stan rozszerzonej funkcji wypychania do rozmowy dla użytkownika: wartość logiczna.
Numer EPTT	EPTTNumber	string	Numer telefonu dla rozszerzonej funkcji wypychania do rozmowy dla użytkownika: ciąg.
EPTTWebMDN	EPTTWebMDN	string	Numer telefonu używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
EPTTToken	EPTTToken	string	Token interfejsu API używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
GPSEnabled	GPSEnabled	boolean	Stan funkcji GPS dla użytkownika.
MobileOnly	MobileOnly	boolean	Stan dostępu aplikacji internetowej klasycznej dla pliku CAB — (brak dostępu do aplikacji internetowej: prawda, pełny dostęp do aplikacji: fałsz).
Typ licencji	LicenseType	integer	Typ licencji przypisanej do użytkownika: - 0 dla niezdefiniowanych, 1 dla zwykłych, 2 dla webonly i 3 dla pracownika.

CustomerAPI.Models.User.ReadUserListItemApiModel

Nazwa	Ścieżka	Typ	Opis
UserId	UserId	integer	Wartość identyfikatora użytkownika.
Imię (pierwsze)	FirstName	string	Imię użytkownika.
Nazwisko	LastName	string	Nazwisko użytkownika.
Numer pracownika	EmployeeNumber	string	Numer pracownika użytkownika.
Email	Email	string	Adres e-mail użytkownika.
Telefon	Phone	string	Numer telefonu użytkownika.
Identyfikator roli	RoleId	integer	RoleId użytkownika — (administrator: 1, użytkownik: 3, użytkownik: 5).
IsActive	IsActive	boolean	Aktywny stan użytkownika.
EPTTEnabled	EPTTEnabled	boolean	Stan rozszerzonej funkcji wypychania do rozmowy dla użytkownika: wartość logiczna.
Numer EPTT	EPTTNumber	string	Numer telefonu dla rozszerzonej funkcji wypychania do rozmowy dla użytkownika: ciąg.
EPTTWebMDN	EPTTWebMDN	string	Numer telefonu używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
EPTTToken	EPTTToken	string	Token interfejsu API używany do uwierzytelniania użytkownika w systemie Kodiak EPTT — dostarczony przez Kodiak.
GPSEnabled	GPSEnabled	boolean	Stan funkcji GPS dla użytkownika.
MobileOnly	MobileOnly	boolean	Stan dostępu aplikacji internetowej klasycznej dla pliku CAB — (brak dostępu do aplikacji internetowej: prawda, pełny dostęp do aplikacji: fałsz).
Typ licencji	LicenseType	integer	Typ licencji przypisanej do użytkownika: - 0 dla niezdefiniowanych, 1 dla zwykłych, 2 dla webonly i 3 dla pracownika.

CustomerAPI.Models.Vehicles.VehicleReadApi

Model danych pojazdu.

Nazwa	Ścieżka	Typ
Identyfikator wewnętrzny	InternalId	integer
Number	Number	string
Name	Name	string
Typ	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
Nazwa grupy	GroupName	string
TimeZone	TimeZone	string
Robić	Make	string
Rok	Year	integer
Model	Model	string
Kolor	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Typ urządzenia	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

liczba całkowita

Jest to podstawowy typ danych "liczba całkowita".

obiekt

Jest to typ 'obiekt'.

Udostępnij przez

TeamWherx

Tworzenie połączenia

Domyślny

Limity ograniczania

Akcje

Aktualizowanie części użytkownika

Parametry

Zwraca

Aktualizowanie istniejącego geofencingu

Parametry

Zwraca

Aktualizowanie klienta

Parametry

Zwraca

Aktualizowanie pojazdu

Parametry

Zwraca

Aktualizowanie stanu zamówienia

Parametry

Zwraca

Aktualizowanie użytkownika

Parametry

Zwraca

Aktualizowanie zamówienia

Parametry

Zwraca

Aktywowanie pojazdu

Parametry

Zwraca

Aktywowanie użytkownika

Parametry

Anulowanie subskrypcji elementu webhook danych GPS

Parametry

Anulowanie subskrypcji zdarzeń webhook

Parametry

Częściowa aktualizacja pojazdu

Parametry

Zwraca

Dezaktywacja pojazdu

Parametry

Zwraca

Dezaktywowanie użytkownika

Parametry

Pobieranie klienta

Parametry

Zwraca

Pobieranie listy formularzy

Parametry

Zwraca

Pobieranie listy geofencingów

Parametry

Zwraca

Pobieranie listy klientów

Parametry

Zwraca

Pobieranie listy niestandardowych definicji zdarzeń

Zwraca

Pobieranie listy niestandardowych pól listy według identyfikatora CustomListID

Parametry

Zwraca

Pobieranie listy podróży

Parametry

Zwraca

Pobieranie listy pojazdów

Parametry

Zwraca

Pobieranie listy subskrypcji

Zwraca

Pobieranie listy subskrypcji zdarzeń webhook

Zwraca

Pobieranie listy użytkowników

Parametry

Zwraca

Pobieranie listy wpisów utrzymywania czasu

Parametry

Zwraca

Pobieranie listy zamówień

Parametry

Zwraca