TeamWherx

  • リファレンス

TeamWherx(TW) は、オフィスから離れた場所にいる従業員のリモート チームや一般的なビジネス オペレーションをより効果的に管理するのに役立つオールインワンのサービス管理プラットフォームです。 クラウドベースのソリューションとして、TW はリモート データ収集を可能にし、Web アプリ ダッシュボードを介してデータを表示します。これにより、マネージャーは、モバイル ワーカーを調整しながら、効率、生産性を高めて、コストを削減するためのよりスマートな戦略を作成するために必要な追加の洞察を得ることができます。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Actsoft サポート
[URL] https://www.actsoft.com/self-help-wizards
メール support@actsoft.com
Connector Metadata
発行者 Actsoft
Web サイト https://actsoft.com
プライバシー ポリシー https://www.actsoft.com/privacy
カテゴリー 生産性

コネクタの説明

TeamWherx を使用すると、デジタル フォーム情報、従業員の時間管理情報を作成および取得し、派遣システムで作業指示書を管理できます。

詳細な説明

TeamWherx コネクタを使用すると、ユーザーは複数のプラットフォーム間で接続して情報を交換できます。 データをアニメーション化して、プロセス フローを作成し、他の社内アプリケーションを駆動し、強力な分析を通知できます。 最新の実用的なデータにアクセスして、毎日、毎週、または毎月のプロセスを自動化および合理化します。

## 必要条件

このコネクタを使用するには、以下が必要です。

  • TeamWherx アカウント

  • TeamWherx API キー

  • Microsoft Power Apps または Power Automate 計画

## 資格情報を取得するには

API 開発者ポータル

コネクタにアクセスするには、最初に API 開発者ポータルのユーザー名とパスワードを設定し、顧客 API にサブスクライブする必要があります。

  1. アプリケーション内から、管理 > 設定 > API 設定。

  2. 資格情報を作成するを選択します。

  3. 名と姓を適切なフィールドに入力します。

  4. 電子メール フィールドに、メール アドレス フィールドを入力します。

  5. 招待状を保存してメールで送信を選択します。 次に、メールでパスワードの作成手順を確認してください。

  6. 招待メール内で、パスワードを選択をクリックすると、パスワードを作成できるダイアログが開きます。

  7. パスワードの保存を選択します。

  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. アクション リストから受注状態ポーリングを選択します。

  4. コネクタ名フィールドに、新しいコネクタの名前を入力します。

  5. 次に、自分の API キーを入力します。

  6. 作成を選択します。 プロセス フローの最初のステップは、フローチャートの最初の「ボックス」として表示されます。

接続フローのステップの各アクション ダイアログには、実行するアクションを制御するためにカスタマイズできるプロパティ フィールドがあります。

  1. 例を続けて、フォーム フィールドの値を表示するかどうかを選択します (excludeFormData パラメーター)。

  2. 接続用の X-API バージョンを選択します。

  3. 次のステップを選択して、受注状態が変更されたときに実行するアクションを設定します。

  4. 操作の選択ダイアログで、検索フィールドを使用してアプリケーションを検索し、次に目的のアクションを見つけます。 たとえば、受注状態が変更されるたびに Google ワークシートに行を挿入する場合は、Google Sheets を選択してからアクションの行を挿入を選択します。

  5. 次の 挿入 行 ダイアログで、ファイル フィールドをクリックし、結果を含むファイルを選択します。

  6. ワークシート フィールドで、データ ワークシート タイプを選択します。 動的に表示されるフィールドは、ワークシートのデータ列です。

  7. 各列のフィールドをクリックし、受注状態ポーリング プロパティ リストからプロパティを選択します。 または、検索フィールドを使用して、特定のプロパティを検索できます。

  8. 各列フィールドに複数のプロパティを入力できます。イベント列で StatusLabel を選択し、ダッシュを挿入してから、StatusStartDate を選択します。 これは、受注状態が更新されるたびに、状態ラベルと状態の開始日が新しい行のイベント列に書き込まれることを意味します。

  9. 新規 ステップ を選択します。 余談ですが、矢印コネクタにカーソルを合わせてクリックすると、いつでも新しいステップを挿入できます

  10. 操作の選択ダイアログで、TeamWherx コネクタをもう一度選択し、アクションのクライアントを作成するを選択します。

ここでも、ダイアログに表示される各フィールドは、Google Sheets スプレッドシートの列を表します。 各フィールドをクリックして、受注状態ポーリング プロパティ リストをアクティブ化し、必要なプロパティを選択します。

  1. この例では、名前フィールドの EmployeeNumber を選択し、受注状態を更新した従業員を識別します。

  2. GroupName を選択して、名前フィールドにも挿入します。

  3. 保存 を選択します。

これで、銃状態が更新されるたびに従業員番号と関連するグループでスプレッドシートを更新するプロセス フローが作成されました。

## 既知の問題と制限事項

  • すべてのエンドポイントのオーディオ ファイル バイナリ アップロード (POST) は、MP4 のみに制限されています。

  • 日時情報を必要とするすべてのエンドポイントの日付は、次の例のように、RFC3339 ガイドラインに従って指定する必要があります: 2021-09-22T02:36:56.52Z。 タイムスタンプに正確な秒を指定する必要はありません; 00 は許可されます。

## 一般的なエラーと解決策

発生する可能性のある一般的なエラー、応答コード、および修正の例は、API 開発者ポータルで確認できます。

アンコール - https://developer.wfmplatform.com/

## よくあるご質問

接続を作成する

このコネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

CustomListID でカスタム リスト データを取得する

CustomListID を使用して、単一のカスタム リスト内のすべてのデータ レコードを取得します。

結果は列で並べ替えられ、ページングがサポートされます。

エラー:

404 - 提供された customListId のカスタム リストがありません。
CustomListID でカスタム リスト フィールド リストを取得する

CustomListID を使用して、単一のカスタム リストのフィールド リストを取得します。
GPS データ Web hook にサブスクライブ

新しい GPS 追跡データ (GPS 位置) Web hook を追加します。 Web hook を使用すると、指定した URL で発生する GPS 位置を受信できます。
GPS データ Web hook をサブスクライブ解除

ID によって GPS データ Web hook サブスクリプションを削除します。
GPS データ エントリを取得

指定された日付範囲の GPS データ エントリを取得します。 また、後続トークンと次のデータ部分を取得するためのリンクを返します。 返されるページ数、およびページごとの要素数を指定できます。

削除されたユーザー/車両の位置は返されません。 ただし、データが要求されたときにユーザー/車両が存在し、後で削除された場合、後続トークンによって要求されたユーザー/車両のデータが返されます。

結果は、UtcTime と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
GPS データ フィードを使用した webhook コールバック

このサンプル メソッドは、gpsdata/subscribe によって使用され、顧客が指定した URL を使用してデータ フィードをポスト バックします。
ID で車両を取得

ID により単一の車両を取得します・
ID を指定してカスタム イベント定義を取得

ID を指定して単一のカスタム イベント定義を取得します。
イベント Web hook からサブスクライブ解除

ID によってイベント Web hook サブスクリプションを削除します。
イベント Web hook にサブスクライブ

新しいイベント Web hook サブスクリプションを追加します。 Web hook を使用すると、指定した URL で発生する会社のイベントに関する自動通知を受信できます。
イベント Web hook サブスクリプション ステータスをリセットします

サブスクリプション ステータスをステータス = 1 (「実行中」) に変更します。
イベント Web hook サブスクリプションのリストを取得する

イベント Web hook サブスクリプションのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、SubscriptionId と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
イベント フィードを使用した Web hook コールバック

このサンプル メソッドは、events/subscribe によって使用され、顧客が指定した URL を使用してイベント データ フィードをポスト バックします。
イベントの一覧の取得

特定の期間のイベントの一覧を取得します。 返されるページ数、およびページごとの要素数を指定できます。

イベント タイプでフィルタリングして、特定のイベントを取得します。 従業員が車両に関連付けられている場合、車両イベントを従業員に返すことができます。
イベントの送信

イベントを送信します。
カスタム イベント定義のリストの取得

カスタム イベント定義のリストを取得します。
カスタム イベント定義の作成や更新を行う

カスタム イベント定義の作成や更新を行います。
カスタム イベント定義を削除

カスタム イベント定義を削除します。
カスタム リスト レコードの削除

カスタムリストに登録されているレコードを customListId と id で削除します。

Id - カスタム リスト レコードの一意の値です。

エラー:

404 - customListId または ID が見つかりません。
カスタム リスト レコードを作成または更新

カスタム リスト データ レコードを作成または更新します。 一意の列の値は省略できますが、存在する場合は、クエリ パラメーターの一意の ID 値と一致する必要があります。
カスタム リストから単一のレコードを取得

CustomListId と一意の列値によって検出された単一のカスタム リスト データ レコードを取得します。

エラー:

404 - 提供された customListId および一意の列値のカスタム リスト レコードがありません
カスタム リスト定義を取得

カスタム イベント定義のリストを取得します。 定義リストには、既存のすべてのカスタム リストの CustomListID、名前、およびバージョンが含まれています。
クライアントの一覧を取得

クライアントの一覧を取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、名前と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
クライアントの作成

新しいクライアントを作成します。
クライアントの削除

既存のクライアントを ID により削除します。
クライアントの取得

ID を指定してクライアント オブジェクトを取得します。
クライアントの更新

既存のクライアントを更新します。
サブスクリプションの一覧を取得

Web hook サブスクリプションのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、SubscriptionId と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
サブスクリプションの状態をリセットします

サブスクリプション ステータスをステータス = 1 (「実行中」) に変更します。
ジオフェンスの一覧を取得

ジオフェンスの一覧を取得します。 返されるページ数とページあたりの要素数、およびジオフェンス座標がメートル法であるかどうかを指定できます。 結果は、名前と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
ジオフェンスの作成

新しいジオフェンスを作成します。
ジオフェンスの削除

既存のジオフェンスを ID により削除します。
ジオフェンスの取得

ID を指定してジオフェンスを取得します。
トリップのリストを取得

特定の期間のトリップの一覧を取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、StartUtcTIme と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
バイナリ ファイルのアップロード

このオプションを使用して、フォームの画像と音声ファイルをアップロードします。 バイナリ サイズは 10MB に制限されています。 サポートされているファイルの種類は、JPEG、PNG、MP4 です。
フォームの一覧を取得

以下に示すリクエスト パラメーターから、いずれかのフィルターを使用してフォームのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、SubmittedTime と降順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
フォームの作成

新しいフォームを追加します。
フォームの取得

ID を指定してフォームを取得します。
マイナー バージョンの取得

API の最新のマイナー バージョンを返します。
ユーザーのアクティブ化

ID によって既存のユーザーをアクティブ化します。
ユーザーの一覧を取得

ユーザー リストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、UserId と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
ユーザーの一部を更新

ユーザーのプロパティの一部を更新します。
ユーザーの取得

ID でユーザーを取得します。
ユーザーの更新

既存のユーザーを更新します。
ユーザーの非アクティブ化

ID によって既存のユーザーを非アクティブ化します。
ユーザーを作成する

新しいユーザーを作成します。
受注を作成します

新しい受注を追加します。
受注を取得する

既存の受注を ID により取得します。
受注を更新する

既存の注文を更新します。
既存のジオフェンスを更新

既存のジオフェンスを ID により更新します。
時間管理エントリのリストを取得

日付範囲に基づいて時間管理エントリのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、ClockInTime、TimekeepingStatusId の順に、昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
時間管理エントリを取得

ID を指定してエントリを取得します。
注文の一覧を取得

以下に示すリクエスト パラメーターから、フィルターを使用して注文のリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、Client.Name と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。
注文の状態の更新

既存の注文の状態を変更します。
添付ファイルをアップロードする

このオプションを使用して、フォームの添付ファイルをアップロードします。 バイナリ サイズは 25MB. に制限されています。 単一ファイルの予想されるマルチパート/フォームデータ要求。
車両のアクティブ化

ID により車両をアクティブ化します。
車両の削除

車両を ID により削除します。
車両の部分更新

ID により車両を部分更新します。
車両の非アクティブ化

ID により車両を非アクティブ化します。
車両を作成する

車両を作成します。
車両を更新する

ID で車両を更新します。
車両リストを取得

車両リストを取得します。

CustomListID でカスタム リスト データを取得する

操作 ID:
CustomListController_GetCustomList

CustomListID を使用して、単一のカスタム リスト内のすべてのデータ レコードを取得します。

結果は列で並べ替えられ、ページングがサポートされます。

エラー:

404 - 提供された customListId のカスタム リストがありません。

パラメーター

名前 キー 必須 型 説明
customListId
 customListId True integer

カスタム リスト ID。
pageNumber
 pageNumber integer

開始ページ番号。
pageSize
 pageSize integer

ページ サイズ。

戻り値

カスタム リスト列データ配列のコンテナ。

Body
CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

CustomListID でカスタム リスト フィールド リストを取得する

操作 ID:
CustomListController_GetById

CustomListID を使用して、単一のカスタム リストのフィールド リストを取得します。

パラメーター

名前 キー 必須 型 説明
customListId
 customListId True integer

カスタム リスト ID。

戻り値

カスタム リスト モデル。

Body
CustomerAPI.Models.CustomLists.CustomListApiModel

GPS データ Web hook にサブスクライブ

操作 ID:
TrackingController_SubscribeToGpsDataFeed

新しい GPS 追跡データ (GPS 位置) Web hook を追加します。 Web hook を使用すると、指定した URL で発生する GPS 位置を受信できます。

パラメーター

名前 キー 必須 型 説明
Url
 Url string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。
SecurityToken
 SecurityToken string

この WebHookSubscriptionParamsApiModel に関連付けられたセキュリティ トークン。

戻り値

Body
CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

GPS データ Web hook をサブスクライブ解除

操作 ID:
TrackingController_RemoveGpsDataFeedSubscription

ID によって GPS データ Web hook サブスクリプションを削除します。

パラメーター

名前 キー 必須 型 説明
subscriptionId
 subscriptionId True string

削除するサブスクリプション ID。

GPS データ エントリを取得

操作 ID:
TrackingController_GetGpsData

指定された日付範囲の GPS データ エントリを取得します。 また、後続トークンと次のデータ部分を取得するためのリンクを返します。 返されるページ数、およびページごとの要素数を指定できます。

削除されたユーザー/車両の位置は返されません。 ただし、データが要求されたときにユーザー/車両が存在し、後で削除された場合、後続トークンによって要求されたユーザー/車両のデータが返されます。

結果は、UtcTime と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
fromDate
 fromDate date-time

期間開始日。 推奨事項: 小さい日付範囲の代わりに大きい日付範囲を使用してください (>= 4 時間)。
toDate
 toDate date-time

期間終了日。 推奨事項: 小さい日付範囲の代わりに大きい日付範囲を使用してください (>= 4 時間)。
employeeNumber
 employeeNumber string

従業員番号。
VIN
 vin string

車両の VIN 番号。
useMetric
 useMetric boolean

メートル法を使用するかどうか。
token
 token string

最初の呼び出しによって返され、後続の呼び出しで使用される後続トークン。

戻り値

Body
CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

GPS データ フィードを使用した webhook コールバック

操作 ID:
TrackingController_subscribe_callback

このサンプル メソッドは、gpsdata/subscribe によって使用され、顧客が指定した URL を使用してデータ フィードをポスト バックします。

パラメーター

名前 キー 必須 型 説明
Id
 Id string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。
DeviceId
 DeviceId string

サブスクリプションが関連付けられている GpsDeviceDto ID。
DeviceType
 DeviceType integer

GpsDeviceDto の種類: Handset (0)、CalAmp (1)、Geotab (2)、Xirgo (3)。
Timestamp
 Timestamp date-time

ローカルとオフセットを使用した ISO 形式。
CompanyId
 CompanyId integer

会社 ID。
UserId
 UserId integer

ユーザー ID。
VehicleId
 VehicleId integer

車両 ID。
UserLinkedToVehicle
 UserLinkedToVehicle boolean

ユーザーが車両にリンクされているかどうか。
LocationProvider
 LocationProvider string

位置情報プロバイダー名。
Lat
 Lat double

緯度。
Lon
 Lon double

経度。
AccuracyFt
 AccuracyFt double

位置の精度 (フィート)。
AltitudeFt
 AltitudeFt double

高度 (フィート)。
Heading
 Heading integer

コンパスの方向 (度)。
SpeedMph
 SpeedMph double

移動速度 (Mph)。
BatteryStatus
 BatteryStatus integer

バッテリーの状態: 充電中以外 (0)、充電中 (1)。
BatteryLevel
 BatteryLevel integer

バッテリー レベル (%)。
ActivityState
 ActivityState integer

アクティビティの状態: 静止 (1)、移動 (2)。
IsNetworkConnected
 IsNetworkConnected boolean

現在、デバイスがネットワークに接続されているかどうか。
Rssi
 Rssi integer

受信信号強度インジケーター。
DOdoMl
 DOdoMl double

GpsDeviceDto 走行距離計 (マイル)。
VOdoMl
 VOdoMl double

車両走行距離計 (マイル)。

戻り値

返答
object

ID で車両を取得

操作 ID:
VehicleController_GetVehicle

ID により単一の車両を取得します・

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

車両のデータ モデル。

Body
CustomerAPI.Models.Vehicles.VehicleReadApi

ID を指定してカスタム イベント定義を取得

操作 ID:
EventController_Get

ID を指定して単一のカスタム イベント定義を取得します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

イベント定義 ID。

戻り値

カスタム イベント定義モデル。

Body
CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

イベント Web hook からサブスクライブ解除

操作 ID:
EventController_RemoveEventDataFeedSubscription

ID によってイベント Web hook サブスクリプションを削除します。

パラメーター

名前 キー 必須 型 説明
subscriptionId
 subscriptionId True string

削除するサブスクリプション ID。

イベント Web hook にサブスクライブ

操作 ID:
EventController_SubscribeToEventDataFeed

新しいイベント Web hook サブスクリプションを追加します。 Web hook を使用すると、指定した URL で発生する会社のイベントに関する自動通知を受信できます。

パラメーター

名前 キー 必須 型 説明
Url
 Url string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。
SecurityToken
 SecurityToken string

この WebHookSubscriptionParamsApiModel に関連付けられたセキュリティ トークン。

戻り値

Body
CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

イベント Web hook サブスクリプション ステータスをリセットします

操作 ID:
EventController_ResetSubscriptionHealthStatus

サブスクリプション ステータスをステータス = 1 (「実行中」) に変更します。

パラメーター

名前 キー 必須 型 説明
subscriptionId
 subscriptionId True integer

サブスクリプション ID。

イベント Web hook サブスクリプションのリストを取得する

操作 ID:
EventController_GetSubscriptions

イベント Web hook サブスクリプションのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、SubscriptionId と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

戻り値

response
array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

イベント フィードを使用した Web hook コールバック

操作 ID:
EventController_subscribe_callback

このサンプル メソッドは、events/subscribe によって使用され、顧客が指定した URL を使用してイベント データ フィードをポスト バックします。

パラメーター

名前 キー 必須 型 説明
Id
 Id string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。
EventType
 EventType integer
EventCode
 EventCode string
EventTime
 EventTime date-time

ローカルとオフセットを使用した ISO 形式。
DeviceId
 DeviceId string

サブスクリプションが関連付けられている GpsDeviceDto ID。
DeviceType
 DeviceType integer

GpsDeviceDto の種類: Handset (0)、CalAmp (1)、Geotab (2)、Xirgo (3)。
UserId
 UserId integer

ユーザー ID。
VehicleId
 VehicleId integer

車両 ID。
UserLinkedToVehicle
 UserLinkedToVehicle boolean

ユーザーが車両にリンクされているかどうか。
緯度
 Lat double

緯度。
経度
 Lon double

経度。
CustomEventDefinitionId
 CustomEventDefinitionId string
EventParams
 EventParams object

イベント パラメーター。

戻り値

返答
object

イベントの一覧の取得

操作 ID:
EventController_GetEvents

特定の期間のイベントの一覧を取得します。 返されるページ数、およびページごとの要素数を指定できます。

イベント タイプでフィルタリングして、特定のイベントを取得します。 従業員が車両に関連付けられている場合、車両イベントを従業員に返すことができます。

パラメーター

名前 キー 必須 型 説明
fromDate
 fromDate True date-time

期間開始日。
toDate
 toDate True date-time

期間終了日。
employeeNumber
 employeeNumber string

従業員番号。
vehicleNumber
 vehicleNumber string

車両番号。
pageNumber
 pageNumber integer

開始ページ番号。
pageSize
 pageSize integer

ページ サイズ。
eventType
 eventType integer

イベント タイプでフィルターします。

従業員番号が指定されています:

  • UserEvents(0) - ユーザー イベントのみ。
  • VehicleEvents(1) - センサー イベントを含む車両イベントのみ。
  • ExternalEvents(2) - 外部イベントのみ。

車両番号が指定されています:

  • UserEvents(0) - 該当なし。
  • VehicleEvents(1) - センサー イベントを含む車両イベントのみ。
  • ExternalEvents(2) - 外部イベントのみ。

従業員番号も車両番号も指定されていません。

  • UserEvents(0) - ユーザー イベントのみ。
  • VehicleEvents(1) - センサー イベントを含む車両イベントのみ。
  • ExternalEvents(2) - 外部イベントのみ。

戻り値

response
array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

イベントの送信

操作 ID:
EventController_Post

イベントを送信します。

パラメーター

名前 キー 必須 型 説明
EventDefinitionId
 EventDefinitionId string

イベント定義 ID。
EmployeeNumber
 EmployeeNumber string

従業員番号。
VehicleNumber
 VehicleNumber string

車両番号。
DeviceSerialNumber
 DeviceSerialNumber string

GpsDeviceDto シリアル番号。
経度
 Latitude double
緯度
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
時間
 Time date-time
Parameters
 Parameters object

イベント パラメーター。

カスタム イベント定義のリストの取得

操作 ID:
EventController_GetList

カスタム イベント定義のリストを取得します。

戻り値

response
array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

カスタム イベント定義の作成や更新を行う

操作 ID:
EventController_Put

カスタム イベント定義の作成や更新を行います。

パラメーター

名前 キー 必須 型 説明
id
 id True string

イベント定義 ID。
件名
 Name string
ReverseGeocode
 ReverseGeocode boolean
件名
 Name string
タイプ
 Type integer
Caption
 Caption string
Required
 Required boolean

カスタム イベント定義を削除

操作 ID:
EventController_Delete

カスタム イベント定義を削除します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

イベント定義 ID。

カスタム リスト レコードの削除

操作 ID:
CustomListController_DeleteRecord

カスタムリストに登録されているレコードを customListId と id で削除します。

Id - カスタム リスト レコードの一意の値です。

エラー:

404 - customListId または ID が見つかりません。

パラメーター

名前 キー 必須 型 説明
customListId
 customListId True integer

カスタム リスト ID。
id
 id True string

一意の値。

カスタム リスト レコードを作成または更新

操作 ID:
CustomListController_PutRecord

カスタム リスト データ レコードを作成または更新します。 一意の列の値は省略できますが、存在する場合は、クエリ パラメーターの一意の ID 値と一致する必要があります。

パラメーター

名前 キー 必須 型 説明
customListId
 customListId True integer

カスタム リスト ID。
id
 id True string

一意の値。
ColumnIndex
 ColumnIndex integer

カスタム リストの列インデックス。
Caption
 Caption string

カスタム リストの列キャプション。
Value
 Value

カスタム リストの列値。

カスタム リストから単一のレコードを取得

操作 ID:
CustomListController_GetSingleRecord

CustomListId と一意の列値によって検出された単一のカスタム リスト データ レコードを取得します。

エラー:

404 - 提供された customListId および一意の列値のカスタム リスト レコードがありません

パラメーター

名前 キー 必須 型 説明
customListId
 customListId True integer

カスタム リスト ID。
id
 id True string

一意の値。

戻り値

カスタム リスト列データ配列のコンテナ。

Body
CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

カスタム リスト定義を取得

操作 ID:
CustomListController_Get

カスタム イベント定義のリストを取得します。 定義リストには、既存のすべてのカスタム リストの CustomListID、名前、およびバージョンが含まれています。

戻り値

response
array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

クライアントの一覧を取得

操作 ID:
ClientController_GetClients

クライアントの一覧を取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、名前と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
pageNumber
 pageNumber integer

開始ページ番号。
pageSize
 pageSize integer

ページ サイズ。

戻り値

response
array of CustomerAPI.Models.Client.ReadClientApiModel

クライアントの作成

操作 ID:
ClientController_Create

新しいクライアントを作成します。

パラメーター

名前 キー 必須 型 説明
ExternalId
 ExternalId string

クライアントの外部使用 ID - API 拡張プロパティ。
FieldIndex
 FieldIndex integer

フィールド インデックス。
Value
 Value

フィールド値。
Name
 Name string

クライアントの名前です。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Name
 Name string

ContactApiModel の名前。
PhoneNumber
 PhoneNumber string

ContactApiModel の PhoneNumber。
Email
 Email string

ContactApiModel の Email。
geocode
 geocode boolean

住所をジオコード化する必要があるかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

クライアントの削除

操作 ID:
ClientController_Delete

既存のクライアントを ID により削除します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

クライアント ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

クライアントの取得

操作 ID:
ClientController_Get

ID を指定してクライアント オブジェクトを取得します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

クライアント ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.Client.ReadClientApiModel

クライアントの更新

操作 ID:
ClientController_Update

既存のクライアントを更新します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
ExternalId
 ExternalId string

クライアントの外部使用 ID - API 拡張プロパティ。
FieldIndex
 FieldIndex integer

フィールド インデックス。
Value
 Value

フィールド値。
Name
 Name string

クライアントの名前です。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Name
 Name string

ContactApiModel の名前。
PhoneNumber
 PhoneNumber string

ContactApiModel の PhoneNumber。
Email
 Email string

ContactApiModel の Email。
geocode
 geocode boolean

住所をジオコード化する必要があるかどうか。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

サブスクリプションの一覧を取得

操作 ID:
TrackingController_GetSubscriptions

Web hook サブスクリプションのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、SubscriptionId と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

戻り値

response
array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

サブスクリプションの状態をリセットします

操作 ID:
TrackingController_ResetSubscriptionHealthStatus

サブスクリプション ステータスをステータス = 1 (「実行中」) に変更します。

パラメーター

名前 キー 必須 型 説明
subscriptionId
 subscriptionId True integer

サブスクリプション ID。

ジオフェンスの一覧を取得

操作 ID:
GeofenceController_GetGeofences

ジオフェンスの一覧を取得します。 返されるページ数とページあたりの要素数、およびジオフェンス座標がメートル法であるかどうかを指定できます。 結果は、名前と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
pageNumber
 pageNumber integer

開始ページ番号。 既定値は 1 です。
pageSize
 pageSize integer

ページ サイズ。 既定値は 500 です。
useMetric
 useMetric boolean

メートル法を使用するかどうか。

戻り値

response
array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

ジオフェンスの作成

操作 ID:
GeofenceController_CreateGeofence

新しいジオフェンスを作成します。

パラメーター

名前 キー 必須 型 説明
GroupNames
 GroupNames array of string

GeofenceCreateApiModel の GroupPaths。
経度
 Latitude double
緯度
 Longitude double
件名
 Name string

GeofenceApiModelBase の名前。
Type
 Type string

GeofenceApiModel のタイプ。
Shape
 Shape integer

Shape: 円の場合は 0、多角形の場合は 1。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Radius
 Radius double

GeofenceApiModel の半径。
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel の UseGeofenceAddress。
useMetric
 useMetric boolean

メートル法を使用するかどうか。
geocode
 geocode boolean

住所をジオコード化する必要があるかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

ジオフェンスの削除

操作 ID:
GeofenceController_DeleteGeofence

既存のジオフェンスを ID により削除します。

パラメーター

名前 キー 必須 型 説明
id
 id True integer

ジオフェンス Id。

ジオフェンスの取得

操作 ID:
GeofenceController_GetGeofence

ID を指定してジオフェンスを取得します。

パラメーター

名前 キー 必須 型 説明
id
 id True integer

ジオフェンス Id。
useMetric
 useMetric boolean

メートル法を使用するかどうか。

戻り値

Body
CustomerAPI.Models.Geofence.GeofenceApiModel

トリップのリストを取得

操作 ID:
TrackingController_GetTrips

特定の期間のトリップの一覧を取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、StartUtcTIme と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
fromDate
 fromDate True date-time

期間開始日。 推奨事項: 小さい日付範囲の代わりに大きい日付範囲を使用してください (>= 4 時間)。
toDate
 toDate True date-time

期間終了日。 推奨事項: 小さい日付範囲の代わりに大きい日付範囲を使用してください (>= 4 時間)。
employeeNumber
 employeeNumber string

従業員番号。
vin
 vin string

車両の VIN 番号。
pageNumber
 pageNumber integer

開始ページ番号。 既定値は 1 です。
pageSize
 pageSize integer

ページ サイズ。 既定値は 1000 です。
useMetric
 useMetric boolean

メートル法を使用するかどうか。

戻り値

返答
array of CustomerAPI.Models.Tracking.TripApiModel

バイナリ ファイルのアップロード

操作 ID:
BinaryController_UploadBinary

このオプションを使用して、フォームの画像と音声ファイルをアップロードします。 バイナリ サイズは 10MB に制限されています。 サポートされているファイルの種類は、JPEG、PNG、MP4 です。

戻り値

Body
CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

フォームの一覧を取得

操作 ID:
FormController_GetFormsAsync

以下に示すリクエスト パラメーターから、いずれかのフィルターを使用してフォームのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、SubmittedTime と降順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
submittedStartDate
 submittedStartDate True date-time

提出されたフォームの開始日。
submittedEndDate
 submittedEndDate True date-time

提出されたフォームの終了日。
apiModuleId
 apiModuleId string

フォーム モジュール ID。
employeeNumber
 employeeNumber string

従業員番号。
reviewed
 reviewed boolean

レビュー済みのフォームのみを取得するかどうか。 既定値はすべてで null です。
pageNumber
 pageNumber integer

開始ページ番号。 既定値は 1 です。
pageSize
 pageSize integer

ページ サイズ。 既定値は 1000 です。

戻り値

response
array of CustomerAPI.Models.Forms.StandaloneFormApiModel

フォームの作成

操作 ID:
FormController_PostFormAsync

新しいフォームを追加します。

パラメーター

名前 キー 必須 型 説明
ApiModuleId
 ApiModuleId string

この CreateStandaloneFormApiModel に関連付けられている ApiModule の ID。
Reviewed
 Reviewed boolean

この CreateStandaloneFormApiModel のレビューのステータス。
UserId
 UserId integer

ユーザーの UserId。
EmployeeNumber
 EmployeeNumber string

ユーザーの従業員番号。
SubmittedTime
 SubmittedTime True date-time

CreateStandaloneFormApiModel が送信された時点。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
ApiFieldId
 ApiFieldId True string

APIフィールド Id。
Value
 Value True

FormFieldDataApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Sign" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

バイナリ データがキャプチャされた時刻。 形式 - 日付-時刻 (RFC3339 での日時) (オフセットを含む)。
Latitude
 Latitude double
Longitude
 Longitude double
住所 1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
ApiFieldId
 ApiFieldId True string

APIフィールド Id。
Value
 Value True

FormFieldDataApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Sign" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

バイナリ データがキャプチャされた時刻。 形式 - 日付-時刻 (RFC3339 での日時) (オフセットを含む)。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

フォームの取得

操作 ID:
FormController_GetFormAsync

ID を指定してフォームを取得します。

パラメーター

名前 キー 必須 型 説明
id
 id True integer

フォーム ID。

戻り値

Body
CustomerAPI.Models.Forms.StandaloneFormApiModel

マイナー バージョンの取得

操作 ID:
VersionController_Get

API の最新のマイナー バージョンを返します。

ユーザーのアクティブ化

操作 ID:
UserController_Activate

ID によって既存のユーザーをアクティブ化します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

ユーザーの一覧を取得

操作 ID:
UserController_GetUsers

ユーザー リストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、UserId と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
pageNumber
 pageNumber integer

開始ページ番号。 既定値は 1 です。
pageSize
 pageSize integer

ページ サイズ。 既定値は 500 です。

戻り値

response
array of CustomerAPI.Models.User.ReadUserListItemApiModel

ユーザーの一部を更新

操作 ID:
UserController_PartialUpdate

ユーザーのプロパティの一部を更新します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
object
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

ユーザーの取得

操作 ID:
UserController_Get

ID でユーザーを取得します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.User.ReadUserApiModel

ユーザーの更新

操作 ID:
UserController_Update

既存のユーザーを更新します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
UserName
 UserName string

ユーザーの UserName。
Password
 Password password

ユーザーのパスワード。
GroupName
 GroupName string

ユーザーのグループ名。
FirstName
 FirstName string

ユーザーの名。
LastName
 LastName string

ユーザーの姓。
EmployeeNumber
 EmployeeNumber string

ユーザーの従業員番号。
Email
 Email string

ユーザーのメール アドレスです。
Phone
 Phone string

ユーザーの電話番号です。
RoleId
 RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、パワー ユーザー: 5)。
IsActive
 IsActive boolean

ユーザーのアクティブ状態。
EPTTEnabled
 EPTTEnabled boolean

ユーザー向けの拡張プッシュツートーク機能のステータス: ブール値。
EPTTNumber
 EPTTNumber string

ユーザー向けの拡張プッシュツートーク機能の電話番号: 文字列。
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT システムに対してユーザーを認証するために使用される電話番号 - Kodiak によって提供されます。
EPTTToken
 EPTTToken string

Kodiak EPTT システムに対してユーザーを認証するために使用される API トークン - Kodiak によって提供されます。
GPSEnabled
 GPSEnabled boolean

ユーザーの GPS 機能のステータス。
MobileOnly
 MobileOnly boolean

CAB のデスクトップ Web アプリケーション アクセスのステータス - (WebApp アクセスなし: True、フル アプリ アクセス: False)。
LicenseType
 LicenseType integer

ユーザーに割り当てられたライセンスのタイプ: - 未定義の場合は 0、通常の場合は 1、WebOnly の場合は 2、従業員の場合は 3。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

ユーザーの非アクティブ化

操作 ID:
UserController_Deactivate

ID によって既存のユーザーを非アクティブ化します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

ユーザーを作成する

操作 ID:
UserController_Create

新しいユーザーを作成します。

パラメーター

名前 キー 必須 型 説明
ユーザー名
 UserName string

ユーザーの UserName。
Password
 Password password

ユーザーのパスワード。
GroupName
 GroupName string

ユーザーのグループ名。
FirstName
 FirstName string

ユーザーの名。
LastName
 LastName string

ユーザーの姓。
EmployeeNumber
 EmployeeNumber string

ユーザーの従業員番号。
Email
 Email string

ユーザーのメール アドレスです。
Phone
 Phone string

ユーザーの電話番号です。
RoleId
 RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、パワー ユーザー: 5)。
IsActive
 IsActive boolean

ユーザーのアクティブ状態。
EPTTEnabled
 EPTTEnabled boolean

ユーザー向けの拡張プッシュツートーク機能のステータス: ブール値。
EPTTNumber
 EPTTNumber string

ユーザー向けの拡張プッシュツートーク機能の電話番号: 文字列。
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT システムに対してユーザーを認証するために使用される電話番号 - Kodiak によって提供されます。
EPTTToken
 EPTTToken string

Kodiak EPTT システムに対してユーザーを認証するために使用される API トークン - Kodiak によって提供されます。
GPSEnabled
 GPSEnabled boolean

ユーザーの GPS 機能のステータス。
MobileOnly
 MobileOnly boolean

CAB のデスクトップ Web アプリケーション アクセスのステータス - (WebApp アクセスなし: True、フル アプリ アクセス: False)。
LicenseType
 LicenseType integer

ユーザーに割り当てられたライセンスのタイプ: - 未定義の場合は 0、通常の場合は 1、WebOnly の場合は 2、従業員の場合は 3。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

受注を作成します

操作 ID:
OrderController_Create

新しい受注を追加します。

パラメーター

名前 キー 必須 型 説明
CreatedDateTime
 CreatedDateTime date-time

この CreateUpdateOrderApiModel が作成された時点。
ExternalClientId
 ExternalClientId True string

クライアントの外部使用 ID - API 拡張プロパティ。
ServiceType
 ServiceType True string

この CreateUpdateOrderApiModel に関連付けられているサービス タイプ。
ExternalOrderId
 ExternalOrderId string

クライアントの外部使用 OrderId - API 拡張プロパティ。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Name
 Name string

ContactApiModel の名前。
PhoneNumber
 PhoneNumber string

ContactApiModel の PhoneNumber。
Email
 Email string

ContactApiModel の Email。
DueDate
 DueDate date-time

この BaseUpdateOrderApiModel が完了する予定の時点 (v1.3 では廃止)。
StartTime
 StartTime date-time

この BaseUpdateOrderApiModel が開始する必要がある時点 (v1.3 で導入)。
EndTime
 EndTime date-time

この BaseUpdateOrderApiModel が終了する必要がある時点 (v1.3 で導入)。
Caption
 Caption True string
Value
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Caption
 Caption True string
価値
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
EmployeeNumber
 EmployeeNumber True string

この NewOrderStatusApiModel を作成したユーザーの EmployeeNumber。
StatusLabel
 StatusLabel True string

この NewOrderStatusApiModel に関連付けられている 状態Label のラベル コンテンツ。
StatusStartDateTime
 StatusStartDateTime True date-time

この NewOrderStatusApiModel ステータスが開始された時点。
Caption
 Caption True string
Value
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Caption
 Caption True string
価値
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
FieldIndex
 FieldIndex integer

フィールド インデックス。
価値
 Value

フィールド値。
geocode
 geocode boolean

住所をジオコード化する必要があるかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

受注を取得する

操作 ID:
OrderController_GetOrder

既存の受注を ID により取得します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
include-status-history
 include-status-history string

true の場合、応答にはこの注文のすべてのステータス履歴とフォーム データが含まれます。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.Order.OrderApiModel

受注を更新する

操作 ID:
OrderController_Update

既存の注文を更新します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
ExternalOrderId
 ExternalOrderId string

クライアントの外部使用 OrderId - API 拡張プロパティ。
IsClosed
 IsClosed boolean

UpdateOrderApiModel が閉じたかどうかを示すステータス。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Name
 Name string

ContactApiModel の名前。
PhoneNumber
 PhoneNumber string

ContactApiModel の PhoneNumber。
Email
 Email string

ContactApiModel の Email。
DueDate
 DueDate date-time

この BaseUpdateOrderApiModel が完了する予定の時点 (v1.3 では廃止)。
StartTime
 StartTime date-time

この BaseUpdateOrderApiModel が開始する必要がある時点 (v1.3 で導入)。
EndTime
 EndTime date-time

この BaseUpdateOrderApiModel が終了する必要がある時点 (v1.3 で導入)。
Caption
 Caption True string
Value
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Caption
 Caption True string
価値
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
EmployeeNumber
 EmployeeNumber True string

この NewOrderStatusApiModel を作成したユーザーの EmployeeNumber。
StatusLabel
 StatusLabel True string

この NewOrderStatusApiModel に関連付けられている 状態Label のラベル コンテンツ。
StatusStartDateTime
 StatusStartDateTime True date-time

この NewOrderStatusApiModel ステータスが開始された時点。
Caption
 Caption True string
Value
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Caption
 Caption True string
価値
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
FieldIndex
 FieldIndex integer

フィールド インデックス。
価値
 Value

フィールド値。
geocode
 geocode boolean

住所をジオコード化する必要があるかどうか。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

既存のジオフェンスを更新

操作 ID:
GeofenceController_UpdateGeofence

既存のジオフェンスを ID により更新します。

パラメーター

名前 キー 必須 型 説明
id
 id True integer

ジオフェンス Id。
GroupNames
 GroupNames array of string

GeofenceUpdateApiModel の GroupPaths です。
経度
 Latitude double
緯度
 Longitude double
件名
 Name string

GeofenceApiModelBase の名前。
Type
 Type string

GeofenceApiModel のタイプ。
Shape
 Shape integer

Shape: 円の場合は 0、多角形の場合は 1。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Radius
 Radius double

GeofenceApiModel の半径。
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel の UseGeofenceAddress。
useMetric
 useMetric boolean

メートル法を使用するかどうか。
geocode
 geocode boolean

住所をジオコード化する必要があるかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

時間管理エントリのリストを取得

操作 ID:
TimekeepingController_GetTimekeepingDataList

日付範囲に基づいて時間管理エントリのリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、ClockInTime、TimekeepingStatusId の順に、昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
fromDate
 fromDate True date-time

開始日。
toDate
 toDate True date-time

終了日。
employeeNumber
 employeeNumber string

従業員番号。
承認済み
 approved boolean

承認されたエントリのみをフィルタリングします。
closedOnly
 closedOnly boolean

終了したエントリのみをフィルタリングします。
excludeFormData
 excludeFormData boolean

フォーム データを除外するためのフィルター。
pageNumber
 pageNumber integer

開始ページ番号 (既定値 1)。
pageSize
 pageSize integer

ページ サイズ (既定値は 1000)。

戻り値

response
array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

時間管理エントリを取得

操作 ID:
TimekeepingController_GetTimekeepingEntryAsync

ID を指定してエントリを取得します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

レコードの ID。

戻り値

Body
CustomerAPI.Models.Timekeeping.TimekeepingApiModel

注文の一覧を取得

操作 ID:
OrderController_GetOrders

以下に示すリクエスト パラメーターから、フィルターを使用して注文のリストを取得します。 返されるページ数、およびページごとの要素数を指定できます。 結果は、Client.Name と昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

パラメーター

名前 キー 必須 型 説明
dueDateFrom
 dueDateFrom True date-time

期限開始日でフィルターします。
dueDateTo
 dueDateTo True date-time

期限終了日でフィルターします。
employeeNumber
 employeeNumber string

従業員番号でフィルター処理します。
pageNumber
 pageNumber integer

開始ページ番号 (既定値 1)。
pageSize
 pageSize integer

ページ サイズ (既定値は 500)。

戻り値

response
array of CustomerAPI.Models.Order.OrderListItemApiModel

注文の状態の更新

操作 ID:
OrderController_ChangeStatus

既存の注文の状態を変更します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
EmployeeNumber
 EmployeeNumber True string

この NewOrderStatusApiModel を作成したユーザーの EmployeeNumber。
StatusLabel
 StatusLabel True string

この NewOrderStatusApiModel に関連付けられている 状態Label のラベル コンテンツ。
StatusStartDateTime
 StatusStartDateTime True date-time

この NewOrderStatusApiModel ステータスが開始された時点。
Caption
 Caption True string
Value
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
Latitude
 Latitude double
Longitude
 Longitude double
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。
Caption
 Caption True string
価値
 Value

UpdateFormFieldApiModel の値。

"NFC" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded image (see upload binary API) "Note": string // Note for the referenced image }

"Signature" フィールド値の形式 (バイナリ参照): { "BinaryId": string // Binary ID of an uploaded image (see upload binary API) }

"Audio" フィールド値の形式 (バイナリ参照): { "BinaryId": string, // Binary ID of an uploaded audio (see upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime
 CapturedTime date-time

値がキャプチャされた時点。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

添付ファイルをアップロードする

操作 ID:
BinaryController_UploadAttachment

このオプションを使用して、フォームの添付ファイルをアップロードします。 バイナリ サイズは 25MB. に制限されています。 単一ファイルの予想されるマルチパート/フォームデータ要求。

戻り値

Body
CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

車両のアクティブ化

操作 ID:
VehicleController_Activate

ID により車両をアクティブ化します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

返答
integer

車両の削除

操作 ID:
VehicleController_Delete

車両を ID により削除します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

車両の部分更新

操作 ID:
VehicleController_PartialUpdateVehicle

ID により車両を部分更新します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
object
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

車両の非アクティブ化

操作 ID:
VehicleController_Deactivate

ID により車両を非アクティブ化します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

返答
integer

車両を作成する

操作 ID:
VehicleController_CreateVehicle

車両を作成します。

パラメーター

名前 キー 必須 型 説明
回数
 Number string
件名
 Name string
タイプ
 Type string
Tag
 Tag string
UserEmployeeNumber
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
Make
 Make string
年式
 Year integer
Model
 Model string
カラー
 Color string
VIN
 VIN string
IsActive
 IsActive boolean
DeviceType
 DeviceType integer
DeviceSerialNumber
 DeviceSerialNumber string

戻り値

Body
CustomerAPI.Models.ReturnIdApiModel

車両を更新する

操作 ID:
VehicleController_UpdateVehicle

ID で車両を更新します。

パラメーター

名前 キー 必須 型 説明
id
 id True string

外部 ID の使用パラメーターの値によって決まる、外部 ID または内部 ID。
回数
 Number string
件名
 Name string
タイプ
 Type string
Tag
 Tag string
UserEmployeeNumber
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
Make
 Make string
Year
 Year integer
Model
 Model string
Color
 Color string
VIN
 VIN string
IsActive
 IsActive boolean
DeviceType
 DeviceType integer
DeviceSerialNumber
 DeviceSerialNumber string
use-external-id
 use-external-id boolean

external id を使用するかどうか。

戻り値

response
integer

車両リストを取得

操作 ID:
VehicleController_GetVehicles

車両リストを取得します。

パラメーター

名前 キー 必須 型 説明
pageNumber
 pageNumber integer

ページ番号。
pageSize
 pageSize integer

ページ内の最大アイテム数。 既定 = 1000。 最大値 = 2000。
activeOnly
 activeOnly boolean

true の場合 - アクティブな車両のみを返します。 既定値 = false。

戻り値

返答
array of CustomerAPI.Models.Vehicles.VehicleReadApi

トリガー

フォーム データ ポール

フォーム API ポーリング エンドポイントを使用すると、アプリケーションは、最近送信されたスタンドアロン フォームを継続的にポーリングおよび処理できます。

統合:

このエンドポイントは、ポーリング トリガー統合として Microsoft Flow を使用してすぐに機能するように設計されています。 または、任意の言語を使用して独自のカスタム統合を開発することもできます。

使用法:

一般的なシナリオでは、このエンドポイントへの最初のリクエストはパラメーターを提供しません。 考えられる成功応答は 2 つあります。

  • HTTP 応答コード 200 - 最近送信されたフォーム レコードが存在します。応答本文にはフォーム データが表示されます。
  • HTTP 応答コード 202 - 最近送信されたレコードが存在しません。応答本文は空になります。

どちらの場合も、応答には 2 つの重要なヘッダーがあります。

  • Location - 次の要求の 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 つの重要なヘッダーがあります。

  • Location - 次の要求の 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 つの重要なヘッダーがあります。

  • Location - 次の要求の URL です。
  • Retry-After - 次の要求の推奨時間間隔 (秒単位)。 たとえば、取得するデータがある場合、Retry-After ヘッダーの値は 1 または 60 になります。 取得するデータがない場合、Retry-After ヘッダーの値は 300 になります。

注: これらはあくまで推奨値であり、アプリケーションの要件に応じて異なる頻度でポーリングすることも可能です。 最初の要求の後、後続のすべての要求では、最新の応答の Location ヘッダーで提供されている URL を使用する必要があります。 時間管理エントリが要求から欠落していないことを確認するために必要なものがすでに含まれているため、これ以上パラメーターを URL に追加しないでください。

結果は、ModifiedUtc、TimekeepingStatusId の順に、その後昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

ModifiedUtc 定義: 内部時間タグ = 最新の時間管理状態変更の時間。
注文ポール

注文 API ポーリング エンドポイントを使用すると、アプリケーションは、注文の最近の変更を継続的にポーリングおよび処理できます。

統合:

このエンドポイントは、ポーリング トリガー統合として Microsoft Flow を使用してすぐに機能するように設計されています。 または、任意の言語を使用して独自のカスタム統合を開発することもできます。

使用法:

一般的なシナリオでは、このエンドポイントへの最初のリクエストはパラメーターを提供しません。 考えられる成功応答は 2 つあります。

  • HTTP 応答コード 200 - 最近変更された注文が存在します。応答本文には注文データが表示されます。
  • HTTP 応答コード 202 - 最近変更れた注文が存在しません。応答本文は空になります。

どちらの場合も、応答には 2 つの重要なヘッダーがあります。

  • Location - 次の要求の URL です。
  • Retry-After - 次の要求の推奨時間間隔 (秒単位)。 たとえば、取得するデータがある場合、Retry-After ヘッダーの値は 1 または 60 になります。 取得するデータがない場合、Retry-After ヘッダーの値は 300 になります。

注: これらはあくまで推奨値であり、アプリケーションの要件に応じて異なる頻度でポーリングすることも可能です。 最初の要求の後、後続のすべての要求では、最新の応答の Location ヘッダーで提供されている URL を使用する必要があります。 注文の変更が要求から欠落していないことを確認するために必要なパラメーターがすでに含まれているため、これ以上パラメーターを URL に追加しないでください。

結果は、ModifiedUtc、OrderId の順に、昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

ModifiedUtc 定義: 内部時間タグ = 最新の注文データ変更の時間。

フォーム データ ポール

操作 ID:
FormController_Poll

フォーム API ポーリング エンドポイントを使用すると、アプリケーションは、最近送信されたスタンドアロン フォームを継続的にポーリングおよび処理できます。

統合:

このエンドポイントは、ポーリング トリガー統合として Microsoft Flow を使用してすぐに機能するように設計されています。 または、任意の言語を使用して独自のカスタム統合を開発することもできます。

使用法:

一般的なシナリオでは、このエンドポイントへの最初のリクエストはパラメーターを提供しません。 考えられる成功応答は 2 つあります。

  • HTTP 応答コード 200 - 最近送信されたフォーム レコードが存在します。応答本文にはフォーム データが表示されます。
  • HTTP 応答コード 202 - 最近送信されたレコードが存在しません。応答本文は空になります。

どちらの場合も、応答には 2 つの重要なヘッダーがあります。

  • Location - 次の要求の URL です。
  • Retry-After - 次の要求の推奨時間間隔 (秒単位)。 たとえば、取得するデータがある場合、Retry-After ヘッダーの値は 1 または 60 になります。 取得するデータがない場合、Retry-After ヘッダーの値は 300 になります。

注: これらはあくまで推奨値であり、アプリケーションの要件に応じて異なる頻度でポーリングすることも可能です。 最初の要求の後、後続のすべての要求では、最新の応答の Location ヘッダーで提供されている URL を使用する必要があります。 フォームが要求から欠落していないことを確認するために必要なパラメーターがすでに含まれているため、これ以上パラメーターを URL に追加しないでください。

結果は、ModifiedUtc、FormHeaderId の順に、昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

ModifiedUtc 定義: 内部時間タグ = 最新のフォーム データ変更の時間。

戻り値

Body
CustomerAPI.Models.Forms.StandaloneFormApiModel

受注状態ポール

操作 ID:
OrderController_StatusPoll

注文状態 API ポーリング エンドポイントを使用すると、アプリケーションは、注文の最近の変更を継続的にポーリングおよび処理できます。

統合:

このエンドポイントは、ポーリング トリガー統合として Microsoft Flow を使用してすぐに機能するように設計されています。 または、任意の言語を使用して独自のカスタム統合を開発することもできます。

使用法:

一般的なシナリオでは、このエンドポイントへの最初のリクエストはパラメーターを提供しません。 考えられる成功応答は 2 つあります。

  • HTTP 応答コード 200 - 最近変更された注文状態レコードが存在します。応答本文には注文状態データが表示されます
  • HTTP 応答コード 202 - 最近送信されたレコードが存在しません。応答本文は空になります。

どちらの場合も、応答には 2 つの重要なヘッダーがあります。

  • Location - 次の要求の URL です。
  • Retry-After - 次の要求の推奨時間間隔 (秒単位)。 たとえば、取得するデータがある場合、Retry-After ヘッダーの値は 1 または 60 になります。 取得するデータがない場合、Retry-After ヘッダーの値は 300 になります。

注: これらはあくまで推奨値であり、アプリケーションの要件に応じて異なる頻度でポーリングすることも可能です。 最初の要求の後、後続のすべての要求では、最新の応答の Location ヘッダーで提供されている URL を使用する必要があります。 注文状態が要求から欠落していないことを確認するために必要なものがすでに含まれているため、これ以上パラメーターを URL に追加しないでください。

結果は、ModifiedUtc、StatusId の順に、昇順で並べ替えられます。 並べ替えパラメーターは設定できません。

ModifiedUtc 定義: 内部時間タグ = 最新の注文状態データ変更の時間。

パラメーター

名前 キー 必須 型 説明
excludeFormData
 excludeFormData boolean

true の場合、FieldValues は常に空の配列になります。

戻り値

Body
CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

時間管理ポール

操作 ID:
TimekeepingController_Poll

時間管理 API ポーリング エンドポイントを使用すると、アプリケーションは、最近送信された時間管理エントリを継続的にポーリングおよび処理できます。

統合:

このエンドポイントは、ポーリング トリガー統合として Microsoft Flow を使用してすぐに機能するように設計されています。 または、任意の言語を使用して独自のカスタム統合を開発することもできます。

使用法:

一般的なシナリオでは、このエンドポイントへの最初のリクエストはパラメーターを提供しません。 考えられる成功応答は 2 つあります。

  • HTTP 応答コード 200 - 最近送信された時間管理レコードが存在します。応答本文には時間管理エントリ データが表示されます。
  • HTTP 応答コード 202 - 最近送信されたレコードが存在しません。応答本文は空になります。

どちらの場合も、応答には 2 つの重要なヘッダーがあります。

  • Location - 次の要求の URL です。
  • Retry-After - 次の要求の推奨時間間隔 (秒単位)。 たとえば、取得するデータがある場合、Retry-After ヘッダーの値は 1 または 60 になります。 取得するデータがない場合、Retry-After ヘッダーの値は 300 になります。

注: これらはあくまで推奨値であり、アプリケーションの要件に応じて異なる頻度でポーリングすることも可能です。 最初の要求の後、後続のすべての要求では、最新の応答の Location ヘッダーで提供されている URL を使用する必要があります。 時間管理エントリが要求から欠落していないことを確認するために必要なものがすでに含まれているため、これ以上パラメーターを URL に追加しないでください。

結果は、ModifiedUtc、TimekeepingStatusId の順に、その後昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

ModifiedUtc 定義: 内部時間タグ = 最新の時間管理状態変更の時間。

パラメーター

名前 キー 必須 型 説明
excludeFormData
 excludeFormData boolean

true の場合、ClockInFormData と ClockOutFormData は常に null になります。

戻り値

Body
CustomerAPI.Models.Timekeeping.TimekeepingApiModel

注文ポール

操作 ID:
OrderController_Poll

注文 API ポーリング エンドポイントを使用すると、アプリケーションは、注文の最近の変更を継続的にポーリングおよび処理できます。

統合:

このエンドポイントは、ポーリング トリガー統合として Microsoft Flow を使用してすぐに機能するように設計されています。 または、任意の言語を使用して独自のカスタム統合を開発することもできます。

使用法:

一般的なシナリオでは、このエンドポイントへの最初のリクエストはパラメーターを提供しません。 考えられる成功応答は 2 つあります。

  • HTTP 応答コード 200 - 最近変更された注文が存在します。応答本文には注文データが表示されます。
  • HTTP 応答コード 202 - 最近変更れた注文が存在しません。応答本文は空になります。

どちらの場合も、応答には 2 つの重要なヘッダーがあります。

  • Location - 次の要求の URL です。
  • Retry-After - 次の要求の推奨時間間隔 (秒単位)。 たとえば、取得するデータがある場合、Retry-After ヘッダーの値は 1 または 60 になります。 取得するデータがない場合、Retry-After ヘッダーの値は 300 になります。

注: これらはあくまで推奨値であり、アプリケーションの要件に応じて異なる頻度でポーリングすることも可能です。 最初の要求の後、後続のすべての要求では、最新の応答の Location ヘッダーで提供されている URL を使用する必要があります。 注文の変更が要求から欠落していないことを確認するために必要なパラメーターがすでに含まれているため、これ以上パラメーターを URL に追加しないでください。

結果は、ModifiedUtc、OrderId の順に、昇順で自動的に並べ替えられます。 並べ替えパラメーターは設定できません。

ModifiedUtc 定義: 内部時間タグ = 最新の注文データ変更の時間。

パラメーター

名前 キー 必須 型 説明
excludeFormData
 excludeFormData boolean

true の場合、OrderFormFields は常に空の配列になります。
excludeCustomFieldData
 excludeCustomFieldData boolean

true の場合、CustomFields は返されません。

戻り値

Body
CustomerAPI.Models.Order.OrderHeaderApiModel

定義

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

名前 パス 型 説明
Id
 Id string

CustomerAPI.Models.Client.ReadClientApiModel

名前 パス 型 説明
Id
 Id integer

クラスの ID。
ExternalId
 ExternalId string

クライアントの外部使用 ID - API 拡張プロパティ。
CreatedUtc
 CreatedUtc date-time

クライアントが作成された最初の時点
ModifiedUtc
 ModifiedUtc date-time

クライアントが更新された最後の時点
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Name
 Name string

クライアントの名前です。
Address
 Address CustomerAPI.Models.LocationApiModel
Contact
 Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

名前 パス 型 説明
FieldIndex
 FieldIndex integer

フィールド インデックス。
キャプション
 Caption string

フィールド キャプション。
DataType
 DataType integer

フィールドのデータ型。
DateTimeFormat
 DateTimeFormat integer

DateTime 形式。
Value
 Value

フィールド値。

CustomerAPI.Models.LocationApiModel

名前 パス 型 説明
LatLon
 LatLon System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1
 AddressLine1 string

この LocationApiModel の AddressLine1。
AddressLine2
 AddressLine2 string

この LocationApiModel の AddressLine2。
都市
 City string

LocationApiModel の市区町村。
RegionName
 RegionName string

LocationApiModel の地域名。
PostalCode
 PostalCode string

LocationApiModel の郵便番号。
CountryCode
 CountryCode string

ISO 3166-1 alpha-2 コード。
SubRegionName
 SubRegionName string

LocationApiModel の SubRegion。
SubRegionCode
 SubRegionCode string

LocationApiModel の SubRegion コード。
RegionCode
 RegionCode string

LocationApiModel の Region コード。

CustomerAPI.Models.Client.ContactApiModel

名前 パス 型 説明
Name
 Name string

ContactApiModel の名前。
PhoneNumber
 PhoneNumber string

ContactApiModel の PhoneNumber。
Email
 Email string

ContactApiModel の Email。

System.Nullable_1_Actsoft.Core.Geo.LatLon_

名前 パス 型 説明
経度
 Latitude double
緯度
 Longitude double

CustomerAPI.Models.ReturnIdApiModel

名前 パス 型 説明
Id
 Id integer

オブジェクト ID です。

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

カスタム リスト定義リスト アイテム API モデルを定義します。

名前 パス 型 説明
CustomListId
 CustomListId integer

カスタム リスト ID。
Name
 Name string

カスタム リスト名。
Version
 Version string

カスタム リスト バージョン。

CustomerAPI.Models.CustomLists.CustomListApiModel

カスタム リスト モデル。

名前 パス 型 説明
CustomListId
 CustomListId integer

カスタム リスト ID。
Name
 Name string

カスタム リスト名。
Version
 Version string

カスタム リスト バージョン。
Definition
 Definition CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

カスタム リスト定義 API モデルを定義します。

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

カスタム リスト定義 API モデルを定義します。

名前 パス 型 説明
Columns
 Columns array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

カスタム リスト列。
UniqueColumnIndexIndex
 UniqueColumnIndexIndex integer

一意の列インデックス。

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

カスタム リスト定義列 API モデルを定義します。

名前 パス 型 説明
Index
 Index integer

列のインデックス。
DataType
 DataType integer

列のデータ型 (テキスト: 0、数値: 1、日付: 2、時刻: 3、日時: 4、メール: 5)。
Name
 Name string

列名。

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

カスタム リスト列データ配列のコンテナ。

名前 パス 型 説明
ColumnValues
 ColumnValues array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

データを含む列の配列。

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

このモデルは、カスタム リスト列値を定義します。

名前 パス 型 説明
ColumnIndex
 ColumnIndex integer

カスタム リストの列インデックス。
Caption
 Caption string

カスタム リストの列キャプション。
Value
 Value

カスタム リストの列値。

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

カスタム イベント定義モデル。

名前 パス 型 説明
Id
 Id string
Name
 Name string
ReverseGeocode
 ReverseGeocode boolean
Parameters
 Parameters array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

名前 パス 型 説明
Name
 Name string
Type
 Type integer
Caption
 Caption string
Required
 Required boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

名前 パス 型 説明
EventId
 EventId integer

イベント ID。
EventType
 EventType integer
EventCode
 EventCode string

イベント コード。
EventTime
 EventTime date-time

ローカルとオフセットを使用した ISO 形式。
User
 User CustomerAPI.Models.UserReferenceApiModel
Vehicle
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle
 UserLinkedToVehicle boolean

有効にすると、イベントの車両にユーザーが割り当てられます。
Location
 Location CustomerAPI.Models.LocationApiModel
PrimaryGeofence
 PrimaryGeofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId
 CustomEventDefinitionId string

外部イベント定義 ID。
EventParams
 EventParams object

イベント パラメーター。

CustomerAPI.Models.UserReferenceApiModel

名前 パス 型 説明
UserId
 UserId integer

ユーザーの UserId。
FirstName
 FirstName string

ユーザーの名。
LastName
 LastName string

ユーザーの姓。
EmployeeNumber
 EmployeeNumber string

ユーザーの従業員番号。
GroupName
 GroupName string

ユーザーに割り当てられたグループの名前。

CustomerAPI.Models.ReadVehicleApiModel

名前 パス 型 説明
VehicleId
 VehicleId integer

BaseVehicleApiModel の ID。
Name
 Name string

BaseVehicleApiModel の名前。
VIN
 VIN string

BaseVehicleApiModel の車両識別番号。
DeviceName
 DeviceName string

BaseVehicleApiModel に関連付けられている GpsDeviceDto の名前。
SerialNumber
 SerialNumber string

BaseVehicleApiModel の SerialNumber。
GroupName
 GroupName string

BaseVehicleApiModel の GroupName。

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

名前 パス 型 説明
GeofenceId
 GeofenceId integer

ジオフェンスの ID。
Name
 Name string

ジオフェンスの名前です。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

名前 パス 型 説明
SubscriptionId
 SubscriptionId string

WebHookSubscriptionResultApiModel の ID。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

名前 パス 型 説明
SubscriptionId
 SubscriptionId string
Url
 Url string
状態
 Status integer

サブスクリプションの状態 - (実行中: 1、停止: 2)。

CustomerAPI.Models.Forms.StandaloneFormApiModel

名前 パス 型 説明
Id
 Id integer

この StandaloneFormApiModel に関連付けられた ID - (レガシー コメント: FormHeaderId)。
FormId
 FormId integer

この StandaloneFormApiModel によって参照されるフォームの ID。
FormName
 FormName string

この StandaloneFormApiModel によって参照されるフォームの名前。
EntryNumber
 EntryNumber string

フォーム データの入力番号です。
Reviewed
 Reviewed boolean

この StandaloneFormApiModel のレビューのステータス。
User
 User CustomerAPI.Models.UserReferenceApiModel
SubmittedTime
 SubmittedTime date-time

StandaloneFormApiModel が送信された時点。
StartTime
 StartTime date-time

StandaloneFormApiModel が開始された時点。
SubmittedLocation
 SubmittedLocation CustomerAPI.Models.LocationApiModel
FormData
 FormData array of CustomerAPI.Models.Forms.FormFieldDataApiModel

この StandaloneFormApiModel に関連付けられているフィールドのリスト。
ApiModuleId
 ApiModuleId string

この StandaloneFormApiModel に関連付けられている ApiModule の ID。
SharedUrl
 SharedUrl string

この StandaloneFormApiModel の共有 URL。
ReviewedByUser
 ReviewedByUser CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime
 ReviewedByTime date-time

フォーム レビューの時間

CustomerAPI.Models.Forms.FormFieldDataApiModel

名前 パス 型 説明
Repeatables
 Repeatables array of array
items
 Repeatables array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id
 Id string

FormFieldDataApiModel の ID。
Value
 Value

FormFieldDataApiModel の値。
DisplayValue
 DisplayValue

FormFieldDataApiModel の DisplayValue。
CapturedTime
 CapturedTime date-time

FormFieldDataApiModel がキャプチャされた時点の値。
CapturedLocation
 CapturedLocation CustomerAPI.Models.LocationApiModel
Caption
 Caption string

FormFieldDataApiModel のキャプション コンテンツ。
ApiFieldId
 ApiFieldId string

FormFieldDataApiModel の ApiField の ID。

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

名前 パス 型 説明
Id
 Id string

FormFieldDataApiModel の ID。
Value
 Value

FormFieldDataApiModel の値。
DisplayValue
 DisplayValue

FormFieldDataApiModel の DisplayValue。
CapturedTime
 CapturedTime date-time

FormFieldDataApiModel がキャプチャされた時点の値。
CapturedLocation
 CapturedLocation CustomerAPI.Models.LocationApiModel
Caption
 Caption string

FormFieldDataApiModel のキャプション コンテンツ。
ApiFieldId
 ApiFieldId string

FormFieldDataApiModel の ApiField の ID。

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

名前 パス 型 説明
GeofenceId
 GeofenceId integer

GeofenceApiModel の GeofenceId。
CreatedUtc
 CreatedUtc date-time

GeofenceApiModel の CreatedUtc。
ModifiedUtc
 ModifiedUtc date-time

GeofenceApiModel の ModifiedUtc。
GroupNames
 GroupNames array of string

GeofenceApiModel の GroupPaths。
Name
 Name string

GeofenceApiModelBase の名前。
Type
 Type string

GeofenceApiModel のタイプ。
Shape
 Shape integer

Shape: 円の場合は 0、多角形の場合は 1。
Address
 Address CustomerAPI.Models.LocationApiModel
Radius
 Radius double

GeofenceApiModel の半径。
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel の UseGeofenceAddress。

Actsoft.Core.Geo.LatLon

名前 パス 型 説明
経度
 Latitude double
緯度
 Longitude double

CustomerAPI.Models.Geofence.GeofenceApiModel

名前 パス 型 説明
GeofenceId
 GeofenceId integer

GeofenceApiModel の GeofenceId。
CreatedUtc
 CreatedUtc date-time

GeofenceApiModel の CreatedUtc。
ModifiedUtc
 ModifiedUtc date-time

GeofenceApiModel の ModifiedUtc。
GroupNames
 GroupNames array of string

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

多角形ポイント。 Shape が 1 の場合に入力する必要があります。
Name
 Name string

GeofenceApiModelBase の名前。
Type
 Type string

GeofenceApiModel のタイプ。
Shape
 Shape integer

Shape: 円の場合は 0、多角形の場合は 1。
Address
 Address CustomerAPI.Models.LocationApiModel
Radius
 Radius double

GeofenceApiModel の半径。
UseGeofenceAddress
 UseGeofenceAddress boolean

GeofenceApiModel の UseGeofenceAddress。

CustomerAPI.Models.Order.OrderListItemApiModel

名前 パス 型 説明
OrderId
 OrderId integer

OrderBaseApiModel の ID。
ExternalOrderId
 ExternalOrderId string

クライアントの外部使用 OrderId - API 拡張プロパティ。
DueDate
 DueDate date-time

この OrderBaseApiModel が完了する予定の時点 (v1.3 では廃止)。
StartTime
 StartTime date-time

この OrderBaseApiModel が開始する必要がある時点 (v1.3 で導入)。
EndTime
 EndTime date-time

この OrderBaseApiModel が完了する予定の時点 (v1.3 で導入)。
ServiceType
 ServiceType string

この OrderBaseApiModel に関連付けられた ServiceType。
CreatedUTCDate
 CreatedUTCDate date-time

この OrderBaseApiModel が作成された時点。
OrderNumber
 OrderNumber string

この OrderBaseApiModel に関連付けられた注文番号。
IsClosed
 IsClosed boolean

OrderBaseApiModel が閉じたかどうかを示すステータス。
状態
 Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
 ExternalClientId string

クライアントの外部使用 ID - API 拡張プロパティ。
ClientId
 ClientId integer

クライアントの内部使用 ID - API 拡張プロパティ。
Client
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

この OrderBaseApiModel に関連付けられている ApiService の ID。
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

カスタム フィールド モジュール バージョン。
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
繰り返し
 Recurrence boolean

CustomerAPI.Models.Order.OrderStatusApiModel

名前 パス 型 説明
StatusIndex
 StatusIndex integer

OrderStatusApiModel のインデックス。
StatusType
 StatusType integer

注文状態: 0 は新規注文、1 は発送済み、2 は進行中、3 は完了、4 はキャンセル済み。
StatusLabel
 StatusLabel string

OrderStatusApiModel のラベル コンテンツ。
StatusId
 StatusId integer

OrderStatusApiModel の ID。
StatusStartDateTime
 StatusStartDateTime date-time

OrderStatusApiModel の開始時点。
User
 User CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

名前 パス 型 説明
GroupNames
 GroupNames array of string

クライアントグループの階層名。
件名
 Name string

クライアントの名前です。
番地
 Address CustomerAPI.Models.LocationApiModel
お問い合わせ先
 Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

名前 パス 型 説明
StatusHistory
 StatusHistory array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

この OrderApiModel に関連付けられている OrderStatusListItems のリスト。
OrderFormFields
 OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
OrderId
 OrderId integer

OrderBaseApiModel の ID。
ExternalOrderId
 ExternalOrderId string

クライアントの外部使用 OrderId - API 拡張プロパティ。
DueDate
 DueDate date-time

この OrderBaseApiModel が完了する予定の時点 (v1.3 では廃止)。
StartTime
 StartTime date-time

この OrderBaseApiModel が開始する必要がある時点 (v1.3 で導入)。
EndTime
 EndTime date-time

この OrderBaseApiModel が完了する予定の時点 (v1.3 で導入)。
ServiceType
 ServiceType string

この OrderBaseApiModel に関連付けられた ServiceType。
CreatedUTCDate
 CreatedUTCDate date-time

この OrderBaseApiModel が作成された時点。
OrderNumber
 OrderNumber string

この OrderBaseApiModel に関連付けられた注文番号。
IsClosed
 IsClosed boolean

OrderBaseApiModel が閉じたかどうかを示すステータス。
状態
 Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
 ExternalClientId string

クライアントの外部使用 ID - API 拡張プロパティ。
ClientId
 ClientId integer

クライアントの内部使用 ID - API 拡張プロパティ。
Client
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

この OrderBaseApiModel に関連付けられている ApiService の ID。
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

カスタム フィールド モジュール バージョン。
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
繰り返し
 Recurrence boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

名前 パス 型 説明
StatusStartDateTime
 StatusStartDateTime date-time

この OrderStatusHistoryListItemApiModel ステータスが開始された時点。
StatusEndDateTime
 StatusEndDateTime date-time

この OrderStatusHistoryListItemApiModel ステータスが終了された時点。
StatusId
 StatusId integer

この OrderStatusHistoryListItemApiModel に関連付けられた ID。
StatusIndex
 StatusIndex integer

この OrderStatusHistoryListItemApiModel に関連付けられたインデックス。
StatusLabel
 StatusLabel string

この OrderStatusHistoryListItemApiModel に関連付けられたラベル コンテンツ。
StatusType
 StatusType integer

注文状態: 0 は新規注文、1 は発送済み、2 は進行中、3 は完了、4 はキャンセル済み。
ExternalOrderId
 ExternalOrderId string

クライアントの外部使用 OrderId - API 拡張プロパティ。
OrderId
 OrderId integer

この OrderStatusHistoryListItemApiModel に関連付けられた OrderId。
User
 User CustomerAPI.Models.UserReferenceApiModel
StartAddress
 StartAddress CustomerAPI.Models.LocationApiModel
EndAddress
 EndAddress CustomerAPI.Models.LocationApiModel
ApiServiceId
 ApiServiceId string

この OrderStatusHistoryListItemApiModel に関連付けられている ApiService の ID。
FieldValues
 FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

名前 パス 型 説明
OrderFormFields
 OrderFormFields array of CustomerAPI.Models.Forms.FormFieldDataApiModel
OrderId
 OrderId integer

OrderBaseApiModel の ID。
ExternalOrderId
 ExternalOrderId string

クライアントの外部使用 OrderId - API 拡張プロパティ。
DueDate
 DueDate date-time

この OrderBaseApiModel が完了する予定の時点 (v1.3 では廃止)。
StartTime
 StartTime date-time

この OrderBaseApiModel が開始する必要がある時点 (v1.3 で導入)。
EndTime
 EndTime date-time

この OrderBaseApiModel が完了する予定の時点 (v1.3 で導入)。
ServiceType
 ServiceType string

この OrderBaseApiModel に関連付けられた ServiceType。
CreatedUTCDate
 CreatedUTCDate date-time

この OrderBaseApiModel が作成された時点。
OrderNumber
 OrderNumber string

この OrderBaseApiModel に関連付けられた注文番号。
IsClosed
 IsClosed boolean

OrderBaseApiModel が閉じたかどうかを示すステータス。
状態
 Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
 ExternalClientId string

クライアントの外部使用 ID - API 拡張プロパティ。
ClientId
 ClientId integer

クライアントの内部使用 ID - API 拡張プロパティ。
Client
 Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
 ApiServiceId string

この OrderBaseApiModel に関連付けられている ApiService の ID。
CustomFieldsModuleVersion
 CustomFieldsModuleVersion integer

カスタム フィールド モジュール バージョン。
CustomFieldsData
 CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
繰り返し
 Recurrence boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

名前 パス 型 説明
Id
 Id integer

時間管理エントリの ID (レガシー コメント: RootSubmittedStatusId)。
User
 User CustomerAPI.Models.UserReferenceApiModel
ClockInTime
 ClockInTime date-time

ユーザーがシステムに勤務開始を記録した時点。
ClockInLocation
 ClockInLocation CustomerAPI.Models.LocationApiModel
ClockOutTime
 ClockOutTime date-time

ユーザーがシステムに勤務終了を記録した時点。
ClockOutLocation
 ClockOutLocation CustomerAPI.Models.LocationApiModel
TotalHours
 TotalHours double

この時間管理エントリの合計時間数。
TotalBreakHours
 TotalBreakHours double

この時間管理エントリの合計休憩 (勤務時間外) 時間数。
NetHours
 NetHours double

この時間管理エントリの合計請求可能時間数。
Approved
 Approved boolean

この時間管理エントリに対するスーパーバイザー承認のステータス。
Breaks
 Breaks array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData
 ClockInFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData
 ClockOutFormData CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion
 ModuleVersion System.Version
CompanyModuleId
 CompanyModuleId integer

この時間管理エントリの送信に使用される会社モジュールの ID。

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

名前 パス 型 説明
Id
 Id integer

SubmittedStatusId.
StartTime
 StartTime date-time

開始時刻。
StartLocation
 StartLocation CustomerAPI.Models.LocationApiModel
EndTime
 EndTime date-time

終了時刻。
EndLocation
 EndLocation CustomerAPI.Models.LocationApiModel
DurationHours
 DurationHours double

期間 (時間)。 EndTime が null の場合、null にできます。
StatusType
 StatusType integer

状態の種類: 休憩は 1、昼食は 2。
StartLabel
 StartLabel string

開始ラベル。
EndLabel
 EndLabel string

終了ラベル。
Caption
 Caption string

キャプション。

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

名前 パス 型 説明
CompanyModuleId
 CompanyModuleId integer
ModuleVersion
 ModuleVersion System.Version
FieldValues
 FieldValues array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

名前 パス 型 説明
_Major
 _Major integer
_Minor
 _Minor integer
_Build
 _Build integer
_Revision
 _Revision integer

CustomerAPI.Models.Tracking.TripApiModel

名前 パス 型 説明
User
 User CustomerAPI.Models.UserReferenceApiModel
Vehicle
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
StartTime
 StartTime date-time

この TripApiModel ステータスが開始された時点。
EndTime
 EndTime date-time

この TripApiModel ステータスが終了された時点。
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

この TripApiModel に関連付けられている停止時間の長さ (時間単位)。
TotalIdleTime
 TotalIdleTime double

この TripApiModel に関連付けられているアイドル時間の長さ (時間単位)。
TotalDuration
 TotalDuration double

この TripApiModel に関連付けられている時間全体の長さ (時間単位)。
Distance
 Distance double

この TripApiModel に関連付けられている移動距離 (ローカライズされた単位)。

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

名前 パス 型 説明
Records
 Records array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken
 ContinuationToken string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

名前 パス 型 説明
User
 User CustomerAPI.Models.UserReferenceApiModel
Vehicle
 Vehicle CustomerAPI.Models.ReadVehicleApiModel
TimeTag
 TimeTag date-time

この GpsDataRecordApiModel に関連付けられた TimeTag。
Location
 Location System.Nullable_1_Actsoft.Core.Geo.LatLon_
Geofence
 Geofence CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Speed
 Speed double

この GpsDataRecordApiModel に関連付けられた移動速度。
Heading
 Heading double

この GpsDataRecordApiModel に関連付けられたコンパスの方向 (度)。
状態
 Status integer

OrderBaseApiModel に関連付けられた ApiMovementStatus - (停止: 1、アイドル: 2、移動: 3、非追跡: 4): OrderBaseApiModel。
StatusTime
 StatusTime string

この GpsDataRecordApiModel ステータスが設定された時点。
Distance
 Distance double

この TripApiModel に関連付けられている移動距離 (ローカライズされた単位)。
IgnitionOn
 IgnitionOn boolean

この GpsDataRecordApiModel に関連付けられている車両イグニッションのステータス。
LocationProvider
 LocationProvider integer

この GpsDataRecordApiModel に関連付けられた API ロケーション プロバイダー - (GPS: 1、ネットワーク: 2)。

CustomerAPI.Models.User.ReadUserApiModel

名前 パス 型 説明
UserName
 UserName string

ユーザーの UserName。
UserId
 UserId integer

ユーザーの ID 値。
GroupName
 GroupName string

ユーザーのグループ名。
FirstName
 FirstName string

ユーザーの名。
LastName
 LastName string

ユーザーの姓。
EmployeeNumber
 EmployeeNumber string

ユーザーの従業員番号。
Email
 Email string

ユーザーのメール アドレスです。
Phone
 Phone string

ユーザーの電話番号です。
RoleId
 RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、パワー ユーザー: 5)。
IsActive
 IsActive boolean

ユーザーのアクティブ状態。
EPTTEnabled
 EPTTEnabled boolean

ユーザー向けの拡張プッシュツートーク機能のステータス: ブール値。
EPTTNumber
 EPTTNumber string

ユーザー向けの拡張プッシュツートーク機能の電話番号: 文字列。
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT システムに対してユーザーを認証するために使用される電話番号 - Kodiak によって提供されます。
EPTTToken
 EPTTToken string

Kodiak EPTT システムに対してユーザーを認証するために使用される API トークン - Kodiak によって提供されます。
GPSEnabled
 GPSEnabled boolean

ユーザーの GPS 機能のステータス。
MobileOnly
 MobileOnly boolean

CAB のデスクトップ Web アプリケーション アクセスのステータス - (WebApp アクセスなし: True、フル アプリ アクセス: False)。
LicenseType
 LicenseType integer

ユーザーに割り当てられたライセンスのタイプ: - 未定義の場合は 0、通常の場合は 1、WebOnly の場合は 2、従業員の場合は 3。

CustomerAPI.Models.User.ReadUserListItemApiModel

名前 パス 型 説明
UserId
 UserId integer

ユーザーの ID 値。
FirstName
 FirstName string

ユーザーの名。
LastName
 LastName string

ユーザーの姓。
EmployeeNumber
 EmployeeNumber string

ユーザーの従業員番号。
Email
 Email string

ユーザーのメール アドレスです。
Phone
 Phone string

ユーザーの電話番号です。
RoleId
 RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、パワー ユーザー: 5)。
IsActive
 IsActive boolean

ユーザーのアクティブ状態。
EPTTEnabled
 EPTTEnabled boolean

ユーザー向けの拡張プッシュツートーク機能のステータス: ブール値。
EPTTNumber
 EPTTNumber string

ユーザー向けの拡張プッシュツートーク機能の電話番号: 文字列。
EPTTWebMDN
 EPTTWebMDN string

Kodiak EPTT システムに対してユーザーを認証するために使用される電話番号 - Kodiak によって提供されます。
EPTTToken
 EPTTToken string

Kodiak EPTT システムに対してユーザーを認証するために使用される API トークン - Kodiak によって提供されます。
GPSEnabled
 GPSEnabled boolean

ユーザーの GPS 機能のステータス。
MobileOnly
 MobileOnly boolean

CAB のデスクトップ Web アプリケーション アクセスのステータス - (WebApp アクセスなし: True、フル アプリ アクセス: False)。
LicenseType
 LicenseType integer

ユーザーに割り当てられたライセンスのタイプ: - 未定義の場合は 0、通常の場合は 1、WebOnly の場合は 2、従業員の場合は 3。

CustomerAPI.Models.Vehicles.VehicleReadApi

車両のデータ モデル。

名前 パス 型 説明
InternalId
 InternalId integer
Number
 Number string
Name
 Name string
Type
 Type string
Tag
 Tag string
UserEmployeeNumber
 UserEmployeeNumber string
GroupName
 GroupName string
TimeZone
 TimeZone string
Make
 Make string
Year
 Year integer
Model
 Model string
カラー
 Color string
VIN
 VIN string
IsActive
 IsActive boolean
DeviceType
 DeviceType integer
DeviceSerialNumber
 DeviceSerialNumber string

整数

これは基本的なデータ型 '整数' です。

オブジェクト

’オブジェクト’ という種類です。