events/bred Endpoint

The events/bred endpoint provides information on a dairy cow's PULSE/DairyComp 305 BRED events. All animals (live, sold, and dead) are included in the response for this endpoint.

NOTE: This endpoint is only available in a deprecated version of the VAS Developer API. Please reach out to us at API Support to transition to the latest version of the VAS Developer API.

https://platform-vendor-api.vas.com/dairies/{dairyId}/cows/{dairyCowId}/events/bred
PATH PARAMETERS
{dairyId}* integer	VAS-specific A data value that originates from the VAS product line. dairy identifier
{dairyCowId}* integer	VAS-specific dairy cow identifier. This number is used in all VAS products, including PULSE and DairyComp 305. This identifier is unique to each animal in the VAS suite of products, and is the most stable and reliable source of animal identification data. dairyCowId differs from the animal's cowNumber, displayCowNumber, EID 15-digit electronic ID number associated with the animal eartag, and isoId.
* Required
QUERY PARAMETERS
lactation integer	Period of time initiated at calving/freshening when milk production begins until the animal is dried off and stops producing milk. If no parameter is defined, the response reflects the current lactation.
sinceDate string	Start date for which to include results (YYYY-MM-DD). If no parameter is defined, all results are returned.

Sample Response (JSON)

{
    "items": [
        {
            "id": 3810102,
            "createdAt": "2018-11-21T21:25:26+00:00",
            "eventDate": "2018-03-28T13:00:00+00:00",
            "eventCode": 5,
            "standardEventCode": 5,
            "eventDetails": {
                "interval": 31,
                "breedingCode": " ",
                "breedingCodeDescription": "",
                "breedingResultCode": "P",
                "breedingResultCodeDescription": "Pregnant",
                "sire": {
                    "sireDefault": "29AN1868",
                    "sireName": null,
                    "isoId": null,
                    "breed": "AN",
                    "studCode": 0
                },
                "activityLevel": 0,
                "description": "Pregnant (P)"
             },
            "eventName": "BRED",
            "remark": "29AN1868",
            "daysInMilk": 276,
            "ageInDays": 3427,
            "lactation": 7,
            "pen": {
                "id": 1969,
                "penNumber": 12,
                "zoneId": 23,
                "penType": 0,
                "capacity": 280
            },
            "updatedAt": "2018-11-21T21:25:26+00:00"
        },
        {
            "id": 3810129,
            "createdAt": "2018-11-21T21:25:26+00:00",
            "eventDate": "2018-02-25T15:00:00+00:00",
            "eventCode": 5,
            "standardEventCode": 5,
            "eventDetails": {
                "interval": 23,
                "breedingCode": " ",
                "breedingCodeDescription": "",
                "breedingResultCode": "O",
                "breedingResultCodeDescription": "Open",
                "sire": {
                    "sireDefault": "29AN1868",
                    "sireName": null,
                    "isoId": null,
                    "breed": "AN",
                    "studCode": 0
                },
                "activityLevel": 0,
                "description": "Open (O)"
            },
            "eventName": "BRED",
            "remark": "29AN1868",
            "daysInMilk": 245,
            "ageInDays": 3396,
            "lactation": 7,
            "pen": {
                "id": 1967,
                "penNumber": 10,
                "zoneId": 23,
                "penType": 0,
                "capacity": 317
            },
            "updatedAt": "2018-11-21T21:25:26+00:00"
			"protocolPlan": null	
        }
    ],
    "pageSize": 10,
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 1
}

Response Schema

Data Point

Data Type

Definition

integer

VAS-specific event identifier

createdAt

string

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC Coordinated Universal Time, also known as Greenwich Mean Time (GMT) time) of when the event was created. Learn more about VAS Developer API Date/Time Formatting.

eventDate

string

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of when the event occurred. Learn more about VAS Developer API Date/Time Formatting.

eventCode

integer

5: BRED - The animal was bred either by a bull or artificial insemination

standardEventCode

integer

VAS-specific event identifier:

5: BRED - The animal was bred either by a bull or artificial insemination

eventDetails data

Data Point

Data Type

Definition

interval

integer

The number of days since the last event

breedingCode

integer

Breeding code (configurable by dairy in PULSE and/or DairyComp 305)

breedingCodeDescription

string

Dairy-specific breedingCode description

breedingResultCode

integer

Breeding result:

A: Abortion - Breeding resulted in a pregnancy which aborted

C: Cancelled - An earlier breeding conceived an embryo. This is usually paired with a PREV event.

O: Open - More than 2 days since the last breeding or the result of an OPEN event from an examination

P: Pregnant - Breeding resulted in a pregnancy

R: Rebred - Re-bred within 48 hours of the last breeding event. The earlier BRED event is flagged as `R` instead of `O`.

IMPORTANT: Recent breedings may not have a breedingResultCode because the result of the breeding attempt may not yet be available.

breedingResultCodeDescription

string

Describes the breedingResultCode, as detailed above

Sire data

A sire is the bull whose semen was used for the insemination or embryo transfer.

Data Point	Data Type	Definition
sireDefault	integer	Dairy-specific sire identifier
sireName	string	Sire name
isoId	string	15-digit ISO International Organization for Standardization, a global organization that promotes commercial and industrial standards. number associated with the animal eartag, often the same as the electronicID. If the electronicID changes, the isoId does not. The isoId is a unique on-farm animal identifier. VAS recommends against changing an animal's isoId, and it is generally considered to be more stable than the EID.
breed	string	Sire breed name. Learn more about VAS Developer API Cow Breeds.
studCode	integer	Semen company identification. For a listing of standard identifiers for the US, see NAAB Stud Codes.

activityLevel

integer

Numeric value set by PULSE/DairyComp 305 if integrated with an activity-tracking system

description

string

General event description or summary

eventName

string

Event name

remark

string

Additional information on the event, which may be automatically generated by PULSE and/or DairyComp 305, or manually entered

daysInMilk

integer

Number of days into current lactation. For dry cows, total days in most recent lactation prior to being dried off.

ageInDays

integer

Number of days since the animal birth date

lactation

integer

Current lactation number

Pen data

Data Point	Data Type	Definition
id	integer	VAS-specific pen identifier
penNumber	integer	Pen number at the time of the event
zoneId	integer	Dairy zone to which the pen belongs
penType	integer	Reserved for future use
capacity	integer	Maximum number of animals the pen is equipped to contain

updatedAt

string

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the last event update. Learn more about VAS Developer API Date/Time Formatting.

HTTP Status Codes & Errors

Status Code/Error	Description
`200 OK`	Standard response for a successful HTTP request.
`201 Created`	A method successfully created a resource.
`202 Accepted`	The server accepted the request and will execute it at a later point.
`204 No Content`	The server successfully executed the method but returns no response body.
`400 Bad Request`	Bad request. Depending on the endpoint, additional error details may be sent in the response. Use the strategies below to troubleshoot the error: Check the request for any typos. Check the syntax of the request and verify the parameters provided fall within the expected range. For POST endpoints, verify that the request adheres to the logic of the VAS Developer API: Events may only be added to an animal's current lactation. Events cannot be added to animals in a sold/died status. NOTE: The resource URI is case-sensitive. If you are encountering unexpected 400 errors, check your URI for correct capitalization of resource names.
`401 Unauthorized`	Authentication failed due to invalid authentication credentials.
`403 Forbidden`	You are not permitted to access this resource.
`404 Not Found`	The resource could not be found. It is possible that the resource has been moved or deleted, or that there is a typo in your request.
`405 Method Not Allowed`	The requested method and resource are not compatible.
`429 Too Many Requests`	You sent too many requests within a given period and exceeded the rate limit.
`500 Internal Server Error`	A VAS server error has occurred and the request cannot be fulfilled.
`502 Bad Gateway`	The server did not receive a timely response from another server.
`503 Service Unavailable`	The server is not available, usually due to overloading or maintenance issues.
`504 Gateway Timeout`	The server, while acting as a gateway or proxy, cannot get a response in time.