curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/animals/transports/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "confirmed"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'confirmed'})
};
fetch('https://{organization}.rescueconsole.com/api/animals/transports/{id}', 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}"
payload = { "status": "confirmed" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(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)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Change a transport run
Send only what changes. Changing the status to confirmed is refused (409) while the run has any problem: no legs, a leg with no driver, a leg that does not start where the one before it ended, a first leg that does not start at the origin or a last leg that does not end at the destination, or times out of order. Places are compared ignoring case and extra spaces, and nothing more. The refusal lists every problem in problems, not only the first. Any other status can be set at any time. Needs write on Animals.
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/animals/transports/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "confirmed"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'confirmed'})
};
fetch('https://{organization}.rescueconsole.com/api/animals/transports/{id}', 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}"
payload = { "status": "confirmed" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(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)"
}{
"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.
Body
1Empty text keeps the one it has.
Empty text keeps the one it has.
Moving to confirmed needs a run with no problems.
planning, confirmed, in_progress, completed, cancelled Null or empty text clears it.
Response
The run, as it now is.
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