予約のオープン:GET /sn_tmf_api/appointment/searchTimeSlot

Xanadu API リファレンス

Release

xanadu

ft:locale

ja-JP

ft:publication_title

Xanadu API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

予約のオープン:GET /sn_tmf_api/appointment/searchTimeSlot

リリースバージョン: Xanadu

更新日 2024年08月01日

所要時間：7分

指定された期間内で予約できる利用可能なタイムスロットを返します。

URL 形式

/api/sn_tmf_api/appointment/searchTimeSlot

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
なし

表 : 2. クエリパラメータ
名前	説明
start_date	必須。予約を検索する期間の開始日時。形式:YYYY-MM-DD 00:00:00。`例:2025-01-31 09:00:00`。データタイプ：文字列
end_date	必須。予約を検索する期間の終了日時。形式:YYYY-MM-DD 00:00:00。`例:2025-01-31 12:00:00`。データタイプ：文字列
catalog_id	必須。予約サービス設定で構成されたレコードプロデューサーのSys_id。レコードプロデューサー [sc_cat_item_producer] テーブルにあります。データタイプ：文字列
場所	予約の場所 (cmn_location) のSys_id。場所 [cmn_location] テーブルにあります。データタイプ：文字列
opened_for	必須。予約しているユーザーのSys_id。Contact [customer_contact] テーブルにあります。データタイプ：文字列

表 : 3. 要求本文パラメーター
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター


名前	説明
availableTimeSlot	要求された指定された時間ブロック内の予約スロットのリスト。データタイプ: オブジェクト `'availableTimeSlot': [ { 'available': Boolean, 'end_date': 'String', 'end_date_display': 'String', 'end_dateUTC': 'String', 'start_date': 'String', 'start_date_display': 'String', 'start_dateUTC': 'String', } ]`
availableTimeSlot.available	関連付けられたタイムスロットが利用可能かどうかを示すフラグ。有効な値： true:タイムスロットが利用可能です。 false:タイムスロットは利用できません。データタイプ：ブーリアン
availableTimeSlot.end_date	関連付けられた予約の終了日時。タイムゾーンは、time_zone パラメーターの値に基づいています。データタイプ：文字列
availableTimeSlot.end_date_display	関連付けられた予約の終了日時を表示します。タイムゾーンは、time_zone_display_value パラメーターの値に基づいています。データタイプ：文字列
availableTimeSlot.end_dateUTC	関連する予約の終了日時 (UTC 時間形式)。データタイプ：文字列
availableTimeSlot.start_date	関連付けられた予約の開始日時。time_zoneパラメーターの値を反映します。データタイプ：文字列
availableTimeSlot.start_date_display	関連付けられた予約の開始日時を表示します。time_zone_display_valueパラメーターの値を反映します。データタイプ：文字列
availableTimeSlot.start_dateUTC	関連する予約の開始日時 (UTC 時間形式)。データタイプ：文字列
hasMore	制限を返した後にフェッチする予約スロットがまだあるかどうかを示すフラグ。有効な値： true:より多くの予約スロットをフェッチできます。 false:これ以上予約スロットを使用できません。データタイプ：ブーリアン
noApptAvailable	指定された日時に利用可能な予約スロットがまだあるかどうかを示すフラグ。有効な値： true:指定された日時に利用可能な予約スロットが増えます。 false:指定された日時に利用可能な予約スロットはこれ以上ありません。データタイプ：ブーリアン
検索結果 (searchResult)	指定された検索時間枠内の予約可用性の結果。可能な値：正常終了失敗データタイプ：文字列
status	利用可能なタイムスロットの検索の完了ステータス。データタイプ：文字列
タイムゾーン	予約スロットが表示されたタイムゾーン。予約サービス構成の値に基づきます。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。

curl --location --request GET 'https://instance.service-now.com/api/sn_tmf_api/appointment/searchTimeSlot?
start_date=2024-07-10 09:00:00&end_date=2024-07-20 23:00:00&catalog_id=ada50a93f0220210f8776517d8c8e776&
opened_for=51670151c35420105252716b7d40ddfe&location=f48b21850a0a0ba7004182b18099696d ' \
--user 'username':'password'

結果：

{
  "searchResult": "success",
  "status": "done",
  "availableTimeSlot": [
    {
      "start_date": "2024-07-10 09:00:00",
      "end_date": "2024-07-10 12:00:00",
      "start_date_display": "09:00",
      "end_date_display": "12:00",
      "start_dateUTC": "2024-07-10 16:00:00",
      "end_dateUTC": "2024-07-10 19:00:00",
      "available": false
    },...
    {
      "start_date": "2024-07-11 13:00:00",
      "end_date": "2024-07-11 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-11 20:00:00",
      "end_dateUTC": "2024-07-11 23:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-12 09:00:00",
      "end_date": "2024-07-12 12:00:00",
      "start_date_display": "09:00",
      "end_date_display": "12:00",
      "start_dateUTC": "2024-07-12 16:00:00",
      "end_dateUTC": "2024-07-12 19:00:00",
      "available": true
    },
    {
      "start_date": "2024-07-12 13:00:00",
      "end_date": "2024-07-12 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-12 20:00:00",
      "end_dateUTC": "2024-07-12 23:00:00",
      "available": true
    },...
    {
      "start_date": "2024-07-19 13:00:00",
      "end_date": "2024-07-19 16:00:00",
      "start_date_display": "13:00",
      "end_date_display": "16:00",
      "start_dateUTC": "2024-07-19 20:00:00",
      "end_dateUTC": "2024-07-19 23:00:00",
      "available": true
    }
  ],
  "hasMore": false,
  "noApptAvailable": false,
  "timeZone": "US/Arizona"
}