- Home
- /
- Resource Types
- /
- Livestock
- /
- Livestock Movements
- /
- Consignment
Resource Type: Consignment
Consignment
Consignment are information about the transport of the animal in this event
{
"id": "{...}",
"scheme": "string",
"originLocation": {...},
"originAddress": {...},
"destinationLocation": {...},
"destinationAddress": {...},
"loadingDateTime": "DateTime",
"unloadingDateTime": "DateTime",
"expectedDuration": "double",
"transportOperator": "string",
"vehicle": "string",
"transportReference": "string",
"isolationFacilityUsed": "boolean",
"farmAssuranceReference": {...},
}
Response Item | Description | Data Type |
---|---|---|
Id | The Id of this consignment | String |
Scheme | The Scheme of this consignment | String |
OriginLocation | The Origin of this consignment | Identifier |
OriginAddress | Origin address for movement. | String |
OriginPostalAddress | A structured, schema.org-style address for the origin location. | Address |
DestinationLocation | The Destination of this consignment | Identifier |
DestinationAddress | Destination address for movement. | String |
DestinationPostalAddress | A structured, schema.org-style address for the destination location. | Address |
Loading DateTime | A particular point in the progression of time. Shall be UTC format with Z, specified in RFC3339. | DateTimeOffset |
Unloading DateTime | A particular point in the progression of time. Shall be UTC format with Z, specified in RFC3339. | DateTimeOffset |
Expected Duration | Expected duration of transportation in hours. | Number |
Transport Operator | Transport operator official name (should really be schema.org/organization). | String |
Vehicle | Identification of the vehicle (for example, licence plate). | String |
Transport Reference | Shipping or transporter reference. | String |
Isolation Facility Used | True if an isolation facility was used for the movement. | Boolean |
Farm Assurance Reference | A unique identification for the resource issued under the auspices of the scheme. | Identifier |
Address
A address for a location
{
"addressCountry": "string",
"addressLocality": "string",
"addressRegion": "string",
"postOfficeBoxNumber": "string",
"postalCode": "string",
"streetAddress": "string"
}
Response Item | Description | Data Type |
---|---|---|
Address Country | The country. For example, "NZ". You can also provide the two-letter ISO 3166-1 alpha-2 country code. | String |
Address Locality | The locality in which the street address is, and which is in the region. For example, "Hamilton". | String |
Address Region | The region in which the locality is, and which is in the country. For example, "Waikato" or another appropriate first-level Administrative division | String |
Post Office Box Number | The post office box number for PO box addresses. | String |
Postal Code | The postal code. For example, "3216". | String |
Street Address | The street address. For example, "3 Melody Lane". | String |