zones Endpoint

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.

Use the zones endpoints to access information about dairy zones. Use the {location-id}/zones endpoint to list all of a location's zones, and use the {location-id}/zones/{zoneId} for information on a specific zone.

https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/zones https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/zones/{zoneId}
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.
{zoneId}* integer	VAS-specific A data value that originates from the VAS product line. location zone identifier
* Required
QUERY PARAMETERS (for {location-id}/zones endpoint only)
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.
calculateStatistics boolean	If available, include zone statistics in the results.

Sample Response (JSON)

{
    "view": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 1
    },
    "member": [
        {
            "identifier": {
                "id": 100,
                "scheme": "com.vas.zones.id"
            },
            "location": {
                "id": 21,
                "scheme": "com.vas.dairies.id"
            },
            "premiseId": null,
            "name": Default Zone The term "Zone" represents different dairy locations. PULSE Platform Zones may be different physical dairy locations (for example, multiple locations across the state or country) or different user-defined locations within a single dairy site (for example, Pens 1-100 are Zone 1, Pens 101-200 are Zone 2, etc.).,
            "number": 0,
            "type": 1,
            "herdcode": 11111118,
            "isEnabled": true,
            "createdAtDateTime": "2020-02-25T19:02:25+00:00",
            "updatedAtDateTime": "2020-12-03T18:35:53+00:00",
        }
    ]
}

Sample Response (JSON)

{
    "view": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 1
    },
    "member": [
        {
            "identifier": {
                "id": 100,
                "scheme": "com.vas.zones.id"
            },
            "location": {
                "id": 21,
                "scheme": "com.vas.dairies.id"
            },
            "premiseId": null,
            "name": Default Zone,
            "number": 0,
            "type": 1,
            "herdcode": 11111118,
            "isEnabled": true,
            "createdAtDateTime": "2020-02-25T19:02:25+00:00",
            "updatedAtDateTime": "2020-12-03T18:35:53+00:00",
        }
    ]
}

Response Schema

Data Point	Data Type	Definition
identifier (zone identifier)
id	integer	Zone type identifier
scheme	string	Identifies the data source as VAS: com.vas.zones.id
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 location scheme.
scheme	string	Identifies the data source as VAS: com.vas.dairies.id
premiseId	string	Government-assigned premise identifier
name	string	Zone name
number	integer	Zone number
type	string	Zone type: Undefined, Primary, Secondary, SourceFarm
herdcode	string	Herd code
isEnabled	boolean	Dairy zone is active
createdAtDateTime	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 zone was created. Learn more about VAS Developer API Date/Time Formatting.
updatedAtDateTime	string	Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the last zone 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.