xid Endpoint

Returns data related to animal identifier changes for all animals in the herd. All animals (live, sold, and dead) are included in the response for this endpoint.

GET https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/xid

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.

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.

Sample Request (cURL) 
curl -X GET \
https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/xid \
-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}/xid?pageSize=10 \
-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 UTCClosed Coordinated Universal Time, also known as Greenwich Mean Time (GMT) 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.

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

Sample Response (JSON) 
{
    "view": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 1
    },
    "member": [
        {
            "meta": {
                "created": "2022-06-22T20:04:28+00:00",
                "modified": "2022-06-22T20:04:28+00:00"
            },
            "animal": {
                "identifier": {
                    "id": "120898682",
                    "scheme": "com.vas.animals.id"
                },
            },
            "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"
                    }
                ]
            },
            "eventDateTime": "2022-06-22T05:00:00+00:00",
            "remark": "3273",
            "daysInMilk": 344,
            "ageInDays": 1416,
            "lactation": 2,
            "responsible": {
                "id": null,
                "technicianNumber": null,
                "technicianName": null
            }
        }
    ]
}
NOTE: See API Errors and HTTP Status Code Details for a list of API errors and HTTP status codes.
< Return to Registration Resource