custom-items Endpoint

ReturnsUse 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.

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

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-specificClosed 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.

Query Parameters (required)

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

{item-names}stringREQUIRED

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.

  • https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/zones?calculateStatistics=true

This endpoint supports the following query parameters, which can be used to control or limit the results returned:

pageinteger

Sets the page number to display in the results.

  • page=3 sets the third page to display.

If no parameter is defined, page 1 displays.

pageSizeinteger

Sets the number of items to display on each page of results.

  • pageSize=50 sets the page to include 50 items per page.

If no parameter is defined, the response includes 10 items per page. The maximum pageSize is 1000.

Sample Request (cURL) 
curl -X GET \
https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/custom-items?item-names={item-name} \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'
Sample Request (cURL) - with multiple query parameters 
curl -X GET \
https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/custom-items?item-names={item-name},{item-name} \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'

Response Schema

The itemDefinitions data specifies data for the custom items.

Custom item number (configurable by dairy in PULSE and/or DairyComp 305)

Custom item name (configurable by dairy in PULSE and/or DairyComp 305)

Custom item description (configurable by dairy in PULSE and/or DairyComp 305)

Standard item number used in all VAS products, including PULSE and DairyComp 305

Animals data includes information about the animals with the requested custom item(s).

idinteger

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, EIDClosed 15-digit electronic ID number associated with the animal eartag, and isoId.

schemestring

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

The pen data specifies the animal's pen information.

id integer

VAS-specific pen identifier

schemestring

Identifies the data source as VAS: com.vas.pens.id

idinteger

Current pen number

schemestring

Identifies the data source as VAS: com.vas.pens.number

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

Item number defined by the user. May vary by dairy.

Item value

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

NOTE: See API Errors and HTTP Status Code Details for a list of API errors and HTTP status codes.
Sample Response (JSON) 
{
    "view": {
        "pageSize": 1,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 2
    },
    "member": [
        {
            "itemDefinitions": [
                {
                    "itemNumber": 67,
                    "name": "CALF1Closed Recent identified offspring",
                    "description": "Recent Identified Offspring",
                    "standardItemNumber": 67
                },
                {
                    "itemNumber": 68,
                    "name": "CALF2Closed Previous identified offspring",
                    "description": "Previous Identified Offspring",
                    "standardItemNumber": 68
                }
            ],
            "animals": [
                {
                    "identifier": {
                        "id": "100264744",
                        "scheme": "com.vas.animals.id"
                    },
                    "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"
                    },
                    "pen": {
                        "alternativeIdentifiers": [
                            {
                                "id": "45",
                                "scheme": "com.vas.pens.number"
                            }
                        ]
                    },
                    "items": [
                        {
                            "itemNumber": 67,
                            "value": null,
                            "valueType": null
                        },
                        {
                            "itemNumber": 68,
                            "value": null,
                            "valueType": null
                        }
                    ]
                }
            ]
        }
    ]
}
< Return to Animals Resource