pens/{penId}/repro-status-observations Endpoint

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

GET https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/pens/{penId}/repro-status-observations

Path Parameters (required)

The following parameters must be included in the request path for this endpoint: 

{location-id}integerREQUIRED

VAS-specificClosed A data value that originates from the VAS product line. [dairy] location identifier. For routes with “com.vas.dairies.id”, {location-id} is a VAS-specific dairy id.

This endpoint supports the following query parameters, which can be used to control or limit the results returned:

pageinteger

Sets the page number to display in the results.

  • page=3 sets the third page to display.

If no parameter is defined, page 1 displays.

pageSizeinteger

Sets the number of items to display on each page of results.

  • pageSize=50 sets the page to include 50 items per page.

If no parameter is defined, the response includes 10 items per page. The maximum pageSize is 1000.

meta-modified-fromstring

Specifies a start date and time (optional) for which to include results. Format the date as YYYY-MM-DD. To include a start time as well, add Thh:mm:ss (in 24-hour UTCClosed Coordinated Universal Time, also known as Greenwich Mean Time (GMT) time) to the date. A "T" is required to separate the date and time. Learn more about VAS Developer API Date/Time Formatting.

  • 2020-02-01 specifies a start date of February 1, 2020.
  • 2020-02-01T12:00:00 specifies a start date and time of February 1, 2020 at 12:00.

If no parameter is defined, all results for the past year are included. To specify a date range, include both a meta-modified-from and a meta-modified-to. The date range can be set for up to two years. If the date range exceeds two years, the response only includes results for two years. See the sample request below.

meta-modified-tostring

Specifies an end date and time (optional) for which to include results. Format the date as YYYY-MM-DD. To include an end time as well, add Thh:mm:ss to the date (in 24-hour UTC time) to the date. A "T" is required to separate the date and time. Learn more about VAS Developer API Date/Time Formatting.

  • 2020-02-01 specifies an end date of February 1, 2020.
  • 2020-02-01T12:00:00 specifies an end date and time of February 1, 2020 at 12:00.

If no parameter is defined, all results for the past year are included. To specify a date range, include both a meta-modified-from and an meta-modified-to. The date range can be set for up to two years. If the date range exceeds two years, the response will only show results for two years. See the sample request below.

lactation-zeroboolean

Limits the response to non-lactating animals (lactation = 0), including heifers and bulls.

  • lactation-zero=true limits the results to heifers and bulls.

If no parameter is defined, the response includes all animals.

lactating-onlyboolean

Limits the response to cows (lactation > 0).

  • lactating-only=true limits the results to cows.

If no parameter is defined, the response includes all animals.

isEmbryoTransferboolean

Limits the response to BRED events including or excluding embryo transfers.

  • isEmbryoTransfer=true returns only BRED events with embryo transfers.
  • isEmbryoTransfer=false returns only BRED events without embryo transfers.

If no parameter is defined, all results are returned.

Sample Request (cURL) 
curl -X GET \
https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/pens/{penId}/repro-status-observations \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'
Sample Request (cURL) - with query parameter(s) 
curl -X GET \
https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/pens/{penId}/repro-status-observations?lactation-zero=true \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'

Response Schema

The meta data specifies historical information for the animal record.

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

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.

The animal data includes animal identification details.

idinteger

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, EIDClosed 15-digit electronic ID number associated with the animal eartag, and isoId.

schemestring

Identifies the data source as VAS: com.vas.animals.id

The location data specifies the animal's dairyId information.

VAS-specific dairy identifier

Identifies the data source as VAS: com.vas.dairies.id

The pen data specifies the animal's pen information.

id integer

VAS-specific pen identifier

schemestring

Identifies the data source as VAS: com.vas.pens.id

idinteger

Pen number at the time of the event

schemestring

Identifies the data source as VAS: com.vas.pens.number

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

Move event name (configurable by dairy in PULSE and/or DairyComp 305)

Additional information on the event, which may be automatically generated by PULSE and/or DairyComp 305 or manually entered. A remark is limited to 16 characters.

Number of days into current lactation at the time of the event. For dry cows, total days in most recent lactation including while dry.

Number of days since the animal birth date at the time of the event

Lactation number at the time of the event

The responsible data identifies the technician who performed the event if this was specified during event entry.

Technician identifier that is unique to each technician and used in all VAS products

Technician number, which is commonly reused and not unique in all VAS products

Technician name, which is commonly reused and not unique in all VAS products

The withdrawals data includes additional information about the animal's milk and meat withdrawal dates caused by the event. For an animal's current milk and meat withhold data, use the animals Endpoint.

As a result of the event, this is the animal product that cannot be sold before the withdrawal end date: Milk or Meat

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

NOTE: Only MyDC dairies include this data. DairyComp Unlimited dairies will return a value of null. To learn more about the different dairies supported at VAS, see DC Unlimited and MyDC Dairies.

The eventDetails data includes additional information about the event. The use of these data fields are optional to the user and dependent on the method of entry.

Protocol number for the treatment protocol selected during event entry (configurable by dairy in PULSE and/or DairyComp 305)

Protocol name for the treatment protocol selected for the event during event entry (configurable by dairy in PULSE and/or DairyComp 305)

Identifies the event as an embryo transfer: 

True: BRED event was an embryo transfer

False: BRED event was not an embryo transfer

Embryo data is included when isEmbryoTransfer=true.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of when the embryo transfer occurred (for BRED events including an embryo transfer). Learn more about VAS Developer API Date/Time Formatting.

If the BRED event was an embryo transfer, embryo details are provided.

Includes additional information about the embryo.

VAS-specific embryo identifier

Identifies the data source as VAS: com.vas.embryo.id

VAS-specific donor dam identifier

Identifies the data source as VAS: com.vas.donor.donorDamRegistrationId

VAS-specific donor dam identifier

Identifies the data source as VAS: com.vas.donor.donorDamNumber

Quality of the embryo:

0: Unspecified

1: Good

2: Fair

3: Poor

4: Dead (or Degenerating)

Stage at which the embryo was harvested:

0: Unspecified

1: Unfertilized

2: Simple Celled

3: Early Morula

4: Morula

5: Early Blastocyst

6: Blastocyst

7: Expanded Blastocyst

8: Hatched Blastocyst

9: Expanded and Hatched Blastocyst

Embryo storage method:

1: Fresh - Embryos retrieved from donors using an embryo flushClosed Embryos are harvested by being flushed out of a superovulated cow that has already been bred. or those gathered in a vial from an IVFClosed In-Vitro Fertilization. In relation to embryo transfers, IVF occurs when oocytes (eggs) are collected via OPU (ovum pick up), and then in a lab, semen is added to create embryos. procedure are considered to be "fresh," as they are transferred to a recipient animal shortly after retrieval and are not frozen or otherwise preserved.

2: Frozen - Embryos retrieved from donors or an IVF procedure are analyzed for viability, and those rated as grade 1 or 2 are considered suitable for freezing.

Embryo harvest method:

1: IVF - In vitro fertilization was used to retrieve unfertilized oocytesClosed Unfertilized eggs..

2: Flush - Fertilized embryos were flushed from donor.

4: LOPU - Laparoscopic ovum pick-up from donor was used.

100: Other - Other method was used.

Date the embryo was frozen

Container holding the embryo's straw

Number of the straw holding the embryo. Canes contain multiple straws and each straw holds a single embryo.

Includes additional information about the sire.

VAS-specific sire identifier. sireId differs from the animal's EID and isoId.

Identifies the data source as VAS: com.vas.sire.id

15-digit ISOClosed 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.

Identifies the data source as VAS: com.vas.sire.isoId

Dairy-specific sire identifier

Identifies the data source as VAS: com.vas.sire.default

Sire name

Semen company identification. For a listing of standard identifiers for the US, see NAAB Stud Codes.

Sire breed name. Learn more about VAS Developer API Cow Breeds.

Name of the tank or incubator that held the embryo:

Tank: The liquid nitrogen storage tank containing the cane with the embryo's straw.

Incubator: The warming unit containing the embryo's straw or mating.

Current status of the transfer:

1: Transferred - The transfer was completed.

2: Undetermined - The recipient animal was BRED following a TRANSFER event, so the source of the resulting pregnancy cannot be confirmed.

50: Aborted - The transfer resulted in an ABORT.

51: DOA - The transfer resulted in DOA (dead on arrival) calf or calves.

52: Successful - The transfer was successful.

53: Pregnant - The transfer resulted in a confirmed pregnancy.

54: Unsuccessful - The transfer did not result in a pregnancy.

55: RecipientSoldDied - The recipient animal was sold or died.

100: DeletedUnviable - Embryo was removed from inventory because it was deemed not viable.

101: DeletedLost - Embryo was removed from inventory because it was lost.

102: Broken - Embryo was removed from inventory because the container was broken.

103: ImproperThaw - Embryo was removed from inventory because the embryo was improperly thawed.

104: DeletedOther - Embryo was removed from inventory for other reasons.

105: IncorrectEntry - Embryo was removed from inventory due to data entry error.

127: Corrupted - Embryo was removed from inventory due to corrupted data.

Embyro breed name. Learn more about VAS Developer API Cow Breeds.

Embryo age (in days)

Method used to freeze the embryo:

0: Unknown: The method is not specified.

1: Slow: Embryo was cooled slowly using a low level of cryoprotectant and a programmable freezing machine.

2: DT: Direct transfer - Embryo was cooled quickly using a high level of cryoprotectant.

3: VIT: Vitrification - Embryo was cooled quickly using a flash freezing method.

4: OnFarm: Embryo was frozen on site.

Insemination method:

Implantation: Applies to embryo transfers

Insemination: Animal was bred using artificial insemination or mated with a bull

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

Dairy-specific breedingCode description

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.

Describes the breedingResultCode, as detailed above

Includes additional information about the sire used in the BRED event.

Includes additional information about the sire.

VAS-specific sire identifier. sireId differs from the animal's EID and isoId.

Identifies the data source as VAS: com.vas.sire.id

15-digit ISO 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.

Identifies the data source as VAS: com.vas.sire.isoId

Dairy-specific sire identifier

Identifies the data source as VAS: com.vas.sire.default

Sire name

Semen company identification. For a listing of standard identifiers for the US, see NAAB Stud Codes.

Sire breed name. Learn more about VAS Developer API Cow Breeds.

Reproductive status change observed for the given event: 

  • Aborted
  • Birthed
  • DoNotBreed
  • Inseminated
  • NotPregnant
  • Open
  • Pregnant
Sample Response (JSON) 
{
    "view": {
        "pageSize": 1000,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 2
    },
    "member": [
        {
            "meta": {
                "created": "2024-07-10T18:50:29+00:00",
                "modified": "2024-07-10T18:50:29+00:00"
            },
            "animal": {
                "identifier": {
                    "id": "103159008",
                    "scheme": "com.vas.animals.id"
                }
            },
            "location": {
                "id": "679",
                "scheme": "com.vas.dairies.id"
            },
            "pen": {
                "identifier": {
                    "id": "122708",
                    "scheme": "com.vas.pens.id"
                },
                "alternativeIdentifiers": [
                    {
                        "id": "9",
                        "scheme": "com.vas.pens.number"
                    }
                ]
            },
            "eventDateTime": "2024-06-16T16:00:00+00:00",
            "eventName": "BRED",
            "remark": null,
            "daysInMilk": 270,
            "ageInDays": 1306,
            "lactation": 2,
            "responsible": {
                "id": 28226,
                "technicianNumber": 2,
                "technicianName": "Levi"
            },
            "withdrawals": [
                {
                    "productType": "Milk",
                    "endDate": null
                },
                {
                    "productType": "Meat",
                    "endDate": null
                }
            ],
            "eventDetails": {
                "protocolNumber": null,
                "protocolName": null
            },
            "isEmbryoTransfer": true,
            "transferDate": "2024-06-21T05:00:00+00:00",
            "embryo": {
                "id": {
                    "id": "21158",
                    "scheme": "com.vas.embryo.id"
                },
                "donorIdentifiers": [
                    {
                        "id": "103160876",
                        "scheme": "com.vas.donor.donorDamRegistrationId"
                    },
                    {
                        "id": "1230",
                        "scheme": "com.vas.donor.donorDamNumber"
                    }
                ],
                "grade": 2,
                "stage": 4,
                "storage": 1,
                "recoveryType": 2,
                "frozenDate": null,
                "cane": null,
                "straw": null,
                "sire": {
                    "sireIdentifiers": {
                        "id": "0",
                        "scheme": "com.vas.sire.id"
                    },
                    "sireAlternativeIdentifiers": [
                        {
                            "id": null,
                            "scheme": "com.vas.sire.isoId"
                        },
                        {
                            "id": "11H11687",
                            "scheme": "com.vas.sire.default"
                        }
                    ],
                    "sireOfficialName": null,
                    "studCode": null,
                    "sireBreed": "H"
                },
                "location": null,
                "embryoStatus": 2,
                "breed": "HO",
                "embryoAge": 5,
                "freezeMethod": 0
            },
            "inseminationType": "Implantation",
            "breedingCode": "L",
            "breedingCodeDescription": "Lut",
            "breedingResultCode": "O",
            "breedingResultCodeDescription": "Open",
            "observedStatus": "Inseminated"
        },
        {
            "meta": {
                "created": "2024-07-10T18:50:29+00:00",
                "modified": "2024-07-10T18:50:29+00:00"
            },
            "animal": {
                "identifier": {
                    "id": "103159008",
                    "scheme": "com.vas.animals.id"
                }
            },
            "location": {
                "id": "679",
                "scheme": "com.vas.dairies.id"
            },
            "pen": {
                "identifier": {
                    "id": "110224",
                    "scheme": "com.vas.pens.id"
                },
                "alternativeIdentifiers": [
                    {
                        "id": "1",
                        "scheme": "com.vas.pens.number"
                    }
                ]
            },
            "eventDateTime": "2024-07-10T05:00:00+00:00",
            "eventName": "BRED",
            "remark": null,
            "daysInMilk": 294,
            "ageInDays": 1330,
            "lactation": 2,
            "responsible": {
                "id": 28226,
                "technicianNumber": 2,
                "technicianName": "Levi"
            },
            "withdrawals": [
                {
                    "productType": "Milk",
                    "endDate": null
                },
                {
                    "productType": "Meat",
                    "endDate": null
                }
            ],
            "eventDetails": {
                "protocolNumber": null,
                "protocolName": null
            },
            "isEmbryoTransfer": false,
            "transferDate": null,
            "embryo": null,
            "inseminationType": "Insemination",
            "breedingCode": "E",
            "breedingCodeDescription": "Excellent heat",
            "breedingResultCode": " ",
            "breedingResultCodeDescription": "Unknown",
            "straw": {
                "sire": {
                    "sireIdentifiers": {
                        "id": "0",
                        "scheme": "com.vas.sire.id"
                    },
                    "sireAlternativeIdentifiers": [
                        {
                            "id": null,
                            "scheme": "com.vas.sire.isoId"
                        },
                        {
                            "id": "11H11687",
                            "scheme": "com.vas.sire.default"
                        }
                    ],
                    "sireOfficialName": null,
                    "studCode": null,
                    "sireBreed": "H"
                }
            },
            "observedStatus": "Inseminated"
        }
    ]
}
NOTE: See API Errors and HTTP Status Code Details for a list of API errors and HTTP status codes.
< Return to Reproduction Resource