pens Endpoint

Dairies include multiple pens to contain different types of animals. Use the pens endpoint to access pen information.

NOTE: This endpoint is only available in a deprecated version of the VAS Developer API. Please reach out to us at API Support to transition to the latest version of the VAS Developer API.

https://platform-vendor-api.vas.com/dairies/{dairyId}/pens
PATH PARAMETERS
{dairyId}* integer	VAS-specific A data value that originates from the VAS product line. dairy identifier
* Required
QUERY PARAMETERS
find string	Search query.
page integer	Sets the page number to display in the results. If no parameter is defined, page 1 displays.
pageSize integer	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.

Sample Response (JSON)

{
    "items": [
        {
            "id": 101,
            "createdAt": "2018-11-21T21:25:21+00:00",
            "penNumber": 0,
            "zoneId": 45,
            "penType": 0,
            "description": "",
            "capacity": 0,
            "isBullPen": false,
            "isArtificialInseminationPen": false,
            "isMilkingPen": false,
            "isDryPen": false,
            "isHospitalPen": false,
            "isCalfPen": false,
            "isUserPen": false,
            "isEnabled": true,
            "updatedAt": "2018-11-21T21:25:21+00:00"
        },
        {
            "id": 102,
            "createdAt": "2018-11-21T21:25:21+00:00",
            "penNumber": 1,
            "zoneId": 45,
            "penType": 0,
            "description": "",
            "capacity": 35,
            "isBullPen": false,
            "isArtificialInseminationPen": true,
            "isMilkingPen": true,
            "isDryPen": false,
            "isHospitalPen": false,
            "isCalfPen": false,
            "isUserPen": false,
            "isEnabled": true,
            "updatedAt": "2018-11-26T17:13:26+00:00"
        },
        {
            "id": 103,
            "createdAt": "2018-11-26T17:06:56+00:00",
            "penNumber": 1,
            "zoneId": 45,
            "penType": 0,
            "description": null,
            "capacity": 0,
            "isBullPen": false,
            "isArtificialInseminationPen": false,
            "isMilkingPen": false,
            "isDryPen": false,
            "isHospitalPen": false,
            "isCalfPen": false,
            "isUserPen": false,
            "isEnabled": true,
            "updatedAt": "2019-01-21T16:57:33+00:00"
        },
        {
            "id": 104,
            "createdAt": "2018-12-04T18:35:34+00:00",
            "penNumber": 1,
            "zoneId": 45,
            "penType": 0,
            "description": null,
            "capacity": 0,
            "isBullPen": false,
            "isArtificialInseminationPen": false,
            "isMilkingPen": false,
            "isDryPen": false,
            "isHospitalPen": false,
            "isCalfPen": false,
            "isUserPen": false,
            "isEnabled": false,
            "updatedAt": "2019-01-29T19:27:16+00:00"
        }
    ],
    "pageSize": 10,
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 4
}

Sample Response (JSON)

{
    "items": [
        {
            "id": 1934,
            "createdAt": "2018-11-21T21:25:21+00:00",
            "penNumber": 31,
            "zoneId": 23,
            "penType": 0,
            "description": "",
            "capacity": 56,
            "isBullPen": false,
            "isArtificialInseminationPen": false,
            "isMilkingPen": false,
            "isDryPen": false,
            "isHospitalPen": false,
            "isCalfPen": true,
            "isUserPen": false,
            "isEnabled": true,
            "updatedAt": "2018-11-21T21:25:21+00:00"
        },
        {
            "id": 1935,
            "createdAt": "2018-11-21T21:25:21+00:00",
            "penNumber": 32,
            "zoneId": 23,
            "penType": 0,
            "description": "",
            "capacity": 56,
            "isBullPen": false,
            "isArtificialInseminationPen": false,
            "isMilkingPen": false,
            "isDryPen": false,
            "isHospitalPen": false,
            "isCalfPen": true,
            "isUserPen": false,
            "isEnabled": true,
            "updatedAt": "2018-11-21T21:25:21+00:00"
        }
    ],
    "pageSize": 2,
    "currentPage": 3,
    "totalPages": 8,
    "totalItems": 15
}

Response Schema

Data Point	Data Type	Definition
id	integer	VAS-specific pen identifier
createdAt	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 pen was created. Learn more about VAS Developer API Date/Time Formatting.
penNumber	string	Pen number
zoneId	integer	Dairy zone to which the pen belongs
penType	integer	Reserved for future use
description	string	Pen description
capacity	integer	Maximum number of animals the pen can contain
isBullPen	boolean	Identifies the pen as a bull pen
isArtificialInseminationPen	boolean	Identifies the pen as an artificial insemination pen
isMilkingPen	boolean	Identifies the pen as a milking pen
isDryPen	boolean	Identifies the pen as dry (non-milking) pen
isHospitalPen	boolean	Identifies the pen as a hospital pen
isCalfPen	boolean	Identifies the pen as a calf pen
isUserPen	boolean	Identifies the pen as a custom, user-defined pen
isEnabled	boolean	Identifies the pen as active
updatedAt	string	Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the last pen update. Learn more about VAS Developer API Date/Time Formatting.

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 Pens Resource