Sign in
locations

Get Location

Changed on

Get location details by name.

Args: location_name: The unique name of the location to retrieve. location_service: Service dependency used to fetch location details.

Returns: The requested :class:app.schemas.location_v2.LocationProfile instance.

Raises: HTTPException: 404 if the location does not exist.

get/api/v1/locations/{location_name}

Request

  • The document declares no server URL.
  • Auth: API key in header X-API-Key

Path parameters

location_namestring required

Query parameters

target_languagestring

Response

Successful Response

Changes

  • c204bec6f0f8Revision changes
    • info

      added the optional property / to the response with the status

  • f4dfebe1152dRevision changes
    • breaking

      response property location/solutions/solutions/additionalProperties/items/hasLocalAction list-of-types was widened by adding types null to media type application/json of response 200

    • info

      the response's property default value false was removed for the status