Module `python_odpt.api.default.train_operations_get_trains`

Functions

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[typing.Any]

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[Any]:
    """列車情報(列車の位置情報)を取得する

    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[Any]
    """

    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[Any]

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[typing.Any]