sampledbapi.locations module

class sampledbapi.locations.Location(d: Dict)[source]

Bases: SampleDBObject

description: str | None = None

is_hidden: bool | None = None

location_id: int | None = None

name: str | None = None

parent_location_id: int | None = None

type_id: int | None = None

sampledbapi.locations.get(location_id: int) → Location[source]

Get the specific location (location_id).

Parameters:: location_id (int) – ID of the location to be retrieved.
Returns:: The requested Location.
Return type:: Location

sampledbapi.locations.get_list() → List[Location][source]

Get a list of all locations.

Returns:: List of Location objects.
Return type:: List