Get a list of reminder protocol usage for a pet
1 min
GET
https://developer.digitail.io/api/v1/reminder-protocol-usages
Query Parameters
- filter[reminder_protocol_template_id]integerDescription
- filter[reminder_protocol_template_ids]stringDescription
- filter[latest]booleanDescription
- filter[due_date_type]stringDescriptionAlloweddueoverdueupcoming
- filter[active]booleanDescription
- filter[exclude_historical]booleanDescription
- filter[date_before]stringDescription
- filter[date_after]Description
- filter[last_fetched]stringDescription
Responses
200
- object
- dataobject[]
- idintegerExample
- clinic_idintegerExample
- reminder_protocol_template_idintegerExample
- record_idintegerExample
- pet_idintegerExample
- vet_idintegerExample
- treatment_type_idintegerExample
- due_datestring<date>ExampleDescriptionFormatdate
- administration_datestring<date>ExampleDescriptionFormatdate
- clinicdata
- due_date_utcstring<date>ExampleFormatdate
- administration_date_utcstring<date>ExampleFormatdate
- overwritten_byintegerExample
- is_activebooleanExample
- petobjectDescription
- idinteger
- nicknamestring
- speciesobject
- idinteger
- labelstring
- breedobject
- idinteger
- labelstring
- species_idinteger
- birthdaystring
- genderstring<male | female | unknown>Allowedmalefemaleunknown
- hormonal_statusintegerAllowed012
- profile_picturestring
- protocol_templateobject
- idintegerExample
- namestringExample
- clinic_idintegerExample
- is_enabledintegerExample
- product_categoriesobject[]Example
[ { "id": 74, "product_category_id": 153, "name": "Stupefiante", "products": [ { "id": 36, "name": "Product" } ], "created_at": "2023-07-11T15:24:15.000000Z" } ]- idintegerExample
- product_category_idintegerExample
- namestringExample
- productsobject[]
- idintegerExample
- namestringExample
- created_atstring<date-time>ExampleFormatdate-time
- visit_typesobject[]
- idinteger
- visit_type_idinteger
- namestring
- servicesobject[]
- idinteger
- namestring
- created_atstring<date-time>ExampleFormatdate-time
- template_overwritesobject[]Example
[ { "id": 2, "name": "Reminder Protocol Template Overwritten by this Protocol" } ]- idinteger
- namestring
- template_overwritten_byobject[]Example
[ { "id": 3, "name": "Reminder Protocol Template that Overwrites this Protocol" } ]- idinteger
- namestring
- intervalsobject[]Example
[ { "id": 1, "duration": 1, "unit": "day", "time_to_in_days": 1 } ]- idinteger
- durationinteger
- unitstring
- time_to_in_daysinteger
- created_atstring<date-time>ExampleFormatdate-time
- updated_atstring<date-time>ExampleFormatdate-time
- protocol_usage_itemsobject[]
- idintegerExample
- reminder_protocol_idintegerExample
- reminder_protocol_usage_itemable_idintegerExample
- reminder_protocol_usage_itemable_typestringExample
- reminder_protocol_usage_itemableobject
- namestringExample
- batch_numberstringExample
- manufacturerstringExample
- rabic_tag_numberstringExample
- expiration_datestring<date>ExampleFormatdate
- printed_filesobject[]
- idintegerExample
- namestringExample
- titlestringExample
- real_namestringExample
- printable_file_idintegerExample
- vet_idintegerExample
- patient_idintegerExample
- created_atstring<date-time>ExampleFormatdate-time
- linkslinks
- metameta
curl
curl --request GET \
--url https://developer.digitail.io/api/v1/reminder-protocol-usages \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://developer.digitail.io/api/v1/reminder-protocol-usages", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://developer.digitail.io/api/v1/reminder-protocol-usages")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://developer.digitail.io/api/v1/reminder-protocol-usages"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successful operation
{
"data": [
{
"id": 1,
"clinic_id": 1,
"reminder_protocol_template_id": 1,
"record_id": 1,
"pet_id": 1,
"vet_id": 1,
"treatment_type_id": 1,
"due_date": "2022-09-28T00:00:00.000Z",
"administration_date": "2022-09-28T00:00:00.000Z",
"clinic": {},
"due_date_utc": "2022-09-28T00:00:00.000Z",
"administration_date_utc": "2022-09-28T00:00:00.000Z",
"overwritten_by": 1,
"is_active": true,
"pet": {
"id": 0,
"nickname": "",
"species": {
"id": 0,
"label": ""
},
"breed": {
"id": 0,
"label": "",
"species_id": 0
},
"birthday": "",
"gender": "",
"hormonal_status": 0,
"profile_picture": ""
},
"protocol_template": {
"id": 1,
"name": "Reminder Protocol Template",
"clinic_id": 1,
"is_enabled": 1,
"product_categories": [
{
"id": 74,
"product_category_id": 153,
"name": "Stupefiante",
"products": [
{
"id": 36,
"name": "Vaccine"
}
],
"created_at": "2023-07-11T15:24:15.000Z"
}
],
"visit_types": [
{
"id": 0,
"visit_type_id": 0,
"name": "",
"services": [
{
"id": 0,
"name": ""
}
],
"created_at": "2023-07-11T07:41:16.000Z"
}
],
"template_overwrites": [
{
"id": 0,
"name": ""
}
],
"template_overwritten_by": [
{
"id": 0,
"name": ""
}
],
"intervals": [
{
"id": 0,
"duration": 0,
"unit": "",
"time_to_in_days": 0
}
],
"created_at": "2023-06-27T15:12:43.000000Z",
"updated_at": "2023-06-27T15:12:43.000000Z"
},
"protocol_usage_items": [
{
"id": 1,
"reminder_protocol_id": 1,
"reminder_protocol_usage_itemable_id": 1,
"reminder_protocol_usage_itemable_type": "App\\\\Models\\\\Treatment",
"reminder_protocol_usage_itemable": {
"name": "Product #9911",
"batch_number": "Test batch - 1123",
"manufacturer": "Test manufacturer",
"rabic_tag_number": "Rabic - #12121",
"expiration_date": "2023-11-22T00:00:00.000Z",
"printed_files": [
{
"id": 1,
"name": "Test certificate",
"title": "Test title",
"real_name": "Test real name.pdf",
"printable_file_id": 1,
"vet_id": 6,
"patient_id": 2,
"created_at": "2023-09-14T11:26:45.000000Z"
}
]
}
}
]
}
],
"links": {},
"meta": {}
}