zone Endpoint

There are multiple zone types, which can be identified using the types/zone 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.

https://platform-vendor-api.vas.com/types/zone
PATH PARAMETERS
None	No path parameters are required

Sample Response (JSON)

{
    "items": [
        {
            "id": 0,
            "description": "Undefined"
        },
        {
            "id": 1,
            "description": "Primary"
        },
        {
            "id": 2,
            "description": "Secondary"
        },
        {
            "id": 3,
            "description": "Source Farm"
        },
    ]
}

Response Schema

Data Point	Data Type	Definition
id	integer	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.). type identifier: 0: Undefined 1: Primary 2: Secondary 3: Source Farm
description	string	Zone type description: Undefined, Primary, Secondary

Data Point

Data Type

Definition

integer

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.). type identifier:

0: Undefined
1: Primary
2: Secondary
3: Source Farm

description

string

Zone type description: Undefined, Primary, Secondary

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.