Put an animal on a run
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/transports/{id}/animals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"animal_id": "39fbe05a-3fcd-4e02-9091-bde4e4e26098",
"notes": "Crate 2, carsick on long drives."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
animal_id: '39fbe05a-3fcd-4e02-9091-bde4e4e26098',
notes: 'Crate 2, carsick on long drives.'
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/transports/{id}/animals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/transports/{id}/animals"
payload = {
"animal_id": "39fbe05a-3fcd-4e02-9091-bde4e4e26098",
"notes": "Crate 2, carsick on long drives."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"scheduled_date": "2023-12-25",
"origin": "<string>",
"destination": "<string>",
"status": "planning",
"legs": [
{
"id": "<string>",
"sequence": 123,
"from_place": "<string>",
"to_place": "<string>",
"driver_person_id": "<string>",
"depart_at": "<string>",
"arrive_at": "<string>",
"driver_name": "<string>",
"notes": "<string>"
}
],
"animals": [
{
"id": "<string>",
"name": "<string>",
"species": "<string>",
"status": "<string>",
"notes": "<string>"
}
],
"problems": [
{
"kind": "no_legs",
"sequence": 123,
"message": "<string>"
}
],
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Transports
Put an animal on a run
Puts one of your animals on the run. Sending an animal that is already on it replaces its note. The animal’s own record is not changed. Needs write on Animals.
POST
/
api
/
animals
/
transports
/
{id}
/
animals
Put an animal on a run
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/transports/{id}/animals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"animal_id": "39fbe05a-3fcd-4e02-9091-bde4e4e26098",
"notes": "Crate 2, carsick on long drives."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
animal_id: '39fbe05a-3fcd-4e02-9091-bde4e4e26098',
notes: 'Crate 2, carsick on long drives.'
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/transports/{id}/animals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/transports/{id}/animals"
payload = {
"animal_id": "39fbe05a-3fcd-4e02-9091-bde4e4e26098",
"notes": "Crate 2, carsick on long drives."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"scheduled_date": "2023-12-25",
"origin": "<string>",
"destination": "<string>",
"status": "planning",
"legs": [
{
"id": "<string>",
"sequence": 123,
"from_place": "<string>",
"to_place": "<string>",
"driver_person_id": "<string>",
"depart_at": "<string>",
"arrive_at": "<string>",
"driver_name": "<string>",
"notes": "<string>"
}
],
"animals": [
{
"id": "<string>",
"name": "<string>",
"species": "<string>",
"status": "<string>",
"notes": "<string>"
}
],
"problems": [
{
"kind": "no_legs",
"sequence": 123,
"message": "<string>"
}
],
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The run's ID.
Response
The run, with the animal on it.
Available options:
planning, confirmed, in_progress, completed, cancelled In order.
Show child attributes
Show child attributes
The animals on the run, by name.
Show child attributes
Show child attributes
Every reason the run cannot be confirmed yet. Empty when it is ready.
Show child attributes
Show child attributes