Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Reminder Protocol Usages

Get a list of reminder protocol usage for a pet

Returns list of all of the reminder protocol usage for a pet. This information can be found in the UI on the pet's profile page under the "Preventive" tab.

get/api/v1/reminder-protocol-usages

Query parameters

filter[reminder_protocol_template_id]integer

Filter by reminder protocol template ID including the ones with the same treatment_type. The treatment_type is only applicable for clinic groups.

filter[reminder_protocol_template_ids]string

Filters by an array of Protocol Templates IDs

filter[latest]boolean

Filter by latest usage for each reminder protocol template

filter[due_date_type]'due' | 'overdue' | 'upcoming'

Filter by the state of an usage

filter[active]boolean

Filter by active status

filter[exclude_historical]boolean

Exclude usages generated by custom products added from the pet's health card

filter[date_before]string

Filter the usages that have administration_date smaller or equal than the given date (Y-m-d)

Filter the usages that have administration_date bigger or equal than the given date (Y-m-d)

filter[last_fetched]string

Filter the usages that have been updated after the given date (Y-m-d)

Parameters

#/paths/~1api~1v1~1pets/get/parameters/0 — unresolved $ref
#/paths/~1api~1v1~1files/get/parameters/0 — unresolved $ref

Response

Successful operation

linksLinks — unresolved $ref
metaMeta — unresolved $ref