Skip to navigation

Retrieve a dosage for an animal

Retrieves a single dose administered to an animal.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

animalIdstringRequiredformat: "^aml_[a-zA-Z0-9]{10,22}$"
The unique identifier of the animal.
dosageIdstringRequiredformat: "^dsg_[a-zA-Z0-9]{10,22}$"
The unique identifier of the dosage.

Headers

X-Studies-Api-VersionstringOptional

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The requested dosage recorded on this animal.
idstringformat: "^dsg_[a-zA-Z0-9]{10,22}$"
Unique identifier for a dosage.
namestring or null<=255 characters
The name of the dosage.
dosed_atdatetime or null

The time the dose was administered, which may be earlier than created_at when it was recorded retrospectively.

commentsstring or null<=255 characters
Any note recorded alongside the dosage.
weight_at_dosingstring or null<=200 characters
The animal's weight used to scale the dose, as a string so that the precision recorded is preserved exactly. Null when the dose was not scaled to weight.
doseobject or null
The dose administered, relative to body weight.
dose_volumeobject or null
The volume administered, relative to body weight.
stockobject or null
The concentration of the stock solution the dose was drawn from.
volumeobject or null
The absolute volume administered.
studyobject or null
The study the dosage was given under, taken from its treatment.
animalobject
The animal a record belongs to, as embedded in dosages, measurements, observations and samples. Carries the same attributes as an animal retrieved directly, except that the cage, study and treatment group are given as identifiers rather than embedded objects.
measurementobject or null
The measurement the dose was scaled from. Null when the dose was not scaled to a recorded weight.
userobject or null
The user who administered the dose.
treatmentobject

The treatment a dosage was given under, as embedded in dosages. A treatment belongs to a study and defines what is administered and how much; the quantities here are the treatment’s prescribed amounts, which may differ from the amounts actually recorded on an individual dosage.

created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

updated_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error