Customer API Documentation

API Endpoint
https://example.com/xxxx

パブリックなリソースを提供します。

基本仕様は以下に従っています。

OAuth 2.0

OAuth 2.0 Framework

リクエストクォータ

レートクォータ

  • プロジェクトごとに最大20 RPS(1秒あたりのリクエスト)が適用されます。

  • 取引内操作に関してはさらに取引ごと(取引IDごと)に最大10 RPSが適用されます。

  • クォータを超過するとステータスコード429を返却します。

同時実行クォータ

  • 取引内操作に関しては、取引ごと(取引IDごと)に最大1の同時実行数が適用されます。

  • クォータを超過するとステータスコード409を返却します。

ステータスコード

status code description
200 OK リクエスト成功
400 BAD_REQUEST リクエストに問題があります。リクエストパラメータやJSONのフォーマットを確認してください。
401 UNAUTHORIZED Authorizationヘッダを正しく送信していることを確認してください。
403 FORBIDDEN APIの利用権限がありません。スコープを確認してください。
404 NOT_FOUND 指定したリソースが見つかりません。
409 CONFLICT 指定したリソースにおいて競合が発生しました。
429 TOO_MANY_REQUESTS レート制限(リクエストクォータを参照)を超過しました。時間をおいて再度アクセスしてください。
500 INTERNAL_SERVER_ERROR APIサーバ側の一時的なエラーです。
503 SERVICE_UNAVAILABLE APIサーバ側の一時的なエラーです。

Error response

エラー時のresponse bodyは、以下のフィールドを持つJSONデータです。

field type description
error Object エラーオブジェクト
error.code Array HTTPステータスコード
error.errors Array 詳細エラーリスト
error.message Array エラーメッセージ
error.errors[].message Object 詳細なエラー内容
error.errors[].name String エラー名称
error.errors[].reason String エラーの概要

OAuth

アクセストークン

POST https://example.com/xxxx/oauth2/token
Requestsクライアント認証
Headers
Content-Type: application/x-www-form-urlencoded
Authorization: Basic ABC123
Body
{
  "grant_type": "client_credencials",
  "state": "state123456789"
}
Schema
{
  "type": "object",
  "properties": {
    "grant_type": {
      "type": "string",
      "description": "認証タイプ(固定値)"
    },
    "state": {
      "type": "string",
      "description": "クライアント状態(クライアント側で現在のユーザー状態を表す文字列を送信してください。例えばセッションIDなどです)"
    }
  },
  "required": [
    "grant_type",
    "state"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Responses200400
Headers
Content-Type: application/json
Body
{
  "access_token": "JWT",
  "token_type": "Bearer",
  "expires_in": 1800
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "アクセストークン"
    },
    "token_type": {
      "type": "string",
      "description": "発行されたトークンタイプ"
    },
    "expires_in": {
      "type": "number",
      "description": "アクセストークンの有効期間"
    }
  },
  "required": [
    "access_token",
    "token_type",
    "expires_in"
  ]
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

アクセストークン発行
POST/oauth2/token

OAuth2 に準拠したトークンエンドポイントです。

エンドポイントは、

https://auth.example.com/oauth2/token

となります。

開発前に、運営側よりエンドポイント、認証情報を取得してください。

利用可能な認可タイプ

  • client_credentials

返却値には、access_tokenとexpires_inが含まれます。

アプリケーション側でアクセストークンの有効期間を管理し、適宜再取得してください。

販売者

販売者検索

GET https://example.com/xxxx/sellers?page=1&limit=10
Responses200400
Headers
Content-Type: application/json
Body
[
  {
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ],
    "branchCode": "xxx",
    "id": "xxx",
    "name": {
      "en": "English",
      "ja": "日本語"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      },
      "branchCode": {
        "type": "string",
        "description": "コード"
      },
      "id": {
        "type": "string",
        "description": "ID"
      },
      "name": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "英語"
          },
          "ja": {
            "type": "string",
            "description": "日本語"
          }
        },
        "description": "名称"
      }
    },
    "required": [
      "branchCode",
      "id"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

販売者検索
GET/sellers{?page,limit}

販売者を検索します。

URI Parameters
HideShow
page
number (optional) Default: 1 Example: 1

ページ

limit
number (optional) Default: 100 Example: 10

最大取得件数

施設

施設検索

GET https://example.com/xxxx/places/MovieTheater?page=1&limit=10
Responses200400
Headers
Content-Type: application/json
Body
[
  {
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ],
    "branchCode": "xxx",
    "name": {
      "en": "English",
      "ja": "日本語"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      },
      "branchCode": {
        "type": "string",
        "description": "コード"
      },
      "name": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "英語"
          },
          "ja": {
            "type": "string",
            "description": "日本語"
          }
        },
        "description": "名称"
      }
    },
    "required": [
      "branchCode"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

施設検索
GET/places/MovieTheater{?page,limit}

施設を検索します。ソート順はコード昇順です。

URI Parameters
HideShow
page
number (optional) Default: 1 Example: 1

ページ

limit
number (optional) Default: 100 Example: 10

最大取得件数

ルーム検索

GET https://example.com/xxxx/places/ScreeningRoom?page=1&limit=10
Responses200400
Headers
Content-Type: application/json
Body
[
  {
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ],
    "address": {
      "en": "English",
      "ja": "日本語"
    },
    "containedInPlace": {
      "branchCode": "xxx"
    },
    "branchCode": "xxx",
    "name": {
      "en": "English",
      "ja": "日本語"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      },
      "address": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "英語"
          },
          "ja": {
            "type": "string",
            "description": "日本語"
          }
        },
        "description": "アドレス"
      },
      "containedInPlace": {
        "type": "object",
        "properties": {
          "branchCode": {
            "type": "string",
            "description": "施設コード"
          }
        },
        "required": [
          "branchCode"
        ],
        "description": "施設"
      },
      "branchCode": {
        "type": "string",
        "description": "コード"
      },
      "name": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "英語"
          },
          "ja": {
            "type": "string",
            "description": "日本語"
          }
        },
        "description": "名称"
      }
    },
    "required": [
      "containedInPlace",
      "branchCode"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

ルーム検索
GET/places/ScreeningRoom{?page,limit}

ルームを検索します。

URI Parameters
HideShow
page
number (optional) Default: 1 Example: 1

ページ

limit
number (optional) Default: 100 Example: 10

最大取得件数

コンテンツ

コンテンツ検索

GET https://example.com/xxxx/creativeWorks/movie?page=1&limit=10&identifierEq=xxxx
Responses200400
Headers
Content-Type: application/json
Body
[
  {
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ],
    "contentRating": "G",
    "datePublished": "2020-01-01T00:00:00Z",
    "headline": "xxx",
    "identifier": "xxx",
    "name": {
      "en": "English",
      "ja": "日本語"
    },
    "thumbnailUrl": "xxx"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      },
      "contentRating": {
        "type": "string",
        "description": "レイティング"
      },
      "datePublished": {
        "type": "string",
        "description": "公開日"
      },
      "headline": {
        "type": "string",
        "description": "サブタイトル"
      },
      "identifier": {
        "type": "string",
        "description": "コード"
      },
      "name": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "英語"
          },
          "ja": {
            "type": "string",
            "description": "日本語"
          }
        },
        "description": "名称"
      },
      "thumbnailUrl": {
        "type": "string",
        "description": "サムネイルURL"
      }
    },
    "required": [
      "identifier"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

コンテンツ検索
GET/creativeWorks/movie{?page,limit,identifierEq}

コンテンツを検索します。ソート順はコード昇順です。

URI Parameters
HideShow
page
number (optional) Default: 1 Example: 1

ページ

limit
number (optional) Default: 100 Example: 10

最大取得件数

identifierEq
string (optional) Example: xxxx

コード(完全一致)

イベント

施設コンテンツ検索

GET https://example.com/xxxx/events/ScreeningEventSeries?page=1&limit=10&locationBranchCode=xxx&workPerformedIdentifier=xxx&startFrom=2021-04-01T00:00:00Z&startThrough=2021-04-01T00:00:00Z&endFrom=2021-04-01T00:00:00Z&endThrough=2021-04-01T00:00:00Z
Responses200400
Headers
Content-Type: application/json
Body
[
  {
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ],
    "id": "xxxxxxxxxxxx",
    "name": {
      "en": "English",
      "ja": "日本語"
    },
    "duration": "PT15M",
    "kanaName": "カナ",
    "endDate": "2021-04-01T00:00:00Z",
    "startDate": "2021-04-01T00:00:00Z",
    "videoFormat": [
      "2D"
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      },
      "id": {
        "type": "string",
        "description": "施設コンテンツID"
      },
      "name": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "英語"
          },
          "ja": {
            "type": "string",
            "description": "日本語"
          }
        },
        "description": "名称"
      },
      "duration": {
        "type": "string",
        "description": "上映時間(https://en.wikipedia.org/wiki/ISO_8601#Durations)"
      },
      "kanaName": {
        "type": "string",
        "description": "カナ名称"
      },
      "endDate": {
        "type": "string",
        "description": "終了日時"
      },
      "startDate": {
        "type": "string",
        "description": "開始日時"
      },
      "videoFormat": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "上映方式"
      }
    },
    "required": [
      "id"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

施設コンテンツ検索
GET/events/ScreeningEventSeries{?page,limit,locationBranchCode,workPerformedIdentifier,startFrom,startThrough,endFrom,endThrough}

施設コンテンツを検索します。ソート順は開始日時昇順です。

URI Parameters
HideShow
page
number (optional) Default: 1 Example: 1

ページ

limit
number (optional) Default: 100 Example: 10

最大取得件数

locationBranchCode
string (optional) Example: xxx

施設コード

workPerformedIdentifier
string (optional) Example: xxx

コンテンツコード

startFrom
string (optional) Example: 2021-04-01T00:00:00Z

開始日時範囲(から)

startThrough
string (optional) Example: 2021-04-01T00:00:00Z

開始日時範囲(まで)

endFrom
string (optional) Example: 2021-04-01T00:00:00Z

終了日時範囲(から)

endThrough
string (optional) Example: 2021-04-01T00:00:00Z

終了日時範囲(まで)

イベント検索

GET https://example.com/xxxx/events/ScreeningEvent?page=1&limit=10&startFrom=2021-04-01T00:00:00Z&startThrough=2021-04-01T00:00:00Z&superEventLocationBranchCode=xxx&superEventWorkPerformedIdentifier=xxx
Responses200400
Headers
Content-Type: application/json
Body
[
  {
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ],
    "doorTime": "2021-04-01T00:00:00Z",
    "endDate": "2021-04-01T00:00:00Z",
    "eventStatus": "xxx",
    "id": "xxxxxxxxxxxx",
    "location": {
      "address": {
        "en": "English",
        "ja": "日本語"
      },
      "branchCode": "xxx",
      "name": {
        "en": "English",
        "ja": "日本語"
      }
    },
    "maximumAttendeeCapacity": 1,
    "name": {
      "en": "English",
      "ja": "日本語"
    },
    "offers": {
      "availabilityStarts": "2021-04-01T00:00:00Z",
      "validFrom": "2021-04-01T00:00:00Z",
      "validThrough": "2021-04-01T00:00:00Z",
      "availabilityStartsToMembers": "2021-04-01T00:00:00Z",
      "validFromForMembers": "2021-04-01T00:00:00Z",
      "validThroughForMembers": "2021-04-01T00:00:00Z"
    },
    "startDate": "2021-04-01T00:00:00Z",
    "superEvent": {
      "id": "xxxxxxxxxxxx",
      "description": {
        "en": "English",
        "ja": "日本語"
      },
      "dubLanguage": {
        "name": "Japanese"
      },
      "subtitleLanguage": {
        "name": "Japanese"
      },
      "kanaName": "カナ"
    },
    "remainingAttendeeCapacity": 1,
    "workPerformed": {
      "identifier": "xxx",
      "contentRating": "G",
      "duration": "PT15M"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      },
      "doorTime": {
        "type": "string",
        "description": "開場日時"
      },
      "endDate": {
        "type": "string",
        "description": "終了日時"
      },
      "eventStatus": {
        "type": "string",
        "description": "イベントステータス"
      },
      "id": {
        "type": "string",
        "description": "イベントID"
      },
      "location": {
        "type": "object",
        "properties": {
          "address": {
            "type": "object",
            "properties": {
              "en": {
                "type": "string",
                "description": "英語"
              },
              "ja": {
                "type": "string",
                "description": "日本語"
              }
            },
            "description": "アドレス"
          },
          "branchCode": {
            "type": "string",
            "description": "ルームコード"
          },
          "name": {
            "type": "object",
            "properties": {
              "en": {
                "type": "string",
                "description": "英語"
              },
              "ja": {
                "type": "string",
                "description": "日本語"
              }
            },
            "description": "名称"
          }
        }
      },
      "maximumAttendeeCapacity": {
        "type": "number",
        "description": "最大収容席数"
      },
      "name": {
        "type": "object",
        "properties": {
          "en": {
            "type": "string",
            "description": "英語"
          },
          "ja": {
            "type": "string",
            "description": "日本語"
          }
        },
        "description": "名称"
      },
      "offers": {
        "type": "object",
        "properties": {
          "availabilityStarts": {
            "type": "string",
            "description": "公開開始日時(非会員オンライン取引)"
          },
          "validFrom": {
            "type": "string",
            "description": "販売開始日時(非会員オンライン取引)"
          },
          "validThrough": {
            "type": "string",
            "description": "販売終了日時(非会員オンライン取引)"
          },
          "availabilityStartsToMembers": {
            "type": "string",
            "description": "公開開始日時(会員オンライン取引)"
          },
          "validFromForMembers": {
            "type": "string",
            "description": "販売開始日時(会員オンライン取引)"
          },
          "validThroughForMembers": {
            "type": "string",
            "description": "販売終了日時(会員オンライン取引)"
          }
        }
      },
      "startDate": {
        "type": "string",
        "description": "開始日時"
      },
      "superEvent": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "施設コンテンツID"
          },
          "description": {
            "type": "object",
            "properties": {
              "en": {
                "type": "string",
                "description": "英語"
              },
              "ja": {
                "type": "string",
                "description": "日本語"
              }
            },
            "description": "補足説明"
          },
          "dubLanguage": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "名称"
              }
            },
            "description": "吹替言語"
          },
          "subtitleLanguage": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "名称"
              }
            },
            "description": "字幕言語"
          },
          "kanaName": {
            "type": "string",
            "description": "カナ名称"
          }
        },
        "required": [
          "id"
        ]
      },
      "remainingAttendeeCapacity": {
        "type": "number",
        "description": "残席数"
      },
      "workPerformed": {
        "type": "object",
        "properties": {
          "identifier": {
            "type": "string",
            "description": "コンテンツコード"
          },
          "contentRating": {
            "type": "string",
            "description": "レイティング"
          },
          "duration": {
            "type": "string",
            "description": "上映時間(https://en.wikipedia.org/wiki/ISO_8601#Durations)"
          }
        },
        "required": [
          "identifier"
        ]
      }
    },
    "required": [
      "id"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

イベント検索
GET/events/ScreeningEvent{?page,limit,startFrom,startThrough,superEventLocationBranchCode,superEventWorkPerformedIdentifier}

イベントを検索します。ソート順は開始日時昇順です。

URI Parameters
HideShow
page
number (optional) Default: 1 Example: 1

ページ

limit
number (optional) Default: 100 Example: 10

最大取得件数

startFrom
string (optional) Example: 2021-04-01T00:00:00Z

開始日時範囲(から)

startThrough
string (optional) Example: 2021-04-01T00:00:00Z

開始日時範囲(まで)

superEventLocationBranchCode
string (optional) Example: xxx

施設コード

superEventWorkPerformedIdentifier
string (optional) Example: xxx

コンテンツコード

イベント座席検索

GET https://example.com/xxxx/events/ScreeningEvent/xxxx/seats?page=1&limit=10
Responses200400
Headers
Content-Type: application/json
Body
[
  {
    "branchCode": "xxx",
    "containedInPlace": {
      "branchCode": "xxx"
    },
    "offers": [
      {
        "availability": "InStock"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "branchCode": {
        "type": "string",
        "description": "座席コード"
      },
      "containedInPlace": {
        "type": "object",
        "properties": {
          "branchCode": {
            "type": "string",
            "description": "セクションコード"
          }
        },
        "required": [
          "branchCode"
        ]
      },
      "offers": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "availability": {
              "type": "string",
              "description": "利用可能性(値については利用可能性タイプを参照)"
            }
          },
          "required": [
            "availability"
          ]
        },
        "description": "オファー"
      }
    },
    "required": [
      "branchCode"
    ]
  }
}
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

イベント座席検索
GET/events/ScreeningEvent/{eventId}/seats{?page,limit}

イベントのルームに含まれるひとつめのセクションの座席とその在庫を検索します。 複数セクションのルームには対応していません。

利用可能性タイプ

値 説明
InStock 在庫あり
OutOfStock 在庫切れ
URI Parameters
HideShow
eventId
string (required) Example: xxxx

イベントID

page
number (optional) Default: 1 Example: 1

ページ

limit
number (optional) Default: 100 Example: 10

最大取得件数

Generated by aglio on 10 Dec 2025