メインコンテンツまでスキップ

ゲスト検索

ゲスト情報の検索・取得を行います。

基本仕様​

  • エンドポイント : /guests/search?type={search type}&query={search word}
  • メソッド : GET

リクエストヘッダー​

APIキーなどの共通の設定は「Cracker API概要」を参照してください。

パスパラメータ​

なし

クエリパラメータ​

パラメータ名タイプ必須説明
type文字列必須検索タイプを指定します。
query文字列必須検索ワードを指定します。
  • typeについて
    ゲスト情報の何を検索するかを指定します。
タイプ名説明
nameゲスト名から検索を行います。
mailメールアドレスから検索を行います。

どちらのタイプの場合でもデータベース上の文字列に一致する部分があれば結果として出力されます。

リクエストボディ​

なし

レスポンスボディ​

パラメータ名タイプ説明
group_id文字列ゲストID
guests配列来場者の続柄と名前
guest_type文字列family/other
st_name文字列生徒名
st_belong文字列生徒所属
st_grade文字列生徒学年, n年表記
st_class文字列生徒クラス, n組表記(クラスなしの場合はなし)
state文字列ゲストの入退場状況
mail文字列ゲストのメールアドレス
parking数値駐車券の必要有無 (1:必要, 0:不要)

レスポンスボディサンプル

[
    {
      "group_id": "99b0c89c-b00c-48cb-9831-04cf536644bd",
      "guests": [
        [
          "佐藤恵",
          "母"
        ],
        [
          "佐藤健一",
          "兄"
        ],
        [
          "佐藤次郎",
          "弟"
        ]
      ],
      "guest_type": "family",
      "st_name": "佐藤花子",
      "st_belong": "普通科",
      "st_grade": "3年",
      "st_class": "1組",
      "state": "entered",
      "mail": "satou@example.com",
      "parking": 1
    }
]