Jump to Content
Guides
Recipes
API Reference
Discussions
v1.0
Log In
API Reference
Log In
v1.0
Guides
Recipes
API Reference
Discussions
Retrieves a breed
All
Pages
Start typing to search…
JUMP TO
AIMS Webservices API
Aims
Find holding records by num and program_ids
get
Find holding records associated with herd by num and program_ids
get
Find premises by num
get
Find person by license
get
Find person by person number
get
Find person by name
get
Find programs by enrollment number
get
WLIC Webservices API
PremiseRenewalStatus
Create a program visit for a program participation(s)
get
CoreOne WebServices v2 API
Access
Login and get token
get
Logout
post
Accession
Get accessions for a herd
get
Get all accessions
get
Return an accession
get
Delete an accession
del
Reassign an accession
post
Accession Sample
Get sample Accessions for a Herd
get
Get all sample Accessions
get
Return a sample Accession
get
Delete a sample Accession
del
Reassign a sample Accession
post
Activity 2
Activities for Entity
get
Close Activity
post
Activities for Entity
get
Activity 2 Sample
Get sample Activity for Entity
get
Close sample Activity
post
Sample Activities for Entity
post
Activity
Activities
get
Create an Activity
post
Retrieves an Activity
get
Updates an Activity
put
Delete an Activity
del
Reopen an activity
post
Retrieves index of my activities
get
Retrieves index of team activities
get
Assign an Activity
post
Unassign an Activity
post
Creates an activity association
post
Reassigns an activity entity
post
Activity Sample
Get all sample Activities
get
Create sample activity
post
Return an activity
get
Updates sample Activity
put
Delete sample Activity
del
Reopen sample activity
post
Retrieves index of my sample activities
get
Retrieves index of team activities
get
Assign sample activity
post
Unassign sample activity
post
Create sample activity association
post
Reassigns sample activity entity
post
Activity Type
Activity Types
get
Create an activity type
post
Retrieves an activity_type
get
Delete an activity type
del
Updates an activity type
put
Activity Type Sample
Activity Types
get
Create sample activity type
post
Return a sample Activity Type
get
Delete sample activity type
del
Updates a sample activity type
put
Activity Update
Retrieve Activity Update
get
Create an Activity Update
post
Updates an Activity Update
put
Delete an Activity Update
del
Activity Update Sample
Retrieve sample Activity Update
get
Create sample Activity Update
post
Updates sample Activity Update
put
Delete sample Activity Update
del
Animal Event
Create an Animal Event
post
Animal Event Sample
Create a sample Animal Event
post
Animal List Categories
Animal List Category
get
Retrieves an Animal List Category
get
Animal List Category Sample
Return sample Animal List Categories
get
Retrieves an Animal List Category
get
Animal List
Get all animal lists
get
Return animal list
get
Delete animal list
del
Animal List Sample
Retrieves sample Animal Lists
get
Return sample Animal List
get
Delete sample Animal List
del
Animal Tag
Create an Animal Tag
post
Return animal tags
get
Update an Animal Tag
put
Delete animal tag
del
Animal Tag Sample
Create sample Animal Tag
post
Return sample Animal Tags
get
Update sample Animal Tag
put
Delete sample Animal Tag
del
Animal
Return animal with optional tags
get
Update an animal
put
Create an Animal
post
Search animals with optional tags
get
Return animal history report
get
Resurrect animal
get
Destroy Animal
del
Animal Sample
Return sample animal with optional tags
get
Create sample Animal
post
Search sample Animals with optional tags
get
Return sample animal history report
get
AssociatedHerd
Find associated herds
get
Create associated herd
post
Update an associated herd
put
Delete an associated herd
del
AssociatedHerd Sample
Find sample associated herds
get
Create sample associated herd
post
Update sample associated herd
put
Delete sample associated herd
del
AssociatedHoldingHerd
Find associated holding herds
get
Create associated holding herd
post
Update an associated holding herd
put
Delete an associated holding herd
del
AssociatedHoldingHerd Sample
Find sample associated holding herds
get
Create sample associated holding herd
post
Update sample associated holding herd
put
Delete sample associated holding herd
del
AssociatedPerson
Find associated people
get
Create associated person
post
Update an associated person
put
Delete an associated person
del
AssociatedPerson Sample
Find sample associated people
get
Create sample associated person
post
Update sample associated people
put
Delete sample associated person
del
Attachment
Attachments Index
get
Create an attachment
post
Retrieve an attachment
get
Delete an attachment
del
Download attachment
get
Add keyword to attachment
put
Set fields for attachment
put
Attachment Sample
Find sample attachments
get
Create sample attachments
post
Update sample attachment
get
Delete sample attachment
del
Download sample attachment
get
Add keyword to sample attachment
put
Set field for sample attachment
put
BrandCertificate
Brand Certificates
get
Create a brand certificate
post
Retrieve a brand certificate
get
Delete a brand certificate
del
Updates a brand certificate
put
Retrieves brand certificates for an entity
get
Retrieves brand certificate brand history
get
Inactivate brand certificate
put
Renew brand certificate
put
Print brand certificate
get
BrandCertificate Sample
Find sample brand certificates
get
Create brand certificate
post
Retrieve sample brand certificate
get
Delete sample brand certificate
del
Update sample brand certificate
put
Retrieves sample brand certificates for an entity
get
Retrieves sample brand certificate brand history
get
Inactivate sample brand certificate
put
Renew sample brand certificate
put
Print sample brand certificate
get
Brand Location
Brand Locations
get
Create a brand location
post
Retrieves a brand location
get
Delete a brand location
del
Updates a brand location
put
Brand Location Sample
Retrieve sample Brand Locations
get
Create sample Brand Location
post
Retrieve sample Brand Location
get
Delete sample Brand Location
del
Update sample Brand Location
put
Brand
Brands
get
Create a brand
post
Retrieves a brand
get
Delete a brand
del
Updates a brand
put
Save a brand picture
post
Remove a brand picture
put
Brand Sample
Retrieve sample Brands
get
Create Brand
post
Retrieve sample Brand
get
Delete sample Brand
del
Update sample Brand
put
Save sample Brand Picture
post
Remove sample Brand Picture
put
Breed
Breeds
get
Create a breed
post
Retrieves a breed
get
Delete a breed
del
Updates a breed
put
Breed Sample
Retrieve sample Breeds
get
Create Breed
post
Retrieve sample Breed
get
Delete sample Breed
del
Update sample Breed
put
Bulk Tank Manufacturer
Bulk Tank Manufacturers
get
Create a bulk tank manufacturer
post
Retrieves a bulk tank manufacturer
get
Delete a bulk tank manufacturer
del
Updates a bulk tank manufacturer
put
Bulk Tank Manufacturer Sample
Retrieve sample Bulk Tank Manufacturers
get
Create Bulk Tank Manufacturer
post
Retrieve sample Bulk Tank Manufacturer
get
Delete sample Bulk Tank Manufacturer
del
Update sample Bulk Tank Manufacturer
put
Capability
Capabilities
get
Retrieves a Capability
get
Capability Sample
Retrieves sample Capabilities
get
Return sample Capability
get
Certification Participation
Retrieves a certification participants
get
Retrieves a certification participants for an entity
get
Retrieves a certification participation
get
Creates a certification participation
post
Updates a certification participation
put
Deletes a certification participation
del
Creates a quick certification participation
post
Creates a certification participation association
post
Retrieves a certification participants for an associated entity
get
Downloads a dart badge attachment
get
Certification Participation Sample
Return sample certification participants
get
Retrieves sample certification participants for an entity
get
Retrieves a sample certification participation
get
Creates a sample certification participation
post
Updates a sample certification participation
put
Delete a sample certification participation
del
Creates a sample quick certification participation
post
Creates a sample certification participation association
post
Retrieves sample certification participants for an associated entity
get
Downloads a sample dart badge attachment
get
Certification
Certifications
get
Create a certification
post
Retrieves a certification
get
Delete a certification
del
Updates a certification
put
Duplicates a certification
get
Certification Sample
Certificiations
get
Create sample certification
post
Retrieves a sample Certification
get
Delete sample Certification
del
Updates a sample Certification
put
Duplicates a sample certification
get
Certification Update
Retrieves a certification update
get
Updates a certification updates
put
Create a certification update
post
Deletes a certification update
del
Certification Update Sample
Retrieves a sample certification update
get
Updates a sample certifications updates
put
Creates a sample certification update
post
Deletes a sample certification update
del
ConfigSetting
Config Settings
get
Create a Config Setting
post
Retrieves a config setting
get
Delete a config setting
del
Updates a config setting
put
ConfigSetting Sample
Find sample Config Settings
get
Create sample Config Setting
post
Retrieves a sample Config Setting
get
Delete sample Config Setting
del
Updates a sample Config Setting
put
Country
Countries
get
Create a country
post
Updates a country
put
Country Sample
Find sample Countries
get
Create sample Country
post
Update sample Country
put
County
County
get
Retrieves a County
get
County Sample
Find sample Counties
get
Retrieve sample County
get
DeathReason
Death Reasons
get
Create a death reason
post
Updates a death reason
put
DeathReason Sample
Find sample Death Reasons
get
Create sample Death Reason
post
Update sample Death Reason
put
Disease
Diseases
get
Create a disease
post
Retrieves a disease
get
Updates a disease
put
Disease Sample
Find sample Diseases
get
Create sample Disease
post
Retrieves a sample Disease
get
Updates a sample Disease
put
Event Type
Event Types
get
Create an event type
post
Updates an event type
put
EventType Sample
Find sample Event Types
get
Create sample Event Type
post
Update sample Event Type
put
Herd
Return herd with optional animals
get
Updates a herd
put
Delete a Herd
del
Return program visits for a herd scoped by programs
get
Herds
get
Create a herd
post
Return current animals for a herd
get
Return deceased animals for a herd
get
Set owner for a herd
post
Herd Sample
Return sample herd with optional animals
get
Updates a sample herd
put
Delete sample herd
del
Return sample program visits for a sample herd scoped by sample programs
get
Find sample herds
get
Create sample herd
post
Return current animals for a sample herd
get
Return deceased animals for a sample herd
get
Set owner for a sample herd
post
HoldingType
Holding Types
get
Create a holding type
post
Updates a holding type
put
HoldingType Sample
Find sample Holding Types
get
Create sample Holding Type
post
Update sample Holding Type
put
Holdings
Search holdings with optional herds
get
Create a Holding
post
Return holding with optional herds
get
Updates a Holding
put
Delete a Holding
del
Create a Holding with Owner
post
Holdings Sample
Find sample Holdings with optional herds
get
Create sample Holding
post
Retrieves a sample Holding with optional herds
get
Updates a sample Holding
put
Delete sample Holding
del
Inventory Record
Inventory Records
get
Create an inventory record
post
Return an inventory record
get
Delete an inventory record
del
Update an inventory record
put
Inventory Record Sample
Find sample Inventory Records
get
Create sample Inventory Record
post
Retrieves a sample Inventory Record
get
Updates a sample Inventory Record
put
Delete sample Inventory Record
del
Job
Jobs
get
Create a job
post
Updates a job
put
Job Sample
Find sample Jobs
get
Create sample Job
post
Update sample Job
put
Lab
Labs
get
Create a Lab
post
Retrieves a lab
get
Updates a lab
put
Lab Sample
Find sample Labs
get
Create sample Lab
post
Retrieves a sample Lab
get
Updates a sample Lab
put
Lab Test
Lab Tests
get
Create a Lab Test
post
Retrieves a lab test
get
Updates a lab test
put
Lab Test Sample
Find sample Lab Tests
get
Create sample Lab Test
post
Retrieves a sample Lab Test
get
Updates a sample Lab Test
put
Lims Accession
Get all lims accessions
get
Create lims accession
post
Return a lims accessions
get
Delete lims accession
del
Update lims accession
post
Lims Accession Sample
Find sample Lims Accessions
get
Create sample Lims Accession
post
Retrieves a sample Lims Accession
get
Delete sample Lims Accession
del
Updates a sample Lims Accession
put
Lims Specific Test
Lims specific tests
get
Lims Test Family
Lims test families
get
Create lims test family
post
Retrieve lims test family
get
Update a lims test family
put
Lookup
Lookups
get
Create a lookup
post
Return Lookup
get
Updates a lookup
put
Lookup Sample
Find sample Lookups
get
Create sample Lookup
post
Retrieves a sample Lookup
get
Updates a sample Lookup
put
Medicine Manufacturer
Medicine Manufacturers
get
Create a Medicine Manufacturer
post
Retrieves a Medicine Manufacturer
get
Updates a Medicine Manufacturer
put
Medicine Manufacturer Sample
Find sample Medicine Manufacturers
get
Create sample Medicine Manufacturers
post
Retrieves a sample Medicine Manufacturer
get
Updates a sample Medicine Manufacturer
put
Medicine
Medicines
get
Create a Medicine
post
Retrieves a medicine
get
Updates a medicine
put
Medicine Sample
Find sample Medicine
get
Create sample Medicines
post
Retrieves a sample Medicine
get
Updates a sample Medicine
put
Menu Item
Menu Items
get
Create a Menu Item
post
Updates a menu item
put
Menu Item Sample
Find sample Menu Items
get
Create sample Menu Items
post
Updates a sample Menu Item
put
Movement
Movements
get
Retrieve a movement
get
Delete a movement
del
Movement Sample
Retrieves sample Movements
get
Return sample Movement
get
Delete sample Movement
del
Movement Type
Movement Types
get
Create a Movement Type
post
Updates a Movement Type
put
Movement Type Sample
Find sample Movement Types
get
Create sample Movement Type
post
Update sample Movement Type
put
Note
Find all notes
get
Create a note
post
Retrieve a note
get
Delete a note
del
Update a note
put
Note Sample
Notes
get
Create sample note
post
Retrieves a sample Note
get
Delete sample Note
del
Updates a sample Note
put
NUI
Show history
get
Create nui inventory
post
Update nui inventory
put
Create nui event
post
Destroy nui event
post
Group movements
get
Create nui group movement
post
Retrieves nui group movement
get
Destroy nui group movement
del
Update nui group movement
put
Movements
get
Create nui movement
post
Show nui master movement
get
Destroy nui master movement
del
Update nui master movement
put
NUI Sample
Show sample history
get
Create sample nui
post
Update sample nui inventory
put
Create sample nui event
post
Destroy sample nui event
post
Show sample nui master movement
get
Destroy sample nui master movement
del
Destroy sample nui master movement
put
Permission
Permissions
get
Create a permission
post
Delete a Permission
del
Updates a Permission
put
Permission Sample
Find sample Permissions
get
Create sample permission
post
Delete sample Permission
del
Updates a sample Permission
put
Permit
Permits
get
Create a permit
post
Return a permit
get
Update a permit
put
Delete Permit
del
Get permits for an entity
get
Get Permit PDF
get
Create Permit Update
post
Create Permit Bulk Updates
post
Update Permit Update
put
Delete Permit Update
del
Close Permit Update
post
Update Permit Test
put
Permit Sample
Find sample Permits
get
Create sample Permit
post
Retrieves a sample Permit
get
Updates a sample Permit
put
Deletes a sample Permit
del
Get sample Permits for an Entity
get
Get sample Permit PDF
get
Create sample Permit Update
post
Create sample Permit Bulk Updates for Permit
post
Update Sample Permit Update
put
Delete Sample Permit Update
del
Close Sample Permit Update
post
Update Sample Permit Test
put
Person Job
Create a Person Job
post
Retrieves a Person Job
get
Updates a person job record
put
Updates a person job with person id
post
Person Job Sample
Create sample Person Job
post
Return sample Person Job
get
Update sample Person Job
put
Updates a sample person job with person id
post
Person
People
get
Create a Person
post
Retrieves a Person
get
Updates a Person
put
Delete a Person
del
Person Sample
Find sample People
get
Create sample person
post
Retrieves a sample Person
get
Updates a sample Person
put
Delete sample Person
del
Pls Lookup
Pls Lookup
get
Pls Lookup Sample
Get all sample Pls Lookups
get
Printer
Printers
get
Create a printer
post
Retrieves a printer
get
Delete a printer
del
Updates a printer
put
Printer Sample
Find sample Printers
get
Create sample printer
post
Retrieves a sample Printer
get
Delete sample Printer
del
Updates a sample Printer
put
Program Participation
Return program associations
get
Retrieves a program participants for an entity
get
Retrieves a program participation
get
Updates a program participation
put
Creates a program participation
post
Delete a program participation
del
Retrieves a program inspectors
get
Retrieves a program participants
get
Creates a program participation association
post
Retrieves a program participants by county
get
Updates a program participation enrollment number
put
Mass change status of program participations
post
Downloads an lcp dealer license
get
Program Participation Sample
Return sample program associations
get
Retrieves a sample program participants for an entity
get
Retrieves a sample program participation
get
Updates a sample program participation
put
Creates a sample program participation
post
Delete a sample program participation
del
Retrieves sample program inspectors
get
Retrieves sample program participants
get
Creates a sample program participation association
post
Retrieves sample program participants by county
get
Updates a sample program participation enrollment number
put
Mass change status of sample program participation
post
Downloads a sample lcp dealer license
get
Program
Search programs
get
Create a program
post
Retrieves a program
get
Updates a Program
put
Program Sample
Find sample program
get
Create sample Program
post
Retrieves a sample Program
get
Updates a sample Program
put
Program Visit
Retrieves a program visit
get
Creates a program visit
post
Updates a program visit
put
Deletes a program visit
del
Program Visit Sample
Retrieves a sample program visit
get
Creates a sample program visit
post
Updates a sample program visit
put
Deletes a sample program visit
del
Region
Regions
get
Create a region
post
Delete a region
del
Updates a Region
put
Region Sample
Find sample Regions
get
Create sample region
post
Delete sample Region
del
Updates a sample Region
put
Restriction Reason
Restriction Reasons
get
Create a Restriction Reason
post
Updates a Restriction Reason
put
Restriction Reason Sample
Retrieves sample restriction reasons
get
Create sample restriction reason
post
Update sample restriction reason
put
Restriction Type
Restriction Types
get
Create a Restriction Type
post
Updates a Restriction Type
put
Restriction Type Sample
Retrieves sample restriction types
get
Create a sample restriction type
post
Update sample restriction type
put
Role
Roles
get
Create a Role
post
Updates a Role
put
Role Sample
Retrieves sample roles
get
Create a sample role
post
Update sample role
put
Slaughter Abnormality
SlaughterAbnormalities
get
Create a SlaughterAbnormality
post
Updates a Slaugher Abnormality
put
Slaughter Abnormality Sample
Retrieves sample slaughter abnormalities
get
Create a sample slaughter abnormality
post
Update sample slaughter abnormality
put
Slaughter Grade
SlaughterGrades
get
Create a Slaughter Grade
post
Updates a Slaugher Grade
put
Species Herd Usage
Species Herd Usages
get
Create a Species Herd Usage
post
Updates a Species Herd Usage
put
Delete a Species Herd Usage
del
Species Herd Usage Sample
Find sample Species Herd Usages
get
Create sample Species Herd Usage
post
Updates a sample Species Herd Usage
put
Delete sample Species Herd Usage
del
Species Restriction
Species Restrictions
get
Create a Species Restriction
post
Updates a species restriction
put
Species Restriction Sample
Find sample Species Restrictions
get
Create sample Species Restrictions
post
Updates a sample Species Restriction
put
Species
Species
get
Create a Species
post
Retrieves a species
get
Updates a species
put
Species Sample
Find sample Species
get
Create sample Species
post
Retrieves a sample Species
get
Updates a sample Species
put
Specimen Type
Specimen Types
get
Create a Specimen Type
post
Updates a Specimen Type
put
Specimen Type Sample
Find sample specimen types
get
Create sample specimen type
post
Updates a sample specimen type
put
Status Color
Status Colors
get
Create a Status Color
post
Updates a Status Color
put
Status Color Sample
Find sample status colors
get
Create sample status color
post
Updates a sample status color
put
Survey Answer
Update survey answer
put
Update survey answer text
put
Tag Colour
Tag Colour
get
Create a Tag Colour
post
Updates a Tag Colours
put
Tag Colour Sample
Find sample tag colours
get
Create sample tag colour
post
Updates a sample tag colour
put
Tag Type
Tag Types
get
Create a Tag Type
post
Retrieves a Tag Type
get
Updates a Tag Type
put
Tag Type Sample
Find sample Tag Types
get
Create sample Tag Type
post
Retrieves a sample Tag Type
get
Updates a sample Tag Type
put
Team
Teams
get
Create a team
post
Retrieves a team
get
Delete a team
del
Updates a team
put
Team Sample
Find sample Teams
get
Create sample team
post
Retrieves a sample Team
get
Delete sample Team
del
Updates a sample Team
put
User
User
get
Create a User
post
Updates a User
put
Changes user password
put
Update users mobile status
put
Update users disabled state
put
User Sample
Find sample Users
get
Create sample user
post
Update sample user
put
Changes sample users password
put
Update sample users mobile status
put
Disables sample user
put
Usgs Geoname
Usgs Geoname
get
Retrieves a Usgs Geoname
get
Usgs Geoname Sample
Find sample Usgs Geonames
get
Retrieves a sample Usgs Geoname
get
Vaccination
Vaccinations
get
Vaccinations
get
Retrieves a vaccination
get
Destroy a Vaccination
post
Reassigns herd to a vaccination
post
Set a field for a vaccination
put
Zip Code
Zip Code
get
Retrieves a Zip Code
get
Zip Code Sample
Find sample Zip Codes
get
Retrieves a sample Zip Code
get
Powered by
Retrieves a breed
Ask AI
get
http://localhost:3000/api/v2/breeds/
{id}
Retrieves a Breed
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
http://localhost:3000
/api/v2/breeds/{id}
Response
Click
Try It!
to start a request and see the response here!