custom-items Endpoint

Use the custom-items endpoint with set item-names parameters to retrieve bulk data for custom items in the location. To see all custom items for a location, use the custom-item-names endpoint.

NOTE: This endpoint requires Bulk Data Access.

IMPORTANT: This endpoint does not retrieve any calculated items. If you do not see an item in this endpoint, it is possible that the data already exists in a standard endpoint or the item is for internal use only by VAS. See VAS Developer API Resources to review all available VAS endpoints.

https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/custom-items?item-names={item-name}
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
QUERY PARAMETERS
{item-names}* integer	Specifies the custom item(s) to include in the results. To include multiple custom items, separate each custom item name with a comma. The query can contain up to 5 custom items. Example https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/custom-items?item-names={item-name},{item-name}
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.
* Required

Sample Response (JSON)

{
    "view": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 2
    },
    "member": [
        {
            "itemDefinitions": [
                {
                    "itemNumber": 37,
                    "name": "BLDAT Bullpen entry date",
                    "description": "Date entered bullpen",
                    "standardItemNumber": 37
                }
            ],
            "animals": [
                {
                    "identifier": {
                        "id": "100151618",
                        "scheme": "com.vas.animals.id"
                    },
                    "alternativeIdentifiers": [
                        {
                            "id": "2",
                            "scheme": "com.vas.animals.managementNumber"
                        },
                        {
                            "id": "test",
                            "scheme": "com.vas.animals.name"
                        }
                    ],
                    "pen": {
                        "alternativeIdentifiers": [
                            {
                                "id": "3",
                                "scheme": "com.vas.pens.number"
                            }
                        ]
                    },
                    "items": [
                        {
                            "itemNumber": 37,
                            "value": null,
                            "valueType": null
                        }
                    ]
                },
                {
                    "identifier": {
                        "id": "100151619",
                        "scheme": "com.vas.animals.id"
                    },
                    "alternativeIdentifiers": [
                        {
                            "id": "5",
                            "scheme": "com.vas.animals.managementNumber"
                        },
                        {
                            "id": "",
                            "scheme": "com.vas.animals.name"
                        }
                    ],
                    "pen": {
                        "alternativeIdentifiers": [
                            {
                                "id": "1",
                                "scheme": "com.vas.pens.number"
                            }
                        ]
                    },
                    "items": [
                        {
                            "itemNumber": 37,
                            "value": null,
                            "valueType": null
                        }
                    ]
                }
            ]
        }
    ]
}

Sample Response (JSON)

{
    "view": {
        "pageSize": 1,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 2
    },
    "member": [
        {
            "itemDefinitions": [
                {
                    "itemNumber": 67,
                    "name": "CALF1 Recent identified offspring",
                    "description": "Recent Identified Offspring",
                    "standardItemNumber": 67
                },
                {
                    "itemNumber": 68,
                    "name": "CALF2 Previous identified offspring",
                    "description": "Previous Identified Offspring",
                    "standardItemNumber": 68
                }
            ],
            "animals": [
                {
                    "identifier": {
                        "id": "100264744",
                        "scheme": "com.vas.animals.id"
                    },
                    "alternativeIdentifiers": [
                        {
                            "id": "9",
                            "scheme": "com.vas.animals.managementNumber"
                        },
                        {
                            "id": "",
                            "scheme": "com.vas.animals.name"
                        }
                    ],
                    "pen": {
                        "alternativeIdentifiers": [
                            {
                                "id": "0",
                                "scheme": "com.vas.pens.number"
                            }
                        ]
                    },
                    "items": [
                        {
                            "itemNumber": 67,
                            "value": null,
                            "valueType": null
                        },
                        {
                            "itemNumber": 68,
                            "value": null,
                            "valueType": null
                        }
                    ]
                },
                {
                    "identifier": {
                        "id": "100151608",
                        "scheme": "com.vas.animals.id"
                    },
                    "alternativeIdentifiers": [
                        {
                            "id": "14",
                            "scheme": "com.vas.animals.managementNumber"
                        },
                        {
                            "id": "sil",
                            "scheme": "com.vas.animals.name"
                        }
                    ],
                    "pen": {
                        "alternativeIdentifiers": [
                            {
                                "id": "45",
                                "scheme": "com.vas.pens.number"
                            }
                        ]
                    },
                    "items": [
                        {
                            "itemNumber": 67,
                            "value": null,
                            "valueType": null
                        },
                        {
                            "itemNumber": 68,
                            "value": null,
                            "valueType": null
                        }
                    ]
                }
            ]
        }
    ]
}

Response Schema

Data Point

Data Type

Definition

itemDefinitions data

The itemDefinitions data specifies data for the custom items.

Data Point	Data Type	Definition
itemNumber	integer	Item number defined by the user so it may differ for each dairy
name	string	Item name
description	string	Item description
standardItemNumber	integer	Standard item number used universally for all VAS systems

animals data

The animal data includes multiple data points to identify the animal.

Data Point

Data Type

Definition

identifier (primary animal identifier)

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

alternativeIdentifiers (other animal identifiers)

integer

Number assigned to an animal, usually visible on the eartag:

This number is commonly reused and is not unique to the animal on farm or in the VAS suite of products. cowNumber differs from the animal's dairyCowId, EID, and isoId.

scheme

string

Identifies the data source as VAS: com.vas.animals.managementNumber

string

Name assigned to an animal. This name is commonly reused and is not unique to the animal on farm or in the VAS suite of products.

scheme

string

Identifies the data source as VAS: com.vas.animals.name

pen data

The pen data specifies the animal's pen information.

Data Point	Data Type	Definition
identifier (primary pen identifier)
id	integer	Current pen number
scheme	string	Identifies the data source as VAS: com.vas.pen.number

items data

The items data includes details about the custom item information for the animal.

Data Point	Data Type	Definition
itemNumber	integer	Item number
value	string	Item value
valueType	number	Item value type: 0: Undefined 1: Cow 2: Sire 3: Pen 4: Technician 5: Eid 6: Date 7: Time 8: Integer 9: Float 10: String 11: Boolean 12: DateTime 13: Calf 14: Int64 15: Embryo 16: Hex

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.