共用方式為

團隊Wherx

TeamWherx（TW） 是一個一體化服務管理平台，可幫助您更有效地管理遠距員工團隊和遠離辦公室的一般業務營運。 作為基於雲的解決方案，TW 支持遠程數據收集並通過其 Web 應用程序儀表板進行顯示，為管理人員提供所需的額外洞察力，以創建更智能的策略，以提高效率、生產力和降低成本，同時協調他們的移動勞動力。

此連接器適用於以下產品和區域：

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 （DoD）
Power Apps 進階 除下列區域外的所有 Power Apps 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
連絡人​​
名稱 Actsoft 支援
URL https://www.actsoft.com/self-help-wizards
Email support@actsoft.com
連接器中繼資料
Publisher 行動軟體
網站 https://actsoft.com
隱私策略 https://www.actsoft.com/privacy
類別 生產力

連接器說明：

TeamWherx 允許您創建和捕獲數字表單信息、員工計時信息並使用調度系統管理工單。

詳細說明

TeamWherx 連接器使用戶能夠在多個平台之間連接和交換信息。 您可以為資料製作動畫以建立流程、驅動其他內部應用程式，並為強大的分析提供資訊。 自動化和簡化您的每日、每週或每月流程，並存取 up-to即時可操作的資料。

## 先決條件

若要使用此連接器，您將需要下列專案：

  • TeamWherx 帳戶

  • TeamWherx API 金鑰

  • Microsoft Power Apps 或 Power Automate 方案

## 如何取得憑證

API 開發人員入口網站

若要存取連接器，您必須先設定 API 開發人員入口網站的使用者名稱和密碼，並訂閱客戶 API：

  1. 從應用程式內部，移至 [管理>設定>API設定]。

  2. 選擇 Create Credentials （建立憑證）。

  3. 在適當的欄位中輸入您的名字和姓氏。

  4. 在電子郵件地址欄位中輸入您的電子郵件地址。

  5. 選擇 [儲存並傳送電子郵件邀請]。 然後，檢查您的電子郵件以獲取有關創建密碼的說明。

  6. 進入邀請電子郵件後，按一下「 選擇密碼」，這將開啟一個對話框，允許您建立密碼。

  7. 選擇 Save password （儲存密碼）。

  8. 若要繼續前往開發人員入口網站，請從應用程式內部移至 [管理設定>]> 移至 開發人員入口網站。

  9. 在開發人員入口網站內，選擇 產品，然後選取 客戶API。

  10. 選擇 [訂閱]。

API 金鑰

現在您是註冊的 API 使用者，已為您產生稱為索引鍵的英數字列。 您將需要此金鑰才能在 API 中使用您的資料。

若要尋找您的 API 金鑰：

  1. 從「開發人員入口網站」功能表中選擇 產品 。 將顯示您的授權中可用的 API 產品。

  2. 在「您有 X 個此產品訂閱」下方選取 客戶 API 版本。

  3. 選擇訂閱主索引鍵旁的 顯示 。

  4. 選取欄位的內容，按一下滑鼠右鍵，然後選擇 [複製]。 金鑰現在已儲存至剪貼簿，並準備好貼上。

## 開始使用您的連接器

  1. 移至我的流程新>流程，然後選取自動化雲端流程。

  2. 從建置自動化雲端流程對話方塊中選擇 手動觸發流程 。

  3. 為您的流程命名，或讓系統自動產生流程。

  4. 搜尋並選擇流程的觸發器。

  5. 選擇 [建立] 。

  6. 在搜尋欄位中，搜尋並選擇 TeamWherx 連接器。

  7. 尋找您要使用連接器執行的動作。

系統將提示您登入執行所選操作所需的所有應用程序，跳過您已登入的任何應用程式。

  1. 在 [連接器] 欄位中輸入新連接器的名稱。

  2. 然後，輸入您的 API 金鑰。

  3. 選擇 [建立] 。 流程中的第一個步驟會顯示為流程圖中的第一個「方塊」。

  4. 選擇 [新增步驟 ] 以繼續將更多動作和步驟新增至連接器程序流程。

  5. 選擇儲存。

**使用聯結器 - 訂單狀態輪詢範例
** 以下指示向您展示如何建立流程以在工作表中插入列，並在訂單狀態更新時插入更新訂單的員工的識別資料。

  1. 移至 連接器。

  2. 搜尋並選擇 [TeamWherx] 連接器。

  3. 從動作清單中選擇 Order statuses poll （排序狀態輪詢 ）。

  4. 在 [連線名稱] 欄位中輸入新連線的名稱。

  5. 然後，輸入您的 API 金鑰。

  6. 選擇 [建立] 。 流程中的第一個步驟會顯示為流程圖中的第一個「方塊」。

連線流程步驟中的每個動作對話方塊都會有屬性欄位，您可以自訂這些欄位來控制所執行的動作。

  1. 繼續範例，選擇是否要顯示表單欄位值（excludeFormData引數）。

  2. 選擇連線的 X-API 版本。

  3. 選擇 Next step （下一步 ） 以設定您希望在訂單狀態變更時執行的動作。

  4. 在 [ 選擇作業 ] 對話方塊中，使用搜尋欄位來尋找應用程式，然後找到所需的動作。 例如，如果您想在每次訂單狀態變更時在 Google 工作表中插入一列，您可以選擇 Google試算表，然後選擇 插入列 進行操作。

  5. 在隨後的 [插入列 ] 對話方塊中，按一下 [檔案 ] 欄位，然後選擇將包含結果的檔案。

  6. 在 Worksheet （工作表 ） 欄位中，選擇 資料 工作表類型。 動態顯示的欄位是工作表中的資料欄。

  7. 按一下每個欄的欄位，然後從 訂單狀態輪詢 屬性 清單中選擇屬性。 或者，您可以使用搜尋欄位來尋找特定屬性。

  8. 您可以在每個欄欄位中輸入多個屬性;在 Event （事件） 欄中，選擇 StatusLabel，插入破折號，然後選擇 StatusStartDate。 這表示對於每個訂單狀態更新，狀態標籤和狀態開始日期將寫入新列的「事件」欄。

  9. 選取 [新增步驟]。 順便說一句，您可以隨時將鼠標懸停並單擊箭頭連接器以插入新步驟

  10. 在 [ 選擇作業 ] 對話方塊中，再次選取 TeamWherx 連接器，然後選取 [ 建立 動作的用戶端]。

同樣，對話框中顯示的每個字段將代表 Google 試算表中的一列。 按一下每個欄位以啟用 訂單狀態輪詢 屬性 清單，然後選取您想要的屬性。

  1. 在此範例中，請為「名稱」欄位選擇「EmployeeNumber」，以識別更新訂單狀態的員工。

  2. 選擇 GroupName 並將其也插入 Name 欄位。

  3. 選擇儲存。

現在，您已經建立了一個流程，每次更新訂單狀態時，都會使用員工編號及其關聯群組更新您的試算表。

## 已知問題與限制

  • 所有端點的音訊檔案二進位上傳 （POST） 僅限於 MP4。

  • 必須根據RFC3339準則指定所有需要日期時間資訊的端點的日期，如下列範例所示：2021-09-22T02：36：56.52Z。 不需要在時間戳記中指定確切的秒數;00 是可以接受的。

## 常見錯誤及補救措施

可能發生的常見錯誤、回應代碼和更正範例可在 API 開發人員入口網站找到：

安可 - https://developer.wfmplatform.com/

## 常見問題

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有區域 不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
API 金鑰 securestring 此 API 的 API 金鑰 對

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

上傳二進位檔案

使用此選項可上傳表單影像和音訊檔案。 二進位大小限制為 10MB。 支援的檔案類型有：JPEG、PNG 和 MP4。
上傳附件檔案

使用此選項可上傳表單檔案附件。 二進位大小限制為 25MB。 預期具有單一檔案的多部分/表單資料請求。
依 CustomListID 取得自訂清單欄位清單

使用 CustomListID 擷取單一自訂清單的欄位清單。
依 CustomListID 取得自訂清單資料

使用 CustomListID 擷取單一自訂清單中的所有資料記錄。

結果會依資料行排序，並支援分頁。

錯誤：

404 - 提供的 customListId 沒有自訂清單。
依識別碼取得自訂事件定義

依識別碼擷取單一自訂事件定義。
停用使用者

依現有使用者的 ID 停用。
停用車輛

通過 ID 停用車輛。
具有事件摘要的 Web 掛鉤回呼

事件/訂閱使用此範例方法，使用客戶提供的URL回傳事件資料摘要。
刪除地理柵欄

依其識別碼刪除現有的地理柵欄。
刪除用戶端

依其識別碼刪除現有用戶端。
刪除自訂事件定義

刪除自訂事件定義。
刪除自訂清單記錄

依自訂清單中的 customListId 和 ID 刪除現有記錄。

id - 是自訂清單記錄的唯一值。

錯誤：

404 - 找不到 customListId 或 id。
刪除車輛

按 ID 刪除車輛。
取得 GPS 資料條目

擷取指定日期範圍的 GPS 資料項目。 也會傳回接續權杖和連結，以取得下一個資料部分。 您可以指定傳回的頁數和每頁的元素數。

已刪除使用者/車輛的位置不會退回。 不過，如果使用者/車輛在要求資料時存在，但稍後被移除，則會傳回延續權杖所要求的使用者/車輛的資料。

結果會依 UtcTime 自動排序，並依遞增順序排序。 排序參數無法配置。
取得事件 Web 攔截訂用帳戶的清單

擷取事件 Web 勾點訂閱的清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 SubscriptionId 排序，並依遞增順序排序。 排序參數無法配置。
取得事件清單

擷取特定時段的事件清單。 您可以指定傳回的頁數和每頁的元素數。

依事件類型篩選以取得特定事件。 如果員工與車輛相關聯，則可以為員工傳回車輛事件。
取得使用者

依使用者的 ID 取得使用者。
取得使用者清單

擷取使用者清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 UserId 排序，並依遞增順序排序。 排序參數無法配置。
取得地理圍欄

依其識別碼擷取地理柵欄。
取得地理圍欄清單

擷取地理柵欄清單。 您可以指定傳回的頁數和每頁的元素數，以及地理柵欄座標是否為度量。 結果會自動依名稱排序，並依遞增順序排序。 排序參數無法配置。
取得客戶清單

擷取用戶端清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依名稱排序，並依遞增順序排序。 排序參數無法配置。
取得次要版本

傳回目前次要的 API 版本。
取得自訂事件定義清單

擷取自訂事件定義的清單。
取得自訂清單定義

擷取自訂清單定義清單。 定義清單包含所有現有自訂清單的 CustomListID、名稱和版本。
取得行程清單

擷取特定時段的行程清單。 您可以指定傳回的頁數和每頁的元素數。 結果會依 StartUtcTIme 自動排序，並以升序排序。 排序參數無法配置。
取得表單

依表單的 ID 擷取表單。
取得表單清單

使用下列請求引數中的任何篩選器擷取表單清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 SubmittedTime 排序，並以遞減順序排序。 排序參數無法配置。
取得訂單清單

使用篩選器從如下所示的請求引數中擷取訂單清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動按 Client.Name 排序，並按遞增順序排序。 排序參數無法配置。
取得訂用帳戶清單

擷取 Web 勾點訂閱的清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 SubscriptionId 排序，並依遞增順序排序。 排序參數無法配置。
取得計時條目

依其識別碼擷取專案。
取消訂閱 GPS 數據網絡掛鉤

依 ID 刪除 GPS 資料 Web 攔截訂閱。
取消訂閱事件 Web 掛鉤

依事件 Web 勾點訂閱的 ID 刪除。
啟動車輛

通過 ID 激活車輛。
啟用使用者

依現有使用者的 ID 啟用。
帶有 GPS 數據源的 Webhook 回調

gpsdata/subscribe 使用此範例方法，使用客戶提供的 URL 回傳資料摘要。
建立使用者

建立新使用者。
建立地理柵欄

建立新的地理柵欄。
建立或更新自訂事件定義

建立或更新自訂事件定義。
建立或更新自訂清單記錄

建立或更新自訂清單資料記錄。 唯一資料行的值可以省略，但如果存在，它應該符合查詢參數中的唯一 ID 值。
建立用戶端

建立新的用戶端。
建立表單

新增表單。
建立訂單

新增訂單。
建立車輛

創建車輛。
從自定義列表中獲取單條記錄

擷取 CustomListId 找到的單一自訂清單資料記錄和唯一資料行值。

錯誤：

404 - 提供的 customListId 和唯一資料行值沒有自訂清單記錄
提交事件

提交事件。
更新使用者

更新現有使用者。
更新使用者的一部分

更新使用者的部分屬性。
更新現有的地理柵欄

依其識別碼更新現有的地理柵欄。
更新用戶端

更新現有的用戶端。
更新訂單

更新現有訂單。
更新訂單狀態

變更現有的訂單狀態。
更新車輛

依 ID 更新車輛。
獲取訂單

依其 ID 取得現有訂單。
獲取計時條目列表

根據日期範圍擷取計時項目清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 ClockInTime 排序，然後依 TimekeepingStatusId 排序，並依遞增順序排序。 排序參數無法配置。
獲取車輛清單

擷取車輛清單。
獲得客戶

依用戶端物件的識別碼擷取用戶端物件。
訂閱 GPS 數據網絡掛鉤

添加新的 GPS 跟踪數據（GPS 位置）網絡掛鉤。 Web 掛鉤可讓您接收在指定 URL 上發生的 GPS 位置。
訂閱事件 Web 掛鉤

新增事件 Web 掛鉤訂閱。 Web 勾點可讓您接收有關指定 URL 上發生的公司事件的自動通知。
通過身份證獲取車輛

按 ID 檢索單輛車。
部分更新車輛

按 ID 部分更新車輛。
重設事件 Web 勾點訂閱狀態

將訂閱狀態變更為狀態 = 1 （「執行中」）。
重設訂閱狀態

將訂閱狀態變更為狀態 = 1 （「執行中」）。

上傳二進位檔案

作業識別碼：
BinaryController_UploadBinary

使用此選項可上傳表單影像和音訊檔案。 二進位大小限制為 10MB。 支援的檔案類型有：JPEG、PNG 和 MP4。

傳回

身體
CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

上傳附件檔案

作業識別碼：
BinaryController_UploadAttachment

使用此選項可上傳表單檔案附件。 二進位大小限制為 25MB。 預期具有單一檔案的多部分/表單資料請求。

傳回

身體
CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

依 CustomListID 取得自訂清單欄位清單

作業識別碼：
CustomListController_GetById

使用 CustomListID 擷取單一自訂清單的欄位清單。

參數

名稱 機碼 必要 類型 Description
自訂清單標識碼
 customListId True integer

自訂清單識別碼。

傳回

自訂清單模型。

身體
CustomerAPI.Models.CustomLists.CustomListApiModel

依 CustomListID 取得自訂清單資料

作業識別碼：
CustomListController_GetCustomList

使用 CustomListID 擷取單一自訂清單中的所有資料記錄。

結果會依資料行排序，並支援分頁。

錯誤：

404 - 提供的 customListId 沒有自訂清單。

參數

名稱 機碼 必要 類型 Description
自訂清單標識碼
 customListId True integer

自訂清單識別碼。
頁號
 pageNumber integer

起始頁碼。
pageSize
 pageSize integer

頁面大小。

傳回

自訂清單資料行資料陣列的容器。

身體
CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

依識別碼取得自訂事件定義

作業識別碼：
EventController_Get

依識別碼擷取單一自訂事件定義。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

事件定義識別碼。

傳回

自訂事件定義模型。

身體
CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

停用使用者

作業識別碼：
UserController_Deactivate

依現有使用者的 ID 停用。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

停用車輛

作業識別碼：
VehicleController_Deactivate

通過 ID 停用車輛。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

response
integer

具有事件摘要的 Web 掛鉤回呼

作業識別碼：
EventController_subscribe_callback

事件/訂閱使用此範例方法，使用客戶提供的URL回傳事件資料摘要。

參數

名稱 機碼 必要 類型 Description
Id
 Id string

包含 WebHookSubscriptionParamsApiModel 位址的 URL。
事件類型
 EventType integer
事件代碼
 EventCode string
EventTime
 EventTime date-time

具有 Local 和 Offset 的 ISO 格式。
DeviceId
 DeviceId string

GpsDeviceD與訂用帳戶相關聯的識別碼。
裝置類型
 DeviceType integer

GpsDeviceD轉換為類型：聽筒 （0）、CalAmp （1）、Geotab （2）、Xirgo （3）。
UserId
 UserId integer

使用者 ID。
車輛識別碼
 VehicleId integer

車輛 ID。
使用者連結至車輛
 UserLinkedToVehicle boolean

使用者是否連結至車輛。
Lat
 Lat double

緯度。
朗
 Lon double

經度。
CustomEventDefinitionId
 CustomEventDefinitionId string
事件參數
 EventParams object

事件參數。

傳回

response
object

刪除地理柵欄

作業識別碼：
GeofenceController_DeleteGeofence

依其識別碼刪除現有的地理柵欄。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True integer

地理圍欄 Id.

刪除用戶端

作業識別碼：
ClientController_Delete

依其識別碼刪除現有用戶端。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

用戶端識別碼。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

刪除自訂事件定義

作業識別碼：
EventController_Delete

刪除自訂事件定義。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

事件定義識別碼。

刪除自訂清單記錄

作業識別碼：
CustomListController_DeleteRecord

依自訂清單中的 customListId 和 ID 刪除現有記錄。

id - 是自訂清單記錄的唯一值。

錯誤：

404 - 找不到 customListId 或 id。

參數

名稱 機碼 必要 類型 Description
自訂清單標識碼
 customListId True integer

自訂清單識別碼。
識別碼
 id True string

唯一價值。

刪除車輛

作業識別碼：
VehicleController_Delete

按 ID 刪除車輛。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

取得 GPS 資料條目

作業識別碼：
TrackingController_GetGpsData

擷取指定日期範圍的 GPS 資料項目。 也會傳回接續權杖和連結，以取得下一個資料部分。 您可以指定傳回的頁數和每頁的元素數。

已刪除使用者/車輛的位置不會退回。 不過，如果使用者/車輛在要求資料時存在，但稍後被移除，則會傳回延續權杖所要求的使用者/車輛的資料。

結果會依 UtcTime 自動排序，並依遞增順序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
fromDate
 fromDate date-time

日期範圍開始。 建議：請使用大日期範圍（>=4小時）而不是小日期範圍。
至今
 toDate date-time

日期範圍結束。 建議：請使用大日期範圍（>=4小時）而不是小日期範圍。
員工編號
 employeeNumber string

員工編號。
文
 vin string

車輛的 VIN 號碼。
使用指標
 useMetric boolean

使用公制與否。
Token
 token string

初始呼叫所傳回的接續權杖，且應在後續呼叫中使用。

傳回

身體
CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

取得事件 Web 攔截訂用帳戶的清單

作業識別碼：
EventController_GetSubscriptions

擷取事件 Web 勾點訂閱的清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 SubscriptionId 排序，並依遞增順序排序。 排序參數無法配置。

傳回

response
array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

取得事件清單

作業識別碼：
EventController_GetEvents

擷取特定時段的事件清單。 您可以指定傳回的頁數和每頁的元素數。

依事件類型篩選以取得特定事件。 如果員工與車輛相關聯，則可以為員工傳回車輛事件。

參數

名稱 機碼 必要 類型 Description
fromDate
 fromDate True date-time

日期範圍開始。
至今
 toDate True date-time

日期範圍結束。
員工編號
 employeeNumber string

員工編號。
車輛編號
 vehicleNumber string

車輛編號。
頁號
 pageNumber integer

起始頁碼。
pageSize
 pageSize integer

頁面大小。
eventType
 eventType integer

依事件類型篩選。

指定員工編號：

  • UserEvents（0） - 僅限使用者事件。
  • VehicleEvents（1） - 僅車輛事件，包括感測器事件。
  • ExternalEvents（2） - 僅限外部事件。

指定車號：

  • 使用者事件 （0） - 不適用。
  • VehicleEvents（1） - 僅車輛事件，包括感測器事件。
  • ExternalEvents（2） - 僅限外部事件。

既沒有指定員工編號，也沒有指定車輛編號：

  • UserEvents（0） - 僅限使用者事件。
  • VehicleEvents（1） - 僅車輛事件，包括感測器事件。
  • ExternalEvents（2） - 僅限外部事件。

傳回

response
array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

取得使用者

作業識別碼：
UserController_Get

依使用者的 ID 取得使用者。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.User.ReadUserApiModel

取得使用者清單

作業識別碼：
UserController_GetUsers

擷取使用者清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 UserId 排序，並依遞增順序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
頁號
 pageNumber integer

起始頁碼。 預設值為 1。
pageSize
 pageSize integer

頁面大小。 預設值為 500。

傳回

response
array of CustomerAPI.Models.User.ReadUserListItemApiModel

取得地理圍欄

作業識別碼：
GeofenceController_GetGeofence

依其識別碼擷取地理柵欄。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True integer

地理圍欄 Id.
使用指標
 useMetric boolean

使用公制與否。

傳回

身體
CustomerAPI.Models.Geofence.GeofenceApiModel

取得地理圍欄清單

作業識別碼：
GeofenceController_GetGeofences

擷取地理柵欄清單。 您可以指定傳回的頁數和每頁的元素數，以及地理柵欄座標是否為度量。 結果會自動依名稱排序，並依遞增順序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
頁號
 pageNumber integer

起始頁碼。 預設值為 1。
pageSize
 pageSize integer

頁面大小。 預設值為 500。
使用指標
 useMetric boolean

使用公制與否。

傳回

response
array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

取得客戶清單

作業識別碼：
ClientController_GetClients

擷取用戶端清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依名稱排序，並依遞增順序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
頁號
 pageNumber integer

起始頁碼。
pageSize
 pageSize integer

頁面大小。

傳回

response
array of CustomerAPI.Models.Client.ReadClientApiModel

取得次要版本

作業識別碼：
VersionController_Get

傳回目前次要的 API 版本。

取得自訂事件定義清單

作業識別碼：
EventController_GetList

擷取自訂事件定義的清單。

傳回

response
array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

取得自訂清單定義

作業識別碼：
CustomListController_Get

擷取自訂清單定義清單。 定義清單包含所有現有自訂清單的 CustomListID、名稱和版本。

傳回

response
array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

取得行程清單

作業識別碼：
TrackingController_GetTrips

擷取特定時段的行程清單。 您可以指定傳回的頁數和每頁的元素數。 結果會依 StartUtcTIme 自動排序，並以升序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
fromDate
 fromDate True date-time

日期範圍開始。 建議：請使用大日期範圍（>=4小時）而不是小日期範圍。
至今
 toDate True date-time

日期範圍結束。 建議：請使用大日期範圍（>=4小時）而不是小日期範圍。
員工編號
 employeeNumber string

員工編號。
文
 vin string

車輛的 VIN 號碼。
頁號
 pageNumber integer

起始頁碼。 預設值為 1。
pageSize
 pageSize integer

頁面大小。 預設值為 1000。
使用指標
 useMetric boolean

使用公制與否。

傳回

response
array of CustomerAPI.Models.Tracking.TripApiModel

取得表單

作業識別碼：
FormController_GetFormAsync

依表單的 ID 擷取表單。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True integer

表單 ID。

傳回

身體
CustomerAPI.Models.Forms.StandaloneFormApiModel

取得表單清單

作業識別碼：
FormController_GetFormsAsync

使用下列請求引數中的任何篩選器擷取表單清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 SubmittedTime 排序，並以遞減順序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
提交開始日期
 submittedStartDate True date-time

提交表格的開始日期。
提交結束日期
 submittedEndDate True date-time

已提交表單的結束日期。
apiModuleId
 apiModuleId string

表單模組 ID。
員工編號
 employeeNumber string

員工編號。
審查
 reviewed boolean

僅檢索是否檢索已審核的表單。 預設值為 null for all。
頁號
 pageNumber integer

起始頁碼。 預設值為 1。
pageSize
 pageSize integer

頁面大小。 預設值為 1000。

傳回

response
array of CustomerAPI.Models.Forms.StandaloneFormApiModel

取得訂單清單

作業識別碼：
OrderController_GetOrders

使用篩選器從如下所示的請求引數中擷取訂單清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動按 Client.Name 排序，並按遞增順序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
到期日期自
 dueDateFrom True date-time

按截止日期開始日期過濾。
到期日期至
 dueDateTo True date-time

依到期日結束日期篩選。
員工編號
 employeeNumber string

按員工編號過濾。
頁號
 pageNumber integer

起始頁碼 （預設為 1）。
pageSize
 pageSize integer

頁面大小 （預設值為 500）。

傳回

response
array of CustomerAPI.Models.Order.OrderListItemApiModel

取得訂用帳戶清單

作業識別碼：
TrackingController_GetSubscriptions

擷取 Web 勾點訂閱的清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 SubscriptionId 排序，並依遞增順序排序。 排序參數無法配置。

傳回

response
array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

取得計時條目

作業識別碼：
TimekeepingController_GetTimekeepingEntryAsync

依其識別碼擷取專案。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

記錄的 ID。

傳回

身體
CustomerAPI.Models.Timekeeping.TimekeepingApiModel

取消訂閱 GPS 數據網絡掛鉤

作業識別碼：
TrackingController_RemoveGpsDataFeedSubscription

依 ID 刪除 GPS 資料 Web 攔截訂閱。

參數

名稱 機碼 必要 類型 Description
subscriptionId
 subscriptionId True string

要刪除的訂閱識別碼。

取消訂閱事件 Web 掛鉤

作業識別碼：
EventController_RemoveEventDataFeedSubscription

依事件 Web 勾點訂閱的 ID 刪除。

參數

名稱 機碼 必要 類型 Description
subscriptionId
 subscriptionId True string

要刪除的訂閱識別碼。

啟動車輛

作業識別碼：
VehicleController_Activate

通過 ID 激活車輛。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

response
integer

啟用使用者

作業識別碼：
UserController_Activate

依現有使用者的 ID 啟用。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

帶有 GPS 數據源的 Webhook 回調

作業識別碼：
TrackingController_subscribe_callback

gpsdata/subscribe 使用此範例方法，使用客戶提供的 URL 回傳資料摘要。

參數

名稱 機碼 必要 類型 Description
Id
 Id string

包含 WebHookSubscriptionParamsApiModel 位址的 URL。
DeviceId
 DeviceId string

GpsDeviceD與訂用帳戶相關聯的識別碼。
裝置類型
 DeviceType integer

GpsDeviceD轉換為類型：Handset（0）、CalAmp（1）、Geotab （2）、Xirgo （3）。
時間戳
 Timestamp date-time

具有 Local 和 Offset 的 ISO 格式。
公司標識符
 CompanyId integer

公司編號。
UserId
 UserId integer

使用者 ID。
車輛識別碼
 VehicleId integer

車輛 ID。
使用者連結至車輛
 UserLinkedToVehicle boolean

使用者是否連結至車輛。
位置提供者
 LocationProvider string

位置提供者名稱。
Lat
 Lat double

緯度。
朗
 Lon double

經度。
準確度英尺
 AccuracyFt double

位置精度（英尺）。
海拔高度英尺
 AltitudeFt double

海拔高度（英尺）。
Heading
 Heading integer

羅盤方向（以度為單位）。
速度英里/小時
 SpeedMph double

移動速度 （Mph）。
電池狀態
 BatteryStatus integer

電池狀態：未充電（0）、正在充電（1）。
電池電量
 BatteryLevel integer

電池電量（以百分比為單位）。
活動狀態
 ActivityState integer

活動狀態：Staying（1）、Modving（2）。
是網絡連接
 IsNetworkConnected boolean

設備目前是否連接到網絡。
魯西
 Rssi integer

接收信號強度指示器。
DOdoMl
 DOdoMl double

GpsDeviceD到里程表（英里）。
VOdoMl
 VOdoMl double

車輛里程表（英里）。

傳回

response
object

建立使用者

作業識別碼：
UserController_Create

建立新使用者。

參數

名稱 機碼 必要 類型 Description
UserName
 UserName string

使用者名稱。
密碼
 Password password

使用者的密碼。
GroupName
 GroupName string

使用者群組的名稱。
FirstName
 FirstName string

使用者的名字。
姓氏
 LastName string

使用者的姓氏。
員工編號
 EmployeeNumber string

使用者的員工編號。
Email
 Email string

使用者的電子郵件地址。
電話
 Phone string

用戶的電話號碼。
角色標識符
 RoleId integer

使用者的 RoleId - （系統管理員：1、使用者：3、進階使用者：5）。
IsActive
 IsActive boolean

使用者的作用中狀態。
EPTT啟用
 EPTTEnabled boolean

使用者增強型一鍵通功能的狀態：布林值。
EPTTNumber
 EPTTNumber string

使用者增強型一鍵通功能的電話號碼：字串。
EPTTWebMDN
 EPTTWebMDN string

用於向 Kodiak EPTT 系統驗證用戶的電話號碼 - 由 Kodiak 提供。
EPTTToken
 EPTTToken string

用於向 Kodiak EPTT 系統驗證使用者的 API 令牌 - 由 Kodiak 提供。
GPS支援
 GPSEnabled boolean

用戶的 GPS 功能狀態。
僅限行動裝置
 MobileOnly boolean

CAB 的桌面 Web 應用程式存取狀態 - （無 WebApp 存取：True，完整應用程式存取：False）。
授權類型
 LicenseType integer

指派給使用者的授權類型：- 0 代表未定義、1 代表一般、2 代表 WebOnly，以及 3 代表員工。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

建立地理柵欄

作業識別碼：
GeofenceController_CreateGeofence

建立新的地理柵欄。

參數

名稱 機碼 必要 類型 Description
群組名稱
 GroupNames array of string

GroupPaths 的 GeofenceCreateApiModel。
緯度
 Latitude double
經度
 Longitude double
名稱
 Name string

GeofenceApiModelBase 的名稱。
類型
 Type string

GeofenceApiModel 的類型。
Shape
 Shape integer

形狀：0 代表圓形，1 代表多邊形。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
Radius
 Radius double

GeofenceApiModel 的半徑。
使用地理圍欄地址
 UseGeofenceAddress boolean

UseGeofenceAddress 的 GeofenceApiModel。
使用指標
 useMetric boolean

使用公制與否。
地理編碼
 geocode boolean

地址是否應該進行地理編碼。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

建立或更新自訂事件定義

作業識別碼：
EventController_Put

建立或更新自訂事件定義。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

事件定義識別碼。
名稱
 Name string
反向地理編碼
 ReverseGeocode boolean
名稱
 Name string
類型
 Type integer
標題
 Caption string
為必填項目
 Required boolean

建立或更新自訂清單記錄

作業識別碼：
CustomListController_PutRecord

建立或更新自訂清單資料記錄。 唯一資料行的值可以省略，但如果存在，它應該符合查詢參數中的唯一 ID 值。

參數

名稱 機碼 必要 類型 Description
自訂清單標識碼
 customListId True integer

自訂清單識別碼。
識別碼
 id True string

唯一價值。
資料行索引
 ColumnIndex integer

自訂清單資料行索引。
標題
 Caption string

自訂清單欄標題。
價值觀
 Value

自訂清單欄值。

建立用戶端

作業識別碼：
ClientController_Create

建立新的用戶端。

參數

名稱 機碼 必要 類型 Description
外部標識
 ExternalId string

用戶端的外部使用 ID - API 擴充功能屬性。
欄位索引
 FieldIndex integer

欄位索引。
價值觀
 Value

欄位值。
名稱
 Name string

用戶端的名稱。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
名稱
 Name string

ContactApiModel 的名稱。
電話號碼
 PhoneNumber string

ContactApiModel 的 PhoneNumber。
Email
 Email string

ContactApiModel 的電子郵件。
地理編碼
 geocode boolean

地址是否應該進行地理編碼。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

建立表單

作業識別碼：
FormController_PostFormAsync

新增表單。

參數

名稱 機碼 必要 類型 Description
ApiModuleId
 ApiModuleId string

與此 CreateStandaloneFormApiModel 相關聯的 ApiModule 標識碼。
審查過
 Reviewed boolean

此 CreateStandaloneFormApiModel 的檢閱狀態。
UserId
 UserId integer

使用者的 UserId。
員工編號
 EmployeeNumber string

使用者的員工編號。
提交時間
 SubmittedTime True date-time

提交 CreateStandaloneFormApiModel 的時間點。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
ApiFieldId
 ApiFieldId True string

API 欄位 ID。
價值觀
 Value True

FormFieldDataApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“Sign” 欄位值格式 （二進位參考）： { “BinaryId”： string // 上傳影像的二進位 ID （請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

擷取二進位資料的時間。 格式 - 日期時間 （以 RFC3339 為日期時間），包括偏移量。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
ApiFieldId
 ApiFieldId True string

API 欄位 ID。
價值觀
 Value True

FormFieldDataApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“Sign” 欄位值格式 （二進位參考）： { “BinaryId”： string // 上傳影像的二進位 ID （請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

擷取二進位資料的時間。 格式 - 日期時間 （以 RFC3339 為日期時間），包括偏移量。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

建立訂單

作業識別碼：
OrderController_Create

新增訂單。

參數

名稱 機碼 必要 類型 Description
創建日期時間
 CreatedDateTime date-time

此 CreateUpdateOrderApiModel 已建立。
外部用戶端識別碼
 ExternalClientId True string

用戶端的外部使用 ID - API 擴充功能屬性。
ServiceType
 ServiceType True string

與此 CreateUpdateOrderApiModel 相關聯的服務類型。
外部順序標識符
 ExternalOrderId string

用戶端的外部使用 OrderId - API 延伸模組屬性。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
名稱
 Name string

ContactApiModel 的名稱。
電話號碼
 PhoneNumber string

ContactApiModel 的 PhoneNumber。
Email
 Email string

ContactApiModel 的電子郵件。
截止日期
 DueDate date-time

此 BaseUpdateOrderApiModel 的時間點到期完成 （在 v1.3 中已過時）。
StartTime
 StartTime date-time

此 BaseUpdateOrderApiModel 應該啟動的時間點 （在 v1.3 中引進）。
EndTime
 EndTime date-time

此 BaseUpdateOrderApiModel 應該結束的時間點 （在 v1.3 中引進）。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
員工編號
 EmployeeNumber True string

EmployeeNumber 建立此 NewOrderStatusApiModel 之使用者。
狀態標籤
 StatusLabel True string

與此 NewOrderStatusApiModel 相關聯之 StatusLabel 的標籤內容。
狀態開始日期時間
 StatusStartDateTime True date-time

此 NewOrderStatusApiModel 狀態已啟動。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
欄位索引
 FieldIndex integer

欄位索引。
價值觀
 Value

欄位值。
地理編碼
 geocode boolean

地址是否應該進行地理編碼。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

建立車輛

作業識別碼：
VehicleController_CreateVehicle

創建車輛。

參數

名稱 機碼 必要 類型 Description
Number
 Number string
名稱
 Name string
類型
 Type string
標記
 Tag string
使用者員工編號
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
做
 Make string
年
 Year integer
型號
 Model string
顏色
 Color string
VIN
 VIN string
IsActive
 IsActive boolean
裝置類型
 DeviceType integer
裝置序列號
 DeviceSerialNumber string

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

從自定義列表中獲取單條記錄

作業識別碼：
CustomListController_GetSingleRecord

擷取 CustomListId 找到的單一自訂清單資料記錄和唯一資料行值。

錯誤：

404 - 提供的 customListId 和唯一資料行值沒有自訂清單記錄

參數

名稱 機碼 必要 類型 Description
自訂清單標識碼
 customListId True integer

自訂清單識別碼。
識別碼
 id True string

唯一價值。

傳回

自訂清單資料行資料陣列的容器。

身體
CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

提交事件

作業識別碼：
EventController_Post

提交事件。

參數

名稱 機碼 必要 類型 Description
EventDefinitionId
 EventDefinitionId string

事件定義識別碼。
員工編號
 EmployeeNumber string

員工編號。
車號
 VehicleNumber string

車輛編號。
裝置序列號
 DeviceSerialNumber string

GpsDeviceD變更為序號。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
Time
 Time date-time
參數
 Parameters object

事件參數。

更新使用者

作業識別碼：
UserController_Update

更新現有使用者。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
UserName
 UserName string

使用者名稱。
密碼
 Password password

使用者的密碼。
GroupName
 GroupName string

使用者群組的名稱。
FirstName
 FirstName string

使用者的名字。
姓氏
 LastName string

使用者的姓氏。
員工編號
 EmployeeNumber string

使用者的員工編號。
Email
 Email string

使用者的電子郵件地址。
電話
 Phone string

用戶的電話號碼。
角色標識符
 RoleId integer

使用者的 RoleId - （系統管理員：1、使用者：3、進階使用者：5）。
IsActive
 IsActive boolean

使用者的作用中狀態。
EPTT啟用
 EPTTEnabled boolean

使用者增強型一鍵通功能的狀態：布林值。
EPTTNumber
 EPTTNumber string

使用者增強型一鍵通功能的電話號碼：字串。
EPTTWebMDN
 EPTTWebMDN string

用於向 Kodiak EPTT 系統驗證用戶的電話號碼 - 由 Kodiak 提供。
EPTTToken
 EPTTToken string

用於向 Kodiak EPTT 系統驗證使用者的 API 令牌 - 由 Kodiak 提供。
GPS支援
 GPSEnabled boolean

用戶的 GPS 功能狀態。
僅限行動裝置
 MobileOnly boolean

CAB 的桌面 Web 應用程式存取狀態 - （無 WebApp 存取：True，完整應用程式存取：False）。
授權類型
 LicenseType integer

指派給使用者的授權類型：- 0 代表未定義、1 代表一般、2 代表 WebOnly，以及 3 代表員工。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

更新使用者的一部分

作業識別碼：
UserController_PartialUpdate

更新使用者的部分屬性。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
object
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

更新現有的地理柵欄

作業識別碼：
GeofenceController_UpdateGeofence

依其識別碼更新現有的地理柵欄。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True integer

地理圍欄 Id.
群組名稱
 GroupNames array of string

GroupPaths 的 GeofenceUpdateApiModel 的路徑。
緯度
 Latitude double
經度
 Longitude double
名稱
 Name string

GeofenceApiModelBase 的名稱。
類型
 Type string

GeofenceApiModel 的類型。
Shape
 Shape integer

形狀：0 代表圓形，1 代表多邊形。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
Radius
 Radius double

GeofenceApiModel 的半徑。
使用地理圍欄地址
 UseGeofenceAddress boolean

UseGeofenceAddress 的 GeofenceApiModel。
使用指標
 useMetric boolean

使用公制與否。
地理編碼
 geocode boolean

地址是否應該進行地理編碼。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

更新用戶端

作業識別碼：
ClientController_Update

更新現有的用戶端。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
外部標識
 ExternalId string

用戶端的外部使用 ID - API 擴充功能屬性。
欄位索引
 FieldIndex integer

欄位索引。
價值觀
 Value

欄位值。
名稱
 Name string

用戶端的名稱。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
名稱
 Name string

ContactApiModel 的名稱。
電話號碼
 PhoneNumber string

ContactApiModel 的 PhoneNumber。
Email
 Email string

ContactApiModel 的電子郵件。
地理編碼
 geocode boolean

地址是否應該進行地理編碼。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

更新訂單

作業識別碼：
OrderController_Update

更新現有訂單。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
外部順序標識符
 ExternalOrderId string

用戶端的外部使用 OrderId - API 延伸模組屬性。
已關閉
 IsClosed boolean

顯示 UpdateOrderApiModel 是否關閉的狀態。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
名稱
 Name string

ContactApiModel 的名稱。
電話號碼
 PhoneNumber string

ContactApiModel 的 PhoneNumber。
Email
 Email string

ContactApiModel 的電子郵件。
截止日期
 DueDate date-time

此 BaseUpdateOrderApiModel 的時間點到期完成 （在 v1.3 中已過時）。
StartTime
 StartTime date-time

此 BaseUpdateOrderApiModel 應該啟動的時間點 （在 v1.3 中引進）。
EndTime
 EndTime date-time

此 BaseUpdateOrderApiModel 應該結束的時間點 （在 v1.3 中引進）。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
員工編號
 EmployeeNumber True string

EmployeeNumber 建立此 NewOrderStatusApiModel 之使用者。
狀態標籤
 StatusLabel True string

與此 NewOrderStatusApiModel 相關聯之 StatusLabel 的標籤內容。
狀態開始日期時間
 StatusStartDateTime True date-time

此 NewOrderStatusApiModel 狀態已啟動。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
欄位索引
 FieldIndex integer

欄位索引。
價值觀
 Value

欄位值。
地理編碼
 geocode boolean

地址是否應該進行地理編碼。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

更新訂單狀態

作業識別碼：
OrderController_ChangeStatus

變更現有的訂單狀態。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
員工編號
 EmployeeNumber True string

EmployeeNumber 建立此 NewOrderStatusApiModel 之使用者。
狀態標籤
 StatusLabel True string

與此 NewOrderStatusApiModel 相關聯之 StatusLabel 的標籤內容。
狀態開始日期時間
 StatusStartDateTime True date-time

此 NewOrderStatusApiModel 狀態已啟動。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
緯度
 Latitude double
經度
 Longitude double
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。
標題
 Caption True string
價值觀
 Value

UpdateFormFieldApiModel 的值。

“NFC” 欄位值 format： { “Type”： number， // 0 - 文字 “Payload”： object， // 類型 = 0 的文字 }

“Camera” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳圖片的二進位 ID （請參閱上傳二進位 API） “Note”： string // 參考圖片的備註 }

“簽名”欄位值格式（二進位參考）： { “BinaryId”： string // 上傳圖片的二進位 ID（請參閱上傳二進位 API） }

“Audio” 欄位值格式 （二進位參考）： { “BinaryId”： string， // 上傳音訊的二進位 ID （請參閱上傳二進位 API） “DurationSeconds”： number // 音訊持續時間 （以秒為單位） }
捕獲時間
 CapturedTime date-time

捕獲了時間點值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

更新車輛

作業識別碼：
VehicleController_UpdateVehicle

依 ID 更新車輛。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
Number
 Number string
名稱
 Name string
類型
 Type string
標記
 Tag string
使用者員工編號
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
做
 Make string
年
 Year integer
型號
 Model string
顏色
 Color string
VIN
 VIN string
IsActive
 IsActive boolean
裝置類型
 DeviceType integer
裝置序列號
 DeviceSerialNumber string
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

response
integer

獲取訂單

作業識別碼：
OrderController_GetOrder

依其 ID 取得現有訂單。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
包含狀態歷史記錄
 include-status-history string

如果為true，則回應將包含此訂單的所有狀態歷程記錄和表單資料。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.Order.OrderApiModel

獲取計時條目列表

作業識別碼：
TimekeepingController_GetTimekeepingDataList

根據日期範圍擷取計時項目清單。 您可以指定傳回的頁數和每頁的元素數。 結果會自動依 ClockInTime 排序，然後依 TimekeepingStatusId 排序，並依遞增順序排序。 排序參數無法配置。

參數

名稱 機碼 必要 類型 Description
fromDate
 fromDate True date-time

開始日期。
至今
 toDate True date-time

結束日期。
員工編號
 employeeNumber string

員工編號。
已批准
 approved boolean

僅篩選已核准的項目。
closedOnly
 closedOnly boolean

僅過濾封閉的入口。
excludeFormData
 excludeFormData boolean

篩選以排除表單資料。
頁號
 pageNumber integer

起始頁碼 （預設為 1）。
pageSize
 pageSize integer

頁面大小 （預設為 1000）。

傳回

response
array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

獲取車輛清單

作業識別碼：
VehicleController_GetVehicles

擷取車輛清單。

參數

名稱 機碼 必要 類型 Description
頁號
 pageNumber integer

頁碼。
pageSize
 pageSize integer

頁面中的項目數目上限。 預設值 = 1000。 最大值 = 2000。
活動專用
 activeOnly boolean

如果為 true - 僅傳回作用中的車輛。 預設值 = false。

傳回

response
array of CustomerAPI.Models.Vehicles.VehicleReadApi

獲得客戶

作業識別碼：
ClientController_Get

依用戶端物件的識別碼擷取用戶端物件。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

用戶端識別碼。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.Client.ReadClientApiModel

訂閱 GPS 數據網絡掛鉤

作業識別碼：
TrackingController_SubscribeToGpsDataFeed

添加新的 GPS 跟踪數據（GPS 位置）網絡掛鉤。 Web 掛鉤可讓您接收在指定 URL 上發生的 GPS 位置。

參數

名稱 機碼 必要 類型 Description
網址
 Url string

包含 WebHookSubscriptionParamsApiModel 位址的 URL。
安全令牌
 SecurityToken string

與此 WebHookSubscriptionParamsApiModel 相關聯的安全性權杖。

傳回

身體
CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

訂閱事件 Web 掛鉤

作業識別碼：
EventController_SubscribeToEventDataFeed

新增事件 Web 掛鉤訂閱。 Web 勾點可讓您接收有關指定 URL 上發生的公司事件的自動通知。

參數

名稱 機碼 必要 類型 Description
網址
 Url string

包含 WebHookSubscriptionParamsApiModel 位址的 URL。
安全令牌
 SecurityToken string

與此 WebHookSubscriptionParamsApiModel 相關聯的安全性權杖。

傳回

身體
CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

通過身份證獲取車輛

作業識別碼：
VehicleController_GetVehicle

按 ID 檢索單輛車。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

車輛資料模型。

身體
CustomerAPI.Models.Vehicles.VehicleReadApi

部分更新車輛

作業識別碼：
VehicleController_PartialUpdateVehicle

按 ID 部分更新車輛。

參數

名稱 機碼 必要 類型 Description
識別碼
 id True string

外部或內部 ID 取決於 use-external-id 參數中的值。
object
使用外部識別碼
 use-external-id boolean

是否使用外部 ID。

傳回

身體
CustomerAPI.Models.ReturnIdApiModel

重設事件 Web 勾點訂閱狀態

作業識別碼：
EventController_ResetSubscriptionHealthStatus

將訂閱狀態變更為狀態 = 1 （「執行中」）。

參數

名稱 機碼 必要 類型 Description
subscriptionId
 subscriptionId True integer

訂閱 ID。

重設訂閱狀態

作業識別碼：
TrackingController_ResetSubscriptionHealthStatus

將訂閱狀態變更為狀態 = 1 （「執行中」）。

參數

名稱 機碼 必要 類型 Description
subscriptionId
 subscriptionId True integer

訂閱 ID。

觸發程序

表單資料輪詢

Forms API輪詢端點可讓您的應用程式持續輪詢和處理最近提交的獨立表單。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應碼 200 - 最近提交的表單記錄存在;回應本文將顯示表單資料。
  • HTTP 回應代碼 202 - 不存在最近提交的記錄;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏表單所需的必要引數。

結果會自動依 ModifiedUtc 排序，然後依 FormHeaderId 遞增排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最新表單資料變更的時間。
訂單狀態輪詢

訂單狀態 API 輪詢端點可讓您的應用程式持續輪詢和處理訂單的最新變更。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應碼 200 - 存在最近變更的訂單狀態記錄;回應正文將顯示訂單狀態資料
  • HTTP 回應代碼 202 - 不存在最近提交的記錄;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏訂單狀態所需的引數。

結果會依 ModifiedUtc 排序，然後依 StatusId 遞增排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最新訂單狀態資料變更的時間。
訂單輪詢

訂單 API 輪詢端點可讓您的應用程式持續輪詢和處理訂單的最新變更。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應代碼 200 - 存在最近更改的訂單;回應內文將顯示訂單資料。
  • HTTP 回應代碼 202 - 不存在最近更改的訂單;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏訂單變更所需的必要引數。

結果會自動依 ModifiedUtc 排序，然後依 OrderId 遞增排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最新訂單資料變更的時間。
計時民意調查

計時 API 輪詢端點可讓您的應用程式持續輪詢和處理最近提交的計時項目。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應碼 200 - 存在最近提交的計時記錄;回應主體將顯示計時條目資料。
  • HTTP 回應代碼 202 - 不存在最近提交的記錄;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏計時專案所需的引數。

結果會自動依 ModifiedUtc 排序，然後依 TimekeepingStatusId 排序，然後依遞增順序排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最近計時狀態變更的時間。

表單資料輪詢

作業識別碼：
FormController_Poll

Forms API輪詢端點可讓您的應用程式持續輪詢和處理最近提交的獨立表單。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應碼 200 - 最近提交的表單記錄存在;回應本文將顯示表單資料。
  • HTTP 回應代碼 202 - 不存在最近提交的記錄;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏表單所需的必要引數。

結果會自動依 ModifiedUtc 排序，然後依 FormHeaderId 遞增排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最新表單資料變更的時間。

傳回

身體
CustomerAPI.Models.Forms.StandaloneFormApiModel

訂單狀態輪詢

作業識別碼：
OrderController_StatusPoll

訂單狀態 API 輪詢端點可讓您的應用程式持續輪詢和處理訂單的最新變更。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應碼 200 - 存在最近變更的訂單狀態記錄;回應正文將顯示訂單狀態資料
  • HTTP 回應代碼 202 - 不存在最近提交的記錄;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏訂單狀態所需的引數。

結果會依 ModifiedUtc 排序，然後依 StatusId 遞增排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最新訂單狀態資料變更的時間。

參數

名稱 機碼 必要 類型 Description
excludeFormData
 excludeFormData boolean

如果為true，則FieldValues一律是空陣列。

傳回

身體
CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

訂單輪詢

作業識別碼：
OrderController_Poll

訂單 API 輪詢端點可讓您的應用程式持續輪詢和處理訂單的最新變更。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應代碼 200 - 存在最近更改的訂單;回應內文將顯示訂單資料。
  • HTTP 回應代碼 202 - 不存在最近更改的訂單;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏訂單變更所需的必要引數。

結果會自動依 ModifiedUtc 排序，然後依 OrderId 遞增排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最新訂單資料變更的時間。

參數

名稱 機碼 必要 類型 Description
excludeFormData
 excludeFormData boolean

如果為true，OrderFormFields一律是空陣列。
excludeCustomFieldData
 excludeCustomFieldData boolean

如果為true，則不會傳回CustomFields。

傳回

身體
CustomerAPI.Models.Order.OrderHeaderApiModel

計時民意調查

作業識別碼：
TimekeepingController_Poll

計時 API 輪詢端點可讓您的應用程式持續輪詢和處理最近提交的計時項目。

整合：

此端點的設計目的是要與 Microsoft Flow 搭配使用，作為輪詢觸發程式整合。 或者，您可以使用任何語言開發自己的自訂整合。

使用方式：

在一般案例中，對此端點的第一個要求不應提供任何參數。 有兩 （2） 種可能的成功回應：

  • HTTP 回應碼 200 - 存在最近提交的計時記錄;回應主體將顯示計時條目資料。
  • HTTP 回應代碼 202 - 不存在最近提交的記錄;回應內文將會是空的。

在這兩種情況下，回應中都有兩 （2） 個重要標頭：

  • 位置 - 下一個請求的 URL。
  • Retry-After - 下一個請求的建議時間間隔（以秒為單位）。 例如，如果有資料要擷取，則 Retry-After 標頭的值會為 1 或 60。 如果沒有要擷取的資料，則 Retry-After 標頭的值將為 300。

附註： 這些只是建議值 - 您的應用程式可能會根據您的需求選擇以不同的頻率輪詢。 在第一個要求之後，所有後續要求都應該使用最近回應的 Location 標頭中提供的 URL。 請勿在URL中新增更多引數，因為它已包含確保請求中不會遺漏計時專案所需的引數。

結果會自動依 ModifiedUtc 排序，然後依 TimekeepingStatusId 排序，然後依遞增順序排序。 排序參數無法配置。

ModifiedUtc 定義：內部時間標籤 = 最近計時狀態變更的時間。

參數

名稱 機碼 必要 類型 Description
excludeFormData
 excludeFormData boolean

如果為true，則ClockInFormData和ClockOutFormData一律會為Null。

傳回

身體
CustomerAPI.Models.Timekeeping.TimekeepingApiModel

定義

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

名稱 路徑 類型 Description
Id
 Id string

CustomerAPI.Models.Client.ReadClientApiModel

名稱 路徑 類型 Description
Id
 Id integer

用戶端的識別碼。
外部標識
 ExternalId string

用戶端的外部使用 ID - API 擴充功能屬性。
創建UTC
 CreatedUtc date-time

建立用戶端的原始時間點。
修改後UTC
 ModifiedUtc date-time

更新用戶端的最後一個時間點。
CustomFields資料
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
名稱
 Name string

用戶端的名稱。
Address
 Address CustomerAPI.Models.LocationApiModel
連絡人​​
 Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

名稱 路徑 類型 Description
欄位索引
 FieldIndex integer

欄位索引。
標題
 Caption string

欄位標題。
資料類型
 DataType integer

欄位資料類型。
DateTimeFormat
 DateTimeFormat integer

DateTime 格式。
價值觀
 Value

欄位值。

CustomerAPI.Models.LocationApiModel

名稱 路徑 類型 Description
拉特隆
 LatLon System.Nullable_1_Actsoft.Core.Geo.LatLon_
地址欄位1
 AddressLine1 string

AddressLine1 的 LocationApiModel。
地址欄位二
 AddressLine2 string

AddressLine2 的 LocationApiModel 。
城市
 City string

City of the LocationApiModel。
地區名稱
 RegionName string

LocationApiModel 的區域名稱。
郵遞區號
 PostalCode string

LocationApiModel 的郵遞區號。
國家代碼
 CountryCode string

ISO 3166-1 alpha-2 代碼。
子區域名稱
 SubRegionName string

LocationApiModel 的子區域。
子區域代碼
 SubRegionCode string

LocationApiModel 的子區域代碼。
區域代碼
 RegionCode string

LocationApiModel 的區域代碼。

CustomerAPI.Models.Client.ContactApiModel

名稱 路徑 類型 Description
名稱
 Name string

ContactApiModel 的名稱。
電話號碼
 PhoneNumber string

ContactApiModel 的 PhoneNumber。
Email
 Email string

ContactApiModel 的電子郵件。

System.Nullable_1_Actsoft.核心.地理.緯度_

名稱 路徑 類型 Description
緯度
 Latitude double
經度
 Longitude double

CustomerAPI.Models.ReturnIdApiModel

名稱 路徑 類型 Description
Id
 Id integer

物件識別碼。

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

定義自訂清單定義清單項目 API 模型。

名稱 路徑 類型 Description
自訂清單標識碼
 CustomListId integer

自訂清單識別碼。
名稱
 Name string

自訂清單名稱。
版本
 Version string

自訂清單版本。

CustomerAPI.Models.CustomLists.CustomListApiModel

自訂清單模型。

名稱 路徑 類型 Description
自訂清單標識碼
 CustomListId integer

自訂清單識別碼。
名稱
 Name string

自訂清單名稱。
版本
 Version string

自訂清單版本。
Definition
 Definition CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

定義自訂清單定義 API 模型。

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

定義自訂清單定義 API 模型。

名稱 路徑 類型 Description
Columns
 Columns array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

自訂清單欄。
UniqueColumnIndex索引
 UniqueColumnIndexIndex integer

唯一資料行索引。

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

定義自訂清單定義欄 API 模型。

名稱 路徑 類型 Description
Index
 Index integer

資料行索引。
資料類型
 DataType integer

資料行資料類型 （文字：0、數值：1、日期：2、時間：3、日期時間：4、電子郵件：5）。
名稱
 Name string

欄名稱。

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

自訂清單資料行資料陣列的容器。

名稱 路徑 類型 Description
資料行值
 ColumnValues array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

包含資料的資料行陣列。

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

此模型會定義自訂清單欄值。

名稱 路徑 類型 Description
資料行索引
 ColumnIndex integer

自訂清單資料行索引。
標題
 Caption string

自訂清單欄標題。
價值觀
 Value

自訂清單欄值。

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

自訂事件定義模型。

名稱 路徑 類型 Description
Id
 Id string
名稱
 Name string
反向地理編碼
 ReverseGeocode boolean
參數
 Parameters array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

名稱 路徑 類型 Description
名稱
 Name string
類型
 Type integer
標題
 Caption string
為必填項目
 Required boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

名稱 路徑 類型 Description
事件標識符
 EventId integer

事件標識碼。
事件類型
 EventType integer
事件代碼
 EventCode string

事件代碼。
EventTime
 EventTime date-time

具有 Local 和 Offset 的 ISO 格式。
User
 User CustomerAPI.Models.UserReferenceApiModel
車
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
使用者連結至車輛
 UserLinkedToVehicle boolean

如果啟用，則事件的車輛已指派使用者。
地點
 Location CustomerAPI.Models.LocationApiModel
主要地理圍欄
 PrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId
 CustomEventDefinitionId string

外部事件定義 ID。
事件參數
 EventParams object

事件參數。

CustomerAPI.Models.UserReferenceApiModel

名稱 路徑 類型 Description
UserId
 UserId integer

使用者的 UserId。
FirstName
 FirstName string

使用者的名字。
姓氏
 LastName string

使用者的姓氏。
員工編號
 EmployeeNumber string

使用者的員工編號。
GroupName
 GroupName string

指派給使用者的群組名稱。

CustomerAPI.Models.ReadVehicleApiModel

名稱 路徑 類型 Description
車輛識別碼
 VehicleId integer

BaseVehicleApiModel 的識別碼。
名稱
 Name string

BaseVehicleApiModel 的名稱。
VIN
 VIN string

BaseVehicleApiModel 的車輛識別號碼。
裝置名稱
 DeviceName string

GpsDeviceD的名稱與 BaseVehicleApiModel 相關聯。
SerialNumber
 SerialNumber string

BaseVehicleApiModel 的 SerialNumber。
GroupName
 GroupName string

BaseVehicleApiModel 的 GroupName。

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

名稱 路徑 類型 Description
地理圍欄識別碼
 GeofenceId integer

地理圍欄的 ID。
名稱
 Name string

地理圍欄的名稱。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

名稱 路徑 類型 Description
SubscriptionId (訂閱識別碼)
 SubscriptionId string

WebHookSubscriptionResultApiModel 的識別碼。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

名稱 路徑 類型 Description
SubscriptionId (訂閱識別碼)
 SubscriptionId string
網址
 Url string
地位
 Status integer

訂閱狀態 - （執行中：1，已停止：2）。

CustomerAPI.Models.Forms.StandaloneFormApiModel

名稱 路徑 類型 Description
Id
 Id integer

與此 StandaloneFormApiModel 相關聯的識別碼 - （舊版註解：FormHeaderId）。
表單標識符
 FormId integer

此 StandaloneFormApiModel 所參考表單的標識碼。
表單名稱
 FormName string

此 StandaloneFormApiModel 所參考的表單名稱。
條目編號
 EntryNumber string

表單資料輸入編號。
審查過
 Reviewed boolean

此 StandaloneFormApiModel 的檢閱狀態。
User
 User CustomerAPI.Models.UserReferenceApiModel
提交時間
 SubmittedTime date-time

提交 StandaloneFormApiModel 的時間點。
StartTime
 StartTime date-time

啟動 StandaloneFormApiModel 的時間點。
提交位置
 SubmittedLocation CustomerAPI.Models.LocationApiModel
表單數據
 FormData array of CustomerAPI.Models.Forms.FormFieldDataApiModel

與此 StandaloneFormApiModel 相關聯的欄位清單。
ApiModuleId
 ApiModuleId string

與此 StandaloneFormApiModel 相關聯之 ApiModule 的識別碼。
共用網址
 SharedUrl string

此 StandaloneFormApiModel 的共用 URL。
檢閱者用戶
 ReviewedByUser CustomerAPI.Models.UserReferenceApiModel
評論者Time時間
 ReviewedByTime date-time

表單審查時間

CustomerAPI.Models.Forms.FormFieldDataApiModel

名稱 路徑 類型 Description
可重複項目
 Repeatables array of array
items
 Repeatables array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id
 Id string

FormFieldDataApiModel 的識別碼。
價值觀
 Value

FormFieldDataApiModel 的值。
顯示值
 DisplayValue

DisplayValue 的 FormFieldDataApiModel。
捕獲時間
 CapturedTime date-time

已擷取 FormFieldDataApiModel 的時間點值。
擷取位置
 CapturedLocation CustomerAPI.Models.LocationApiModel
標題
 Caption string

FormFieldDataApiModel 的標題內容。
ApiFieldId
 ApiFieldId string

FormFieldDataApiModel 的 ApiField 標識碼。

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

名稱 路徑 類型 Description
Id
 Id string

FormFieldDataApiModel 的識別碼。
價值觀
 Value

FormFieldDataApiModel 的值。
顯示值
 DisplayValue

DisplayValue 的 FormFieldDataApiModel。
捕獲時間
 CapturedTime date-time

已擷取 FormFieldDataApiModel 的時間點值。
擷取位置
 CapturedLocation CustomerAPI.Models.LocationApiModel
標題
 Caption string

FormFieldDataApiModel 的標題內容。
ApiFieldId
 ApiFieldId string

FormFieldDataApiModel 的 ApiField 標識碼。

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

名稱 路徑 類型 Description
地理圍欄識別碼
 GeofenceId integer

GeofenceApiModel 的 GeofenceId。
創建UTC
 CreatedUtc date-time

CreatedUtc 的 GeofenceApiModel 的 CreatedUtc。
修改後UTC
 ModifiedUtc date-time

GeofenceApiModel 的 ModifiedUtc。
群組名稱
 GroupNames array of string

GroupPaths 的 GeofenceApiModel。
名稱
 Name string

GeofenceApiModelBase 的名稱。
類型
 Type string

GeofenceApiModel 的類型。
Shape
 Shape integer

形狀：0 代表圓形，1 代表多邊形。
Address
 Address CustomerAPI.Models.LocationApiModel
Radius
 Radius double

GeofenceApiModel 的半徑。
使用地理圍欄地址
 UseGeofenceAddress boolean

UseGeofenceAddress 的 GeofenceApiModel。

Actsoft.Core.Geo.LatLon

名稱 路徑 類型 Description
緯度
 Latitude double
經度
 Longitude double

CustomerAPI.Models.Geofence.GeofenceApiModel

名稱 路徑 類型 Description
地理圍欄識別碼
 GeofenceId integer

GeofenceApiModel 的 GeofenceId。
創建UTC
 CreatedUtc date-time

CreatedUtc 的 GeofenceApiModel 的 CreatedUtc。
修改後UTC
 ModifiedUtc date-time

GeofenceApiModel 的 ModifiedUtc。
群組名稱
 GroupNames array of string

GroupPaths 的 GeofenceApiModel。
Polygon
 Polygon array of Actsoft.Core.Geo.LatLon

多邊形點。 當「形狀」等於 1 時，應填滿。
名稱
 Name string

GeofenceApiModelBase 的名稱。
類型
 Type string

GeofenceApiModel 的類型。
Shape
 Shape integer

形狀：0 代表圓形，1 代表多邊形。
Address
 Address CustomerAPI.Models.LocationApiModel
Radius
 Radius double

GeofenceApiModel 的半徑。
使用地理圍欄地址
 UseGeofenceAddress boolean

UseGeofenceAddress 的 GeofenceApiModel。

CustomerAPI.Models.Order.OrderListItemApiModel

名稱 路徑 類型 Description
訂單編號
 OrderId integer

OrderBaseApiModel 的識別碼。
外部順序標識符
 ExternalOrderId string

用戶端的外部使用 OrderId - API 延伸模組屬性。
截止日期
 DueDate date-time

此 OrderBaseApiModel 的時間點到期完成 （在 v1.3 中已過時）。
StartTime
 StartTime date-time

此 OrderBaseApiModel 應該啟動的時間點 （在 v1.3 中引進）。
EndTime
 EndTime date-time

此 OrderBaseApiModel 的時間點到期完成 （在 v1.3 中引進）。
ServiceType
 ServiceType string

ServiceType 與此 OrderBaseApiModel 相關聯。
CreatedUTC日期
 CreatedUTCDate date-time

此 OrderBaseApiModel 已建立時間點。
訂單編號
 OrderNumber string

與此 OrderBaseApiModel 相關聯的訂單號碼。
已關閉
 IsClosed boolean

顯示 OrderBaseApiModel 是否已關閉的狀態。
地位
 Status CustomerAPI.Models.Order.OrderStatusApiModel
外部用戶端識別碼
 ExternalClientId string

用戶端的外部使用 ID - API 擴充功能屬性。
用戶端ID
 ClientId integer

用戶端的內部使用識別碼 - API 擴充功能屬性。
客戶
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

與此 OrderBaseApiModel 相關聯之 ApiService 的識別碼。
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

自訂欄位模組版本。
CustomFields資料
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
 Recurrence boolean

CustomerAPI.Models.Order.OrderStatusApiModel

名稱 路徑 類型 Description
狀態索引
 StatusIndex integer

OrderStatusApiModel 的索引。
狀態類型
 StatusType integer

訂單狀態：0 表示新訂單，1 表示已出貨，2 表示進行中，3 表示完成，4 表示已取消。
狀態標籤
 StatusLabel string

OrderStatusApiModel 的標籤內容。
狀態標識碼
 StatusId integer

OrderStatusApiModel 的識別碼。
狀態開始日期時間
 StatusStartDateTime date-time

OrderStatusApiModel 的開始時間點。
User
 User CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

名稱 路徑 類型 Description
群組名稱
 GroupNames array of string

用戶端群組階層名稱。
名稱
 Name string

用戶端的名稱。
Address
 Address CustomerAPI.Models.LocationApiModel
連絡人​​
 Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

名稱 路徑 類型 Description
狀態歷史記錄
 StatusHistory array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

與此 OrderApiModel 相關聯的 OrderStatusListItems 清單。
OrderFormFields
 OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
訂單編號
 OrderId integer

OrderBaseApiModel 的識別碼。
外部順序標識符
 ExternalOrderId string

用戶端的外部使用 OrderId - API 延伸模組屬性。
截止日期
 DueDate date-time

此 OrderBaseApiModel 的時間點到期完成 （在 v1.3 中已過時）。
StartTime
 StartTime date-time

此 OrderBaseApiModel 應該啟動的時間點 （在 v1.3 中引進）。
EndTime
 EndTime date-time

此 OrderBaseApiModel 的時間點到期完成 （在 v1.3 中引進）。
ServiceType
 ServiceType string

ServiceType 與此 OrderBaseApiModel 相關聯。
CreatedUTC日期
 CreatedUTCDate date-time

此 OrderBaseApiModel 已建立時間點。
訂單編號
 OrderNumber string

與此 OrderBaseApiModel 相關聯的訂單號碼。
已關閉
 IsClosed boolean

顯示 OrderBaseApiModel 是否已關閉的狀態。
地位
 Status CustomerAPI.Models.Order.OrderStatusApiModel
外部用戶端識別碼
 ExternalClientId string

用戶端的外部使用 ID - API 擴充功能屬性。
用戶端ID
 ClientId integer

用戶端的內部使用識別碼 - API 擴充功能屬性。
客戶
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

與此 OrderBaseApiModel 相關聯之 ApiService 的識別碼。
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

自訂欄位模組版本。
CustomFields資料
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
 Recurrence boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

名稱 路徑 類型 Description
狀態開始日期時間
 StatusStartDateTime date-time

此 OrderStatusHistoryListItemApiModel 狀態已啟動。
狀態結束日期時間
 StatusEndDateTime date-time

此 OrderStatusHistoryListItemApiModel 狀態已結束。
狀態標識碼
 StatusId integer

與此 OrderStatusHistoryListItemApiModel 相關聯的標識碼。
狀態索引
 StatusIndex integer

與此 OrderStatusHistoryListItemApiModel 相關聯的索引。
狀態標籤
 StatusLabel string

標籤與此 OrderStatusHistoryListItemApiModel 相關聯的內容。
狀態類型
 StatusType integer

訂單狀態：0 表示新訂單，1 表示已出貨，2 表示進行中，3 表示完成，4 表示已取消。
外部順序標識符
 ExternalOrderId string

用戶端的外部使用 OrderId - API 延伸模組屬性。
訂單編號
 OrderId integer

OrderId 與此 OrderStatusHistoryListItemApiModel 相關聯。
User
 User CustomerAPI.Models.UserReferenceApiModel
開始位址
 StartAddress CustomerAPI.Models.LocationApiModel
結束位址
 EndAddress CustomerAPI.Models.LocationApiModel
ApiServiceId
 ApiServiceId string

與此 OrderStatusHistoryListItemApiModel 相關聯之 ApiService 的 ID。
欄位值
 FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

名稱 路徑 類型 Description
OrderFormFields
 OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
訂單編號
 OrderId integer

OrderBaseApiModel 的識別碼。
外部順序標識符
 ExternalOrderId string

用戶端的外部使用 OrderId - API 延伸模組屬性。
截止日期
 DueDate date-time

此 OrderBaseApiModel 的時間點到期完成 （在 v1.3 中已過時）。
StartTime
 StartTime date-time

此 OrderBaseApiModel 應該啟動的時間點 （在 v1.3 中引進）。
EndTime
 EndTime date-time

此 OrderBaseApiModel 的時間點到期完成 （在 v1.3 中引進）。
ServiceType
 ServiceType string

ServiceType 與此 OrderBaseApiModel 相關聯。
CreatedUTC日期
 CreatedUTCDate date-time

此 OrderBaseApiModel 已建立時間點。
訂單編號
 OrderNumber string

與此 OrderBaseApiModel 相關聯的訂單號碼。
已關閉
 IsClosed boolean

顯示 OrderBaseApiModel 是否已關閉的狀態。
地位
 Status CustomerAPI.Models.Order.OrderStatusApiModel
外部用戶端識別碼
 ExternalClientId string

用戶端的外部使用 ID - API 擴充功能屬性。
用戶端ID
 ClientId integer

用戶端的內部使用識別碼 - API 擴充功能屬性。
客戶
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

與此 OrderBaseApiModel 相關聯之 ApiService 的識別碼。
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

自訂欄位模組版本。
CustomFields資料
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
 Recurrence boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

名稱 路徑 類型 Description
Id
 Id integer

計時項目的識別碼（舊版註解：RootSubmittedStatusId）。
User
 User CustomerAPI.Models.UserReferenceApiModel
時鐘時間
 ClockInTime date-time

使用者計時進入系統的時間點。
時鐘位置
 ClockInLocation CustomerAPI.Models.LocationApiModel
打卡時間
 ClockOutTime date-time

使用者打卡離開系統的時間點。
打卡位置
 ClockOutLocation CustomerAPI.Models.LocationApiModel
總小時數
 TotalHours double

此計時條目的總小時數。
休息時間總計
 TotalBreakHours double

此計時項目的休息（非工作）總小時數。
網路時數
 NetHours double

此計時條目的應計時總小時數。
已核准
 Approved boolean

主管批准此計時條目的狀態。
休息
 Breaks array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
時鐘形式數據
 ClockInFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
時鐘表單數據
 ClockOutFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion
 ModuleVersion System.Version
CompanyModuleId
 CompanyModuleId integer

用於提交此計時項目的公司模組的 ID。

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

名稱 路徑 類型 Description
Id
 Id integer

SubmittedStatusId 的 SubmittedStatusId 。
StartTime
 StartTime date-time

開始時間。
開始位置
 StartLocation CustomerAPI.Models.LocationApiModel
EndTime
 EndTime date-time

結束時間。
結束位置
 EndLocation CustomerAPI.Models.LocationApiModel
DurationHours
 DurationHours double

以小時為單位的持續時間。 如果 EndTime 為 Null，則它可以是 Null。
狀態類型
 StatusType integer

狀態類型：1 休息，2 午餐。
開始標籤
 StartLabel string

開始標籤。
結束標籤
 EndLabel string

結束標籤。
標題
 Caption string

標題。

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

名稱 路徑 類型 Description
CompanyModuleId
 CompanyModuleId integer
ModuleVersion
 ModuleVersion System.Version
欄位值
 FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

名稱 路徑 類型 Description
_少校
 _Major integer
_㹕
 _Minor integer
_造
 _Build integer
_校訂
 _Revision integer

CustomerAPI.Models.Tracking.TripApiModel

名稱 路徑 類型 Description
User
 User CustomerAPI.Models.UserReferenceApiModel
車
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
StartTime
 StartTime date-time

此 TripApiModel 狀態已啟動的時間點。
EndTime
 EndTime date-time

此 TripApiModel 狀態已結束。
開始位置
 StartLocation CustomerAPI.Models.LocationApiModel
結束位置
 EndLocation CustomerAPI.Models.LocationApiModel
StartPrimary地理柵欄
 StartPrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimary地理柵欄
 EndPrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
總停止時間
 TotalStopTime double

與此 TripApiModel 相關聯的停止時間量 （以小時為單位）。
總閒置時間
 TotalIdleTime double

與此 TripApiModel 相關聯的閒置時間量 （以小時為單位）。
總持續時間
 TotalDuration double

與此 TripApiModel 相關聯的完整時間 （以小時為單位）。
距離
 Distance double

與此 TripApiModel 相關聯的當地語系化單位所行駛的距離。

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

名稱 路徑 類型 Description
記錄
 Records array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
繼續標誌
 ContinuationToken string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

名稱 路徑 類型 Description
User
 User CustomerAPI.Models.UserReferenceApiModel
車
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
時間標籤
 TimeTag date-time

TimeTag 與此 GpsDataRecordApiModel 相關聯。
地點
 Location System.Nullable_1_Actsoft.Core.Geo.LatLon_
地理柵欄
 Geofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
速度
 Speed double

與此 GpsDataRecordApiModel 相關聯的移動速度。
Heading
 Heading double

與此 GpsDataRecordApiModel 相關聯的指南針方向 （以度數為單位）。
地位
 Status integer

與 OrderBaseApiModel 相關聯的 ApiMovementStatus - （已停止：1、閒置：2、移動：3、NotTracking：4）：OrderStatusApiModel。
狀態時間
 StatusTime string

已設定此 GpsDataRecordApiModel 狀態的時間點。
距離
 Distance double

與此 TripApiModel 相關聯的當地語系化單位所行駛的距離。
點火開啟
 IgnitionOn boolean

與此 GpsDataRecordApiModel 相關聯的車輛點火狀態。
位置提供者
 LocationProvider integer

與此 GpsDataRecordApiModel 相關聯的 API 位置提供者 - （GPS：1，網路：2）。

CustomerAPI.Models.User.ReadUserApiModel

名稱 路徑 類型 Description
UserName
 UserName string

使用者名稱。
UserId
 UserId integer

使用者的 ID 值。
GroupName
 GroupName string

使用者群組的名稱。
FirstName
 FirstName string

使用者的名字。
姓氏
 LastName string

使用者的姓氏。
員工編號
 EmployeeNumber string

使用者的員工編號。
Email
 Email string

使用者的電子郵件地址。
電話
 Phone string

用戶的電話號碼。
角色標識符
 RoleId integer

使用者的 RoleId - （系統管理員：1、使用者：3、進階使用者：5）。
IsActive
 IsActive boolean

使用者的作用中狀態。
EPTT啟用
 EPTTEnabled boolean

使用者增強型一鍵通功能的狀態：布林值。
EPTTNumber
 EPTTNumber string

使用者增強型一鍵通功能的電話號碼：字串。
EPTTWebMDN
 EPTTWebMDN string

用於向 Kodiak EPTT 系統驗證用戶的電話號碼 - 由 Kodiak 提供。
EPTTToken
 EPTTToken string

用於向 Kodiak EPTT 系統驗證使用者的 API 令牌 - 由 Kodiak 提供。
GPS支援
 GPSEnabled boolean

用戶的 GPS 功能狀態。
僅限行動裝置
 MobileOnly boolean

CAB 的桌面 Web 應用程式存取狀態 - （無 WebApp 存取：True，完整應用程式存取：False）。
授權類型
 LicenseType integer

指派給使用者的授權類型：- 0 代表未定義、1 代表一般、2 代表 WebOnly，以及 3 代表員工。

CustomerAPI.Models.User.ReadUserListItemApiModel

名稱 路徑 類型 Description
UserId
 UserId integer

使用者的 ID 值。
FirstName
 FirstName string

使用者的名字。
姓氏
 LastName string

使用者的姓氏。
員工編號
 EmployeeNumber string

使用者的員工編號。
Email
 Email string

使用者的電子郵件地址。
電話
 Phone string

用戶的電話號碼。
角色標識符
 RoleId integer

使用者的 RoleId - （系統管理員：1、使用者：3、進階使用者：5）。
IsActive
 IsActive boolean

使用者的作用中狀態。
EPTT啟用
 EPTTEnabled boolean

使用者增強型一鍵通功能的狀態：布林值。
EPTTNumber
 EPTTNumber string

使用者增強型一鍵通功能的電話號碼：字串。
EPTTWebMDN
 EPTTWebMDN string

用於向 Kodiak EPTT 系統驗證用戶的電話號碼 - 由 Kodiak 提供。
EPTTToken
 EPTTToken string

用於向 Kodiak EPTT 系統驗證使用者的 API 令牌 - 由 Kodiak 提供。
GPS支援
 GPSEnabled boolean

用戶的 GPS 功能狀態。
僅限行動裝置
 MobileOnly boolean

CAB 的桌面 Web 應用程式存取狀態 - （無 WebApp 存取：True，完整應用程式存取：False）。
授權類型
 LicenseType integer

指派給使用者的授權類型：- 0 代表未定義、1 代表一般、2 代表 WebOnly，以及 3 代表員工。

CustomerAPI.Models.Vehicles.VehicleReadApi

車輛資料模型。

名稱 路徑 類型 Description
內部識別碼
 InternalId integer
Number
 Number string
名稱
 Name string
類型
 Type string
標記
 Tag string
使用者員工編號
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
做
 Make string
年
 Year integer
型號
 Model string
顏色
 Color string
VIN
 VIN string
IsActive
 IsActive boolean
裝置類型
 DeviceType integer
裝置序列號
 DeviceSerialNumber string

整數

這是基本資料類型「整數」。

物件

這是類型 'object'。