custom-item-names Endpoint

Returns all custom items defined for the location. Use the custom-items endpoint to request custom item data for the herd.

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

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.

Path Parameters (required)

The following parameters must be included in the request path for this endpoint:

{location-id}integerREQUIRED

VAS-specific 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.

Sample Request (cURL)

curl -X GET \
https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/custom-item-names \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'

Response Schema

Sample Response (JSON)

{
    "view": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 8
    },
    "member": [
        {
            "itemName": "ABDAT",
            "itemDescription": "Abortion Date",
            "standardItemNumber": 38
        },
        {
            "itemName": "ADDAT",
            "itemDescription": "Abortion Determination Date",
            "standardItemNumber": 39
        },
        {
            "itemName": "AIDAT",
            "itemDescription": "Date heifer enters AI Pen",
            "standardItemNumber": null
        },
        {
            "itemName": "ARDAT",
            "itemDescription": "Archive Date",
            "standardItemNumber": 43
        },
        {
            "itemName": "BFDAT",
            "itemDescription": "Beef date",
            "standardItemNumber": 2001
        },
        {
            "itemName": "BLDAT",
            "itemDescription": "Bullpen Entry Date",
            "standardItemNumber": 37
        },
        {
            "itemName": "CALF1",
            "itemDescription": "Recent Identified Offspring",
            "standardItemNumber": 67
        },
        {
            "itemName": "CALF2",
            "itemDescription": "Previous Identified Offspring",
            "standardItemNumber": 68
        }
    ]
}

NOTE: See API Errors and HTTP Status Code Details for a list of API errors and HTTP status codes.

< Return to Animals Resource