Module python_odpt.api.default.place_search_operations_search

Functions

async def asyncio(rdf_type: PlaceRDFType,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
lat: float,
lon: float,
radius: int,
predicate: Unset | str = <python_odpt.types.Unset object>) ‑> Any | List[PlaceSearchResponse] | None
Expand source code
async def asyncio(
    rdf_type: PlaceRDFType,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    lat: float,
    lon: float,
    radius: int,
    predicate: Union[Unset, str] = UNSET,
) -> Optional[Union[Any, List["PlaceSearchResponse"]]]:
    """地物情報検索API

    Args:
        rdf_type (PlaceRDFType): 地物情報検索対象のデータ種別
        aclconsumer_key (str): アクセストークン
        lat (float):
        lon (float):
        radius (int):
        predicate (Union[Unset, str]):

    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['PlaceSearchResponse']]
    """

    return (
        await asyncio_detailed(
            rdf_type=rdf_type,
            client=client,
            aclconsumer_key=aclconsumer_key,
            lat=lat,
            lon=lon,
            radius=radius,
            predicate=predicate,
        )
    ).parsed

地物情報検索API

Args

rdf_type : PlaceRDFType
地物情報検索対象のデータ種別
aclconsumer_key : str
アクセストークン

lat (float): lon (float): radius (int): predicate (Union[Unset, str]):

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['PlaceSearchResponse']]

async def asyncio_detailed(rdf_type: PlaceRDFType,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
lat: float,
lon: float,
radius: int,
predicate: Unset | str = <python_odpt.types.Unset object>) ‑> Response[Any | List[PlaceSearchResponse]]
Expand source code
async def asyncio_detailed(
    rdf_type: PlaceRDFType,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    lat: float,
    lon: float,
    radius: int,
    predicate: Union[Unset, str] = UNSET,
) -> Response[Union[Any, List["PlaceSearchResponse"]]]:
    """地物情報検索API

    Args:
        rdf_type (PlaceRDFType): 地物情報検索対象のデータ種別
        aclconsumer_key (str): アクセストークン
        lat (float):
        lon (float):
        radius (int):
        predicate (Union[Unset, str]):

    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['PlaceSearchResponse']]]
    """

    kwargs = _get_kwargs(
        rdf_type=rdf_type,
        aclconsumer_key=aclconsumer_key,
        lat=lat,
        lon=lon,
        radius=radius,
        predicate=predicate,
    )

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

    return _build_response(client=client, response=response)

地物情報検索API

Args

rdf_type : PlaceRDFType
地物情報検索対象のデータ種別
aclconsumer_key : str
アクセストークン

lat (float): lon (float): radius (int): predicate (Union[Unset, str]):

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['PlaceSearchResponse']]]

def sync(rdf_type: PlaceRDFType,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
lat: float,
lon: float,
radius: int,
predicate: Unset | str = <python_odpt.types.Unset object>) ‑> Any | List[PlaceSearchResponse] | None
Expand source code
def sync(
    rdf_type: PlaceRDFType,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    lat: float,
    lon: float,
    radius: int,
    predicate: Union[Unset, str] = UNSET,
) -> Optional[Union[Any, List["PlaceSearchResponse"]]]:
    """地物情報検索API

    Args:
        rdf_type (PlaceRDFType): 地物情報検索対象のデータ種別
        aclconsumer_key (str): アクセストークン
        lat (float):
        lon (float):
        radius (int):
        predicate (Union[Unset, str]):

    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['PlaceSearchResponse']]
    """

    return sync_detailed(
        rdf_type=rdf_type,
        client=client,
        aclconsumer_key=aclconsumer_key,
        lat=lat,
        lon=lon,
        radius=radius,
        predicate=predicate,
    ).parsed

地物情報検索API

Args

rdf_type : PlaceRDFType
地物情報検索対象のデータ種別
aclconsumer_key : str
アクセストークン

lat (float): lon (float): radius (int): predicate (Union[Unset, str]):

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['PlaceSearchResponse']]

def sync_detailed(rdf_type: PlaceRDFType,
*,
client: AuthenticatedClient | Client,
aclconsumer_key: str,
lat: float,
lon: float,
radius: int,
predicate: Unset | str = <python_odpt.types.Unset object>) ‑> Response[Any | List[PlaceSearchResponse]]
Expand source code
def sync_detailed(
    rdf_type: PlaceRDFType,
    *,
    client: Union[AuthenticatedClient, Client],
    aclconsumer_key: str,
    lat: float,
    lon: float,
    radius: int,
    predicate: Union[Unset, str] = UNSET,
) -> Response[Union[Any, List["PlaceSearchResponse"]]]:
    """地物情報検索API

    Args:
        rdf_type (PlaceRDFType): 地物情報検索対象のデータ種別
        aclconsumer_key (str): アクセストークン
        lat (float):
        lon (float):
        radius (int):
        predicate (Union[Unset, str]):

    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['PlaceSearchResponse']]]
    """

    kwargs = _get_kwargs(
        rdf_type=rdf_type,
        aclconsumer_key=aclconsumer_key,
        lat=lat,
        lon=lon,
        radius=radius,
        predicate=predicate,
    )

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

    return _build_response(client=client, response=response)

地物情報検索API

Args

rdf_type : PlaceRDFType
地物情報検索対象のデータ種別
aclconsumer_key : str
アクセストークン

lat (float): lon (float): radius (int): predicate (Union[Unset, str]):

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['PlaceSearchResponse']]]