Module python_odpt.api.default.train_information_operations_get_train_information

Functions

async def asyncio(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>,
odptrailway: Unset | str = <python_odpt.types.Unset object>) ‑> Any | List[TrainInformation] | None

Expand source code

async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    owlsame_as: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
    odptrailway: Union[Unset, str] = UNSET,
) -> Optional[Union[Any, List["TrainInformation"]]]:
    """列車運行情報を取得する

    Args:
        aclconsumer_key (str): アクセストークン
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptrailway (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Union[Any, List['TrainInformation']]
    """

    return (
        await asyncio_detailed(
            client=client,
            aclconsumer_key=aclconsumer_key,
            owlsame_as=owlsame_as,
            odptoperator=odptoperator,
            odptrailway=odptrailway,
        )
    ).parsed

列車運行情報を取得する

Args

aclconsumer_key : str

アクセストークン

owlsame_as : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptoperator : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptrailway : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Union[Any, List['TrainInformation']]

async def asyncio_detailed(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>,
odptrailway: Unset | str = <python_odpt.types.Unset object>) ‑> Response[Any | List[TrainInformation]]

Expand source code

async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    owlsame_as: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
    odptrailway: Union[Unset, str] = UNSET,
) -> Response[Union[Any, List["TrainInformation"]]]:
    """列車運行情報を取得する

    Args:
        aclconsumer_key (str): アクセストークン
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptrailway (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[Union[Any, List['TrainInformation']]]
    """

    kwargs = _get_kwargs(
        aclconsumer_key=aclconsumer_key,
        owlsame_as=owlsame_as,
        odptoperator=odptoperator,
        odptrailway=odptrailway,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

列車運行情報を取得する

Args

aclconsumer_key : str

アクセストークン

owlsame_as : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptoperator : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptrailway : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Response[Union[Any, List['TrainInformation']]]

def sync(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>,
odptrailway: Unset | str = <python_odpt.types.Unset object>) ‑> Any | List[TrainInformation] | None

Expand source code

def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    owlsame_as: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
    odptrailway: Union[Unset, str] = UNSET,
) -> Optional[Union[Any, List["TrainInformation"]]]:
    """列車運行情報を取得する

    Args:
        aclconsumer_key (str): アクセストークン
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptrailway (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Union[Any, List['TrainInformation']]
    """

    return sync_detailed(
        client=client,
        aclconsumer_key=aclconsumer_key,
        owlsame_as=owlsame_as,
        odptoperator=odptoperator,
        odptrailway=odptrailway,
    ).parsed

列車運行情報を取得する

Args

aclconsumer_key : str

アクセストークン

owlsame_as : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptoperator : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptrailway : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Union[Any, List['TrainInformation']]

def sync_detailed(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>,
odptrailway: Unset | str = <python_odpt.types.Unset object>) ‑> Response[Any | List[TrainInformation]]

Expand source code

def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    owlsame_as: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
    odptrailway: Union[Unset, str] = UNSET,
) -> Response[Union[Any, List["TrainInformation"]]]:
    """列車運行情報を取得する

    Args:
        aclconsumer_key (str): アクセストークン
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptrailway (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[Union[Any, List['TrainInformation']]]
    """

    kwargs = _get_kwargs(
        aclconsumer_key=aclconsumer_key,
        owlsame_as=owlsame_as,
        odptoperator=odptoperator,
        odptrailway=odptrailway,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)

列車運行情報を取得する

Args

aclconsumer_key : str

アクセストークン

owlsame_as : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptoperator : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

odptrailway : Union[Unset, str]

固有識別子の別名 多くがodpt.hoge:fuga形式

Raises

errors.UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

httpx.TimeoutException

If the request takes longer than Client.timeout.

Returns

Response[Union[Any, List['TrainInformation']]]