Ttebra_soap_apiAsync Tebra SOAP 2.1
SOAP 2.1
Resources

Service locations

Read the service locations configured for a practice.

Resource
client.locations
SOAP operation
GetServiceLocations
Flat method
get_service_locations
Writes
None
On this page

Methods

client.locations.list#

read
async list(*, practice_id=None, practice_name=None, location_id=None, from_created_date=None, to_created_date=None, from_last_modified_date=None, to_last_modified_date=None, fields=None, extra_filter=None) -> list[dict]

List service locations using GetServiceLocations.

Parameters
ParameterTypeDescription
practice_idint | str | NoneFilter by practice ID (sent as a string).
practice_namestr | NoneFilter by practice name.
location_idint | str | NoneFilter by service location ID (sent as ID).
from_created_datestr | date | datetime | NoneLower creation-date bound.
to_created_datestr | date | datetime | NoneUpper creation-date bound.
from_last_modified_datestr | date | datetime | NoneLower last-modified bound.
to_last_modified_datestr | date | datetime | NoneUpper last-modified bound.
fieldsIterable[str] | Mapping[str, bool] | NoneField selector.
extra_filterMapping[str, Any] | NoneAdditional raw Filter keys.
Returnslist[dict[str, Any]]
Example
locations = await client.get_service_locations(practice_id=7)
for location in locations:
    print(location["ID"], location["Name"])

client.locations.get#

read
async get(location_id, *, practice_id=None, practice_name=None, fields=None) -> dict | None

Fetch a single service location by ID, returning None when not found.

Parameters
ParameterTypeDescription
location_idrequiredint | strService location ID.
practice_idint | str | NoneOptional practice ID filter.
practice_namestr | NoneOptional practice name filter.
fieldsIterable[str] | Mapping[str, bool] | NoneField selector.
Returnsdict[str, Any] | None

Related