Get Appointment Candidates

構文

URI

/services/data/vXX.X/scheduling/getAppointmentCandidates

適用開始バージョン

45.0

形式

JSON、XML

HTTP メソッド

POST

認証

Authorization: Bearer token

Lightning Platform REST API では、OAuth 2.0 (セキュアな API 認証を可能にするオープンプロトコル) がサポートされています。詳細は「認証について」を参照してください。

メモ

リクエストボディ

パラメータ	必須	型	説明
workTypeGroupId	workType が指定されていない場合は必須。	String	実施されている作業種別を含む作業種別グループの ID。
workType	workTypeGroupId が指定されていない場合は必須。	作業種別	実施される作業の種別。
territoryIds	はい	String[]	要求されている作業が実施されるサービステリトリー ID のリスト。
schedulingPolicyId	いいえ	String	AppointmentSchedulingPolicy オブジェクトの ID。リクエストボディでスケジュールポリシーが渡されない場合、デフォルトの設定が使用されます。この API を使用する場合、すべてのスケジュールポリシー設定が考慮されます。
startTime	いいえ	String	時間枠 (両端を含む) が始まる最も早い時間。指定されていない場合は、デフォルトの要求の現時刻に設定されます。
endTime	いいえ	String	時間枠 (両端を含む) が終わる最も遅い時間。
accountId	いいえ	String	関連取引先の ID。
allowConcurrent スケジュール	いいえ	Boolean	true の場合、時間枠での同時予定のスケジュールが許可されます。true の場合、同時予定は許可されません。デフォルトは false です。

リクエストボディ内の必須項目を決める場合は、以下の点を考慮してください。

• リクエストボディに workTypeGroupId または workType のいずれかを指定します。ただし両方は指定できません。
• workType が指定されている場合、id または durationInMinutes のいずれかを指定する必要があります。ただし両方は指定できません。
• workType の id が指定されている場合、他の workType 項目は省略可能です。

メモ

レスポンスボディ

要求の実行が成功すると、利用可能な予定のリソースのリストを含むレスポンスボディが返されます。

パラメータ	必須	型	説明
candidates	はい	Candidates[]	利用可能な予定の候補のリスト。

例

リクエストボディの例

workTypeGroupId を使用:

1{
2    "startTime" : "2019-01-23T00:00:00.000Z",
3    "endTime" : "2019-02-30T00:00:00.000Z",
4    "workTypeGroupId" : "0VSB0000000KyjBOAS",
5    "accountId" : "001B000000qAUAWIA4",
6    "territoryIds" : ["0HhB0000000TO9WKAW"],
7    "schedulingPolicyId" : "0VrB0000000KyjB"
8}

workType を使用:

1{
2"startTime" : "2019-01-23T00:00:00.000Z",
3"endTime" : "2019-02-30T00:00:00.000Z",
4"workType" : {
5    "id" : "08qRM00000003fkYAA"
6    },
7"territoryIds" : ["0HhRM00000003OZ0AY"],
8"accountId" : "001B000000qAUAWIA4",
9"schedulingPolicyId" : "0VrB0000000KyjB"
10}

durationInMinutes を使用。ただし workTypeGroupId 項目または workType id 項目は除く:

1{
2"workType" : {
3    "durationInMinutes" : 60,
4    "blockTimeBeforeAppointmentInMinutes" : 5,
5    "blockTimeAfterAppointmentInMinutes" : 5,
6    "timeFrameStartInMinutes" : 10080,
7    "timeFrameEndInMinutes" : 40320,
8    "operatingHoursId" : "0OHR00000004EEjOAM",
9    "skillRequirements" : [
10        {"skillId" : "0C5R000000000cf", "skillLevel" : 90}
11    ]
12  },
13"territoryIds" : ["0HhRM00000003OZ0AY"]
14}

レスポンスボディの例

1{
2  "candidates" : [ {
3    "endTime" : "2019-01-23T19:15:00.000+0000",
4    "resources" : [ "0HnB0000000D2DsKAK" ],
5    "startTime" : "2019-01-23T16:15:00.000+0000",
6    "territoryId" : "0HhB0000000TO9WKAW"
7  }, {
8    "endTime" : "2019-01-23T19:30:00.000+0000",
9    "resources" : [ "0HnB0000000D2DsKAK" ],
10    "startTime" : "2019-01-23T16:30:00.000+0000",
11    "territoryId" : "0HhB0000000TO9WKAW"
12  }, {
13    "endTime" : "2019-01-23T19:45:00.000+0000",
14    "resources" : [ "0HnB0000000D2DsKAK" ],
15    "startTime" : "2019-01-23T16:45:00.000+0000",
16    "territoryId" : "0HhB0000000TO9WKAW"
17  }]
18}

前提条件

予定の時間枠は、Lightning Scheduler のデータモデル設定に基づいて決定されます。以下に、データ設定時に検討できる要件をいくつか示します。

• 要求を作成する前に、Lightning Scheduler を設定します。この設定には、サービスリソース、サービステリトリーメンバー、作業種別グループ、作業種別、作業種別グループメンバー、およびサービステリトリー作業種別の作成または設定が含まれます。詳細は、「Lightning Scheduler の設定」を参照してください。
• サービステリトリーメンバーのテリトリー種別は、「主メンバー」、「副メンバー」、または「再配置」のいずれかでなければなりません。「主メンバー」と「再配置」テリトリー種別は同一と見なされます。
• サービステリトリーメンバーのテリトリー種別は、「主メンバー」、「副メンバー」、または「再配置」のいずれかでなければなりません。「主メンバー」と「再配置」テリトリー種別は同一と見なされます。

ルールとガイドライン

リソースの開始時刻および終了時刻を返す際には、以下の要素が検討されます。

リソースの作業可能性

サービステリトリーメンバー、サービステリトリー、作業種別、取引先の業務時間の各項目を使用して判断されます。

リソースの作業不可能性

リソースの不在、リソースが割り当てられた既存の予定に基づいて判断されます。リソースは、状況が [クローズ済み]、[キャンセル]、または [完了] のいずれでもない予定の必須リソースとしてマークする必要があります。

スケジュールポリシー内の予定の開始時間の間隔

予定を開始できる時間は、スケジュールポリシー内の [Appointment start time interval (予定の開始時間の間隔)] 項目を使用して決定されます。この間隔には、5、10、15、20、30、または 60 を設定できます。デフォルトでは 15 に設定されます。

作業種別の期間

終了時刻は、開始時刻 + 作業種別の期間で計算されます。