Module python_odpt.api.default.busstop_pole_operations_get_busstop_poles

Functions

async def asyncio(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
id: Unset | str = <python_odpt.types.Unset object>,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
dctitle: Unset | str = <python_odpt.types.Unset object>,
odptbusstop_pole_number: Unset | str = <python_odpt.types.Unset object>,
odptplatform_number: Unset | str = <python_odpt.types.Unset object>,
odptbusroute_pattern: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>) ‑> Any | List[BusstopPole] | None

Expand source code

async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    id: Union[Unset, str] = UNSET,
    owlsame_as: Union[Unset, str] = UNSET,
    dctitle: Union[Unset, str] = UNSET,
    odptbusstop_pole_number: Union[Unset, str] = UNSET,
    odptplatform_number: Union[Unset, str] = UNSET,
    odptbusroute_pattern: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
) -> Optional[Union[Any, List["BusstopPole"]]]:
    """バス停情報

    Args:
        aclconsumer_key (str): アクセストークン
        id (Union[Unset, str]): 固有識別子
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        dctitle (Union[Unset, str]):
        odptbusstop_pole_number (Union[Unset, str]):
        odptplatform_number (Union[Unset, str]):
        odptbusroute_pattern (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (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['BusstopPole']]
    """

    return (
        await asyncio_detailed(
            client=client,
            aclconsumer_key=aclconsumer_key,
            id=id,
            owlsame_as=owlsame_as,
            dctitle=dctitle,
            odptbusstop_pole_number=odptbusstop_pole_number,
            odptplatform_number=odptplatform_number,
            odptbusroute_pattern=odptbusroute_pattern,
            odptoperator=odptoperator,
        )
    ).parsed

バス停情報

Args

aclconsumer_key : str

アクセストークン

id : Union[Unset, str]

固有識別子

owlsame_as : Union[Unset, str]

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

dctitle (Union[Unset, str]):

odptbusstop_pole_number (Union[Unset, str]):

odptplatform_number (Union[Unset, str]):

odptbusroute_pattern : Union[Unset, str]

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

odptoperator : 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['BusstopPole']]

async def asyncio_detailed(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
id: Unset | str = <python_odpt.types.Unset object>,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
dctitle: Unset | str = <python_odpt.types.Unset object>,
odptbusstop_pole_number: Unset | str = <python_odpt.types.Unset object>,
odptplatform_number: Unset | str = <python_odpt.types.Unset object>,
odptbusroute_pattern: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>) ‑> Response[Any | List[BusstopPole]]

Expand source code

async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    id: Union[Unset, str] = UNSET,
    owlsame_as: Union[Unset, str] = UNSET,
    dctitle: Union[Unset, str] = UNSET,
    odptbusstop_pole_number: Union[Unset, str] = UNSET,
    odptplatform_number: Union[Unset, str] = UNSET,
    odptbusroute_pattern: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
) -> Response[Union[Any, List["BusstopPole"]]]:
    """バス停情報

    Args:
        aclconsumer_key (str): アクセストークン
        id (Union[Unset, str]): 固有識別子
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        dctitle (Union[Unset, str]):
        odptbusstop_pole_number (Union[Unset, str]):
        odptplatform_number (Union[Unset, str]):
        odptbusroute_pattern (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (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['BusstopPole']]]
    """

    kwargs = _get_kwargs(
        aclconsumer_key=aclconsumer_key,
        id=id,
        owlsame_as=owlsame_as,
        dctitle=dctitle,
        odptbusstop_pole_number=odptbusstop_pole_number,
        odptplatform_number=odptplatform_number,
        odptbusroute_pattern=odptbusroute_pattern,
        odptoperator=odptoperator,
    )

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

    return _build_response(client=client, response=response)

バス停情報

Args

aclconsumer_key : str

アクセストークン

id : Union[Unset, str]

固有識別子

owlsame_as : Union[Unset, str]

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

dctitle (Union[Unset, str]):

odptbusstop_pole_number (Union[Unset, str]):

odptplatform_number (Union[Unset, str]):

odptbusroute_pattern : Union[Unset, str]

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

odptoperator : 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['BusstopPole']]]

def sync(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
id: Unset | str = <python_odpt.types.Unset object>,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
dctitle: Unset | str = <python_odpt.types.Unset object>,
odptbusstop_pole_number: Unset | str = <python_odpt.types.Unset object>,
odptplatform_number: Unset | str = <python_odpt.types.Unset object>,
odptbusroute_pattern: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>) ‑> Any | List[BusstopPole] | None

Expand source code

def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    id: Union[Unset, str] = UNSET,
    owlsame_as: Union[Unset, str] = UNSET,
    dctitle: Union[Unset, str] = UNSET,
    odptbusstop_pole_number: Union[Unset, str] = UNSET,
    odptplatform_number: Union[Unset, str] = UNSET,
    odptbusroute_pattern: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
) -> Optional[Union[Any, List["BusstopPole"]]]:
    """バス停情報

    Args:
        aclconsumer_key (str): アクセストークン
        id (Union[Unset, str]): 固有識別子
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        dctitle (Union[Unset, str]):
        odptbusstop_pole_number (Union[Unset, str]):
        odptplatform_number (Union[Unset, str]):
        odptbusroute_pattern (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (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['BusstopPole']]
    """

    return sync_detailed(
        client=client,
        aclconsumer_key=aclconsumer_key,
        id=id,
        owlsame_as=owlsame_as,
        dctitle=dctitle,
        odptbusstop_pole_number=odptbusstop_pole_number,
        odptplatform_number=odptplatform_number,
        odptbusroute_pattern=odptbusroute_pattern,
        odptoperator=odptoperator,
    ).parsed

バス停情報

Args

aclconsumer_key : str

アクセストークン

id : Union[Unset, str]

固有識別子

owlsame_as : Union[Unset, str]

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

dctitle (Union[Unset, str]):

odptbusstop_pole_number (Union[Unset, str]):

odptplatform_number (Union[Unset, str]):

odptbusroute_pattern : Union[Unset, str]

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

odptoperator : 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['BusstopPole']]

def sync_detailed(*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
id: Unset | str = <python_odpt.types.Unset object>,
owlsame_as: Unset | str = <python_odpt.types.Unset object>,
dctitle: Unset | str = <python_odpt.types.Unset object>,
odptbusstop_pole_number: Unset | str = <python_odpt.types.Unset object>,
odptplatform_number: Unset | str = <python_odpt.types.Unset object>,
odptbusroute_pattern: Unset | str = <python_odpt.types.Unset object>,
odptoperator: Unset | str = <python_odpt.types.Unset object>) ‑> Response[Any | List[BusstopPole]]

Expand source code

def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    id: Union[Unset, str] = UNSET,
    owlsame_as: Union[Unset, str] = UNSET,
    dctitle: Union[Unset, str] = UNSET,
    odptbusstop_pole_number: Union[Unset, str] = UNSET,
    odptplatform_number: Union[Unset, str] = UNSET,
    odptbusroute_pattern: Union[Unset, str] = UNSET,
    odptoperator: Union[Unset, str] = UNSET,
) -> Response[Union[Any, List["BusstopPole"]]]:
    """バス停情報

    Args:
        aclconsumer_key (str): アクセストークン
        id (Union[Unset, str]): 固有識別子
        owlsame_as (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        dctitle (Union[Unset, str]):
        odptbusstop_pole_number (Union[Unset, str]):
        odptplatform_number (Union[Unset, str]):
        odptbusroute_pattern (Union[Unset, str]): 固有識別子の別名 多くが`odpt.hoge:fuga`形式
        odptoperator (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['BusstopPole']]]
    """

    kwargs = _get_kwargs(
        aclconsumer_key=aclconsumer_key,
        id=id,
        owlsame_as=owlsame_as,
        dctitle=dctitle,
        odptbusstop_pole_number=odptbusstop_pole_number,
        odptplatform_number=odptplatform_number,
        odptbusroute_pattern=odptbusroute_pattern,
        odptoperator=odptoperator,
    )

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

    return _build_response(client=client, response=response)

バス停情報

Args

aclconsumer_key : str

アクセストークン

id : Union[Unset, str]

固有識別子

owlsame_as : Union[Unset, str]

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

dctitle (Union[Unset, str]):

odptbusstop_pole_number (Union[Unset, str]):

odptplatform_number (Union[Unset, str]):

odptbusroute_pattern : Union[Unset, str]

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

odptoperator : 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['BusstopPole']]]