{dairyId}/profile Endpoint

The profile endpoint retrieves the public profile for a specific dairy.

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/dairies/{dairyId}/profile
PATH PARAMETERS

{dairyId}*
integer

VAS-specificClosed A data value that originates from the VAS product line. dairy identifier

* Required

curl -X GET \

https://platform-vendor-api.vas.com/dairies/{dairyId}/profile \

-H 'Authorization: bearer {authorization token}' \

-H 'X-API-Key: {API key}' 

{
    "id": 123,
    "name": "VAS Dairy",
    "description": "Your favorite dairy in Tulare, CA",
    "city": "Tulare",
    "stateProvince": "California",
    "country": "United States",
    "imageUrl": "https://vas-platform/dairies/123/profile.jpg",
    "herdCodes": [12345678],
    "isDiscoverable": true,
    "timeZone": "America/Los_Angeles",
    "type": 1,
    "phoneNumber": "888-225-6753",
    "supportVendorType": 0,
    "websiteUrl": "https://web.vas.com"
}
Data Point Data Type Definition

id

integer

VAS-specific dairy identifier

name

string

Dairy name

description

 string

Dairy description

city

 string

Dairy city

stateProvince

 string

Dairy state or provincce

country

string

Dairy country

imageUrl

 string

URL for the image to display on the dairy homepage

herdCodes

 array [string]

Dairy herd code(s)

isDiscoverable

 boolean

Controls whether or not the dairy displays in PULSE search results

timeZone

 string

Dairy timezone

type

string

Dairy type description:

0: Undefined
1: MilkProducer
2: CalfRanch
3: HeiferGrower

phoneNumber

 string

Dairy phone number

supportVendorType

 integer

Organization providing VAS product support to the dairy:

0: VAS (direct support)
1: DiaryOne
2: CanWest
3: Minnesota
4: AgSource

websiteUrl

 string

Dairy website
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.

< Return to DAIRIES Resource