post heats Endpoint

Sends heat data from activity monitoring devices to PULSE.

POST https://integrations.prod.vas.com/api/batches/locations/com.vas.dairies.id/{location-id}/heats

IMPORTANT: VAS currently supports the following data points for use in PULSE and DairyComp reports and worklists: 

All other data sent to VAS will not be visible from PULSE and DairyComp.

Parameters (required)

In addition to the standard Authorization and API Key header parameters, the following are required: 

{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.

ContentTypestringREQUIRED

Use application/json

Request bodyREQUIRED

Format required for the POST request. See the details below in the Request Schema.

Request Schema

Follow the ICARClosed International Committee for Animal Recording (ICAR) is a global organization focused on the standardization of animal identification, recording, genetic evaluation, and data management. resourceTypeCatalog

The meta data specifies information about the data or event source.

URI or reverse DNS that identifies the source system

Unique identifier within the source system

Indicates if the resource is deleted in the source system

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

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

Person or system that created the resource

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the start of valid period.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the end of valid period.

Unique identifier in the source system for this data or event

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the heat alert. Learn more about VAS Developer API Date/Time Formatting. This data is made available in DairyComp and PULSE as the following items:

VAS Developer API Data Point Default DairyComp Item Standard PULSE Item
eventDateTimeACDAT
ACTIM
ACTHTDAT
ACTHTTIM
NOTE: Item names in DairyComp and PULSE are customizable and may differ from the default listed above.

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

Method used to detect the heat: 

Bolus
Chemical
Collar
EarTag
Pedometer
Visual
Other

Likelihood of heat:

InHeat
Suspect
Potential

Manufacturer-specific number to indicate the certainty of the heat. This data is made available in DairyComp and PULSE as the following item:

VAS Developer API Data Point Default DairyComp Item Standard PULSE Item
deviceHeatProbability ACLEV ACTHTLVL
NOTE: Item names in DairyComp and PULSE are customizable and may differ from the default listed above.

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

Includes optimal breeding timeframe for an animal in heat. Learn more about VAS Developer API Date/Time Formatting.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the start of the optimal breeding window.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the end of the optimal breeding window.

Name of the optimum breeding window.

Sample Request (cURL) 
curl -X POST 
'https://integrations.prod.vas.com/api/batches/locations/com.vas.dairies.id/{location-id}/heats'  \
-H 'Authorization: bearer {authorization token}'  \
-H 'X-API-Key: {API key}'  \
-H 'Content-Type: application/json'  \
--data-raw '{
[
    {
        "resourceType": "ReproHeatEvent",
        "meta": {
            "source": "10.1.1.123",
            "sourceId": "10.1.1.234",
            "isDeleted": false,
            "modified": "2024-04-30T14:54:07.609Z",
            "created": "2024-04-30T14:54:07.609Z",
            "creator": "Technician123",
            "validFrom": "2024-04-30T14:54:07.609Z",
            "validTo": "2024-04-30T14:54:07.609Z"
        },
        "location": {
            "id": "{location}",
            "scheme": "com.vas.dairies.id"
        },
        "id": "{system name}",
        "eventDateTime": "2024-04-30T14:54:07.609Z",
        "animal": {
            "id": "123456789",
            "scheme": "com.vas.animals.id"
        },
        "heatDetectionMethod": "Chemical",
        "certainty": "InHeat",
        "deviceHeatProbability": 80,
        "expirationDateTime": "2024-04-30T14:54:07.609Z",
        "optimumInseminationWindow": [
            {
                "startDateTime": "2024-05-01T16:50:36.868Z",
                "endDateTime": "2024-05-01T16:50:36.868Z",
                "windowName": "optimal"
            }
        ]
    }
]
}'

Response

A successful response is 201 Created. See API Errors and HTTP Status Code Details for other possible responses and errors.

< Return to Bi-directional Data Exchange Overview