custom-item-names Endpoint

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

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-item-names
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

Sample Response (JSON)

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

Response Schema

Data Point	Data Type	Definition
itemName	string	Item name
itemDescription	string	Item description
standardItemNumber	number	Item number

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.