Skip to main content
POST
Put an animal on a run

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The run's ID.

Body

application/json
animal_id
string
required
notes
string

A note for this animal on this run.

crate_size
enum<string> | null

The size of crate this animal needs, which is what a capacity is counted against. An animal with no size counts against nothing.

Available options:
small,
medium,
large,
extra_large,
null
boards_place
string | null

The NAME of the stop where this animal joins the van (Phase 449b), or null for the start. Each field is written only when its key is sent, so setting a crate size does not clear it.

leaves_place
string | null

The NAME of the stop where it leaves, or null for the end. Both null is the whole journey.

Response

The run, with the animal on it.

id
string
required
name
string
required
scheduled_date
string<date>
required
origin
string
required
destination
string
required
status
enum<string>
required
Available options:
planning,
confirmed,
in_progress,
completed,
cancelled
legs
object[]
required

In order.

animals
object[]
required

The animals on the run, by name.

problems
object[]
required

Every reason the run cannot be confirmed yet. Empty when it is ready.

notes
string | null
created_at
string<date-time>
updated_at
string<date-time>
reminders
object[]

What has already been sent about this run (Phase 447). A confirmed run reminds its drivers and every rescue holding space three days before and again the day before, once each. Read only: there is no endpoint that sends one.

driver_person_id
string | null

Who is driving the run (Phase 436). On a run with legs this is whoever is in charge of the whole journey; each leg has its own driver. Empty text or null clears it. An address is only rewritten when its key is sent, so a patch about a date never clears one somebody verified.

driver_name
string | null

The run driver's name. Empty text when there is no driver.

origin_address
object

The place, as the six address fields (Phase 437). Every part is optional and a key not listed here is refused. Sent as an object and returned as one; an address with nothing in it is stored as nothing.

destination_address
object

The place, as the six address fields (Phase 437). Every part is optional and a key not listed here is refused. Sent as an object and returned as one; an address with nothing in it is stored as nothing.

origin_type
enum<string> | null

What kind of place it is (Phase 438). It changes what a driver expects to find and how long to allow: break_stop covers a planned pause for fuel, a meal, rest or an overnight.

Available options:
residence,
shelter,
vet,
break_stop,
other,
null
destination_type
enum<string> | null

What kind of place it is (Phase 438). It changes what a driver expects to find and how long to allow: break_stop covers a planned pause for fuel, a meal, rest or an overnight.

Available options:
residence,
shelter,
vet,
break_stop,
other,
null
vehicle_type
enum<string> | null

What is being driven (Phase 439).

Available options:
car,
suv,
minivan,
cargo_van,
box_truck,
trailer,
other,
null
vehicle_notes
string | null

Anything a driver should know about the vehicle.

crate_capacity
object

How many crates of each size the vehicle holds (Phase 439). Every size is optional, a size left out or zero is not counted, and a key that is not one of the four sizes is refused rather than dropped. AN EMPTY OBJECT MEANS NOBODY HAS SAID, and nothing is checked against it.

transport_type
enum<string> | null

Whether the van comes back (Phase 441). round_trip is checked: a run that says round trip and does not end where it started reports the problem not_a_round_trip and cannot be confirmed.

Available options:
one_way,
round_trip,
null
series_id
string | null

The first run of the series, on every run of it including the first. Null on a run that does not repeat.

recurrence
object | null

The rule, on the FIRST run of a series only. series.rule carries it on every run.

series_through
string<date> | null

Read only, and on the first run of a series only: the furthest date the series has ever put a run on. It is how a never-ending series is extended without minting a date somebody deleted.

series
object | null

The series this run is one of, or null. Only on a single run, not in the list.

origin_contact
object | null

Who to ring at the start (Phase 449b). An address gets a van to a car park; a name and a number get an animal out of it. Either half may be empty; both empty reads back as null. Only rewritten when the key is sent, so a patch about a date never clears a number somebody finally got hold of. An unknown field is refused rather than dropped.

destination_contact
object | null

Who to ring at the end (Phase 449b). An address gets a van to a car park; a name and a number get an animal out of it. Either half may be empty; both empty reads back as null. Only rewritten when the key is sent, so a patch about a date never clears a number somebody finally got hold of. An unknown field is refused rather than dropped.

weather_min_f
integer | null

The coldest temperature this rescue will move animals in, in degrees Fahrenheit (Phase 449d). Between -60 and 140, and the coldest cannot be warmer than the warmest. Null is a rescue that has not said, which is most of them.

weather_max_f
integer | null

The warmest temperature this rescue will move animals in, in degrees Fahrenheit (Phase 449d). Between -60 and 140, and the coldest cannot be warmer than the warmest. Null is a rescue that has not said, which is most of them.

weather_decision
enum<string> | null

Whether somebody decided this run goes (Phase 449d). Nothing here checks the weather - we do not know it - so this records that a person looked and what they said. Setting it stamps who and when; re-sending the same decision does not re-stamp it, and clearing it clears the stamp.

Available options:
go,
hold,
null
weather_note
string | null

What the forecast said, in whoever wrote it words.

weather_decided_at
string<date-time> | null

When the decision was made. Read only.

weather_decided_by_person_id
string | null

Who made it. Read only.

weather_decided_by_name
string | null

And their name, because a decision that reads as an id settles nothing. Read only.

papers
object[]

What this run needs on paper (Phase 448), each document with who has it. Empty is ordinary.

miles
number | null

How far a run with no legs is, in miles, to one decimal place. A per-mile transport service is priced on the route these add up to.

Required range: 0 <= x <= 10000
miles_calculated
boolean

True when the miles were worked out from the two addresses by driving distance; false when somebody typed them.

route_miles
number | null

What a per-mile service is priced on: every leg’s miles added up, or the run’s own when it has no legs. Null while any leg has no miles.