Connect REST API 開発者ガイド
jサービステリトリー
workTypeId または workTypeGroupId のサービステリトリーを取得します。radius、latitude、longitude、sortBy、および sortOrder プロパティを使用して、サービステリトリーの絞り込みや並び替えを行います。
- リソース
-
- リソースの例
-
- 使用可能なバージョン
- 48.0
- Chatter が必要かどうか
- いいえ
- HTTP のメソッド
- GET
- クエリパラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン filterByTerritoryIds String [] API 応答を絞り込むためのサービステリトリー ID のカンマ区切りリスト。 省略可能 57.0 latitude Double サービステリトリーエリアの緯度。 省略可能 48.0 limit Integer 返されるサービステリトリーの制限。たとえば、limit=1 と指定すると、サービステリトリーリストには 1 つのサービステリトリーしか登録できません。デフォルト値は 40 です。 省略可能 48.0 longitude Double サービステリトリーエリアの経度。 省略可能 48.0 offset Integer 返されるサービステリトリーのオフセット。デフォルト値は 0 です。 省略可能 48.0 radius Integer サービステリトリーを取得するための、緯度と経度の値を中心とした半径。緯度と経度が指定されている場合のデフォルト値は 5 で、指定されていない場合はデフォルト値はありません。 省略可能 48.0 radiusUnit String 半径値の単位。可能な値は mi (マイル) と km (キロメートル) です。緯度と経度が指定されている場合のデフォルト値は mi で、指定されていない場合はデフォルト値はありません。 省略可能 48.0 schedulingPolicyId String AppointmentSchedulingPolicy オブジェクトの ID。リクエストボディでスケジュールポリシーが渡されない場合、デフォルトの設定が使用されます。この API を使用する場合、すべてのスケジュールポリシー設定が考慮されます。 省略可能 48.0 serviceResourceIds String [] API 応答を絞り込むためのサービステリトリーの技術者 ID またはアセット ID のカンマ区切りリスト。 省略可能 48.0 sortBy String[] サービステリトリーリストの並び替え条件。有効な値は distance と name で、大文字と小文字は区別されません。緯度と経度が指定されている場合のデフォルト値は distance で、指定されていない場合のデフォルト値は name です。 省略可能 48.0 sortOrder String[] サービステリトリーリストの並び替えの順序。大文字と小文字が区別されない有効な値は asc (昇順) と desc (降順) で、大文字と小文字は区別されません。デフォルト値は asc です。 省略可能 48.0 workTypeGroupId String 実施されている作業種別を含む作業種別グループの ID。 workTypeId が指定されていない場合は必須 48.0 workTypeId String 実行する作業の種別の ID。 workTypeGroupId が指定されていない場合は必須 48.0 - レスポンスボディ
- Service Territories Output
- サンプルレスポンスボディ
-