- Home
- /
- Resource Types
- /
- Dairy
- /
- Dairy
Resource Type: Dairy
URLs
Get all Milk Collections that you have access to
GET /data/dairy/milk-collections
Get the Milk Collection for the specified id
GET /data/dairy/milk-collection/{id}
Get all Milk Collections that are linked to the provided holding id
GET /data/holdings/{holdingId}/dairy/milk-collections
Get the Milk Collection for the specified id that is linked to the provided holding id
GET /data/holdings/{holdingId}/dairy/milk-collections/{id}
Response Structure
A call to the Milk Collection endpoints returns the following fields.
{
"self": "string",
"id": "string",
"identifiers": [{...}],
"links": [{...}],
"meta": {...},
"name": "string",
"resourceType": "/dairy/milk-collection",
"observationDate": "string",
"holding": {...},
"holdingId": "string",
"source": {...},
"destination": {...},
"logisticUnit": "string",
"quantity": "string",
"units": "string",
"rawQuantity": "string",
"rawUnits": "string",
"analysis": [{...}],
"status": "string"
}
Response Item | Description | Data Type |
---|---|---|
Self | A link to this specific Milk Collection. | URI |
Id | The Pure Farming ExternalId of this Milk Collection. | UUID |
Identifiers | Any identifier of this Milk Collection. | Array of Identifiers |
Links | Used to define a relationship with another resource. | Array of Link |
Meta | Meta data for the resource. | Metadata |
Name | A user-readable name for the resource. | String |
Resource Type | The fixed discriminator for the milk collection resource type. Value: /dairy/milk-collection |
String |
Observation Date | UTC date and time the milk collection was taken. | DateTime |
Holding | The holding where the milk collection was recorded. | Feature |
Holding Id | Internal purefarming holding id. To be used in internal versions of the schema, in place of the holding object (cannot have both, but valid to have neither!) | String |
Source | Source endpoint of the milk collection. | Source |
Destination | Destination endpoint of the milk collection. | Destination |
Logistic Unit | Enumerated value of logistic units. (Valid values: Unknown, Tank, Field, Truck, Bale, Module) | Enumeration |
Quantity | Quantity in the milk collection. | String |
Units | Units for the quantity metric. | String |
Raw Quantity | Raw quantity before standardisation. | String |
Raw Units | Units for the raw quantity before standardisation. | String |
Analysis | The details of the analysis. | Array of Analysis |
Status | The status of the milk collection. | String |