curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/cage-card-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Adoption event card",
"paper": "index_5x7",
"fields": [
"name",
"pet_id",
"breed",
"sex",
"age",
"adoption_fee",
"description"
],
"show_photo": true,
"qr_mode": "url",
"qr_url_template": "https://contoso.com/adopt/{pet_id}",
"is_default": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Adoption event card',
paper: 'index_5x7',
fields: ['name', 'pet_id', 'breed', 'sex', 'age', 'adoption_fee', 'description'],
show_photo: true,
qr_mode: 'url',
qr_url_template: 'https://contoso.com/adopt/{pet_id}',
is_default: false
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/cage-card-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/cage-card-templates"
payload = {
"name": "Adoption event card",
"paper": "index_5x7",
"fields": ["name", "pet_id", "breed", "sex", "age", "adoption_fee", "description"],
"show_photo": True,
"qr_mode": "url",
"qr_url_template": "https://contoso.com/adopt/{pet_id}",
"is_default": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"template": {
"id": "<string>",
"name": "<string>",
"paper": "index_4x6",
"fields": [
"<string>"
],
"show_photo": 1,
"qr_mode": "none",
"qr_url_template": "<string>",
"is_default": 1,
"style": "list",
"photo_corner": "bottom_left",
"sponsor_logo_file_ids": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tenant_id": "<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)"
}Add a cage card template
Creates a template. Only the name is required: unless you say, a new template is index_4x6 paper in the list style, prints the photo, prints no fields and no QR code, and is not the default. Making it the default takes that from the template that had it. Needs admin on Animals.
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/cage-card-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Adoption event card",
"paper": "index_5x7",
"fields": [
"name",
"pet_id",
"breed",
"sex",
"age",
"adoption_fee",
"description"
],
"show_photo": true,
"qr_mode": "url",
"qr_url_template": "https://contoso.com/adopt/{pet_id}",
"is_default": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Adoption event card',
paper: 'index_5x7',
fields: ['name', 'pet_id', 'breed', 'sex', 'age', 'adoption_fee', 'description'],
show_photo: true,
qr_mode: 'url',
qr_url_template: 'https://contoso.com/adopt/{pet_id}',
is_default: false
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/cage-card-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/cage-card-templates"
payload = {
"name": "Adoption event card",
"paper": "index_5x7",
"fields": ["name", "pet_id", "breed", "sex", "age", "adoption_fee", "description"],
"show_photo": True,
"qr_mode": "url",
"qr_url_template": "https://contoso.com/adopt/{pet_id}",
"is_default": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"template": {
"id": "<string>",
"name": "<string>",
"paper": "index_4x6",
"fields": [
"<string>"
],
"show_photo": 1,
"qr_mode": "none",
"qr_url_template": "<string>",
"is_default": 1,
"style": "list",
"photo_corner": "bottom_left",
"sponsor_logo_file_ids": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tenant_id": "<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)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Body
120What the card is printed on: an index card (4x6, 5x7 or 6x9 inches), half a letter sheet, a letter sheet, or A5.
index_4x6, index_5x7, index_6x9, half_letter, letter, a5 The keys of the fields to print, in order. The app prints name, pet_id, species, breed, sex, age, altered, status, location, intake_date, days_in_care, microchip_number, health_status, medical_flags, behavioral_traits, adoption_fee and description. A new template with none sent prints no fields.
241 - 60True for a new template unless you say.
What the QR code points at. none prints no code. record opens the animal's record in RescueConsole, which needs a sign-in. url is an address you write in qr_url_template. site is the animal's page on your public site at your primary domain. With no address, or no live domain, no code is printed.
none, record, url, site Must start with http:// or https://. Use {pet_id}, {id} or {name} where the animal goes, as in https://contoso.com/adopt/{pet_id}.
Making one template the default takes that from the one that had it.
list prints the fields the template lists. petsmart is the PetSmart card, with its own fixed wording, the photo in one bottom corner and the QR code in the other.
list, petsmart bottom_left, bottom_right IDs of PNG, JPEG, WebP or GIF images uploaded to your organization, in print order.
480Response
The template, as it was created.
Show child attributes
Show child attributes