Save a place

POST

https://{organization}.rescueconsole.com

api

animals

transport-places

Save a place

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/animals/transport-places \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Exit 42 Pilot",
  "place_type": "break_stop",
  "address": {
    "line1": "4600 Buford Hwy",
    "city": "Norcross",
    "administrative_area": "GA",
    "postal_code": "30071",
    "country": "US"
  },
  "notes": "Park at the far end, away from the pumps."
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Exit 42 Pilot',
    place_type: 'break_stop',
    address: {
      line1: '4600 Buford Hwy',
      city: 'Norcross',
      administrative_area: 'GA',
      postal_code: '30071',
      country: 'US'
    },
    notes: 'Park at the far end, away from the pumps.'
  })
};

fetch('https://{organization}.rescueconsole.com/api/animals/transport-places', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/animals/transport-places"

payload = {
    "name": "Exit 42 Pilot",
    "place_type": "break_stop",
    "address": {
        "line1": "4600 Buford Hwy",
        "city": "Norcross",
        "administrative_area": "GA",
        "postal_code": "30071",
        "country": "US"
    },
    "notes": "Park at the far end, away from the pumps."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "name": "<string>",
  "place_type": "residence",
  "address": {
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "administrative_area": "<string>",
    "postal_code": "<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

Authorization

string

header

required

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

Body

application/json

On a PATCH every field is optional and a field left out keeps what it had; an address sent with nothing in it is cleared.

name

string

required

Required string length: 1 - 120

place_type

enum<string> | null

Available options:

residence,

shelter,

vet,

break_stop,

other,

null

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

notes

string | null

Response

The saved place.

string

required

name

string

required

What a driver reads. Unique within the organization, case aside.

place_type

enum<string> | null

The same kinds a place on a run has.

Available options:

residence,

shelter,

vet,

break_stop,

other,

null

address

object | null

The six fields, or null when nobody has said.

Show child attributes

notes

string | null

What a driver should know when they get there.

created_at

string<date-time>

updated_at

string<date-time>

⌘I

Save a place

curl --request POST \
  --url https://{organization}.rescueconsole.com/api/animals/transport-places \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Exit 42 Pilot",
  "place_type": "break_stop",
  "address": {
    "line1": "4600 Buford Hwy",
    "city": "Norcross",
    "administrative_area": "GA",
    "postal_code": "30071",
    "country": "US"
  },
  "notes": "Park at the far end, away from the pumps."
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Exit 42 Pilot',
    place_type: 'break_stop',
    address: {
      line1: '4600 Buford Hwy',
      city: 'Norcross',
      administrative_area: 'GA',
      postal_code: '30071',
      country: 'US'
    },
    notes: 'Park at the far end, away from the pumps.'
  })
};

fetch('https://{organization}.rescueconsole.com/api/animals/transport-places', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/animals/transport-places"

payload = {
    "name": "Exit 42 Pilot",
    "place_type": "break_stop",
    "address": {
        "line1": "4600 Buford Hwy",
        "city": "Norcross",
        "administrative_area": "GA",
        "postal_code": "30071",
        "country": "US"
    },
    "notes": "Park at the far end, away from the pumps."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "name": "<string>",
  "place_type": "residence",
  "address": {
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "administrative_area": "<string>",
    "postal_code": "<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)"
}

Using the API

Endpoints

Authorizations

Body

Response