Skip to navigation
APIsStudy ResourcesStudy Dosages

Create dosages

Records between 1 and 100 dosages of the study’s treatments against animals on the study. The request is validated as a whole; if any item is invalid, none are created.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study.

Headers

X-Studies-Api-VersionstringOptional

Request

The dosages to record.
animal_idstringRequiredformat: "^aml_[a-zA-Z0-9]{10,22}$"

The animal to dose. Must be on the study, and for a treatment classified as treatment must be in one of the study groups the treatment is assigned to.

treatment_idstringRequiredformat: "^tmt_[a-zA-Z0-9]{10,22}$"
The treatment to administer. Must be on the study.
dosed_atstringRequired

When the dosage was administered, as a full ISO-8601 UTC date-time: either an explicit UTC instant (offset Z or +00:00) or an offset-less date-time taken as UTC. Date-only values and non-UTC offsets are rejected. Must fall within the animal’s lifespan: not before its date of birth and not after it was terminated.

commentsstring or nullOptional<=255 characters
A comment recorded against the dosage.
dosestring or nullOptionalformat: "^\d+(\.\d{1,3})?$"
The dose, in the treatment's display units.
stockstring or nullOptionalformat: "^\d+(\.\d{1,3})?$"
The stock concentration, in the treatment's display units.
volumestring or nullOptionalformat: "^\d+(\.\d{1,3})?$"
The volume, in the treatment's display units.
dose_volumestring or nullOptionalformat: "^\d+(\.\d{1,3})?$"
The dose volume, in the treatment's display units.
weight_at_dosingstring or nullOptionalformat: "^\d+(\.\d{1,3})?$"<=8 characters
The animal's weight to calculate with and to record on the dosage. Must be greater than zero. When omitted, the animal's latest weight measurement is used, and a treatment that is not custom requires one to exist. Supplying only a weight still calculates the dosage from the treatment's own values.
induct_diseasebooleanOptional
Set the animal's disease induction date to the earliest dosing time, if it is not already set. Only allowed with a disease induction treatment. Defaults to false.

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 created dosages.
datalist of objects
The dosages.

Errors

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