ゲストREST API v2 (レガシー)

ゲストの作成 (レガシー)

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

大事な

このREST APIの新しいバージョン(v2.1)が利用可能です。このREST APIを初めて使用する場合は、新しいバージョンを使用してください。または、すでに古いバージョンを使用している場合は、v2とv2.1の違いについて読んでアップグレードできるようにしてください。

POST /v2/guests

ゲストを作成します。

警告

ゲストの作成時に、ゲストがすでに存在するかどうかはREST API検証されません。ゲストの重複を防ぐには、まずメールアドレスまたはその他の識別情報を使用してゲストを取得します。

少なくとも、要求本文で次の必須属性を指定する必要があります。

属性	種類	形容	例
guestType	文字列列挙型	取得したIDのレベル。	次のいずれかである必要があります。 "visitor" "customer" "traveller"

応答では、refキーにゲスト参照が含まれています。

個人を特定できる情報(PII)を使用してゲストを作成する:

curl -X POST '<baseURL>/v2/guests' \
-u '<username>:<password>' \
-H 'Accept: application/json' \
--data-raw '
 {
    "guestType": "customer",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "passportExpiry": "2033-01-01T00:00Z",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "IE",
    "postCode": "D2",
    "state": "Dublin",
}'

201 Created個人を特定できる情報(PII)による回答:

{
   "href":"<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "ref":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "createdAt":"2025-03-07T16:15:11.000Z",
   "modifiedAt":"2025-08-23T16:17:16.000Z",
   "firstSeen":"2025-03-07T16:15:11.000Z",
   "lastSeen":"2025-08-23T16:17:16.000Z",
   "guestType":"customer",
   "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "passportExpiry": "2033-01-01T00:00:00.000Z",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "IE",
    "postCode": "D2",
    "state": "Dublin",
}

identifiersを使用してゲストを作成します。

curl -X POST '<baseURL>/v2/guests' \
-u '<username>:<password>' \
-H 'Accept: application/json' \
--data-raw '
 {
   "guestType":"customer",
   "identifiers":[
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
   ]
}'

201 Createdidentifiersでの応答:

{   
   "href":"<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "ref":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "createdAt":"2025-03-07T16:15:11.000Z",
   "modifiedAt":"2025-08-23T16:17:16.000Z",
   "firstSeen":"2025-03-07T16:15:11.000Z",
   "lastSeen":"2025-08-23T16:17:16.000Z",
   "guestType":"customer",
   "identifiers":[
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
   ]
}

curl -X POST '<baseURL>/v2/guests' \
-u '<username>:<password>' \
-H 'Accept: application/json' \
--data-raw '
 {
    "guestType": "customer",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "passportExpiry": "2033-01-01T00:00:00.000Z",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "IE",
    "postCode": "D2",
    "state": "Dublin",
    "identifiers": [
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
    ]
}'

{
   "href":"<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "ref":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "createdAt":"2025-03-07T16:15:11.000Z",
   "modifiedAt":"2025-08-23T16:17:16.000Z",
   "firstSeen":"2025-03-07T16:15:11.000Z",
   "lastSeen":"2025-08-23T16:17:16.000Z",
    "guestType": "customer",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "Ireland",
    "postCode": "D2",
    "state": "Dublin",
    "identifiers": [
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
    ]
}

この記事を改善するための提案がある場合は、お知らせください!