施設、ルームタイプ、およびルームAPI
APIエンドポイント
施設、ルームタイプ、およびルームAPIのエンドポイントは、https://api.amazonalexa.com
です。
認証
すべてのAPIリクエストには認可ヘッダーが必要であり、その値にはLogin with Amazon(LWA)から取得したアクセストークンが入ります。
操作
施設、ルームタイプ、およびルームAPIには、以下の操作が用意されています。
操作 | HTTPメソッドとURI |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
施設を管理する
施設を作成する
施設を作成するには、POST /enterprise/hospitality/v1/properties
を呼び出します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
POST /enterprise/hospitality/v1/properties HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエスト本文
{
"name": "{propertyName}",
"organizationId": "amzn1.alexa.unit.did.{id}"
}
リクエスト本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
name |
施設名です。 | 文字列 | ◯ |
organizationId |
Alexa Smart Properties for Hospitalityの組織IDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Location: "/enterprise/hospitality/v1/properties/{propertyId}"
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
propertyId |
施設IDです。Location ヘッダーにURIの一部として含まれます。 |
文字列 | ◯ |
応答本文
{
"id": "amzn1.alexa.unit.did.{id}"
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
新しい施設の施設IDです。 | 文字列 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
201 | Created | 施設が正常に作成されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
施設のリストを取得する
組織下にある施設のリストを取得するには、GET /enterprise/hospitality/v1/properties?organizationId={organizationId}
を呼び出します。呼び出し元のユーザーに、施設を表示するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
GET /enterprise/hospitality/v1/properties?organizationId={organizationId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
organizationId |
Alexa Smart Properties for Hospitalityの組織IDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
nextToken |
前回の施設リストの取得に対する応答で、応答オブジェクトに返された継続トークンです。詳細については、クエリ結果のページ分割を処理するを参照してください。 | 文字列 | ✕ |
maxResults |
表示する結果の最大数です。値は1~50の間で指定します。デフォルトは10です。 | 整数 | ✕ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
{
"properties": [
{
"id": "string",
"organizationId": "string",
"name": "string"
}
],
"paginationContext": {
"nextToken": "string"
}
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
施設IDです。 | 文字列 | ◯ |
organizationId |
施設の組織IDです。 | 整数 | ◯ |
name |
施設名です。 | 文字列 | ◯ |
paginationContext.nextToken |
nextToken の値を次回のリクエストで継続トークンとして使用すると、オブジェクトの次のセットを取得できます。詳細については、クエリ結果のページ分割を処理するを参照してください。 |
文字列 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされた施設が見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
施設を取得する
特定の施設のメタデータを取得するには、GET /enterprise/hospitality/v1/properties/{propertyId}
を呼び出します。呼び出し元のユーザーに、その施設を表示するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
GET /enterprise/hospitality/v1/properties/{propertyId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
propertyId |
施設IDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
{
"id": "string",
"organizationId": "string",
"name": "string"
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
施設IDです。 | 文字列 | ◯ |
organizationId |
施設の組織IDです。 | 整数 | ◯ |
name |
施設名です。 | 文字列 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされた施設が見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
施設を更新する
特定の施設のメタデータを更新するには、PUT /enterprise/hospitality/v1/properties/{propertyId}
を呼び出します。呼び出し元のユーザーに、その施設を更新するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
PUT /enterprise/hospitality/v1/properties/{propertyId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
propertyId |
施設IDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
{
"name": "string"
}
リクエスト本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
name |
新しい施設名です。 | 文字列 | ◯ |
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
ありません。
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
204 | No content | 施設が正常に更新されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされた施設が見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
施設を削除する
特定の施設を削除するには、その施設にユニット(ルームタイプやルーム)が含まれていない状態で、DELETE /enterprise/hospitality/v1/properties/{propertyId}
を呼び出します。呼び出し元のユーザーに、その施設を削除するアクセス権限が必要です。施設が空でない場合は、削除操作によってHTTPステータスコード400が返されます。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
DELETE /enterprise/hospitality/v1/properties/{propertyId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
propertyId |
施設IDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
ありません。
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
204 | No content | 施設が正常に削除されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされた施設が見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
施設のルームタイプを管理する
ルームタイプとは、同じような特徴を持つルームをグループ化するためのユニットです。たとえば、オーシャンビュールーム、デラックススイート、同じフロアの部屋のように、同様のタイプのルームをそれぞれのグループにまとめることができます。
ルームタイプを作成する
施設の下にルームタイプを作成するには、POST /enterprise/hospitality/v1/roomTypes
を呼び出します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
POST /enterprise/hospitality/v1/roomTypes HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエスト本文
{
"name": "{roomTypeName}",
"propertyId": "amzn1.alexa.unit.did.{id}"
}
リクエスト本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
name |
ルームタイプの名前です。 | 文字列 | ◯ |
propertyId |
施設IDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Location: "/enterprise/hospitality/v1/roomTypes/{roomTypeId}"
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
roomTypeId |
ルームタイプIDです。Location ヘッダーにURIの一部として含まれます。 |
文字列 | ◯ |
応答本文
{
"id": "amzn1.alexa.unit.did.{id}"
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
新しいルームタイプのIDです。 | 文字列 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
201 | Created | ルームタイプが正常に作成されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームタイプのリストを取得する
施設内にあるルームタイプのリストを取得するには、GET /enterprise/hospitality/v1/roomTypes?propertyId={propertyId}
を呼び出します。呼び出し元のユーザーに、ルームタイプを表示するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
GET /enterprise/hospitality/v1/roomTypes?propertyId={propertyId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのクエリパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
propertyId |
施設IDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
nextToken |
前回のルームタイプリストの取得に対する応答で、応答オブジェクトに返された継続トークンです。詳細については、クエリ結果のページ分割を処理するを参照してください。 | 文字列 | ✕ |
maxResults |
表示する結果の最大数です。値は1~50の間で指定します。デフォルトは10です。 | 整数 | ✕ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
{
"roomTypes": [
{
"id": "string",
"name": "string",
"propertyId": "string"
}
],
"paginationContext": {
"nextToken": "string"
}
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
ルームタイプIDです。 | 文字列 | ◯ |
name |
ルームタイプ名です。 | 文字列 | ◯ |
propertyId |
施設IDです。 | 整数 | ◯ |
paginationContext.nextToken |
nextToken の値を次回のリクエストで継続トークンとして使用すると、結果の次のセットを取得できます。詳細については、クエリ結果のページ分割を処理するを参照してください。 |
文字列 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームタイプが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームタイプを取得する
特定のルームタイプのメタデータを取得するには、GET /enterprise/hospitality/v1/roomTypes/{roomTypeId}
を呼び出します。呼び出し元のユーザーに、そのルームタイプを表示するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
GET /enterprise/hospitality/v1/roomTypes/{roomTypeId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
roomTypeId |
ルームタイプIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
{
"id": "string",
"name": "string",
"propertyId": "string"
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
ルームタイプIDです。 | 文字列 | ◯ |
name |
ルームタイプ名です。 | 文字列 | ◯ |
propertyId |
施設IDです。 | 整数 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームタイプが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームタイプを更新する
特定のルームタイプのメタデータを更新するには、PUT /enterprise/hospitality/v1/roomTypes/{roomTypeId}
を呼び出します。呼び出し元のユーザーに、そのルームタイプを更新するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
PUT /enterprise/hospitality/v1/roomTypes/{roomTypeId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
roomTypeId |
ルームタイプIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
{
"name": "string"
}
リクエスト本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
name |
新しいルームタイプ名です。 | 文字列 | ◯ |
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
ありません。
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
204 | No content | ルームタイプが正常に更新されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームタイプが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームタイプを削除する
特定のルームタイプを削除するには、そのルームタイプにルームが含まれていない状態で、DELETE /enterprise/hospitality/v1/roomTypes/{roomTypeId}
を呼び出します。呼び出し元のユーザーに、そのルームタイプを削除するアクセス権限が必要です。ルームタイプが空でない場合は、削除操作によってHTTPステータスコード400が返されます。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
DELETE /enterprise/hospitality/v1/roomTypes/{roomTypeId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
roomTypeId |
ルームタイプIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
ありません。
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
204 | No content | ルームタイプが正常に削除されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームタイプが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームタイプ内のルームを管理する
ルームを作成する
ルームタイプの下に新しいルームを作成するには、POST /enterprise/hospitality/v1/rooms
を呼び出します。
ルーム名には、英数字および特殊文字_ - = # ; : ? @ &を使用できます。スペースとピリオドは使用できません。ルーム名は256文字以内にする必要があります。ルーム名は施設ごとに一意でなければならず、組織のユーザーにとって意味のある名前にする必要があります。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
POST /enterprise/hospitality/v1/rooms HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエスト本文
{
"name": "{roomName}",
"roomTypeId": "amzn1.alexa.unit.did.{id}"
}
リクエスト本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
name |
ルームの名前です。 | 文字列 | ◯ |
roomTypeId |
ルームタイプIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Location: "/enterprise/hospitality/v1/rooms/{roomId}"
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
roomId |
ルームIDです。Location ヘッダーにURIの一部として含まれます。 |
文字列 | ◯ |
応答本文
{
"id": "amzn1.alexa.unit.did.{id}"
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
新しいルームのIDです。 | 文字列 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
201 | Created | ルームが正常に作成されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームのリストを取得する
ルームタイプ内にあるルームのリストを取得するには、GET /enterprise/hospitality/v1/rooms?roomTypeId={roomTypeId}
を呼び出します。呼び出し元のユーザーに、ルームを表示するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
GET /enterprise/hospitality/v1/rooms?roomTypeId={roomTypeId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
roomTypeId |
ルームタイプIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
nextToken |
前回のルームリストの取得に対する応答で、応答オブジェクトに返された継続トークンです。詳細については、クエリ結果のページ分割を処理するを参照してください。 | 文字列 | ✕ |
maxResults |
表示する結果の最大数です。値は1~50の間で指定します。デフォルトは10です。 | 整数 | ✕ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
{
"rooms": [
{
"id": "string",
"name": "string",
"roomTypeId": "string"
}
],
"paginationContext": {
"nextToken": "string"
}
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
ルームIDです。 | 文字列 | ◯ |
name |
ルーム名です。 | 文字列 | ◯ |
roomTypeId |
ルームタイプIDです。 | 整数 | ◯ |
paginationContext.nextToken |
nextToken の値を次回のリクエストで継続トークンとして使用すると、結果の次のセットを取得できます。詳細については、クエリ結果のページ分割を処理するを参照してください。 |
文字列 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームを取得する
特定のルームのメタデータを取得するには、GET /enterprise/hospitality/v1/rooms/{roomId}
を呼び出します。呼び出し元のユーザーに、そのルームを表示するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
GET /enterprise/hospitality/v1/rooms/{roomId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
roomId |
ルームIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
{
"id": "string",
"name": "string",
"roomTypeId": "string"
}
応答本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
id |
ルームIDです。 | 文字列 | ◯ |
name |
ルーム名です。 | 文字列 | ◯ |
roomTypeId |
ルームタイプIDです。 | 整数 | ◯ |
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームを更新する
特定のルームのメタデータを更新するには、PUT /enterprise/hospitality/v1/rooms/{roomId}
を呼び出します。呼び出し元のユーザーに、そのルームを更新するアクセス権限が必要です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
PUT /enterprise/hospitality/v1/rooms/{roomId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
roomId |
ルームIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
{
"name": "string"
}
リクエスト本文のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
name |
新しいルーム名です。 | 文字列 | ◯ |
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
ありません。
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
204 | No content | ルームが正常に更新されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームタイプが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
ルームを削除する
特定のルームを削除するには、DELETE /enterprise/hospitality/v1/rooms/{roomId}
を呼び出します。呼び出し元のユーザーに、そのルームを削除するアクセス権限が必要です。エンドポイントが関連付けられているルームを削除することはできません。ルームに関連付けられたエンドポイントがある場合は、削除操作によってHTTPステータスコード400が返されます。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Residential | Senior Living | Core |
---|---|---|---|---|
なし |
米国、英国、フランス、カナダ |
なし |
なし |
なし |
リクエストの形式
DELETE /enterprise/hospitality/v1/rooms/{roomId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWAトークン}
リクエストのパスパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
roomId |
ルームIDです。形式は"amzn1.alexa.unit.did.{id}" です。 |
文字列 | ◯ |
リクエスト本文
ありません。
応答ヘッダー
Host
値は、リクエストのHost
値と同じになります。Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
X-Amzn-RequestId |
リクエストの一意のIDです。問題が発生する場合、Amazonはこの値をトラブルシューティングに使用します。 | 文字列 | ◯ |
応答本文
ありません。
エラー応答
HTTP/1.1 {ErrorCode}
{
"message": "{ErrorMessage}"
}
エラー応答のパラメーター
フィールド | 説明 | 型 | 必須 |
---|---|---|---|
message |
エラーのエラーメッセージです。 | 文字列 | ✕ |
HTTP応答コード
ステータスコード | 名前 | 説明 |
---|---|---|
204 | No content | ルームが正常に削除されました。 |
400 | Bad Request | リクエストの形式が正しくないか、1つ以上の必須パラメーターがありません。 |
401 | Unauthorized | アクセストークンがないか、無効です。 |
403 | Forbidden | サービスにアクセスする権限がユーザーにありません。 |
404 | Not found | リクエストされたルームが見つかりませんでした。 |
429 | Too many requests | リクエストが制限されました。1秒後に再試行し、待機間隔が256秒になるまでエクスポネンシャルバックオフを実行して、それ以降は429以外の応答を受信するまで256秒ごとに再試行してください。 |
500 | Internal Server Error | 内部サービスエラーのためリクエストを処理できませんでした。 |
最終更新日: 2023 年 03 月 16 日