### Install Themeparks API Python Client via Setuptools Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Installs the Python package using Setuptools, typically by running the setup script. This method is useful for local development or when installing from source. ```sh python setup.py install --user ``` -------------------------------- ### Install Themeparks API Python Client via Pip Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Installs the Python package directly from a Git repository using pip. This is a common method for installing packages not yet published to PyPI. ```sh pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git ``` -------------------------------- ### GET /destinations Source: https://github.com/themeparks/themeparks_python/blob/main/docs/DestinationsApi.md Retrieves a comprehensive list of all theme park destinations supported by the API. ```APIDOC ## GET /destinations ### Description Get a list of supported destinations available on the live API. ### Method GET ### Endpoint /destinations ### Parameters This endpoint does not need any parameter. ### Request Example ```python import time import openapi_client from openapi_client.api import destinations_api from openapi_client.model.destinations_response import DestinationsResponse from pprint import pprint configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) with openapi_client.ApiClient() as api_client: api_instance = destinations_api.DestinationsApi(api_client) try: api_response = api_instance.get_destinations() pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling DestinationsApi->get_destinations: %s\n" % e) ``` ### Response #### Success Response (200) - **DestinationsResponse** (DestinationsResponse) - A list of supported destinations. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Destinations using Themeparks API Python Client Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Demonstrates how to initialize the Themeparks API client and fetch a list of supported destinations. It shows error handling for API exceptions. ```python import time import openapi_client from pprint import pprint from openapi_client.api import destinations_api from openapi_client.model.destinations_response import DestinationsResponse # Defining the host is optional and defaults to https://api.themeparks.wiki/v1 # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = destinations_api.DestinationsApi(api_client) try: # Get a list of supported destinations available on the live API api_response = api_instance.get_destinations() pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling DestinationsApi->get_destinations: %s\n" % e) ``` -------------------------------- ### Get Destinations API Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Retrieves a list of supported theme park destinations available on the live API. ```APIDOC ## GET /destinations ### Description Get a list of supported destinations available on the live API. ### Method GET ### Endpoint /destinations ### Parameters ### Request Example (No request body for this GET request) ### Response #### Success Response (200) - **destinations** (array) - A list of destination objects. - **id** (string) - The unique identifier for the destination. - **name** (string) - The name of the destination. - **parks** (array) - A list of parks within the destination. - **id** (string) - The unique identifier for the park. - **name** (string) - The name of the park. #### Response Example ```json { "destinations": [ { "id": "magic-kingdom", "name": "Magic Kingdom", "parks": [ { "id": "mk", "name": "Magic Kingdom" } ] } ] } ``` ``` -------------------------------- ### GET /entity/{entityID}/live Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves live data for an entity and any of its child entities. ```APIDOC ## GET /entity/{entityID}/live ### Description Get live data for this entity and any child entities. ### Method GET ### Endpoint /entity/{entityID}/live ### Parameters #### Path Parameters - **entityID** (str) - Required - Entity ID (or slug) to fetch ### Request Example ```python { "entityID": "entityID_example" } ``` ### Response #### Success Response (200) - **LiveDataResponse** (object) - Contains live operational status and wait times. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Entity Live Data API Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Retrieves live operational data for an entity and its child entities. ```APIDOC ## GET /entity/{entityID}/live ### Description Get live data for this entity and any child entities. ### Method GET ### Endpoint /entity/{entityID}/live ### Parameters #### Path Parameters - **entityID** (string) - Required - The unique identifier for the entity. #### Query Parameters #### Request Body ### Request Example (No request body for this GET request) ### Response #### Success Response (200) - **liveData** (array) - A list of live data objects for the entity and its children. - **id** (string) - The unique identifier for the entity. - **name** (string) - The name of the entity. - **type** (string) - The type of entity. - **queue** (object) - Live queue information. - **standby** (object) - Standby queue details. - **value** (integer) - The current standby wait time in minutes. - **updated** (string) - The timestamp when the data was last updated. - **boardingGroup** (object) - Boarding group information, if applicable. - **status** (string) - The current status of the boarding group (e.g., OPEN, CLOSED). - **callAhead** (string) - Information about call ahead availability. - **returnTime** (object) - Return time information, if applicable. - **value** (string) - The return time. - **type** (string) - The type of return time (e.g., PAID_RETURN_TIME, RETURN_TIME). - **showTimes** (array) - List of upcoming show times. - **time** (string) - The show time. - **status** (string) - The status of the show (e.g., "Showtime", "Canceled"). #### Response Example ```json { "liveData": [ { "id": "mk-5", "name": "Seven Dwarfs Mine Train", "type": "ATTRACTION", "queue": { "standby": { "value": 60, "updated": "2023-10-27T10:30:00Z" } } }, { "id": "mk-1", "name": "Walt Disney's Carousel of Progress", "type": "ATTRACTION", "queue": { "standby": { "value": 5, "updated": "2023-10-27T10:31:00Z" } } } ] } ``` ``` -------------------------------- ### Get Supported Destinations (Python) Source: https://github.com/themeparks/themeparks_python/blob/main/docs/DestinationsApi.md Retrieves a list of all supported theme park destinations from the themeparks.wiki API. This method requires no parameters and returns a DestinationsResponse object. It demonstrates basic API client instantiation and error handling. ```python import time import openapi_client from openapi_client.api import destinations_api from openapi_client.model.destinations_response import DestinationsResponse from pprint import pprint configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) with openapi_client.ApiClient() as api_client: api_instance = destinations_api.DestinationsApi(api_client) try: api_response = api_instance.get_destinations() pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling DestinationsApi->get_destinations: %s\n" % e) ``` -------------------------------- ### Get Entity Schedule by Year and Month API Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Retrieves the schedule for a specific entity for a given month and year. ```APIDOC ## GET /entity/{entityID}/schedule/{year}/{month} ### Description Get entity schedule for a specific month and year. ### Method GET ### Endpoint /entity/{entityID}/schedule/{year}/{month} ### Parameters #### Path Parameters - **entityID** (string) - Required - The unique identifier for the entity. - **year** (integer) - Required - The year for which to retrieve the schedule. - **month** (integer) - Required - The month for which to retrieve the schedule (1-12). #### Query Parameters #### Request Body ### Request Example (No request body for this GET request) ### Response #### Success Response (200) - **schedule** (array) - A list of schedule entries for the specified month and year. - **date** (string) - The date of the schedule entry (YYYY-MM-DD). - **type** (string) - The type of schedule entry (e.g., "OPERATIONAL", "SHOW"). - **openingTime** (string) - The opening time for the entity on this date. - **closingTime** (string) - The closing time for the entity on this date. - **specialHours** (string) - Any special hours information. - **showTimes** (array) - A list of show times for this date. - **time** (string) - The time of the show. - **name** (string) - The name of the show. - **type** (string) - The type of show. - **status** (string) - The status of the show. #### Response Example ```json { "schedule": [ { "date": "2023-11-15", "type": "OPERATIONAL", "openingTime": "08:30", "closingTime": "20:00" }, { "date": "2023-11-16", "type": "OPERATIONAL", "openingTime": "09:00", "closingTime": "21:00", "showTimes": [ { "time": "15:00", "name": "Mickey's Once Upon a Christmastime Parade", "type": "Parade", "status": "Scheduled" } ] } ] } ``` ``` -------------------------------- ### GET /entity/{entityID}/schedule Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves the schedule for a given entity. ```APIDOC ## GET /entity/{entityID}/schedule ### Description Get entity schedule. ### Method GET ### Endpoint /entity/{entityID}/schedule ### Parameters #### Path Parameters - **entityID** (str) - Required - Entity ID (or slug) to fetch ### Request Example ```python { "entityID": "entityID_example" } ``` ### Response #### Success Response (200) - **ScheduleResponse** (object) - Contains the operating schedule for the entity. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Entity Live Data (Python) Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Fetches live operational data, such as queue times and event schedules, for a specified theme park entity and its child entities. Requires the 'openapi-client' library. ```python import time import openapi_client from openapi_client.api import entities_api from openapi_client.model.entity_live_data_response import EntityLiveDataResponse from pprint import pprint # Defining the host is optional and defaults to https://api.themeparks.wiki/v1 # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) # Enter a context with an instance of the API client with openapi_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) entity_id = "entityID_example" # str | Entity ID (or slug) to fetch # example passing only required values which don't have defaults set try: # Get live data for this entity and any child entities api_response = api_instance.get_entity_live_data(entity_id) pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling EntitiesApi->get_entity_live_data: %s\n" % e) ``` -------------------------------- ### GET /entity/{entityID}/schedule/{year}/{month} Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves the entity's schedule for a specific month and year. ```APIDOC ## GET /entity/{entityID}/schedule/{year}/{month} ### Description Get entity schedule for a specific month and year. ### Method GET ### Endpoint /entity/{entityID}/schedule/{year}/{month} ### Parameters #### Path Parameters - **entityID** (str) - Required - Entity ID (or slug) to fetch - **year** (int) - Required - The year for the schedule lookup - **month** (int) - Required - The month for the schedule lookup (1-12) ### Request Example ```python { "entityID": "entityID_example", "year": 2023, "month": 10 } ``` ### Response #### Success Response (200) - **ScheduleResponse** (object) - Contains the operating schedule for the specified month and year. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Entity Schedule by Year and Month (Python) Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Fetches the entity schedule for a specific month and year using the Themeparks API. Requires an initialized API client, entity ID, year, and month as input. Handles potential API exceptions. ```python import openapi_client from openapi_client import entities_api from pprint import pprint # Enter a context with an instance of the API client with openapi_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) entity_id = "entityID_example" # str | Entity ID (or slug) to fetch year = 3.14 # float | Schedule year to fetch month = 3.14 # float | Schedule month to fetch. Must be a two digit zero-padded month. # example passing only required values which don't have defaults set try: # Get entity schedule for a specific month and year api_response = api_instance.get_entity_schedule_year_month(entity_id, year, month) pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling EntitiesApi->get_entity_schedule_year_month: %s\n" % e) ``` -------------------------------- ### Get Entity Document (Python) Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Fetches the complete data document for a specified entity using its ID or slug. Requires the openapi_client library. ```python import time import openapi_client from openapi_client.api import entities_api from openapi_client.model.entity_data import EntityData from pprint import pprint # Defining the host is optional and defaults to https://api.themeparks.wiki/v1 # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) # Enter a context with an instance of the API client with openapi_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) entity_id = "entityID_example" # str | Entity ID (or slug) to fetch # example passing only required values which don't have defaults set try: # Get entity document api_response = api_instance.get_entity(entity_id) pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling EntitiesApi->get_entity: %s\n" % e) ``` -------------------------------- ### GET /entity/{entityID} Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves the full data document for a given entity using its ID or slug. ```APIDOC ## GET /entity/{entityID} ### Description Get the full data document for a given entity. You can supply either a GUID or slug string. ### Method GET ### Endpoint /entity/{entityID} ### Parameters #### Path Parameters - **entityID** (str) - Required - Entity ID (or slug) to fetch ### Request Example ```python { "entityID": "entityID_example" } ``` ### Response #### Success Response (200) - **EntityData** (object) - Detailed entity information. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /entities/{entity_id}/schedule/{year}/{month} Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves the schedule for a specific entity for a given month and year. ```APIDOC ## GET /entities/{entity_id}/schedule/{year}/{month} ### Description Retrieves the schedule for a specific entity for a given month and year. ### Method GET ### Endpoint /entities/{entity_id}/schedule/{year}/{month} ### Parameters #### Path Parameters - **entity_id** (str) - Required - Entity ID (or slug) to fetch - **year** (float) - Required - Schedule year to fetch - **month** (float) - Required - Schedule month to fetch. Must be a two digit zero-padded month. ### Request Example ```json { "entity_id": "entityID_example", "year": 3.14, "month": 3.14 } ``` ### Response #### Success Response (200) - **EntityScheduleResponse** (object) - Details of the entity's schedule #### Response Example ```json { "example": "response body" } ``` ### Authorization No authorization required ### HTTP request headers - **Accept**: application/json ``` -------------------------------- ### GET /entities/{entity_id}/schedule Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Fetches the upcoming schedule for a given entity for the next 30 days. ```APIDOC ## GET /entities/{entity_id}/schedule ### Description Get entity schedule. Fetch this entity's schedule for the next 30 days. ### Method GET ### Endpoint /entities/{entity_id}/schedule ### Parameters #### Path Parameters - **entity_id** (str) - Required - Entity ID (or slug) to fetch ### Response #### Success Response (200) - **EntityScheduleResponse** - The schedule information for the entity. #### Response Example { "example": "response body" } ``` -------------------------------- ### Get Entity API Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Retrieves detailed information about a specific entity (e.g., park, attraction) using its unique ID. ```APIDOC ## GET /entity/{entityID} ### Description Get entity document. ### Method GET ### Endpoint /entity/{entityID} ### Parameters #### Path Parameters - **entityID** (string) - Required - The unique identifier for the entity. #### Query Parameters #### Request Body ### Request Example (No request body for this GET request) ### Response #### Success Response (200) - **entity** (object) - The entity document containing details about the park or attraction. - **id** (string) - The unique identifier for the entity. - **name** (string) - The name of the entity. - **type** (string) - The type of entity (e.g., PARK, LAND, ATTRACTION). - **parent** (string) - The ID of the parent entity, if applicable. - **timezone** (string) - The timezone of the entity's location. - **location** (object) - Geographical coordinates. - **latitude** (number) - The latitude. - **longitude** (number) - The longitude. - **links** (array) - Links to related resources. #### Response Example ```json { "entity": { "id": "mk-5", "name": "Seven Dwarfs Mine Train", "type": "ATTRACTION", "parent": "mk", "timezone": "America/New_York", "location": { "latitude": 28.4003, "longitude": -81.5795 }, "links": [ { "rel": "self", "href": "https://api.themeparks.wiki/v1/entity/mk-5" } ] } } ``` ``` -------------------------------- ### Get Entity Children API Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Retrieves all child entities for a given entity document (e.g., attractions within a park). ```APIDOC ## GET /entity/{entityID}/children ### Description Get all children for a given entity document. ### Method GET ### Endpoint /entity/{entityID}/children ### Parameters #### Path Parameters - **entityID** (string) - Required - The unique identifier for the parent entity. #### Query Parameters #### Request Body ### Request Example (No request body for this GET request) ### Response #### Success Response (200) - **children** (array) - A list of child entity objects. - **id** (string) - The unique identifier for the child entity. - **name** (string) - The name of the child entity. - **type** (string) - The type of the child entity. #### Response Example ```json { "children": [ { "id": "mk-5", "name": "Seven Dwarfs Mine Train", "type": "ATTRACTION" }, { "id": "mk-1", "name": "Walt Disney's Carousel of Progress", "type": "ATTRACTION" } ] } ``` ``` -------------------------------- ### GET /entities/{entity_id}/live Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves live data for a specific entity and its child entities. This includes information such as queue times and event schedules. ```APIDOC ## GET /entities/{entity_id}/live ### Description Get live data for this entity and any child entities. Fetch this entity's live data (queue times, parade times, etc.) as well as all child entities. For a destination, this will include all parks within that destination. ### Method GET ### Endpoint /entities/{entity_id}/live ### Parameters #### Path Parameters - **entity_id** (str) - Required - Entity ID (or slug) to fetch ### Response #### Success Response (200) - **EntityLiveDataResponse** - Detailed live data for the entity and its children. #### Response Example { "example": "response body" } ``` -------------------------------- ### GET /entities/{entity_id}/schedule/{year}/{month} Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves the entity's schedule for a specific month and year. ```APIDOC ## GET /entities/{entity_id}/schedule/{year}/{month} ### Description Get entity schedule for a specific month and year. Fetch this entity's schedule for the supplied year and month. ### Method GET ### Endpoint /entities/{entity_id}/schedule/{year}/{month} ### Parameters #### Path Parameters - **entity_id** (str) - Required - Entity ID (or slug) to fetch - **year** (int) - Required - The year for the schedule - **month** (int) - Required - The month for the schedule ### Response #### Success Response (200) - **EntityScheduleResponse** - The schedule information for the specified month and year. #### Response Example { "example": "response body" } ``` -------------------------------- ### Get Entity Schedule - Upcoming (Python) Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves the operational schedule for a theme park entity for the next 30 days. This function requires the 'openapi-client' library. ```python import time import openapi_client from openapi_client.api import entities_api from openapi_client.model.entity_schedule_response import EntityScheduleResponse from pprint import pprint # Defining the host is optional and defaults to https://api.themeparks.wiki/v1 # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) # Enter a context with an instance of the API client with openapi_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) entity_id = "entityID_example" # str | Entity ID (or slug) to fetch # example passing only required values which don't have defaults set try: # Get entity schedule api_response = api_instance.get_entity_schedule_upcoming(entity_id) pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling EntitiesApi->get_entity_schedule_upcoming: %s\n" % e) ``` -------------------------------- ### GET /entity/{entityID}/children Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Fetches a list of all children belonging to a specific entity, including recursive data. ```APIDOC ## GET /entity/{entityID}/children ### Description Get all children for a given entity document. Fetch a list of all the children that belong to this entity. This is recursive, so a destination will return all parks and all rides within those parks. ### Method GET ### Endpoint /entity/{entityID}/children ### Parameters #### Path Parameters - **entityID** (str) - Required - Entity ID (or slug) to fetch ### Request Example ```python { "entityID": "entityID_example" } ``` ### Response #### Success Response (200) - **EntityChildrenResponse** (object) - A response object containing a list of child entities. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Entity Schedule Upcoming API Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Retrieves the upcoming schedule for a specific entity, including park hours and show times. ```APIDOC ## GET /entity/{entityID}/schedule ### Description Get entity schedule. ### Method GET ### Endpoint /entity/{entityID}/schedule ### Parameters #### Path Parameters - **entityID** (string) - Required - The unique identifier for the entity. #### Query Parameters #### Request Body ### Request Example (No request body for this GET request) ### Response #### Success Response (200) - **schedule** (array) - A list of schedule entries. - **date** (string) - The date of the schedule entry (YYYY-MM-DD). - **type** (string) - The type of schedule entry (e.g., "OPERATIONAL", "SHOW"). - **openingTime** (string) - The opening time for the entity on this date. - **closingTime** (string) - The closing time for the entity on this date. - **specialHours** (string) - Any special hours information. - **showTimes** (array) - A list of show times for this date. - **time** (string) - The time of the show. - **name** (string) - The name of the show. - **type** (string) - The type of show. - **status** (string) - The status of the show. #### Response Example ```json { "schedule": [ { "date": "2023-10-27", "type": "OPERATIONAL", "openingTime": "09:00", "closingTime": "21:00", "showTimes": [ { "time": "11:00", "name": "Festival of Fantasy Parade", "type": "Parade", "status": "Scheduled" }, { "time": "20:00", "name": "Happily Ever After", "type": "Fireworks", "status": "Scheduled" } ] } ] } ``` ``` -------------------------------- ### Get Entity Schedule - Specific Month (Python) Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Fetches the operational schedule for a given theme park entity for a specific month and year. This method utilizes the 'openapi-client' library and requires the entity ID, year, and month as parameters. ```python import time import openapi_client from openapi_client.api import entities_api from openapi_client.model.entity_schedule_response import EntityScheduleResponse from pprint import pprint # Defining the host is optional and defaults to https://api.themeparks.wiki/v1 # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) # Enter a context with an instance of the API client with openapi_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) entity_id = "entityID_example" # str | Entity ID (or slug) to fetch year = 2023 # int | Year to fetch schedule for month = 10 # int | Month to fetch schedule for # example passing only required values which don't have defaults set try: # Get entity schedule for a specific month and year api_response = api_instance.get_entity_schedule_year_month(entity_id, year, month) pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling EntitiesApi->get_entity_schedule_year_month: %s\n" % e) ``` -------------------------------- ### Get Entity Children (Python) Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntitiesApi.md Retrieves a recursive list of all child entities belonging to a given entity. This function requires the openapi_client library and is useful for exploring hierarchical data within the ThemeParks API. ```python import time import openapi_client from openapi_client.api import entities_api from openapi_client.model.entity_children_response import EntityChildrenResponse from pprint import pprint # Defining the host is optional and defaults to https://api.themeparks.wiki/v1 # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( host = "https://api.themeparks.wiki/v1" ) # Enter a context with an instance of the API client with openapi_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) entity_id = "entityID_example" # str | Entity ID (or slug) to fetch # example passing only required values which don't have defaults set try: # Get all children for a given entity document api_response = api_instance.get_entity_children(entity_id) pprint(api_response) except openapi_client.ApiException as e: print("Exception when calling EntitiesApi->get_entity_children: %s\n" % e) ``` -------------------------------- ### ScheduleEntry Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/ScheduleEntry.md Details the properties of the ScheduleEntry model, including date, opening and closing times, and type. ```APIDOC ## ScheduleEntry Model ### Description Represents a schedule entry for a theme park, including date, opening and closing times, and event type. ### Properties #### date - **type**: str - **description**: The date of the schedule entry. #### opening_time - **type**: datetime - **description**: The opening time for the schedule entry. #### closing_time - **type**: datetime - **description**: The closing time for the schedule entry. #### type - **type**: str - **description**: The type of the schedule entry (e.g., 'Operating', 'Event'). #### any string name - **type**: bool, date, datetime, dict, float, int, list, str, none_type - **description**: Allows for any string key with a value of the specified types. This property is optional. - **optional**: true ``` -------------------------------- ### DestinationParkEntry Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/DestinationParkEntry.md Details the properties of the DestinationParkEntry model. ```APIDOC ## DestinationParkEntry Model ### Description Represents an entry for a destination park, with optional fields for ID and name, and the ability to include custom string-keyed properties. ### Properties #### Path Parameters * None #### Query Parameters * None #### Request Body * **id** (str) - Optional - The unique identifier for the park entry. * **name** (str) - Optional - The name of the park entry. * **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Optional - Allows any string as a key, with the value conforming to the specified types. This enables flexible data representation. ### Request Example ```json { "id": "park-123", "name": "Magic Kingdom", "capacity": 10000, "opening_time": "09:00:00" } ``` ### Response #### Success Response (200) * **id** (str) - The unique identifier for the park entry. * **name** (str) - The name of the park entry. * **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Any string-keyed property with its corresponding value. #### Response Example ```json { "id": "park-123", "name": "Magic Kingdom", "capacity": 10000, "opening_time": "09:00:00" } ``` ``` -------------------------------- ### DestinationEntry Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/DestinationEntry.md Defines the structure of a DestinationEntry, including its properties and their types. ```APIDOC ## DestinationEntry ### Description Represents a destination entry, which can include multiple theme parks. ### Properties #### Path Parameters * None #### Query Parameters * None #### Request Body * **id** (str) - Optional - The unique identifier for the destination. * **name** (str) - Optional - The name of the destination. * **slug** (str) - Optional - A URL-friendly identifier for the destination. * **parks** (list[DestinationParkEntry]) - Optional - A list of theme parks associated with this destination. * **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Optional - Allows any string key with a value of the specified types. ### Request Example ```json { "id": "disneyland-resort", "name": "Disneyland Resort", "slug": "disneyland-resort", "parks": [ { "id": "disneyland", "name": "Disneyland Park", "slug": "disneyland" }, { "id": "disney-california-adventure", "name": "Disney California Adventure Park", "slug": "disney-california-adventure" } ], "additional_info": "A magical place!" } ``` ### Response #### Success Response (200) * **id** (str) - The unique identifier for the destination. * **name** (str) - The name of the destination. * **slug** (str) - A URL-friendly identifier for the destination. * **parks** (list[DestinationParkEntry]) - A list of theme parks associated with this destination. * **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Additional properties with string keys and values of various types. #### Response Example ```json { "id": "disneyland-resort", "name": "Disneyland Resort", "slug": "disneyland-resort", "parks": [ { "id": "disneyland", "name": "Disneyland Park", "slug": "disneyland" }, { "id": "disney-california-adventure", "name": "Disney California Adventure Park", "slug": "disney-california-adventure" } ], "established": 1955 } ``` ``` -------------------------------- ### DestinationsResponse Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/DestinationsResponse.md Details the structure and properties of the DestinationsResponse object. ```APIDOC ## DestinationsResponse ### Description Represents the response containing a list of destinations and flexible additional properties. ### Properties #### destinations - **destinations** (list[DestinationEntry]) - Optional - A list of DestinationEntry objects. #### any string name - **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Optional - Allows any string key with a value of the specified types. ### Request Example ```json { "destinations": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Magic Kingdom", "latitude": 28.4194, "longitude": -81.5812 } ], "example_property": "example_value" } ``` ### Response Example ```json { "destinations": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Magic Kingdom", "latitude": 28.4194, "longitude": -81.5812 } ], "another_example": 123 } ``` ``` -------------------------------- ### EntityLiveData Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntityLiveData.md Details the properties of the EntityLiveData model. ```APIDOC ## EntityLiveData ### Description Represents live data for an entity. ### Properties - **id** (str) - Unique identifier for the entity. - **name** (str) - The name of the entity. - **entity_type** (EntityType) - The type of the entity. See [EntityType](EntityType.md). - **last_updated** (datetime) - The timestamp when the entity's data was last updated. - **status** (LiveStatusType) - The live status of the entity. See [LiveStatusType](LiveStatusType.md). [optional] - **queue** (LiveQueue) - Live queue information for the entity. See [LiveQueue](LiveQueue.md). [optional] - **showtimes** (List[LiveShowTime]) - A list of live showtimes for the entity. See [LiveShowTime](LiveShowTime.md). [optional] - **operating_hours** (List[LiveShowTime]) - A list of operating hours for the entity. See [LiveShowTime](LiveShowTime.md). [optional] - **any string name** (bool, date, datetime, dict, float, int, list, str, NoneType) - Any string key with a value of the specified types. [optional] ``` -------------------------------- ### Specific Imports for OpenAPI Python Client Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Demonstrates how to perform specific imports for APIs and models to avoid potential RecursionError with large OpenAPI client libraries. This approach targets individual components rather than importing everything at once. ```python from openapi_client.api.default_api import DefaultApi from openapi_client.model.pet import Pet ``` -------------------------------- ### PriceData Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/PriceData.md Details the structure of the PriceData model, including amount, currency, and flexible string-keyed properties. ```APIDOC ## PriceData Model ### Description This model represents pricing information, including the monetary amount and currency. It also allows for additional string-keyed properties with various data types. ### Properties #### amount - **amount** (float) - Optional - The monetary value. #### currency - **currency** (str) - Optional - The currency code (e.g., 'USD', 'EUR'). #### any string name - **any string name** (bool, date, datetime, dict, float, int, list, str, None) - Optional - Any string can be used as a key, but the value must be of the correct type. ### Request Example ```json { "amount": 100.50, "currency": "USD", "discount_applied": true, "valid_until": "2024-12-31" } ``` ### Response Example ```json { "amount": 100.50, "currency": "USD", "discount_applied": true, "valid_until": "2024-12-31" } ``` ``` -------------------------------- ### EntityScheduleResponse Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntityScheduleResponse.md Details the properties of the EntityScheduleResponse, including ID, name, entity type, timezone, and schedule. ```APIDOC ## EntityScheduleResponse ### Description Represents the response structure for an entity's schedule, containing identification details and the schedule itself. ### Properties #### id - **Type**: str - **Description**: - **Notes**: [optional] #### name - **Type**: str - **Description**: - **Notes**: [optional] #### entity_type - **Type**: EntityType - **Description**: Reference to the EntityType model. - **Notes**: [optional] #### timezone - **Type**: str - **Description**: - **Notes**: [optional] #### schedule - **Type**: List[ScheduleEntry] - **Description**: A list of schedule entries. - **Notes**: [optional] #### any string name - **Type**: bool, date, datetime, dict, float, int, list, str, None - **Description**: Any string key can be used, but the value must be of the correct type. - **Notes**: [optional] ``` -------------------------------- ### LiveQueue Properties Source: https://github.com/themeparks/themeparks_python/blob/main/docs/LiveQueue.md Details the properties available for the LiveQueue API, including standby, single_rider, return_time, paid_return_time, and boarding_group. It also supports custom string properties with various data types. ```APIDOC ## LiveQueue Object ### Description Represents the live queue status for a theme park attraction, including different waitlist types and times. ### Properties - **standby** (LiveQueueSTANDBY) - Optional - Represents the standby queue status. - **single_rider** (LiveQueueSTANDBY) - Optional - Represents the single rider queue status. - **return_time** (LiveQueueRETURNTIME) - Optional - Represents the return time for the queue. - **paid_return_time** (LiveQueuePAIDRETURNTIME) - Optional - Represents the paid return time for the queue. - **boarding_group** (LiveQueueBOARDINGGROUP) - Optional - Represents the boarding group status. - **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Optional - Allows for custom string-keyed properties with specified data types. ``` -------------------------------- ### EntityChildrenResponse Model Source: https://github.com/themeparks/themeparks_python/blob/main/docs/EntityChildrenResponse.md Details of the EntityChildrenResponse model including its properties and their types. ```APIDOC ## EntityChildrenResponse ### Description Represents a response containing child entities, including their details and a list of their own children. ### Properties #### Properties - **id** (str) - Optional - The unique identifier for the entity. - **name** (str) - Optional - The name of the entity. - **entity_type** (EntityType) - Optional - The type of the entity, referencing the EntityType model. - **timezone** (str) - Optional - The timezone associated with the entity. - **children** ([EntityChild]) - Optional - A list of child entities, each referencing the EntityChild model. - **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Optional - Allows for any string key with a value of specified types. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) ``` -------------------------------- ### TagData Model Properties Source: https://github.com/themeparks/themeparks_python/blob/main/docs/TagData.md Describes the properties available in the TagData model, including their types and optionality. ```APIDOC ## TagData Model ### Description Represents data associated with a tag, including its name, ID, and a value. ### Properties - **tag** (str) - The tag identifier. - **tag_name** (str) - The name of the tag. - **id** (str) - Optional. The unique identifier for the tag data entry. - **value** (bool, date, datetime, dict, float, int, list, str, none_type) - Optional. The value associated with the tag. Can be of various types. - **any string name** (bool, date, datetime, dict, float, int, list, str, none_type) - Optional. Any string can be used as a property name, provided the value adheres to the correct type. ``` -------------------------------- ### Adjusting Recursion Limit for OpenAPI Python Client Source: https://github.com/themeparks/themeparks_python/blob/main/README.md Shows how to increase the maximum recursion limit in Python before importing the OpenAPI client library. This is a workaround for RecursionError issues that arise with very large OpenAPI specifications. ```python import sys sys.setrecursionlimit(1500) import openapi_client from openapi_client.apis import * from openapi_client.models import * ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.