Record a handover

Records who handed the animals to whom, where, and when. THERE IS NO EDIT AND NO DELETE, here or anywhere: this is the only thing that settles it when an animal is hurt or missing and two organizations remember the handover differently, and a line that can be rewritten afterwards settles nothing. A mistake is a second handover saying what happened. Every animal named must be on this run. The people and the animals are written in one batch, so a handover that could not record its animals is not recorded at all. Needs write on Animals.

POST

https://{organization}.rescueconsole.com

api

animals

transports

{id}

handovers

Record a handover

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/animals/transports/{id}/handovers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "at_place": "Exit 42 Pilot",
  "from_name": "Ada Green",
  "to_name": "Casey Miller",
  "signature_name": "Casey Miller",
  "animal_ids": [
    "39fbe05a-3fcd-4e02-9091-bde4e4e26098"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    at_place: 'Exit 42 Pilot',
    from_name: 'Ada Green',
    to_name: 'Casey Miller',
    signature_name: 'Casey Miller',
    animal_ids: ['39fbe05a-3fcd-4e02-9091-bde4e4e26098']
  })
};

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

payload = {
    "at_place": "Exit 42 Pilot",
    "from_name": "Ada Green",
    "to_name": "Casey Miller",
    "signature_name": "Casey Miller",
    "animal_ids": ["39fbe05a-3fcd-4e02-9091-bde4e4e26098"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "results": [
    {
      "id": "<string>",
      "at_place": "<string>",
      "handed_at": "2023-11-07T05:31:56Z",
      "from_name": "<string>",
      "from_person_id": "<string>",
      "to_name": "<string>",
      "to_person_id": "<string>",
      "signature_name": "<string>",
      "notes": "<string>",
      "recorded_by_person_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "animals": [
        {
          "id": "<string>",
          "name": "<string>",
          "species": "<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

at_place

string

required

Where it happened, by name.

from_name

string

required

to_name

string

required

handed_at

string<date-time>

When. Defaults to now, which is right for somebody recording it in the car park; a driver catching up in the evening sends the real time.

from_person_id

string | null

to_person_id

string | null

signature_name

string | null

notes

string | null

animal_ids

string[]

The animals handed over. Each must be on this run.

Response

The chain of custody, including the new one.

results

object[]

Show child attributes

⌘I

Record a handover

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/animals/transports/{id}/handovers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "at_place": "Exit 42 Pilot",
  "from_name": "Ada Green",
  "to_name": "Casey Miller",
  "signature_name": "Casey Miller",
  "animal_ids": [
    "39fbe05a-3fcd-4e02-9091-bde4e4e26098"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    at_place: 'Exit 42 Pilot',
    from_name: 'Ada Green',
    to_name: 'Casey Miller',
    signature_name: 'Casey Miller',
    animal_ids: ['39fbe05a-3fcd-4e02-9091-bde4e4e26098']
  })
};

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

payload = {
    "at_place": "Exit 42 Pilot",
    "from_name": "Ada Green",
    "to_name": "Casey Miller",
    "signature_name": "Casey Miller",
    "animal_ids": ["39fbe05a-3fcd-4e02-9091-bde4e4e26098"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "results": [
    {
      "id": "<string>",
      "at_place": "<string>",
      "handed_at": "2023-11-07T05:31:56Z",
      "from_name": "<string>",
      "from_person_id": "<string>",
      "to_name": "<string>",
      "to_person_id": "<string>",
      "signature_name": "<string>",
      "notes": "<string>",
      "recorded_by_person_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "animals": [
        {
          "id": "<string>",
          "name": "<string>",
          "species": "<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

Record a handover

Authorizations

Path Parameters

Body

Response