Change a service

PATCH

https://{organization}.rescueconsole.com

api

animals

transport-services

{id}

Change a service

curl --request PATCH \
  --url https://{organization}.rescueconsole.com/api/animals/transport-services/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "amount_cents": 1,
  "species": "<string>",
  "sort_order": 123,
  "is_active": true,
  "notes": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    amount_cents: 1,
    species: '<string>',
    sort_order: 123,
    is_active: true,
    notes: '<string>'
  })
};

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

payload = {
    "label": "<string>",
    "amount_cents": 1,
    "species": "<string>",
    "sort_order": 123,
    "is_active": True,
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "label": "<string>",
  "kind": "surgery",
  "pricing": "flat",
  "amount_cents": 1,
  "species": "<string>",
  "sex": "male",
  "size": "small",
  "sort_order": 123,
  "is_active": true,
  "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_.

Path Parameters

string

required

The line.

Body

application/json

On a PATCH every field is optional and one left out keeps what it had; a criterion sent as empty text is cleared, which widens the line to any.

label

string

required

Minimum string length: 1

kind

enum<string>

required

What sort of thing the line is, for grouping a list somebody reads.

Available options:

surgery,

vaccine,

test,

microchip,

ride,

other

pricing

enum<string>

required

A flat price, or a price a mile that is multiplied by the miles given when the line is chosen.

Available options:

flat,

per_mile

amount_cents

integer

required

Required range: x >= 0

species

string | null

sex

enum<string> | null

Available options:

male,

female,

unknown,

null

size

enum<string> | null

Available options:

small,

medium,

large,

extra_large,

null

sort_order

integer

is_active

boolean

notes

string | null

Response

The line.

One line of a rescue's transport price list (Phase 443). A transport does not have a single price: the cost of a seat is the sum of the lines chosen for the animals riding.

string

required

label

string

required

What a partner reads when they pick it.

kind

enum<string>

required

What sort of thing the line is, for grouping a list somebody reads.

Available options:

surgery,

vaccine,

test,

microchip,

ride,

other

pricing

enum<string>

required

A flat price, or a price a mile that is multiplied by the miles given when the line is chosen.

Available options:

flat,

per_mile

amount_cents

integer

required

Cents, or cents a mile. Zero is allowed: a service a rescue does not charge for but wants recorded.

Required range: x >= 0

species

string | null

The line is offered for this species only. Null is any.

sex

enum<string> | null

Null is any.

Available options:

male,

female,

unknown,

null

size

enum<string> | null

Null is any.

Available options:

small,

medium,

large,

extra_large,

null

sort_order

integer

The order the rescue put its own list in.

is_active

boolean

A retired line is not offered to anybody and stays readable to its owner.

notes

string | null

created_at

string<date-time>

updated_at

string<date-time>

⌘I

Change a service

curl --request PATCH \
  --url https://{organization}.rescueconsole.com/api/animals/transport-services/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "amount_cents": 1,
  "species": "<string>",
  "sort_order": 123,
  "is_active": true,
  "notes": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    amount_cents: 1,
    species: '<string>',
    sort_order: 123,
    is_active: true,
    notes: '<string>'
  })
};

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

payload = {
    "label": "<string>",
    "amount_cents": 1,
    "species": "<string>",
    "sort_order": 123,
    "is_active": True,
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "label": "<string>",
  "kind": "surgery",
  "pricing": "flat",
  "amount_cents": 1,
  "species": "<string>",
  "sex": "male",
  "size": "small",
  "sort_order": 123,
  "is_active": true,
  "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

Path Parameters

Body

Response