pens/reproduction Endpoint

The reproduction endpoint provides bulk data related to reproduction status for all animals in a pen. Only live animals are included in the response for this endpoint.

NOTE: This endpoint requires Advanced Partner Access.

https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/pens/{penId}/reproduction
PATH PARAMETERS
{dairyId}* integer	VAS-specific A data value that originates from the VAS product line. dairy identifier
{penId}* integer	VAS-specific dairy pen identifier
* Required
QUERY PARAMETERS
page integer	Sets the page number to display in the results. If no parameter is defined, page 1 displays.
pageSize integer	Sets the number of items to display on one page of results. If no parameter is defined, the response includes 10 items per page. The maximum pageSize is 1000.

Sample Response (JSON)

{
    "view": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 1
    },
    "member": [
        {
            "identifier": {
                "id": "101590091",
                "scheme": "com.vas.animals.id"
            },
            "alternativeIdentifiers": [
                {
                    "id": "1",
                    "scheme": "com.vas.animals.managementNumber"
                },
                {
                    "id": null,
                    "scheme": "com.vas.animals.name"
                },
                {
                    "id": null,
                    "scheme": "com.vas.animals.registrationId"
                },
                {
                    "id": null,
                    "scheme": "com.vas.animals.electronicId"
                },
                {
                    "id": "1",
                    "scheme": "com.vas.animals.controlNumber"
                },
                {
                    "id": null,
                    "scheme": "com.vas.animals.visualId"
                }
            ],
            "location": {
                "id": "679",
                "scheme": "com.vas.dairies.id"
            },
            "pen": {
                "identifier": {
                    "id": "110222",
                    "scheme": "com.vas.pens.id"
                },
                "alternativeIdentifiers": [
                    {
                        "id": "3",
                        "scheme": "com.vas.pens.number"
                    }
                ]
            },
            "lactation": 0,
            "birthEventDateTime": "2021-11-02T05:00:00+00:00",
            "freshEventDateTime": null,
            "lastHeatEventDateTime": null,
            "lastBredEventDateTime": null,
            "timesBred": 0,
            "pregnancyResult": "Empty",
            "lastPregnantOrOpenEventDateTime": null,
            "gender": "Female",
            "lastDryEventDateTime": null,
            "reproductionCode": 0,
            "conceptionDate": null,
            "abortionDate": null,
            "foetalAge": 0,
            "daysOpen": 0,
            "daysSinceLastHeat": 0,
            "expectedCalvingDate": null,
            "lastServiceSire": null,
            "foetalAgeAtLastPregnancyCheck": 0,
            "abortionDeterminationDate": null,
            "previousSireConception": null,
            "previousTimesBred": 0
        }
    ]
}

Response Schema

Data Point

Data Type

Definition

animal data

The animal data includes multiple data points to identify the animal.

Data Point	Data Type	Definition
identifier (primary animal identifier)
id	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.
scheme	string	Identifies the data source as VAS: com.vas.animals.id
alternativeIdentifiers (other animal identifiers)
id	integer	Number assigned to an animal, usually visible on the eartag: This number is commonly reused and is not unique to the animal on farm or in the VAS suite of products. cowNumber differs from the animal's dairyCowId, EID, and isoId.
scheme	string	Identifies the data source as VAS: com.vas.animals.managementNumber
id	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.
scheme	string	Identifies the data source as VAS: com.vas.animals.registrationId
id	string	15-digit electronic ID Identifier (EID) number associated with the electronic animal eartag, often the same as the IsoId. The EID of an animal changes whenever the button in the electronic tag is replaced: The EID is subject to change and is therefore not an ideal source for unique animal identification data.
scheme	string	Identifies the data source as VAS: com.vas.animals.electronicId

location data

The location data specifies the animal's dairyId information.

Data Point	Data Type	Definition
id	string	VAS-specific dairy identifier
scheme	string	Identifies the data source as VAS: com.vas.dairies.id

pen data

The pen data specifies the animal's pen information.

Data Point	Data Type	Definition
identifier (primary pen identifier)
id	integer	VAS-specific pen identifier
scheme	string	Identifies the data source as VAS: com.vas.pen.id
alternativeIdentifiers (other pen identifiers)
id	integer	Current pen number
scheme	string	Identifies the data source as VAS: com.vas.pen.number

lactationNumber

integer

Current lactation number

birthEventDateTime

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 the animal birth date. Learn more about VAS Developer API Date/Time Formatting.

freshEventDateTime

string

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

lastHeatEventDateTime

string

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

lastBredEventDateTime

string

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

timesBred

integer

Number of times inseminated during current lactation

pregnancyResult

string

Result of latest pregnancy check:
Empty: Not pregnant
Pregnant: Pregnancy detected

Multiple: Twin or other multiple pregnancy

Unknown: Check was inconclusive

lastPregnantOrOpenEvent
DateTime

string

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

gender

string

Animal's gender: Male or Female

lastDryEventDateTime

string

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of when the cow was removed from milk production in the associated lactation number. Learn more about VAS Developer API Date/Time Formatting.

reproductionCode

integer

Reproduction code:

0: HEIFER - female, heifer

1: DNB Do Not Breed - Do not breed

2: FRESH - Fresh cow

3: OK/OPEN - OK to breed

4: BRED - Bred (by AI artificial insemination or bull)

5: PREG Pregnant - Pregnant animal

6: DRY - Dry animal

8: MALE - Male animal

conceptionDate

string

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

abortionDate

string

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the animal's last abort event.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.