lame Endpoint

The POST lameClosed Lameness includes any abnormality which causes an animal to change the way it walks, and can be caused by a range of foot and leg conditions, including hoof ailments, hock damage, bruising, sores, or cuts. endpoint allows VAS partners to share LAME diagnosis details to PULSE. Data provided includes the following:

  • Type of lame diagnosis, such as a fissure, dermatitis, hemorrhage, or limb damage.
  • Affected claw(s) and hoof zone(s).
NOTE: This endpoint requires Bulk Data Access.

https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/animals/{animal-id}/events/lame
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 ICARClosed 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.

{animal-id}*

integer

Animal identifier. For routes with “com.vas.animals.id”, {animal-id} is a VAS-specificClosed A data value that originates from the VAS product line. dairy cow id, commonly referred to as {dairyCowId} when not part of an ICAR identification scheme.

* Required
OTHER PARAMETERS

In addition to path parameters and the standard Authorization and API Key header parameters, the following are also required: 

Content-Type

application/json

Request body*

Formatted JSON that includes the data to POST. See the Sample Request below.

* Required

 
curl -X POST 'https://platform-vendor-api.vas.com/locations/com.vas.dairies.id/{location-id}/animals/{animal-id}/events/lame' \
-H 'Authorization: bearer {authorization token}' 
-H 'X-API-Key: {API key}'  \
-H 'Content-Type: application/json'  
--data-raw '{
  "member": {
        "eventDateTime": "2020-12-04T20:06:41.038Z",
        "remark": null,
        "eventDetails": {
            "diagnosisCode": 1,
            "digitalDermatitisStage": 1,
            "affectedClaws": [
                {
                    "claw": 1,
                    "hoofZones": [
                        0, 3
                    ]
                },
                {
                    "claw": 2,
                    "hoofZones": [
                        0, 3
                    ]
                }
            ]
        }
    }
}'

A successful response is 201 Created. See HTTP Status Codes & Errors below for other possible responses.

Data Point Data Type Definition

eventDateTime*

string

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTCClosed Coordinated Universal Time, also known as Greenwich Mean Time (GMT) time) of when the event occurred. Learn more about VAS Developer API Date/Time Formatting.

remark

string

Additional information on the event, which may be automatically generated by PULSE and/or DairyComp 305, or manually entered.

IMPORTANT: Leave this field blank (null) to automatically post the diagnosis (corresponding to the diagnosisCode) to PULSE.

The eventDetails data includes additional information about the LAME event.

Data Point

Data Type

Definition

diagnosisCode

number

Identifies the diagnosis:

1: WhiteLineLesionAbscess

2: SoleUlcer
3: SoleHemorrhage
4: ToeUlcer
5: CorkscrewClaw
6: HorizontalFissure
7: VerticalFissure
8: AxialFissure
9: InterdigitalHyperplasia
10: ThinSole
11: DigitalDermatitisMScoring
12: HeelErosion
13: InterdigitalDermatitis
14: FootRot
15: Puncture
16: LimbDamage
17: InterdigitalOverGrowth
18: SoleFractureHeelUlcer
19: JointInfectionSurgery
20: WallUlcerHemorrhage
21: Other

digitalDermatitisStage

string

Severity of dermatitis: 

M0: Normal, no signs of digital dermatitis

M1: Early stage of digital dermatitis

M2: Acute, active stage of digital dermatitis

M3: Healing stage of digital dermatitis

M4: Late, chronic stage of digital dermatitis

M4.1: Combination of stages 1 and 4; chronic digital dermatitis with new lesions containing early stages of digital dermatitis

affectedClaws data

Cows have a total of eight claws, two per hoof. They are identified by number according to the following scheme, starting at the left front hoof: 

Each hoof also has a total of 11 zones (0-10).

claw

list of integers

Affected claw(s): 

1: LeftFrontLeftClaw

2: LeftFrontRightClaw

3: RightFrontLeftClaw

4: RightFrontRightClaw

5: LeftHindLeftClaw

6: LeftHindRightClaw

7: RightHindLeftClaw

8: RightHindRightClaw

hoofZones

list of integers

Affected hoof zone(s):

0: InterdigitalCleft

1: WeightBearingFront

2: WeightBearingFrontLeft

3: WeightBearingLeft

4: WeightBearingCenter

5: WeightBearingFrontCenter

6: WeightBearingHind

7: OutsideFront

8: OutsideHind

9: AboveCoronet

10: InterdigitalSkin

* Required
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 ANIMALS Resource