curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/animals/animals/{id}/medical/{recordId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"result_status": "negative",
"notes": "Negative on both."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({result_status: 'negative', notes: 'Negative on both.'})
};
fetch('https://{organization}.rescueconsole.com/api/animals/animals/{id}/medical/{recordId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/animals/{id}/medical/{recordId}"
payload = {
"result_status": "negative",
"notes": "Negative on both."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"record_type": "vaccination",
"name": "<string>",
"performed_on": "2023-12-25",
"due_on": "2023-12-25",
"notes": "<string>",
"performed_by_person_id": "<string>",
"recurrence_interval": 123,
"recurrence_unit": "day",
"series_id": "<string>",
"recurrence_ended_at": "2023-11-07T05:31:56Z",
"veterinary_practice_id": "<string>",
"veterinarian_person_id": "<string>",
"medication_id": "<string>",
"refills_remaining": 123,
"prescription_expires_on": "2023-12-25",
"catalogue_item_id": "<string>",
"result_status": "pending",
"details": {},
"performed_in_house": true,
"due_start_at": "2023-11-07T05:31:56Z",
"duration_minutes": 123,
"task_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"performed_by_name": "<string>",
"veterinarian_name": "<string>",
"veterinary_practice_name": "<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)"
}Change a medical record
Changes a record: a test’s result, a diagnosis’s notes, a new date. Its task moves with it, and is marked done when the record is. To mark a scheduled record done and make the next of a series, complete it instead. Needs write on Animals.
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/animals/animals/{id}/medical/{recordId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"result_status": "negative",
"notes": "Negative on both."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({result_status: 'negative', notes: 'Negative on both.'})
};
fetch('https://{organization}.rescueconsole.com/api/animals/animals/{id}/medical/{recordId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/animals/{id}/medical/{recordId}"
payload = {
"result_status": "negative",
"notes": "Negative on both."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"record_type": "vaccination",
"name": "<string>",
"performed_on": "2023-12-25",
"due_on": "2023-12-25",
"notes": "<string>",
"performed_by_person_id": "<string>",
"recurrence_interval": 123,
"recurrence_unit": "day",
"series_id": "<string>",
"recurrence_ended_at": "2023-11-07T05:31:56Z",
"veterinary_practice_id": "<string>",
"veterinarian_person_id": "<string>",
"medication_id": "<string>",
"refills_remaining": 123,
"prescription_expires_on": "2023-12-25",
"catalogue_item_id": "<string>",
"result_status": "pending",
"details": {},
"performed_in_house": true,
"due_start_at": "2023-11-07T05:31:56Z",
"duration_minutes": 123,
"task_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"performed_by_name": "<string>",
"veterinarian_name": "<string>",
"veterinary_practice_name": "<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
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The animal's record ID (not its Pet ID).
The medical record's ID.
Body
Send only what changes. Null clears a date, the notes, the booked time, the practice, the vet, the catalogue item, the result or the details. The record type, the recurrence, the medication and the prescription cannot be changed here.
Cannot be blank.
The date it was done. Leave it out for something still to do.
The date it is due. A record with a due_on and no performed_on is scheduled, and a task is made for it, assigned to whoever will do it.
Who did it, or will: a person on file. The person who made the key, unless you say.
Done at your own clinic. A record done in house names no veterinary_practice_id.
Where it was done: an organization on file.
The vet: a person on file.
An item from your medical catalogue, of the kind the record type takes: a diagnosis for a condition, a test for a test, a vaccine for a vaccination, a treatment for a treatment, a procedure for a procedure. The other record types take none.
A test's outcome. Refused on any other record type.
pending, normal, abnormal, positive, negative, inconclusive, null Replaced whole. The record's own fields. For a vaccination, treatment, exam or procedure, and for any record made from a catalogue item, each key must be one of its fields, and each value that field's kind: text, a number, true or false, a YYYY-MM-DD date, an HH:MM time, or one of a list's options. A vaccination's fields include lot_number, product_expires_on, method and site; a procedure's include will_alter. Other records keep short text, numbers or true or false under keys of your own.
The time it is booked for. Needs a due_on.
How long it is booked for, from 5 to 1,440 minutes. An hour when you give a start time and no length.
5 <= x <= 1440Response
The record, as it now is.
vaccination, treatment, procedure, test, medication, exam, condition, preventative How many units apart a recurring record falls.
day, week, month, year, null The first record of a recurring series, shared by every record in it.
When the series was stopped.
Refills left. Null is not tracked, which is different from 0.
pending, normal, abnormal, positive, negative, inconclusive, null The task made for it while it was scheduled.
In the list only.
In the list only.
In the list only.