measurements Endpoint

The POST measurements endpoint allows VAS partners to share animal measurements to PULSE.

https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/animals/measurements
PATH PARAMETERS
{location-id}* integer	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 International Committee for Animal Recording (ICAR) is a global organization focused on the standardization of animal identification, recording, genetic evaluation, and data management. location scheme.
* Required

OTHER PARAMETERS In addition to path parameters and the standard Authorization and API Key header parameters, the following are also required:
Content-Type	application/json
Request body*	Formatted JSON that includes the data to POST. See the Sample Request below.
* Required

Sample Request (cURL)

curl -L -X POST 'https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/animals/measurements' \
-H 'Authorization: bearer {authorization token}' 
-H 'X-API-Key: {API key}'  \
-H 'Content-Type: application/json'  
--data-raw '{
  "members": [
    {
        "animal" : {
          "identifier": {
              "id": 1009,
              "scheme": "com.vas.animals.id"
          }
        },
        "eventDateTime": "2020-12-23T19:56:04.180Z",
        "type": 5,
        "value": 40.0,
        "flag": true
    },
    {
        "animal" : {
          "identifier": {
              "id": 1010,
              "scheme": "com.vas.animals.id"
          }
        },
        "eventDateTime": "2020-12-23T19:56:04.180Z",
        "type": 5
        "value": 42.06,
        "flag": true
    }
  ]
}'

Request 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

eventDateTime*

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 when the event occurred. Learn more about VAS Developer API Date/Time Formatting.

type*

integer

Measurement type:

1: Locomotion score - The measurement of the animal's ability to walk normally

2: Body condition score - The measurement of the animal's entire body composition, determined by its visible fat, muscle, bone, and other physical indicators

3: Rectal temperature - Animal's temperature (in °F)

4: Body weight - Animal's weight (in lbs)

5: Body height - Animal's height (in inches)

value*

any

Measurement value

flag

boolean

Indicates whether Partner animal measurements need to be converted into VAS standard items. Currently, only supported measurements can be converted into items:

True: Supported animal measurements will be stored, then converted into items in the VAS system, which allows PULSE or DairyComp to use the measurement data in commands, reports, or widgets.

False: Animal measurements will not be converted, but they will still be stored and used for widgets.

* Required

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.

< Return to ANIMALS Resource