次の方法で共有


TeamWherx

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

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Actsoft のサポート
URL https://www.actsoft.com/self-help-wizards
Email support@actsoft.com
コネクタ メタデータ
Publisher Actsoft
Website https://actsoft.com
プライバシー ポリシー https://www.actsoft.com/privacy
カテゴリ 生産性

コネクタの説明:

TeamWherxを使用すると、デジタルフォーム情報、従業員の時間管理情報を作成してキャプチャし、ディスパッチシステムを使用して作業指示書を管理することができます。

詳細な説明

TeamWherx コネクタを使用すると、ユーザーは複数のプラットフォーム間で接続して情報を交換できます。 データをアニメーション化してプロセス フローを作成し、他の社内アプリケーションを推進し、強力な分析を通知することができます。 up-to-the-moment アクション可能なデータにアクセスして、毎日、毎週、または毎月のプロセスを自動化し、合理化します。

## の前提条件

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

  • TeamWherx アカウント

  • TeamWherx API キー

  • Microsoft Power Apps または Power Automate プラン

## 資格情報を取得する方法

API 開発者ポータル

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

  1. アプリケーション内から、 管理>Settings>APIセットアップに移動します。

  2. [ 資格情報の作成] を選択します

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

  4. [メール アドレス] フィールドに メールアドレス を入力します。

  5. [保存] と [招待メール] を選択します。 次に、メールでパスワードの作成手順を確認します。

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

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

  8. 開発者ポータルに進むには、アプリケーション内から管理>Settings>開発者ポータルに移動します。

  9. 開発者ポータルで [ 製品] を選択し、[ CustomerAPI] を選択します。

  10. [ サブスクライブ] を選択します。

API キー

登録済みの API ユーザーになったので、キーと呼ばれる英数字シーケンスが生成されました。 API でデータを操作するには、このキーが必要です。

API キーを見つけるには:

  1. [開発者ポータル] メニューから [ 製品 ] を選択します。 ライセンスで利用可能な API 製品が表示されます。

  2. [You have X subscription(s) to this product]\(この製品の X サブスクリプションがある\) で、 Customer 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スプレッドシート] を選択し、アクションの [行挿入] を選択します。

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

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

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

  8. 各列フィールドに複数のプロパティを入力できます。[イベント] 列で、[StatusLabel] を選択し、ダッシュを挿入して、[StatusStartDate] を選択します。 つまり、注文状態の更新ごとに、状態ラベルと状態開始日が新しい行の [イベント] 列に書き込まれます。

  9. [ 新しいステップ] を選択します。 アサイドノートとして、いつでも矢印コネクタをポイントしてクリックして新しいステップを挿入できます

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

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

  1. この例では、[名前] フィールドに EmployeeNumber を選択して、注文ステータスを更新した従業員を識別します。

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

  3. [保存] を選択します。

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

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

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

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

## 一般的なエラーと解決方法

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

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

## に関する FAQ

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

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

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

名前 タイプ Description 必須
API キー securestring この API の API キー 正しい

調整制限

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

アクション

CustomListID で一覧表示されるカスタム リスト フィールドを取得する

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

CustomListID によるカスタム リスト データの取得

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

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

エラー:

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

GPS データ Web フックの登録を解除する

GPS データ Web フック サブスクリプションを ID で削除します。

GPS データ Web フックをサブスクライブする

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

GPS データ エントリを取得する

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

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

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

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

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

ID でカスタム イベント定義を取得する

ID で 1 つのカスタム イベント定義を取得します。

ID で車両を取得する

ID で 1 台の車両を取得します。

イベント Web フック サブスクリプションの一覧を取得する

イベント Web フック サブスクリプションの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は SubscriptionId で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

イベント Web フックの登録を解除する

イベント Web フック サブスクリプションを ID で削除します。

イベント Web フックをサブスクライブする

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

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

サブスクリプションの状態を状態 = 1 ("実行中") に変更します。

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

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

イベントの一覧を取得する

特定の期間のイベントの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。

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

イベントを送信する

イベントを送信します。

カスタム イベント定義の一覧を取得する

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

カスタム イベント定義を作成または更新する

カスタム イベント定義を作成または更新します。

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

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

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

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

カスタム リスト レコードを削除する

customListId と id を使用して、カスタム リスト内の既存のレコードを削除します。

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

エラー:

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

カスタム リストから 1 つのレコードを取得する

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

エラー:

404 - 指定された customListId と一意の列値のカスタム リスト レコードがありません

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

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

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

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

クライアントの作成

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

クライアントを削除する

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

クライアントを取得する

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

クライアントを更新する

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

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

Web フック サブスクリプションの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は SubscriptionId で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

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

サブスクリプションの状態を状態 = 1 ("実行中") に変更します。

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

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

ジオフェンスを作成する

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

ジオフェンスを削除する

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

ジオフェンスを取得する

ジオフェンスを ID で取得します。

タイムキーピング エントリの一覧を取得する

日付範囲に基づいて、タイムキーピング エントリの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は、ClockInTime、TimekeepingStatusId、および昇順で自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

タイムキーピング エントリを取得する

ID でエントリを取得します。

バイナリ ファイルをアップロードする

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

フォームの一覧を取得する

次に示す要求パラメーターから、いずれかのフィルターを使用してフォームの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は SubmittedTime で降順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

フォームを作成する

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

フォームを取得する

フォームを ID で取得します。

マイナー バージョンを取得する

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

ユーザーのアクティブ化

既存のユーザーをその ID でアクティブ化します。

ユーザーの一覧を取得する

ユーザーの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は UserId で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

ユーザーの一部を更新する

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

ユーザーの作成

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

ユーザーを取得する

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

ユーザーを更新する

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

ユーザーを非アクティブ化する

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

旅行の一覧を取得する

特定の期間の乗車の一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は StartUtcTIme で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

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

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

注文の一覧を取得する

以下に示す要求パラメーターから、フィルターを使用して注文の一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は、Client.Name 順、および昇順で自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

注文の状態を更新する

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

注文を作成する

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

注文を取得する

ID で既存の注文を取得します。

注文を更新する

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

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

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

車両をアクティブ化する

ID で車両をアクティブ化します。

車両を作成する

車両を作成します。

車両を削除する

ID で車両を削除します。

車両を更新する

ID で車両を更新します。

車両を部分的に更新する

車両を ID で部分的に更新します。

車両を非アクティブ化する

ID で車両を非アクティブ化します。

車両リストを取得する

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

CustomListID で一覧表示されるカスタム リスト フィールドを取得する

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

パラメーター

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

カスタム リスト ID。

戻り値

カスタム リスト モデル。

CustomListID によるカスタム リスト データの取得

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

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

エラー:

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

パラメーター

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

カスタム リスト ID。

pageNumber
pageNumber integer

スタート ページ番号。

pageSize
pageSize integer

ページサイズ。

戻り値

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

GPS データ Web フックの登録を解除する

GPS データ Web フック サブスクリプションを ID で削除します。

パラメーター

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

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

GPS データ Web フックをサブスクライブする

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

パラメーター

名前 キー 必須 説明
ウェブアドレス
Url string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。

SecurityToken
SecurityToken string

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

戻り値

GPS データ エントリを取得する

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

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

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

パラメーター

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

日付範囲の開始。 推奨事項: 小さな日付範囲ではなく、大きな日付範囲 (> = 4 時間) を使用してください。

toDate
toDate date-time

日付範囲の終了。 推奨事項: 小さな日付範囲ではなく、大きな日付範囲 (> = 4 時間) を使用してください。

従業員番号
employeeNumber string

従業員番号。

vin
vin string

車両の VIN 番号。

useMetric
useMetric boolean

メトリック システムを使用するかどうか。

トークン
token string

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

戻り値

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

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

パラメーター

名前 キー 必須 説明
ID (アイディー)
Id string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。

デバイスID
DeviceId string

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

デバイスタイプ
DeviceType integer

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

タイムスタンプ
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 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

アクティビティの状態: Staying(1)、Modving(2)。

IsNetworkConnected
IsNetworkConnected boolean

現時点でネットワークに接続されているデバイスです。

Rssi
Rssi integer

信号強度インジケーターを受信しました。

DOdoMl
DOdoMl double

GpsDeviceDto Odometer (マイル)。

VOdoMl
VOdoMl double

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

戻り値

response
object

ID でカスタム イベント定義を取得する

ID で 1 つのカスタム イベント定義を取得します。

パラメーター

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

イベント定義 ID。

戻り値

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

ID で車両を取得する

ID で 1 台の車両を取得します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

車両データ モデル。

イベント Web フック サブスクリプションの一覧を取得する

イベント Web フック サブスクリプションの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は SubscriptionId で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

戻り値

イベント Web フックの登録を解除する

イベント Web フック サブスクリプションを ID で削除します。

パラメーター

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

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

イベント Web フックをサブスクライブする

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

パラメーター

名前 キー 必須 説明
ウェブアドレス
Url string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。

SecurityToken
SecurityToken string

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

戻り値

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

サブスクリプションの状態を状態 = 1 ("実行中") に変更します。

パラメーター

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

サブスクリプション ID。

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

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

パラメーター

名前 キー 必須 説明
ID (アイディー)
Id string

WebHookSubscriptionParamsApiModel のアドレスを含む URL。

イベントの種類
EventType integer
EventCode
EventCode string
EventTime
EventTime date-time

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

デバイスID
DeviceId string

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

デバイスタイプ
DeviceType integer

GpsDeviceDto の種類: ハンドセット (0)、CalAmp (1)、Geotab (2)、Xirgo (3)。

UserId
UserId integer

ユーザー ID。

VehicleId
VehicleId integer

車両 ID。

UserLinkedToVehicle
UserLinkedToVehicle boolean

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

Lat
Lat double

緯度。

経度
Lon double

経度。

CustomEventDefinitionId
CustomEventDefinitionId string
EventParams
EventParams object

イベント パラメーター。

戻り値

response
object

イベントの一覧を取得する

特定の期間のイベントの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。

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

パラメーター

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

日付範囲の開始。

toDate
toDate True date-time

日付範囲の終了。

従業員番号
employeeNumber string

従業員番号。

vehicleNumber
vehicleNumber string

車両番号。

pageNumber
pageNumber integer

スタート ページ番号。

pageSize
pageSize integer

ページサイズ。

eventType
eventType integer

イベントの種類でフィルター処理します。

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

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

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

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

従業員番号も車両番号も指定しません。

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

戻り値

イベントを送信する

イベントを送信します。

パラメーター

名前 キー 必須 説明
EventDefinitionId
EventDefinitionId string

イベント定義 ID。

従業員番号
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 string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

Time
Time date-time
パラメーター
Parameters object

イベント パラメーター。

カスタム イベント定義の一覧を取得する

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

戻り値

カスタム イベント定義を作成または更新する

カスタム イベント定義を作成または更新します。

パラメーター

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

イベント定義 ID。

名前
Name string
ReverseGeocode
ReverseGeocode boolean
名前
Name string
タイプ
Type integer
キャプション
Caption string
必須
Required boolean

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

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

パラメーター

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

イベント定義 ID。

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

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

パラメーター

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

カスタム リスト ID。

id
id True string

一意の値。

ColumnIndex
ColumnIndex integer

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

キャプション
Caption string

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

価値
Value

カスタム リスト列の値。

カスタム リスト レコードを削除する

customListId と id を使用して、カスタム リスト内の既存のレコードを削除します。

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

エラー:

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

パラメーター

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

カスタム リスト ID。

id
id True string

一意の値。

カスタム リストから 1 つのレコードを取得する

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

エラー:

404 - 指定された customListId と一意の列値のカスタム リスト レコードがありません

パラメーター

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

カスタム リスト ID。

id
id True string

一意の値。

戻り値

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

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

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

戻り値

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

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

パラメーター

名前 キー 必須 説明
pageNumber
pageNumber integer

スタート ページ番号。

pageSize
pageSize integer

ページサイズ。

戻り値

クライアントの作成

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

パラメーター

名前 キー 必須 説明
ExternalId
ExternalId string

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

FieldIndex
FieldIndex integer

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

価値
Value

フィールド値。

名前
Name string

クライアントの名前。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

名前
Name string

ContactApiModel の名前。

電話番号
PhoneNumber string

ContactApiModel の PhoneNumber。

Email
Email string

ContactApiModel の電子メール。

ジオコード
geocode boolean

住所はジオコーディングする必要があります。

戻り値

クライアントを削除する

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

パラメーター

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

クライアント ID。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

クライアントを取得する

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

パラメーター

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

クライアント ID。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

クライアントを更新する

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

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

ExternalId
ExternalId string

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

FieldIndex
FieldIndex integer

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

価値
Value

フィールド値。

名前
Name string

クライアントの名前。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

名前
Name string

ContactApiModel の名前。

電話番号
PhoneNumber string

ContactApiModel の PhoneNumber。

Email
Email string

ContactApiModel の電子メール。

ジオコード
geocode boolean

住所はジオコーディングする必要があります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

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

Web フック サブスクリプションの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は SubscriptionId で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

戻り値

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

サブスクリプションの状態を状態 = 1 ("実行中") に変更します。

パラメーター

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

サブスクリプション ID。

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

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

パラメーター

名前 キー 必須 説明
pageNumber
pageNumber integer

スタート ページ番号。 既定値は 1 です。

pageSize
pageSize integer

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

useMetric
useMetric boolean

メトリック システムを使用するかどうか。

戻り値

ジオフェンスを作成する

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

パラメーター

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

GeofenceCreateApiModel の GroupPaths。

緯度
Latitude double
緯度
Longitude double
名前
Name string

GeofenceApiModelBase の名前。

タイプ
Type string

GeofenceApiModel の型。

Shape
Shape integer

図形: 円の場合は 0、多角形の場合は 1 です。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

半径
Radius double

GeofenceApiModel の半径。

UseGeofenceAddress
UseGeofenceAddress boolean

GeofenceApiModel の UseGeofenceAddress。

useMetric
useMetric boolean

メトリック システムを使用するかどうか。

ジオコード
geocode boolean

住所はジオコーディングする必要があります。

戻り値

ジオフェンスを削除する

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

パラメーター

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

ジオフェンス ID。

ジオフェンスを取得する

ジオフェンスを ID で取得します。

パラメーター

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

ジオフェンス ID。

useMetric
useMetric boolean

メトリック システムを使用するかどうか。

戻り値

タイムキーピング エントリの一覧を取得する

日付範囲に基づいて、タイムキーピング エントリの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は、ClockInTime、TimekeepingStatusId、および昇順で自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

パラメーター

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

開始日。

toDate
toDate True date-time

終了日。

従業員番号
employeeNumber string

従業員番号。

承認
approved boolean

承認済みエントリのみをフィルター処理します。

closedOnly
closedOnly boolean

閉じたエントリのみをフィルター処理します。

excludeFormData
excludeFormData boolean

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

pageNumber
pageNumber integer

スタート ページ番号 (既定値は 1)。

pageSize
pageSize integer

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

戻り値

タイムキーピング エントリを取得する

ID でエントリを取得します。

パラメーター

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

レコードの ID。

戻り値

バイナリ ファイルをアップロードする

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

戻り値

フォームの一覧を取得する

次に示す要求パラメーターから、いずれかのフィルターを使用してフォームの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は SubmittedTime で降順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

パラメーター

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

送信されたフォームの開始日。

submittedEndDate
submittedEndDate True date-time

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

apiModuleId
apiModuleId string

フォーム モジュール ID。

従業員番号
employeeNumber string

従業員番号。

reviewed
reviewed boolean

レビューされたフォームのみを取得します。 既定値は、すべて null です。

pageNumber
pageNumber integer

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

pageSize
pageSize integer

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

戻り値

フォームを作成する

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

パラメーター

名前 キー 必須 説明
ApiModuleId
ApiModuleId string

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

見直し
Reviewed boolean

この CreateStandaloneFormApiModel のレビューの状態。

UserId
UserId integer

ユーザーの UserId。

従業員番号
EmployeeNumber string

ユーザーの従業員番号。

SubmittedTime
SubmittedTime True date-time

CreateStandaloneFormApiModel が送信された時点。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

ApiFieldId
ApiFieldId True string

API フィールド ID。

価値
Value True

FormFieldDataApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Sign" フィールド値の形式 (バイナリ リファレンス): { "BinaryId": アップロードされたイメージの文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

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

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

ApiFieldId
ApiFieldId True string

API フィールド ID。

価値
Value True

FormFieldDataApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Sign" フィールド値の形式 (バイナリ リファレンス): { "BinaryId": アップロードされたイメージの文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

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

戻り値

フォームを取得する

フォームを ID で取得します。

パラメーター

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

フォーム ID。

戻り値

マイナー バージョンを取得する

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

ユーザーのアクティブ化

既存のユーザーをその ID でアクティブ化します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

ユーザーの一覧を取得する

ユーザーの一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は UserId で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

パラメーター

名前 キー 必須 説明
pageNumber
pageNumber integer

スタート ページ番号。 既定値は 1 です。

pageSize
pageSize integer

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

戻り値

ユーザーの一部を更新する

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

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

object
use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

ユーザーの作成

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

パラメーター

名前 キー 必須 説明
UserName
UserName string

ユーザーの UserName。

パスワード
Password password

ユーザーのパスワード。

GroupName
GroupName string

ユーザーのグループの名前。

ファーストネーム
FirstName string

ユーザーの名。

LastName
LastName string

ユーザーの姓。

従業員番号
EmployeeNumber string

ユーザーの従業員番号。

Email
Email string

ユーザーのメール アドレス。

電話
Phone string

ユーザーの電話番号。

RoleId
RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、Power User: 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 です。

戻り値

ユーザーを取得する

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

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

ユーザーを更新する

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

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

UserName
UserName string

ユーザーの UserName。

パスワード
Password password

ユーザーのパスワード。

GroupName
GroupName string

ユーザーのグループの名前。

ファーストネーム
FirstName string

ユーザーの名。

LastName
LastName string

ユーザーの姓。

従業員番号
EmployeeNumber string

ユーザーの従業員番号。

Email
Email string

ユーザーのメール アドレス。

電話
Phone string

ユーザーの電話番号。

RoleId
RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、Power User: 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

外部 ID を使用するかどうか。

戻り値

ユーザーを非アクティブ化する

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

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

旅行の一覧を取得する

特定の期間の乗車の一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は StartUtcTIme で昇順に自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

パラメーター

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

日付範囲の開始。 推奨事項: 小さな日付範囲ではなく、大きな日付範囲 (> = 4 時間) を使用してください。

toDate
toDate True date-time

日付範囲の終了。 推奨事項: 小さな日付範囲ではなく、大きな日付範囲 (> = 4 時間) を使用してください。

従業員番号
employeeNumber string

従業員番号。

vin
vin string

車両の VIN 番号。

pageNumber
pageNumber integer

スタート ページ番号。 既定値は 1 です。

pageSize
pageSize integer

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

useMetric
useMetric boolean

メトリック システムを使用するかどうか。

戻り値

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

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

パラメーター

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

ジオフェンス ID。

GroupNames
GroupNames array of string

GeofenceUpdateApiModel の GroupPaths。

緯度
Latitude double
緯度
Longitude double
名前
Name string

GeofenceApiModelBase の名前。

タイプ
Type string

GeofenceApiModel の型。

Shape
Shape integer

図形: 円の場合は 0、多角形の場合は 1 です。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

半径
Radius double

GeofenceApiModel の半径。

UseGeofenceAddress
UseGeofenceAddress boolean

GeofenceApiModel の UseGeofenceAddress。

useMetric
useMetric boolean

メトリック システムを使用するかどうか。

ジオコード
geocode boolean

住所はジオコーディングする必要があります。

戻り値

注文の一覧を取得する

以下に示す要求パラメーターから、フィルターを使用して注文の一覧を取得します。 返されるページ数と 1 ページあたりの要素数を指定できます。 結果は、Client.Name 順、および昇順で自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

パラメーター

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

期限の開始日でフィルター処理します。

dueDateTo
dueDateTo True date-time

期限終了日でフィルター処理します。

従業員番号
employeeNumber string

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

pageNumber
pageNumber integer

スタート ページ番号 (既定値は 1)。

pageSize
pageSize integer

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

戻り値

注文の状態を更新する

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

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

従業員番号
EmployeeNumber True string

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

StatusLabel
StatusLabel True string

この NewOrderStatusApiModel に関連付けられている StatusLabel のコンテンツにラベルを付けます。

StatusStartDateTime
StatusStartDateTime True date-time

この NewOrderStatusApiModel 状態が開始された時点。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

注文を作成する

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

パラメーター

名前 キー 必須 説明
作成日時
CreatedDateTime date-time

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

ExternalClientId
ExternalClientId True string

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

ServiceType
ServiceType True string

この CreateUpdateOrderApiModel に関連付けられているサービスの種類。

ExternalOrderId
ExternalOrderId string

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

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
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" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

従業員番号
EmployeeNumber True string

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

StatusLabel
StatusLabel True string

この NewOrderStatusApiModel に関連付けられている StatusLabel のコンテンツにラベルを付けます。

StatusStartDateTime
StatusStartDateTime True date-time

この NewOrderStatusApiModel 状態が開始された時点。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

FieldIndex
FieldIndex integer

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

価値
Value

フィールド値。

ジオコード
geocode boolean

住所はジオコーディングする必要があります。

戻り値

注文を取得する

ID で既存の注文を取得します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

include-status-history
include-status-history string

true の場合、応答には、この注文のすべての状態履歴とフォーム データが含まれます。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

注文を更新する

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

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

ExternalOrderId
ExternalOrderId string

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

IsClosed
IsClosed boolean

UpdateOrderApiModel が閉じたかどうかを示す状態。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
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" フィールド値の形式: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 }

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

従業員番号
EmployeeNumber True string

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

StatusLabel
StatusLabel True string

この NewOrderStatusApiModel に関連付けられている StatusLabel のコンテンツにラベルを付けます。

StatusStartDateTime
StatusStartDateTime True date-time

この NewOrderStatusApiModel 状態が開始された時点。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

緯度
Latitude double
緯度
Longitude double
AddressLine1
AddressLine1 string

この LocationApiModel の AddressLine1。

AddressLine2
AddressLine2 string

この LocationApiModel の AddressLine2。

市区町村
City string

LocationApiModel の市区町村。

地域名
RegionName string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

キャプション
Caption True string
価値
Value

UpdateFormFieldApiModel の値。

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

"Camera" フィールド値の形式 (バイナリ参照): { "BinaryId": アップロードされた画像の文字列、// バイナリ ID (バイナリ API のアップロードを参照) "注": 参照先イメージの文字列 // 注 }

"Signature" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされた画像の文字列 // バイナリ ID (バイナリ API のアップロードを参照) }

"Audio" フィールド値の形式 (バイナリリファレンス): { "BinaryId": アップロードされたオーディオの文字列、// バイナリ ID (バイナリ API のアップロードを参照) "DurationSeconds": number // Audio duration in seconds }

CapturedTime
CapturedTime date-time

ポイントインタイム値がキャプチャされました。

FieldIndex
FieldIndex integer

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

価値
Value

フィールド値。

ジオコード
geocode boolean

住所はジオコーディングする必要があります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

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

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

戻り値

車両をアクティブ化する

ID で車両をアクティブ化します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

response
integer

車両を作成する

車両を作成します。

パラメーター

名前 キー 必須 説明
Number
Number string
名前
Name string
タイプ
Type string
タグ
Tag string
UserEmployeeNumber
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
DeviceSerialNumber string

戻り値

車両を削除する

ID で車両を削除します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

車両を更新する

ID で車両を更新します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

Number
Number string
名前
Name string
タイプ
Type string
タグ
Tag string
UserEmployeeNumber
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
DeviceSerialNumber string
use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

response
integer

車両を部分的に更新する

車両を ID で部分的に更新します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

object
use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

車両を非アクティブ化する

ID で車両を非アクティブ化します。

パラメーター

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

外部 ID または内部 ID は、use-external-id パラメーターの値によって異なります。

use-external-id
use-external-id boolean

外部 ID を使用するかどうか。

戻り値

response
integer

車両リストを取得する

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

パラメーター

名前 キー 必須 説明
pageNumber
pageNumber integer

ページ番号。

pageSize
pageSize integer

ページ内のアイテムの最大数。 既定値は 1000 です。 最大値 = 2000。

activeOnly
activeOnly boolean

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

戻り値

トリガー

タイムキーピング ポーリング

タイムキーピング 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 定義: 内部タイム タグ = 最新のタイムキーピング状態変更の時刻。

フォーム データポーリング

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 定義: 内部時間タグ = 最新のフォーム データ変更の時刻。

注文のポーリング

Orders 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 定義: 内部タイム タグ = 最新の注文データ変更の時刻。

注文の状態のポーリング

Order Statuses 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、TimekeepingStatusId、昇順で自動的に並べ替えられます。 並べ替えパラメーターは構成できません。

ModifiedUtc 定義: 内部タイム タグ = 最新のタイムキーピング状態変更の時刻。

パラメーター

名前 キー 必須 説明
excludeFormData
excludeFormData boolean

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

戻り値

フォーム データポーリング

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 定義: 内部時間タグ = 最新のフォーム データ変更の時刻。

戻り値

注文のポーリング

Orders 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 定義: 内部タイム タグ = 最新の注文データ変更の時刻。

パラメーター

名前 キー 必須 説明
excludeFormData
excludeFormData boolean

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

excludeCustomFieldData
excludeCustomFieldData boolean

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

戻り値

注文の状態のポーリング

Order Statuses 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 定義: 内部時間タグ = 最新の注文状態データ変更の時刻。

パラメーター

名前 キー 必須 説明
excludeFormData
excludeFormData boolean

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

戻り値

定義

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 string

クライアントの名前。

住所
Address CustomerAPI.Models.LocationApiModel
お問い合わせ
Contact CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

名前 パス 説明
FieldIndex
FieldIndex integer

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

キャプション
Caption string

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

データ型
DataType integer

フィールド データ型。

DateTimeFormat
DateTimeFormat integer

DateTime 形式。

価値
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 string

LocationApiModel のリージョン名。

郵便番号
PostalCode string

LocationApiModel の郵便番号。

国コード
CountryCode string

ISO 3166-1 alpha-2 コード。

SubRegionName
SubRegionName string

LocationApiModel の SubRegion。

SubRegionCode
SubRegionCode string

LocationApiModel の SubRegion コード。

RegionCode
RegionCode string

LocationApiModel のリージョン コード。

CustomerAPI.Models.Client.ContactApiModel

名前 パス 説明
名前
Name string

ContactApiModel の名前。

電話番号
PhoneNumber string

ContactApiModel の PhoneNumber。

Email
Email string

ContactApiModel の電子メール。

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 string

カスタム リスト名。

バージョン
Version string

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

CustomerAPI.Models.CustomLists.CustomListApiModel

カスタム リスト モデル。

名前 パス 説明
CustomListId
CustomListId integer

カスタム リスト ID。

名前
Name string

カスタム リスト名。

バージョン
Version string

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

Definition
Definition CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

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

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

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

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

カスタム リスト列。

UniqueColumnIndexIndex
UniqueColumnIndexIndex integer

一意の列インデックス。

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

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

名前 パス 説明
Index
Index integer

列インデックス。

データ型
DataType integer

Column DataType (Text: 0、Numeric: 1、Date: 2、Time: 3、DateTime: 4、Email: 5)。

名前
Name string

列名。

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

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

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

データを含む列の配列。

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

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

名前 パス 説明
ColumnIndex
ColumnIndex integer

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

キャプション
Caption string

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

価値
Value

カスタム リスト列の値。

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

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

名前 パス 説明
ID (アイディー)
Id string
名前
Name string
ReverseGeocode
ReverseGeocode boolean
パラメーター
Parameters array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

名前 パス 説明
名前
Name string
タイプ
Type integer
キャプション
Caption string
必須
Required boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

名前 パス 説明
EventId
EventId integer

イベント ID。

イベントの種類
EventType integer
EventCode
EventCode string

イベント コード。

EventTime
EventTime date-time

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

User
User CustomerAPI.Models.UserReferenceApiModel
Vehicle CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle
UserLinkedToVehicle boolean

有効にすると、イベントの車両にユーザーが割り当てられます。

ロケーション
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 string

ユーザーの名。

LastName
LastName string

ユーザーの姓。

従業員番号
EmployeeNumber string

ユーザーの従業員番号。

GroupName
GroupName string

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

CustomerAPI.Models.ReadVehicleApiModel

名前 パス 説明
VehicleId
VehicleId integer

BaseVehicleApiModel の ID。

名前
Name string

BaseVehicleApiModel の名前。

VIN
VIN string

BaseVehicleApiModel の車両識別番号。

デバイス名
DeviceName string

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

シリアルナンバー
SerialNumber string

BaseVehicleApiModel の SerialNumber。

GroupName
GroupName string

BaseVehicleApiModel の GroupName。

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

名前 パス 説明
GeofenceId
GeofenceId integer

ジオフェンスの ID。

名前
Name string

ジオフェンスの名前。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

名前 パス 説明
購読ID
SubscriptionId string

WebHookSubscriptionResultApiModel の ID。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

名前 パス 説明
購読ID
SubscriptionId string
ウェブアドレス
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 boolean

このスタンドアロンFormApiModelのレビューの状態。

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

FormFieldDataApiModel の値。

DisplayValue
DisplayValue

FormFieldDataApiModel の DisplayValue。

CapturedTime
CapturedTime date-time

FormFieldDataApiModel のポイント イン タイム値がキャプチャされました。

CapturedLocation
CapturedLocation CustomerAPI.Models.LocationApiModel
キャプション
Caption string

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

ApiFieldId
ApiFieldId string

FormFieldDataApiModel の ApiField の ID。

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

名前 パス 説明
ID (アイディー)
Id string

FormFieldDataApiModel の ID。

価値
Value

FormFieldDataApiModel の値。

DisplayValue
DisplayValue

FormFieldDataApiModel の DisplayValue。

CapturedTime
CapturedTime date-time

FormFieldDataApiModel のポイント イン タイム値がキャプチャされました。

CapturedLocation
CapturedLocation CustomerAPI.Models.LocationApiModel
キャプション
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 string

GeofenceApiModelBase の名前。

タイプ
Type string

GeofenceApiModel の型。

Shape
Shape integer

図形: 円の場合は 0、多角形の場合は 1 です。

住所
Address CustomerAPI.Models.LocationApiModel
半径
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

多角形のポイント。 図形が 1 の場合は塗りつぶす必要があります。

名前
Name string

GeofenceApiModelBase の名前。

タイプ
Type string

GeofenceApiModel の型。

Shape
Shape integer

図形: 円の場合は 0、多角形の場合は 1 です。

住所
Address CustomerAPI.Models.LocationApiModel
半径
Radius double

GeofenceApiModel の半径。

UseGeofenceAddress
UseGeofenceAddress boolean

GeofenceApiModel の UseGeofenceAddress。

CustomerAPI.Models.Order.OrderListItemApiModel

名前 パス 説明
注文ID
OrderId integer

OrderBaseApiModel の ID。

ExternalOrderId
ExternalOrderId string

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

納期
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 string

この OrderBaseApiModel に関連付けられている注文番号。

IsClosed
IsClosed boolean

OrderBaseApiModel が閉じているかどうかを示す状態。

ステータス
Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
ExternalClientId string

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

ClientId
ClientId integer

クライアント - API 拡張機能プロパティの内部使用 ID。

Client
Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
ApiServiceId string

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

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

カスタム フィールド モジュールのバージョン。

CustomFieldsData
CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
Recurrence boolean

CustomerAPI.Models.Order.OrderStatusApiModel

名前 パス 説明
StatusIndex
StatusIndex integer

OrderStatusApiModel のインデックス。

ステータスの種類
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
注文ID
OrderId integer

OrderBaseApiModel の ID。

ExternalOrderId
ExternalOrderId string

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

納期
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 string

この OrderBaseApiModel に関連付けられている注文番号。

IsClosed
IsClosed boolean

OrderBaseApiModel が閉じているかどうかを示す状態。

ステータス
Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
ExternalClientId string

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

ClientId
ClientId integer

クライアント - API 拡張機能プロパティの内部使用 ID。

Client
Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
ApiServiceId string

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

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

カスタム フィールド モジュールのバージョン。

CustomFieldsData
CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
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 integer

注文の状態: 新しい注文の場合は 0、発送済みの場合は 1、進行中の場合は 2、完了の場合は 3、取り消しの場合は 4。

ExternalOrderId
ExternalOrderId string

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

注文ID
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
注文ID
OrderId integer

OrderBaseApiModel の ID。

ExternalOrderId
ExternalOrderId string

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

納期
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 string

この OrderBaseApiModel に関連付けられている注文番号。

IsClosed
IsClosed boolean

OrderBaseApiModel が閉じているかどうかを示す状態。

ステータス
Status CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId
ExternalClientId string

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

ClientId
ClientId integer

クライアント - API 拡張機能プロパティの内部使用 ID。

Client
Client CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId
ApiServiceId string

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

CustomFieldsModuleVersion
CustomFieldsModuleVersion integer

カスタム フィールド モジュールのバージョン。

CustomFieldsData
CustomFieldsData array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence
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 boolean

このタイムキーピングエントリの監督者承認のステータス。

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 integer

状態の種類: 中断の場合は 1、昼食の場合は 2。

StartLabel
StartLabel string

開始ラベル。

EndLabel
EndLabel string

終了ラベル。

キャプション
Caption string

キャプション。

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

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

System.Version

名前 パス 説明
_少佐
_Major integer
_マイナー
_Minor integer
_建てる
_Build integer
_改定
_Revision integer

CustomerAPI.Models.Tracking.TripApiModel

名前 パス 説明
User
User CustomerAPI.Models.UserReferenceApiModel
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 double

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

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

名前 パス 説明
レコード​​
Records array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken(継続トークン)
ContinuationToken string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

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

この GpsDataRecordApiModel に関連付けられている TimeTag。

ロケーション
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
StatusTime string

この GpsDataRecordApiModel 状態が設定された時点。

距離
Distance double

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

イグニッションオン
IgnitionOn boolean

この GpsDataRecordApiModel に関連付けられている車両のイグニッションの状態。

LocationProvider
LocationProvider integer

この GpsDataRecordApiModel に関連付けられている Api Location Provider - (GPS: 1、ネットワーク: 2)。

CustomerAPI.Models.User.ReadUserApiModel

名前 パス 説明
UserName
UserName string

ユーザーの UserName。

UserId
UserId integer

ユーザーの ID 値。

GroupName
GroupName string

ユーザーのグループの名前。

ファーストネーム
FirstName string

ユーザーの名。

LastName
LastName string

ユーザーの姓。

従業員番号
EmployeeNumber string

ユーザーの従業員番号。

Email
Email string

ユーザーのメール アドレス。

電話
Phone string

ユーザーの電話番号。

RoleId
RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、Power User: 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 string

ユーザーの名。

LastName
LastName string

ユーザーの姓。

従業員番号
EmployeeNumber string

ユーザーの従業員番号。

Email
Email string

ユーザーのメール アドレス。

電話
Phone string

ユーザーの電話番号。

RoleId
RoleId integer

ユーザーの RoleId - (管理者: 1、ユーザー: 3、Power User: 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 string
タイプ
Type string
タグ
Tag string
UserEmployeeNumber
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
DeviceSerialNumber string

整数

これは、基本的なデータ型 'integer' です。

オブジェクト

これは型 'object' です。