Loading...

IWDR API Documentation

Use the IWDR API to access your organizations data stored within the IWDR database. There are many data models retrievable from the IWDR API such as, dogs, litters, health data, status histories, and much more.

Getting Started

In order to use the IWDR API you must first acquire an authentication token. You can apply for an authentication token here, if you do not already have one.

To get started, or, for an overview of the setup process, we highly recommend reading the Quickstart page. You can also visit the Authentication page for information about using your IWDR API token to make authenticated HTTP requests.

What is an API and how can it help?

An API allows you to connect your existing database with the IWDR. Many organizations need to use the IWDR for its unique breeding selection and specialized program management tools, but also need to maintain data in their own internal database. This results in time consuming and costly data entry duplication. An API resolves this by automatically duplicating some of that data for you.

What services are available?

There are a number of options around how the API can work, and the IWDR does have some limitations around what data can be managed with an API.

It is faster, cheaper, and more accurate in tying pedigrees together if you enter fresh data directly into the IWDR, and then use the API to duplicate that data into your own database.There are some cases where we can enable data duplication the other way around (e.g. data is entered in your database and duplicated to the IWDR) however this is a time consuming endeavor restricted to very large organizations with sufficient IT staffing and budget - read more on this under Option C.

Option A: Create records for the following in the IWDR, then at a frequency you choose, duplicate the data into your database:

Most useful when you want to eliminate duplicate data entry but want to have EBVs and advanced genetic tools with collaboration but need to manage the puppy raiser, clients, etc in your database

You enter your data in IWDR and then IWDR sends a copy of the data you want electronically and adds this new data to your database. Easiest, least expensive to set up and ,eliminates duplicate data entry.

IWDR is Source
New puppies
YourDB is Source
Dog updates (names, status, key dates, microchip)
IWDR is Source
Diagnosis and genetic tests
YourDB is Source
IWDR is Source
Behavior Checklist
YourDB is Source
IWDR is Source
Litters
YourDB is Source
IWDR is Source
Other types of data you can specify in the API application
YourDB is Source

Option B: Enable survey data to be reviewed then electronically added to IWDR

You are already an IWDR user and you are just adding survey functionality.
  • We will provide links to specialized IWDR-approved forms. Currently an Annual Health Survey is available. In the future this will include puppy raiser survey data and other useful forms.
  • You email the surveys to your target audience: for example, puppy raisers and owners of withdrawn, breeding and graduated dogs. The surveys are prefilled with appropriate identification information from data for the person and dog. Your IT can do the set up to configure pulling the data from your own database.
  • Alternatively, if IWDR is your only database, we can set this up.
  • The survey responses are stored for review in IWDR and by specific action approve entry into IWDR.
IWDR is Source
New puppies
YourDB is Source
IWDR is Source
Diagnosis and genetic tests
YourDB is Source
IWDR Health Survey responses
IWDR is Source
Behavior Checklist
YourDB is Source

Option C: Very large orgs can apply to enable pushing dog and EBV related data from their database to the IWDR. There are some key limitations:

Best for organizations that want to have the EBV calculations and test mating features which also enhances effective collaboration. EBV data can be pushed back to your database if desired.

Data integrity must meet high standards. Upon your initial API application, we will discuss this in detail with you, however your dog data must meet certain standards as not to cause inaccuracies or duplications within the IWDR.

This is an involved process with multiple steps:

  • Work with the IWDR team to complete an initial migration of the data to IWDR. This may involve collaboration with canine team staff to review ancestral dog records, etc. On a case-by-case basis the IWDR may be able to offer contractor support for some of this work at your expense, pending staff availability. Migrations are the most time consuming task of the set up.
  • After the initial migration of your dog data, only puppies owned by your organization who are less than 36 days old can be imported via the API.
  • Must have highly skilled IT support: Your team will need to
    • Review and cleanse all your dog data to meet IWDR requirements
    • Build data files with required and other data required for import
    • Have a good understanding of API configuration on your end to properly set up the data transfer.
    • Set up and maintain mapping and storage of IWDR keys and the import and last update data.
    • Build the infrastructure/flows to process successful and failed API transactions.
IWDR is Source
YourDB is Source
New puppies (less than 35 days old) after initial migration
IWDR is Source
Diagnoses and genetic tests (preferred)
YourDB is Source
Discussion needed
IWDR is Source
Behavior Checklist- (optional)
YourDB is Source
Behavior Checklist (most often the case)

Guides

Quickstart

A quick intro for understanding who this API is designed for, and how to utilize it best.

Read more

Mapping

Learn how to accurately describe data mappings used by the IWDR API to ensure data integrity.

Read more

Authentication

Learn how to authenticate your IWDR API requests.

Read more

Errors

Read about the different types of errors returned by the IWDR API, and how to accurately handle them in a production environment.

Read more

Common Resources

You must sign in to view our available API resources.