Locations

Get all active locations (convenience endpoint)

Changed on
get/Locations/active

Request

  • Base URL
    https://api.clinicos.vet/backend/business
  • Auth
    HTTP bearer

Query parameters

kind'Room' | 'Cage' | 'Run' | 'Ward'

What a Location physically is (ITE-710). Exam rooms are where appointments happen and what the flowboard room grid shows; cages, runs and wards are where a hospitalized patient lives for the length of a HospitalStay. The admit picker filters on this, and the flowboard keeps hospitalization locations out of its grid. Stored as text; the default keeps every pre-existing location an exam room.

Filter by kind (Room / Cage / Run / Ward); omit for every kind

Response

List of active locations sorted by display order

idstring
namestring
descriptionstring nullable
isActiveboolean
createdAtstring date-time
updatedAtstring date-time
isVehicleboolean
isPersonalVehicleboolean
allowOnlineBookingboolean
allowOverbookingboolean
kind'Room' | 'Cage' | 'Run' | 'Ward'

What a Location physically is (ITE-710). Exam rooms are where appointments happen and what the flowboard room grid shows; cages, runs and wards are where a hospitalized patient lives for the length of a HospitalStay. The admit picker filters on this, and the flowboard keeps hospitalization locations out of its grid. Stored as text; the default keeps every pre-existing location an exam room.

allowedSpeciesIdsstring[] nullable

Species IDs allowed at this location. If empty/null, all species are allowed.

Changes

    • info

      added the new optional query request parameter kind

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)