parturitions Endpoint
The parturitions endpoint provides bulk data related to FRESH events for all animals in the herd. All animals (live, sold, and dead) are included in the response for this endpoint.
|
|
|
| PATH PARAMETERS | |
|
{location-id}* |
Location identifier. For routes with “com.vas.dairies.id”, {location-id} is a VAS-specific dairy id, commonly referred to as {dairyId} when not part of an ICAR |
|
QUERY PARAMETERS |
|
|
page |
Sets the page number to display in the results. If no parameter is defined, page 1 displays. |
|
pageSize |
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. |
|
start-date-time |
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 to the date. A "T" is required to separate the date and time.  Examples
If no parameter is defined, all results for the past year are included. To specify a date range, include both a start-date-time and an end-date-time. |
|
end-date-time |
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. A "T" is required to separate the date and time. Examples
If no parameter is defined, all results for the past year are included. To specify a date range, include both a start-date-time and an end-date-time. |
Sample Request (cURL)
curl -X GET \
https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/parturitions \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'
Sample Response (JSON)
{
"view": {
"pageSize": 10,
"currentPage": 1,
"totalPages": 1,
"totalItems": 2
},
"member": [
{
"meta": {
"modified": "2021-01-22T13:32:12+00:00",
"created": "2021-01-22T13:32:12+00:00"
},
"animal": {
"identifier": {
"id": "100256948",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "10000406",
"scheme": "com.vas.animals.managementNumber"
},
{
"id": "34",
"scheme": "com.vas.animals.name"
},
{
"id": "66",
"scheme": "com.vas.animals.registrationId"
},
{
"id": "",
"scheme": "com.vas.animals.electronicId"
}
]
},
"location": {
"id": "8",
"scheme": "com.vas.dairies.id"
},
"pen": {
"identifier": {
"id": "57070",
"scheme": "com.vas.pens.id"
},
"alternativeIdentifiers": [
{
"id": "0",
"scheme": "com.vas.pens.number"
}
]
},
"eventDateTime": "2021-01-22T08:00:00+00:00",
"eventName": "FRESH",
"remark": "",
"daysInMilk": "0",
"ageInDays": "",
"lactation": "6",
"liveProgeny": "0",
"totalProgeny": 0,
"calvingEase": "",
"progeny": [
{
"identifier": {
"id": "",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "",
"scheme": "com.vas.animals.managementNumber"
}
],
"specie": "Cattle",
"birthDate": "2021-01-22T08:00:00+00:00",
"gender": "Female",
"managementTag": "",
"status": "Alive",
"isTwin": "False"
},
{
"identifier": {
"id": "",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "",
"scheme": "com.vas.animals.managementNumber"
}
],
"specie": "Cattle",
"birthDate": "2021-01-22T08:00:00+00:00",
"gender": "Female",
"managementTag": "",
"status": "Alive",
"isTwin": "False"
}
],
"daysDried": "0"
},
{
"meta": {
"modified": "2020-12-21T21:25:06+00:00",
"created": "2020-12-21T21:25:06+00:00"
},
"animal": {
"identifier": {
"id": "100132425",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "17232",
"scheme": "com.vas.animals.managementNumber"
},
{
"id": "",
"scheme": "com.vas.animals.name"
},
{
"id": "840003128506354",
"scheme": "com.vas.animals.registrationId"
},
{
"id": "982000418626741",
"scheme": "com.vas.animals.electronicId"
}
]
},
"location": {
"id": "8",
"scheme": "com.vas.dairies.id"
},
"pen": {
"identifier": {
"id": "57130",
"scheme": "com.vas.pens.id"
},
"alternativeIdentifiers": [
{
"id": "35",
"scheme": "com.vas.pens.number"
}
]
},
"eventDateTime": "2020-12-09T08:00:00+00:00",
"eventName": "FRESH",
"remark": "H",
"daysInMilk": "0",
"ageInDays": "",
"lactation": "4",
"liveProgeny": "1",
"totalProgeny": 1,
"calvingEase": "1",
"progeny": [
{
"identifier": {
"id": "",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "25468",
"scheme": "com.vas.animals.managementNumber"
}
],
"specie": "Cattle",
"birthDate": "2020-12-09T08:00:00+00:00",
"gender": "Female",
"managementTag": "25468",
"status": "Alive",
"isTwin": "False"
},
{
"identifier": {
"id": "",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "",
"scheme": "com.vas.animals.managementNumber"
}
],
"specie": "Cattle",
"birthDate": "2020-12-09T08:00:00+00:00",
"gender": "Female",
"managementTag": "",
"status": "Alive",
"isTwin": "False"
}
],
"daysDried": "63"
}
]
}curl -X GET \
https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/parturitions?start-date-time=2020-12-01&end-date-time=2020-12-03 \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'
Sample Response (JSON)
{
"view": {
"pageSize": 10,
"currentPage": 1,
"totalPages": 1
"totalItems": 1
},
"member": [
{
"meta": {
"modified": "2020-12-03T01:26:30+00:00",
"created": "2020-12-03T01:26:30+00:00"
},
"animal": {
"identifier": {
"id": "100126015",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "10000406",
"scheme": "com.vas.animals.managementNumber"
},
{
"id": "34",
"scheme": "com.vas.animals.name"
},
{
"id": "66",
"scheme": "com.vas.animals.registrationId"
},
{
"id": "",
"scheme": "com.vas.animals.electronicId"
}
]
},
"location": {
"id": "21",
"scheme": "com.vas.dairies.id"
},
"pen": {
"identifier": {
"id": "54908",
"scheme": "com.vas.pens.id"
},
"alternativeIdentifiers": [
{
"id": "0",
"scheme": "com.vas.pens.number"
}
]
},
"eventDateTime": "2020-12-01T08:00:00+00:00",
"eventName": "FRESH",
"remark": "TESTY",
"daysInMilk": "0",
"ageInDays": "",
"lactation": "1",
"liveProgeny": "1",
"totalProgeny": 1,
"calvingEase": "",
"progeny": [
{
"identifier": {
"id": "",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "18162",
"scheme": "com.vas.animals.managementNumber"
}
],
"specie": "Cattle",
"birthDate": "2020-12-01T08:00:00+00:00",
"gender": "Female",
"managementTag": "18162",
"status": "Alive",
"isTwin": "False"
},
{
"identifier": {
"id": "",
"scheme": "com.vas.animals.id"
},
"alternativeIdentifiers": [
{
"id": "",
"scheme": "com.vas.animals.managementNumber"
}
],
"specie": "Cattle",
"birthDate": "2020-12-01T08:00:00+00:00",
"gender": "Female",
"managementTag": "",
"status": "Alive",
"isTwin": "False"
}
],
"daysDried": "0"
}
]
}| Data Point | Data Type | Definition | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
meta data
The meta data specifies historical information for the animal record.
|
|||||||||||||||||||||||||||||||||||||||||
|
animal data
The animal data includes multiple data points to identify the animal.
|
|||||||||||||||||||||||||||||||||||||||||
|
location data
The location data specifies the animal's dairyId information.
|
|||||||||||||||||||||||||||||||||||||||||
|
pen data
The pen data specifies the animal's pen information.
|
|||||||||||||||||||||||||||||||||||||||||
|
eventDateTime |
string |
Date/time stamp (YYYY-MM-DDThh:mm:ss |
|||||||||||||||||||||||||||||||||||||||
|
eventName |
string |
FRESH (configurable by dairy in PULSE and/or DairyComp 305) |
|||||||||||||||||||||||||||||||||||||||
|
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 |
|||||||||||||||||||||||||||||||||||||||
|
liveProgeny |
integer |
Total live calves born |
|||||||||||||||||||||||||||||||||||||||
|
totalProgeny |
integer |
Total calves born, including those born dead |
|||||||||||||||||||||||||||||||||||||||
|
calvingEase |
string |
Level of calving difficulty. For example, some herds may use the following definitions for each value: 1: No problem 2: Slight problems 3: Needed assistance 4: Considerable force 5: Extreme difficulty |
|||||||||||||||||||||||||||||||||||||||
|
daysDried |
integer |
Number of days since the cow was removed from milk production |
|||||||||||||||||||||||||||||||||||||||
progeny data
|
|||||||||||||||||||||||||||||||||||||||||
HTTP Status Codes & Errors
| Status Code/Error | Description |
|---|---|
200 OK
|
Standard response for a successful HTTP request. |
201 Created
|
A |
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:
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. |
method successfully created a resource.Last Built: November 21, 2024
Data Disclaimer
The VAS Developer API is designed to align with industry standards, including NAAB National Association of Animal Breeders. www.naab-css.org and ICAR International Committee for Animal Recording (ICAR) is a global organization focused on the standardization of animal identification, recording, genetic evaluation, and data management.. However, due to the customizable nature of VAS applications, we cannot guarantee that our users' data comply with industry standards. VAS partners' use of the API is at their sole discretion and risk. The VAS Developer API is provided "as is," including any potential errors or missing data.