What this run needs on paper

PUT

https://{organization}.rescueconsole.com

api

animals

transports

{id}

papers

What this run needs on paper

curl --request PUT \
  --url https://{organization}.rescueconsole.com/api/animals/transports/{id}/papers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "papers": [
    {
      "label": "Certificate of Veterinary Inspection"
    },
    {
      "label": "SC import permit"
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    papers: [{label: 'Certificate of Veterinary Inspection'}, {label: 'SC import permit'}]
  })
};

fetch('https://{organization}.rescueconsole.com/api/animals/transports/{id}/papers', 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}/papers"

payload = { "papers": [{ "label": "Certificate of Veterinary Inspection" }, { "label": "SC import permit" }] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(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>",
      "from_address": {
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>"
      },
      "to_address": {
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>"
      },
      "from_type": "residence",
      "to_type": "residence",
      "from_contact": {
        "name": "<string>",
        "phone": "<string>"
      },
      "to_contact": {
        "name": "<string>",
        "phone": "<string>"
      }
    }
  ],
  "animals": [
    {
      "id": "<string>",
      "name": "<string>",
      "species": "<string>",
      "status": "<string>",
      "notes": "<string>",
      "crate_size": "small",
      "boards_place": "<string>",
      "leaves_place": "<string>"
    }
  ],
  "problems": [
    {
      "kind": "sequence_gap",
      "sequence": 123,
      "message": "<string>"
    }
  ],
  "notes": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "reminders": [
    {
      "days_before": 123,
      "told": 123,
      "sent_at": "2023-11-07T05:31:56Z"
    }
  ],
  "driver_person_id": "<string>",
  "driver_name": "<string>",
  "origin_address": {
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "administrative_area": "<string>",
    "postal_code": "<string>"
  },
  "destination_address": {
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "administrative_area": "<string>",
    "postal_code": "<string>"
  },
  "origin_type": "residence",
  "destination_type": "residence",
  "vehicle_type": "car",
  "vehicle_notes": "<string>",
  "crate_capacity": {
    "small": 1,
    "medium": 1,
    "large": 1,
    "extra_large": 1
  },
  "transport_type": "one_way",
  "series_id": "<string>",
  "recurrence": {
    "freq": "daily",
    "interval": 1,
    "by_weekday": [
      3
    ],
    "monthly_by": "date",
    "until": "2023-12-25",
    "count": 51,
    "never_ends": true,
    "tz": "<string>"
  },
  "series_through": "2023-12-25",
  "series": {
    "count": 123,
    "rule": {
      "freq": "daily",
      "interval": 1,
      "by_weekday": [
        3
      ],
      "monthly_by": "date",
      "until": "2023-12-25",
      "count": 51,
      "never_ends": true,
      "tz": "<string>"
    }
  },
  "origin_contact": {
    "name": "<string>",
    "phone": "<string>"
  },
  "destination_contact": {
    "name": "<string>",
    "phone": "<string>"
  },
  "weather_min_f": 123,
  "weather_max_f": 123,
  "weather_decision": "go",
  "weather_note": "<string>",
  "weather_decided_at": "2023-11-07T05:31:56Z",
  "weather_decided_by_person_id": "<string>",
  "weather_decided_by_name": "<string>",
  "papers": [
    {
      "id": "<string>",
      "label": "<string>",
      "notes": "<string>",
      "paper_id": "<string>",
      "marks": [
        {
          "animal_id": "<string>",
          "in_hand": true,
          "note": "<string>"
        }
      ]
    }
  ]
}

{
  "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

Authorization

string

header

required

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

Path Parameters

string

required

The run's ID.

Body

application/json

papers

object[]

required

Show child attributes

Response

The run.

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.

Show child attributes

animals

object[]

required

The animals on the run, by name.

Show child attributes

problems

object[]

required

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

Show child attributes

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.

Show child attributes

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.

Show child attributes

destination_address

object

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

⌘I

What this run needs on paper

curl --request PUT \
  --url https://{organization}.rescueconsole.com/api/animals/transports/{id}/papers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "papers": [
    {
      "label": "Certificate of Veterinary Inspection"
    },
    {
      "label": "SC import permit"
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    papers: [{label: 'Certificate of Veterinary Inspection'}, {label: 'SC import permit'}]
  })
};

fetch('https://{organization}.rescueconsole.com/api/animals/transports/{id}/papers', 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}/papers"

payload = { "papers": [{ "label": "Certificate of Veterinary Inspection" }, { "label": "SC import permit" }] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(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>",
      "from_address": {
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>"
      },
      "to_address": {
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>"
      },
      "from_type": "residence",
      "to_type": "residence",
      "from_contact": {
        "name": "<string>",
        "phone": "<string>"
      },
      "to_contact": {
        "name": "<string>",
        "phone": "<string>"
      }
    }
  ],
  "animals": [
    {
      "id": "<string>",
      "name": "<string>",
      "species": "<string>",
      "status": "<string>",
      "notes": "<string>",
      "crate_size": "small",
      "boards_place": "<string>",
      "leaves_place": "<string>"
    }
  ],
  "problems": [
    {
      "kind": "sequence_gap",
      "sequence": 123,
      "message": "<string>"
    }
  ],
  "notes": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "reminders": [
    {
      "days_before": 123,
      "told": 123,
      "sent_at": "2023-11-07T05:31:56Z"
    }
  ],
  "driver_person_id": "<string>",
  "driver_name": "<string>",
  "origin_address": {
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "administrative_area": "<string>",
    "postal_code": "<string>"
  },
  "destination_address": {
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "administrative_area": "<string>",
    "postal_code": "<string>"
  },
  "origin_type": "residence",
  "destination_type": "residence",
  "vehicle_type": "car",
  "vehicle_notes": "<string>",
  "crate_capacity": {
    "small": 1,
    "medium": 1,
    "large": 1,
    "extra_large": 1
  },
  "transport_type": "one_way",
  "series_id": "<string>",
  "recurrence": {
    "freq": "daily",
    "interval": 1,
    "by_weekday": [
      3
    ],
    "monthly_by": "date",
    "until": "2023-12-25",
    "count": 51,
    "never_ends": true,
    "tz": "<string>"
  },
  "series_through": "2023-12-25",
  "series": {
    "count": 123,
    "rule": {
      "freq": "daily",
      "interval": 1,
      "by_weekday": [
        3
      ],
      "monthly_by": "date",
      "until": "2023-12-25",
      "count": 51,
      "never_ends": true,
      "tz": "<string>"
    }
  },
  "origin_contact": {
    "name": "<string>",
    "phone": "<string>"
  },
  "destination_contact": {
    "name": "<string>",
    "phone": "<string>"
  },
  "weather_min_f": 123,
  "weather_max_f": 123,
  "weather_decision": "go",
  "weather_note": "<string>",
  "weather_decided_at": "2023-11-07T05:31:56Z",
  "weather_decided_by_person_id": "<string>",
  "weather_decided_by_name": "<string>",
  "papers": [
    {
      "id": "<string>",
      "label": "<string>",
      "notes": "<string>",
      "paper_id": "<string>",
      "marks": [
        {
          "animal_id": "<string>",
          "in_hand": true,
          "note": "<string>"
        }
      ]
    }
  ]
}

{
  "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)"
}

Using the API

Endpoints

What this run needs on paper

Authorizations

Path Parameters

Body

Response