Table of Contents

Pure Farming Data API

Crops :: Load receivals

GET data/holdings/{HoldingId}/crops/load-receivals

Get a list of load receivals that are linked to the provided holding id.

Request
GET /data/holdings/{HoldingId}/crops/load-receivals[?ObservationDateFrom&ObservationDateTo&ConsignmentDateFrom&ConsignmentDateTo]
Parameters
Name Type Default Notes
*HoldingId

The identifier of the holding these load receivals are linked to.
ObservationDateFrom

The end of the date range for the observation date to filter these load receivals by. Note that this must be in UTC. This parameter is optional.
ObservationDateTo

The end of the date range for the observation date to filter these load receivals by. Note that this must be in UTC. This parameter is optional.
ConsignmentDateFrom

The end of the date range for the consignment date to filter these load receivals by. Note that this must be in UTC. This parameter is optional.
ConsignmentDateTo

The end of the date range for the consignment date to filter these load receivals by. Note that this must be in UTC. This parameter is optional.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.CropContracts.CropLoadReceivalContract[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{HoldingId}/crops/load-receivals/{Id}

Gets the specified load receival.

Request
GET /data/holdings/{HoldingId}/crops/load-receivals/{Id}
Parameters
Name Type Default Notes
*HoldingId

The identifier of the holding this load receival is linked to.
*Id

The identifier of the load receival.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.CropContracts.CropLoadReceivalContract

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Crops :: Pasture cover events

GET data/holdings/{holdingId}/crops/pasture-cover-events

Get all pasture cover events associated with the given holding.

Request
GET /data/holdings/{holdingId}/crops/pasture-cover-events[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
includeDeleted False

Flag to include deleted records or not.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfPastureCoverEvent]

Success

GET data/crops/pasture-cover-events

Gets all pasture cover events you have access to.

Request
GET /data/crops/pasture-cover-events[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
includeDeleted False

Flag to include deleted records or not.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfPastureCoverEvent]

Success

GET data/crops/pasture-cover-events/{pastureCoverEventId}

Gets a specific pasture cover event for a given PureFarming ID.

Request
GET /data/crops/pasture-cover-events/{pastureCoverEventId}
Parameters
Name Type Default Notes
*pastureCoverEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfPastureCoverEvent

Success
Mime type: text/plain 
{"resourceType":"pfPastureCoverEvent","dryMatter":{"resourceType":"pfDryMatterMeasureType","measure":{"units":"KGM","measurement":1635.0,"resolution":5.0},"areaMetric":{"units":"HAR","measurement":1.0,"resolution":0.01}},"pastureHeight":{"resourceType":"lengthMeasureType","units":"CMT","measurement":6.1,"resolution":0.1},"pastureArea":{"resourceType":"areaMeasureType","units":"HAR","measurement":1.41,"resolution":0.1},"methodUsed":"PastureProbe","device":{"resourceType":"pfDeviceType","id":"JHP03","serial":"4321-GD81-1234","name":"JayHigh Pasture Probe","description":"JayHigh capacitance pasture meter","softwareVersion":"4.7","hardwareVersion":"6.23","manufacturer":"JayHigh.nz","deviceCategory":"PastureAssessment"},"equationIntercept":826.0,"equationSlope":158.0,"metabolisableEnergy":10.6,"observationDate":"2022-04-03T00:00:00+00:00","phenomenonStartTime":"2022-03-03T09:40:00+00:00","phenomenonEndTime":"2022-04-03T08:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://api.dev.purefarming.com/data/holdings/eedc61f0-1d82-4f46-b429-22afef7ccdbe","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"27abc62e-80e7-4183-95b7-66896a34db17"},"name":"Oak Reach","uri":"https://api.dev.purefarming.com/data/holdings/eedc61f0-1d82-4f46-b429-22afef7ccdbe/plots/27abc62e-80e7-4183-95b7-66896a34db17","contentType":"plot"},"responsible":"Jane Smart","remark":"Pasture cover Apr 22: Oak Reach: C-Dax","id":"107f1f12-0a3e-41ac-ad44-75c771903062","identifiers":[{"resourceType":"identifierType","scheme":"nz.zaxfarm.pasture-yield","id":"UD034/JG/2022-04"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.pasture","id":"d5af627e-04fa-4e34-942b-2cfeb7e86f6e"},"modified":"2022-04-03T10:18:02+00:00","created":"2022-04-03T10:18:02+00:00","creator":"zaxfarm.co.nz"},"name":"Pasture D. Hartley - Oak Reach, Apr 2022"}
Mime type: application/json 
{
  "resourceType": "pfPastureCoverEvent",
  "dryMatter": {
    "resourceType": "pfDryMatterMeasureType",
    "measure": {
      "units": "KGM",
      "measurement": 1635,
      "resolution": 5
    },
    "areaMetric": {
      "units": "HAR",
      "measurement": 1,
      "resolution": 0.01
    }
  },
  "pastureHeight": {
    "resourceType": "lengthMeasureType",
    "units": "CMT",
    "measurement": 6.1,
    "resolution": 0.1
  },
  "pastureArea": {
    "resourceType": "areaMeasureType",
    "units": "HAR",
    "measurement": 1.41,
    "resolution": 0.1
  },
  "methodUsed": "PastureProbe",
  "device": {
    "resourceType": "pfDeviceType",
    "id": "JHP03",
    "serial": "4321-GD81-1234",
    "name": "JayHigh Pasture Probe",
    "description": "JayHigh capacitance pasture meter",
    "softwareVersion": "4.7",
    "hardwareVersion": "6.23",
    "manufacturer": "JayHigh.nz",
    "deviceCategory": "PastureAssessment"
  },
  "equationIntercept": 826,
  "equationSlope": 158,
  "metabolisableEnergy": 10.6,
  "observationDate": "2022-04-03T00:00:00+00:00",
  "phenomenonStartTime": "2022-03-03T09:40:00+00:00",
  "phenomenonEndTime": "2022-04-03T08:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Bliss Farm",
    "uri": "https://api.dev.purefarming.com/data/holdings/eedc61f0-1d82-4f46-b429-22afef7ccdbe",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.plotId",
      "id": "27abc62e-80e7-4183-95b7-66896a34db17"
    },
    "name": "Oak Reach",
    "uri": "https://api.dev.purefarming.com/data/holdings/eedc61f0-1d82-4f46-b429-22afef7ccdbe/plots/27abc62e-80e7-4183-95b7-66896a34db17",
    "contentType": "plot"
  },
  "responsible": "Jane Smart",
  "remark": "Pasture cover Apr 22: Oak Reach: C-Dax",
  "id": "107f1f12-0a3e-41ac-ad44-75c771903062",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.zaxfarm.pasture-yield",
      "id": "UD034/JG/2022-04"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfarm.pasture",
      "id": "d5af627e-04fa-4e34-942b-2cfeb7e86f6e"
    },
    "modified": "2022-04-03T10:18:02+00:00",
    "created": "2022-04-03T10:18:02+00:00",
    "creator": "zaxfarm.co.nz"
  },
  "name": "Pasture D. Hartley - Oak Reach, Apr 2022"
}
Mime type: text/json 
{"resourceType":"pfPastureCoverEvent","dryMatter":{"resourceType":"pfDryMatterMeasureType","measure":{"units":"KGM","measurement":1635.0,"resolution":5.0},"areaMetric":{"units":"HAR","measurement":1.0,"resolution":0.01}},"pastureHeight":{"resourceType":"lengthMeasureType","units":"CMT","measurement":6.1,"resolution":0.1},"pastureArea":{"resourceType":"areaMeasureType","units":"HAR","measurement":1.41,"resolution":0.1},"methodUsed":"PastureProbe","device":{"resourceType":"pfDeviceType","id":"JHP03","serial":"4321-GD81-1234","name":"JayHigh Pasture Probe","description":"JayHigh capacitance pasture meter","softwareVersion":"4.7","hardwareVersion":"6.23","manufacturer":"JayHigh.nz","deviceCategory":"PastureAssessment"},"equationIntercept":826.0,"equationSlope":158.0,"metabolisableEnergy":10.6,"observationDate":"2022-04-03T00:00:00+00:00","phenomenonStartTime":"2022-03-03T09:40:00+00:00","phenomenonEndTime":"2022-04-03T08:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://api.dev.purefarming.com/data/holdings/eedc61f0-1d82-4f46-b429-22afef7ccdbe","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"27abc62e-80e7-4183-95b7-66896a34db17"},"name":"Oak Reach","uri":"https://api.dev.purefarming.com/data/holdings/eedc61f0-1d82-4f46-b429-22afef7ccdbe/plots/27abc62e-80e7-4183-95b7-66896a34db17","contentType":"plot"},"responsible":"Jane Smart","remark":"Pasture cover Apr 22: Oak Reach: C-Dax","id":"107f1f12-0a3e-41ac-ad44-75c771903062","identifiers":[{"resourceType":"identifierType","scheme":"nz.zaxfarm.pasture-yield","id":"UD034/JG/2022-04"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.pasture","id":"d5af627e-04fa-4e34-942b-2cfeb7e86f6e"},"modified":"2022-04-03T10:18:02+00:00","created":"2022-04-03T10:18:02+00:00","creator":"zaxfarm.co.nz"},"name":"Pasture D. Hartley - Oak Reach, Apr 2022"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/crops/pasture-cover-events/{pastureCoverEventId}

Gets a specific pasture cover event by its PureFarming ID.

Request
GET /data/holdings/{holdingId}/crops/pasture-cover-events/{pastureCoverEventId}
Parameters
Name Type Default Notes
*holdingId
*pastureCoverEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfPastureCoverEvent

Success
Mime type: text/plain 
{"resourceType":"pfPastureCoverEvent","dryMatter":{"resourceType":"pfDryMatterMeasureType","measure":{"units":"KGM","measurement":1635.0,"resolution":5.0},"areaMetric":{"units":"HAR","measurement":1.0,"resolution":0.01}},"pastureHeight":{"resourceType":"lengthMeasureType","units":"CMT","measurement":6.1,"resolution":0.1},"pastureArea":{"resourceType":"areaMeasureType","units":"HAR","measurement":1.41,"resolution":0.1},"methodUsed":"PastureProbe","device":{"resourceType":"pfDeviceType","id":"JHP03","serial":"4321-GD81-1234","name":"JayHigh Pasture Probe","description":"JayHigh capacitance pasture meter","softwareVersion":"4.7","hardwareVersion":"6.23","manufacturer":"JayHigh.nz","deviceCategory":"PastureAssessment"},"equationIntercept":826.0,"equationSlope":158.0,"metabolisableEnergy":10.6,"observationDate":"2022-04-03T00:00:00+00:00","phenomenonStartTime":"2022-03-03T09:40:00+00:00","phenomenonEndTime":"2022-04-03T08:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://api.dev.purefarming.com/data/holdings/653eab84-84a4-4649-8a05-055d1de725bc","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"2f4da043-311a-4beb-b26a-faad283d257d"},"name":"Oak Reach","uri":"https://api.dev.purefarming.com/data/holdings/653eab84-84a4-4649-8a05-055d1de725bc/plots/2f4da043-311a-4beb-b26a-faad283d257d","contentType":"plot"},"responsible":"Jane Smart","remark":"Pasture cover Apr 22: Oak Reach: C-Dax","id":"60e540be-1923-47bb-b05a-9092a4d6b3bb","identifiers":[{"resourceType":"identifierType","scheme":"nz.zaxfarm.pasture-yield","id":"UD034/JG/2022-04"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.pasture","id":"ca08e209-1f01-4543-8920-1445b55b769f"},"modified":"2022-04-03T10:18:02+00:00","created":"2022-04-03T10:18:02+00:00","creator":"zaxfarm.co.nz"},"name":"Pasture D. Hartley - Oak Reach, Apr 2022"}
Mime type: application/json 
{
  "resourceType": "pfPastureCoverEvent",
  "dryMatter": {
    "resourceType": "pfDryMatterMeasureType",
    "measure": {
      "units": "KGM",
      "measurement": 1635,
      "resolution": 5
    },
    "areaMetric": {
      "units": "HAR",
      "measurement": 1,
      "resolution": 0.01
    }
  },
  "pastureHeight": {
    "resourceType": "lengthMeasureType",
    "units": "CMT",
    "measurement": 6.1,
    "resolution": 0.1
  },
  "pastureArea": {
    "resourceType": "areaMeasureType",
    "units": "HAR",
    "measurement": 1.41,
    "resolution": 0.1
  },
  "methodUsed": "PastureProbe",
  "device": {
    "resourceType": "pfDeviceType",
    "id": "JHP03",
    "serial": "4321-GD81-1234",
    "name": "JayHigh Pasture Probe",
    "description": "JayHigh capacitance pasture meter",
    "softwareVersion": "4.7",
    "hardwareVersion": "6.23",
    "manufacturer": "JayHigh.nz",
    "deviceCategory": "PastureAssessment"
  },
  "equationIntercept": 826,
  "equationSlope": 158,
  "metabolisableEnergy": 10.6,
  "observationDate": "2022-04-03T00:00:00+00:00",
  "phenomenonStartTime": "2022-03-03T09:40:00+00:00",
  "phenomenonEndTime": "2022-04-03T08:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Bliss Farm",
    "uri": "https://api.dev.purefarming.com/data/holdings/653eab84-84a4-4649-8a05-055d1de725bc",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.plotId",
      "id": "2f4da043-311a-4beb-b26a-faad283d257d"
    },
    "name": "Oak Reach",
    "uri": "https://api.dev.purefarming.com/data/holdings/653eab84-84a4-4649-8a05-055d1de725bc/plots/2f4da043-311a-4beb-b26a-faad283d257d",
    "contentType": "plot"
  },
  "responsible": "Jane Smart",
  "remark": "Pasture cover Apr 22: Oak Reach: C-Dax",
  "id": "60e540be-1923-47bb-b05a-9092a4d6b3bb",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.zaxfarm.pasture-yield",
      "id": "UD034/JG/2022-04"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfarm.pasture",
      "id": "ca08e209-1f01-4543-8920-1445b55b769f"
    },
    "modified": "2022-04-03T10:18:02+00:00",
    "created": "2022-04-03T10:18:02+00:00",
    "creator": "zaxfarm.co.nz"
  },
  "name": "Pasture D. Hartley - Oak Reach, Apr 2022"
}
Mime type: text/json 
{"resourceType":"pfPastureCoverEvent","dryMatter":{"resourceType":"pfDryMatterMeasureType","measure":{"units":"KGM","measurement":1635.0,"resolution":5.0},"areaMetric":{"units":"HAR","measurement":1.0,"resolution":0.01}},"pastureHeight":{"resourceType":"lengthMeasureType","units":"CMT","measurement":6.1,"resolution":0.1},"pastureArea":{"resourceType":"areaMeasureType","units":"HAR","measurement":1.41,"resolution":0.1},"methodUsed":"PastureProbe","device":{"resourceType":"pfDeviceType","id":"JHP03","serial":"4321-GD81-1234","name":"JayHigh Pasture Probe","description":"JayHigh capacitance pasture meter","softwareVersion":"4.7","hardwareVersion":"6.23","manufacturer":"JayHigh.nz","deviceCategory":"PastureAssessment"},"equationIntercept":826.0,"equationSlope":158.0,"metabolisableEnergy":10.6,"observationDate":"2022-04-03T00:00:00+00:00","phenomenonStartTime":"2022-03-03T09:40:00+00:00","phenomenonEndTime":"2022-04-03T08:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://api.dev.purefarming.com/data/holdings/653eab84-84a4-4649-8a05-055d1de725bc","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"2f4da043-311a-4beb-b26a-faad283d257d"},"name":"Oak Reach","uri":"https://api.dev.purefarming.com/data/holdings/653eab84-84a4-4649-8a05-055d1de725bc/plots/2f4da043-311a-4beb-b26a-faad283d257d","contentType":"plot"},"responsible":"Jane Smart","remark":"Pasture cover Apr 22: Oak Reach: C-Dax","id":"60e540be-1923-47bb-b05a-9092a4d6b3bb","identifiers":[{"resourceType":"identifierType","scheme":"nz.zaxfarm.pasture-yield","id":"UD034/JG/2022-04"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.pasture","id":"ca08e209-1f01-4543-8920-1445b55b769f"},"modified":"2022-04-03T10:18:02+00:00","created":"2022-04-03T10:18:02+00:00","creator":"zaxfarm.co.nz"},"name":"Pasture D. Hartley - Oak Reach, Apr 2022"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Crops :: Sample analyses

GET data/holdings/{HoldingId}/crops/sample-analyses

Get a list of sample analyses that are linked to the provided holding id.

Request
GET /data/holdings/{HoldingId}/crops/sample-analyses[?ObservationDateFrom&ObservationDateTo]
Parameters
Name Type Default Notes
*HoldingId

The identifier of the holding these sampling analyses are linked to.
ObservationDateFrom

The start of the date range for the observation date to filter these sampling analyses by. Note that this must be in UTC. This parameter is optional.
ObservationDateTo

The end of the date range for the observation date to filter these sampling analyses by. Note that this must be in UTC. This parameter is optional.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.CropContracts.CropSampleAnalysisContract[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{HoldingId}/crops/sample-analyses/{Id}

Gets the specified sample analysis.

Request
GET /data/holdings/{HoldingId}/crops/sample-analyses/{Id}
Parameters
Name Type Default Notes
*HoldingId

The identifier of the holding these sample analysis is linked to.
*Id

The identifier of the sample analysis.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.CropContracts.CropSampleAnalysisContract

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Crops :: Sample plans

GET data/holdings/{HoldingId}/crops/sample-plans

Get a list of sample plans that are linked to the provided holding id.

Request
GET /data/holdings/{HoldingId}/crops/sample-plans[?ObservationDateFrom&ObservationDateTo]
Parameters
Name Type Default Notes
*HoldingId

The identifier of the holding these sample plans are linked to.
ObservationDateFrom

The start of the date range for the observation date to filter these sampling plans by. Note that this must be in UTC. This parameter is optional.
ObservationDateTo

The end of the date range for the observation date to filter these sampling plans by. Note that this must be in UTC. This parameter is optional.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.CropContracts.CropSamplePlanContract[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{HoldingId}/crops/sample-plans/{Id}

Gets the specified sample plan.

Request
GET /data/holdings/{HoldingId}/crops/sample-plans/{Id}
Parameters
Name Type Default Notes
*HoldingId

The identifier of the holding this sample plan is linked to.
*Id

The identifier of the sample plan.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.CropContracts.CropSamplePlanContract

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Crops :: Work records

GET data/crops/work-records

Gets all work records you have access to

Request
GET /data/crops/work-records[?limit&offset]
Parameters
Name Type Default Notes
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.workRecordResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1"},"items":[{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"606fda74-60cb-4e28-9af3-c1911d0326ae"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"d4a47d5a-7b87-4296-89c8-d2957f5b3657","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"fc849d76-63b7-4203-ade1-ba1b42fa8bdd"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98","contentType":"plot"},"id":"a3776732-2f58-4788-a729-a10108e4334e","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"fc849d76-63b7-4203-ade1-ba1b42fa8bdd"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"606fda74-60cb-4e28-9af3-c1911d0326ae"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"f2b989d6-dc6a-4560-96fc-d0ecddc64283","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"fc849d76-63b7-4203-ade1-ba1b42fa8bdd"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/crops/work-records/f2b989d6-dc6a-4560-96fc-d0ecddc64283"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "workRecordResource",
      "operation": "Spraying and fertiliser spreading",
      "status": "Complete",
      "priority": "Medium",
      "workedArea": {
        "resourceType": "areaMeasureType",
        "units": "MTK",
        "measurement": 1546,
        "resolution": 1
      },
      "nonOverlapWorkedArea": {
        "resourceType": "areaMeasureType",
        "units": "MTK",
        "measurement": 1123,
        "resolution": 1
      },
      "loggedOperations": [
        {
          "resourceType": "operationRecordResource",
          "operation": "spraying",
          "operationName": "spraying",
          "products": [
            {
              "resourceType": "operationProductType",
              "applicationRate": {
                "units": "LTR",
                "measurement": 10
              },
              "spatialMetric": {
                "units": "SMI",
                "measurement": 60,
                "resolution": 0.5
              },
              "applicationTotal": {
                "units": "LTR",
                "measurement": 50,
                "resolution": 1
              },
              "waterVolume": {
                "units": "LTR",
                "measurement": 100
              },
              "components": [
                {
                  "mixSequence": 1,
                  "percent": 100,
                  "product": {
                    "type": "Pesticide",
                    "manufacturer": "Mitsui AgriScience International S.A/B.V",
                    "form": "Granules",
                    "crop": {
                      "name": "Wheat",
                      "taxonomicName": "Triticum aestivum",
                      "variety": "Extase",
                      "establishmentDate": "2022-03-14T00:00:00+00:00",
                      "maturityDate": "2022-08-10T00:00:00+00:00",
                      "harvestDate": "2022-09-10T00:00:00+00:00"
                    },
                    "specificGravity": 1.1,
                    "withdrawals": [
                      {
                        "scheme": "uk.hse",
                        "hours": 400
                      }
                    ],
                    "registrations": [
                      {
                        "scheme": "mapp",
                        "id": "20177"
                      }
                    ]
                  }
                }
              ]
            }
          ],
          "observationDate": "2022-07-16T10:18:02+00:00",
          "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
          "holding": {
            "identifier": {
              "resourceType": "identifierType",
              "scheme": "com.purefarming.core.holding",
              "id": "606fda74-60cb-4e28-9af3-c1911d0326ae"
            },
            "name": "Cloudy Hills Farm",
            "uri": "https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae",
            "contentType": "holding"
          },
          "feature": {
            "identifier": {
              "resourceType": "identifierType",
              "scheme": "com.purefarming.core.plot",
              "id": "f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"
            },
            "name": "Upper south",
            "uri": "https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98",
            "contentType": "plot"
          },
          "responsible": "Daniel Danielson",
          "remark": "We sprayed some product",
          "id": "d4a47d5a-7b87-4296-89c8-d2957f5b3657",
          "meta": {
            "resourceType": "metaDataType",
            "sourceId": {
              "scheme": "uk.muddyboots.glfm",
              "id": "fc849d76-63b7-4203-ade1-ba1b42fa8bdd"
            },
            "modified": "2022-08-16T10:18:02+00:00"
          },
          "name": "/crop/operation-record"
        },
        {
          "resourceType": "operationRecordResource",
          "operation": "Fertiliser Spreading",
          "summaryGeometry": {
            "id": null,
            "type": "Feature",
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -1.016815,
                    52.064057
                  ],
                  [
                    -1.016245,
                    52.064491
                  ],
                  [
                    -1.016752,
                    52.064591
                  ],
                  [
                    -1.018005,
                    52.063947
                  ]
                ]
              ],
              "bbox": null
            },
            "properties": {},
            "bbox": null
          },
          "loggedGeometry": {
            "id": null,
            "type": "Feature",
            "geometry": {
              "type": "LineString",
              "coordinates": [
                [
                  -1.016815,
                  52.064057
                ],
                [
                  -1.016245,
                  52.064491
                ],
                [
                  -1.016752,
                  52.064591
                ],
                [
                  -1.018005,
                  52.063947
                ],
                [
                  -1.017662,
                  52.063853
                ]
              ],
              "bbox": null
            },
            "properties": {},
            "bbox": null
          },
          "environment": {
            "resourceType": "operationEnvironmentType",
            "windSpeed": {
              "units": "M19",
              "measurement": 20
            },
            "windDirectionCompass": "SE",
            "soilTemperature": {
              "units": "FAH",
              "measurement": 30,
              "resolution": 1
            }
          },
          "observationDate": "2022-07-16T10:18:02+00:00",
          "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
          "feature": {
            "identifier": {
              "resourceType": "identifierType",
              "scheme": "com.purefarming.core.plot",
              "id": "f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"
            },
            "name": "Upper south",
            "uri": "https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98",
            "contentType": "plot"
          },
          "id": "a3776732-2f58-4788-a729-a10108e4334e",
          "meta": {
            "resourceType": "metaDataType",
            "sourceId": {
              "scheme": "uk.muddyboots.glfm",
              "id": "fc849d76-63b7-4203-ade1-ba1b42fa8bdd"
            },
            "modified": "2022-08-16T10:18:02+00:00"
          }
        }
      ],
      "observationDate": "2022-09-01T00:00:00+00:00",
      "phenomenonStartTime": "2022-08-01T00:00:00+00:00",
      "phenomenonEndTime": "2022-08-31T23:59:59+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.holding",
          "id": "606fda74-60cb-4e28-9af3-c1911d0326ae"
        },
        "name": "Cloudy Hills Farm",
        "uri": "https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.plot",
          "id": "f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"
        },
        "name": "Upper south",
        "uri": "https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98",
        "contentType": "plot"
      },
      "responsible": "Dave Davidson",
      "remark": "spray product and spreading fert on wheat field",
      "id": "f2b989d6-dc6a-4560-96fc-d0ecddc64283",
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "uk.muddyboots.glfm",
          "id": "fc849d76-63b7-4203-ade1-ba1b42fa8bdd"
        },
        "modified": "2022-08-16T10:18:02+00:00",
        "created": "2022-08-15T10:18:02+00:00",
        "creator": "com.purefarming.ingestor.glfm"
      },
      "@self": "https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/crops/work-records/f2b989d6-dc6a-4560-96fc-d0ecddc64283"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1"},"items":[{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"606fda74-60cb-4e28-9af3-c1911d0326ae"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"d4a47d5a-7b87-4296-89c8-d2957f5b3657","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"fc849d76-63b7-4203-ade1-ba1b42fa8bdd"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98","contentType":"plot"},"id":"a3776732-2f58-4788-a729-a10108e4334e","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"fc849d76-63b7-4203-ade1-ba1b42fa8bdd"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"606fda74-60cb-4e28-9af3-c1911d0326ae"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/plots/f02a8a8e-afc8-4ebb-b2dc-14fd5d578f98","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"f2b989d6-dc6a-4560-96fc-d0ecddc64283","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"fc849d76-63b7-4203-ade1-ba1b42fa8bdd"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/606fda74-60cb-4e28-9af3-c1911d0326ae/crops/work-records/f2b989d6-dc6a-4560-96fc-d0ecddc64283"}]}

GET data/crops/work-records/{WorkRecordId}

Gets a specific work-records for a given PureFarming ID

Request
GET /data/crops/work-records/{WorkRecordId}
Parameters
Name Type Default Notes
*WorkRecordId

The PureFarming ID of the work record you want to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.workRecordResource

Success
Mime type: text/plain 
{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"029f1ba6-3acd-438c-99fa-ba4bb9726acb"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"ee97a1cc-b07a-405c-9fee-80b76cc8e57f"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"61675540-e6eb-4918-b3c0-cc5eb3b4dbd7","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"ee97a1cc-b07a-405c-9fee-80b76cc8e57f"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f","contentType":"plot"},"id":"8d3a485a-f723-4eb5-b7f0-e32cced74ead","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"029f1ba6-3acd-438c-99fa-ba4bb9726acb"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"ee97a1cc-b07a-405c-9fee-80b76cc8e57f"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"a71106d1-eb6c-4105-8e95-0079425bb1b3","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/crops/work-records/a71106d1-eb6c-4105-8e95-0079425bb1b3"}
Mime type: application/json 
{
  "resourceType": "workRecordResource",
  "operation": "Spraying and fertiliser spreading",
  "status": "Complete",
  "priority": "Medium",
  "workedArea": {
    "resourceType": "areaMeasureType",
    "units": "MTK",
    "measurement": 1546,
    "resolution": 1
  },
  "nonOverlapWorkedArea": {
    "resourceType": "areaMeasureType",
    "units": "MTK",
    "measurement": 1123,
    "resolution": 1
  },
  "loggedOperations": [
    {
      "resourceType": "operationRecordResource",
      "operation": "spraying",
      "operationName": "spraying",
      "products": [
        {
          "resourceType": "operationProductType",
          "applicationRate": {
            "units": "LTR",
            "measurement": 10
          },
          "spatialMetric": {
            "units": "SMI",
            "measurement": 60,
            "resolution": 0.5
          },
          "applicationTotal": {
            "units": "LTR",
            "measurement": 50,
            "resolution": 1
          },
          "waterVolume": {
            "units": "LTR",
            "measurement": 100
          },
          "components": [
            {
              "mixSequence": 1,
              "percent": 100,
              "product": {
                "type": "Pesticide",
                "manufacturer": "Mitsui AgriScience International S.A/B.V",
                "form": "Granules",
                "crop": {
                  "name": "Wheat",
                  "taxonomicName": "Triticum aestivum",
                  "variety": "Extase",
                  "establishmentDate": "2022-03-14T00:00:00+00:00",
                  "maturityDate": "2022-08-10T00:00:00+00:00",
                  "harvestDate": "2022-09-10T00:00:00+00:00"
                },
                "specificGravity": 1.1,
                "withdrawals": [
                  {
                    "scheme": "uk.hse",
                    "hours": 400
                  }
                ],
                "registrations": [
                  {
                    "scheme": "mapp",
                    "id": "20177"
                  }
                ]
              }
            }
          ]
        }
      ],
      "observationDate": "2022-07-16T10:18:02+00:00",
      "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.holding",
          "id": "029f1ba6-3acd-438c-99fa-ba4bb9726acb"
        },
        "name": "Cloudy Hills Farm",
        "uri": "https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.plot",
          "id": "ee97a1cc-b07a-405c-9fee-80b76cc8e57f"
        },
        "name": "Upper south",
        "uri": "https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f",
        "contentType": "plot"
      },
      "responsible": "Daniel Danielson",
      "remark": "We sprayed some product",
      "id": "61675540-e6eb-4918-b3c0-cc5eb3b4dbd7",
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "uk.muddyboots.glfm",
          "id": "561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"
        },
        "modified": "2022-08-16T10:18:02+00:00"
      },
      "name": "/crop/operation-record"
    },
    {
      "resourceType": "operationRecordResource",
      "operation": "Fertiliser Spreading",
      "summaryGeometry": {
        "id": null,
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -1.016815,
                52.064057
              ],
              [
                -1.016245,
                52.064491
              ],
              [
                -1.016752,
                52.064591
              ],
              [
                -1.018005,
                52.063947
              ]
            ]
          ],
          "bbox": null
        },
        "properties": {},
        "bbox": null
      },
      "loggedGeometry": {
        "id": null,
        "type": "Feature",
        "geometry": {
          "type": "LineString",
          "coordinates": [
            [
              -1.016815,
              52.064057
            ],
            [
              -1.016245,
              52.064491
            ],
            [
              -1.016752,
              52.064591
            ],
            [
              -1.018005,
              52.063947
            ],
            [
              -1.017662,
              52.063853
            ]
          ],
          "bbox": null
        },
        "properties": {},
        "bbox": null
      },
      "environment": {
        "resourceType": "operationEnvironmentType",
        "windSpeed": {
          "units": "M19",
          "measurement": 20
        },
        "windDirectionCompass": "SE",
        "soilTemperature": {
          "units": "FAH",
          "measurement": 30,
          "resolution": 1
        }
      },
      "observationDate": "2022-07-16T10:18:02+00:00",
      "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.plot",
          "id": "ee97a1cc-b07a-405c-9fee-80b76cc8e57f"
        },
        "name": "Upper south",
        "uri": "https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f",
        "contentType": "plot"
      },
      "id": "8d3a485a-f723-4eb5-b7f0-e32cced74ead",
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "uk.muddyboots.glfm",
          "id": "561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"
        },
        "modified": "2022-08-16T10:18:02+00:00"
      }
    }
  ],
  "observationDate": "2022-09-01T00:00:00+00:00",
  "phenomenonStartTime": "2022-08-01T00:00:00+00:00",
  "phenomenonEndTime": "2022-08-31T23:59:59+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.core.holding",
      "id": "029f1ba6-3acd-438c-99fa-ba4bb9726acb"
    },
    "name": "Cloudy Hills Farm",
    "uri": "https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.core.plot",
      "id": "ee97a1cc-b07a-405c-9fee-80b76cc8e57f"
    },
    "name": "Upper south",
    "uri": "https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f",
    "contentType": "plot"
  },
  "responsible": "Dave Davidson",
  "remark": "spray product and spreading fert on wheat field",
  "id": "a71106d1-eb6c-4105-8e95-0079425bb1b3",
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "uk.muddyboots.glfm",
      "id": "561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"
    },
    "modified": "2022-08-16T10:18:02+00:00",
    "created": "2022-08-15T10:18:02+00:00",
    "creator": "com.purefarming.ingestor.glfm"
  },
  "@self": "https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/crops/work-records/a71106d1-eb6c-4105-8e95-0079425bb1b3"
}
Mime type: text/json 
{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"029f1ba6-3acd-438c-99fa-ba4bb9726acb"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"ee97a1cc-b07a-405c-9fee-80b76cc8e57f"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"61675540-e6eb-4918-b3c0-cc5eb3b4dbd7","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"ee97a1cc-b07a-405c-9fee-80b76cc8e57f"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f","contentType":"plot"},"id":"8d3a485a-f723-4eb5-b7f0-e32cced74ead","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"029f1ba6-3acd-438c-99fa-ba4bb9726acb"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"ee97a1cc-b07a-405c-9fee-80b76cc8e57f"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/plots/ee97a1cc-b07a-405c-9fee-80b76cc8e57f","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"a71106d1-eb6c-4105-8e95-0079425bb1b3","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"561caa0f-4a3d-49fb-aaf2-1c61b8ab2fb2"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/029f1ba6-3acd-438c-99fa-ba4bb9726acb/crops/work-records/a71106d1-eb6c-4105-8e95-0079425bb1b3"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/crops/work-records

Gets all work records for a given holding

Request
GET /data/holdings/{holdingId}/crops/work-records[?limit&offset]
Parameters
Name Type Default Notes
*holdingId
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.workRecordResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1"},"items":[{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"b27b1c97-130e-4507-afb5-c4f8faf1b81f"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"8aed1a23-f2eb-4f79-ab73-24e3c874e553"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"f67d0b49-7ef6-4e16-b7e3-466b18c8e590","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"a546fc92-3db4-46bd-93d1-3e9a29006b9a"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"8aed1a23-f2eb-4f79-ab73-24e3c874e553"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553","contentType":"plot"},"id":"5f1ffc99-2b5e-442f-b801-8875720948ee","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"a546fc92-3db4-46bd-93d1-3e9a29006b9a"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"b27b1c97-130e-4507-afb5-c4f8faf1b81f"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"8aed1a23-f2eb-4f79-ab73-24e3c874e553"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"f3519c7e-f118-49b4-ab0b-1ccea72cf949","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"a546fc92-3db4-46bd-93d1-3e9a29006b9a"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/crops/work-records/f3519c7e-f118-49b4-ab0b-1ccea72cf949"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "workRecordResource",
      "operation": "Spraying and fertiliser spreading",
      "status": "Complete",
      "priority": "Medium",
      "workedArea": {
        "resourceType": "areaMeasureType",
        "units": "MTK",
        "measurement": 1546,
        "resolution": 1
      },
      "nonOverlapWorkedArea": {
        "resourceType": "areaMeasureType",
        "units": "MTK",
        "measurement": 1123,
        "resolution": 1
      },
      "loggedOperations": [
        {
          "resourceType": "operationRecordResource",
          "operation": "spraying",
          "operationName": "spraying",
          "products": [
            {
              "resourceType": "operationProductType",
              "applicationRate": {
                "units": "LTR",
                "measurement": 10
              },
              "spatialMetric": {
                "units": "SMI",
                "measurement": 60,
                "resolution": 0.5
              },
              "applicationTotal": {
                "units": "LTR",
                "measurement": 50,
                "resolution": 1
              },
              "waterVolume": {
                "units": "LTR",
                "measurement": 100
              },
              "components": [
                {
                  "mixSequence": 1,
                  "percent": 100,
                  "product": {
                    "type": "Pesticide",
                    "manufacturer": "Mitsui AgriScience International S.A/B.V",
                    "form": "Granules",
                    "crop": {
                      "name": "Wheat",
                      "taxonomicName": "Triticum aestivum",
                      "variety": "Extase",
                      "establishmentDate": "2022-03-14T00:00:00+00:00",
                      "maturityDate": "2022-08-10T00:00:00+00:00",
                      "harvestDate": "2022-09-10T00:00:00+00:00"
                    },
                    "specificGravity": 1.1,
                    "withdrawals": [
                      {
                        "scheme": "uk.hse",
                        "hours": 400
                      }
                    ],
                    "registrations": [
                      {
                        "scheme": "mapp",
                        "id": "20177"
                      }
                    ]
                  }
                }
              ]
            }
          ],
          "observationDate": "2022-07-16T10:18:02+00:00",
          "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
          "holding": {
            "identifier": {
              "resourceType": "identifierType",
              "scheme": "com.purefarming.core.holding",
              "id": "b27b1c97-130e-4507-afb5-c4f8faf1b81f"
            },
            "name": "Cloudy Hills Farm",
            "uri": "https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f",
            "contentType": "holding"
          },
          "feature": {
            "identifier": {
              "resourceType": "identifierType",
              "scheme": "com.purefarming.core.plot",
              "id": "8aed1a23-f2eb-4f79-ab73-24e3c874e553"
            },
            "name": "Upper south",
            "uri": "https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553",
            "contentType": "plot"
          },
          "responsible": "Daniel Danielson",
          "remark": "We sprayed some product",
          "id": "f67d0b49-7ef6-4e16-b7e3-466b18c8e590",
          "meta": {
            "resourceType": "metaDataType",
            "sourceId": {
              "scheme": "uk.muddyboots.glfm",
              "id": "a546fc92-3db4-46bd-93d1-3e9a29006b9a"
            },
            "modified": "2022-08-16T10:18:02+00:00"
          },
          "name": "/crop/operation-record"
        },
        {
          "resourceType": "operationRecordResource",
          "operation": "Fertiliser Spreading",
          "summaryGeometry": {
            "id": null,
            "type": "Feature",
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -1.016815,
                    52.064057
                  ],
                  [
                    -1.016245,
                    52.064491
                  ],
                  [
                    -1.016752,
                    52.064591
                  ],
                  [
                    -1.018005,
                    52.063947
                  ]
                ]
              ],
              "bbox": null
            },
            "properties": {},
            "bbox": null
          },
          "loggedGeometry": {
            "id": null,
            "type": "Feature",
            "geometry": {
              "type": "LineString",
              "coordinates": [
                [
                  -1.016815,
                  52.064057
                ],
                [
                  -1.016245,
                  52.064491
                ],
                [
                  -1.016752,
                  52.064591
                ],
                [
                  -1.018005,
                  52.063947
                ],
                [
                  -1.017662,
                  52.063853
                ]
              ],
              "bbox": null
            },
            "properties": {},
            "bbox": null
          },
          "environment": {
            "resourceType": "operationEnvironmentType",
            "windSpeed": {
              "units": "M19",
              "measurement": 20
            },
            "windDirectionCompass": "SE",
            "soilTemperature": {
              "units": "FAH",
              "measurement": 30,
              "resolution": 1
            }
          },
          "observationDate": "2022-07-16T10:18:02+00:00",
          "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
          "feature": {
            "identifier": {
              "resourceType": "identifierType",
              "scheme": "com.purefarming.core.plot",
              "id": "8aed1a23-f2eb-4f79-ab73-24e3c874e553"
            },
            "name": "Upper south",
            "uri": "https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553",
            "contentType": "plot"
          },
          "id": "5f1ffc99-2b5e-442f-b801-8875720948ee",
          "meta": {
            "resourceType": "metaDataType",
            "sourceId": {
              "scheme": "uk.muddyboots.glfm",
              "id": "a546fc92-3db4-46bd-93d1-3e9a29006b9a"
            },
            "modified": "2022-08-16T10:18:02+00:00"
          }
        }
      ],
      "observationDate": "2022-09-01T00:00:00+00:00",
      "phenomenonStartTime": "2022-08-01T00:00:00+00:00",
      "phenomenonEndTime": "2022-08-31T23:59:59+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.holding",
          "id": "b27b1c97-130e-4507-afb5-c4f8faf1b81f"
        },
        "name": "Cloudy Hills Farm",
        "uri": "https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.plot",
          "id": "8aed1a23-f2eb-4f79-ab73-24e3c874e553"
        },
        "name": "Upper south",
        "uri": "https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553",
        "contentType": "plot"
      },
      "responsible": "Dave Davidson",
      "remark": "spray product and spreading fert on wheat field",
      "id": "f3519c7e-f118-49b4-ab0b-1ccea72cf949",
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "uk.muddyboots.glfm",
          "id": "a546fc92-3db4-46bd-93d1-3e9a29006b9a"
        },
        "modified": "2022-08-16T10:18:02+00:00",
        "created": "2022-08-15T10:18:02+00:00",
        "creator": "com.purefarming.ingestor.glfm"
      },
      "@self": "https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/crops/work-records/f3519c7e-f118-49b4-ab0b-1ccea72cf949"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/crops/work-records?offset=0&limit=1"},"items":[{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"b27b1c97-130e-4507-afb5-c4f8faf1b81f"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"8aed1a23-f2eb-4f79-ab73-24e3c874e553"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"f67d0b49-7ef6-4e16-b7e3-466b18c8e590","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"a546fc92-3db4-46bd-93d1-3e9a29006b9a"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"8aed1a23-f2eb-4f79-ab73-24e3c874e553"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553","contentType":"plot"},"id":"5f1ffc99-2b5e-442f-b801-8875720948ee","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"a546fc92-3db4-46bd-93d1-3e9a29006b9a"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"b27b1c97-130e-4507-afb5-c4f8faf1b81f"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"8aed1a23-f2eb-4f79-ab73-24e3c874e553"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/plots/8aed1a23-f2eb-4f79-ab73-24e3c874e553","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"f3519c7e-f118-49b4-ab0b-1ccea72cf949","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"a546fc92-3db4-46bd-93d1-3e9a29006b9a"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/b27b1c97-130e-4507-afb5-c4f8faf1b81f/crops/work-records/f3519c7e-f118-49b4-ab0b-1ccea72cf949"}]}

GET data/holdings/{HoldingId}/crops/work-records/{WorkRecordId}

Gets a specific work-record by its PureFarming ID

Request
GET /data/holdings/{HoldingId}/crops/work-records/{WorkRecordId}
Parameters
Name Type Default Notes
*HoldingId

The PureFarming ID of the holding that the work record is for
*WorkRecordId

The PureFarming ID of the work record you want to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.workRecordResource

Success
Mime type: text/plain 
{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"add33f2e-c22f-4069-a5e4-a36b0c43143a"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"67b11179-8e22-4f3c-8c3a-8e1d0e86562d"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"777e52b4-5184-4777-ae73-e105cf8731e8","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"67b11179-8e22-4f3c-8c3a-8e1d0e86562d"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d","contentType":"plot"},"id":"05980f8c-a19b-484e-b128-34d8509012f0","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"add33f2e-c22f-4069-a5e4-a36b0c43143a"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"67b11179-8e22-4f3c-8c3a-8e1d0e86562d"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"b2bca321-3749-420a-92bf-f8921a406a25","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/crops/work-records/b2bca321-3749-420a-92bf-f8921a406a25"}
Mime type: application/json 
{
  "resourceType": "workRecordResource",
  "operation": "Spraying and fertiliser spreading",
  "status": "Complete",
  "priority": "Medium",
  "workedArea": {
    "resourceType": "areaMeasureType",
    "units": "MTK",
    "measurement": 1546,
    "resolution": 1
  },
  "nonOverlapWorkedArea": {
    "resourceType": "areaMeasureType",
    "units": "MTK",
    "measurement": 1123,
    "resolution": 1
  },
  "loggedOperations": [
    {
      "resourceType": "operationRecordResource",
      "operation": "spraying",
      "operationName": "spraying",
      "products": [
        {
          "resourceType": "operationProductType",
          "applicationRate": {
            "units": "LTR",
            "measurement": 10
          },
          "spatialMetric": {
            "units": "SMI",
            "measurement": 60,
            "resolution": 0.5
          },
          "applicationTotal": {
            "units": "LTR",
            "measurement": 50,
            "resolution": 1
          },
          "waterVolume": {
            "units": "LTR",
            "measurement": 100
          },
          "components": [
            {
              "mixSequence": 1,
              "percent": 100,
              "product": {
                "type": "Pesticide",
                "manufacturer": "Mitsui AgriScience International S.A/B.V",
                "form": "Granules",
                "crop": {
                  "name": "Wheat",
                  "taxonomicName": "Triticum aestivum",
                  "variety": "Extase",
                  "establishmentDate": "2022-03-14T00:00:00+00:00",
                  "maturityDate": "2022-08-10T00:00:00+00:00",
                  "harvestDate": "2022-09-10T00:00:00+00:00"
                },
                "specificGravity": 1.1,
                "withdrawals": [
                  {
                    "scheme": "uk.hse",
                    "hours": 400
                  }
                ],
                "registrations": [
                  {
                    "scheme": "mapp",
                    "id": "20177"
                  }
                ]
              }
            }
          ]
        }
      ],
      "observationDate": "2022-07-16T10:18:02+00:00",
      "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.holding",
          "id": "add33f2e-c22f-4069-a5e4-a36b0c43143a"
        },
        "name": "Cloudy Hills Farm",
        "uri": "https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.plot",
          "id": "67b11179-8e22-4f3c-8c3a-8e1d0e86562d"
        },
        "name": "Upper south",
        "uri": "https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d",
        "contentType": "plot"
      },
      "responsible": "Daniel Danielson",
      "remark": "We sprayed some product",
      "id": "777e52b4-5184-4777-ae73-e105cf8731e8",
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "uk.muddyboots.glfm",
          "id": "0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"
        },
        "modified": "2022-08-16T10:18:02+00:00"
      },
      "name": "/crop/operation-record"
    },
    {
      "resourceType": "operationRecordResource",
      "operation": "Fertiliser Spreading",
      "summaryGeometry": {
        "id": null,
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -1.016815,
                52.064057
              ],
              [
                -1.016245,
                52.064491
              ],
              [
                -1.016752,
                52.064591
              ],
              [
                -1.018005,
                52.063947
              ]
            ]
          ],
          "bbox": null
        },
        "properties": {},
        "bbox": null
      },
      "loggedGeometry": {
        "id": null,
        "type": "Feature",
        "geometry": {
          "type": "LineString",
          "coordinates": [
            [
              -1.016815,
              52.064057
            ],
            [
              -1.016245,
              52.064491
            ],
            [
              -1.016752,
              52.064591
            ],
            [
              -1.018005,
              52.063947
            ],
            [
              -1.017662,
              52.063853
            ]
          ],
          "bbox": null
        },
        "properties": {},
        "bbox": null
      },
      "environment": {
        "resourceType": "operationEnvironmentType",
        "windSpeed": {
          "units": "M19",
          "measurement": 20
        },
        "windDirectionCompass": "SE",
        "soilTemperature": {
          "units": "FAH",
          "measurement": 30,
          "resolution": 1
        }
      },
      "observationDate": "2022-07-16T10:18:02+00:00",
      "phenomenonStartTime": "2022-07-16T08:28:02+00:00",
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.core.plot",
          "id": "67b11179-8e22-4f3c-8c3a-8e1d0e86562d"
        },
        "name": "Upper south",
        "uri": "https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d",
        "contentType": "plot"
      },
      "id": "05980f8c-a19b-484e-b128-34d8509012f0",
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "uk.muddyboots.glfm",
          "id": "0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"
        },
        "modified": "2022-08-16T10:18:02+00:00"
      }
    }
  ],
  "observationDate": "2022-09-01T00:00:00+00:00",
  "phenomenonStartTime": "2022-08-01T00:00:00+00:00",
  "phenomenonEndTime": "2022-08-31T23:59:59+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.core.holding",
      "id": "add33f2e-c22f-4069-a5e4-a36b0c43143a"
    },
    "name": "Cloudy Hills Farm",
    "uri": "https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.core.plot",
      "id": "67b11179-8e22-4f3c-8c3a-8e1d0e86562d"
    },
    "name": "Upper south",
    "uri": "https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d",
    "contentType": "plot"
  },
  "responsible": "Dave Davidson",
  "remark": "spray product and spreading fert on wheat field",
  "id": "b2bca321-3749-420a-92bf-f8921a406a25",
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "uk.muddyboots.glfm",
      "id": "0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"
    },
    "modified": "2022-08-16T10:18:02+00:00",
    "created": "2022-08-15T10:18:02+00:00",
    "creator": "com.purefarming.ingestor.glfm"
  },
  "@self": "https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/crops/work-records/b2bca321-3749-420a-92bf-f8921a406a25"
}
Mime type: text/json 
{"resourceType":"workRecordResource","operation":"Spraying and fertiliser spreading","status":"Complete","priority":"Medium","workedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1546.0,"resolution":1.0},"nonOverlapWorkedArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":1123.0,"resolution":1.0},"loggedOperations":[{"resourceType":"operationRecordResource","operation":"spraying","operationName":"spraying","products":[{"resourceType":"operationProductType","applicationRate":{"units":"LTR","measurement":10.0},"spatialMetric":{"units":"SMI","measurement":60.0,"resolution":0.5},"applicationTotal":{"units":"LTR","measurement":50.0,"resolution":1.0},"waterVolume":{"units":"LTR","measurement":100.0},"components":[{"mixSequence":1.0,"percent":100.0,"product":{"type":"Pesticide","manufacturer":"Mitsui AgriScience International S.A/B.V","form":"Granules","crop":{"name":"Wheat","taxonomicName":"Triticum aestivum","variety":"Extase","establishmentDate":"2022-03-14T00:00:00+00:00","maturityDate":"2022-08-10T00:00:00+00:00","harvestDate":"2022-09-10T00:00:00+00:00"},"specificGravity":1.1,"withdrawals":[{"scheme":"uk.hse","hours":400.0}],"registrations":[{"scheme":"mapp","id":"20177"}]}}]}],"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"add33f2e-c22f-4069-a5e4-a36b0c43143a"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"67b11179-8e22-4f3c-8c3a-8e1d0e86562d"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d","contentType":"plot"},"responsible":"Daniel Danielson","remark":"We sprayed some product","id":"777e52b4-5184-4777-ae73-e105cf8731e8","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"},"modified":"2022-08-16T10:18:02+00:00"},"name":"/crop/operation-record"},{"resourceType":"operationRecordResource","operation":"Fertiliser Spreading","summaryGeometry":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947]]],"bbox":null},"properties":{},"bbox":null},"loggedGeometry":{"id":null,"type":"Feature","geometry":{"type":"LineString","coordinates":[[-1.016815,52.064057],[-1.016245,52.064491],[-1.016752,52.064591],[-1.018005,52.063947],[-1.017662,52.063853]],"bbox":null},"properties":{},"bbox":null},"environment":{"resourceType":"operationEnvironmentType","windSpeed":{"units":"M19","measurement":20.0},"windDirectionCompass":"SE","soilTemperature":{"units":"FAH","measurement":30.0,"resolution":1.0}},"observationDate":"2022-07-16T10:18:02+00:00","phenomenonStartTime":"2022-07-16T08:28:02+00:00","feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"67b11179-8e22-4f3c-8c3a-8e1d0e86562d"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d","contentType":"plot"},"id":"05980f8c-a19b-484e-b128-34d8509012f0","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"},"modified":"2022-08-16T10:18:02+00:00"}}],"observationDate":"2022-09-01T00:00:00+00:00","phenomenonStartTime":"2022-08-01T00:00:00+00:00","phenomenonEndTime":"2022-08-31T23:59:59+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.holding","id":"add33f2e-c22f-4069-a5e4-a36b0c43143a"},"name":"Cloudy Hills Farm","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.core.plot","id":"67b11179-8e22-4f3c-8c3a-8e1d0e86562d"},"name":"Upper south","uri":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/plots/67b11179-8e22-4f3c-8c3a-8e1d0e86562d","contentType":"plot"},"responsible":"Dave Davidson","remark":"spray product and spreading fert on wheat field","id":"b2bca321-3749-420a-92bf-f8921a406a25","meta":{"resourceType":"metaDataType","sourceId":{"scheme":"uk.muddyboots.glfm","id":"0bccbd0c-a043-4cbc-a55f-7da4468fa7ea"},"modified":"2022-08-16T10:18:02+00:00","created":"2022-08-15T10:18:02+00:00","creator":"com.purefarming.ingestor.glfm"},"@self":"https://api.dev.purefarming.com/data/holdings/add33f2e-c22f-4069-a5e4-a36b0c43143a/crops/work-records/b2bca321-3749-420a-92bf-f8921a406a25"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Dairy :: Milk collections

GET data/milk-collections

Gets all of the Milk Collections that the user has access to

Request
GET /data/milk-collections[?limit&offset&since&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
since

The date time to specify the oldest meta.created/modified record.
includeDeleted False

True will include deleted milk collection events in the response data. Defaults to false
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfMilkCollection]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": null,
    "next": null,
    "previous": null,
    "last": null
  },
  "items": [
    {
      "resourceType": "pfMilkCollection",
      "source": {
        "resourceType": "pfConsignmentEndPointType",
        "consignmentDate": "2022-11-14T11:00:00+00:00",
        "organisation": {
          "leiCode": "XYZ1234",
          "name": "Green Valley Farm Holdings",
          "uri": "https://greenvalleyfarm.nz",
          "registration": {
            "scheme": "nz.dairyco.member",
            "id": "ABC123"
          },
          "gln": "GS1X554433377"
        },
        "feature": {
          "identifier": {
            "scheme": "nz.dairyco.supplier",
            "id": "647-893"
          },
          "name": "Green Valley Farm Herd 1",
          "uri": "https://greenvalleyfarm.nz/herd1",
          "contentType": "Herd"
        }
      },
      "destination": {
        "resourceType": "pfConsignmentEndPointType",
        "consignmentDate": "2022-11-14T11:00:00+00:00",
        "organisation": {
          "leiCode": "ABC333",
          "name": "Dairy Co Holdings Ltd",
          "uri": "https://dairycoholdings.nz/info",
          "registration": {
            "scheme": "nz.companiesregister",
            "id": "KF1234567"
          },
          "gln": "GS1X1234566521"
        },
        "feature": {
          "identifier": {
            "scheme": "nz.dairyco.plant",
            "id": "P12"
          },
          "name": "Hamilton",
          "uri": "https://dairyco.com/plant/hamilton",
          "contentType": "Plant"
        }
      },
      "logisticUnit": "Truck",
      "quantity": 12698,
      "units": "litres",
      "rawQuantity": 1.24,
      "rawUnits": "tonnes",
      "analysis": [
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "leiCode": "ABC444",
            "name": "Dairy Co Chemistry Laboratory, Hamilton",
            "uri": "https://dairyco.com/laboratory/hamiltonC",
            "registration": {
              "scheme": "nz.dairyco.lab",
              "id": "CL47"
            },
            "gln": "GS1X666777999"
          },
          "laboratoryIdentifier": "HamChem",
          "sessionIdentifier": "45",
          "responsible": "Max Henselite",
          "results": [
            {
              "name": "Milk Solids",
              "status": "completed",
              "abbreviation": "MS",
              "metric": "https://standards.nz/dairy/ms",
              "method": "https://standards.nz/dairy/filtration",
              "rawValue": "8.95",
              "rawUnit": "%",
              "value": 1429.4,
              "unit": "kg",
              "resolution": 0.5,
              "errorStatistic": 0,
              "qualitativeGrade": "KX"
            },
            {
              "name": "Fat",
              "status": "completed",
              "abbreviation": "FPC",
              "metric": "https://standards.nz/dairy/fpc",
              "method": "https://standards.nz/dairy/infrared",
              "rawValue": "3.4",
              "rawUnit": "%",
              "value": 650,
              "unit": "kg",
              "resolution": 0.1,
              "errorStatistic": 0,
              "qualitativeGrade": "XG"
            }
          ]
        },
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "leiCode": "ABC100",
            "name": "KF Milk Testing Services",
            "uri": "https://kfm.co.nz",
            "registration": {
              "scheme": "nz.dairyco.lab",
              "id": "KFM"
            },
            "gln": "GS1X666777000"
          },
          "laboratoryIdentifier": "https://kfm.co.nz/xd",
          "sessionIdentifier": "498",
          "responsible": "Logan Campbell",
          "results": [
            {
              "name": "DetergentResidue",
              "status": "completed",
              "abbreviation": "DRX",
              "metric": "https://standards.nz/dairy/dr",
              "method": "https://standards.nz/dairy/dr",
              "rawValue": "0",
              "rawUnit": "mg",
              "value": 0,
              "unit": "mg",
              "resolution": 0.01,
              "errorStatistic": 1,
              "qualitativeGrade": "A"
            }
          ]
        }
      ],
      "status": "Received",
      "observationDate": "2022-11-14T12:46:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "nz.dairyco.holding",
          "id": "CDE444"
        },
        "name": "Green Valley Farm",
        "uri": "https://greenvalleyfarm.nz",
        "contentType": "Holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "nz.dairyco.supplier",
          "id": "647-893"
        },
        "name": "Green Valley Farm Herd 1",
        "uri": "https://greenvalleyfarm.nz/herd1",
        "contentType": "Herd"
      },
      "id": "f6709aca-d0af-4e5b-a460-d1e5e551e833",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.dairyco.collection",
          "id": "70259"
        },
        {
          "resourceType": "identifierType",
          "scheme": "nz.milk.collection",
          "id": "AB123"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "Milk Collection Divisional Manager",
          "contentType": "Person",
          "related": "https://dairyco.com/personname"
        },
        {
          "resourceType": "relationType",
          "relationship": "Parent Company",
          "contentType": "Organisation",
          "related": "https://dairyholdings.com/info"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.dairyco.milk.collection",
          "id": "7239888c-ad3c-49bb-a045-bd309fcfb5c3"
        },
        "modified": "2022-11-14T11:00:00+00:00",
        "created": "2022-11-14T09:00:00+00:00",
        "creator": "don.wilson@newco.com",
        "validFrom": "2022-11-14T11:00:00+00:00",
        "validTo": "2022-12-14T11:00:00+00:00",
        "isDeleted": false
      },
      "name": "Milk Collection",
      "@self": "https://dairyco.com/collection"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/milk-collections/{collectionId}

Gets the specified milk collection event

Request
GET /data/milk-collections/{collectionId}
Parameters
Name Type Default Notes
*collectionId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfMilkCollection

Success
Mime type: text/plain 
{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}
Mime type: application/json 
{
  "resourceType": "pfMilkCollection",
  "source": {
    "resourceType": "pfConsignmentEndPointType",
    "consignmentDate": "2022-11-14T11:00:00+00:00",
    "organisation": {
      "leiCode": "XYZ1234",
      "name": "Green Valley Farm Holdings",
      "uri": "https://greenvalleyfarm.nz",
      "registration": {
        "scheme": "nz.dairyco.member",
        "id": "ABC123"
      },
      "gln": "GS1X554433377"
    },
    "feature": {
      "identifier": {
        "scheme": "nz.dairyco.supplier",
        "id": "647-893"
      },
      "name": "Green Valley Farm Herd 1",
      "uri": "https://greenvalleyfarm.nz/herd1",
      "contentType": "Herd"
    }
  },
  "destination": {
    "resourceType": "pfConsignmentEndPointType",
    "consignmentDate": "2022-11-14T11:00:00+00:00",
    "organisation": {
      "leiCode": "ABC333",
      "name": "Dairy Co Holdings Ltd",
      "uri": "https://dairycoholdings.nz/info",
      "registration": {
        "scheme": "nz.companiesregister",
        "id": "KF1234567"
      },
      "gln": "GS1X1234566521"
    },
    "feature": {
      "identifier": {
        "scheme": "nz.dairyco.plant",
        "id": "P12"
      },
      "name": "Hamilton",
      "uri": "https://dairyco.com/plant/hamilton",
      "contentType": "Plant"
    }
  },
  "logisticUnit": "Truck",
  "quantity": 12698,
  "units": "litres",
  "rawQuantity": 1.24,
  "rawUnits": "tonnes",
  "analysis": [
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "leiCode": "ABC444",
        "name": "Dairy Co Chemistry Laboratory, Hamilton",
        "uri": "https://dairyco.com/laboratory/hamiltonC",
        "registration": {
          "scheme": "nz.dairyco.lab",
          "id": "CL47"
        },
        "gln": "GS1X666777999"
      },
      "laboratoryIdentifier": "HamChem",
      "sessionIdentifier": "45",
      "responsible": "Max Henselite",
      "results": [
        {
          "name": "Milk Solids",
          "status": "completed",
          "abbreviation": "MS",
          "metric": "https://standards.nz/dairy/ms",
          "method": "https://standards.nz/dairy/filtration",
          "rawValue": "8.95",
          "rawUnit": "%",
          "value": 1429.4,
          "unit": "kg",
          "resolution": 0.5,
          "errorStatistic": 0,
          "qualitativeGrade": "KX"
        },
        {
          "name": "Fat",
          "status": "completed",
          "abbreviation": "FPC",
          "metric": "https://standards.nz/dairy/fpc",
          "method": "https://standards.nz/dairy/infrared",
          "rawValue": "3.4",
          "rawUnit": "%",
          "value": 650,
          "unit": "kg",
          "resolution": 0.1,
          "errorStatistic": 0,
          "qualitativeGrade": "XG"
        }
      ]
    },
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "leiCode": "ABC100",
        "name": "KF Milk Testing Services",
        "uri": "https://kfm.co.nz",
        "registration": {
          "scheme": "nz.dairyco.lab",
          "id": "KFM"
        },
        "gln": "GS1X666777000"
      },
      "laboratoryIdentifier": "https://kfm.co.nz/xd",
      "sessionIdentifier": "498",
      "responsible": "Logan Campbell",
      "results": [
        {
          "name": "DetergentResidue",
          "status": "completed",
          "abbreviation": "DRX",
          "metric": "https://standards.nz/dairy/dr",
          "method": "https://standards.nz/dairy/dr",
          "rawValue": "0",
          "rawUnit": "mg",
          "value": 0,
          "unit": "mg",
          "resolution": 0.01,
          "errorStatistic": 1,
          "qualitativeGrade": "A"
        }
      ]
    }
  ],
  "status": "Received",
  "observationDate": "2022-11-14T12:46:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "nz.dairyco.holding",
      "id": "CDE444"
    },
    "name": "Green Valley Farm",
    "uri": "https://greenvalleyfarm.nz",
    "contentType": "Holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "nz.dairyco.supplier",
      "id": "647-893"
    },
    "name": "Green Valley Farm Herd 1",
    "uri": "https://greenvalleyfarm.nz/herd1",
    "contentType": "Herd"
  },
  "id": "f6709aca-d0af-4e5b-a460-d1e5e551e833",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.dairyco.collection",
      "id": "70259"
    },
    {
      "resourceType": "identifierType",
      "scheme": "nz.milk.collection",
      "id": "AB123"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "Milk Collection Divisional Manager",
      "contentType": "Person",
      "related": "https://dairyco.com/personname"
    },
    {
      "resourceType": "relationType",
      "relationship": "Parent Company",
      "contentType": "Organisation",
      "related": "https://dairyholdings.com/info"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.dairyco.milk.collection",
      "id": "7239888c-ad3c-49bb-a045-bd309fcfb5c3"
    },
    "modified": "2022-11-14T11:00:00+00:00",
    "created": "2022-11-14T09:00:00+00:00",
    "creator": "don.wilson@newco.com",
    "validFrom": "2022-11-14T11:00:00+00:00",
    "validTo": "2022-12-14T11:00:00+00:00",
    "isDeleted": false
  },
  "name": "Milk Collection",
  "@self": "https://dairyco.com/collection"
}
Mime type: text/json 
{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/milk-collections

Gets all of the milk collection events for the holding

Request
GET /data/holdings/{holdingId}/milk-collections[?limit&offset&since&includeDeleted]
Parameters
Name Type Default Notes
*holdingId

The PureFarming ID for the holding
limit

The limit of results to return
offset

The offset to specify at what row to start querying
since

The date time to specify the oldest meta.created/modified record.
includeDeleted False

True will include deleted milk collection events in the response data. Defaults to false
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfMilkCollection]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": null,
    "next": null,
    "previous": null,
    "last": null
  },
  "items": [
    {
      "resourceType": "pfMilkCollection",
      "source": {
        "resourceType": "pfConsignmentEndPointType",
        "consignmentDate": "2022-11-14T11:00:00+00:00",
        "organisation": {
          "leiCode": "XYZ1234",
          "name": "Green Valley Farm Holdings",
          "uri": "https://greenvalleyfarm.nz",
          "registration": {
            "scheme": "nz.dairyco.member",
            "id": "ABC123"
          },
          "gln": "GS1X554433377"
        },
        "feature": {
          "identifier": {
            "scheme": "nz.dairyco.supplier",
            "id": "647-893"
          },
          "name": "Green Valley Farm Herd 1",
          "uri": "https://greenvalleyfarm.nz/herd1",
          "contentType": "Herd"
        }
      },
      "destination": {
        "resourceType": "pfConsignmentEndPointType",
        "consignmentDate": "2022-11-14T11:00:00+00:00",
        "organisation": {
          "leiCode": "ABC333",
          "name": "Dairy Co Holdings Ltd",
          "uri": "https://dairycoholdings.nz/info",
          "registration": {
            "scheme": "nz.companiesregister",
            "id": "KF1234567"
          },
          "gln": "GS1X1234566521"
        },
        "feature": {
          "identifier": {
            "scheme": "nz.dairyco.plant",
            "id": "P12"
          },
          "name": "Hamilton",
          "uri": "https://dairyco.com/plant/hamilton",
          "contentType": "Plant"
        }
      },
      "logisticUnit": "Truck",
      "quantity": 12698,
      "units": "litres",
      "rawQuantity": 1.24,
      "rawUnits": "tonnes",
      "analysis": [
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "leiCode": "ABC444",
            "name": "Dairy Co Chemistry Laboratory, Hamilton",
            "uri": "https://dairyco.com/laboratory/hamiltonC",
            "registration": {
              "scheme": "nz.dairyco.lab",
              "id": "CL47"
            },
            "gln": "GS1X666777999"
          },
          "laboratoryIdentifier": "HamChem",
          "sessionIdentifier": "45",
          "responsible": "Max Henselite",
          "results": [
            {
              "name": "Milk Solids",
              "status": "completed",
              "abbreviation": "MS",
              "metric": "https://standards.nz/dairy/ms",
              "method": "https://standards.nz/dairy/filtration",
              "rawValue": "8.95",
              "rawUnit": "%",
              "value": 1429.4,
              "unit": "kg",
              "resolution": 0.5,
              "errorStatistic": 0,
              "qualitativeGrade": "KX"
            },
            {
              "name": "Fat",
              "status": "completed",
              "abbreviation": "FPC",
              "metric": "https://standards.nz/dairy/fpc",
              "method": "https://standards.nz/dairy/infrared",
              "rawValue": "3.4",
              "rawUnit": "%",
              "value": 650,
              "unit": "kg",
              "resolution": 0.1,
              "errorStatistic": 0,
              "qualitativeGrade": "XG"
            }
          ]
        },
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "leiCode": "ABC100",
            "name": "KF Milk Testing Services",
            "uri": "https://kfm.co.nz",
            "registration": {
              "scheme": "nz.dairyco.lab",
              "id": "KFM"
            },
            "gln": "GS1X666777000"
          },
          "laboratoryIdentifier": "https://kfm.co.nz/xd",
          "sessionIdentifier": "498",
          "responsible": "Logan Campbell",
          "results": [
            {
              "name": "DetergentResidue",
              "status": "completed",
              "abbreviation": "DRX",
              "metric": "https://standards.nz/dairy/dr",
              "method": "https://standards.nz/dairy/dr",
              "rawValue": "0",
              "rawUnit": "mg",
              "value": 0,
              "unit": "mg",
              "resolution": 0.01,
              "errorStatistic": 1,
              "qualitativeGrade": "A"
            }
          ]
        }
      ],
      "status": "Received",
      "observationDate": "2022-11-14T12:46:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "nz.dairyco.holding",
          "id": "CDE444"
        },
        "name": "Green Valley Farm",
        "uri": "https://greenvalleyfarm.nz",
        "contentType": "Holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "nz.dairyco.supplier",
          "id": "647-893"
        },
        "name": "Green Valley Farm Herd 1",
        "uri": "https://greenvalleyfarm.nz/herd1",
        "contentType": "Herd"
      },
      "id": "f6709aca-d0af-4e5b-a460-d1e5e551e833",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.dairyco.collection",
          "id": "70259"
        },
        {
          "resourceType": "identifierType",
          "scheme": "nz.milk.collection",
          "id": "AB123"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "Milk Collection Divisional Manager",
          "contentType": "Person",
          "related": "https://dairyco.com/personname"
        },
        {
          "resourceType": "relationType",
          "relationship": "Parent Company",
          "contentType": "Organisation",
          "related": "https://dairyholdings.com/info"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.dairyco.milk.collection",
          "id": "7239888c-ad3c-49bb-a045-bd309fcfb5c3"
        },
        "modified": "2022-11-14T11:00:00+00:00",
        "created": "2022-11-14T09:00:00+00:00",
        "creator": "don.wilson@newco.com",
        "validFrom": "2022-11-14T11:00:00+00:00",
        "validTo": "2022-12-14T11:00:00+00:00",
        "isDeleted": false
      },
      "name": "Milk Collection",
      "@self": "https://dairyco.com/collection"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/milk-collections/{collectionId}

Gets the specified milk collection event linked to the specified holding

Request
GET /data/holdings/{holdingId}/milk-collections/{collectionId}
Parameters
Name Type Default Notes
*holdingId
*collectionId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfMilkCollection

Success
Mime type: text/plain 
{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}
Mime type: application/json 
{
  "resourceType": "pfMilkCollection",
  "source": {
    "resourceType": "pfConsignmentEndPointType",
    "consignmentDate": "2022-11-14T11:00:00+00:00",
    "organisation": {
      "leiCode": "XYZ1234",
      "name": "Green Valley Farm Holdings",
      "uri": "https://greenvalleyfarm.nz",
      "registration": {
        "scheme": "nz.dairyco.member",
        "id": "ABC123"
      },
      "gln": "GS1X554433377"
    },
    "feature": {
      "identifier": {
        "scheme": "nz.dairyco.supplier",
        "id": "647-893"
      },
      "name": "Green Valley Farm Herd 1",
      "uri": "https://greenvalleyfarm.nz/herd1",
      "contentType": "Herd"
    }
  },
  "destination": {
    "resourceType": "pfConsignmentEndPointType",
    "consignmentDate": "2022-11-14T11:00:00+00:00",
    "organisation": {
      "leiCode": "ABC333",
      "name": "Dairy Co Holdings Ltd",
      "uri": "https://dairycoholdings.nz/info",
      "registration": {
        "scheme": "nz.companiesregister",
        "id": "KF1234567"
      },
      "gln": "GS1X1234566521"
    },
    "feature": {
      "identifier": {
        "scheme": "nz.dairyco.plant",
        "id": "P12"
      },
      "name": "Hamilton",
      "uri": "https://dairyco.com/plant/hamilton",
      "contentType": "Plant"
    }
  },
  "logisticUnit": "Truck",
  "quantity": 12698,
  "units": "litres",
  "rawQuantity": 1.24,
  "rawUnits": "tonnes",
  "analysis": [
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "leiCode": "ABC444",
        "name": "Dairy Co Chemistry Laboratory, Hamilton",
        "uri": "https://dairyco.com/laboratory/hamiltonC",
        "registration": {
          "scheme": "nz.dairyco.lab",
          "id": "CL47"
        },
        "gln": "GS1X666777999"
      },
      "laboratoryIdentifier": "HamChem",
      "sessionIdentifier": "45",
      "responsible": "Max Henselite",
      "results": [
        {
          "name": "Milk Solids",
          "status": "completed",
          "abbreviation": "MS",
          "metric": "https://standards.nz/dairy/ms",
          "method": "https://standards.nz/dairy/filtration",
          "rawValue": "8.95",
          "rawUnit": "%",
          "value": 1429.4,
          "unit": "kg",
          "resolution": 0.5,
          "errorStatistic": 0,
          "qualitativeGrade": "KX"
        },
        {
          "name": "Fat",
          "status": "completed",
          "abbreviation": "FPC",
          "metric": "https://standards.nz/dairy/fpc",
          "method": "https://standards.nz/dairy/infrared",
          "rawValue": "3.4",
          "rawUnit": "%",
          "value": 650,
          "unit": "kg",
          "resolution": 0.1,
          "errorStatistic": 0,
          "qualitativeGrade": "XG"
        }
      ]
    },
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "leiCode": "ABC100",
        "name": "KF Milk Testing Services",
        "uri": "https://kfm.co.nz",
        "registration": {
          "scheme": "nz.dairyco.lab",
          "id": "KFM"
        },
        "gln": "GS1X666777000"
      },
      "laboratoryIdentifier": "https://kfm.co.nz/xd",
      "sessionIdentifier": "498",
      "responsible": "Logan Campbell",
      "results": [
        {
          "name": "DetergentResidue",
          "status": "completed",
          "abbreviation": "DRX",
          "metric": "https://standards.nz/dairy/dr",
          "method": "https://standards.nz/dairy/dr",
          "rawValue": "0",
          "rawUnit": "mg",
          "value": 0,
          "unit": "mg",
          "resolution": 0.01,
          "errorStatistic": 1,
          "qualitativeGrade": "A"
        }
      ]
    }
  ],
  "status": "Received",
  "observationDate": "2022-11-14T12:46:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "nz.dairyco.holding",
      "id": "CDE444"
    },
    "name": "Green Valley Farm",
    "uri": "https://greenvalleyfarm.nz",
    "contentType": "Holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "nz.dairyco.supplier",
      "id": "647-893"
    },
    "name": "Green Valley Farm Herd 1",
    "uri": "https://greenvalleyfarm.nz/herd1",
    "contentType": "Herd"
  },
  "id": "f6709aca-d0af-4e5b-a460-d1e5e551e833",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.dairyco.collection",
      "id": "70259"
    },
    {
      "resourceType": "identifierType",
      "scheme": "nz.milk.collection",
      "id": "AB123"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "Milk Collection Divisional Manager",
      "contentType": "Person",
      "related": "https://dairyco.com/personname"
    },
    {
      "resourceType": "relationType",
      "relationship": "Parent Company",
      "contentType": "Organisation",
      "related": "https://dairyholdings.com/info"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.dairyco.milk.collection",
      "id": "7239888c-ad3c-49bb-a045-bd309fcfb5c3"
    },
    "modified": "2022-11-14T11:00:00+00:00",
    "created": "2022-11-14T09:00:00+00:00",
    "creator": "don.wilson@newco.com",
    "validFrom": "2022-11-14T11:00:00+00:00",
    "validTo": "2022-12-14T11:00:00+00:00",
    "isDeleted": false
  },
  "name": "Milk Collection",
  "@self": "https://dairyco.com/collection"
}
Mime type: text/json 
{"resourceType":"pfMilkCollection","source":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"XYZ1234","name":"Green Valley Farm Holdings","uri":"https://greenvalleyfarm.nz","registration":{"scheme":"nz.dairyco.member","id":"ABC123"},"gln":"GS1X554433377"},"feature":{"identifier":{"scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"}},"destination":{"resourceType":"pfConsignmentEndPointType","consignmentDate":"2022-11-14T11:00:00+00:00","organisation":{"leiCode":"ABC333","name":"Dairy Co Holdings Ltd","uri":"https://dairycoholdings.nz/info","registration":{"scheme":"nz.companiesregister","id":"KF1234567"},"gln":"GS1X1234566521"},"feature":{"identifier":{"scheme":"nz.dairyco.plant","id":"P12"},"name":"Hamilton","uri":"https://dairyco.com/plant/hamilton","contentType":"Plant"}},"logisticUnit":"Truck","quantity":12698.0,"units":"litres","rawQuantity":1.24,"rawUnits":"tonnes","analysis":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC444","name":"Dairy Co Chemistry Laboratory, Hamilton","uri":"https://dairyco.com/laboratory/hamiltonC","registration":{"scheme":"nz.dairyco.lab","id":"CL47"},"gln":"GS1X666777999"},"laboratoryIdentifier":"HamChem","sessionIdentifier":"45","responsible":"Max Henselite","results":[{"name":"Milk Solids","status":"completed","abbreviation":"MS","metric":"https://standards.nz/dairy/ms","method":"https://standards.nz/dairy/filtration","rawValue":"8.95","rawUnit":"%","value":1429.4,"unit":"kg","resolution":0.5,"errorStatistic":0.0,"qualitativeGrade":"KX"},{"name":"Fat","status":"completed","abbreviation":"FPC","metric":"https://standards.nz/dairy/fpc","method":"https://standards.nz/dairy/infrared","rawValue":"3.4","rawUnit":"%","value":650.0,"unit":"kg","resolution":0.1,"errorStatistic":0.0,"qualitativeGrade":"XG"}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"leiCode":"ABC100","name":"KF Milk Testing Services","uri":"https://kfm.co.nz","registration":{"scheme":"nz.dairyco.lab","id":"KFM"},"gln":"GS1X666777000"},"laboratoryIdentifier":"https://kfm.co.nz/xd","sessionIdentifier":"498","responsible":"Logan Campbell","results":[{"name":"DetergentResidue","status":"completed","abbreviation":"DRX","metric":"https://standards.nz/dairy/dr","method":"https://standards.nz/dairy/dr","rawValue":"0","rawUnit":"mg","value":0.0,"unit":"mg","resolution":0.01,"errorStatistic":1.0,"qualitativeGrade":"A"}]}],"status":"Received","observationDate":"2022-11-14T12:46:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.holding","id":"CDE444"},"name":"Green Valley Farm","uri":"https://greenvalleyfarm.nz","contentType":"Holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"nz.dairyco.supplier","id":"647-893"},"name":"Green Valley Farm Herd 1","uri":"https://greenvalleyfarm.nz/herd1","contentType":"Herd"},"id":"f6709aca-d0af-4e5b-a460-d1e5e551e833","identifiers":[{"resourceType":"identifierType","scheme":"nz.dairyco.collection","id":"70259"},{"resourceType":"identifierType","scheme":"nz.milk.collection","id":"AB123"}],"links":[{"resourceType":"relationType","relationship":"Milk Collection Divisional Manager","contentType":"Person","related":"https://dairyco.com/personname"},{"resourceType":"relationType","relationship":"Parent Company","contentType":"Organisation","related":"https://dairyholdings.com/info"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.dairyco.milk.collection","id":"7239888c-ad3c-49bb-a045-bd309fcfb5c3"},"modified":"2022-11-14T11:00:00+00:00","created":"2022-11-14T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-11-14T11:00:00+00:00","validTo":"2022-12-14T11:00:00+00:00","isDeleted":false},"name":"Milk Collection","@self":"https://dairyco.com/collection"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Enterprise statistics

GET data/enterprise-statistics

Get all of the enterprise statistics that a user has access to

The limit of results to return The offset to specify at what row to start queryingInclude deleted events in the results, default = false
Request
GET /data/enterprise-statistics[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
limit
offset
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/enterprise-statistics/{enterpriseStatisticsId}

Get a specific enterprise statistics by Id

Request
GET /data/enterprise-statistics/{enterpriseStatisticsId}
Parameters
Name Type Default Notes
*enterpriseStatisticsId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/enterprise-statistics

Get all of the enterprise statistics associated with the given holding

Request
GET /data/holdings/{holdingId}/enterprise-statistics[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
includeDeleted False

Include deleted events in the results, default = false
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/enterprise-statistics/{enterpriseStatisticsId}

Get a single enterprise statistics associated with the given holding

Request
GET /data/holdings/{holdingId}/enterprise-statistics/{enterpriseStatisticsId}
Parameters
Name Type Default Notes
*holdingId
*enterpriseStatisticsId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Environment :: Climate observation events

GET data/environment/climate-observations-events

Gets all of the climate observations events the user has access to via pagination

Request
GET /data/environment/climate-observations-events[?limit&offset]
Parameters
Name Type Default Notes
limit

the maximum number of items per page
offset

the number of items offset from the start of the set for the current page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfClimateObservationsEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfClimateObservationsEvent",
      "sampledFeature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.district",
          "id": "e374b4d8-b566-444c-ad19-8419f511569b"
        },
        "name": "Whitehall District",
        "uri": "https://landco.co.nz/district/46",
        "contentType": "district"
      },
      "sensorResults": [
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "Lower Soil Moisture"
          },
          "method": "Digital",
          "value": 20.72,
          "units": "%",
          "resolution": 0.01,
          "duration": 1,
          "durationUnits": "HUR"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "Upper Soil Moisture"
          },
          "method": "Digital",
          "value": 33.93,
          "units": "%",
          "resolution": 0.01,
          "duration": 1,
          "durationUnits": "HUR"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "DailyRainfall"
          },
          "method": "Digital",
          "value": 4.5,
          "units": "MMT",
          "aggregation": "Sum",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "DAY"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "SoilTemperature"
          },
          "method": "Digital",
          "value": 5.9,
          "units": "CEL",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "HUR",
          "qualitativeValue": "Bad",
          "observationStatus": "Measured",
          "problemDetail": "Instrument is mis-reading"
        }
      ],
      "device": {
        "resourceType": "pfDeviceType",
        "id": "GX4777-8",
        "serial": "GX4777-765-2390",
        "name": "GX4777 Farm Environment Monitor",
        "description": "Farm environment monitoring integrated system",
        "softwareVersion": "6.5.17",
        "hardwareVersion": "3.9",
        "manufacturer": "GX Weather Devices Ltd",
        "deviceCategory": "EnvironmentMonitor"
      },
      "observationDate": "2022-10-14T00:00:00+00:00",
      "phenomenonStartTime": "2022-10-14T00:00:00+00:00",
      "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Bliss Farm",
        "uri": "https://landco.co.nz/property/K384",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.plotId",
          "id": "232cec2c-4a88-4a26-9812-251e5ceb4389"
        },
        "name": "Far Flats",
        "uri": "https://landco.co.nz/plot/K384-24",
        "contentType": "plot"
      },
      "responsible": "Aimee Clarke",
      "remark": "Testing environmental monitoring, October 2022",
      "id": "159bcde7-5aa6-47fd-a22a-a1edca819c10",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.co.climatedb",
          "id": "23/34567"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "yyyyyyyyyyyyyyy",
          "contentType": "Farm Map",
          "related": "https://jjjj.kkkk/dddd"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.zaxfarm.climate",
          "id": "c7860e27-8e0e-4d88-abea-20fb41568c2a"
        },
        "modified": "2022-10-15T08:00:00+00:00",
        "created": "2022-10-15T08:00:00+00:00",
        "creator": "zaxfarm.co.nz",
        "validFrom": "2022-10-15T08:00:00+00:00",
        "validTo": "2023-10-15T11:00:00+00:00"
      },
      "name": "Environmental monitoring - Bliss Farm, 14 October 2022",
      "@self": "https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}]}

GET data/holdings/{holdingId}/environment/climate-observations-events

Gets the climate observations events for a holding via pagination

Request
GET /data/holdings/{holdingId}/environment/climate-observations-events[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the climate observations events for
limit

the maximum number of climate observations events on a page
offset

the number of climate observations events in the total set before the first one on the page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfClimateObservationsEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfClimateObservationsEvent",
      "sampledFeature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.district",
          "id": "e374b4d8-b566-444c-ad19-8419f511569b"
        },
        "name": "Whitehall District",
        "uri": "https://landco.co.nz/district/46",
        "contentType": "district"
      },
      "sensorResults": [
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "Lower Soil Moisture"
          },
          "method": "Digital",
          "value": 20.72,
          "units": "%",
          "resolution": 0.01,
          "duration": 1,
          "durationUnits": "HUR"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "Upper Soil Moisture"
          },
          "method": "Digital",
          "value": 33.93,
          "units": "%",
          "resolution": 0.01,
          "duration": 1,
          "durationUnits": "HUR"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "DailyRainfall"
          },
          "method": "Digital",
          "value": 4.5,
          "units": "MMT",
          "aggregation": "Sum",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "DAY"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "SoilTemperature"
          },
          "method": "Digital",
          "value": 5.9,
          "units": "CEL",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "HUR",
          "qualitativeValue": "Bad",
          "observationStatus": "Measured",
          "problemDetail": "Instrument is mis-reading"
        }
      ],
      "device": {
        "resourceType": "pfDeviceType",
        "id": "GX4777-8",
        "serial": "GX4777-765-2390",
        "name": "GX4777 Farm Environment Monitor",
        "description": "Farm environment monitoring integrated system",
        "softwareVersion": "6.5.17",
        "hardwareVersion": "3.9",
        "manufacturer": "GX Weather Devices Ltd",
        "deviceCategory": "EnvironmentMonitor"
      },
      "observationDate": "2022-10-14T00:00:00+00:00",
      "phenomenonStartTime": "2022-10-14T00:00:00+00:00",
      "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Bliss Farm",
        "uri": "https://landco.co.nz/property/K384",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.plotId",
          "id": "232cec2c-4a88-4a26-9812-251e5ceb4389"
        },
        "name": "Far Flats",
        "uri": "https://landco.co.nz/plot/K384-24",
        "contentType": "plot"
      },
      "responsible": "Aimee Clarke",
      "remark": "Testing environmental monitoring, October 2022",
      "id": "159bcde7-5aa6-47fd-a22a-a1edca819c10",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.co.climatedb",
          "id": "23/34567"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "yyyyyyyyyyyyyyy",
          "contentType": "Farm Map",
          "related": "https://jjjj.kkkk/dddd"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.zaxfarm.climate",
          "id": "c7860e27-8e0e-4d88-abea-20fb41568c2a"
        },
        "modified": "2022-10-15T08:00:00+00:00",
        "created": "2022-10-15T08:00:00+00:00",
        "creator": "zaxfarm.co.nz",
        "validFrom": "2022-10-15T08:00:00+00:00",
        "validTo": "2023-10-15T11:00:00+00:00"
      },
      "name": "Environmental monitoring - Bliss Farm, 14 October 2022",
      "@self": "https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/climate-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}]}

GET data/environment/climate-observations-events/{eventId}

Gets a single climate observations event by Id

Request
GET /data/environment/climate-observations-events/{eventId}
Parameters
Name Type Default Notes
*eventId

The Id of the climate observations event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfClimateObservationsEvent

Success
Mime type: text/plain 
{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}
Mime type: application/json 
{
  "resourceType": "pfClimateObservationsEvent",
  "sampledFeature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.district",
      "id": "e374b4d8-b566-444c-ad19-8419f511569b"
    },
    "name": "Whitehall District",
    "uri": "https://landco.co.nz/district/46",
    "contentType": "district"
  },
  "sensorResults": [
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "Lower Soil Moisture"
      },
      "method": "Digital",
      "value": 20.72,
      "units": "%",
      "resolution": 0.01,
      "duration": 1,
      "durationUnits": "HUR"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "Upper Soil Moisture"
      },
      "method": "Digital",
      "value": 33.93,
      "units": "%",
      "resolution": 0.01,
      "duration": 1,
      "durationUnits": "HUR"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "DailyRainfall"
      },
      "method": "Digital",
      "value": 4.5,
      "units": "MMT",
      "aggregation": "Sum",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "DAY"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "SoilTemperature"
      },
      "method": "Digital",
      "value": 5.9,
      "units": "CEL",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "HUR",
      "qualitativeValue": "Bad",
      "observationStatus": "Measured",
      "problemDetail": "Instrument is mis-reading"
    }
  ],
  "device": {
    "resourceType": "pfDeviceType",
    "id": "GX4777-8",
    "serial": "GX4777-765-2390",
    "name": "GX4777 Farm Environment Monitor",
    "description": "Farm environment monitoring integrated system",
    "softwareVersion": "6.5.17",
    "hardwareVersion": "3.9",
    "manufacturer": "GX Weather Devices Ltd",
    "deviceCategory": "EnvironmentMonitor"
  },
  "observationDate": "2022-10-14T00:00:00+00:00",
  "phenomenonStartTime": "2022-10-14T00:00:00+00:00",
  "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Bliss Farm",
    "uri": "https://landco.co.nz/property/K384",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.plotId",
      "id": "232cec2c-4a88-4a26-9812-251e5ceb4389"
    },
    "name": "Far Flats",
    "uri": "https://landco.co.nz/plot/K384-24",
    "contentType": "plot"
  },
  "responsible": "Aimee Clarke",
  "remark": "Testing environmental monitoring, October 2022",
  "id": "159bcde7-5aa6-47fd-a22a-a1edca819c10",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.co.climatedb",
      "id": "23/34567"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "yyyyyyyyyyyyyyy",
      "contentType": "Farm Map",
      "related": "https://jjjj.kkkk/dddd"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfarm.climate",
      "id": "c7860e27-8e0e-4d88-abea-20fb41568c2a"
    },
    "modified": "2022-10-15T08:00:00+00:00",
    "created": "2022-10-15T08:00:00+00:00",
    "creator": "zaxfarm.co.nz",
    "validFrom": "2022-10-15T08:00:00+00:00",
    "validTo": "2023-10-15T11:00:00+00:00"
  },
  "name": "Environmental monitoring - Bliss Farm, 14 October 2022",
  "@self": "https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"
}
Mime type: text/json 
{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/environment/climate-observations-events/{eventId}

Gets a single climate observations event with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/environment/climate-observations-events/{eventId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the climate observations event for
*eventId

The Id of the climate observations event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfClimateObservationsEvent

Success
Mime type: text/plain 
{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}
Mime type: application/json 
{
  "resourceType": "pfClimateObservationsEvent",
  "sampledFeature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.district",
      "id": "e374b4d8-b566-444c-ad19-8419f511569b"
    },
    "name": "Whitehall District",
    "uri": "https://landco.co.nz/district/46",
    "contentType": "district"
  },
  "sensorResults": [
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "Lower Soil Moisture"
      },
      "method": "Digital",
      "value": 20.72,
      "units": "%",
      "resolution": 0.01,
      "duration": 1,
      "durationUnits": "HUR"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "Upper Soil Moisture"
      },
      "method": "Digital",
      "value": 33.93,
      "units": "%",
      "resolution": 0.01,
      "duration": 1,
      "durationUnits": "HUR"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "DailyRainfall"
      },
      "method": "Digital",
      "value": 4.5,
      "units": "MMT",
      "aggregation": "Sum",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "DAY"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "SoilTemperature"
      },
      "method": "Digital",
      "value": 5.9,
      "units": "CEL",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "HUR",
      "qualitativeValue": "Bad",
      "observationStatus": "Measured",
      "problemDetail": "Instrument is mis-reading"
    }
  ],
  "device": {
    "resourceType": "pfDeviceType",
    "id": "GX4777-8",
    "serial": "GX4777-765-2390",
    "name": "GX4777 Farm Environment Monitor",
    "description": "Farm environment monitoring integrated system",
    "softwareVersion": "6.5.17",
    "hardwareVersion": "3.9",
    "manufacturer": "GX Weather Devices Ltd",
    "deviceCategory": "EnvironmentMonitor"
  },
  "observationDate": "2022-10-14T00:00:00+00:00",
  "phenomenonStartTime": "2022-10-14T00:00:00+00:00",
  "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Bliss Farm",
    "uri": "https://landco.co.nz/property/K384",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.plotId",
      "id": "232cec2c-4a88-4a26-9812-251e5ceb4389"
    },
    "name": "Far Flats",
    "uri": "https://landco.co.nz/plot/K384-24",
    "contentType": "plot"
  },
  "responsible": "Aimee Clarke",
  "remark": "Testing environmental monitoring, October 2022",
  "id": "159bcde7-5aa6-47fd-a22a-a1edca819c10",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.co.climatedb",
      "id": "23/34567"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "yyyyyyyyyyyyyyy",
      "contentType": "Farm Map",
      "related": "https://jjjj.kkkk/dddd"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfarm.climate",
      "id": "c7860e27-8e0e-4d88-abea-20fb41568c2a"
    },
    "modified": "2022-10-15T08:00:00+00:00",
    "created": "2022-10-15T08:00:00+00:00",
    "creator": "zaxfarm.co.nz",
    "validFrom": "2022-10-15T08:00:00+00:00",
    "validTo": "2023-10-15T11:00:00+00:00"
  },
  "name": "Environmental monitoring - Bliss Farm, 14 October 2022",
  "@self": "https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"
}
Mime type: text/json 
{"resourceType":"pfClimateObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.district","id":"e374b4d8-b566-444c-ad19-8419f511569b"},"name":"Whitehall District","uri":"https://landco.co.nz/district/46","contentType":"district"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Upper Soil Moisture"},"method":"Digital","value":33.93,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"GX4777-8","serial":"GX4777-765-2390","name":"GX4777 Farm Environment Monitor","description":"Farm environment monitoring integrated system","softwareVersion":"6.5.17","hardwareVersion":"3.9","manufacturer":"GX Weather Devices Ltd","deviceCategory":"EnvironmentMonitor"},"observationDate":"2022-10-14T00:00:00+00:00","phenomenonStartTime":"2022-10-14T00:00:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"232cec2c-4a88-4a26-9812-251e5ceb4389"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Testing environmental monitoring, October 2022","id":"159bcde7-5aa6-47fd-a22a-a1edca819c10","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.climatedb","id":"23/34567"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.climate","id":"c7860e27-8e0e-4d88-abea-20fb41568c2a"},"modified":"2022-10-15T08:00:00+00:00","created":"2022-10-15T08:00:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-15T08:00:00+00:00","validTo":"2023-10-15T11:00:00+00:00"},"name":"Environmental monitoring - Bliss Farm, 14 October 2022","@self":"https://api.dev.purefarming.com/data/environment/climate-observations-events/159bcde7-5aa6-47fd-a22a-a1edca819c10"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Environment :: Hydrological observation events

GET data/environment/hydrological-observations-event

Gets all of the hydrological observations events the user has access to via pagination

Request
GET /data/environment/hydrological-observations-event[?limit&offset]
Parameters
Name Type Default Notes
limit

the maximum number of items per page
offset

the number of items offset from the start of the set for the current page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfHydrologicalObservationsEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfHydrologicalObservationsEvent",
      "sampledFeature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.irrigationId",
          "id": "f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"
        },
        "name": "BF-06 Pump Shed",
        "contentType": "irrigation"
      },
      "sensorResults": [
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "Lower Soil Moisture"
          },
          "method": "Digital",
          "value": 20.72,
          "units": "%",
          "resolution": 0.01,
          "duration": 1,
          "durationUnits": "HUR"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "DailyRainfall"
          },
          "method": "Digital",
          "value": 4.5,
          "units": "MMT",
          "aggregation": "Sum",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "DAY"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "SoilTemperature"
          },
          "method": "Digital",
          "value": 5.9,
          "units": "CEL",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "HUR",
          "qualitativeValue": "Bad",
          "observationStatus": "Measured",
          "problemDetail": "Instrument is mis-reading"
        }
      ],
      "device": {
        "resourceType": "pfDeviceType",
        "id": "KV-8",
        "serial": "KV-8-999111",
        "name": "KV-8 Farm Irrigation Monitor",
        "description": "KV-8 smart farm irrigation monitoring integrated system",
        "softwareVersion": "3.4.2",
        "hardwareVersion": "8.1",
        "manufacturer": "Farmsmart Irrigation Ltd",
        "deviceCategory": "IrrigationMonitor"
      },
      "observationDate": "2022-10-21T11:15:00+00:00",
      "phenomenonStartTime": "2022-10-21T11:15:00+00:00",
      "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Bliss Farm",
        "uri": "https://landco.co.nz/property/K384",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.plotId",
          "id": "ec891102-a8fd-451a-96dd-88aaa8b01c57"
        },
        "name": "Far Flats",
        "uri": "https://landco.co.nz/plot/K384-24",
        "contentType": "plot"
      },
      "responsible": "Aimee Clarke",
      "remark": "Water use, soil moisture and temperature, 21 October 2022",
      "id": "edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.co.irrigationdb",
          "id": "22/JP741"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "yyyyyyyyyyyyyyy",
          "contentType": "Farm Map",
          "related": "https://jjjj.kkkk/dddd"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.zaxfarm.hydrology",
          "id": "0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"
        },
        "modified": "2022-10-21T11:31:00+00:00",
        "created": "2022-10-21T11:31:00+00:00",
        "creator": "zaxfarm.co.nz",
        "validFrom": "2022-10-21T11:31:00+00:00",
        "validTo": "2023-04-21T11:31:00+00:00"
      },
      "name": "Pump Shed readings - Bliss Farm, 21 October 2022",
      "@self": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
      "dataPointKey": "pfHydrologicalObservationsEvent-F"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}]}

GET data/holdings/{holdingId}/environment/hydrological-observations-events

Gets the hydrological observations events for a holding via pagination

Request
GET /data/holdings/{holdingId}/environment/hydrological-observations-events[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the hydrological observations events for
limit

the maximum number of hydrological observations events on a page
offset

the number of hydrological observations events in the total set before the first one on the page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfHydrologicalObservationsEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfHydrologicalObservationsEvent",
      "sampledFeature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.irrigationId",
          "id": "f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"
        },
        "name": "BF-06 Pump Shed",
        "contentType": "irrigation"
      },
      "sensorResults": [
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "Lower Soil Moisture"
          },
          "method": "Digital",
          "value": 20.72,
          "units": "%",
          "resolution": 0.01,
          "duration": 1,
          "durationUnits": "HUR"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "DailyRainfall"
          },
          "method": "Digital",
          "value": 4.5,
          "units": "MMT",
          "aggregation": "Sum",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "DAY"
        },
        {
          "resourceType": "pfSensorResultType",
          "phenomenon": {
            "scheme": "com.metdata.phenomena",
            "id": "SoilTemperature"
          },
          "method": "Digital",
          "value": 5.9,
          "units": "CEL",
          "resolution": 0.1,
          "duration": 1,
          "durationUnits": "HUR",
          "qualitativeValue": "Bad",
          "observationStatus": "Measured",
          "problemDetail": "Instrument is mis-reading"
        }
      ],
      "device": {
        "resourceType": "pfDeviceType",
        "id": "KV-8",
        "serial": "KV-8-999111",
        "name": "KV-8 Farm Irrigation Monitor",
        "description": "KV-8 smart farm irrigation monitoring integrated system",
        "softwareVersion": "3.4.2",
        "hardwareVersion": "8.1",
        "manufacturer": "Farmsmart Irrigation Ltd",
        "deviceCategory": "IrrigationMonitor"
      },
      "observationDate": "2022-10-21T11:15:00+00:00",
      "phenomenonStartTime": "2022-10-21T11:15:00+00:00",
      "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Bliss Farm",
        "uri": "https://landco.co.nz/property/K384",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.plotId",
          "id": "ec891102-a8fd-451a-96dd-88aaa8b01c57"
        },
        "name": "Far Flats",
        "uri": "https://landco.co.nz/plot/K384-24",
        "contentType": "plot"
      },
      "responsible": "Aimee Clarke",
      "remark": "Water use, soil moisture and temperature, 21 October 2022",
      "id": "edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.co.irrigationdb",
          "id": "22/JP741"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "yyyyyyyyyyyyyyy",
          "contentType": "Farm Map",
          "related": "https://jjjj.kkkk/dddd"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.zaxfarm.hydrology",
          "id": "0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"
        },
        "modified": "2022-10-21T11:31:00+00:00",
        "created": "2022-10-21T11:31:00+00:00",
        "creator": "zaxfarm.co.nz",
        "validFrom": "2022-10-21T11:31:00+00:00",
        "validTo": "2023-04-21T11:31:00+00:00"
      },
      "name": "Pump Shed readings - Bliss Farm, 21 October 2022",
      "@self": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
      "dataPointKey": "pfHydrologicalObservationsEvent-F"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events?offset=0&limit=1"},"items":[{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}]}

GET data/environment/hydrological-observations-events/{eventId}

Gets a single hydrological observations event by Id

Request
GET /data/environment/hydrological-observations-events/{eventId}
Parameters
Name Type Default Notes
*eventId

The Id of the hydrological observations event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfHydrologicalObservationsEvent

Success
Mime type: text/plain 
{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}
Mime type: application/json 
{
  "resourceType": "pfHydrologicalObservationsEvent",
  "sampledFeature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.irrigationId",
      "id": "f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"
    },
    "name": "BF-06 Pump Shed",
    "contentType": "irrigation"
  },
  "sensorResults": [
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "Lower Soil Moisture"
      },
      "method": "Digital",
      "value": 20.72,
      "units": "%",
      "resolution": 0.01,
      "duration": 1,
      "durationUnits": "HUR"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "DailyRainfall"
      },
      "method": "Digital",
      "value": 4.5,
      "units": "MMT",
      "aggregation": "Sum",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "DAY"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "SoilTemperature"
      },
      "method": "Digital",
      "value": 5.9,
      "units": "CEL",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "HUR",
      "qualitativeValue": "Bad",
      "observationStatus": "Measured",
      "problemDetail": "Instrument is mis-reading"
    }
  ],
  "device": {
    "resourceType": "pfDeviceType",
    "id": "KV-8",
    "serial": "KV-8-999111",
    "name": "KV-8 Farm Irrigation Monitor",
    "description": "KV-8 smart farm irrigation monitoring integrated system",
    "softwareVersion": "3.4.2",
    "hardwareVersion": "8.1",
    "manufacturer": "Farmsmart Irrigation Ltd",
    "deviceCategory": "IrrigationMonitor"
  },
  "observationDate": "2022-10-21T11:15:00+00:00",
  "phenomenonStartTime": "2022-10-21T11:15:00+00:00",
  "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Bliss Farm",
    "uri": "https://landco.co.nz/property/K384",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.plotId",
      "id": "ec891102-a8fd-451a-96dd-88aaa8b01c57"
    },
    "name": "Far Flats",
    "uri": "https://landco.co.nz/plot/K384-24",
    "contentType": "plot"
  },
  "responsible": "Aimee Clarke",
  "remark": "Water use, soil moisture and temperature, 21 October 2022",
  "id": "edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.co.irrigationdb",
      "id": "22/JP741"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "yyyyyyyyyyyyyyy",
      "contentType": "Farm Map",
      "related": "https://jjjj.kkkk/dddd"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfarm.hydrology",
      "id": "0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"
    },
    "modified": "2022-10-21T11:31:00+00:00",
    "created": "2022-10-21T11:31:00+00:00",
    "creator": "zaxfarm.co.nz",
    "validFrom": "2022-10-21T11:31:00+00:00",
    "validTo": "2023-04-21T11:31:00+00:00"
  },
  "name": "Pump Shed readings - Bliss Farm, 21 October 2022",
  "@self": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
  "dataPointKey": "pfHydrologicalObservationsEvent-F"
}
Mime type: text/json 
{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/environment/hydrological-observations-events/{eventId}

Gets a single hydrological observations event with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/environment/hydrological-observations-events/{eventId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the hydrological observations event for
*eventId

The Id of the hydrological observations event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfHydrologicalObservationsEvent

Success
Mime type: text/plain 
{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}
Mime type: application/json 
{
  "resourceType": "pfHydrologicalObservationsEvent",
  "sampledFeature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.irrigationId",
      "id": "f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"
    },
    "name": "BF-06 Pump Shed",
    "contentType": "irrigation"
  },
  "sensorResults": [
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "Lower Soil Moisture"
      },
      "method": "Digital",
      "value": 20.72,
      "units": "%",
      "resolution": 0.01,
      "duration": 1,
      "durationUnits": "HUR"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "DailyRainfall"
      },
      "method": "Digital",
      "value": 4.5,
      "units": "MMT",
      "aggregation": "Sum",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "DAY"
    },
    {
      "resourceType": "pfSensorResultType",
      "phenomenon": {
        "scheme": "com.metdata.phenomena",
        "id": "SoilTemperature"
      },
      "method": "Digital",
      "value": 5.9,
      "units": "CEL",
      "resolution": 0.1,
      "duration": 1,
      "durationUnits": "HUR",
      "qualitativeValue": "Bad",
      "observationStatus": "Measured",
      "problemDetail": "Instrument is mis-reading"
    }
  ],
  "device": {
    "resourceType": "pfDeviceType",
    "id": "KV-8",
    "serial": "KV-8-999111",
    "name": "KV-8 Farm Irrigation Monitor",
    "description": "KV-8 smart farm irrigation monitoring integrated system",
    "softwareVersion": "3.4.2",
    "hardwareVersion": "8.1",
    "manufacturer": "Farmsmart Irrigation Ltd",
    "deviceCategory": "IrrigationMonitor"
  },
  "observationDate": "2022-10-21T11:15:00+00:00",
  "phenomenonStartTime": "2022-10-21T11:15:00+00:00",
  "phenomenonEndTime": "2022-10-14T01:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Bliss Farm",
    "uri": "https://landco.co.nz/property/K384",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.plotId",
      "id": "ec891102-a8fd-451a-96dd-88aaa8b01c57"
    },
    "name": "Far Flats",
    "uri": "https://landco.co.nz/plot/K384-24",
    "contentType": "plot"
  },
  "responsible": "Aimee Clarke",
  "remark": "Water use, soil moisture and temperature, 21 October 2022",
  "id": "edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.co.irrigationdb",
      "id": "22/JP741"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "yyyyyyyyyyyyyyy",
      "contentType": "Farm Map",
      "related": "https://jjjj.kkkk/dddd"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfarm.hydrology",
      "id": "0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"
    },
    "modified": "2022-10-21T11:31:00+00:00",
    "created": "2022-10-21T11:31:00+00:00",
    "creator": "zaxfarm.co.nz",
    "validFrom": "2022-10-21T11:31:00+00:00",
    "validTo": "2023-04-21T11:31:00+00:00"
  },
  "name": "Pump Shed readings - Bliss Farm, 21 October 2022",
  "@self": "https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57",
  "dataPointKey": "pfHydrologicalObservationsEvent-F"
}
Mime type: text/json 
{"resourceType":"pfHydrologicalObservationsEvent","sampledFeature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.irrigationId","id":"f44c65fa-9c16-4b5f-b8b3-52bd9acb49be"},"name":"BF-06 Pump Shed","contentType":"irrigation"},"sensorResults":[{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"Lower Soil Moisture"},"method":"Digital","value":20.72,"units":"%","resolution":0.01,"duration":1.0,"durationUnits":"HUR"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"DailyRainfall"},"method":"Digital","value":4.5,"units":"MMT","aggregation":"Sum","resolution":0.1,"duration":1.0,"durationUnits":"DAY"},{"resourceType":"pfSensorResultType","phenomenon":{"scheme":"com.metdata.phenomena","id":"SoilTemperature"},"method":"Digital","value":5.9,"units":"CEL","resolution":0.1,"duration":1.0,"durationUnits":"HUR","qualitativeValue":"Bad","observationStatus":"Measured","problemDetail":"Instrument is mis-reading"}],"device":{"resourceType":"pfDeviceType","id":"KV-8","serial":"KV-8-999111","name":"KV-8 Farm Irrigation Monitor","description":"KV-8 smart farm irrigation monitoring integrated system","softwareVersion":"3.4.2","hardwareVersion":"8.1","manufacturer":"Farmsmart Irrigation Ltd","deviceCategory":"IrrigationMonitor"},"observationDate":"2022-10-21T11:15:00+00:00","phenomenonStartTime":"2022-10-21T11:15:00+00:00","phenomenonEndTime":"2022-10-14T01:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Bliss Farm","uri":"https://landco.co.nz/property/K384","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.plotId","id":"ec891102-a8fd-451a-96dd-88aaa8b01c57"},"name":"Far Flats","uri":"https://landco.co.nz/plot/K384-24","contentType":"plot"},"responsible":"Aimee Clarke","remark":"Water use, soil moisture and temperature, 21 October 2022","id":"edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.irrigationdb","id":"22/JP741"}],"links":[{"resourceType":"relationType","relationship":"yyyyyyyyyyyyyyy","contentType":"Farm Map","related":"https://jjjj.kkkk/dddd"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfarm.hydrology","id":"0bd8ec0f-b6d3-4aa0-9da2-4751bd0d9271"},"modified":"2022-10-21T11:31:00+00:00","created":"2022-10-21T11:31:00+00:00","creator":"zaxfarm.co.nz","validFrom":"2022-10-21T11:31:00+00:00","validTo":"2023-04-21T11:31:00+00:00"},"name":"Pump Shed readings - Bliss Farm, 21 October 2022","@self":"https://api.dev.purefarming.com/data/environment/hydrological-observations-events/edbc7b38-58dc-4fbd-86cf-3bb3a07b5b57","dataPointKey":"pfHydrologicalObservationsEvent-F"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Fisheries

GET data/fisheries/catch-landing-observations

Returns all of the catch-landing-observations that a user has access too

Request
GET /data/fisheries/catch-landing-observations[?limit&offset&cloIdentifier&cloIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
cloIdentifier

The catch-landing-observation identifier to search for
cloIdentifierScheme

The catch-landing-observation identifier scheme to search for
includeDeleted False

Include deleted events in the results, default = false
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.catchLandingObservation]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"d183085a-2313-4550-a155-453d86b29d68"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"2fd2e359-589d-4886-ad4d-13708a6c6896"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"8d835be1-0959-4f56-98fc-c46f433f1592","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"554454aa-9c88-4b73-8264-b2686fa029fc"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"d6a5491b-ab0b-4725-b7d5-30bdbecf4b63"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"16bce58a-c73b-44e0-850c-1beca218f69c"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/8d835be1-0959-4f56-98fc-c46f433f1592"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "catchLandingObservation",
      "processor": "ABC99999",
      "port": "Gablehead West",
      "numberShots": 5,
      "numberBins": 5,
      "potsPulled": 7,
      "numberTakeHome": 0,
      "tagRangeStart": "XY123456",
      "tagRangeEnd": "XY123456",
      "catch": [
        {
          "resourceType": "speciesQuantityType",
          "species": "Rock Lobster",
          "grade": "Size",
          "weight": {
            "units": "KGM",
            "measurement": 40,
            "resolution": 0.1
          },
          "count": 20
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Rock Lobster",
          "grade": "1.5-2kgs",
          "weight": {
            "units": "KGM",
            "measurement": 12.3,
            "resolution": 0.1
          },
          "count": 7
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Rock Lobster",
          "grade": "2-2.5kgs",
          "weight": {
            "units": "KGM",
            "measurement": 18,
            "resolution": 0.1
          },
          "count": 8
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Spencer Gulf King Prawns",
          "grade": "Total",
          "weight": {
            "units": "KGM",
            "measurement": 950,
            "resolution": 1
          },
          "count": 450
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Spencer Gulf King Prawns",
          "grade": "U10",
          "weight": {
            "units": "KGM",
            "measurement": 100,
            "resolution": 1
          },
          "count": 310
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Spencer Gulf King Prawns",
          "grade": "U10-15",
          "weight": {
            "units": "KGM",
            "measurement": 200,
            "resolution": 1
          },
          "count": 453
        }
      ],
      "bycatch": [
        {
          "resourceType": "speciesQuantityType",
          "species": "Octopus",
          "grade": "High",
          "weight": {
            "units": "KGM",
            "measurement": 58,
            "resolution": 1
          },
          "count": 20
        }
      ],
      "trip": {
        "resourceType": "fisheriesTripType",
        "tripId": {
          "scheme": "com.deckhand.trip",
          "id": "d183085a-2313-4550-a155-453d86b29d68"
        },
        "skipper": "Jack Smith",
        "vesselName": "Blue Doris",
        "vesselIdentifier": {
          "scheme": "com.deckhand.vessel",
          "id": "V88810000A"
        },
        "licences": [
          "S999"
        ],
        "startDateTime": "2023-10-31T11:49:28+00:00",
        "endDateTime": "2023-10-31T17:51:00+00:00",
        "fishery": "ABC123",
        "manDays": 1,
        "effortActive": 3,
        "effortNets": 2,
        "environmentalObservations": [
          {
            "metric": {
              "scheme": "com.metadata.metric",
              "id": "2fd2e359-589d-4886-ad4d-13708a6c6896"
            },
            "value": 23.3,
            "units": "CEL",
            "aggregation": "Max"
          }
        ]
      },
      "observationDate": "2023-10-31T16:25:00+00:00",
      "phenomenonStartTime": "2023-10-31T16:25:00+00:00",
      "phenomenonEndTime": "2023-10-31T17:17:00+00:00",
      "responsible": "Fabio Capello",
      "remark": "Poor Catch",
      "id": "8d835be1-0959-4f56-98fc-c46f433f1592",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "com.deckhand.organisation",
          "id": "554454aa-9c88-4b73-8264-b2686fa029fc"
        },
        {
          "resourceType": "identifierType",
          "scheme": "com.deckhand.report",
          "id": "d6a5491b-ab0b-4725-b7d5-30bdbecf4b63"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "Organisation",
          "contentType": "FishingCompany",
          "related": "https://abcfishingco.com.au"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "com.deckhand.report",
          "id": "16bce58a-c73b-44e0-850c-1beca218f69c"
        },
        "modified": "2023-10-31T15:20:00+00:00",
        "created": "2023-10-31T15:20:00+00:00",
        "creator": "com.deckhand",
        "validFrom": "2023-10-31T15:20:00+00:00",
        "validTo": "2024-10-31T15:20:00+00:00",
        "isDeleted": false
      },
      "name": "Catch landing, 31/10/23 start 12:38, Trip S999123456A",
      "@self": "https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/8d835be1-0959-4f56-98fc-c46f433f1592"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"d183085a-2313-4550-a155-453d86b29d68"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"2fd2e359-589d-4886-ad4d-13708a6c6896"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"8d835be1-0959-4f56-98fc-c46f433f1592","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"554454aa-9c88-4b73-8264-b2686fa029fc"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"d6a5491b-ab0b-4725-b7d5-30bdbecf4b63"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"16bce58a-c73b-44e0-850c-1beca218f69c"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/8d835be1-0959-4f56-98fc-c46f433f1592"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/fisheries/catch-landing-observations/{cloId}

Returns the details for the given catch-landing-observation that the user has access too

Request
GET /data/fisheries/catch-landing-observations/{cloId}
Parameters
Name Type Default Notes
*cloId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.catchLandingObservation

Success
Mime type: text/plain 
{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"984834f4-deae-46e8-826c-2ee8ea871384"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"2db32f49-5cad-4da9-bf63-54bb9137e4a9"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"d50bcde2-c341-4db3-9c3b-e0c214d7cc1f","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"452e78d9-96c0-4539-8bab-b486b892cbc2"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"b3a84b7e-0231-45b0-91c0-9d8c3a275cd9"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"a34c3568-97de-488c-9147-00201b52b5a3"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/d50bcde2-c341-4db3-9c3b-e0c214d7cc1f"}
Mime type: application/json 
{
  "resourceType": "catchLandingObservation",
  "processor": "ABC99999",
  "port": "Gablehead West",
  "numberShots": 5,
  "numberBins": 5,
  "potsPulled": 7,
  "numberTakeHome": 0,
  "tagRangeStart": "XY123456",
  "tagRangeEnd": "XY123456",
  "catch": [
    {
      "resourceType": "speciesQuantityType",
      "species": "Rock Lobster",
      "grade": "Size",
      "weight": {
        "units": "KGM",
        "measurement": 40,
        "resolution": 0.1
      },
      "count": 20
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Rock Lobster",
      "grade": "1.5-2kgs",
      "weight": {
        "units": "KGM",
        "measurement": 12.3,
        "resolution": 0.1
      },
      "count": 7
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Rock Lobster",
      "grade": "2-2.5kgs",
      "weight": {
        "units": "KGM",
        "measurement": 18,
        "resolution": 0.1
      },
      "count": 8
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Spencer Gulf King Prawns",
      "grade": "Total",
      "weight": {
        "units": "KGM",
        "measurement": 950,
        "resolution": 1
      },
      "count": 450
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Spencer Gulf King Prawns",
      "grade": "U10",
      "weight": {
        "units": "KGM",
        "measurement": 100,
        "resolution": 1
      },
      "count": 310
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Spencer Gulf King Prawns",
      "grade": "U10-15",
      "weight": {
        "units": "KGM",
        "measurement": 200,
        "resolution": 1
      },
      "count": 453
    }
  ],
  "bycatch": [
    {
      "resourceType": "speciesQuantityType",
      "species": "Octopus",
      "grade": "High",
      "weight": {
        "units": "KGM",
        "measurement": 58,
        "resolution": 1
      },
      "count": 20
    }
  ],
  "trip": {
    "resourceType": "fisheriesTripType",
    "tripId": {
      "scheme": "com.deckhand.trip",
      "id": "984834f4-deae-46e8-826c-2ee8ea871384"
    },
    "skipper": "Jack Smith",
    "vesselName": "Blue Doris",
    "vesselIdentifier": {
      "scheme": "com.deckhand.vessel",
      "id": "V88810000A"
    },
    "licences": [
      "S999"
    ],
    "startDateTime": "2023-10-31T11:49:28+00:00",
    "endDateTime": "2023-10-31T17:51:00+00:00",
    "fishery": "ABC123",
    "manDays": 1,
    "effortActive": 3,
    "effortNets": 2,
    "environmentalObservations": [
      {
        "metric": {
          "scheme": "com.metadata.metric",
          "id": "2db32f49-5cad-4da9-bf63-54bb9137e4a9"
        },
        "value": 23.3,
        "units": "CEL",
        "aggregation": "Max"
      }
    ]
  },
  "observationDate": "2023-10-31T16:25:00+00:00",
  "phenomenonStartTime": "2023-10-31T16:25:00+00:00",
  "phenomenonEndTime": "2023-10-31T17:17:00+00:00",
  "responsible": "Fabio Capello",
  "remark": "Poor Catch",
  "id": "d50bcde2-c341-4db3-9c3b-e0c214d7cc1f",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "com.deckhand.organisation",
      "id": "452e78d9-96c0-4539-8bab-b486b892cbc2"
    },
    {
      "resourceType": "identifierType",
      "scheme": "com.deckhand.report",
      "id": "b3a84b7e-0231-45b0-91c0-9d8c3a275cd9"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "Organisation",
      "contentType": "FishingCompany",
      "related": "https://abcfishingco.com.au"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "com.deckhand.report",
      "id": "a34c3568-97de-488c-9147-00201b52b5a3"
    },
    "modified": "2023-10-31T15:20:00+00:00",
    "created": "2023-10-31T15:20:00+00:00",
    "creator": "com.deckhand",
    "validFrom": "2023-10-31T15:20:00+00:00",
    "validTo": "2024-10-31T15:20:00+00:00",
    "isDeleted": false
  },
  "name": "Catch landing, 31/10/23 start 12:38, Trip S999123456A",
  "@self": "https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/d50bcde2-c341-4db3-9c3b-e0c214d7cc1f"
}
Mime type: text/json 
{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"984834f4-deae-46e8-826c-2ee8ea871384"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"2db32f49-5cad-4da9-bf63-54bb9137e4a9"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"d50bcde2-c341-4db3-9c3b-e0c214d7cc1f","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"452e78d9-96c0-4539-8bab-b486b892cbc2"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"b3a84b7e-0231-45b0-91c0-9d8c3a275cd9"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"a34c3568-97de-488c-9147-00201b52b5a3"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/d50bcde2-c341-4db3-9c3b-e0c214d7cc1f"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/fisheries/catch-landing-observations

Returns all of the catch-landing-observations attached to the given holding

Request
GET /data/holdings/{holdingId}/fisheries/catch-landing-observations[?limit&offset&cloIdentifier&cloIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
cloIdentifier

The catch-landing-observation identifier to search for
cloIdentifierScheme

The catch-landing-observation identifier scheme to search for
includeDeleted False

Include deleted events in the results, default = false
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.catchLandingObservation]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"9788fb8e-cbbf-4ff4-809e-366bc1cb2dd1"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"6ecd60f4-6abd-4eac-a64c-867a402b785a"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"498c85ce-2ef5-413c-aef1-641481a45193","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"31bc49df-f513-45e3-9f3e-d5d5a235485e"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"abd7fb71-cb16-4174-a9b2-16b4733fda4b"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"47a16cf5-a318-4474-95f5-d5ebc4e64ccf"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/498c85ce-2ef5-413c-aef1-641481a45193"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "catchLandingObservation",
      "processor": "ABC99999",
      "port": "Gablehead West",
      "numberShots": 5,
      "numberBins": 5,
      "potsPulled": 7,
      "numberTakeHome": 0,
      "tagRangeStart": "XY123456",
      "tagRangeEnd": "XY123456",
      "catch": [
        {
          "resourceType": "speciesQuantityType",
          "species": "Rock Lobster",
          "grade": "Size",
          "weight": {
            "units": "KGM",
            "measurement": 40,
            "resolution": 0.1
          },
          "count": 20
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Rock Lobster",
          "grade": "1.5-2kgs",
          "weight": {
            "units": "KGM",
            "measurement": 12.3,
            "resolution": 0.1
          },
          "count": 7
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Rock Lobster",
          "grade": "2-2.5kgs",
          "weight": {
            "units": "KGM",
            "measurement": 18,
            "resolution": 0.1
          },
          "count": 8
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Spencer Gulf King Prawns",
          "grade": "Total",
          "weight": {
            "units": "KGM",
            "measurement": 950,
            "resolution": 1
          },
          "count": 450
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Spencer Gulf King Prawns",
          "grade": "U10",
          "weight": {
            "units": "KGM",
            "measurement": 100,
            "resolution": 1
          },
          "count": 310
        },
        {
          "resourceType": "speciesQuantityType",
          "species": "Spencer Gulf King Prawns",
          "grade": "U10-15",
          "weight": {
            "units": "KGM",
            "measurement": 200,
            "resolution": 1
          },
          "count": 453
        }
      ],
      "bycatch": [
        {
          "resourceType": "speciesQuantityType",
          "species": "Octopus",
          "grade": "High",
          "weight": {
            "units": "KGM",
            "measurement": 58,
            "resolution": 1
          },
          "count": 20
        }
      ],
      "trip": {
        "resourceType": "fisheriesTripType",
        "tripId": {
          "scheme": "com.deckhand.trip",
          "id": "9788fb8e-cbbf-4ff4-809e-366bc1cb2dd1"
        },
        "skipper": "Jack Smith",
        "vesselName": "Blue Doris",
        "vesselIdentifier": {
          "scheme": "com.deckhand.vessel",
          "id": "V88810000A"
        },
        "licences": [
          "S999"
        ],
        "startDateTime": "2023-10-31T11:49:28+00:00",
        "endDateTime": "2023-10-31T17:51:00+00:00",
        "fishery": "ABC123",
        "manDays": 1,
        "effortActive": 3,
        "effortNets": 2,
        "environmentalObservations": [
          {
            "metric": {
              "scheme": "com.metadata.metric",
              "id": "6ecd60f4-6abd-4eac-a64c-867a402b785a"
            },
            "value": 23.3,
            "units": "CEL",
            "aggregation": "Max"
          }
        ]
      },
      "observationDate": "2023-10-31T16:25:00+00:00",
      "phenomenonStartTime": "2023-10-31T16:25:00+00:00",
      "phenomenonEndTime": "2023-10-31T17:17:00+00:00",
      "responsible": "Fabio Capello",
      "remark": "Poor Catch",
      "id": "498c85ce-2ef5-413c-aef1-641481a45193",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "com.deckhand.organisation",
          "id": "31bc49df-f513-45e3-9f3e-d5d5a235485e"
        },
        {
          "resourceType": "identifierType",
          "scheme": "com.deckhand.report",
          "id": "abd7fb71-cb16-4174-a9b2-16b4733fda4b"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "relationship": "Organisation",
          "contentType": "FishingCompany",
          "related": "https://abcfishingco.com.au"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "com.deckhand.report",
          "id": "47a16cf5-a318-4474-95f5-d5ebc4e64ccf"
        },
        "modified": "2023-10-31T15:20:00+00:00",
        "created": "2023-10-31T15:20:00+00:00",
        "creator": "com.deckhand",
        "validFrom": "2023-10-31T15:20:00+00:00",
        "validTo": "2024-10-31T15:20:00+00:00",
        "isDeleted": false
      },
      "name": "Catch landing, 31/10/23 start 12:38, Trip S999123456A",
      "@self": "https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/498c85ce-2ef5-413c-aef1-641481a45193"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"9788fb8e-cbbf-4ff4-809e-366bc1cb2dd1"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"6ecd60f4-6abd-4eac-a64c-867a402b785a"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"498c85ce-2ef5-413c-aef1-641481a45193","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"31bc49df-f513-45e3-9f3e-d5d5a235485e"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"abd7fb71-cb16-4174-a9b2-16b4733fda4b"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"47a16cf5-a318-4474-95f5-d5ebc4e64ccf"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/498c85ce-2ef5-413c-aef1-641481a45193"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/fisheries/catch-landing-observations/{cloId}

Returns the details for the given catch-landing-observation

Request
GET /data/holdings/{holdingId}/fisheries/catch-landing-observations/{cloId}
Parameters
Name Type Default Notes
*cloId
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.catchLandingObservation

Success
Mime type: text/plain 
{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"5976b7e3-3346-406f-905d-974cdb324d8a"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"46c59a75-29df-49ac-acc4-c5d84c9d0aac"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"33456b4a-3f2b-49de-97a0-4355e616b493","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"0a53167e-047d-4647-aaf7-d65a02066a2f"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"1a85c5ec-375b-430f-ae5c-42361a3e269c"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"0eb35e89-9d9b-4b20-b1f7-f6657e08a6fd"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/33456b4a-3f2b-49de-97a0-4355e616b493"}
Mime type: application/json 
{
  "resourceType": "catchLandingObservation",
  "processor": "ABC99999",
  "port": "Gablehead West",
  "numberShots": 5,
  "numberBins": 5,
  "potsPulled": 7,
  "numberTakeHome": 0,
  "tagRangeStart": "XY123456",
  "tagRangeEnd": "XY123456",
  "catch": [
    {
      "resourceType": "speciesQuantityType",
      "species": "Rock Lobster",
      "grade": "Size",
      "weight": {
        "units": "KGM",
        "measurement": 40,
        "resolution": 0.1
      },
      "count": 20
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Rock Lobster",
      "grade": "1.5-2kgs",
      "weight": {
        "units": "KGM",
        "measurement": 12.3,
        "resolution": 0.1
      },
      "count": 7
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Rock Lobster",
      "grade": "2-2.5kgs",
      "weight": {
        "units": "KGM",
        "measurement": 18,
        "resolution": 0.1
      },
      "count": 8
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Spencer Gulf King Prawns",
      "grade": "Total",
      "weight": {
        "units": "KGM",
        "measurement": 950,
        "resolution": 1
      },
      "count": 450
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Spencer Gulf King Prawns",
      "grade": "U10",
      "weight": {
        "units": "KGM",
        "measurement": 100,
        "resolution": 1
      },
      "count": 310
    },
    {
      "resourceType": "speciesQuantityType",
      "species": "Spencer Gulf King Prawns",
      "grade": "U10-15",
      "weight": {
        "units": "KGM",
        "measurement": 200,
        "resolution": 1
      },
      "count": 453
    }
  ],
  "bycatch": [
    {
      "resourceType": "speciesQuantityType",
      "species": "Octopus",
      "grade": "High",
      "weight": {
        "units": "KGM",
        "measurement": 58,
        "resolution": 1
      },
      "count": 20
    }
  ],
  "trip": {
    "resourceType": "fisheriesTripType",
    "tripId": {
      "scheme": "com.deckhand.trip",
      "id": "5976b7e3-3346-406f-905d-974cdb324d8a"
    },
    "skipper": "Jack Smith",
    "vesselName": "Blue Doris",
    "vesselIdentifier": {
      "scheme": "com.deckhand.vessel",
      "id": "V88810000A"
    },
    "licences": [
      "S999"
    ],
    "startDateTime": "2023-10-31T11:49:28+00:00",
    "endDateTime": "2023-10-31T17:51:00+00:00",
    "fishery": "ABC123",
    "manDays": 1,
    "effortActive": 3,
    "effortNets": 2,
    "environmentalObservations": [
      {
        "metric": {
          "scheme": "com.metadata.metric",
          "id": "46c59a75-29df-49ac-acc4-c5d84c9d0aac"
        },
        "value": 23.3,
        "units": "CEL",
        "aggregation": "Max"
      }
    ]
  },
  "observationDate": "2023-10-31T16:25:00+00:00",
  "phenomenonStartTime": "2023-10-31T16:25:00+00:00",
  "phenomenonEndTime": "2023-10-31T17:17:00+00:00",
  "responsible": "Fabio Capello",
  "remark": "Poor Catch",
  "id": "33456b4a-3f2b-49de-97a0-4355e616b493",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "com.deckhand.organisation",
      "id": "0a53167e-047d-4647-aaf7-d65a02066a2f"
    },
    {
      "resourceType": "identifierType",
      "scheme": "com.deckhand.report",
      "id": "1a85c5ec-375b-430f-ae5c-42361a3e269c"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "relationship": "Organisation",
      "contentType": "FishingCompany",
      "related": "https://abcfishingco.com.au"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "com.deckhand.report",
      "id": "0eb35e89-9d9b-4b20-b1f7-f6657e08a6fd"
    },
    "modified": "2023-10-31T15:20:00+00:00",
    "created": "2023-10-31T15:20:00+00:00",
    "creator": "com.deckhand",
    "validFrom": "2023-10-31T15:20:00+00:00",
    "validTo": "2024-10-31T15:20:00+00:00",
    "isDeleted": false
  },
  "name": "Catch landing, 31/10/23 start 12:38, Trip S999123456A",
  "@self": "https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/33456b4a-3f2b-49de-97a0-4355e616b493"
}
Mime type: text/json 
{"resourceType":"catchLandingObservation","processor":"ABC99999","port":"Gablehead West","numberShots":5,"numberBins":5,"potsPulled":7,"numberTakeHome":0,"tagRangeStart":"XY123456","tagRangeEnd":"XY123456","catch":[{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"Size","weight":{"units":"KGM","measurement":40.0,"resolution":0.1},"count":20},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"1.5-2kgs","weight":{"units":"KGM","measurement":12.3,"resolution":0.1},"count":7},{"resourceType":"speciesQuantityType","species":"Rock Lobster","grade":"2-2.5kgs","weight":{"units":"KGM","measurement":18.0,"resolution":0.1},"count":8},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"Total","weight":{"units":"KGM","measurement":950.0,"resolution":1.0},"count":450},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10","weight":{"units":"KGM","measurement":100.0,"resolution":1.0},"count":310},{"resourceType":"speciesQuantityType","species":"Spencer Gulf King Prawns","grade":"U10-15","weight":{"units":"KGM","measurement":200.0,"resolution":1.0},"count":453}],"bycatch":[{"resourceType":"speciesQuantityType","species":"Octopus","grade":"High","weight":{"units":"KGM","measurement":58.0,"resolution":1.0},"count":20}],"trip":{"resourceType":"fisheriesTripType","tripId":{"scheme":"com.deckhand.trip","id":"5976b7e3-3346-406f-905d-974cdb324d8a"},"skipper":"Jack Smith","vesselName":"Blue Doris","vesselIdentifier":{"scheme":"com.deckhand.vessel","id":"V88810000A"},"licences":["S999"],"startDateTime":"2023-10-31T11:49:28+00:00","endDateTime":"2023-10-31T17:51:00+00:00","fishery":"ABC123","manDays":1.0,"effortActive":3.0,"effortNets":2.0,"environmentalObservations":[{"metric":{"scheme":"com.metadata.metric","id":"46c59a75-29df-49ac-acc4-c5d84c9d0aac"},"value":23.3,"units":"CEL","aggregation":"Max"}]},"observationDate":"2023-10-31T16:25:00+00:00","phenomenonStartTime":"2023-10-31T16:25:00+00:00","phenomenonEndTime":"2023-10-31T17:17:00+00:00","responsible":"Fabio Capello","remark":"Poor Catch","id":"33456b4a-3f2b-49de-97a0-4355e616b493","identifiers":[{"resourceType":"identifierType","scheme":"com.deckhand.organisation","id":"0a53167e-047d-4647-aaf7-d65a02066a2f"},{"resourceType":"identifierType","scheme":"com.deckhand.report","id":"1a85c5ec-375b-430f-ae5c-42361a3e269c"}],"links":[{"resourceType":"relationType","relationship":"Organisation","contentType":"FishingCompany","related":"https://abcfishingco.com.au"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"com.deckhand.report","id":"0eb35e89-9d9b-4b20-b1f7-f6657e08a6fd"},"modified":"2023-10-31T15:20:00+00:00","created":"2023-10-31T15:20:00+00:00","creator":"com.deckhand","validFrom":"2023-10-31T15:20:00+00:00","validTo":"2024-10-31T15:20:00+00:00","isDeleted":false},"name":"Catch landing, 31/10/23 start 12:38, Trip S999123456A","@self":"https://api.dev.purefarming.com/data/fisheries/catch-landing-observations/33456b4a-3f2b-49de-97a0-4355e616b493"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Holdings

GET data/holdings

Get information about holdings (you must have permission on the /core/holding resource type)

This endpoint gets information about holdings where you have permission to access information about the holding itself. This means you must have access to the /core/holding resource type for the holding.

It will not get you a list of all the holdings you have access to. You can get a list of holdings you have access to read data about from the Ecosystem API - /ecosystem/self/holdings endpoint

Request
GET /data/holdings[?limit&offset]
Parameters
Name Type Default Notes
limit

This endpoint gets information about holdings where you have permission to access information about the holding itself. This means you must have access to the /core/holding resource type for the holding.

It will not get you a list of all the holdings you have access to. You can get a list of holdings you have access to read data about from the Ecosystem API - /ecosystem/self/holdings endpoint
offset

This endpoint gets information about holdings where you have permission to access information about the holding itself. This means you must have access to the /core/holding resource type for the holding.

It will not get you a list of all the holdings you have access to. You can get a list of holdings you have access to read data about from the Ecosystem API - /ecosystem/self/holdings endpoint
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfHoldingResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":500,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500","next":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500","previous":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500","last":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500"},"items":[{"holdingResource":"pfHoldingResource","spatialFeature":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[100.0,0.0],[101.0,0.0],[101.0,1.0],[100.0,1.0],[100.0,0.0]]],"bbox":null},"properties":{},"bbox":null},"totalArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":23000.0},"id":"8bfa7aa2-47df-4596-bc83-16071659b098","identifiers":[{"resourceType":"identifierType","scheme":"CPH","id":"12/345/6789"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"someFarmMapSystem","id":"123456789"},"modified":"2021-09-15T12:34:56+00:00"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 500,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/holdings?offset=0&limit=500",
    "next": "https://api.dev.purefarming.com/data/holdings?offset=0&limit=500",
    "previous": "https://api.dev.purefarming.com/data/holdings?offset=0&limit=500",
    "last": "https://api.dev.purefarming.com/data/holdings?offset=0&limit=500"
  },
  "items": [
    {
      "holdingResource": "pfHoldingResource",
      "spatialFeature": {
        "id": null,
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                100,
                0
              ],
              [
                101,
                0
              ],
              [
                101,
                1
              ],
              [
                100,
                1
              ],
              [
                100,
                0
              ]
            ]
          ],
          "bbox": null
        },
        "properties": {},
        "bbox": null
      },
      "totalArea": {
        "resourceType": "areaMeasureType",
        "units": "MTK",
        "measurement": 23000
      },
      "id": "8bfa7aa2-47df-4596-bc83-16071659b098",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "CPH",
          "id": "12/345/6789"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "someFarmMapSystem",
          "id": "123456789"
        },
        "modified": "2021-09-15T12:34:56+00:00"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":500,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500","next":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500","previous":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500","last":"https://api.dev.purefarming.com/data/holdings?offset=0&limit=500"},"items":[{"holdingResource":"pfHoldingResource","spatialFeature":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[100.0,0.0],[101.0,0.0],[101.0,1.0],[100.0,1.0],[100.0,0.0]]],"bbox":null},"properties":{},"bbox":null},"totalArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":23000.0},"id":"8bfa7aa2-47df-4596-bc83-16071659b098","identifiers":[{"resourceType":"identifierType","scheme":"CPH","id":"12/345/6789"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"someFarmMapSystem","id":"123456789"},"modified":"2021-09-15T12:34:56+00:00"}}]}

GET data/holdings/{Id}

Gets the specified holding.

Request
GET /data/holdings/{Id}
Parameters
Name Type Default Notes
*Id

The identifier of the queried holding.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfHoldingResource

Success
Mime type: text/plain 
{"holdingResource":"pfHoldingResource","spatialFeature":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[100.0,0.0],[101.0,0.0],[101.0,1.0],[100.0,1.0],[100.0,0.0]]],"bbox":null},"properties":{},"bbox":null},"totalArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":23000.0},"id":"8bfa7aa2-47df-4596-bc83-16071659b098","identifiers":[{"resourceType":"identifierType","scheme":"CPH","id":"12/345/6789"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"someFarmMapSystem","id":"123456789"},"modified":"2021-09-15T12:34:56+00:00"}}
Mime type: application/json 
{
  "holdingResource": "pfHoldingResource",
  "spatialFeature": {
    "id": null,
    "type": "Feature",
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            100,
            0
          ],
          [
            101,
            0
          ],
          [
            101,
            1
          ],
          [
            100,
            1
          ],
          [
            100,
            0
          ]
        ]
      ],
      "bbox": null
    },
    "properties": {},
    "bbox": null
  },
  "totalArea": {
    "resourceType": "areaMeasureType",
    "units": "MTK",
    "measurement": 23000
  },
  "id": "8bfa7aa2-47df-4596-bc83-16071659b098",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "CPH",
      "id": "12/345/6789"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "someFarmMapSystem",
      "id": "123456789"
    },
    "modified": "2021-09-15T12:34:56+00:00"
  }
}
Mime type: text/json 
{"holdingResource":"pfHoldingResource","spatialFeature":{"id":null,"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[100.0,0.0],[101.0,0.0],[101.0,1.0],[100.0,1.0],[100.0,0.0]]],"bbox":null},"properties":{},"bbox":null},"totalArea":{"resourceType":"areaMeasureType","units":"MTK","measurement":23000.0},"id":"8bfa7aa2-47df-4596-bc83-16071659b098","identifiers":[{"resourceType":"identifierType","scheme":"CPH","id":"12/345/6789"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"someFarmMapSystem","id":"123456789"},"modified":"2021-09-15T12:34:56+00:00"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

POST data/holdings/billing-summary

Gets whether a holding has data or not. This is used for billing purposes

Request
POST /data/holdings/billing-summary
Parameters
Name Type Default Notes
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
body array

The holding Ids.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Mediatr.Holdings.PostHoldingSummaryResponse

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

Inventory :: Feed transactions

GET data/inventory/feed-transactions

Returns all of the inventory feed transactions that a user has access to via pagination

Request
GET /data/inventory/feed-transactions[?limit&offset]
Parameters
Name Type Default Notes
limit

The number of inventory feed transactions per page
offset

the number of inventory feed transaction to skip before the first one returned
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarFeedTransactionResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarFeedTransactionResource",
      "product": {
        "resourceType": "icarFeedReferenceType",
        "category": "Additives",
        "type": {
          "id": "Cattle Supplements",
          "scheme": "nz.co.abcstockfoods.type"
        },
        "identifier": {
          "id": "MOL111",
          "scheme": "nz.co.abcstockfoods"
        },
        "href": "https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html",
        "family": "Animal Feeds",
        "name": "KJH Stockfoods - Mollases",
        "gtin": "012345678966",
        "unspc": "10121500"
      },
      "transactionKind": "Receipt",
      "quantity": 80,
      "units": "LTR",
      "supplierName": "KJH Farm Supplies Ltd",
      "expiryDate": "2023-10-30T00:00:00+00:00",
      "totalCost": 210.5,
      "currency": "NZD",
      "packSize": 20,
      "numberOfPacks": 3,
      "id": "d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4",
      "eventDateTime": "2023-04-07T15:33:00+00:00",
      "responsible": "Dawn Brown",
      "remark": "Molasses purchase 07-04-2023",
      "@self": "https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.co.kjhfarmsupplies",
        "sourceId": "14fe6cfb-652a-4f86-a56b-500e1c1966e2",
        "isDeleted": false,
        "modified": "2023-04-08T11:00:00+00:00",
        "created": "2023-04-08T11:00:00+00:00",
        "creator": "don.wilson@kjhfarmsupplies.co.nz",
        "validFrom": "2023-04-08T11:00:00+00:00",
        "validTo": "2026-04-08T11:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "12345",
        "scheme": "nz.nait.pica-location"
      },
      "dataPointKey": "sample-feed-transaction-f",
      "reason": "Purchased"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/inventory/feed-transactions/{feedTransactionId}

Returns a specific inventory feed transaction by the given feed transaction Id

Request
GET /data/inventory/feed-transactions/{feedTransactionId}
Parameters
Name Type Default Notes
*feedTransactionId

The Id of the requested feed transaction
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarFeedTransactionResource

Success
Mime type: text/plain 
{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}
Mime type: application/json 
{
  "resourceType": "icarFeedTransactionResource",
  "product": {
    "resourceType": "icarFeedReferenceType",
    "category": "Additives",
    "type": {
      "id": "Cattle Supplements",
      "scheme": "nz.co.abcstockfoods.type"
    },
    "identifier": {
      "id": "MOL111",
      "scheme": "nz.co.abcstockfoods"
    },
    "href": "https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html",
    "family": "Animal Feeds",
    "name": "KJH Stockfoods - Mollases",
    "gtin": "012345678966",
    "unspc": "10121500"
  },
  "transactionKind": "Receipt",
  "quantity": 80,
  "units": "LTR",
  "supplierName": "KJH Farm Supplies Ltd",
  "expiryDate": "2023-10-30T00:00:00+00:00",
  "totalCost": 210.5,
  "currency": "NZD",
  "packSize": 20,
  "numberOfPacks": 3,
  "id": "d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4",
  "eventDateTime": "2023-04-07T15:33:00+00:00",
  "responsible": "Dawn Brown",
  "remark": "Molasses purchase 07-04-2023",
  "@self": "https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.co.kjhfarmsupplies",
    "sourceId": "14fe6cfb-652a-4f86-a56b-500e1c1966e2",
    "isDeleted": false,
    "modified": "2023-04-08T11:00:00+00:00",
    "created": "2023-04-08T11:00:00+00:00",
    "creator": "don.wilson@kjhfarmsupplies.co.nz",
    "validFrom": "2023-04-08T11:00:00+00:00",
    "validTo": "2026-04-08T11:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "12345",
    "scheme": "nz.nait.pica-location"
  },
  "dataPointKey": "sample-feed-transaction-f",
  "reason": "Purchased"
}
Mime type: text/json 
{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/inventory/feed-transactions

Gets all of the inventory feed transactions for the specified holding via pagination

Request
GET /data/holdings/{holdingId}/inventory/feed-transactions[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

The Id of the holding
limit

The number of feed transactions per page
offset

the number of feed transactions to skip before the first one returned
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarFeedTransactionResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarFeedTransactionResource",
      "product": {
        "resourceType": "icarFeedReferenceType",
        "category": "Additives",
        "type": {
          "id": "Cattle Supplements",
          "scheme": "nz.co.abcstockfoods.type"
        },
        "identifier": {
          "id": "MOL111",
          "scheme": "nz.co.abcstockfoods"
        },
        "href": "https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html",
        "family": "Animal Feeds",
        "name": "KJH Stockfoods - Mollases",
        "gtin": "012345678966",
        "unspc": "10121500"
      },
      "transactionKind": "Receipt",
      "quantity": 80,
      "units": "LTR",
      "supplierName": "KJH Farm Supplies Ltd",
      "expiryDate": "2023-10-30T00:00:00+00:00",
      "totalCost": 210.5,
      "currency": "NZD",
      "packSize": 20,
      "numberOfPacks": 3,
      "id": "d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4",
      "eventDateTime": "2023-04-07T15:33:00+00:00",
      "responsible": "Dawn Brown",
      "remark": "Molasses purchase 07-04-2023",
      "@self": "https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.co.kjhfarmsupplies",
        "sourceId": "14fe6cfb-652a-4f86-a56b-500e1c1966e2",
        "isDeleted": false,
        "modified": "2023-04-08T11:00:00+00:00",
        "created": "2023-04-08T11:00:00+00:00",
        "creator": "don.wilson@kjhfarmsupplies.co.nz",
        "validFrom": "2023-04-08T11:00:00+00:00",
        "validTo": "2026-04-08T11:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "12345",
        "scheme": "nz.nait.pica-location"
      },
      "dataPointKey": "sample-feed-transaction-f",
      "reason": "Purchased"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/feed-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/inventory/feed-transactions/{feedTransactionId}

Gets the specified feed transaction on the specified holding

Request
GET /data/holdings/{holdingId}/inventory/feed-transactions/{feedTransactionId}
Parameters
Name Type Default Notes
*holdingId

The id of the holding
*feedTransactionId

The id of the feed transaction
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarFeedTransactionResource

Success
Mime type: text/plain 
{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}
Mime type: application/json 
{
  "resourceType": "icarFeedTransactionResource",
  "product": {
    "resourceType": "icarFeedReferenceType",
    "category": "Additives",
    "type": {
      "id": "Cattle Supplements",
      "scheme": "nz.co.abcstockfoods.type"
    },
    "identifier": {
      "id": "MOL111",
      "scheme": "nz.co.abcstockfoods"
    },
    "href": "https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html",
    "family": "Animal Feeds",
    "name": "KJH Stockfoods - Mollases",
    "gtin": "012345678966",
    "unspc": "10121500"
  },
  "transactionKind": "Receipt",
  "quantity": 80,
  "units": "LTR",
  "supplierName": "KJH Farm Supplies Ltd",
  "expiryDate": "2023-10-30T00:00:00+00:00",
  "totalCost": 210.5,
  "currency": "NZD",
  "packSize": 20,
  "numberOfPacks": 3,
  "id": "d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4",
  "eventDateTime": "2023-04-07T15:33:00+00:00",
  "responsible": "Dawn Brown",
  "remark": "Molasses purchase 07-04-2023",
  "@self": "https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.co.kjhfarmsupplies",
    "sourceId": "14fe6cfb-652a-4f86-a56b-500e1c1966e2",
    "isDeleted": false,
    "modified": "2023-04-08T11:00:00+00:00",
    "created": "2023-04-08T11:00:00+00:00",
    "creator": "don.wilson@kjhfarmsupplies.co.nz",
    "validFrom": "2023-04-08T11:00:00+00:00",
    "validTo": "2026-04-08T11:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "12345",
    "scheme": "nz.nait.pica-location"
  },
  "dataPointKey": "sample-feed-transaction-f",
  "reason": "Purchased"
}
Mime type: text/json 
{"resourceType":"icarFeedTransactionResource","product":{"resourceType":"icarFeedReferenceType","category":"Additives","type":{"id":"Cattle Supplements","scheme":"nz.co.abcstockfoods.type"},"identifier":{"id":"MOL111","scheme":"nz.co.abcstockfoods"},"href":"https://www.abcstockfoods.co.nz/store/ABC_Stockfoods-Mollasses.html","family":"Animal Feeds","name":"KJH Stockfoods - Mollases","gtin":"012345678966","unspc":"10121500"},"transactionKind":"Receipt","quantity":80.0,"units":"LTR","supplierName":"KJH Farm Supplies Ltd","expiryDate":"2023-10-30T00:00:00+00:00","totalCost":210.5,"currency":"NZD","packSize":20.0,"numberOfPacks":3.0,"id":"d0f9eed2-22ad-4915-b0dc-3ad0dbc31bc4","eventDateTime":"2023-04-07T15:33:00+00:00","responsible":"Dawn Brown","remark":"Molasses purchase 07-04-2023","@self":"https://api.purefarming.com/data/inventory/feed-transaction/a9fac5f5-9b26-495e-a1ee-aaa84b438e28","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"14fe6cfb-652a-4f86-a56b-500e1c1966e2","isDeleted":false,"modified":"2023-04-08T11:00:00+00:00","created":"2023-04-08T11:00:00+00:00","creator":"don.wilson@kjhfarmsupplies.co.nz","validFrom":"2023-04-08T11:00:00+00:00","validTo":"2026-04-08T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"12345","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-feed-transaction-f","reason":"Purchased"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Inventory :: Fertiliser transactions

GET data/inventory/fertiliser-transactions

Returns all of the fertiliser transactions that a user has access to via pagination

Request
GET /data/inventory/fertiliser-transactions[?limit&offset]
Parameters
Name Type Default Notes
limit

The number of fertiliser transactions per page
offset

the number of fertiliser transaction to skip before the first one returned
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfFertiliserTransaction]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"81d163f8-7164-4795-9087-5941358327a2","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/81d163f8-7164-4795-9087-5941358327a2"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfFertiliserTransaction",
      "product": {
        "resourceType": "productResource",
        "identifiers": [
          {
            "scheme": "nz.co.ckzfert.product",
            "id": "7493"
          }
        ],
        "name": "CKZ Gold Potash Super",
        "type": "Fertiliser",
        "manufacturer": "CKZ Fertiliser Manufacturing Co Ltd",
        "brand": "CKZ Gold Potash Super",
        "form": "Granules",
        "uri": "https://ckzfert.co.nz/products/7493",
        "crop": {
          "name": "Perennial Ryegrass Pasture",
          "taxonomicName": "Lolium perenne L.",
          "variety": "Max365",
          "identifiers": [
            {
              "scheme": "m365",
              "id": "nz.co.zzseeds.pasture"
            }
          ],
          "establishmentDate": "2022-04-17T00:00:00+00:00",
          "maturityDate": "2023-02-10T00:00:00+00:00",
          "harvestDate": "2022-12-17T00:00:00+00:00"
        },
        "specificGravity": 1.86,
        "matterState": "Solid",
        "analysis": [
          {
            "id": {
              "scheme": "nz.co.nztest.tests",
              "id": "J4"
            },
            "name": "P",
            "percent": 18.9
          },
          {
            "id": {
              "scheme": "nz.co.nztest.tests",
              "id": "J3"
            },
            "name": "Ca",
            "percent": 46.2
          }
        ],
        "activeIngredients": [
          {
            "id": {
              "scheme": "8880-23-4",
              "id": "nz.co.ckzfert.ingredients"
            },
            "name": "Superphosphate"
          },
          {
            "id": {
              "scheme": "8841-75-1",
              "id": "nz.co.ckzfert.ingredients"
            },
            "name": "Potassium Chloride"
          }
        ],
        "withdrawals": [
          {
            "scheme": "nz.co.withdrawals",
            "hours": 40
          }
        ],
        "claims": [
          {
            "scheme": "xxxxxx",
            "id": "nz.co.claims"
          }
        ],
        "registrations": [
          {
            "scheme": "xxxxxx",
            "id": "nz.co.registrations"
          }
        ],
        "relationship": "xxxxxx",
        "contentType": "Safety Data Sheet",
        "related": ""
      },
      "transactionKind": "Receipt",
      "quantity": 1.7,
      "units": "TNE",
      "supplierName": "ZaxFert",
      "expiryDate": "2023-03-28T08:00:00+00:00",
      "totalCost": 1235.75,
      "currency": "NZD",
      "packSize": 5,
      "numberOfPacks": 20,
      "observationDate": "2023-03-31T00:00:00+00:00",
      "phenomenonStartTime": "2023-03-31T11:00:00+00:00",
      "phenomenonEndTime": "2023-03-31T13:00:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Oak Reach",
        "uri": "https://farmapp.co.nz/farm/K384",
        "relationship": "xxxxx",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Oak Reach",
        "uri": "https://farmapp.co.nz/farm/K384",
        "relationship": "xxxxx",
        "contentType": "plot"
      },
      "responsible": "Paula West",
      "remark": "Receipt Potash Super purchase Mar 23: Oak Reach",
      "id": "81d163f8-7164-4795-9087-5941358327a2",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.co.gtspreaders.contract",
          "id": "2023-567"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "contentType": "invoice",
          "related": "https://gtspreaders.co.nz/invoice/23-4599"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.zaxfert.fertiliser",
          "id": "0034ac04-fffc-448a-8e6d-ebe285b4ecda"
        },
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "zaxfert.co.nz",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-02-10T09:00:00+00:00"
      },
      "name": "Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023",
      "@self": "https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/81d163f8-7164-4795-9087-5941358327a2"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"81d163f8-7164-4795-9087-5941358327a2","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/81d163f8-7164-4795-9087-5941358327a2"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/inventory/fertiliser-transactions/{fertiliserTransactionId}

Returns a specific fertiliser transaction by the given fertiliser transaction Id

Request
GET /data/inventory/fertiliser-transactions/{fertiliserTransactionId}
Parameters
Name Type Default Notes
*fertiliserTransactionId

The Id of the requested fertiliser transaction
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfFertiliserTransaction

Success
Mime type: text/plain 
{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"2a5cc348-0f4f-4548-8106-28fd43397cda","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/2a5cc348-0f4f-4548-8106-28fd43397cda"}
Mime type: application/json 
{
  "resourceType": "pfFertiliserTransaction",
  "product": {
    "resourceType": "productResource",
    "identifiers": [
      {
        "scheme": "nz.co.ckzfert.product",
        "id": "7493"
      }
    ],
    "name": "CKZ Gold Potash Super",
    "type": "Fertiliser",
    "manufacturer": "CKZ Fertiliser Manufacturing Co Ltd",
    "brand": "CKZ Gold Potash Super",
    "form": "Granules",
    "uri": "https://ckzfert.co.nz/products/7493",
    "crop": {
      "name": "Perennial Ryegrass Pasture",
      "taxonomicName": "Lolium perenne L.",
      "variety": "Max365",
      "identifiers": [
        {
          "scheme": "m365",
          "id": "nz.co.zzseeds.pasture"
        }
      ],
      "establishmentDate": "2022-04-17T00:00:00+00:00",
      "maturityDate": "2023-02-10T00:00:00+00:00",
      "harvestDate": "2022-12-17T00:00:00+00:00"
    },
    "specificGravity": 1.86,
    "matterState": "Solid",
    "analysis": [
      {
        "id": {
          "scheme": "nz.co.nztest.tests",
          "id": "J4"
        },
        "name": "P",
        "percent": 18.9
      },
      {
        "id": {
          "scheme": "nz.co.nztest.tests",
          "id": "J3"
        },
        "name": "Ca",
        "percent": 46.2
      }
    ],
    "activeIngredients": [
      {
        "id": {
          "scheme": "8880-23-4",
          "id": "nz.co.ckzfert.ingredients"
        },
        "name": "Superphosphate"
      },
      {
        "id": {
          "scheme": "8841-75-1",
          "id": "nz.co.ckzfert.ingredients"
        },
        "name": "Potassium Chloride"
      }
    ],
    "withdrawals": [
      {
        "scheme": "nz.co.withdrawals",
        "hours": 40
      }
    ],
    "claims": [
      {
        "scheme": "xxxxxx",
        "id": "nz.co.claims"
      }
    ],
    "registrations": [
      {
        "scheme": "xxxxxx",
        "id": "nz.co.registrations"
      }
    ],
    "relationship": "xxxxxx",
    "contentType": "Safety Data Sheet",
    "related": ""
  },
  "transactionKind": "Receipt",
  "quantity": 1.7,
  "units": "TNE",
  "supplierName": "ZaxFert",
  "expiryDate": "2023-03-28T08:00:00+00:00",
  "totalCost": 1235.75,
  "currency": "NZD",
  "packSize": 5,
  "numberOfPacks": 20,
  "observationDate": "2023-03-31T00:00:00+00:00",
  "phenomenonStartTime": "2023-03-31T11:00:00+00:00",
  "phenomenonEndTime": "2023-03-31T13:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Oak Reach",
    "uri": "https://farmapp.co.nz/farm/K384",
    "relationship": "xxxxx",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Oak Reach",
    "uri": "https://farmapp.co.nz/farm/K384",
    "relationship": "xxxxx",
    "contentType": "plot"
  },
  "responsible": "Paula West",
  "remark": "Receipt Potash Super purchase Mar 23: Oak Reach",
  "id": "2a5cc348-0f4f-4548-8106-28fd43397cda",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.co.gtspreaders.contract",
      "id": "2023-567"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "contentType": "invoice",
      "related": "https://gtspreaders.co.nz/invoice/23-4599"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfert.fertiliser",
      "id": "0034ac04-fffc-448a-8e6d-ebe285b4ecda"
    },
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "zaxfert.co.nz",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-02-10T09:00:00+00:00"
  },
  "name": "Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023",
  "@self": "https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/2a5cc348-0f4f-4548-8106-28fd43397cda"
}
Mime type: text/json 
{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"2a5cc348-0f4f-4548-8106-28fd43397cda","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/2a5cc348-0f4f-4548-8106-28fd43397cda"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/inventory/fertiliser-transactions

Gets all of the fertiliser transaction for the specified holding via pagination

Request
GET /data/holdings/{holdingId}/inventory/fertiliser-transactions[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

The Id of the holding
limit

The number of fertiliser transactions per page
offset

the number of fertiliser transactions to skip before the first one returned
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfFertiliserTransaction]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"dd087da3-9226-4a59-8fd6-9b0de5b5665e","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/dd087da3-9226-4a59-8fd6-9b0de5b5665e"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfFertiliserTransaction",
      "product": {
        "resourceType": "productResource",
        "identifiers": [
          {
            "scheme": "nz.co.ckzfert.product",
            "id": "7493"
          }
        ],
        "name": "CKZ Gold Potash Super",
        "type": "Fertiliser",
        "manufacturer": "CKZ Fertiliser Manufacturing Co Ltd",
        "brand": "CKZ Gold Potash Super",
        "form": "Granules",
        "uri": "https://ckzfert.co.nz/products/7493",
        "crop": {
          "name": "Perennial Ryegrass Pasture",
          "taxonomicName": "Lolium perenne L.",
          "variety": "Max365",
          "identifiers": [
            {
              "scheme": "m365",
              "id": "nz.co.zzseeds.pasture"
            }
          ],
          "establishmentDate": "2022-04-17T00:00:00+00:00",
          "maturityDate": "2023-02-10T00:00:00+00:00",
          "harvestDate": "2022-12-17T00:00:00+00:00"
        },
        "specificGravity": 1.86,
        "matterState": "Solid",
        "analysis": [
          {
            "id": {
              "scheme": "nz.co.nztest.tests",
              "id": "J4"
            },
            "name": "P",
            "percent": 18.9
          },
          {
            "id": {
              "scheme": "nz.co.nztest.tests",
              "id": "J3"
            },
            "name": "Ca",
            "percent": 46.2
          }
        ],
        "activeIngredients": [
          {
            "id": {
              "scheme": "8880-23-4",
              "id": "nz.co.ckzfert.ingredients"
            },
            "name": "Superphosphate"
          },
          {
            "id": {
              "scheme": "8841-75-1",
              "id": "nz.co.ckzfert.ingredients"
            },
            "name": "Potassium Chloride"
          }
        ],
        "withdrawals": [
          {
            "scheme": "nz.co.withdrawals",
            "hours": 40
          }
        ],
        "claims": [
          {
            "scheme": "xxxxxx",
            "id": "nz.co.claims"
          }
        ],
        "registrations": [
          {
            "scheme": "xxxxxx",
            "id": "nz.co.registrations"
          }
        ],
        "relationship": "xxxxxx",
        "contentType": "Safety Data Sheet",
        "related": ""
      },
      "transactionKind": "Receipt",
      "quantity": 1.7,
      "units": "TNE",
      "supplierName": "ZaxFert",
      "expiryDate": "2023-03-28T08:00:00+00:00",
      "totalCost": 1235.75,
      "currency": "NZD",
      "packSize": 5,
      "numberOfPacks": 20,
      "observationDate": "2023-03-31T00:00:00+00:00",
      "phenomenonStartTime": "2023-03-31T11:00:00+00:00",
      "phenomenonEndTime": "2023-03-31T13:00:00+00:00",
      "holding": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Oak Reach",
        "uri": "https://farmapp.co.nz/farm/K384",
        "relationship": "xxxxx",
        "contentType": "holding"
      },
      "feature": {
        "identifier": {
          "resourceType": "identifierType",
          "scheme": "com.purefarming.holding.identifier",
          "id": "77345.pdk54"
        },
        "name": "Oak Reach",
        "uri": "https://farmapp.co.nz/farm/K384",
        "relationship": "xxxxx",
        "contentType": "plot"
      },
      "responsible": "Paula West",
      "remark": "Receipt Potash Super purchase Mar 23: Oak Reach",
      "id": "dd087da3-9226-4a59-8fd6-9b0de5b5665e",
      "identifiers": [
        {
          "resourceType": "identifierType",
          "scheme": "nz.co.gtspreaders.contract",
          "id": "2023-567"
        }
      ],
      "links": [
        {
          "resourceType": "relationType",
          "contentType": "invoice",
          "related": "https://gtspreaders.co.nz/invoice/23-4599"
        }
      ],
      "meta": {
        "resourceType": "metaDataType",
        "sourceId": {
          "scheme": "nz.zaxfert.fertiliser",
          "id": "0034ac04-fffc-448a-8e6d-ebe285b4ecda"
        },
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "zaxfert.co.nz",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-02-10T09:00:00+00:00"
      },
      "name": "Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023",
      "@self": "https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/dd087da3-9226-4a59-8fd6-9b0de5b5665e"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"dd087da3-9226-4a59-8fd6-9b0de5b5665e","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/dd087da3-9226-4a59-8fd6-9b0de5b5665e"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/inventory/fertiliser-transactions/{fertiliserTransactionId}

Gets the specified fertiliser transaction for the specified holding

Request
GET /data/holdings/{holdingId}/inventory/fertiliser-transactions/{fertiliserTransactionId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding
*fertiliserTransactionId

the Id of the fertiliser transaction
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfFertiliserTransaction

Success
Mime type: text/plain 
{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"044121aa-bf2a-485d-89ec-cb0cb1bf2bf1","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/044121aa-bf2a-485d-89ec-cb0cb1bf2bf1"}
Mime type: application/json 
{
  "resourceType": "pfFertiliserTransaction",
  "product": {
    "resourceType": "productResource",
    "identifiers": [
      {
        "scheme": "nz.co.ckzfert.product",
        "id": "7493"
      }
    ],
    "name": "CKZ Gold Potash Super",
    "type": "Fertiliser",
    "manufacturer": "CKZ Fertiliser Manufacturing Co Ltd",
    "brand": "CKZ Gold Potash Super",
    "form": "Granules",
    "uri": "https://ckzfert.co.nz/products/7493",
    "crop": {
      "name": "Perennial Ryegrass Pasture",
      "taxonomicName": "Lolium perenne L.",
      "variety": "Max365",
      "identifiers": [
        {
          "scheme": "m365",
          "id": "nz.co.zzseeds.pasture"
        }
      ],
      "establishmentDate": "2022-04-17T00:00:00+00:00",
      "maturityDate": "2023-02-10T00:00:00+00:00",
      "harvestDate": "2022-12-17T00:00:00+00:00"
    },
    "specificGravity": 1.86,
    "matterState": "Solid",
    "analysis": [
      {
        "id": {
          "scheme": "nz.co.nztest.tests",
          "id": "J4"
        },
        "name": "P",
        "percent": 18.9
      },
      {
        "id": {
          "scheme": "nz.co.nztest.tests",
          "id": "J3"
        },
        "name": "Ca",
        "percent": 46.2
      }
    ],
    "activeIngredients": [
      {
        "id": {
          "scheme": "8880-23-4",
          "id": "nz.co.ckzfert.ingredients"
        },
        "name": "Superphosphate"
      },
      {
        "id": {
          "scheme": "8841-75-1",
          "id": "nz.co.ckzfert.ingredients"
        },
        "name": "Potassium Chloride"
      }
    ],
    "withdrawals": [
      {
        "scheme": "nz.co.withdrawals",
        "hours": 40
      }
    ],
    "claims": [
      {
        "scheme": "xxxxxx",
        "id": "nz.co.claims"
      }
    ],
    "registrations": [
      {
        "scheme": "xxxxxx",
        "id": "nz.co.registrations"
      }
    ],
    "relationship": "xxxxxx",
    "contentType": "Safety Data Sheet",
    "related": ""
  },
  "transactionKind": "Receipt",
  "quantity": 1.7,
  "units": "TNE",
  "supplierName": "ZaxFert",
  "expiryDate": "2023-03-28T08:00:00+00:00",
  "totalCost": 1235.75,
  "currency": "NZD",
  "packSize": 5,
  "numberOfPacks": 20,
  "observationDate": "2023-03-31T00:00:00+00:00",
  "phenomenonStartTime": "2023-03-31T11:00:00+00:00",
  "phenomenonEndTime": "2023-03-31T13:00:00+00:00",
  "holding": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Oak Reach",
    "uri": "https://farmapp.co.nz/farm/K384",
    "relationship": "xxxxx",
    "contentType": "holding"
  },
  "feature": {
    "identifier": {
      "resourceType": "identifierType",
      "scheme": "com.purefarming.holding.identifier",
      "id": "77345.pdk54"
    },
    "name": "Oak Reach",
    "uri": "https://farmapp.co.nz/farm/K384",
    "relationship": "xxxxx",
    "contentType": "plot"
  },
  "responsible": "Paula West",
  "remark": "Receipt Potash Super purchase Mar 23: Oak Reach",
  "id": "044121aa-bf2a-485d-89ec-cb0cb1bf2bf1",
  "identifiers": [
    {
      "resourceType": "identifierType",
      "scheme": "nz.co.gtspreaders.contract",
      "id": "2023-567"
    }
  ],
  "links": [
    {
      "resourceType": "relationType",
      "contentType": "invoice",
      "related": "https://gtspreaders.co.nz/invoice/23-4599"
    }
  ],
  "meta": {
    "resourceType": "metaDataType",
    "sourceId": {
      "scheme": "nz.zaxfert.fertiliser",
      "id": "0034ac04-fffc-448a-8e6d-ebe285b4ecda"
    },
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "zaxfert.co.nz",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-02-10T09:00:00+00:00"
  },
  "name": "Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023",
  "@self": "https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/044121aa-bf2a-485d-89ec-cb0cb1bf2bf1"
}
Mime type: text/json 
{"resourceType":"pfFertiliserTransaction","product":{"resourceType":"productResource","identifiers":[{"scheme":"nz.co.ckzfert.product","id":"7493"}],"name":"CKZ Gold Potash Super","type":"Fertiliser","manufacturer":"CKZ Fertiliser Manufacturing Co Ltd","brand":"CKZ Gold Potash Super","form":"Granules","uri":"https://ckzfert.co.nz/products/7493","crop":{"name":"Perennial Ryegrass Pasture","taxonomicName":"Lolium perenne L.","variety":"Max365","identifiers":[{"scheme":"m365","id":"nz.co.zzseeds.pasture"}],"establishmentDate":"2022-04-17T00:00:00+00:00","maturityDate":"2023-02-10T00:00:00+00:00","harvestDate":"2022-12-17T00:00:00+00:00"},"specificGravity":1.86,"matterState":"Solid","analysis":[{"id":{"scheme":"nz.co.nztest.tests","id":"J4"},"name":"P","percent":18.9},{"id":{"scheme":"nz.co.nztest.tests","id":"J3"},"name":"Ca","percent":46.2}],"activeIngredients":[{"id":{"scheme":"8880-23-4","id":"nz.co.ckzfert.ingredients"},"name":"Superphosphate"},{"id":{"scheme":"8841-75-1","id":"nz.co.ckzfert.ingredients"},"name":"Potassium Chloride"}],"withdrawals":[{"scheme":"nz.co.withdrawals","hours":40.0}],"claims":[{"scheme":"xxxxxx","id":"nz.co.claims"}],"registrations":[{"scheme":"xxxxxx","id":"nz.co.registrations"}],"relationship":"xxxxxx","contentType":"Safety Data Sheet","related":""},"transactionKind":"Receipt","quantity":1.7,"units":"TNE","supplierName":"ZaxFert","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1235.75,"currency":"NZD","packSize":5.0,"numberOfPacks":20.0,"observationDate":"2023-03-31T00:00:00+00:00","phenomenonStartTime":"2023-03-31T11:00:00+00:00","phenomenonEndTime":"2023-03-31T13:00:00+00:00","holding":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"holding"},"feature":{"identifier":{"resourceType":"identifierType","scheme":"com.purefarming.holding.identifier","id":"77345.pdk54"},"name":"Oak Reach","uri":"https://farmapp.co.nz/farm/K384","relationship":"xxxxx","contentType":"plot"},"responsible":"Paula West","remark":"Receipt Potash Super purchase Mar 23: Oak Reach","id":"044121aa-bf2a-485d-89ec-cb0cb1bf2bf1","identifiers":[{"resourceType":"identifierType","scheme":"nz.co.gtspreaders.contract","id":"2023-567"}],"links":[{"resourceType":"relationType","contentType":"invoice","related":"https://gtspreaders.co.nz/invoice/23-4599"}],"meta":{"resourceType":"metaDataType","sourceId":{"scheme":"nz.zaxfert.fertiliser","id":"0034ac04-fffc-448a-8e6d-ebe285b4ecda"},"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"zaxfert.co.nz","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"name":"Potash Super spreading - Hill Paddock, Oak Reach, Mar 2023","@self":"https://api.dev.purefarming.com/data/inventory/fertiliser-transactions/044121aa-bf2a-485d-89ec-cb0cb1bf2bf1"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Inventory :: Medicine transactions

GET data/inventory/medicine-transactions

Gets all of the inventory medicine transactions that a user has access to via pagination

Request
GET /data/inventory/medicine-transactions[?limit&offset]
Parameters
Name Type Default Notes
limit

The number of inventory medicine transactions per page
offset

the number of inventory medicine transaction to skip before the first one returned
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMedicineTransactionResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMedicineTransactionResource",
      "product": {
        "resourceType": "icarMedicineReferenceType",
        "name": "Golden Mastitis Suspension 20x 10ml",
        "approved": "Approved",
        "registeredIdentifier": {
          "id": "49851",
          "scheme": "au.gov.apvma"
        },
        "identifier": {
          "id": "mast-00010",
          "scheme": "au.com.goldenagsolutions"
        },
        "href": "https://www.goldenagsolutions/products/49851",
        "family": "Veterinary Supplies",
        "gtin": "012345678988",
        "unspc": "70122002  Animal disease control"
      },
      "transactionKind": "Use",
      "quantity": 50,
      "units": "MLT",
      "supplierName": "DEF Vet Services Ltd",
      "expiryDate": "2023-12-28T08:00:00+00:00",
      "totalCost": 186.9,
      "currency": "AUD",
      "packSize": 200,
      "numberOfPacks": 0.25,
      "id": "376f65c8-0fb3-484c-9005-ce978d94487d",
      "eventDateTime": "2023-02-28T11:00:00+00:00",
      "responsible": "Gemma Smith",
      "remark": "Mastitis treated 28 February 2023",
      "@self": "https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "au.com.defvetservices",
        "sourceId": "9fbbf0f1-d386-4a99-a437-d2b954a18008",
        "isDeleted": false,
        "modified": "2023-03-10T09:00:00+00:00",
        "created": "2023-03-10T09:00:00+00:00",
        "creator": "don.wilson@defvetservices.com.au",
        "validFrom": "2023-03-10T09:00:00+00:00",
        "validTo": "2024-02-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD666",
        "scheme": "au.nlis.pic"
      },
      "dataPointKey": "sample-medicine-transaction-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/inventory/medicine-transactions

Gets the inventory medicine transactions for a holding via pagination

Request
GET /data/holdings/{holdingId}/inventory/medicine-transactions[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the inventory medicine transactions for
limit

the maximum number of inventory medicine transactions on a page
offset

the number of inventory medicine transactions in the total set before the first one on the page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMedicineTransactionResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMedicineTransactionResource",
      "product": {
        "resourceType": "icarMedicineReferenceType",
        "name": "Golden Mastitis Suspension 20x 10ml",
        "approved": "Approved",
        "registeredIdentifier": {
          "id": "49851",
          "scheme": "au.gov.apvma"
        },
        "identifier": {
          "id": "mast-00010",
          "scheme": "au.com.goldenagsolutions"
        },
        "href": "https://www.goldenagsolutions/products/49851",
        "family": "Veterinary Supplies",
        "gtin": "012345678988",
        "unspc": "70122002  Animal disease control"
      },
      "transactionKind": "Use",
      "quantity": 50,
      "units": "MLT",
      "supplierName": "DEF Vet Services Ltd",
      "expiryDate": "2023-12-28T08:00:00+00:00",
      "totalCost": 186.9,
      "currency": "AUD",
      "packSize": 200,
      "numberOfPacks": 0.25,
      "id": "376f65c8-0fb3-484c-9005-ce978d94487d",
      "eventDateTime": "2023-02-28T11:00:00+00:00",
      "responsible": "Gemma Smith",
      "remark": "Mastitis treated 28 February 2023",
      "@self": "https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "au.com.defvetservices",
        "sourceId": "9fbbf0f1-d386-4a99-a437-d2b954a18008",
        "isDeleted": false,
        "modified": "2023-03-10T09:00:00+00:00",
        "created": "2023-03-10T09:00:00+00:00",
        "creator": "don.wilson@defvetservices.com.au",
        "validFrom": "2023-03-10T09:00:00+00:00",
        "validTo": "2024-02-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD666",
        "scheme": "au.nlis.pic"
      },
      "dataPointKey": "sample-medicine-transaction-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/medicine-transactions?offset=0&limit=1"},"items":[{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}]}

GET data/inventory/medicine-transactions/{medicineId}

Gets a single inventory medicine transaction by id

Request
GET /data/inventory/medicine-transactions/{medicineId}
Parameters
Name Type Default Notes
*medicineId

The Id of the inventory medicine transaction to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMedicineTransactionResource

Success
Mime type: text/plain 
{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}
Mime type: application/json 
{
  "resourceType": "icarMedicineTransactionResource",
  "product": {
    "resourceType": "icarMedicineReferenceType",
    "name": "Golden Mastitis Suspension 20x 10ml",
    "approved": "Approved",
    "registeredIdentifier": {
      "id": "49851",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "mast-00010",
      "scheme": "au.com.goldenagsolutions"
    },
    "href": "https://www.goldenagsolutions/products/49851",
    "family": "Veterinary Supplies",
    "gtin": "012345678988",
    "unspc": "70122002  Animal disease control"
  },
  "transactionKind": "Use",
  "quantity": 50,
  "units": "MLT",
  "supplierName": "DEF Vet Services Ltd",
  "expiryDate": "2023-12-28T08:00:00+00:00",
  "totalCost": 186.9,
  "currency": "AUD",
  "packSize": 200,
  "numberOfPacks": 0.25,
  "id": "376f65c8-0fb3-484c-9005-ce978d94487d",
  "eventDateTime": "2023-02-28T11:00:00+00:00",
  "responsible": "Gemma Smith",
  "remark": "Mastitis treated 28 February 2023",
  "@self": "https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "au.com.defvetservices",
    "sourceId": "9fbbf0f1-d386-4a99-a437-d2b954a18008",
    "isDeleted": false,
    "modified": "2023-03-10T09:00:00+00:00",
    "created": "2023-03-10T09:00:00+00:00",
    "creator": "don.wilson@defvetservices.com.au",
    "validFrom": "2023-03-10T09:00:00+00:00",
    "validTo": "2024-02-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD666",
    "scheme": "au.nlis.pic"
  },
  "dataPointKey": "sample-medicine-transaction-f"
}
Mime type: text/json 
{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/inventory/medicine-transactions/{medicineId}

Gets a single inventory medicine transaction with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/inventory/medicine-transactions/{medicineId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the inventory medicine transaction for
*medicineId

The Id of the inventory medicine transaction to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMedicineTransactionResource

Success
Mime type: text/plain 
{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}
Mime type: application/json 
{
  "resourceType": "icarMedicineTransactionResource",
  "product": {
    "resourceType": "icarMedicineReferenceType",
    "name": "Golden Mastitis Suspension 20x 10ml",
    "approved": "Approved",
    "registeredIdentifier": {
      "id": "49851",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "mast-00010",
      "scheme": "au.com.goldenagsolutions"
    },
    "href": "https://www.goldenagsolutions/products/49851",
    "family": "Veterinary Supplies",
    "gtin": "012345678988",
    "unspc": "70122002  Animal disease control"
  },
  "transactionKind": "Use",
  "quantity": 50,
  "units": "MLT",
  "supplierName": "DEF Vet Services Ltd",
  "expiryDate": "2023-12-28T08:00:00+00:00",
  "totalCost": 186.9,
  "currency": "AUD",
  "packSize": 200,
  "numberOfPacks": 0.25,
  "id": "376f65c8-0fb3-484c-9005-ce978d94487d",
  "eventDateTime": "2023-02-28T11:00:00+00:00",
  "responsible": "Gemma Smith",
  "remark": "Mastitis treated 28 February 2023",
  "@self": "https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "au.com.defvetservices",
    "sourceId": "9fbbf0f1-d386-4a99-a437-d2b954a18008",
    "isDeleted": false,
    "modified": "2023-03-10T09:00:00+00:00",
    "created": "2023-03-10T09:00:00+00:00",
    "creator": "don.wilson@defvetservices.com.au",
    "validFrom": "2023-03-10T09:00:00+00:00",
    "validTo": "2024-02-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD666",
    "scheme": "au.nlis.pic"
  },
  "dataPointKey": "sample-medicine-transaction-f"
}
Mime type: text/json 
{"resourceType":"icarMedicineTransactionResource","product":{"resourceType":"icarMedicineReferenceType","name":"Golden Mastitis Suspension 20x 10ml","approved":"Approved","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"mast-00010","scheme":"au.com.goldenagsolutions"},"href":"https://www.goldenagsolutions/products/49851","family":"Veterinary Supplies","gtin":"012345678988","unspc":"70122002  Animal disease control"},"transactionKind":"Use","quantity":50.0,"units":"MLT","supplierName":"DEF Vet Services Ltd","expiryDate":"2023-12-28T08:00:00+00:00","totalCost":186.9,"currency":"AUD","packSize":200.0,"numberOfPacks":0.25,"id":"376f65c8-0fb3-484c-9005-ce978d94487d","eventDateTime":"2023-02-28T11:00:00+00:00","responsible":"Gemma Smith","remark":"Mastitis treated 28 February 2023","@self":"https://api.dev.purefarming.com/data/inventory/medicine-transactions/376f65c8-0fb3-484c-9005-ce978d94487d","meta":{"resourceType":"icarMetaDataType","source":"au.com.defvetservices","sourceId":"9fbbf0f1-d386-4a99-a437-d2b954a18008","isDeleted":false,"modified":"2023-03-10T09:00:00+00:00","created":"2023-03-10T09:00:00+00:00","creator":"don.wilson@defvetservices.com.au","validFrom":"2023-03-10T09:00:00+00:00","validTo":"2024-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"au.nlis.pic"},"dataPointKey":"sample-medicine-transaction-f"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Inventory :: Transactions

GET data/inventory/transactions

Returns all of the inventory transactions that a user has access to via pagination

Request
GET /data/inventory/transactions[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
limit

The number of inventory transactions per page
offset

the number of inventory transaction to skip before the first one returned
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarInventoryTransactionResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"c36db94e-0c46-4bbc-9da9-12123ee56b2b","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/c36db94e-0c46-4bbc-9da9-12123ee56b2b","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarInventoryTransactionResource",
      "product": {
        "resourceType": "icarProductReferenceType",
        "identifiers": [
          {
            "id": "BH467",
            "scheme": "uk.sprinrise.productcode"
          }
        ],
        "family": "Animal Reproductive Products",
        "name": "Semen - Destiny Chancellor",
        "gtin": "012345678905",
        "unspc": "11131609",
        "identifier": {
          "id": "KY123412341234",
          "scheme": "uk.co.genus"
        },
        "href": "https://www.genus.co.uk/products/artificial-breeding/bull/54321"
      },
      "transactionKind": "Receipt",
      "quantity": 100,
      "units": "straws",
      "supplierName": "BlackHawk",
      "expiryDate": "2023-03-28T08:00:00+00:00",
      "totalCost": 1324,
      "currency": "GBP",
      "packSize": 5,
      "numberOfPacks": 20,
      "id": "c36db94e-0c46-4bbc-9da9-12123ee56b2b",
      "eventDateTime": "2023-01-28T08:00:00+00:00",
      "responsible": "Matt Henry",
      "remark": "Semen from Destiny Chancellor",
      "@self": "https://api.dev.purefarming.com/data/inventory/transactions/c36db94e-0c46-4bbc-9da9-12123ee56b2b",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.springrise.semen",
        "sourceId": "19a3b5fe-1690-45f8-a819-1471c1a121a3",
        "isDeleted": false,
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@springrise.co.uk",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-02-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABZF222",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"c36db94e-0c46-4bbc-9da9-12123ee56b2b","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/c36db94e-0c46-4bbc-9da9-12123ee56b2b","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/inventory/transactions/{transactionId}

Returns a specific inventory transaction by the given transaction Id

Request
GET /data/inventory/transactions/{transactionId}
Parameters
Name Type Default Notes
*transactionId

The Id of the requested transaction
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarInventoryTransactionResource

Success
Mime type: text/plain 
{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"dad586ea-a6e1-4451-8231-755b4a027041","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/dad586ea-a6e1-4451-8231-755b4a027041","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarInventoryTransactionResource",
  "product": {
    "resourceType": "icarProductReferenceType",
    "identifiers": [
      {
        "id": "BH467",
        "scheme": "uk.sprinrise.productcode"
      }
    ],
    "family": "Animal Reproductive Products",
    "name": "Semen - Destiny Chancellor",
    "gtin": "012345678905",
    "unspc": "11131609",
    "identifier": {
      "id": "KY123412341234",
      "scheme": "uk.co.genus"
    },
    "href": "https://www.genus.co.uk/products/artificial-breeding/bull/54321"
  },
  "transactionKind": "Receipt",
  "quantity": 100,
  "units": "straws",
  "supplierName": "BlackHawk",
  "expiryDate": "2023-03-28T08:00:00+00:00",
  "totalCost": 1324,
  "currency": "GBP",
  "packSize": 5,
  "numberOfPacks": 20,
  "id": "dad586ea-a6e1-4451-8231-755b4a027041",
  "eventDateTime": "2023-01-28T08:00:00+00:00",
  "responsible": "Matt Henry",
  "remark": "Semen from Destiny Chancellor",
  "@self": "https://api.dev.purefarming.com/data/inventory/transactions/dad586ea-a6e1-4451-8231-755b4a027041",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.springrise.semen",
    "sourceId": "19a3b5fe-1690-45f8-a819-1471c1a121a3",
    "isDeleted": false,
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@springrise.co.uk",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-02-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABZF222",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"dad586ea-a6e1-4451-8231-755b4a027041","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/dad586ea-a6e1-4451-8231-755b4a027041","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/inventory/transactions

Gets all of the inventory transaction for the specified holding via pagination

Request
GET /data/holdings/{holdingId}/inventory/transactions[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
*holdingId

The Id of the holding
limit

The number of transactions per page
offset

the number of transactions to skip before the first one returned
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarInventoryTransactionResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"5077bf9e-21d9-4c54-808b-4626d8c8cffa","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/5077bf9e-21d9-4c54-808b-4626d8c8cffa","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarInventoryTransactionResource",
      "product": {
        "resourceType": "icarProductReferenceType",
        "identifiers": [
          {
            "id": "BH467",
            "scheme": "uk.sprinrise.productcode"
          }
        ],
        "family": "Animal Reproductive Products",
        "name": "Semen - Destiny Chancellor",
        "gtin": "012345678905",
        "unspc": "11131609",
        "identifier": {
          "id": "KY123412341234",
          "scheme": "uk.co.genus"
        },
        "href": "https://www.genus.co.uk/products/artificial-breeding/bull/54321"
      },
      "transactionKind": "Receipt",
      "quantity": 100,
      "units": "straws",
      "supplierName": "BlackHawk",
      "expiryDate": "2023-03-28T08:00:00+00:00",
      "totalCost": 1324,
      "currency": "GBP",
      "packSize": 5,
      "numberOfPacks": 20,
      "id": "5077bf9e-21d9-4c54-808b-4626d8c8cffa",
      "eventDateTime": "2023-01-28T08:00:00+00:00",
      "responsible": "Matt Henry",
      "remark": "Semen from Destiny Chancellor",
      "@self": "https://api.dev.purefarming.com/data/inventory/transactions/5077bf9e-21d9-4c54-808b-4626d8c8cffa",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.springrise.semen",
        "sourceId": "19a3b5fe-1690-45f8-a819-1471c1a121a3",
        "isDeleted": false,
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@springrise.co.uk",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-02-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABZF222",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/inventory/transactions?offset=0&limit=1"},"items":[{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"5077bf9e-21d9-4c54-808b-4626d8c8cffa","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/5077bf9e-21d9-4c54-808b-4626d8c8cffa","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/inventory/transactions/{transactionId}

Gets the specified transaction on the specified holding

Request
GET /data/holdings/{holdingId}/inventory/transactions/{transactionId}
Parameters
Name Type Default Notes
*holdingId

the id of the holding
*transactionId

the id of the transaction
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarInventoryTransactionResource

Success
Mime type: text/plain 
{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"e92a2e20-6884-444f-bab9-3ad067638ac3","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/e92a2e20-6884-444f-bab9-3ad067638ac3","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarInventoryTransactionResource",
  "product": {
    "resourceType": "icarProductReferenceType",
    "identifiers": [
      {
        "id": "BH467",
        "scheme": "uk.sprinrise.productcode"
      }
    ],
    "family": "Animal Reproductive Products",
    "name": "Semen - Destiny Chancellor",
    "gtin": "012345678905",
    "unspc": "11131609",
    "identifier": {
      "id": "KY123412341234",
      "scheme": "uk.co.genus"
    },
    "href": "https://www.genus.co.uk/products/artificial-breeding/bull/54321"
  },
  "transactionKind": "Receipt",
  "quantity": 100,
  "units": "straws",
  "supplierName": "BlackHawk",
  "expiryDate": "2023-03-28T08:00:00+00:00",
  "totalCost": 1324,
  "currency": "GBP",
  "packSize": 5,
  "numberOfPacks": 20,
  "id": "e92a2e20-6884-444f-bab9-3ad067638ac3",
  "eventDateTime": "2023-01-28T08:00:00+00:00",
  "responsible": "Matt Henry",
  "remark": "Semen from Destiny Chancellor",
  "@self": "https://api.dev.purefarming.com/data/inventory/transactions/e92a2e20-6884-444f-bab9-3ad067638ac3",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.springrise.semen",
    "sourceId": "19a3b5fe-1690-45f8-a819-1471c1a121a3",
    "isDeleted": false,
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@springrise.co.uk",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-02-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABZF222",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarInventoryTransactionResource","product":{"resourceType":"icarProductReferenceType","identifiers":[{"id":"BH467","scheme":"uk.sprinrise.productcode"}],"family":"Animal Reproductive Products","name":"Semen - Destiny Chancellor","gtin":"012345678905","unspc":"11131609","identifier":{"id":"KY123412341234","scheme":"uk.co.genus"},"href":"https://www.genus.co.uk/products/artificial-breeding/bull/54321"},"transactionKind":"Receipt","quantity":100.0,"units":"straws","supplierName":"BlackHawk","expiryDate":"2023-03-28T08:00:00+00:00","totalCost":1324.0,"currency":"GBP","packSize":5.0,"numberOfPacks":20.0,"id":"e92a2e20-6884-444f-bab9-3ad067638ac3","eventDateTime":"2023-01-28T08:00:00+00:00","responsible":"Matt Henry","remark":"Semen from Destiny Chancellor","@self":"https://api.dev.purefarming.com/data/inventory/transactions/e92a2e20-6884-444f-bab9-3ad067638ac3","meta":{"resourceType":"icarMetaDataType","source":"uk.springrise.semen","sourceId":"19a3b5fe-1690-45f8-a819-1471c1a121a3","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@springrise.co.uk","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Land covers

GET data/land-covers

Gets all land-cover entries that you have access to.

Request
GET /data/land-covers
Parameters
Name Type Default Notes
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfLandCoverResource[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/land-covers

Gets all land-cover entries for a given holding

Request
GET /data/holdings/{holdingId}/land-covers
Parameters
Name Type Default Notes
*holdingId

The PureFarming ID of the Holding you want to get land-covers for
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfLandCoverResource[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{HoldingId}/land-covers/{Id}

Gets the specified land cover that is linked to the provided holding id.

Request
GET /data/holdings/{HoldingId}/land-covers/{Id}
Parameters
Name Type Default Notes
*HoldingId

The identifier of the holding this LandCover is linked to.
*Id

The identifier of the LandCover.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfLandCoverResource

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/land-covers/{Id}

Gets the specified land cover.

Request
GET /data/land-covers/{Id}
Parameters
Name Type Default Notes
*Id

The identifier of the LandCover.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfLandCoverResource

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animal assessment events

GET data/holdings/{HoldingId}/livestock/animal-assessment-events

Get all animal assessment events associated with the given holding.

Request
GET /data/holdings/{HoldingId}/livestock/animal-assessment-events[?limit&offset&animalIdentifier&animalIdentifierScheme&metricScheme&metricId&includeDeleted]
Parameters
Name Type Default Notes
*HoldingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
metricScheme

The metric scheme to search for
metricId

The metric id to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfAnimalAssessmentEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1"},"items":[{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"c1172efd-2866-4744-8d50-ef6c068b2c97","eventDateTime":"2024-02-26T03:19:33.0941329+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/c1172efd-2866-4744-8d50-ef6c068b2c97","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"cde09795-09cd-4bb8-b847-7723fa7c01fe","modified":"2024-02-26T03:19:33.094134+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfAnimalAssessmentEvent",
      "metric": {
        "resourceType": "icarIdentifierType",
        "id": "uk.roms.mobility",
        "scheme": "mobilityScore"
      },
      "score": 2,
      "assessment": "Eartag Issue",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "UK104484200768",
        "scheme": "uk.cts.eartag"
      },
      "id": "c1172efd-2866-4744-8d50-ef6c068b2c97",
      "eventDateTime": "2024-02-26T03:19:33.0941329+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "id.of.trait.label",
        "scheme": "aute aliquip esse quis"
      },
      "responsible": "Davy Samuels",
      "contemporaryGroup": "anim proident ad dolore ipsum",
      "remark": "Ron Ardern",
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events/c1172efd-2866-4744-8d50-ef6c068b2c97",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "cde09795-09cd-4bb8-b847-7723fa7c01fe",
        "modified": "2024-02-26T03:19:33.094134+00:00",
        "created": "2023-03-17T13:45:20+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "210",
        "scheme": "net.farmmetrics.farm_id"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1"},"items":[{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"c1172efd-2866-4744-8d50-ef6c068b2c97","eventDateTime":"2024-02-26T03:19:33.0941329+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/c1172efd-2866-4744-8d50-ef6c068b2c97","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"cde09795-09cd-4bb8-b847-7723fa7c01fe","modified":"2024-02-26T03:19:33.094134+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}]}

GET data/livestock/animal-assessment-events

Gets all animal assessment events you have access to.

Request
GET /data/livestock/animal-assessment-events[?limit&offset&animalIdentifier&animalIdentifierScheme&metricScheme&metricId&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
metricScheme

The metric scheme to search for
metricId

The metric id to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfAnimalAssessmentEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1"},"items":[{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"b2a8d4a7-6402-45a5-899e-20dfecbc9155","eventDateTime":"2024-02-26T03:19:33.0965397+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/b2a8d4a7-6402-45a5-899e-20dfecbc9155","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"c09b677e-bd4d-4caa-84ce-176a53b23337","modified":"2024-02-26T03:19:33.0965407+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfAnimalAssessmentEvent",
      "metric": {
        "resourceType": "icarIdentifierType",
        "id": "uk.roms.mobility",
        "scheme": "mobilityScore"
      },
      "score": 2,
      "assessment": "Eartag Issue",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "UK104484200768",
        "scheme": "uk.cts.eartag"
      },
      "id": "b2a8d4a7-6402-45a5-899e-20dfecbc9155",
      "eventDateTime": "2024-02-26T03:19:33.0965397+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "id.of.trait.label",
        "scheme": "aute aliquip esse quis"
      },
      "responsible": "Davy Samuels",
      "contemporaryGroup": "anim proident ad dolore ipsum",
      "remark": "Ron Ardern",
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events/b2a8d4a7-6402-45a5-899e-20dfecbc9155",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "c09b677e-bd4d-4caa-84ce-176a53b23337",
        "modified": "2024-02-26T03:19:33.0965407+00:00",
        "created": "2023-03-17T13:45:20+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "210",
        "scheme": "net.farmmetrics.farm_id"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events?offset=0&limit=1"},"items":[{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"b2a8d4a7-6402-45a5-899e-20dfecbc9155","eventDateTime":"2024-02-26T03:19:33.0965397+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/b2a8d4a7-6402-45a5-899e-20dfecbc9155","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"c09b677e-bd4d-4caa-84ce-176a53b23337","modified":"2024-02-26T03:19:33.0965407+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}]}

GET data/livestock/animal-assessment-events/{AnimalAssessmentEventId}

Gets a specific animal assessment event for a given PureFarming ID.

Request
GET /data/livestock/animal-assessment-events/{AnimalAssessmentEventId}
Parameters
Name Type Default Notes
*AnimalAssessmentEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfAnimalAssessmentEvent

Success
Mime type: text/plain 
{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"a0519bae-c346-48ec-93ef-8e7414d0fc40","eventDateTime":"2024-02-26T03:19:33.0980565+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/a0519bae-c346-48ec-93ef-8e7414d0fc40","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"3aeb672e-aa14-4934-b6c5-b32bcc89cddf","modified":"2024-02-26T03:19:33.0980574+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}
Mime type: application/json 
{
  "resourceType": "pfAnimalAssessmentEvent",
  "metric": {
    "resourceType": "icarIdentifierType",
    "id": "uk.roms.mobility",
    "scheme": "mobilityScore"
  },
  "score": 2,
  "assessment": "Eartag Issue",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "UK104484200768",
    "scheme": "uk.cts.eartag"
  },
  "id": "a0519bae-c346-48ec-93ef-8e7414d0fc40",
  "eventDateTime": "2024-02-26T03:19:33.0980565+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "id.of.trait.label",
    "scheme": "aute aliquip esse quis"
  },
  "responsible": "Davy Samuels",
  "contemporaryGroup": "anim proident ad dolore ipsum",
  "remark": "Ron Ardern",
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events/a0519bae-c346-48ec-93ef-8e7414d0fc40",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "3aeb672e-aa14-4934-b6c5-b32bcc89cddf",
    "modified": "2024-02-26T03:19:33.0980574+00:00",
    "created": "2023-03-17T13:45:20+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "210",
    "scheme": "net.farmmetrics.farm_id"
  }
}
Mime type: text/json 
{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"a0519bae-c346-48ec-93ef-8e7414d0fc40","eventDateTime":"2024-02-26T03:19:33.0980565+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/a0519bae-c346-48ec-93ef-8e7414d0fc40","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"3aeb672e-aa14-4934-b6c5-b32bcc89cddf","modified":"2024-02-26T03:19:33.0980574+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{HoldingId}/livestock/animal-assessment-events/{AnimalAssessmentEventId}

Gets a specific animal assessment event by its PureFarming ID.

Request
GET /data/holdings/{HoldingId}/livestock/animal-assessment-events/{AnimalAssessmentEventId}
Parameters
Name Type Default Notes
*HoldingId
*AnimalAssessmentEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfAnimalAssessmentEvent

Success
Mime type: text/plain 
{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"c69120ff-2c25-4c1c-91b4-b020a1ce0e31","eventDateTime":"2024-02-26T03:19:33.100033+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/c69120ff-2c25-4c1c-91b4-b020a1ce0e31","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"3eada27b-6c76-475b-be40-a7b006df9c27","modified":"2024-02-26T03:19:33.1000346+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}
Mime type: application/json 
{
  "resourceType": "pfAnimalAssessmentEvent",
  "metric": {
    "resourceType": "icarIdentifierType",
    "id": "uk.roms.mobility",
    "scheme": "mobilityScore"
  },
  "score": 2,
  "assessment": "Eartag Issue",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "UK104484200768",
    "scheme": "uk.cts.eartag"
  },
  "id": "c69120ff-2c25-4c1c-91b4-b020a1ce0e31",
  "eventDateTime": "2024-02-26T03:19:33.100033+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "id.of.trait.label",
    "scheme": "aute aliquip esse quis"
  },
  "responsible": "Davy Samuels",
  "contemporaryGroup": "anim proident ad dolore ipsum",
  "remark": "Ron Ardern",
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-assessment-events/c69120ff-2c25-4c1c-91b4-b020a1ce0e31",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "3eada27b-6c76-475b-be40-a7b006df9c27",
    "modified": "2024-02-26T03:19:33.1000346+00:00",
    "created": "2023-03-17T13:45:20+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "210",
    "scheme": "net.farmmetrics.farm_id"
  }
}
Mime type: text/json 
{"resourceType":"pfAnimalAssessmentEvent","metric":{"resourceType":"icarIdentifierType","id":"uk.roms.mobility","scheme":"mobilityScore"},"score":2.0,"assessment":"Eartag Issue","animal":{"resourceType":"icarIdentifierType","id":"UK104484200768","scheme":"uk.cts.eartag"},"id":"c69120ff-2c25-4c1c-91b4-b020a1ce0e31","eventDateTime":"2024-02-26T03:19:33.100033+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"id.of.trait.label","scheme":"aute aliquip esse quis"},"responsible":"Davy Samuels","contemporaryGroup":"anim proident ad dolore ipsum","remark":"Ron Ardern","@self":"https://api.dev.purefarming.com/data/livestock/animal-assessment-events/c69120ff-2c25-4c1c-91b4-b020a1ce0e31","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"3eada27b-6c76-475b-be40-a7b006df9c27","modified":"2024-02-26T03:19:33.1000346+00:00","created":"2023-03-17T13:45:20+00:00"},"location":{"resourceType":"icarIdentifierType","id":"210","scheme":"net.farmmetrics.farm_id"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animal groups

GET data/livestock/animal-groups

Returns all animal groups

Request
GET /data/livestock/animal-groups[?limit&offset]
Parameters
Name Type Default Notes
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfAnimalGroup]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfAnimalGroup","id":"3d5d38a3-5423-4138-8c66-fb87a5951595","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/3d5d38a3-5423-4138-8c66-fb87a5951595","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"8387d07a-5b00-491c-b8e5-1ea8a9a3d97b","modified":"2024-02-26T03:19:33.1042355+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": null,
    "next": null,
    "previous": null,
    "last": null
  },
  "items": [
    {
      "resourceType": "pfAnimalGroup",
      "id": "3d5d38a3-5423-4138-8c66-fb87a5951595",
      "classification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Milking Herd 2022",
        "count": 410,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "au.nlis.breed"
        },
        "birthPeriod": "2016-07-01/2020-08-31",
        "reproductiveStatus": "Pregnant",
        "lactationStatus": "Lactating",
        "productionPurposes": [
          "Meat",
          "Milk"
        ]
      },
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-groups/3d5d38a3-5423-4138-8c66-fb87a5951595",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animalgroup",
        "sourceId": "8387d07a-5b00-491c-b8e5-1ea8a9a3d97b",
        "modified": "2024-02-26T03:19:33.1042355+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD777",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfAnimalGroup","id":"3d5d38a3-5423-4138-8c66-fb87a5951595","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/3d5d38a3-5423-4138-8c66-fb87a5951595","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"8387d07a-5b00-491c-b8e5-1ea8a9a3d97b","modified":"2024-02-26T03:19:33.1042355+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/livestock/animal-groups/{animalGroupId}

Returns a specific animal group

Request
GET /data/livestock/animal-groups/{animalGroupId}
Parameters
Name Type Default Notes
*animalGroupId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfAnimalGroup

Success
Mime type: text/plain 
{"resourceType":"pfAnimalGroup","id":"f9490930-cf5a-4656-9de0-6fe803b9e2b0","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/f9490930-cf5a-4656-9de0-6fe803b9e2b0","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"acf02ac6-2a9c-4255-b121-5ce52ee00554","modified":"2024-02-26T03:19:33.1058746+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "pfAnimalGroup",
  "id": "f9490930-cf5a-4656-9de0-6fe803b9e2b0",
  "classification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Milking Herd 2022",
    "count": 410,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "birthPeriod": "2016-07-01/2020-08-31",
    "reproductiveStatus": "Pregnant",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Meat",
      "Milk"
    ]
  },
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-groups/f9490930-cf5a-4656-9de0-6fe803b9e2b0",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animalgroup",
    "sourceId": "acf02ac6-2a9c-4255-b121-5ce52ee00554",
    "modified": "2024-02-26T03:19:33.1058746+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD777",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"pfAnimalGroup","id":"f9490930-cf5a-4656-9de0-6fe803b9e2b0","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/f9490930-cf5a-4656-9de0-6fe803b9e2b0","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"acf02ac6-2a9c-4255-b121-5ce52ee00554","modified":"2024-02-26T03:19:33.1058746+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-groups

Returns all of the animal groups associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-groups
Parameters
Name Type Default Notes
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfAnimalGroup]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfAnimalGroup","id":"8b01332c-7ddf-4a8d-b5be-a47a78f4d06c","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/8b01332c-7ddf-4a8d-b5be-a47a78f4d06c","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"fcb9c267-f498-42bf-b932-c9ad09db2d71","modified":"2024-02-26T03:19:33.1072586+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": null,
    "next": null,
    "previous": null,
    "last": null
  },
  "items": [
    {
      "resourceType": "pfAnimalGroup",
      "id": "8b01332c-7ddf-4a8d-b5be-a47a78f4d06c",
      "classification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Milking Herd 2022",
        "count": 410,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "au.nlis.breed"
        },
        "birthPeriod": "2016-07-01/2020-08-31",
        "reproductiveStatus": "Pregnant",
        "lactationStatus": "Lactating",
        "productionPurposes": [
          "Meat",
          "Milk"
        ]
      },
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-groups/8b01332c-7ddf-4a8d-b5be-a47a78f4d06c",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animalgroup",
        "sourceId": "fcb9c267-f498-42bf-b932-c9ad09db2d71",
        "modified": "2024-02-26T03:19:33.1072586+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD777",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":null,"next":null,"previous":null,"last":null},"items":[{"resourceType":"pfAnimalGroup","id":"8b01332c-7ddf-4a8d-b5be-a47a78f4d06c","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/8b01332c-7ddf-4a8d-b5be-a47a78f4d06c","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"fcb9c267-f498-42bf-b932-c9ad09db2d71","modified":"2024-02-26T03:19:33.1072586+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/livestock/animal-groups/{animalGroupId}

Returns a single animal group associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-groups/{animalGroupId}
Parameters
Name Type Default Notes
*holdingId
*animalGroupId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfAnimalGroup

Success
Mime type: text/plain 
{"resourceType":"pfAnimalGroup","id":"3c3d85d5-71a8-43ee-bfff-0502e4cf7328","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/3c3d85d5-71a8-43ee-bfff-0502e4cf7328","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"57306c2e-edfd-4ac9-9f01-14ee0dd27045","modified":"2024-02-26T03:19:33.1092567+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "pfAnimalGroup",
  "id": "3c3d85d5-71a8-43ee-bfff-0502e4cf7328",
  "classification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Milking Herd 2022",
    "count": 410,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "birthPeriod": "2016-07-01/2020-08-31",
    "reproductiveStatus": "Pregnant",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Meat",
      "Milk"
    ]
  },
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-groups/3c3d85d5-71a8-43ee-bfff-0502e4cf7328",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animalgroup",
    "sourceId": "57306c2e-edfd-4ac9-9f01-14ee0dd27045",
    "modified": "2024-02-26T03:19:33.1092567+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD777",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"pfAnimalGroup","id":"3c3d85d5-71a8-43ee-bfff-0502e4cf7328","classification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":410.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Meat","Milk"]},"@self":"https://api.dev.purefarming.com/data/livestock/animal-groups/3c3d85d5-71a8-43ee-bfff-0502e4cf7328","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animalgroup","sourceId":"57306c2e-edfd-4ac9-9f01-14ee0dd27045","modified":"2024-02-26T03:19:33.1092567+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animal scheme compliances

GET data/livestock/animal-scheme-compliances

Gets all of the animal scheme compliances the user has access to via pagination

Request
GET /data/livestock/animal-scheme-compliances[?limit&offset]
Parameters
Name Type Default Notes
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfComplianceAssessment]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfComplianceAssessment",
      "id": "53d69761-0ed3-4e95-9a49-77804f1dea57",
      "reason": "XYZ supermarket dairy scheme compliance v2.1",
      "assessmentSummary": "Compliant",
      "complianceProgramme": {
        "resourceType": "icarIdentifierType",
        "id": "v2.1",
        "scheme": "uk.xyzsupermarket.dairy"
      },
      "assessor": {
        "resourceType": "icarIdentifierType",
        "id": "1234",
        "scheme": "uk.governingbody.vetregistration"
      },
      "compliances": [
        {
          "resourceType": "pfAnimalComplianceType",
          "status": "Compliant",
          "name": "antibiotic usage",
          "metric": {
            "id": "4.08",
            "scheme": "uk.xyzsupermarket.dairy"
          }
        },
        {
          "resourceType": "pfAnimalComplianceType",
          "status": "non-compliant",
          "name": "antibiotic usage",
          "metric": {
            "id": "4.08",
            "scheme": "uk.xyzsupermarket.dairy"
          },
          "method": {
            "id": "DDDVET",
            "scheme": "uk.veterinarygoverningbody.methods"
          },
          "units": "DDDVET",
          "value": 1000.36,
          "lastKnownValue": 1226.56,
          "lastKnownValueDate": "1999-11-25",
          "aggregation": "Average"
        }
      ],
      "groupMethod": "InventoryClassification",
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Dairy",
        "count": 375,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "culpa eu deserunt",
          "scheme": "cillum eu amet"
        },
        "birthPeriod": "2016-01-01/2021-12-31",
        "reproductiveStatus": "Open",
        "lactationStatus": "Lactating",
        "productionPurposes": [
          "Milk"
        ]
      },
      "eventDateTime": "2022-09-01T00:00:00+00:00",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.net.farmsoftware",
        "isDeleted": false,
        "modified": "2023-05-17T18:10:14+00:00",
        "creator": "nulla in nisi fugiat",
        "validTo": "2023-06-10T08:29:05+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "uk.cph"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}

GET data/holdings/{holdingId}/livestock/animal-scheme-compliances

Gets all of the animal scheme compliances for the specified holding

Request
GET /data/holdings/{holdingId}/livestock/animal-scheme-compliances[?limit&offset]
Parameters
Name Type Default Notes
*holdingId
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfComplianceAssessment]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfComplianceAssessment",
      "id": "53d69761-0ed3-4e95-9a49-77804f1dea57",
      "reason": "XYZ supermarket dairy scheme compliance v2.1",
      "assessmentSummary": "Compliant",
      "complianceProgramme": {
        "resourceType": "icarIdentifierType",
        "id": "v2.1",
        "scheme": "uk.xyzsupermarket.dairy"
      },
      "assessor": {
        "resourceType": "icarIdentifierType",
        "id": "1234",
        "scheme": "uk.governingbody.vetregistration"
      },
      "compliances": [
        {
          "resourceType": "pfAnimalComplianceType",
          "status": "Compliant",
          "name": "antibiotic usage",
          "metric": {
            "id": "4.08",
            "scheme": "uk.xyzsupermarket.dairy"
          }
        },
        {
          "resourceType": "pfAnimalComplianceType",
          "status": "non-compliant",
          "name": "antibiotic usage",
          "metric": {
            "id": "4.08",
            "scheme": "uk.xyzsupermarket.dairy"
          },
          "method": {
            "id": "DDDVET",
            "scheme": "uk.veterinarygoverningbody.methods"
          },
          "units": "DDDVET",
          "value": 1000.36,
          "lastKnownValue": 1226.56,
          "lastKnownValueDate": "1999-11-25",
          "aggregation": "Average"
        }
      ],
      "groupMethod": "InventoryClassification",
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Dairy",
        "count": 375,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "culpa eu deserunt",
          "scheme": "cillum eu amet"
        },
        "birthPeriod": "2016-01-01/2021-12-31",
        "reproductiveStatus": "Open",
        "lactationStatus": "Lactating",
        "productionPurposes": [
          "Milk"
        ]
      },
      "eventDateTime": "2022-09-01T00:00:00+00:00",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.net.farmsoftware",
        "isDeleted": false,
        "modified": "2023-05-17T18:10:14+00:00",
        "creator": "nulla in nisi fugiat",
        "validTo": "2023-06-10T08:29:05+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "uk.cph"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}

GET data/livestock/animal-scheme-compliances/{assessmentId}

Returns a single compliance assessment specified by its ID

Request
GET /data/livestock/animal-scheme-compliances/{assessmentId}
Parameters
Name Type Default Notes
*assessmentId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfComplianceAssessment

Success
Mime type: text/plain 
{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
Mime type: application/json 
{
  "resourceType": "pfComplianceAssessment",
  "id": "53d69761-0ed3-4e95-9a49-77804f1dea57",
  "reason": "XYZ supermarket dairy scheme compliance v2.1",
  "assessmentSummary": "Compliant",
  "complianceProgramme": {
    "resourceType": "icarIdentifierType",
    "id": "v2.1",
    "scheme": "uk.xyzsupermarket.dairy"
  },
  "assessor": {
    "resourceType": "icarIdentifierType",
    "id": "1234",
    "scheme": "uk.governingbody.vetregistration"
  },
  "compliances": [
    {
      "resourceType": "pfAnimalComplianceType",
      "status": "Compliant",
      "name": "antibiotic usage",
      "metric": {
        "id": "4.08",
        "scheme": "uk.xyzsupermarket.dairy"
      }
    },
    {
      "resourceType": "pfAnimalComplianceType",
      "status": "non-compliant",
      "name": "antibiotic usage",
      "metric": {
        "id": "4.08",
        "scheme": "uk.xyzsupermarket.dairy"
      },
      "method": {
        "id": "DDDVET",
        "scheme": "uk.veterinarygoverningbody.methods"
      },
      "units": "DDDVET",
      "value": 1000.36,
      "lastKnownValue": 1226.56,
      "lastKnownValueDate": "1999-11-25",
      "aggregation": "Average"
    }
  ],
  "groupMethod": "InventoryClassification",
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Dairy",
    "count": 375,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "culpa eu deserunt",
      "scheme": "cillum eu amet"
    },
    "birthPeriod": "2016-01-01/2021-12-31",
    "reproductiveStatus": "Open",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Milk"
    ]
  },
  "eventDateTime": "2022-09-01T00:00:00+00:00",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.net.farmsoftware",
    "isDeleted": false,
    "modified": "2023-05-17T18:10:14+00:00",
    "creator": "nulla in nisi fugiat",
    "validTo": "2023-06-10T08:29:05+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "uk.cph"
  }
}
Mime type: text/json 
{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-scheme-compliances/{assessmentId}

Returns a single compliance assessment specified by a holding and ID

Request
GET /data/holdings/{holdingId}/livestock/animal-scheme-compliances/{assessmentId}
Parameters
Name Type Default Notes
*holdingId
*assessmentId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfComplianceAssessment

Success
Mime type: text/plain 
{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
Mime type: application/json 
{
  "resourceType": "pfComplianceAssessment",
  "id": "53d69761-0ed3-4e95-9a49-77804f1dea57",
  "reason": "XYZ supermarket dairy scheme compliance v2.1",
  "assessmentSummary": "Compliant",
  "complianceProgramme": {
    "resourceType": "icarIdentifierType",
    "id": "v2.1",
    "scheme": "uk.xyzsupermarket.dairy"
  },
  "assessor": {
    "resourceType": "icarIdentifierType",
    "id": "1234",
    "scheme": "uk.governingbody.vetregistration"
  },
  "compliances": [
    {
      "resourceType": "pfAnimalComplianceType",
      "status": "Compliant",
      "name": "antibiotic usage",
      "metric": {
        "id": "4.08",
        "scheme": "uk.xyzsupermarket.dairy"
      }
    },
    {
      "resourceType": "pfAnimalComplianceType",
      "status": "non-compliant",
      "name": "antibiotic usage",
      "metric": {
        "id": "4.08",
        "scheme": "uk.xyzsupermarket.dairy"
      },
      "method": {
        "id": "DDDVET",
        "scheme": "uk.veterinarygoverningbody.methods"
      },
      "units": "DDDVET",
      "value": 1000.36,
      "lastKnownValue": 1226.56,
      "lastKnownValueDate": "1999-11-25",
      "aggregation": "Average"
    }
  ],
  "groupMethod": "InventoryClassification",
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Dairy",
    "count": 375,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "culpa eu deserunt",
      "scheme": "cillum eu amet"
    },
    "birthPeriod": "2016-01-01/2021-12-31",
    "reproductiveStatus": "Open",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Milk"
    ]
  },
  "eventDateTime": "2022-09-01T00:00:00+00:00",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.net.farmsoftware",
    "isDeleted": false,
    "modified": "2023-05-17T18:10:14+00:00",
    "creator": "nulla in nisi fugiat",
    "validTo": "2023-06-10T08:29:05+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "uk.cph"
  }
}
Mime type: text/json 
{"resourceType":"pfComplianceAssessment","id":"53d69761-0ed3-4e95-9a49-77804f1dea57","reason":"XYZ supermarket dairy scheme compliance v2.1","assessmentSummary":"Compliant","complianceProgramme":{"resourceType":"icarIdentifierType","id":"v2.1","scheme":"uk.xyzsupermarket.dairy"},"assessor":{"resourceType":"icarIdentifierType","id":"1234","scheme":"uk.governingbody.vetregistration"},"compliances":[{"resourceType":"pfAnimalComplianceType","status":"Compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"}},{"resourceType":"pfAnimalComplianceType","status":"non-compliant","name":"antibiotic usage","metric":{"id":"4.08","scheme":"uk.xyzsupermarket.dairy"},"method":{"id":"DDDVET","scheme":"uk.veterinarygoverningbody.methods"},"units":"DDDVET","value":1000.36,"lastKnownValue":1226.56,"lastKnownValueDate":"1999-11-25","aggregation":"Average"}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":375.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"culpa eu deserunt","scheme":"cillum eu amet"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"Open","lactationStatus":"Lactating","productionPurposes":["Milk"]},"eventDateTime":"2022-09-01T00:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"uk.net.farmsoftware","isDeleted":false,"modified":"2023-05-17T18:10:14+00:00","creator":"nulla in nisi fugiat","validTo":"2023-06-10T08:29:05+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animal set joins

GET data/livestock/animal-set-joins

Get all of the animal set joins that a user has access to

Request
GET /data/livestock/animal-set-joins[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetJoinEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"e1c138af-2cab-4742-a37d-6a60a0e63c39","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"7f1ea2c5-eb06-4a46-8e25-5dd6e44c9cab","eventDateTime":"2024-02-26T03:19:33.162355+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/7f1ea2c5-eb06-4a46-8e25-5dd6e44c9cab","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.1623545+00:00","created":"2024-02-26T03:19:33.1623547+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1623548+00:00","validTo":"2024-02-26T03:19:33.1623549+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarAnimalSetJoinEventResource",
      "animalSetId": "e1c138af-2cab-4742-a37d-6a60a0e63c39",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "XGG616616",
        "scheme": "nz.minda"
      },
      "id": "7f1ea2c5-eb06-4a46-8e25-5dd6e44c9cab",
      "eventDateTime": "2024-02-26T03:19:33.162355+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Don Harris",
      "contemporaryGroup": "2020 born heifers",
      "remark": "Daisy added to milking herd",
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/7f1ea2c5-eb06-4a46-8e25-5dd6e44c9cab",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
        "modified": "2024-02-26T03:19:33.1623545+00:00",
        "created": "2024-02-26T03:19:33.1623547+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2024-02-26T03:19:33.1623548+00:00",
        "validTo": "2024-02-26T03:19:33.1623549+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"e1c138af-2cab-4742-a37d-6a60a0e63c39","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"7f1ea2c5-eb06-4a46-8e25-5dd6e44c9cab","eventDateTime":"2024-02-26T03:19:33.162355+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/7f1ea2c5-eb06-4a46-8e25-5dd6e44c9cab","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.1623545+00:00","created":"2024-02-26T03:19:33.1623547+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1623548+00:00","validTo":"2024-02-26T03:19:33.1623549+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/livestock/animal-set-joins/{animalSetJoinId}

Get a specific animal set join

Request
GET /data/livestock/animal-set-joins/{animalSetJoinId}
Parameters
Name Type Default Notes
*animalSetJoinId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalSetJoinEventResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"b6792255-7837-4798-812e-57552142419d","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"3309bf5c-b783-4cd0-bfb4-3e6eecd4836a","eventDateTime":"2024-02-26T03:19:33.1640225+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/3309bf5c-b783-4cd0-bfb4-3e6eecd4836a","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.164022+00:00","created":"2024-02-26T03:19:33.1640222+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1640224+00:00","validTo":"2024-02-26T03:19:33.1640224+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalSetJoinEventResource",
  "animalSetId": "b6792255-7837-4798-812e-57552142419d",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "XGG616616",
    "scheme": "nz.minda"
  },
  "id": "3309bf5c-b783-4cd0-bfb4-3e6eecd4836a",
  "eventDateTime": "2024-02-26T03:19:33.1640225+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Don Harris",
  "contemporaryGroup": "2020 born heifers",
  "remark": "Daisy added to milking herd",
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/3309bf5c-b783-4cd0-bfb4-3e6eecd4836a",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
    "modified": "2024-02-26T03:19:33.164022+00:00",
    "created": "2024-02-26T03:19:33.1640222+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2024-02-26T03:19:33.1640224+00:00",
    "validTo": "2024-02-26T03:19:33.1640224+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"b6792255-7837-4798-812e-57552142419d","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"3309bf5c-b783-4cd0-bfb4-3e6eecd4836a","eventDateTime":"2024-02-26T03:19:33.1640225+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/3309bf5c-b783-4cd0-bfb4-3e6eecd4836a","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.164022+00:00","created":"2024-02-26T03:19:33.1640222+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1640224+00:00","validTo":"2024-02-26T03:19:33.1640224+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-set-joins

Get all of the animal set joins associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-set-joins[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetJoinEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"249a1217-e949-488e-bd5f-867e05c3778a","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"d66afeea-7f22-479c-aeba-88f12caa0d53","eventDateTime":"2024-02-26T03:19:33.1664229+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/d66afeea-7f22-479c-aeba-88f12caa0d53","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.1664224+00:00","created":"2024-02-26T03:19:33.1664226+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1664227+00:00","validTo":"2024-02-26T03:19:33.1664228+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarAnimalSetJoinEventResource",
      "animalSetId": "249a1217-e949-488e-bd5f-867e05c3778a",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "XGG616616",
        "scheme": "nz.minda"
      },
      "id": "d66afeea-7f22-479c-aeba-88f12caa0d53",
      "eventDateTime": "2024-02-26T03:19:33.1664229+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Don Harris",
      "contemporaryGroup": "2020 born heifers",
      "remark": "Daisy added to milking herd",
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/d66afeea-7f22-479c-aeba-88f12caa0d53",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
        "modified": "2024-02-26T03:19:33.1664224+00:00",
        "created": "2024-02-26T03:19:33.1664226+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2024-02-26T03:19:33.1664227+00:00",
        "validTo": "2024-02-26T03:19:33.1664228+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"249a1217-e949-488e-bd5f-867e05c3778a","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"d66afeea-7f22-479c-aeba-88f12caa0d53","eventDateTime":"2024-02-26T03:19:33.1664229+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/d66afeea-7f22-479c-aeba-88f12caa0d53","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.1664224+00:00","created":"2024-02-26T03:19:33.1664226+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1664227+00:00","validTo":"2024-02-26T03:19:33.1664228+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-set-joins/{animalSetJoinId}

Get a single animal set join associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-set-joins/{animalSetJoinId}
Parameters
Name Type Default Notes
*holdingId
*animalSetJoinId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalSetJoinEventResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"bc957462-51b6-449b-a9bb-3fa1aa98491c","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"41dd7a74-491c-486e-a1de-ada6998d682f","eventDateTime":"2024-02-26T03:19:33.1684647+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/41dd7a74-491c-486e-a1de-ada6998d682f","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.1684638+00:00","created":"2024-02-26T03:19:33.1684642+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1684644+00:00","validTo":"2024-02-26T03:19:33.1684645+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalSetJoinEventResource",
  "animalSetId": "bc957462-51b6-449b-a9bb-3fa1aa98491c",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "XGG616616",
    "scheme": "nz.minda"
  },
  "id": "41dd7a74-491c-486e-a1de-ada6998d682f",
  "eventDateTime": "2024-02-26T03:19:33.1684647+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Don Harris",
  "contemporaryGroup": "2020 born heifers",
  "remark": "Daisy added to milking herd",
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-joins/41dd7a74-491c-486e-a1de-ada6998d682f",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
    "modified": "2024-02-26T03:19:33.1684638+00:00",
    "created": "2024-02-26T03:19:33.1684642+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2024-02-26T03:19:33.1684644+00:00",
    "validTo": "2024-02-26T03:19:33.1684645+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalSetJoinEventResource","animalSetId":"bc957462-51b6-449b-a9bb-3fa1aa98491c","animal":{"resourceType":"icarIdentifierType","id":"XGG616616","scheme":"nz.minda"},"id":"41dd7a74-491c-486e-a1de-ada6998d682f","eventDateTime":"2024-02-26T03:19:33.1684647+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2020 born heifers","remark":"Daisy added to milking herd","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-joins/41dd7a74-491c-486e-a1de-ada6998d682f","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","modified":"2024-02-26T03:19:33.1684638+00:00","created":"2024-02-26T03:19:33.1684642+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1684644+00:00","validTo":"2024-02-26T03:19:33.1684645+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animal set leaves

GET data/livestock/animal-set-leaves

Get all of the animal set leave events that a user has access to

Request
GET /data/livestock/animal-set-leaves[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetLeaveEventResource]

Success
Mime type: text/plain 
{"totalPages":0,"itemsPerPage":0,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","next":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","last":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0"},"items":[{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"d42571df-5bcc-43e7-90af-7a42bab02f2f","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"790504ad-8213-4653-aa67-e14506f5c0c2","eventDateTime":"2024-02-26T03:19:33.1741197+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/790504ad-8213-4653-aa67-e14506f5c0c2","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1741189+00:00","created":"2024-02-26T03:19:33.1741191+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1741192+00:00","validTo":"2024-03-26T03:19:33.1741193+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 0,
  "itemsPerPage": 0,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0"
  },
  "items": [
    {
      "resourceType": "icarAnimalSetLeaveEventResource",
      "animalSetId": "d42571df-5bcc-43e7-90af-7a42bab02f2f",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "CBY779410",
        "scheme": "nz.minda"
      },
      "id": "790504ad-8213-4653-aa67-e14506f5c0c2",
      "eventDateTime": "2024-02-26T03:19:33.1741197+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Temperament",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Don Harris",
      "contemporaryGroup": "Waimarama Milking Herd",
      "remark": "Culled for poor temperament",
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves/790504ad-8213-4653-aa67-e14506f5c0c2",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "bcd1e269-8b66-495c-bfc2-56060ff73248",
        "modified": "2024-02-26T03:19:33.1741189+00:00",
        "created": "2024-02-26T03:19:33.1741191+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2024-02-26T03:19:33.1741192+00:00",
        "validTo": "2024-03-26T03:19:33.1741193+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":0,"itemsPerPage":0,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","next":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","last":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0"},"items":[{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"d42571df-5bcc-43e7-90af-7a42bab02f2f","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"790504ad-8213-4653-aa67-e14506f5c0c2","eventDateTime":"2024-02-26T03:19:33.1741197+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/790504ad-8213-4653-aa67-e14506f5c0c2","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1741189+00:00","created":"2024-02-26T03:19:33.1741191+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1741192+00:00","validTo":"2024-03-26T03:19:33.1741193+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}

GET data/livestock/animal-set-leaves/{animalSetLeaveId}

Get a specific animal set leave event by Id

Request
GET /data/livestock/animal-set-leaves/{animalSetLeaveId}
Parameters
Name Type Default Notes
*animalSetLeaveId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalSetLeaveEventResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"85dac639-8a95-4aec-a9b6-335e94762cb1","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"c9a6972f-022c-49ef-91dc-dd1c5f890141","eventDateTime":"2024-02-26T03:19:33.1758297+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/c9a6972f-022c-49ef-91dc-dd1c5f890141","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1758289+00:00","created":"2024-02-26T03:19:33.1758291+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1758292+00:00","validTo":"2024-03-26T03:19:33.1758293+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalSetLeaveEventResource",
  "animalSetId": "85dac639-8a95-4aec-a9b6-335e94762cb1",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "CBY779410",
    "scheme": "nz.minda"
  },
  "id": "c9a6972f-022c-49ef-91dc-dd1c5f890141",
  "eventDateTime": "2024-02-26T03:19:33.1758297+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Temperament",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Don Harris",
  "contemporaryGroup": "Waimarama Milking Herd",
  "remark": "Culled for poor temperament",
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves/c9a6972f-022c-49ef-91dc-dd1c5f890141",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "bcd1e269-8b66-495c-bfc2-56060ff73248",
    "modified": "2024-02-26T03:19:33.1758289+00:00",
    "created": "2024-02-26T03:19:33.1758291+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2024-02-26T03:19:33.1758292+00:00",
    "validTo": "2024-03-26T03:19:33.1758293+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"85dac639-8a95-4aec-a9b6-335e94762cb1","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"c9a6972f-022c-49ef-91dc-dd1c5f890141","eventDateTime":"2024-02-26T03:19:33.1758297+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/c9a6972f-022c-49ef-91dc-dd1c5f890141","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1758289+00:00","created":"2024-02-26T03:19:33.1758291+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1758292+00:00","validTo":"2024-03-26T03:19:33.1758293+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-set-leaves

Get all of the animal set leave events associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-set-leaves[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetLeaveEventResource]

Success
Mime type: text/plain 
{"totalPages":0,"itemsPerPage":0,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","next":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","last":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0"},"items":[{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"f3b76498-99d3-491b-8370-85f962afdc0c","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"f5c87f84-bfbb-4367-b0e1-d576f022003f","eventDateTime":"2024-02-26T03:19:33.1782527+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/f5c87f84-bfbb-4367-b0e1-d576f022003f","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1782519+00:00","created":"2024-02-26T03:19:33.1782521+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1782522+00:00","validTo":"2024-03-26T03:19:33.1782523+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 0,
  "itemsPerPage": 0,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0"
  },
  "items": [
    {
      "resourceType": "icarAnimalSetLeaveEventResource",
      "animalSetId": "f3b76498-99d3-491b-8370-85f962afdc0c",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "CBY779410",
        "scheme": "nz.minda"
      },
      "id": "f5c87f84-bfbb-4367-b0e1-d576f022003f",
      "eventDateTime": "2024-02-26T03:19:33.1782527+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Temperament",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Don Harris",
      "contemporaryGroup": "Waimarama Milking Herd",
      "remark": "Culled for poor temperament",
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves/f5c87f84-bfbb-4367-b0e1-d576f022003f",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "bcd1e269-8b66-495c-bfc2-56060ff73248",
        "modified": "2024-02-26T03:19:33.1782519+00:00",
        "created": "2024-02-26T03:19:33.1782521+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2024-02-26T03:19:33.1782522+00:00",
        "validTo": "2024-03-26T03:19:33.1782523+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":0,"itemsPerPage":0,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","next":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","previous":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0","last":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves?offset=0&limit=0"},"items":[{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"f3b76498-99d3-491b-8370-85f962afdc0c","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"f5c87f84-bfbb-4367-b0e1-d576f022003f","eventDateTime":"2024-02-26T03:19:33.1782527+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/f5c87f84-bfbb-4367-b0e1-d576f022003f","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1782519+00:00","created":"2024-02-26T03:19:33.1782521+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1782522+00:00","validTo":"2024-03-26T03:19:33.1782523+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-set-leaves/{animalSetLeaveId}

Get a single animal set leave event associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-set-leaves/{animalSetLeaveId}
Parameters
Name Type Default Notes
*holdingId
*animalSetLeaveId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalSetLeaveEventResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"87b5ce19-6714-46ef-aea6-913c0628a9fc","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"ee86ced2-670f-46fe-b57b-47578621ba25","eventDateTime":"2024-02-26T03:19:33.1803046+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/ee86ced2-670f-46fe-b57b-47578621ba25","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1803031+00:00","created":"2024-02-26T03:19:33.1803035+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1803037+00:00","validTo":"2024-03-26T03:19:33.1803039+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalSetLeaveEventResource",
  "animalSetId": "87b5ce19-6714-46ef-aea6-913c0628a9fc",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "CBY779410",
    "scheme": "nz.minda"
  },
  "id": "ee86ced2-670f-46fe-b57b-47578621ba25",
  "eventDateTime": "2024-02-26T03:19:33.1803046+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Temperament",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Don Harris",
  "contemporaryGroup": "Waimarama Milking Herd",
  "remark": "Culled for poor temperament",
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-set-leaves/ee86ced2-670f-46fe-b57b-47578621ba25",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "bcd1e269-8b66-495c-bfc2-56060ff73248",
    "modified": "2024-02-26T03:19:33.1803031+00:00",
    "created": "2024-02-26T03:19:33.1803035+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2024-02-26T03:19:33.1803037+00:00",
    "validTo": "2024-03-26T03:19:33.1803039+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalSetLeaveEventResource","animalSetId":"87b5ce19-6714-46ef-aea6-913c0628a9fc","animal":{"resourceType":"icarIdentifierType","id":"CBY779410","scheme":"nz.minda"},"id":"ee86ced2-670f-46fe-b57b-47578621ba25","eventDateTime":"2024-02-26T03:19:33.1803046+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Temperament","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"Waimarama Milking Herd","remark":"Culled for poor temperament","@self":"https://api.dev.purefarming.com/data/livestock/animal-set-leaves/ee86ced2-670f-46fe-b57b-47578621ba25","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"bcd1e269-8b66-495c-bfc2-56060ff73248","modified":"2024-02-26T03:19:33.1803031+00:00","created":"2024-02-26T03:19:33.1803035+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1803037+00:00","validTo":"2024-03-26T03:19:33.1803039+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animal sets

GET data/livestock/animal-sets

Returns all of the animal set events that a user has access to

Request
GET /data/livestock/animal-sets[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetResource","id":"3c1a37fa-777f-4c9b-a9b5-a7634f8844e5","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/3c1a37fa-777f-4c9b-a9b5-a7634f8844e5","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1846101+00:00","created":"2024-02-26T03:19:33.1846103+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1846103+00:00","validTo":"2024-02-26T03:19:33.1846104+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarAnimalSetResource",
      "id": "3c1a37fa-777f-4c9b-a9b5-a7634f8844e5",
      "name": "Waimarama milking herd",
      "purpose": "Lactation",
      "member": [
        {
          "resourceType": "icarIdentifierType",
          "id": "ABK779345",
          "scheme": "nz.mindas"
        }
      ],
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-sets/3c1a37fa-777f-4c9b-a9b5-a7634f8844e5",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "0e353f77-41ca-45e0-ab07-911b93c75f74",
        "modified": "2024-02-26T03:19:33.1846101+00:00",
        "created": "2024-02-26T03:19:33.1846103+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2024-02-26T03:19:33.1846103+00:00",
        "validTo": "2024-02-26T03:19:33.1846104+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetResource","id":"3c1a37fa-777f-4c9b-a9b5-a7634f8844e5","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/3c1a37fa-777f-4c9b-a9b5-a7634f8844e5","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1846101+00:00","created":"2024-02-26T03:19:33.1846103+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1846103+00:00","validTo":"2024-02-26T03:19:33.1846104+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/livestock/animal-sets/{animalSetId}

Get a specific animal set

Request
GET /data/livestock/animal-sets/{animalSetId}
Parameters
Name Type Default Notes
*animalSetId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalSetResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalSetResource","id":"f2d1ce83-fee7-4d6b-8e01-4dd07c2845f1","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/f2d1ce83-fee7-4d6b-8e01-4dd07c2845f1","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1861993+00:00","created":"2024-02-26T03:19:33.1861995+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1861996+00:00","validTo":"2024-02-26T03:19:33.1861996+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalSetResource",
  "id": "f2d1ce83-fee7-4d6b-8e01-4dd07c2845f1",
  "name": "Waimarama milking herd",
  "purpose": "Lactation",
  "member": [
    {
      "resourceType": "icarIdentifierType",
      "id": "ABK779345",
      "scheme": "nz.mindas"
    }
  ],
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-sets/f2d1ce83-fee7-4d6b-8e01-4dd07c2845f1",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "0e353f77-41ca-45e0-ab07-911b93c75f74",
    "modified": "2024-02-26T03:19:33.1861993+00:00",
    "created": "2024-02-26T03:19:33.1861995+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2024-02-26T03:19:33.1861996+00:00",
    "validTo": "2024-02-26T03:19:33.1861996+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalSetResource","id":"f2d1ce83-fee7-4d6b-8e01-4dd07c2845f1","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/f2d1ce83-fee7-4d6b-8e01-4dd07c2845f1","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1861993+00:00","created":"2024-02-26T03:19:33.1861995+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1861996+00:00","validTo":"2024-02-26T03:19:33.1861996+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-sets

Get all of the animal sets associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-sets[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetResource","id":"dc398e51-7c97-4c99-9ccb-9270fbc0943e","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/dc398e51-7c97-4c99-9ccb-9270fbc0943e","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1885581+00:00","created":"2024-02-26T03:19:33.1885583+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1885583+00:00","validTo":"2024-02-26T03:19:33.1885584+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarAnimalSetResource",
      "id": "dc398e51-7c97-4c99-9ccb-9270fbc0943e",
      "name": "Waimarama milking herd",
      "purpose": "Lactation",
      "member": [
        {
          "resourceType": "icarIdentifierType",
          "id": "ABK779345",
          "scheme": "nz.mindas"
        }
      ],
      "@self": "https://api.dev.purefarming.com/data/livestock/animal-sets/dc398e51-7c97-4c99-9ccb-9270fbc0943e",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "0e353f77-41ca-45e0-ab07-911b93c75f74",
        "modified": "2024-02-26T03:19:33.1885581+00:00",
        "created": "2024-02-26T03:19:33.1885583+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2024-02-26T03:19:33.1885583+00:00",
        "validTo": "2024-02-26T03:19:33.1885584+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animal-sets?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalSetResource","id":"dc398e51-7c97-4c99-9ccb-9270fbc0943e","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/dc398e51-7c97-4c99-9ccb-9270fbc0943e","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1885581+00:00","created":"2024-02-26T03:19:33.1885583+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1885583+00:00","validTo":"2024-02-26T03:19:33.1885584+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-sets/{animalSetId}

Get a single animal set associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-sets/{animalSetId}
Parameters
Name Type Default Notes
*holdingId
*animalSetId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalSetResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalSetResource","id":"5e542a19-c306-4673-b074-7f42e3092261","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/5e542a19-c306-4673-b074-7f42e3092261","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1904711+00:00","created":"2024-02-26T03:19:33.1904715+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1904717+00:00","validTo":"2024-02-26T03:19:33.1904718+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalSetResource",
  "id": "5e542a19-c306-4673-b074-7f42e3092261",
  "name": "Waimarama milking herd",
  "purpose": "Lactation",
  "member": [
    {
      "resourceType": "icarIdentifierType",
      "id": "ABK779345",
      "scheme": "nz.mindas"
    }
  ],
  "@self": "https://api.dev.purefarming.com/data/livestock/animal-sets/5e542a19-c306-4673-b074-7f42e3092261",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "0e353f77-41ca-45e0-ab07-911b93c75f74",
    "modified": "2024-02-26T03:19:33.1904711+00:00",
    "created": "2024-02-26T03:19:33.1904715+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2024-02-26T03:19:33.1904717+00:00",
    "validTo": "2024-02-26T03:19:33.1904718+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalSetResource","id":"5e542a19-c306-4673-b074-7f42e3092261","name":"Waimarama milking herd","purpose":"Lactation","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.mindas"}],"@self":"https://api.dev.purefarming.com/data/livestock/animal-sets/5e542a19-c306-4673-b074-7f42e3092261","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"0e353f77-41ca-45e0-ab07-911b93c75f74","modified":"2024-02-26T03:19:33.1904711+00:00","created":"2024-02-26T03:19:33.1904715+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2024-02-26T03:19:33.1904717+00:00","validTo":"2024-02-26T03:19:33.1904718+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animal statistics

GET data/livestock/animal-statistics

Get all of the animal statistics that a user has access to

The limit of results to return The offset to specify at what row to start queryingInclude deleted events in the results, default = false
Request
GET /data/livestock/animal-statistics[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
limit
offset
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/livestock/animal-statistics/{animalStatisticsId}

Get a specific animal statistics by Id

Request
GET /data/livestock/animal-statistics/{animalStatisticsId}
Parameters
Name Type Default Notes
*animalStatisticsId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animal-statistics

Get all of the animal statistics associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-statistics[?limit&offset&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
includeDeleted False

Include deleted events in the results, default = false
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/livestock/animal-statistics/{animalStatisticsId}

Get a single animal statistics associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/animal-statistics/{animalStatisticsId}
Parameters
Name Type Default Notes
*holdingId
*animalStatisticsId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfEnterpriseStatistics

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Animals

GET data/livestock/animals

Returns all of the animals that a user has access too

Request
GET /data/livestock/animals[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalCoreResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/356863c9-4307-47ee-a202-d85961ea0387","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"949763ec-ad4e-4e1f-a859-1b91033c14d0","modified":"2024-02-26T03:19:33.2078252+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarAnimalCoreResource",
      "identifier": {
        "resourceType": "icarIdentifierType",
        "id": "982 123477466062",
        "scheme": "au.nlis"
      },
      "alternativeIdentifiers": [
        {
          "resourceType": "icarIdentifierType",
          "id": "3ABAB111",
          "scheme": "au.nlis.visual"
        }
      ],
      "specie": "Cattle",
      "gender": "Female",
      "birthDate": "2020-07-10T00:00:00+00:00",
      "primaryBreed": {
        "resourceType": "icarIdentifierType",
        "id": "FF",
        "scheme": "au.nlis.breed"
      },
      "breedFractions": {
        "resourceType": "icarBreedFractionsType",
        "denominator": 16,
        "fractions": [
          {
            "breed": {
              "id": "FF",
              "scheme": "au.nlis.breed"
            },
            "fraction": 15
          },
          {
            "breed": {
              "id": "JJ",
              "scheme": "au.nlis.breed"
            },
            "fraction": 1
          }
        ]
      },
      "coatColor": "Black",
      "coatColorIdentifier": {
        "resourceType": "icarIdentifierType",
        "id": "12435",
        "scheme": "mock.color.scheme"
      },
      "managementTag": "44562",
      "name": "Sally",
      "officialName": "Waringa Supreme Sally",
      "productionPurpose": "Milk",
      "status": "Alive",
      "reproductionStatus": "Open",
      "lactationStatus": "Lactating",
      "parentage": [
        {
          "resourceType": "icarParentageType",
          "parentOf": {
            "id": "931 123477466011",
            "scheme": "au.nlis"
          },
          "gender": "Male",
          "relation": "Genetic",
          "identifier": {
            "id": "911 111111",
            "scheme": "au.nlis"
          },
          "officialName": "mock name sire"
        },
        {
          "resourceType": "icarParentageType",
          "parentOf": {
            "id": "931 123477466011",
            "scheme": "au.nlis"
          },
          "gender": "Female",
          "relation": "Genetic",
          "identifier": {
            "id": "911 222222",
            "scheme": "au.nlis"
          },
          "officialName": "mock name dam"
        },
        {
          "resourceType": "icarParentageType",
          "parentOf": {
            "id": "911 222222",
            "scheme": "au.nlis"
          },
          "gender": "Female",
          "relation": "Genetic",
          "identifier": {
            "id": "910 333333",
            "scheme": "au.nlis"
          },
          "officialName": "mock name dam of dam"
        }
      ],
      "healthStatus": "Healthy",
      "@self": "https://api.dev.purefarming.com/data/livestock/animals/356863c9-4307-47ee-a202-d85961ea0387",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "949763ec-ad4e-4e1f-a859-1b91033c14d0",
        "modified": "2024-02-26T03:19:33.2078252+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABZF222",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/356863c9-4307-47ee-a202-d85961ea0387","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"949763ec-ad4e-4e1f-a859-1b91033c14d0","modified":"2024-02-26T03:19:33.2078252+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/livestock/animals/{animalId}

Returns the details for the given animal that the user has access too

Request
GET /data/livestock/animals/{animalId}
Parameters
Name Type Default Notes
*animalId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalCoreResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/3817bcc0-cc25-4fe1-b0b1-e9b8db13f014","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"6f887b44-e485-4f8d-b16b-0d423c5e9e55","modified":"2024-02-26T03:19:33.210694+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalCoreResource",
  "identifier": {
    "resourceType": "icarIdentifierType",
    "id": "982 123477466062",
    "scheme": "au.nlis"
  },
  "alternativeIdentifiers": [
    {
      "resourceType": "icarIdentifierType",
      "id": "3ABAB111",
      "scheme": "au.nlis.visual"
    }
  ],
  "specie": "Cattle",
  "gender": "Female",
  "birthDate": "2020-07-10T00:00:00+00:00",
  "primaryBreed": {
    "resourceType": "icarIdentifierType",
    "id": "FF",
    "scheme": "au.nlis.breed"
  },
  "breedFractions": {
    "resourceType": "icarBreedFractionsType",
    "denominator": 16,
    "fractions": [
      {
        "breed": {
          "id": "FF",
          "scheme": "au.nlis.breed"
        },
        "fraction": 15
      },
      {
        "breed": {
          "id": "JJ",
          "scheme": "au.nlis.breed"
        },
        "fraction": 1
      }
    ]
  },
  "coatColor": "Black",
  "coatColorIdentifier": {
    "resourceType": "icarIdentifierType",
    "id": "12435",
    "scheme": "mock.color.scheme"
  },
  "managementTag": "44562",
  "name": "Sally",
  "officialName": "Waringa Supreme Sally",
  "productionPurpose": "Milk",
  "status": "Alive",
  "reproductionStatus": "Open",
  "lactationStatus": "Lactating",
  "parentage": [
    {
      "resourceType": "icarParentageType",
      "parentOf": {
        "id": "931 123477466011",
        "scheme": "au.nlis"
      },
      "gender": "Male",
      "relation": "Genetic",
      "identifier": {
        "id": "911 111111",
        "scheme": "au.nlis"
      },
      "officialName": "mock name sire"
    },
    {
      "resourceType": "icarParentageType",
      "parentOf": {
        "id": "931 123477466011",
        "scheme": "au.nlis"
      },
      "gender": "Female",
      "relation": "Genetic",
      "identifier": {
        "id": "911 222222",
        "scheme": "au.nlis"
      },
      "officialName": "mock name dam"
    },
    {
      "resourceType": "icarParentageType",
      "parentOf": {
        "id": "911 222222",
        "scheme": "au.nlis"
      },
      "gender": "Female",
      "relation": "Genetic",
      "identifier": {
        "id": "910 333333",
        "scheme": "au.nlis"
      },
      "officialName": "mock name dam of dam"
    }
  ],
  "healthStatus": "Healthy",
  "@self": "https://api.dev.purefarming.com/data/livestock/animals/3817bcc0-cc25-4fe1-b0b1-e9b8db13f014",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "6f887b44-e485-4f8d-b16b-0d423c5e9e55",
    "modified": "2024-02-26T03:19:33.210694+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABZF222",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/3817bcc0-cc25-4fe1-b0b1-e9b8db13f014","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"6f887b44-e485-4f8d-b16b-0d423c5e9e55","modified":"2024-02-26T03:19:33.210694+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animals

Returns all of the animals attached to the given holding

Request
GET /data/holdings/{holdingId}/livestock/animals[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalCoreResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/27bfef54-951b-410f-8388-c41ee7fc583b","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"68dc3584-ffda-40c8-a0f9-88f8269a6c7f","modified":"2024-02-26T03:19:33.2140565+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarAnimalCoreResource",
      "identifier": {
        "resourceType": "icarIdentifierType",
        "id": "982 123477466062",
        "scheme": "au.nlis"
      },
      "alternativeIdentifiers": [
        {
          "resourceType": "icarIdentifierType",
          "id": "3ABAB111",
          "scheme": "au.nlis.visual"
        }
      ],
      "specie": "Cattle",
      "gender": "Female",
      "birthDate": "2020-07-10T00:00:00+00:00",
      "primaryBreed": {
        "resourceType": "icarIdentifierType",
        "id": "FF",
        "scheme": "au.nlis.breed"
      },
      "breedFractions": {
        "resourceType": "icarBreedFractionsType",
        "denominator": 16,
        "fractions": [
          {
            "breed": {
              "id": "FF",
              "scheme": "au.nlis.breed"
            },
            "fraction": 15
          },
          {
            "breed": {
              "id": "JJ",
              "scheme": "au.nlis.breed"
            },
            "fraction": 1
          }
        ]
      },
      "coatColor": "Black",
      "coatColorIdentifier": {
        "resourceType": "icarIdentifierType",
        "id": "12435",
        "scheme": "mock.color.scheme"
      },
      "managementTag": "44562",
      "name": "Sally",
      "officialName": "Waringa Supreme Sally",
      "productionPurpose": "Milk",
      "status": "Alive",
      "reproductionStatus": "Open",
      "lactationStatus": "Lactating",
      "parentage": [
        {
          "resourceType": "icarParentageType",
          "parentOf": {
            "id": "931 123477466011",
            "scheme": "au.nlis"
          },
          "gender": "Male",
          "relation": "Genetic",
          "identifier": {
            "id": "911 111111",
            "scheme": "au.nlis"
          },
          "officialName": "mock name sire"
        },
        {
          "resourceType": "icarParentageType",
          "parentOf": {
            "id": "931 123477466011",
            "scheme": "au.nlis"
          },
          "gender": "Female",
          "relation": "Genetic",
          "identifier": {
            "id": "911 222222",
            "scheme": "au.nlis"
          },
          "officialName": "mock name dam"
        },
        {
          "resourceType": "icarParentageType",
          "parentOf": {
            "id": "911 222222",
            "scheme": "au.nlis"
          },
          "gender": "Female",
          "relation": "Genetic",
          "identifier": {
            "id": "910 333333",
            "scheme": "au.nlis"
          },
          "officialName": "mock name dam of dam"
        }
      ],
      "healthStatus": "Healthy",
      "@self": "https://api.dev.purefarming.com/data/livestock/animals/27bfef54-951b-410f-8388-c41ee7fc583b",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "68dc3584-ffda-40c8-a0f9-88f8269a6c7f",
        "modified": "2024-02-26T03:19:33.2140565+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABZF222",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/animals?offset=0&limit=1"},"items":[{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/27bfef54-951b-410f-8388-c41ee7fc583b","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"68dc3584-ffda-40c8-a0f9-88f8269a6c7f","modified":"2024-02-26T03:19:33.2140565+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/animals/{animalId}

Returns the details for the given animal

Request
GET /data/holdings/{holdingId}/livestock/animals/{animalId}
Parameters
Name Type Default Notes
*animalId
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarAnimalCoreResource

Success
Mime type: text/plain 
{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/b6780cd6-496f-4a6b-8b8d-6643a6c6f0d2","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"e47dc97d-4eff-4ece-b1ab-885d5518f389","modified":"2024-02-26T03:19:33.2168786+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarAnimalCoreResource",
  "identifier": {
    "resourceType": "icarIdentifierType",
    "id": "982 123477466062",
    "scheme": "au.nlis"
  },
  "alternativeIdentifiers": [
    {
      "resourceType": "icarIdentifierType",
      "id": "3ABAB111",
      "scheme": "au.nlis.visual"
    }
  ],
  "specie": "Cattle",
  "gender": "Female",
  "birthDate": "2020-07-10T00:00:00+00:00",
  "primaryBreed": {
    "resourceType": "icarIdentifierType",
    "id": "FF",
    "scheme": "au.nlis.breed"
  },
  "breedFractions": {
    "resourceType": "icarBreedFractionsType",
    "denominator": 16,
    "fractions": [
      {
        "breed": {
          "id": "FF",
          "scheme": "au.nlis.breed"
        },
        "fraction": 15
      },
      {
        "breed": {
          "id": "JJ",
          "scheme": "au.nlis.breed"
        },
        "fraction": 1
      }
    ]
  },
  "coatColor": "Black",
  "coatColorIdentifier": {
    "resourceType": "icarIdentifierType",
    "id": "12435",
    "scheme": "mock.color.scheme"
  },
  "managementTag": "44562",
  "name": "Sally",
  "officialName": "Waringa Supreme Sally",
  "productionPurpose": "Milk",
  "status": "Alive",
  "reproductionStatus": "Open",
  "lactationStatus": "Lactating",
  "parentage": [
    {
      "resourceType": "icarParentageType",
      "parentOf": {
        "id": "931 123477466011",
        "scheme": "au.nlis"
      },
      "gender": "Male",
      "relation": "Genetic",
      "identifier": {
        "id": "911 111111",
        "scheme": "au.nlis"
      },
      "officialName": "mock name sire"
    },
    {
      "resourceType": "icarParentageType",
      "parentOf": {
        "id": "931 123477466011",
        "scheme": "au.nlis"
      },
      "gender": "Female",
      "relation": "Genetic",
      "identifier": {
        "id": "911 222222",
        "scheme": "au.nlis"
      },
      "officialName": "mock name dam"
    },
    {
      "resourceType": "icarParentageType",
      "parentOf": {
        "id": "911 222222",
        "scheme": "au.nlis"
      },
      "gender": "Female",
      "relation": "Genetic",
      "identifier": {
        "id": "910 333333",
        "scheme": "au.nlis"
      },
      "officialName": "mock name dam of dam"
    }
  ],
  "healthStatus": "Healthy",
  "@self": "https://api.dev.purefarming.com/data/livestock/animals/b6780cd6-496f-4a6b-8b8d-6643a6c6f0d2",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "e47dc97d-4eff-4ece-b1ab-885d5518f389",
    "modified": "2024-02-26T03:19:33.2168786+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABZF222",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/b6780cd6-496f-4a6b-8b8d-6643a6c6f0d2","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"e47dc97d-4eff-4ece-b1ab-885d5518f389","modified":"2024-02-26T03:19:33.2168786+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Carcass observation events

GET data/livestock/carcass/carcass-observations-event

Gets all carcass observation events you have access to.

Request
GET /data/livestock/carcass/carcass-observations-event[?limit&offset&animalIdentifierId&animalIdentifierScheme&metricIdentifierScheme&metricIdentifierId&eventDateTimeFrom&eventDateTimeTo&killDateTimeFrom&killDateTimeTo&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifierId

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
metricIdentifierScheme

The metric scheme to search for
metricIdentifierId

The metric id to search for
eventDateTimeFrom

The date and time of the event to search for
eventDateTimeTo

The date and time of the event to search for
killDateTimeFrom

The date and time of the kill event to search for
killDateTimeTo

The date and time of the kill event to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarCarcassObservationsEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1"},"items":[{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"b2efb02a-4708-4d55-97c7-e7729a9d48ce","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"324b1385-e1db-4e71-9def-ab898b5e1593","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/0926d363-da8f-415d-b5ef-d7a2f23cc09d","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"0fd5c578-6cfc-4b22-a536-14532ce2af48","modified":"2024-02-26T03:19:33.2818075+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarCarcassObservationsEventResource",
      "carcass": {
        "resourceType": "icarCarcassType",
        "processingLot": {
          "id": "b2efb02a-4708-4d55-97c7-e7729a9d48ce",
          "name": "025-017",
          "chain": {
            "plant": {
              "interests": [],
              "name": "KBL Meat Processors",
              "leiCode": "123456L00AB00ABC0A00"
            },
            "chainId": "B03",
            "chainProcess": "PostMortem"
          },
          "killDateTime": "2023-01-25T09:45:00+00:00",
          "startBodyNumber": 1,
          "endBodyNumber": 80,
          "lotCount": 80,
          "targetMarket": "Export",
          "killType": "K7",
          "species": "Cattle",
          "consignment": {
            "id": {
              "id": "GB470",
              "scheme": "au.nlis.consign"
            },
            "originLocation": {
              "id": "au.nlis.pic",
              "scheme": "NS444999"
            },
            "destinationLocation": {
              "id": "ND250250",
              "scheme": "au.nlis.pic"
            },
            "loadingDateTime": "2022-10-12T08:15:00+00:00",
            "unloadingDateTime": "2022-10-12T14:27:00+00:00",
            "expectedDuration": 6,
            "transportOperator": "Gene Transport Pty Ltd",
            "vehicle": "74KHP3",
            "transportReference": "94-238",
            "isolationFacilityUsed": false,
            "farmAssuranceReference": {
              "id": "368HH",
              "scheme": "au.lpa.member"
            },
            "countConsigned": 80,
            "countReceived": 80,
            "hoursOffFeed": 6,
            "hoursOffWater": 6
          }
        },
        "killDateTime": "2023-01-25T09:45:00+00:00",
        "bodyNo": 379,
        "identifiers": [
          {
            "id": "au.kbl.id",
            "scheme": "380/547/38"
          }
        ],
        "sex": "Male",
        "birthDate": "2020-07-16T00:00:00+00:00",
        "birthDateConfidence": "AAU",
        "primaryBreed": {
          "id": "ANG",
          "scheme": "au.abri.breed"
        },
        "plantBoningRun": 17,
        "plantBoningRunTemplate": "ABC444",
        "destinationCode": "ABC12",
        "processorGrid": "XYZ-02"
      },
      "observations": [
        {
          "resourceType": "icarCarcassObservationType",
          "metric": {
            "id": {
              "id": "au.ausmeat.metric",
              "scheme": "hotCarcaseWt"
            },
            "method": "Weigh"
          },
          "value": 241.2,
          "units": "KGM",
          "observationStatus": "Measured"
        },
        {
          "resourceType": "icarCarcassObservationType",
          "metric": {
            "id": {
              "id": "au.ausmeat.metric",
              "scheme": "marbling"
            },
            "method": "Visual"
          },
          "value": 3.1,
          "observationStatus": "Calculated"
        }
      ],
      "side": "Left",
      "primal": "Hindquarter",
      "carcassState": "Hot",
      "device": {
        "resourceType": "icarDeviceResource",
        "id": "WS41",
        "serial": "TR546-973-7",
        "name": "Thermometer",
        "description": "Digital thermometer with probes",
        "softwareVersion": "5.4.0.1",
        "hardwareVersion": "3.37",
        "isActive": true,
        "supportedMessages": [
          {
            "messages": "Diagnoses"
          },
          {
            "messages": "Diagnoses"
          }
        ],
        "manufacturer": {
          "id": "thematicdevices.com",
          "deviceType": "Scales",
          "deviceName": "TR546"
        }
      },
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "3FRPI065XBCD0071",
        "scheme": "au.nlis.animal"
      },
      "id": "324b1385-e1db-4e71-9def-ab898b5e1593",
      "eventDateTime": "2022-10-13T07:58:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Cold carcase observations",
        "scheme": "au.ausmeat.traits"
      },
      "responsible": "Jimmy Brown",
      "contemporaryGroup": "BluesBrothersFarm",
      "remark": "Cold observations",
      "@self": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/0926d363-da8f-415d-b5ef-d7a2f23cc09d",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.processco.carcass",
        "sourceId": "0fd5c578-6cfc-4b22-a536-14532ce2af48",
        "modified": "2024-02-26T03:19:33.2818075+00:00",
        "created": "2023-01-03T11:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "au.nlis.pic",
        "scheme": "3ABAB111"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1"},"items":[{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"b2efb02a-4708-4d55-97c7-e7729a9d48ce","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"324b1385-e1db-4e71-9def-ab898b5e1593","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/0926d363-da8f-415d-b5ef-d7a2f23cc09d","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"0fd5c578-6cfc-4b22-a536-14532ce2af48","modified":"2024-02-26T03:19:33.2818075+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}]}

GET data/holdings/{HoldingId}/livestock/carcass/carcass-observations-event

Get all carcass observation events associated with the given holding.

Request
GET /data/holdings/{HoldingId}/livestock/carcass/carcass-observations-event[?limit&offset&animalIdentifier&animalIdentifierScheme&metricScheme&metricId&eventDateTimeFrom&eventDateTimeTo&killDateTimeFrom&killDateTimeTo&includeDeleted]
Parameters
Name Type Default Notes
*HoldingId

The ID of the holding.
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
metricScheme

The metric scheme to search for
metricId

The metric id to search for
eventDateTimeFrom

The date and time of the event to search for
eventDateTimeTo

The date and time of the event to search for
killDateTimeFrom

The date and time of the kill event to search for
killDateTimeTo

The date and time of the kill event to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarCarcassObservationsEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1"},"items":[{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"14e8948f-4033-442e-aa03-2aed3b26561b","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"1867ec2d-9aea-4d57-9fd3-a11c2eac4bda","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/de7bf2dd-b9b0-4928-b83b-ac90b6071118","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"af79aa70-72f5-4998-802a-381364e6a004","modified":"2024-02-26T03:19:33.287412+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarCarcassObservationsEventResource",
      "carcass": {
        "resourceType": "icarCarcassType",
        "processingLot": {
          "id": "14e8948f-4033-442e-aa03-2aed3b26561b",
          "name": "025-017",
          "chain": {
            "plant": {
              "interests": [],
              "name": "KBL Meat Processors",
              "leiCode": "123456L00AB00ABC0A00"
            },
            "chainId": "B03",
            "chainProcess": "PostMortem"
          },
          "killDateTime": "2023-01-25T09:45:00+00:00",
          "startBodyNumber": 1,
          "endBodyNumber": 80,
          "lotCount": 80,
          "targetMarket": "Export",
          "killType": "K7",
          "species": "Cattle",
          "consignment": {
            "id": {
              "id": "GB470",
              "scheme": "au.nlis.consign"
            },
            "originLocation": {
              "id": "au.nlis.pic",
              "scheme": "NS444999"
            },
            "destinationLocation": {
              "id": "ND250250",
              "scheme": "au.nlis.pic"
            },
            "loadingDateTime": "2022-10-12T08:15:00+00:00",
            "unloadingDateTime": "2022-10-12T14:27:00+00:00",
            "expectedDuration": 6,
            "transportOperator": "Gene Transport Pty Ltd",
            "vehicle": "74KHP3",
            "transportReference": "94-238",
            "isolationFacilityUsed": false,
            "farmAssuranceReference": {
              "id": "368HH",
              "scheme": "au.lpa.member"
            },
            "countConsigned": 80,
            "countReceived": 80,
            "hoursOffFeed": 6,
            "hoursOffWater": 6
          }
        },
        "killDateTime": "2023-01-25T09:45:00+00:00",
        "bodyNo": 379,
        "identifiers": [
          {
            "id": "au.kbl.id",
            "scheme": "380/547/38"
          }
        ],
        "sex": "Male",
        "birthDate": "2020-07-16T00:00:00+00:00",
        "birthDateConfidence": "AAU",
        "primaryBreed": {
          "id": "ANG",
          "scheme": "au.abri.breed"
        },
        "plantBoningRun": 17,
        "plantBoningRunTemplate": "ABC444",
        "destinationCode": "ABC12",
        "processorGrid": "XYZ-02"
      },
      "observations": [
        {
          "resourceType": "icarCarcassObservationType",
          "metric": {
            "id": {
              "id": "au.ausmeat.metric",
              "scheme": "hotCarcaseWt"
            },
            "method": "Weigh"
          },
          "value": 241.2,
          "units": "KGM",
          "observationStatus": "Measured"
        },
        {
          "resourceType": "icarCarcassObservationType",
          "metric": {
            "id": {
              "id": "au.ausmeat.metric",
              "scheme": "marbling"
            },
            "method": "Visual"
          },
          "value": 3.1,
          "observationStatus": "Calculated"
        }
      ],
      "side": "Left",
      "primal": "Hindquarter",
      "carcassState": "Hot",
      "device": {
        "resourceType": "icarDeviceResource",
        "id": "WS41",
        "serial": "TR546-973-7",
        "name": "Thermometer",
        "description": "Digital thermometer with probes",
        "softwareVersion": "5.4.0.1",
        "hardwareVersion": "3.37",
        "isActive": true,
        "supportedMessages": [
          {
            "messages": "Diagnoses"
          },
          {
            "messages": "Diagnoses"
          }
        ],
        "manufacturer": {
          "id": "thematicdevices.com",
          "deviceType": "Scales",
          "deviceName": "TR546"
        }
      },
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "3FRPI065XBCD0071",
        "scheme": "au.nlis.animal"
      },
      "id": "1867ec2d-9aea-4d57-9fd3-a11c2eac4bda",
      "eventDateTime": "2022-10-13T07:58:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Cold carcase observations",
        "scheme": "au.ausmeat.traits"
      },
      "responsible": "Jimmy Brown",
      "contemporaryGroup": "BluesBrothersFarm",
      "remark": "Cold observations",
      "@self": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/de7bf2dd-b9b0-4928-b83b-ac90b6071118",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.processco.carcass",
        "sourceId": "af79aa70-72f5-4998-802a-381364e6a004",
        "modified": "2024-02-26T03:19:33.287412+00:00",
        "created": "2023-01-03T11:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "au.nlis.pic",
        "scheme": "3ABAB111"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events?offset=0&limit=1"},"items":[{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"14e8948f-4033-442e-aa03-2aed3b26561b","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"1867ec2d-9aea-4d57-9fd3-a11c2eac4bda","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/de7bf2dd-b9b0-4928-b83b-ac90b6071118","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"af79aa70-72f5-4998-802a-381364e6a004","modified":"2024-02-26T03:19:33.287412+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}]}

GET data/livestock/carcass/carcass-observations-event/{CarcassObservationsEventId}

Gets a specific carcass observation event for a given PureFarming ID.

Request
GET /data/livestock/carcass/carcass-observations-event/{CarcassObservationsEventId}
Parameters
Name Type Default Notes
*CarcassObservationsEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarCarcassObservationsEventResource

Success
Mime type: text/plain 
{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"d136ee1b-63da-4f1b-a9ef-59e2229967af","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"023af539-ad76-40ab-a57b-f62b1458d732","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/163fde24-3139-4952-9768-5444bfc6f1c3","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"a28d63ca-ae9d-49f5-bd71-60de8fc453ed","modified":"2024-02-26T03:19:33.2909876+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}
Mime type: application/json 
{
  "resourceType": "icarCarcassObservationsEventResource",
  "carcass": {
    "resourceType": "icarCarcassType",
    "processingLot": {
      "id": "d136ee1b-63da-4f1b-a9ef-59e2229967af",
      "name": "025-017",
      "chain": {
        "plant": {
          "interests": [],
          "name": "KBL Meat Processors",
          "leiCode": "123456L00AB00ABC0A00"
        },
        "chainId": "B03",
        "chainProcess": "PostMortem"
      },
      "killDateTime": "2023-01-25T09:45:00+00:00",
      "startBodyNumber": 1,
      "endBodyNumber": 80,
      "lotCount": 80,
      "targetMarket": "Export",
      "killType": "K7",
      "species": "Cattle",
      "consignment": {
        "id": {
          "id": "GB470",
          "scheme": "au.nlis.consign"
        },
        "originLocation": {
          "id": "au.nlis.pic",
          "scheme": "NS444999"
        },
        "destinationLocation": {
          "id": "ND250250",
          "scheme": "au.nlis.pic"
        },
        "loadingDateTime": "2022-10-12T08:15:00+00:00",
        "unloadingDateTime": "2022-10-12T14:27:00+00:00",
        "expectedDuration": 6,
        "transportOperator": "Gene Transport Pty Ltd",
        "vehicle": "74KHP3",
        "transportReference": "94-238",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "368HH",
          "scheme": "au.lpa.member"
        },
        "countConsigned": 80,
        "countReceived": 80,
        "hoursOffFeed": 6,
        "hoursOffWater": 6
      }
    },
    "killDateTime": "2023-01-25T09:45:00+00:00",
    "bodyNo": 379,
    "identifiers": [
      {
        "id": "au.kbl.id",
        "scheme": "380/547/38"
      }
    ],
    "sex": "Male",
    "birthDate": "2020-07-16T00:00:00+00:00",
    "birthDateConfidence": "AAU",
    "primaryBreed": {
      "id": "ANG",
      "scheme": "au.abri.breed"
    },
    "plantBoningRun": 17,
    "plantBoningRunTemplate": "ABC444",
    "destinationCode": "ABC12",
    "processorGrid": "XYZ-02"
  },
  "observations": [
    {
      "resourceType": "icarCarcassObservationType",
      "metric": {
        "id": {
          "id": "au.ausmeat.metric",
          "scheme": "hotCarcaseWt"
        },
        "method": "Weigh"
      },
      "value": 241.2,
      "units": "KGM",
      "observationStatus": "Measured"
    },
    {
      "resourceType": "icarCarcassObservationType",
      "metric": {
        "id": {
          "id": "au.ausmeat.metric",
          "scheme": "marbling"
        },
        "method": "Visual"
      },
      "value": 3.1,
      "observationStatus": "Calculated"
    }
  ],
  "side": "Left",
  "primal": "Hindquarter",
  "carcassState": "Hot",
  "device": {
    "resourceType": "icarDeviceResource",
    "id": "WS41",
    "serial": "TR546-973-7",
    "name": "Thermometer",
    "description": "Digital thermometer with probes",
    "softwareVersion": "5.4.0.1",
    "hardwareVersion": "3.37",
    "isActive": true,
    "supportedMessages": [
      {
        "messages": "Diagnoses"
      },
      {
        "messages": "Diagnoses"
      }
    ],
    "manufacturer": {
      "id": "thematicdevices.com",
      "deviceType": "Scales",
      "deviceName": "TR546"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "3FRPI065XBCD0071",
    "scheme": "au.nlis.animal"
  },
  "id": "023af539-ad76-40ab-a57b-f62b1458d732",
  "eventDateTime": "2022-10-13T07:58:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Cold carcase observations",
    "scheme": "au.ausmeat.traits"
  },
  "responsible": "Jimmy Brown",
  "contemporaryGroup": "BluesBrothersFarm",
  "remark": "Cold observations",
  "@self": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/163fde24-3139-4952-9768-5444bfc6f1c3",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.processco.carcass",
    "sourceId": "a28d63ca-ae9d-49f5-bd71-60de8fc453ed",
    "modified": "2024-02-26T03:19:33.2909876+00:00",
    "created": "2023-01-03T11:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "au.nlis.pic",
    "scheme": "3ABAB111"
  }
}
Mime type: text/json 
{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"d136ee1b-63da-4f1b-a9ef-59e2229967af","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"023af539-ad76-40ab-a57b-f62b1458d732","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/163fde24-3139-4952-9768-5444bfc6f1c3","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"a28d63ca-ae9d-49f5-bd71-60de8fc453ed","modified":"2024-02-26T03:19:33.2909876+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{HoldingId}/livestock/carcass/carcass-observations-event/{CarcassObservationsEventId}

Gets a specific carcass observation event by its PureFarming ID and Holding.

Request
GET /data/holdings/{HoldingId}/livestock/carcass/carcass-observations-event/{CarcassObservationsEventId}
Parameters
Name Type Default Notes
*HoldingId
*CarcassObservationsEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarCarcassObservationsEventResource

Success
Mime type: text/plain 
{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"e4345141-9e9d-444e-9cf8-ebc28781c7ea","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"d0d66c51-023b-42c3-8220-616346f44223","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/c0c2e80b-6748-4f9d-a6ec-528b6dd06445","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"d302855a-c4f8-4fc7-8c65-c5a019e8f671","modified":"2024-02-26T03:19:33.295764+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}
Mime type: application/json 
{
  "resourceType": "icarCarcassObservationsEventResource",
  "carcass": {
    "resourceType": "icarCarcassType",
    "processingLot": {
      "id": "e4345141-9e9d-444e-9cf8-ebc28781c7ea",
      "name": "025-017",
      "chain": {
        "plant": {
          "interests": [],
          "name": "KBL Meat Processors",
          "leiCode": "123456L00AB00ABC0A00"
        },
        "chainId": "B03",
        "chainProcess": "PostMortem"
      },
      "killDateTime": "2023-01-25T09:45:00+00:00",
      "startBodyNumber": 1,
      "endBodyNumber": 80,
      "lotCount": 80,
      "targetMarket": "Export",
      "killType": "K7",
      "species": "Cattle",
      "consignment": {
        "id": {
          "id": "GB470",
          "scheme": "au.nlis.consign"
        },
        "originLocation": {
          "id": "au.nlis.pic",
          "scheme": "NS444999"
        },
        "destinationLocation": {
          "id": "ND250250",
          "scheme": "au.nlis.pic"
        },
        "loadingDateTime": "2022-10-12T08:15:00+00:00",
        "unloadingDateTime": "2022-10-12T14:27:00+00:00",
        "expectedDuration": 6,
        "transportOperator": "Gene Transport Pty Ltd",
        "vehicle": "74KHP3",
        "transportReference": "94-238",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "368HH",
          "scheme": "au.lpa.member"
        },
        "countConsigned": 80,
        "countReceived": 80,
        "hoursOffFeed": 6,
        "hoursOffWater": 6
      }
    },
    "killDateTime": "2023-01-25T09:45:00+00:00",
    "bodyNo": 379,
    "identifiers": [
      {
        "id": "au.kbl.id",
        "scheme": "380/547/38"
      }
    ],
    "sex": "Male",
    "birthDate": "2020-07-16T00:00:00+00:00",
    "birthDateConfidence": "AAU",
    "primaryBreed": {
      "id": "ANG",
      "scheme": "au.abri.breed"
    },
    "plantBoningRun": 17,
    "plantBoningRunTemplate": "ABC444",
    "destinationCode": "ABC12",
    "processorGrid": "XYZ-02"
  },
  "observations": [
    {
      "resourceType": "icarCarcassObservationType",
      "metric": {
        "id": {
          "id": "au.ausmeat.metric",
          "scheme": "hotCarcaseWt"
        },
        "method": "Weigh"
      },
      "value": 241.2,
      "units": "KGM",
      "observationStatus": "Measured"
    },
    {
      "resourceType": "icarCarcassObservationType",
      "metric": {
        "id": {
          "id": "au.ausmeat.metric",
          "scheme": "marbling"
        },
        "method": "Visual"
      },
      "value": 3.1,
      "observationStatus": "Calculated"
    }
  ],
  "side": "Left",
  "primal": "Hindquarter",
  "carcassState": "Hot",
  "device": {
    "resourceType": "icarDeviceResource",
    "id": "WS41",
    "serial": "TR546-973-7",
    "name": "Thermometer",
    "description": "Digital thermometer with probes",
    "softwareVersion": "5.4.0.1",
    "hardwareVersion": "3.37",
    "isActive": true,
    "supportedMessages": [
      {
        "messages": "Diagnoses"
      },
      {
        "messages": "Diagnoses"
      }
    ],
    "manufacturer": {
      "id": "thematicdevices.com",
      "deviceType": "Scales",
      "deviceName": "TR546"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "3FRPI065XBCD0071",
    "scheme": "au.nlis.animal"
  },
  "id": "d0d66c51-023b-42c3-8220-616346f44223",
  "eventDateTime": "2022-10-13T07:58:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Cold carcase observations",
    "scheme": "au.ausmeat.traits"
  },
  "responsible": "Jimmy Brown",
  "contemporaryGroup": "BluesBrothersFarm",
  "remark": "Cold observations",
  "@self": "https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/c0c2e80b-6748-4f9d-a6ec-528b6dd06445",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.processco.carcass",
    "sourceId": "d302855a-c4f8-4fc7-8c65-c5a019e8f671",
    "modified": "2024-02-26T03:19:33.295764+00:00",
    "created": "2023-01-03T11:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "au.nlis.pic",
    "scheme": "3ABAB111"
  }
}
Mime type: text/json 
{"resourceType":"icarCarcassObservationsEventResource","carcass":{"resourceType":"icarCarcassType","processingLot":{"id":"e4345141-9e9d-444e-9cf8-ebc28781c7ea","name":"025-017","chain":{"plant":{"interests":[],"name":"KBL Meat Processors","leiCode":"123456L00AB00ABC0A00"},"chainId":"B03","chainProcess":"PostMortem"},"killDateTime":"2023-01-25T09:45:00+00:00","startBodyNumber":1,"endBodyNumber":80,"lotCount":80,"targetMarket":"Export","killType":"K7","species":"Cattle","consignment":{"id":{"id":"GB470","scheme":"au.nlis.consign"},"originLocation":{"id":"au.nlis.pic","scheme":"NS444999"},"destinationLocation":{"id":"ND250250","scheme":"au.nlis.pic"},"loadingDateTime":"2022-10-12T08:15:00+00:00","unloadingDateTime":"2022-10-12T14:27:00+00:00","expectedDuration":6.0,"transportOperator":"Gene Transport Pty Ltd","vehicle":"74KHP3","transportReference":"94-238","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"368HH","scheme":"au.lpa.member"},"countConsigned":80,"countReceived":80,"hoursOffFeed":6,"hoursOffWater":6}},"killDateTime":"2023-01-25T09:45:00+00:00","bodyNo":379,"identifiers":[{"id":"au.kbl.id","scheme":"380/547/38"}],"sex":"Male","birthDate":"2020-07-16T00:00:00+00:00","birthDateConfidence":"AAU","primaryBreed":{"id":"ANG","scheme":"au.abri.breed"},"plantBoningRun":17,"plantBoningRunTemplate":"ABC444","destinationCode":"ABC12","processorGrid":"XYZ-02"},"observations":[{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"hotCarcaseWt"},"method":"Weigh"},"value":241.2,"units":"KGM","observationStatus":"Measured"},{"resourceType":"icarCarcassObservationType","metric":{"id":{"id":"au.ausmeat.metric","scheme":"marbling"},"method":"Visual"},"value":3.1,"observationStatus":"Calculated"}],"side":"Left","primal":"Hindquarter","carcassState":"Hot","device":{"resourceType":"icarDeviceResource","id":"WS41","serial":"TR546-973-7","name":"Thermometer","description":"Digital thermometer with probes","softwareVersion":"5.4.0.1","hardwareVersion":"3.37","isActive":true,"supportedMessages":[{"messages":"Diagnoses"},{"messages":"Diagnoses"}],"manufacturer":{"id":"thematicdevices.com","deviceType":"Scales","deviceName":"TR546"}},"animal":{"resourceType":"icarIdentifierType","id":"3FRPI065XBCD0071","scheme":"au.nlis.animal"},"id":"d0d66c51-023b-42c3-8220-616346f44223","eventDateTime":"2022-10-13T07:58:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Cold carcase observations","scheme":"au.ausmeat.traits"},"responsible":"Jimmy Brown","contemporaryGroup":"BluesBrothersFarm","remark":"Cold observations","@self":"https://api.dev.purefarming.com/data/livestock/carcass/carcass-observation-events/c0c2e80b-6748-4f9d-a6ec-528b6dd06445","meta":{"resourceType":"icarMetaDataType","source":"nz.processco.carcass","sourceId":"d302855a-c4f8-4fc7-8c65-c5a019e8f671","modified":"2024-02-26T03:19:33.295764+00:00","created":"2023-01-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"au.nlis.pic","scheme":"3ABAB111"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Feed :: Group feeding events

GET data/livestock/feed/group-feeding-events

Gets all of the group feeding events the user has access to via pagination

Request
GET /data/livestock/feed/group-feeding-events[?limit&offset]
Parameters
Name Type Default Notes
limit

the maximum number of items per page
offset

the number of items offset from the start of the set for the current page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupFeedingEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1"},"items":[{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupFeedingEventResource",
      "feedingStartingDateTime": "2022-08-23T07:15:00+00:00",
      "feedVisitDuration": {
        "resourceType": "icarFeedDurationType",
        "unitCode": "MIN",
        "value": 35
      },
      "feedPerAnimal": [
        {
          "resourceType": "icarConsumedFeedType",
          "feedId": {
            "id": "Pasture",
            "scheme": "au.com.sf.feed"
          },
          "entitlement": {
            "unitCode": "KGM",
            "value": 21.3
          },
          "feedConsumption": {
            "unitCode": "KGM",
            "value": 19.1
          }
        }
      ],
      "rationPerAnimal": [
        {
          "resourceType": "icarConsumedRationType",
          "rationId": "Jacks Calf Pellets",
          "entitlement": {
            "unitCode": "GRM",
            "value": 200
          },
          "feedConsumption": {
            "unitCode": "GRM",
            "value": 195
          }
        }
      ],
      "device": {
        "resourceType": "icarDeviceReferenceType",
        "model": "Milk Easy 6 Teat Milk Feeder",
        "serial": "K15-8964-386",
        "identifier": {
          "id": "#923654",
          "scheme": "nz.co.stockandstation.feeders"
        },
        "reltype": "TechSheet",
        "href": "https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"
      },
      "groupMethod": "EmbeddedAnimalSet",
      "countObserved": 3,
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "7BGM333",
        "name": "Calves born 18 August 2022",
        "purpose": "Feeding",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "ABK779345",
            "scheme": "nz.minda"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "ABK779345",
            "scheme": "nz.minda"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "ABK779345",
            "scheme": "nz.minda"
          }
        ]
      },
      "id": "58b4a328-f802-446c-a366-d9c3a50d9294",
      "eventDateTime": "2022-08-23T07:50:00+00:00",
      "responsible": "Pip Pink",
      "remark": "New calves feeding 23 August 2022",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.bzagri.app",
        "sourceId": "5291984b-fc0c-424b-904a-9a2c2970aa90",
        "modified": "2022-08-24T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.govt.farmsonline"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1"},"items":[{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}]}

GET data/livestock/feed/group-feeding-events/{eventId}

Gets a single group feeding event by Id

Request
GET /data/livestock/feed/group-feeding-events/{eventId}
Parameters
Name Type Default Notes
*eventId

The Id of the group feeding event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupFeedingEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}
Mime type: application/json 
{
  "resourceType": "icarGroupFeedingEventResource",
  "feedingStartingDateTime": "2022-08-23T07:15:00+00:00",
  "feedVisitDuration": {
    "resourceType": "icarFeedDurationType",
    "unitCode": "MIN",
    "value": 35
  },
  "feedPerAnimal": [
    {
      "resourceType": "icarConsumedFeedType",
      "feedId": {
        "id": "Pasture",
        "scheme": "au.com.sf.feed"
      },
      "entitlement": {
        "unitCode": "KGM",
        "value": 21.3
      },
      "feedConsumption": {
        "unitCode": "KGM",
        "value": 19.1
      }
    }
  ],
  "rationPerAnimal": [
    {
      "resourceType": "icarConsumedRationType",
      "rationId": "Jacks Calf Pellets",
      "entitlement": {
        "unitCode": "GRM",
        "value": 200
      },
      "feedConsumption": {
        "unitCode": "GRM",
        "value": 195
      }
    }
  ],
  "device": {
    "resourceType": "icarDeviceReferenceType",
    "model": "Milk Easy 6 Teat Milk Feeder",
    "serial": "K15-8964-386",
    "identifier": {
      "id": "#923654",
      "scheme": "nz.co.stockandstation.feeders"
    },
    "reltype": "TechSheet",
    "href": "https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"
  },
  "groupMethod": "EmbeddedAnimalSet",
  "countObserved": 3,
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "7BGM333",
    "name": "Calves born 18 August 2022",
    "purpose": "Feeding",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "ABK779345",
        "scheme": "nz.minda"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "ABK779345",
        "scheme": "nz.minda"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "ABK779345",
        "scheme": "nz.minda"
      }
    ]
  },
  "id": "58b4a328-f802-446c-a366-d9c3a50d9294",
  "eventDateTime": "2022-08-23T07:50:00+00:00",
  "responsible": "Pip Pink",
  "remark": "New calves feeding 23 August 2022",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.bzagri.app",
    "sourceId": "5291984b-fc0c-424b-904a-9a2c2970aa90",
    "modified": "2022-08-24T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.govt.farmsonline"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/feed/group-feeding-events

Gets the group feeding events for a holding via pagination

Request
GET /data/holdings/{holdingId}/livestock/feed/group-feeding-events[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the group feeding events for
limit

the maximum number of group feeding events on a page
offset

the number of group feeding events in the total set before the first one on the page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupFeedingEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1"},"items":[{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupFeedingEventResource",
      "feedingStartingDateTime": "2022-08-23T07:15:00+00:00",
      "feedVisitDuration": {
        "resourceType": "icarFeedDurationType",
        "unitCode": "MIN",
        "value": 35
      },
      "feedPerAnimal": [
        {
          "resourceType": "icarConsumedFeedType",
          "feedId": {
            "id": "Pasture",
            "scheme": "au.com.sf.feed"
          },
          "entitlement": {
            "unitCode": "KGM",
            "value": 21.3
          },
          "feedConsumption": {
            "unitCode": "KGM",
            "value": 19.1
          }
        }
      ],
      "rationPerAnimal": [
        {
          "resourceType": "icarConsumedRationType",
          "rationId": "Jacks Calf Pellets",
          "entitlement": {
            "unitCode": "GRM",
            "value": 200
          },
          "feedConsumption": {
            "unitCode": "GRM",
            "value": 195
          }
        }
      ],
      "device": {
        "resourceType": "icarDeviceReferenceType",
        "model": "Milk Easy 6 Teat Milk Feeder",
        "serial": "K15-8964-386",
        "identifier": {
          "id": "#923654",
          "scheme": "nz.co.stockandstation.feeders"
        },
        "reltype": "TechSheet",
        "href": "https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"
      },
      "groupMethod": "EmbeddedAnimalSet",
      "countObserved": 3,
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "7BGM333",
        "name": "Calves born 18 August 2022",
        "purpose": "Feeding",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "ABK779345",
            "scheme": "nz.minda"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "ABK779345",
            "scheme": "nz.minda"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "ABK779345",
            "scheme": "nz.minda"
          }
        ]
      },
      "id": "58b4a328-f802-446c-a366-d9c3a50d9294",
      "eventDateTime": "2022-08-23T07:50:00+00:00",
      "responsible": "Pip Pink",
      "remark": "New calves feeding 23 August 2022",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.bzagri.app",
        "sourceId": "5291984b-fc0c-424b-904a-9a2c2970aa90",
        "modified": "2022-08-24T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.govt.farmsonline"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/feed/group-feeding-events?offset=0&limit=1"},"items":[{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}]}

GET data/holdings/{holdingId}/livestock/feed/group-feeding-events/{eventId}

Gets a single group feeding event with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/livestock/feed/group-feeding-events/{eventId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the group feeding event for
*eventId

The Id of the group feeding event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupFeedingEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}
Mime type: application/json 
{
  "resourceType": "icarGroupFeedingEventResource",
  "feedingStartingDateTime": "2022-08-23T07:15:00+00:00",
  "feedVisitDuration": {
    "resourceType": "icarFeedDurationType",
    "unitCode": "MIN",
    "value": 35
  },
  "feedPerAnimal": [
    {
      "resourceType": "icarConsumedFeedType",
      "feedId": {
        "id": "Pasture",
        "scheme": "au.com.sf.feed"
      },
      "entitlement": {
        "unitCode": "KGM",
        "value": 21.3
      },
      "feedConsumption": {
        "unitCode": "KGM",
        "value": 19.1
      }
    }
  ],
  "rationPerAnimal": [
    {
      "resourceType": "icarConsumedRationType",
      "rationId": "Jacks Calf Pellets",
      "entitlement": {
        "unitCode": "GRM",
        "value": 200
      },
      "feedConsumption": {
        "unitCode": "GRM",
        "value": 195
      }
    }
  ],
  "device": {
    "resourceType": "icarDeviceReferenceType",
    "model": "Milk Easy 6 Teat Milk Feeder",
    "serial": "K15-8964-386",
    "identifier": {
      "id": "#923654",
      "scheme": "nz.co.stockandstation.feeders"
    },
    "reltype": "TechSheet",
    "href": "https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"
  },
  "groupMethod": "EmbeddedAnimalSet",
  "countObserved": 3,
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "7BGM333",
    "name": "Calves born 18 August 2022",
    "purpose": "Feeding",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "ABK779345",
        "scheme": "nz.minda"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "ABK779345",
        "scheme": "nz.minda"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "ABK779345",
        "scheme": "nz.minda"
      }
    ]
  },
  "id": "58b4a328-f802-446c-a366-d9c3a50d9294",
  "eventDateTime": "2022-08-23T07:50:00+00:00",
  "responsible": "Pip Pink",
  "remark": "New calves feeding 23 August 2022",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.bzagri.app",
    "sourceId": "5291984b-fc0c-424b-904a-9a2c2970aa90",
    "modified": "2022-08-24T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.govt.farmsonline"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupFeedingEventResource","feedingStartingDateTime":"2022-08-23T07:15:00+00:00","feedVisitDuration":{"resourceType":"icarFeedDurationType","unitCode":"MIN","value":35.0},"feedPerAnimal":[{"resourceType":"icarConsumedFeedType","feedId":{"id":"Pasture","scheme":"au.com.sf.feed"},"entitlement":{"unitCode":"KGM","value":21.3},"feedConsumption":{"unitCode":"KGM","value":19.1}}],"rationPerAnimal":[{"resourceType":"icarConsumedRationType","rationId":"Jacks Calf Pellets","entitlement":{"unitCode":"GRM","value":200.0},"feedConsumption":{"unitCode":"GRM","value":195.0}}],"device":{"resourceType":"icarDeviceReferenceType","model":"Milk Easy 6 Teat Milk Feeder","serial":"K15-8964-386","identifier":{"id":"#923654","scheme":"nz.co.stockandstation.feeders"},"reltype":"TechSheet","href":"https://stockandstation.co.nz/catalog/milk-easy-6-teat-milk-feeder/923654"},"groupMethod":"EmbeddedAnimalSet","countObserved":3,"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGM333","name":"Calves born 18 August 2022","purpose":"Feeding","member":[{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"},{"resourceType":"icarIdentifierType","id":"ABK779345","scheme":"nz.minda"}]},"id":"58b4a328-f802-446c-a366-d9c3a50d9294","eventDateTime":"2022-08-23T07:50:00+00:00","responsible":"Pip Pink","remark":"New calves feeding 23 August 2022","meta":{"resourceType":"icarMetaDataType","source":"nz.bzagri.app","sourceId":"5291984b-fc0c-424b-904a-9a2c2970aa90","modified":"2022-08-24T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.govt.farmsonline"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Group labratory analyses events

GET data/livestock/group-laboratory-analyses-events

Gets all of the group laboratory analyses events the user has access to via pagination

Request
GET /data/livestock/group-laboratory-analyses-events[?limit&offset]
Parameters
Name Type Default Notes
limit

the maximum number of items per page
offset

the number of items offset from the start of the set for the current page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfGroupLaboratoryAnalysesEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1"},"items":[{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfGroupLaboratoryAnalysesEventResource",
      "sampleDate": "2023-01-03T11:00:00+00:00",
      "sampleType": "Milk",
      "analyses": [
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "name": "BestLabs Ltd."
          },
          "laboratoryIdentifier": "MK2810/01",
          "results": [
            {
              "name": "BVD Anitgen",
              "status": "belowLimit",
              "rawValue": "<45",
              "rawUnit": "CTV",
              "qualitativeGrade": "Negative",
              "limit": 45
            }
          ]
        },
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "name": "Dairy Laboratory Ltd"
          },
          "laboratoryIdentifier": "28778471",
          "results": [
            {
              "name": "Milk Solids",
              "status": "completed",
              "rawValue": "300",
              "rawUnit": "kg"
            }
          ]
        }
      ],
      "groupMethod": "InventoryClassification",
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Dairy",
        "count": 236,
        "species": "Cattle",
        "sex": "Female",
        "birthPeriod": "2016-01-01/2021-12-31"
      },
      "id": "adf6fbd9-0d65-4c3b-bb53-0216de82a666",
      "eventDateTime": "2023-01-04T12:00:00+00:00",
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1"},"items":[{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}]}

GET data/holdings/{holdingId}/livestock/group-laboratory-analyses-events

Gets the group laboratory analyses events for a holding via pagination

Request
GET /data/holdings/{holdingId}/livestock/group-laboratory-analyses-events[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the group laboratory analyses events for
limit

the maximum number of group laboratory analyses events on a page
offset

the number of group laboratory analyses events in the total set before the first one on the page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfGroupLaboratoryAnalysesEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1"},"items":[{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfGroupLaboratoryAnalysesEventResource",
      "sampleDate": "2023-01-03T11:00:00+00:00",
      "sampleType": "Milk",
      "analyses": [
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "name": "BestLabs Ltd."
          },
          "laboratoryIdentifier": "MK2810/01",
          "results": [
            {
              "name": "BVD Anitgen",
              "status": "belowLimit",
              "rawValue": "<45",
              "rawUnit": "CTV",
              "qualitativeGrade": "Negative",
              "limit": 45
            }
          ]
        },
        {
          "resourceType": "pfLaboratoryAnalysisType",
          "laboratory": {
            "name": "Dairy Laboratory Ltd"
          },
          "laboratoryIdentifier": "28778471",
          "results": [
            {
              "name": "Milk Solids",
              "status": "completed",
              "rawValue": "300",
              "rawUnit": "kg"
            }
          ]
        }
      ],
      "groupMethod": "InventoryClassification",
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Dairy",
        "count": 236,
        "species": "Cattle",
        "sex": "Female",
        "birthPeriod": "2016-01-01/2021-12-31"
      },
      "id": "adf6fbd9-0d65-4c3b-bb53-0216de82a666",
      "eventDateTime": "2023-01-04T12:00:00+00:00",
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "au.nlis.pic"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/group-laboratory-analyses-events?offset=0&limit=1"},"items":[{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}]}

GET data/livestock/group-laboratory-analyses-events/{eventId}

Gets a single group laboratory analyses event by Id

Request
GET /data/livestock/group-laboratory-analyses-events/{eventId}
Parameters
Name Type Default Notes
*eventId

The Id of the group laboratory analyses to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfGroupLaboratoryAnalysesEventResource

Success
Mime type: text/plain 
{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "pfGroupLaboratoryAnalysesEventResource",
  "sampleDate": "2023-01-03T11:00:00+00:00",
  "sampleType": "Milk",
  "analyses": [
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "name": "BestLabs Ltd."
      },
      "laboratoryIdentifier": "MK2810/01",
      "results": [
        {
          "name": "BVD Anitgen",
          "status": "belowLimit",
          "rawValue": "<45",
          "rawUnit": "CTV",
          "qualitativeGrade": "Negative",
          "limit": 45
        }
      ]
    },
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "name": "Dairy Laboratory Ltd"
      },
      "laboratoryIdentifier": "28778471",
      "results": [
        {
          "name": "Milk Solids",
          "status": "completed",
          "rawValue": "300",
          "rawUnit": "kg"
        }
      ]
    }
  ],
  "groupMethod": "InventoryClassification",
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Dairy",
    "count": 236,
    "species": "Cattle",
    "sex": "Female",
    "birthPeriod": "2016-01-01/2021-12-31"
  },
  "id": "adf6fbd9-0d65-4c3b-bb53-0216de82a666",
  "eventDateTime": "2023-01-04T12:00:00+00:00",
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/group-laboratory-analyses-events/{eventId}

Gets a single group laboratory analyses event with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/livestock/group-laboratory-analyses-events/{eventId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the group laboratory analyses event for
*eventId

The Id of the group laboratory analyses event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfGroupLaboratoryAnalysesEventResource

Success
Mime type: text/plain 
{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "pfGroupLaboratoryAnalysesEventResource",
  "sampleDate": "2023-01-03T11:00:00+00:00",
  "sampleType": "Milk",
  "analyses": [
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "name": "BestLabs Ltd."
      },
      "laboratoryIdentifier": "MK2810/01",
      "results": [
        {
          "name": "BVD Anitgen",
          "status": "belowLimit",
          "rawValue": "<45",
          "rawUnit": "CTV",
          "qualitativeGrade": "Negative",
          "limit": 45
        }
      ]
    },
    {
      "resourceType": "pfLaboratoryAnalysisType",
      "laboratory": {
        "name": "Dairy Laboratory Ltd"
      },
      "laboratoryIdentifier": "28778471",
      "results": [
        {
          "name": "Milk Solids",
          "status": "completed",
          "rawValue": "300",
          "rawUnit": "kg"
        }
      ]
    }
  ],
  "groupMethod": "InventoryClassification",
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Dairy",
    "count": 236,
    "species": "Cattle",
    "sex": "Female",
    "birthPeriod": "2016-01-01/2021-12-31"
  },
  "id": "adf6fbd9-0d65-4c3b-bb53-0216de82a666",
  "eventDateTime": "2023-01-04T12:00:00+00:00",
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"pfGroupLaboratoryAnalysesEventResource","sampleDate":"2023-01-03T11:00:00+00:00","sampleType":"Milk","analyses":[{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"BestLabs Ltd."},"laboratoryIdentifier":"MK2810/01","results":[{"name":"BVD Anitgen","status":"belowLimit","rawValue":"<45","rawUnit":"CTV","qualitativeGrade":"Negative","limit":45.0}]},{"resourceType":"pfLaboratoryAnalysisType","laboratory":{"name":"Dairy Laboratory Ltd"},"laboratoryIdentifier":"28778471","results":[{"name":"Milk Solids","status":"completed","rawValue":"300","rawUnit":"kg"}]}],"groupMethod":"InventoryClassification","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Dairy","count":236.0,"species":"Cattle","sex":"Female","birthPeriod":"2016-01-01/2021-12-31"},"id":"adf6fbd9-0d65-4c3b-bb53-0216de82a666","eventDateTime":"2023-01-04T12:00:00+00:00","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"au.nlis.pic"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Animal arrivals

GET data/livestock/movement/animal-arrivals

Gets all of the arrival events you have permissions for

Request
GET /data/livestock/movement/animal-arrivals[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit
offset
animalIdentifier
animalIdentifierScheme
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementArrivalEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1"},"items":[{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/7cd1bd69-407b-420b-bedf-e89e5003be28","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"8896d4ea-acb4-45e1-9c47-ad5a42c29d71","modified":"2024-02-26T03:19:33.3964044+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"dfb7c1d1-2540-46b2-b5a8-239423050319","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/dfb7c1d1-2540-46b2-b5a8-239423050319","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"e6640769-487b-47f4-a745-aca0702addf6","modified":"2024-02-26T03:19:33.4004831+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMovementArrivalEventResource",
      "arrivalReason": "StudService",
      "animalDetail": {
        "resourceType": "icarAnimalCoreResource",
        "identifier": {
          "resourceType": "icarIdentifierType",
          "id": "982 123477466062",
          "scheme": "au.nlis"
        },
        "alternativeIdentifiers": [
          {
            "resourceType": "icarIdentifierType",
            "id": "3ABAB111",
            "scheme": "au.nlis.visual"
          }
        ],
        "specie": "Cattle",
        "gender": "Female",
        "birthDate": "2020-07-10T00:00:00+00:00",
        "primaryBreed": {
          "resourceType": "icarIdentifierType",
          "id": "FF",
          "scheme": "au.nlis.breed"
        },
        "breedFractions": {
          "resourceType": "icarBreedFractionsType",
          "denominator": 16,
          "fractions": [
            {
              "breed": {
                "id": "FF",
                "scheme": "au.nlis.breed"
              },
              "fraction": 15
            },
            {
              "breed": {
                "id": "JJ",
                "scheme": "au.nlis.breed"
              },
              "fraction": 1
            }
          ]
        },
        "coatColor": "Black",
        "coatColorIdentifier": {
          "resourceType": "icarIdentifierType",
          "id": "12435",
          "scheme": "mock.color.scheme"
        },
        "managementTag": "44562",
        "name": "Sally",
        "officialName": "Waringa Supreme Sally",
        "productionPurpose": "Milk",
        "status": "Alive",
        "reproductionStatus": "Open",
        "lactationStatus": "Lactating",
        "parentage": [
          {
            "resourceType": "icarParentageType",
            "parentOf": {
              "id": "931 123477466011",
              "scheme": "au.nlis"
            },
            "gender": "Male",
            "relation": "Genetic",
            "identifier": {
              "id": "911 111111",
              "scheme": "au.nlis"
            },
            "officialName": "mock name sire"
          },
          {
            "resourceType": "icarParentageType",
            "parentOf": {
              "id": "931 123477466011",
              "scheme": "au.nlis"
            },
            "gender": "Female",
            "relation": "Genetic",
            "identifier": {
              "id": "911 222222",
              "scheme": "au.nlis"
            },
            "officialName": "mock name dam"
          },
          {
            "resourceType": "icarParentageType",
            "parentOf": {
              "id": "911 222222",
              "scheme": "au.nlis"
            },
            "gender": "Female",
            "relation": "Genetic",
            "identifier": {
              "id": "910 333333",
              "scheme": "au.nlis"
            },
            "officialName": "mock name dam of dam"
          }
        ],
        "healthStatus": "Healthy",
        "@self": "https://api.dev.purefarming.com/data/livestock/animals/7cd1bd69-407b-420b-bedf-e89e5003be28",
        "meta": {
          "resourceType": "icarMetaDataType",
          "source": "com.purefarming.ingestor.animal",
          "sourceId": "8896d4ea-acb4-45e1-9c47-ad5a42c29d71",
          "modified": "2024-02-26T03:19:33.3964044+00:00",
          "created": "2022-10-01T19:49:34+00:00"
        },
        "location": {
          "resourceType": "icarIdentifierType",
          "id": "3ABZF222",
          "scheme": "au.nlis.pic"
        }
      },
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "VVF37555",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "11111",
          "scheme": "nz.nait.pica-location"
        },
        "originPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "destinationLocation": {
          "id": "42424",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "750 Bushy Road, RD17, Katikati",
        "loadingDateTime": "2022-08-14T07:12:00+00:00",
        "unloadingDateTime": "2022-08-14T13:24:00+00:00",
        "expectedDuration": 6.2,
        "transportOperator": "Katikati Transport Ltd",
        "vehicle": "JWL387",
        "transportReference": "OT55-782",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "nz.mpi.ar"
        }
      },
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "982 123477466062",
        "scheme": "au.nlis"
      },
      "id": "dfb7c1d1-2540-46b2-b5a8-239423050319",
      "eventDateTime": "2022-09-13T12:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Arrival",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Ron Ardern",
      "contemporaryGroup": "Calving heifers",
      "remark": "Omokoroa heifer sale",
      "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/dfb7c1d1-2540-46b2-b5a8-239423050319",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "e6640769-487b-47f4-a745-aca0702addf6",
        "modified": "2024-02-26T03:19:33.4004831+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11888",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1"},"items":[{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/7cd1bd69-407b-420b-bedf-e89e5003be28","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"8896d4ea-acb4-45e1-9c47-ad5a42c29d71","modified":"2024-02-26T03:19:33.3964044+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"dfb7c1d1-2540-46b2-b5a8-239423050319","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/dfb7c1d1-2540-46b2-b5a8-239423050319","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"e6640769-487b-47f4-a745-aca0702addf6","modified":"2024-02-26T03:19:33.4004831+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/animal-arrivals

Gets all of the arrival events for the specified holding

Request
GET /data/holdings/{holdingId}/livestock/movement/animal-arrivals[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementArrivalEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1"},"items":[{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/4f7ee166-f6ec-425c-a5be-dac7b7e37bfb","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"eb61825b-1feb-44bc-8d9b-7b428acf503f","modified":"2024-02-26T03:19:33.4680911+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"8b9150ea-c1c4-44bf-858b-644f7d237ed7","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/8b9150ea-c1c4-44bf-858b-644f7d237ed7","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"9216c229-6c25-4974-96b0-ba62693b9e26","modified":"2024-02-26T03:19:33.474377+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMovementArrivalEventResource",
      "arrivalReason": "StudService",
      "animalDetail": {
        "resourceType": "icarAnimalCoreResource",
        "identifier": {
          "resourceType": "icarIdentifierType",
          "id": "982 123477466062",
          "scheme": "au.nlis"
        },
        "alternativeIdentifiers": [
          {
            "resourceType": "icarIdentifierType",
            "id": "3ABAB111",
            "scheme": "au.nlis.visual"
          }
        ],
        "specie": "Cattle",
        "gender": "Female",
        "birthDate": "2020-07-10T00:00:00+00:00",
        "primaryBreed": {
          "resourceType": "icarIdentifierType",
          "id": "FF",
          "scheme": "au.nlis.breed"
        },
        "breedFractions": {
          "resourceType": "icarBreedFractionsType",
          "denominator": 16,
          "fractions": [
            {
              "breed": {
                "id": "FF",
                "scheme": "au.nlis.breed"
              },
              "fraction": 15
            },
            {
              "breed": {
                "id": "JJ",
                "scheme": "au.nlis.breed"
              },
              "fraction": 1
            }
          ]
        },
        "coatColor": "Black",
        "coatColorIdentifier": {
          "resourceType": "icarIdentifierType",
          "id": "12435",
          "scheme": "mock.color.scheme"
        },
        "managementTag": "44562",
        "name": "Sally",
        "officialName": "Waringa Supreme Sally",
        "productionPurpose": "Milk",
        "status": "Alive",
        "reproductionStatus": "Open",
        "lactationStatus": "Lactating",
        "parentage": [
          {
            "resourceType": "icarParentageType",
            "parentOf": {
              "id": "931 123477466011",
              "scheme": "au.nlis"
            },
            "gender": "Male",
            "relation": "Genetic",
            "identifier": {
              "id": "911 111111",
              "scheme": "au.nlis"
            },
            "officialName": "mock name sire"
          },
          {
            "resourceType": "icarParentageType",
            "parentOf": {
              "id": "931 123477466011",
              "scheme": "au.nlis"
            },
            "gender": "Female",
            "relation": "Genetic",
            "identifier": {
              "id": "911 222222",
              "scheme": "au.nlis"
            },
            "officialName": "mock name dam"
          },
          {
            "resourceType": "icarParentageType",
            "parentOf": {
              "id": "911 222222",
              "scheme": "au.nlis"
            },
            "gender": "Female",
            "relation": "Genetic",
            "identifier": {
              "id": "910 333333",
              "scheme": "au.nlis"
            },
            "officialName": "mock name dam of dam"
          }
        ],
        "healthStatus": "Healthy",
        "@self": "https://api.dev.purefarming.com/data/livestock/animals/4f7ee166-f6ec-425c-a5be-dac7b7e37bfb",
        "meta": {
          "resourceType": "icarMetaDataType",
          "source": "com.purefarming.ingestor.animal",
          "sourceId": "eb61825b-1feb-44bc-8d9b-7b428acf503f",
          "modified": "2024-02-26T03:19:33.4680911+00:00",
          "created": "2022-10-01T19:49:34+00:00"
        },
        "location": {
          "resourceType": "icarIdentifierType",
          "id": "3ABZF222",
          "scheme": "au.nlis.pic"
        }
      },
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "VVF37555",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "11111",
          "scheme": "nz.nait.pica-location"
        },
        "originPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "destinationLocation": {
          "id": "42424",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "750 Bushy Road, RD17, Katikati",
        "loadingDateTime": "2022-08-14T07:12:00+00:00",
        "unloadingDateTime": "2022-08-14T13:24:00+00:00",
        "expectedDuration": 6.2,
        "transportOperator": "Katikati Transport Ltd",
        "vehicle": "JWL387",
        "transportReference": "OT55-782",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "nz.mpi.ar"
        }
      },
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "982 123477466062",
        "scheme": "au.nlis"
      },
      "id": "8b9150ea-c1c4-44bf-858b-644f7d237ed7",
      "eventDateTime": "2022-09-13T12:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Arrival",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Ron Ardern",
      "contemporaryGroup": "Calving heifers",
      "remark": "Omokoroa heifer sale",
      "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/8b9150ea-c1c4-44bf-858b-644f7d237ed7",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "9216c229-6c25-4974-96b0-ba62693b9e26",
        "modified": "2024-02-26T03:19:33.474377+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11888",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals?offset=0&limit=1"},"items":[{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/4f7ee166-f6ec-425c-a5be-dac7b7e37bfb","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"eb61825b-1feb-44bc-8d9b-7b428acf503f","modified":"2024-02-26T03:19:33.4680911+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"8b9150ea-c1c4-44bf-858b-644f7d237ed7","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/8b9150ea-c1c4-44bf-858b-644f7d237ed7","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"9216c229-6c25-4974-96b0-ba62693b9e26","modified":"2024-02-26T03:19:33.474377+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/animal-arrivals/{arrivalId}

Gets the specified arrival event for the specified holding

Request
GET /data/holdings/{holdingId}/livestock/movement/animal-arrivals/{arrivalId}
Parameters
Name Type Default Notes
*holdingId
*arrivalId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementArrivalEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/3d04f772-4e2f-4a9c-b5e6-0558215fd291","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"e5a6fe33-570f-424d-b70e-88270b52d6f3","modified":"2024-02-26T03:19:33.5627562+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"9ff6bdaf-94f1-44aa-beb8-6a7dfbda9bbb","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/9ff6bdaf-94f1-44aa-beb8-6a7dfbda9bbb","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"7e527eac-5a42-45f9-82d0-31ba31dfd3a3","modified":"2024-02-26T03:19:33.5689454+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarMovementArrivalEventResource",
  "arrivalReason": "StudService",
  "animalDetail": {
    "resourceType": "icarAnimalCoreResource",
    "identifier": {
      "resourceType": "icarIdentifierType",
      "id": "982 123477466062",
      "scheme": "au.nlis"
    },
    "alternativeIdentifiers": [
      {
        "resourceType": "icarIdentifierType",
        "id": "3ABAB111",
        "scheme": "au.nlis.visual"
      }
    ],
    "specie": "Cattle",
    "gender": "Female",
    "birthDate": "2020-07-10T00:00:00+00:00",
    "primaryBreed": {
      "resourceType": "icarIdentifierType",
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "breedFractions": {
      "resourceType": "icarBreedFractionsType",
      "denominator": 16,
      "fractions": [
        {
          "breed": {
            "id": "FF",
            "scheme": "au.nlis.breed"
          },
          "fraction": 15
        },
        {
          "breed": {
            "id": "JJ",
            "scheme": "au.nlis.breed"
          },
          "fraction": 1
        }
      ]
    },
    "coatColor": "Black",
    "coatColorIdentifier": {
      "resourceType": "icarIdentifierType",
      "id": "12435",
      "scheme": "mock.color.scheme"
    },
    "managementTag": "44562",
    "name": "Sally",
    "officialName": "Waringa Supreme Sally",
    "productionPurpose": "Milk",
    "status": "Alive",
    "reproductionStatus": "Open",
    "lactationStatus": "Lactating",
    "parentage": [
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Male",
        "relation": "Genetic",
        "identifier": {
          "id": "911 111111",
          "scheme": "au.nlis"
        },
        "officialName": "mock name sire"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "910 333333",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam of dam"
      }
    ],
    "healthStatus": "Healthy",
    "@self": "https://api.dev.purefarming.com/data/livestock/animals/3d04f772-4e2f-4a9c-b5e6-0558215fd291",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.animal",
      "sourceId": "e5a6fe33-570f-424d-b70e-88270b52d6f3",
      "modified": "2024-02-26T03:19:33.5627562+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "3ABZF222",
      "scheme": "au.nlis.pic"
    }
  },
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "VVF37555",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "11111",
      "scheme": "nz.nait.pica-location"
    },
    "originPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "destinationLocation": {
      "id": "42424",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "750 Bushy Road, RD17, Katikati",
    "loadingDateTime": "2022-08-14T07:12:00+00:00",
    "unloadingDateTime": "2022-08-14T13:24:00+00:00",
    "expectedDuration": 6.2,
    "transportOperator": "Katikati Transport Ltd",
    "vehicle": "JWL387",
    "transportReference": "OT55-782",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "nz.mpi.ar"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "982 123477466062",
    "scheme": "au.nlis"
  },
  "id": "9ff6bdaf-94f1-44aa-beb8-6a7dfbda9bbb",
  "eventDateTime": "2022-09-13T12:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Arrival",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Ron Ardern",
  "contemporaryGroup": "Calving heifers",
  "remark": "Omokoroa heifer sale",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/9ff6bdaf-94f1-44aa-beb8-6a7dfbda9bbb",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "7e527eac-5a42-45f9-82d0-31ba31dfd3a3",
    "modified": "2024-02-26T03:19:33.5689454+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11888",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/3d04f772-4e2f-4a9c-b5e6-0558215fd291","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"e5a6fe33-570f-424d-b70e-88270b52d6f3","modified":"2024-02-26T03:19:33.5627562+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"9ff6bdaf-94f1-44aa-beb8-6a7dfbda9bbb","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/9ff6bdaf-94f1-44aa-beb8-6a7dfbda9bbb","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"7e527eac-5a42-45f9-82d0-31ba31dfd3a3","modified":"2024-02-26T03:19:33.5689454+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/livestock/movement/animal-arrivals/{arrivalId}

Gets the specified arrival event

Request
GET /data/livestock/movement/animal-arrivals/{arrivalId}
Parameters
Name Type Default Notes
*arrivalId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementArrivalEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/04992e4e-907a-46b6-aa5d-46b3827411ab","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"b9fa45a5-b155-41a8-8077-1f7d1f160169","modified":"2024-02-26T03:19:33.5939097+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"a7cc8258-ad54-400b-87b1-213f17ee780d","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/a7cc8258-ad54-400b-87b1-213f17ee780d","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"30f0003e-dda4-474a-b651-9c2ed46c02b3","modified":"2024-02-26T03:19:33.6587753+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarMovementArrivalEventResource",
  "arrivalReason": "StudService",
  "animalDetail": {
    "resourceType": "icarAnimalCoreResource",
    "identifier": {
      "resourceType": "icarIdentifierType",
      "id": "982 123477466062",
      "scheme": "au.nlis"
    },
    "alternativeIdentifiers": [
      {
        "resourceType": "icarIdentifierType",
        "id": "3ABAB111",
        "scheme": "au.nlis.visual"
      }
    ],
    "specie": "Cattle",
    "gender": "Female",
    "birthDate": "2020-07-10T00:00:00+00:00",
    "primaryBreed": {
      "resourceType": "icarIdentifierType",
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "breedFractions": {
      "resourceType": "icarBreedFractionsType",
      "denominator": 16,
      "fractions": [
        {
          "breed": {
            "id": "FF",
            "scheme": "au.nlis.breed"
          },
          "fraction": 15
        },
        {
          "breed": {
            "id": "JJ",
            "scheme": "au.nlis.breed"
          },
          "fraction": 1
        }
      ]
    },
    "coatColor": "Black",
    "coatColorIdentifier": {
      "resourceType": "icarIdentifierType",
      "id": "12435",
      "scheme": "mock.color.scheme"
    },
    "managementTag": "44562",
    "name": "Sally",
    "officialName": "Waringa Supreme Sally",
    "productionPurpose": "Milk",
    "status": "Alive",
    "reproductionStatus": "Open",
    "lactationStatus": "Lactating",
    "parentage": [
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Male",
        "relation": "Genetic",
        "identifier": {
          "id": "911 111111",
          "scheme": "au.nlis"
        },
        "officialName": "mock name sire"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "910 333333",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam of dam"
      }
    ],
    "healthStatus": "Healthy",
    "@self": "https://api.dev.purefarming.com/data/livestock/animals/04992e4e-907a-46b6-aa5d-46b3827411ab",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.animal",
      "sourceId": "b9fa45a5-b155-41a8-8077-1f7d1f160169",
      "modified": "2024-02-26T03:19:33.5939097+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "3ABZF222",
      "scheme": "au.nlis.pic"
    }
  },
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "VVF37555",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "11111",
      "scheme": "nz.nait.pica-location"
    },
    "originPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "destinationLocation": {
      "id": "42424",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "750 Bushy Road, RD17, Katikati",
    "loadingDateTime": "2022-08-14T07:12:00+00:00",
    "unloadingDateTime": "2022-08-14T13:24:00+00:00",
    "expectedDuration": 6.2,
    "transportOperator": "Katikati Transport Ltd",
    "vehicle": "JWL387",
    "transportReference": "OT55-782",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "nz.mpi.ar"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "982 123477466062",
    "scheme": "au.nlis"
  },
  "id": "a7cc8258-ad54-400b-87b1-213f17ee780d",
  "eventDateTime": "2022-09-13T12:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Arrival",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Ron Ardern",
  "contemporaryGroup": "Calving heifers",
  "remark": "Omokoroa heifer sale",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/a7cc8258-ad54-400b-87b1-213f17ee780d",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "30f0003e-dda4-474a-b651-9c2ed46c02b3",
    "modified": "2024-02-26T03:19:33.6587753+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11888",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarMovementArrivalEventResource","arrivalReason":"StudService","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/04992e4e-907a-46b6-aa5d-46b3827411ab","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"b9fa45a5-b155-41a8-8077-1f7d1f160169","modified":"2024-02-26T03:19:33.5939097+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"a7cc8258-ad54-400b-87b1-213f17ee780d","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"nz.minda.trait"},"responsible":"Ron Ardern","contemporaryGroup":"Calving heifers","remark":"Omokoroa heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-arrivals/a7cc8258-ad54-400b-87b1-213f17ee780d","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"30f0003e-dda4-474a-b651-9c2ed46c02b3","modified":"2024-02-26T03:19:33.6587753+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11888","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Animal birth registrations

GET data/livestock/movement/animal-birth-registrations

Returns all of the animal birth registrations that a user has access to, regardless of holding

Request
GET /data/livestock/movement/animal-birth-registrations[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementBirthEventResource]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{HoldingId}/livestock/movement/animal-birth-registrations

Returns all of the animal birth registrations attached to the given holding

Request
GET /data/holdings/{HoldingId}/livestock/movement/animal-birth-registrations[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*HoldingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementBirthEventResource]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/livestock/movement/animal-birth-registrations/{AnimalBirthRegId}

Returns the details for the given animal birth registration

Request
GET /data/livestock/movement/animal-birth-registrations/{AnimalBirthRegId}
Parameters
Name Type Default Notes
*AnimalBirthRegId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementBirthEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementBirthEventResource","registrationReason":"Registered","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/b57b0f08-74a5-4542-a58b-9ad492f99dbf","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"ee8d0e88-b833-4182-b388-d112eb52311c","modified":"2024-02-26T03:19:33.682702+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"d854c616-3c16-422d-ab86-dbc2b6d4894a","eventDateTime":"2024-02-26T03:19:33.6866958+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2022 heifer calves","remark":"Easy birth","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-birth-registrations/d854c616-3c16-422d-ab86-dbc2b6d4894a","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"155a64f5-a52d-4e3c-ba88-63a123f848fc","modified":"2024-02-26T03:19:33.6866989+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarMovementBirthEventResource",
  "registrationReason": "Registered",
  "animalDetail": {
    "resourceType": "icarAnimalCoreResource",
    "identifier": {
      "resourceType": "icarIdentifierType",
      "id": "982 123477466062",
      "scheme": "au.nlis"
    },
    "alternativeIdentifiers": [
      {
        "resourceType": "icarIdentifierType",
        "id": "3ABAB111",
        "scheme": "au.nlis.visual"
      }
    ],
    "specie": "Cattle",
    "gender": "Female",
    "birthDate": "2020-07-10T00:00:00+00:00",
    "primaryBreed": {
      "resourceType": "icarIdentifierType",
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "breedFractions": {
      "resourceType": "icarBreedFractionsType",
      "denominator": 16,
      "fractions": [
        {
          "breed": {
            "id": "FF",
            "scheme": "au.nlis.breed"
          },
          "fraction": 15
        },
        {
          "breed": {
            "id": "JJ",
            "scheme": "au.nlis.breed"
          },
          "fraction": 1
        }
      ]
    },
    "coatColor": "Black",
    "coatColorIdentifier": {
      "resourceType": "icarIdentifierType",
      "id": "12435",
      "scheme": "mock.color.scheme"
    },
    "managementTag": "44562",
    "name": "Sally",
    "officialName": "Waringa Supreme Sally",
    "productionPurpose": "Milk",
    "status": "Alive",
    "reproductionStatus": "Open",
    "lactationStatus": "Lactating",
    "parentage": [
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Male",
        "relation": "Genetic",
        "identifier": {
          "id": "911 111111",
          "scheme": "au.nlis"
        },
        "officialName": "mock name sire"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "910 333333",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam of dam"
      }
    ],
    "healthStatus": "Healthy",
    "@self": "https://api.dev.purefarming.com/data/livestock/animals/b57b0f08-74a5-4542-a58b-9ad492f99dbf",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.animal",
      "sourceId": "ee8d0e88-b833-4182-b388-d112eb52311c",
      "modified": "2024-02-26T03:19:33.682702+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "3ABZF222",
      "scheme": "au.nlis.pic"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "982 123477466062",
    "scheme": "au.nlis"
  },
  "id": "d854c616-3c16-422d-ab86-dbc2b6d4894a",
  "eventDateTime": "2024-02-26T03:19:33.6866958+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Birth",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Don Harris",
  "contemporaryGroup": "2022 heifer calves",
  "remark": "Easy birth",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-birth-registrations/d854c616-3c16-422d-ab86-dbc2b6d4894a",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "155a64f5-a52d-4e3c-ba88-63a123f848fc",
    "modified": "2024-02-26T03:19:33.6866989+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABZF222",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarMovementBirthEventResource","registrationReason":"Registered","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/b57b0f08-74a5-4542-a58b-9ad492f99dbf","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"ee8d0e88-b833-4182-b388-d112eb52311c","modified":"2024-02-26T03:19:33.682702+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"d854c616-3c16-422d-ab86-dbc2b6d4894a","eventDateTime":"2024-02-26T03:19:33.6866958+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2022 heifer calves","remark":"Easy birth","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-birth-registrations/d854c616-3c16-422d-ab86-dbc2b6d4894a","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"155a64f5-a52d-4e3c-ba88-63a123f848fc","modified":"2024-02-26T03:19:33.6866989+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{HoldingId}/livestock/movement/animal-birth-registrations/{AnimalBirthRegId}

Returns the details for the given animal birth registration

Request
GET /data/holdings/{HoldingId}/livestock/movement/animal-birth-registrations/{AnimalBirthRegId}
Parameters
Name Type Default Notes
*HoldingId

The holding to fetch a birth registration for.
*AnimalBirthRegId

The individual birth registration to fetch.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementBirthEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementBirthEventResource","registrationReason":"Registered","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/2331c2b9-f8c5-41cf-b2df-4bdc25efd6a3","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"f690b854-9f4f-4093-af22-81d6700f25fc","modified":"2024-02-26T03:19:33.7021576+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"4e33a7fe-e882-45bc-bd8c-72be139d49bc","eventDateTime":"2024-02-26T03:19:33.7061394+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2022 heifer calves","remark":"Easy birth","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-birth-registrations/4e33a7fe-e882-45bc-bd8c-72be139d49bc","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"2e04664b-b8a2-4f25-bdfc-6b5e45352856","modified":"2024-02-26T03:19:33.7061426+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarMovementBirthEventResource",
  "registrationReason": "Registered",
  "animalDetail": {
    "resourceType": "icarAnimalCoreResource",
    "identifier": {
      "resourceType": "icarIdentifierType",
      "id": "982 123477466062",
      "scheme": "au.nlis"
    },
    "alternativeIdentifiers": [
      {
        "resourceType": "icarIdentifierType",
        "id": "3ABAB111",
        "scheme": "au.nlis.visual"
      }
    ],
    "specie": "Cattle",
    "gender": "Female",
    "birthDate": "2020-07-10T00:00:00+00:00",
    "primaryBreed": {
      "resourceType": "icarIdentifierType",
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "breedFractions": {
      "resourceType": "icarBreedFractionsType",
      "denominator": 16,
      "fractions": [
        {
          "breed": {
            "id": "FF",
            "scheme": "au.nlis.breed"
          },
          "fraction": 15
        },
        {
          "breed": {
            "id": "JJ",
            "scheme": "au.nlis.breed"
          },
          "fraction": 1
        }
      ]
    },
    "coatColor": "Black",
    "coatColorIdentifier": {
      "resourceType": "icarIdentifierType",
      "id": "12435",
      "scheme": "mock.color.scheme"
    },
    "managementTag": "44562",
    "name": "Sally",
    "officialName": "Waringa Supreme Sally",
    "productionPurpose": "Milk",
    "status": "Alive",
    "reproductionStatus": "Open",
    "lactationStatus": "Lactating",
    "parentage": [
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Male",
        "relation": "Genetic",
        "identifier": {
          "id": "911 111111",
          "scheme": "au.nlis"
        },
        "officialName": "mock name sire"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "931 123477466011",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam"
      },
      {
        "resourceType": "icarParentageType",
        "parentOf": {
          "id": "911 222222",
          "scheme": "au.nlis"
        },
        "gender": "Female",
        "relation": "Genetic",
        "identifier": {
          "id": "910 333333",
          "scheme": "au.nlis"
        },
        "officialName": "mock name dam of dam"
      }
    ],
    "healthStatus": "Healthy",
    "@self": "https://api.dev.purefarming.com/data/livestock/animals/2331c2b9-f8c5-41cf-b2df-4bdc25efd6a3",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.animal",
      "sourceId": "f690b854-9f4f-4093-af22-81d6700f25fc",
      "modified": "2024-02-26T03:19:33.7021576+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "3ABZF222",
      "scheme": "au.nlis.pic"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "982 123477466062",
    "scheme": "au.nlis"
  },
  "id": "4e33a7fe-e882-45bc-bd8c-72be139d49bc",
  "eventDateTime": "2024-02-26T03:19:33.7061394+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Birth",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Don Harris",
  "contemporaryGroup": "2022 heifer calves",
  "remark": "Easy birth",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-birth-registrations/4e33a7fe-e882-45bc-bd8c-72be139d49bc",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "2e04664b-b8a2-4f25-bdfc-6b5e45352856",
    "modified": "2024-02-26T03:19:33.7061426+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABZF222",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarMovementBirthEventResource","registrationReason":"Registered","animalDetail":{"resourceType":"icarAnimalCoreResource","identifier":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"alternativeIdentifiers":[{"resourceType":"icarIdentifierType","id":"3ABAB111","scheme":"au.nlis.visual"}],"specie":"Cattle","gender":"Female","birthDate":"2020-07-10T00:00:00+00:00","primaryBreed":{"resourceType":"icarIdentifierType","id":"FF","scheme":"au.nlis.breed"},"breedFractions":{"resourceType":"icarBreedFractionsType","denominator":16,"fractions":[{"breed":{"id":"FF","scheme":"au.nlis.breed"},"fraction":15.0},{"breed":{"id":"JJ","scheme":"au.nlis.breed"},"fraction":1.0}]},"coatColor":"Black","coatColorIdentifier":{"resourceType":"icarIdentifierType","id":"12435","scheme":"mock.color.scheme"},"managementTag":"44562","name":"Sally","officialName":"Waringa Supreme Sally","productionPurpose":"Milk","status":"Alive","reproductionStatus":"Open","lactationStatus":"Lactating","parentage":[{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Male","relation":"Genetic","identifier":{"id":"911 111111","scheme":"au.nlis"},"officialName":"mock name sire"},{"resourceType":"icarParentageType","parentOf":{"id":"931 123477466011","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"911 222222","scheme":"au.nlis"},"officialName":"mock name dam"},{"resourceType":"icarParentageType","parentOf":{"id":"911 222222","scheme":"au.nlis"},"gender":"Female","relation":"Genetic","identifier":{"id":"910 333333","scheme":"au.nlis"},"officialName":"mock name dam of dam"}],"healthStatus":"Healthy","@self":"https://api.dev.purefarming.com/data/livestock/animals/2331c2b9-f8c5-41cf-b2df-4bdc25efd6a3","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"f690b854-9f4f-4093-af22-81d6700f25fc","modified":"2024-02-26T03:19:33.7021576+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}},"animal":{"resourceType":"icarIdentifierType","id":"982 123477466062","scheme":"au.nlis"},"id":"4e33a7fe-e882-45bc-bd8c-72be139d49bc","eventDateTime":"2024-02-26T03:19:33.7061394+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"nz.minda.trait"},"responsible":"Don Harris","contemporaryGroup":"2022 heifer calves","remark":"Easy birth","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-birth-registrations/4e33a7fe-e882-45bc-bd8c-72be139d49bc","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"2e04664b-b8a2-4f25-bdfc-6b5e45352856","modified":"2024-02-26T03:19:33.7061426+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABZF222","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Animal deaths

GET data/livestock/movement/animal-deaths

Returns all of the animal deaths that a user has access to

Request
GET /data/livestock/movement/animal-deaths[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementDeathEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"2989ea0d-afff-4c68-b5f5-58527416ec70","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/2989ea0d-afff-4c68-b5f5-58527416ec70","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"a5c88e1e-3175-4636-92d7-8d9be5515b46","modified":"2024-02-26T03:19:33.7157918+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMovementDeathEventResource",
      "deathReason": "Accident",
      "explanation": "Fell over a bluff",
      "disposalMethod": "ApprovedService",
      "disposalOperator": "Wallace Corporation Limited",
      "disposalReference": "WC37X-7821",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "VVF37555",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "11111",
          "scheme": "nz.nait.pica-location"
        },
        "originPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "destinationLocation": {
          "id": "42424",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "750 Bushy Road, RD17, Katikati",
        "loadingDateTime": "2022-08-14T07:12:00+00:00",
        "unloadingDateTime": "2022-08-14T13:24:00+00:00",
        "expectedDuration": 6.2,
        "transportOperator": "Katikati Transport Ltd",
        "vehicle": "JWL387",
        "transportReference": "OT55-782",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "nz.mpi.ar"
        }
      },
      "deathMethod": "Accident",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "641 754394666666",
        "scheme": "iso.std.11785"
      },
      "id": "2989ea0d-afff-4c68-b5f5-58527416ec70",
      "eventDateTime": "2022-10-12T20:00:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Death",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Bob Smith",
      "contemporaryGroup": "Dead",
      "remark": "Accident",
      "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/2989ea0d-afff-4c68-b5f5-58527416ec70",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "a5c88e1e-3175-4636-92d7-8d9be5515b46",
        "modified": "2024-02-26T03:19:33.7157918+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "66111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"2989ea0d-afff-4c68-b5f5-58527416ec70","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/2989ea0d-afff-4c68-b5f5-58527416ec70","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"a5c88e1e-3175-4636-92d7-8d9be5515b46","modified":"2024-02-26T03:19:33.7157918+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/animal-deaths

Returns all of the animal deaths that a user has access to in a holding

Request
GET /data/holdings/{holdingId}/livestock/movement/animal-deaths[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementDeathEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"a06332ed-e42e-4f4e-8c52-97482edfe697","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/a06332ed-e42e-4f4e-8c52-97482edfe697","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"6804be1a-f945-4a8c-a284-56b3853cfc64","modified":"2024-02-26T03:19:33.7192723+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMovementDeathEventResource",
      "deathReason": "Accident",
      "explanation": "Fell over a bluff",
      "disposalMethod": "ApprovedService",
      "disposalOperator": "Wallace Corporation Limited",
      "disposalReference": "WC37X-7821",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "VVF37555",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "11111",
          "scheme": "nz.nait.pica-location"
        },
        "originPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "destinationLocation": {
          "id": "42424",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "750 Bushy Road, RD17, Katikati",
        "loadingDateTime": "2022-08-14T07:12:00+00:00",
        "unloadingDateTime": "2022-08-14T13:24:00+00:00",
        "expectedDuration": 6.2,
        "transportOperator": "Katikati Transport Ltd",
        "vehicle": "JWL387",
        "transportReference": "OT55-782",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "nz.mpi.ar"
        }
      },
      "deathMethod": "Accident",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "641 754394666666",
        "scheme": "iso.std.11785"
      },
      "id": "a06332ed-e42e-4f4e-8c52-97482edfe697",
      "eventDateTime": "2022-10-12T20:00:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Death",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Bob Smith",
      "contemporaryGroup": "Dead",
      "remark": "Accident",
      "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/a06332ed-e42e-4f4e-8c52-97482edfe697",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.animal",
        "sourceId": "6804be1a-f945-4a8c-a284-56b3853cfc64",
        "modified": "2024-02-26T03:19:33.7192723+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "66111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"a06332ed-e42e-4f4e-8c52-97482edfe697","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/a06332ed-e42e-4f4e-8c52-97482edfe697","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"6804be1a-f945-4a8c-a284-56b3853cfc64","modified":"2024-02-26T03:19:33.7192723+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/animal-deaths/{deathId}

Returns the animal death by holding id and death id

Request
GET /data/holdings/{holdingId}/livestock/movement/animal-deaths/{deathId}
Parameters
Name Type Default Notes
*holdingId
*deathId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementDeathEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"d1590b24-25f8-43ce-abe4-63594262f5de","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/d1590b24-25f8-43ce-abe4-63594262f5de","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"f914cdd5-0db0-4f24-bf79-defbb46ae135","modified":"2024-02-26T03:19:33.7216276+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarMovementDeathEventResource",
  "deathReason": "Accident",
  "explanation": "Fell over a bluff",
  "disposalMethod": "ApprovedService",
  "disposalOperator": "Wallace Corporation Limited",
  "disposalReference": "WC37X-7821",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "VVF37555",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "11111",
      "scheme": "nz.nait.pica-location"
    },
    "originPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "destinationLocation": {
      "id": "42424",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "750 Bushy Road, RD17, Katikati",
    "loadingDateTime": "2022-08-14T07:12:00+00:00",
    "unloadingDateTime": "2022-08-14T13:24:00+00:00",
    "expectedDuration": 6.2,
    "transportOperator": "Katikati Transport Ltd",
    "vehicle": "JWL387",
    "transportReference": "OT55-782",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "nz.mpi.ar"
    }
  },
  "deathMethod": "Accident",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "641 754394666666",
    "scheme": "iso.std.11785"
  },
  "id": "d1590b24-25f8-43ce-abe4-63594262f5de",
  "eventDateTime": "2022-10-12T20:00:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Death",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Bob Smith",
  "contemporaryGroup": "Dead",
  "remark": "Accident",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/d1590b24-25f8-43ce-abe4-63594262f5de",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "f914cdd5-0db0-4f24-bf79-defbb46ae135",
    "modified": "2024-02-26T03:19:33.7216276+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "66111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"d1590b24-25f8-43ce-abe4-63594262f5de","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/d1590b24-25f8-43ce-abe4-63594262f5de","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"f914cdd5-0db0-4f24-bf79-defbb46ae135","modified":"2024-02-26T03:19:33.7216276+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/livestock/movement/animal-deaths/{DeathId}

Returns the animal death by death id

Request
GET /data/livestock/movement/animal-deaths/{DeathId}
Parameters
Name Type Default Notes
*DeathId

The Pure Farming identifier of the animal death data point.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementDeathEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"f6c427be-46cc-428c-8d61-b946ec2e1e03","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/f6c427be-46cc-428c-8d61-b946ec2e1e03","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"6cd10e1a-5a6b-4bfe-b2be-af289822b815","modified":"2024-02-26T03:19:33.724211+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarMovementDeathEventResource",
  "deathReason": "Accident",
  "explanation": "Fell over a bluff",
  "disposalMethod": "ApprovedService",
  "disposalOperator": "Wallace Corporation Limited",
  "disposalReference": "WC37X-7821",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "VVF37555",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "11111",
      "scheme": "nz.nait.pica-location"
    },
    "originPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "destinationLocation": {
      "id": "42424",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "750 Bushy Road, RD17, Katikati",
    "loadingDateTime": "2022-08-14T07:12:00+00:00",
    "unloadingDateTime": "2022-08-14T13:24:00+00:00",
    "expectedDuration": 6.2,
    "transportOperator": "Katikati Transport Ltd",
    "vehicle": "JWL387",
    "transportReference": "OT55-782",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "nz.mpi.ar"
    }
  },
  "deathMethod": "Accident",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "641 754394666666",
    "scheme": "iso.std.11785"
  },
  "id": "f6c427be-46cc-428c-8d61-b946ec2e1e03",
  "eventDateTime": "2022-10-12T20:00:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Death",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Bob Smith",
  "contemporaryGroup": "Dead",
  "remark": "Accident",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/f6c427be-46cc-428c-8d61-b946ec2e1e03",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.animal",
    "sourceId": "6cd10e1a-5a6b-4bfe-b2be-af289822b815",
    "modified": "2024-02-26T03:19:33.724211+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "66111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarMovementDeathEventResource","deathReason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","animal":{"resourceType":"icarIdentifierType","id":"641 754394666666","scheme":"iso.std.11785"},"id":"f6c427be-46cc-428c-8d61-b946ec2e1e03","eventDateTime":"2022-10-12T20:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Death","scheme":"nz.minda.trait"},"responsible":"Bob Smith","contemporaryGroup":"Dead","remark":"Accident","@self":"https://api.dev.purefarming.com/data/livestock/movement/animal-deaths/f6c427be-46cc-428c-8d61-b946ec2e1e03","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.animal","sourceId":"6cd10e1a-5a6b-4bfe-b2be-af289822b815","modified":"2024-02-26T03:19:33.724211+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"66111","scheme":"nz.nait.pica-location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Animal departures

GET data/livestock/movement/animal-departures

Returns all of the animal departures that a user has access too

Request
GET /data/livestock/movement/animal-departures[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementDepartureEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMovementDepartureEventResource",
      "departureKind": "Sale",
      "departureReason": "Sale",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "VVF37555",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "11111",
          "scheme": "nz.nait.pica-location"
        },
        "originAddress": "340 Maungakawa Road, RD1, Cambridge",
        "destinationLocation": {
          "id": "42424",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "750 Bushy Road, RD17, Katikati",
        "loadingDateTime": "2022-08-14T07:12:00+00:00",
        "unloadingDateTime": "2022-08-14T13:24:00+00:00",
        "expectedDuration": 6.2,
        "transportOperator": "Katikati Transport Ltd",
        "vehicle": "JWL387",
        "transportReference": "OT55-782",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "nz.mpi.ar"
        }
      },
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "423 7543946579213",
        "scheme": "iso.std.11785"
      },
      "id": "b6a8c812-e49b-426d-85b5-dcae0e59744d",
      "eventDateTime": "2022-08-14T08:42:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Departure",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Phil Brown",
      "contemporaryGroup": "Low plane",
      "remark": "Otorohanga Spring sale",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "au.bzagri.app",
        "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
        "isDeleted": false,
        "modified": "2023-02-10T14:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@bzagri.com.au",
        "validFrom": "2023-02-10T14:00:00+00:00",
        "validTo": "2023-12-10T14:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11444",
        "scheme": "nz.nait.pica-location"
      },
      "dataPointKey": "sample-data-movement-departure-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{HoldingId}/livestock/movement/animal-departures

Returns all of the animal departure events that a user has access to in a holding

Request
GET /data/holdings/{HoldingId}/livestock/movement/animal-departures[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*HoldingId

The holding to fetch departures for.
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementDepartureEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarMovementDepartureEventResource",
      "departureKind": "Sale",
      "departureReason": "Sale",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "VVF37555",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "11111",
          "scheme": "nz.nait.pica-location"
        },
        "originAddress": "340 Maungakawa Road, RD1, Cambridge",
        "destinationLocation": {
          "id": "42424",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "750 Bushy Road, RD17, Katikati",
        "loadingDateTime": "2022-08-14T07:12:00+00:00",
        "unloadingDateTime": "2022-08-14T13:24:00+00:00",
        "expectedDuration": 6.2,
        "transportOperator": "Katikati Transport Ltd",
        "vehicle": "JWL387",
        "transportReference": "OT55-782",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "nz.mpi.ar"
        }
      },
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "423 7543946579213",
        "scheme": "iso.std.11785"
      },
      "id": "b6a8c812-e49b-426d-85b5-dcae0e59744d",
      "eventDateTime": "2022-08-14T08:42:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Departure",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Phil Brown",
      "contemporaryGroup": "Low plane",
      "remark": "Otorohanga Spring sale",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "au.bzagri.app",
        "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
        "isDeleted": false,
        "modified": "2023-02-10T14:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@bzagri.com.au",
        "validFrom": "2023-02-10T14:00:00+00:00",
        "validTo": "2023-12-10T14:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11444",
        "scheme": "nz.nait.pica-location"
      },
      "dataPointKey": "sample-data-movement-departure-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/animal-departures?offset=0&limit=1"},"items":[{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{HoldingId}/livestock/movement/animal-departures/{DepartureId}

Returns the animal departure event by holding id and departure id

Request
GET /data/holdings/{HoldingId}/livestock/movement/animal-departures/{DepartureId}
Parameters
Name Type Default Notes
*HoldingId
*DepartureId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementDepartureEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}
Mime type: application/json 
{
  "resourceType": "icarMovementDepartureEventResource",
  "departureKind": "Sale",
  "departureReason": "Sale",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "VVF37555",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "11111",
      "scheme": "nz.nait.pica-location"
    },
    "originAddress": "340 Maungakawa Road, RD1, Cambridge",
    "destinationLocation": {
      "id": "42424",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "750 Bushy Road, RD17, Katikati",
    "loadingDateTime": "2022-08-14T07:12:00+00:00",
    "unloadingDateTime": "2022-08-14T13:24:00+00:00",
    "expectedDuration": 6.2,
    "transportOperator": "Katikati Transport Ltd",
    "vehicle": "JWL387",
    "transportReference": "OT55-782",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "nz.mpi.ar"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "423 7543946579213",
    "scheme": "iso.std.11785"
  },
  "id": "b6a8c812-e49b-426d-85b5-dcae0e59744d",
  "eventDateTime": "2022-08-14T08:42:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Departure",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Phil Brown",
  "contemporaryGroup": "Low plane",
  "remark": "Otorohanga Spring sale",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "au.bzagri.app",
    "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
    "isDeleted": false,
    "modified": "2023-02-10T14:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@bzagri.com.au",
    "validFrom": "2023-02-10T14:00:00+00:00",
    "validTo": "2023-12-10T14:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11444",
    "scheme": "nz.nait.pica-location"
  },
  "dataPointKey": "sample-data-movement-departure-f"
}
Mime type: text/json 
{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/livestock/movement/animal-departures/{DepartureId}

Returns the animal departure event by departure id

Request
GET /data/livestock/movement/animal-departures/{DepartureId}
Parameters
Name Type Default Notes
*DepartureId

The Pure Farming identifier of the AnimalDeparture event data point.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarMovementDepartureEventResource

Success
Mime type: text/plain 
{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}
Mime type: application/json 
{
  "resourceType": "icarMovementDepartureEventResource",
  "departureKind": "Sale",
  "departureReason": "Sale",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "VVF37555",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "11111",
      "scheme": "nz.nait.pica-location"
    },
    "originAddress": "340 Maungakawa Road, RD1, Cambridge",
    "destinationLocation": {
      "id": "42424",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "750 Bushy Road, RD17, Katikati",
    "loadingDateTime": "2022-08-14T07:12:00+00:00",
    "unloadingDateTime": "2022-08-14T13:24:00+00:00",
    "expectedDuration": 6.2,
    "transportOperator": "Katikati Transport Ltd",
    "vehicle": "JWL387",
    "transportReference": "OT55-782",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "nz.mpi.ar"
    }
  },
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "423 7543946579213",
    "scheme": "iso.std.11785"
  },
  "id": "b6a8c812-e49b-426d-85b5-dcae0e59744d",
  "eventDateTime": "2022-08-14T08:42:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Departure",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Phil Brown",
  "contemporaryGroup": "Low plane",
  "remark": "Otorohanga Spring sale",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "au.bzagri.app",
    "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
    "isDeleted": false,
    "modified": "2023-02-10T14:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@bzagri.com.au",
    "validFrom": "2023-02-10T14:00:00+00:00",
    "validTo": "2023-12-10T14:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11444",
    "scheme": "nz.nait.pica-location"
  },
  "dataPointKey": "sample-data-movement-departure-f"
}
Mime type: text/json 
{"resourceType":"icarMovementDepartureEventResource","departureKind":"Sale","departureReason":"Sale","consignment":{"resourceType":"icarConsignmentType","id":{"id":"VVF37555","scheme":"nz.nait.consign"},"originLocation":{"id":"11111","scheme":"nz.nait.pica-location"},"originAddress":"340 Maungakawa Road, RD1, Cambridge","destinationLocation":{"id":"42424","scheme":"nz.nait.pica-location"},"destinationAddress":"750 Bushy Road, RD17, Katikati","loadingDateTime":"2022-08-14T07:12:00+00:00","unloadingDateTime":"2022-08-14T13:24:00+00:00","expectedDuration":6.2,"transportOperator":"Katikati Transport Ltd","vehicle":"JWL387","transportReference":"OT55-782","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"nz.mpi.ar"}},"animal":{"resourceType":"icarIdentifierType","id":"423 7543946579213","scheme":"iso.std.11785"},"id":"b6a8c812-e49b-426d-85b5-dcae0e59744d","eventDateTime":"2022-08-14T08:42:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"nz.minda.trait"},"responsible":"Phil Brown","contemporaryGroup":"Low plane","remark":"Otorohanga Spring sale","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11444","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-departure-f"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Group arrivals

GET data/livestock/movement/group-arrivals

Request
GET /data/livestock/movement/group-arrivals[?limit&offset]
Parameters
Name Type Default Notes
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementArrivalEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":500,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","next":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","last":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500"},"items":[{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 500,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementArrivalEventResource",
      "arrivalReason": "Purchase",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "PQY42427",
          "scheme": "uk.lis.consign"
        },
        "originLocation": {
          "id": "32/443/55545",
          "scheme": "uk.cph"
        },
        "destinationLocation": {
          "id": "33/444/5555",
          "scheme": "uk.cph"
        },
        "destinationAddress": "225 Walker Road, Jupiter, West Country, England",
        "loadingDateTime": "2022-09-13T09:14:00+00:00",
        "unloadingDateTime": "2022-09-13T13:20:00+00:00",
        "expectedDuration": 4.1,
        "transportOperator": "F & D Buckle Ltd",
        "vehicle": "ZKF343",
        "transportReference": "BUC1248",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "uk.lis.ar"
        }
      },
      "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
      "countObserved": 3,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Brightside heifer sale",
        "count": 46,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "uk.lis.breed"
        },
        "birthPeriod": "2021-03",
        "reproductiveStatus": "NotPregnant",
        "lactationStatus": "Dry",
        "productionPurposes": [
          "Milk",
          "Meat"
        ]
      },
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "0ZK684",
        "name": "Fictitious LIS test arrival set",
        "purpose": "Movement",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0244220",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788227",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788231",
            "scheme": "uk.lis"
          }
        ]
      },
      "id": "acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed",
      "eventDateTime": "2022-09-13T12:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Arrival",
        "scheme": "uk.lis.trait"
      },
      "responsible": "Boris Johnson",
      "contemporaryGroup": "Calving heifers",
      "remark": "Brightside heifer sale",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.co.kjhfarmsupplies",
        "sourceId": "efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6",
        "modified": "2023-05-01T11:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "123456",
        "scheme": "uk.cph"
      },
      "dataPointKey": "sample-data-movement-group-arrival-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":500,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","next":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","last":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500"},"items":[{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/livestock/movement/group-arrivals/{groupArrivalId}

Request
GET /data/livestock/movement/group-arrivals/{groupArrivalId}
Parameters
Name Type Default Notes
*groupArrivalId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementArrivalEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementArrivalEventResource",
  "arrivalReason": "Purchase",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "PQY42427",
      "scheme": "uk.lis.consign"
    },
    "originLocation": {
      "id": "32/443/55545",
      "scheme": "uk.cph"
    },
    "destinationLocation": {
      "id": "33/444/5555",
      "scheme": "uk.cph"
    },
    "destinationAddress": "225 Walker Road, Jupiter, West Country, England",
    "loadingDateTime": "2022-09-13T09:14:00+00:00",
    "unloadingDateTime": "2022-09-13T13:20:00+00:00",
    "expectedDuration": 4.1,
    "transportOperator": "F & D Buckle Ltd",
    "vehicle": "ZKF343",
    "transportReference": "BUC1248",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "uk.lis.ar"
    }
  },
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Brightside heifer sale",
    "count": 46,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "uk.lis.breed"
    },
    "birthPeriod": "2021-03",
    "reproductiveStatus": "NotPregnant",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Milk",
      "Meat"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "0ZK684",
    "name": "Fictitious LIS test arrival set",
    "purpose": "Movement",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0244220",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788227",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788231",
        "scheme": "uk.lis"
      }
    ]
  },
  "id": "acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed",
  "eventDateTime": "2022-09-13T12:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Arrival",
    "scheme": "uk.lis.trait"
  },
  "responsible": "Boris Johnson",
  "contemporaryGroup": "Calving heifers",
  "remark": "Brightside heifer sale",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.co.kjhfarmsupplies",
    "sourceId": "efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6",
    "modified": "2023-05-01T11:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "123456",
    "scheme": "uk.cph"
  },
  "dataPointKey": "sample-data-movement-group-arrival-f"
}
Mime type: text/json 
{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/group-arrivals

Request
GET /data/holdings/{holdingId}/livestock/movement/group-arrivals[?limit&offset]
Parameters
Name Type Default Notes
*holdingId
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementArrivalEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":500,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","next":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","last":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500"},"items":[{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 500,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementArrivalEventResource",
      "arrivalReason": "Purchase",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "PQY42427",
          "scheme": "uk.lis.consign"
        },
        "originLocation": {
          "id": "32/443/55545",
          "scheme": "uk.cph"
        },
        "destinationLocation": {
          "id": "33/444/5555",
          "scheme": "uk.cph"
        },
        "destinationAddress": "225 Walker Road, Jupiter, West Country, England",
        "loadingDateTime": "2022-09-13T09:14:00+00:00",
        "unloadingDateTime": "2022-09-13T13:20:00+00:00",
        "expectedDuration": 4.1,
        "transportOperator": "F & D Buckle Ltd",
        "vehicle": "ZKF343",
        "transportReference": "BUC1248",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-388",
          "scheme": "uk.lis.ar"
        }
      },
      "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
      "countObserved": 3,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Brightside heifer sale",
        "count": 46,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "uk.lis.breed"
        },
        "birthPeriod": "2021-03",
        "reproductiveStatus": "NotPregnant",
        "lactationStatus": "Dry",
        "productionPurposes": [
          "Milk",
          "Meat"
        ]
      },
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "0ZK684",
        "name": "Fictitious LIS test arrival set",
        "purpose": "Movement",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0244220",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788227",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788231",
            "scheme": "uk.lis"
          }
        ]
      },
      "id": "acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed",
      "eventDateTime": "2022-09-13T12:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Arrival",
        "scheme": "uk.lis.trait"
      },
      "responsible": "Boris Johnson",
      "contemporaryGroup": "Calving heifers",
      "remark": "Brightside heifer sale",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.co.kjhfarmsupplies",
        "sourceId": "efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6",
        "modified": "2023-05-01T11:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "123456",
        "scheme": "uk.cph"
      },
      "dataPointKey": "sample-data-movement-group-arrival-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":500,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","next":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500","last":"https://api.dev.purefarming.com/data/livestock/movement/group-arrivals?offset=0&limit=500"},"items":[{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/group-arrivals/{groupArrivalId}

Request
GET /data/holdings/{holdingId}/livestock/movement/group-arrivals/{groupArrivalId}
Parameters
Name Type Default Notes
*groupArrivalId
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementArrivalEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementArrivalEventResource",
  "arrivalReason": "Purchase",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "PQY42427",
      "scheme": "uk.lis.consign"
    },
    "originLocation": {
      "id": "32/443/55545",
      "scheme": "uk.cph"
    },
    "destinationLocation": {
      "id": "33/444/5555",
      "scheme": "uk.cph"
    },
    "destinationAddress": "225 Walker Road, Jupiter, West Country, England",
    "loadingDateTime": "2022-09-13T09:14:00+00:00",
    "unloadingDateTime": "2022-09-13T13:20:00+00:00",
    "expectedDuration": 4.1,
    "transportOperator": "F & D Buckle Ltd",
    "vehicle": "ZKF343",
    "transportReference": "BUC1248",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-388",
      "scheme": "uk.lis.ar"
    }
  },
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Brightside heifer sale",
    "count": 46,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "uk.lis.breed"
    },
    "birthPeriod": "2021-03",
    "reproductiveStatus": "NotPregnant",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Milk",
      "Meat"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "0ZK684",
    "name": "Fictitious LIS test arrival set",
    "purpose": "Movement",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0244220",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788227",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788231",
        "scheme": "uk.lis"
      }
    ]
  },
  "id": "acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed",
  "eventDateTime": "2022-09-13T12:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Arrival",
    "scheme": "uk.lis.trait"
  },
  "responsible": "Boris Johnson",
  "contemporaryGroup": "Calving heifers",
  "remark": "Brightside heifer sale",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.co.kjhfarmsupplies",
    "sourceId": "efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6",
    "modified": "2023-05-01T11:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "123456",
    "scheme": "uk.cph"
  },
  "dataPointKey": "sample-data-movement-group-arrival-f"
}
Mime type: text/json 
{"resourceType":"icarGroupMovementArrivalEventResource","arrivalReason":"Purchase","consignment":{"resourceType":"icarConsignmentType","id":{"id":"PQY42427","scheme":"uk.lis.consign"},"originLocation":{"id":"32/443/55545","scheme":"uk.cph"},"destinationLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationAddress":"225 Walker Road, Jupiter, West Country, England","loadingDateTime":"2022-09-13T09:14:00+00:00","unloadingDateTime":"2022-09-13T13:20:00+00:00","expectedDuration":4.1,"transportOperator":"F & D Buckle Ltd","vehicle":"ZKF343","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-388","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":46.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK684","name":"Fictitious LIS test arrival set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"acf66ad1-1e5e-4baa-9dbd-c4a2478a0bed","eventDateTime":"2022-09-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Arrival","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","meta":{"resourceType":"icarMetaDataType","source":"nz.co.kjhfarmsupplies","sourceId":"efc3da28-cc4b-4733-b5bf-2dd0b3a4beb6","modified":"2023-05-01T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-arrival-f"}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Group birth registrations

GET data/livestock/movement/group-birth-registrations

Gets all of the group birth registrations the user has access to via pagination

Request
GET /data/livestock/movement/group-birth-registrations[?limit&offset]
Parameters
Name Type Default Notes
limit

the maximum number of items per page
offset

the number of items offset from the start of the set for the current page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementBirthEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementBirthEventResource",
      "registrationReason": "Born",
      "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
      "countObserved": 3,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Heifers born 13 March 2020",
        "count": 3,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "uk.lis.breed"
        },
        "birthPeriod": "2020-03",
        "reproductiveStatus": "NotPregnant",
        "lactationStatus": "Dry",
        "productionPurposes": [
          "Milk",
          "Meat"
        ]
      },
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "0ZK674",
        "name": "Fictitious LIS test birth set",
        "purpose": "Reproduction",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0244220",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788227",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788231",
            "scheme": "uk.lis"
          }
        ]
      },
      "id": "302dc48a-a056-4e82-8ea5-7e800a9608c9",
      "eventDateTime": "2020-03-13T12:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Birth",
        "scheme": "uk.lis.trait"
      },
      "responsible": "Boris Johnson",
      "contemporaryGroup": "Elite heifers",
      "remark": "Heifers born 13 March 2020",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.lis",
        "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
        "isDeleted": false,
        "modified": "2023-02-10T14:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@bzagri.com.au",
        "validFrom": "2023-02-10T14:00:00+00:00",
        "validTo": "2023-12-10T14:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "uk.cph"
      },
      "dataPointKey": "sample-data-movement-group-birth-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}]}

GET data/livestock/movement/group-birth-registrations/{birthRegistrationId}

Gets a single group birth registration by Id

Request
GET /data/livestock/movement/group-birth-registrations/{birthRegistrationId}
Parameters
Name Type Default Notes
*birthRegistrationId

The Id of the group birth registration to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementBirthEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementBirthEventResource",
  "registrationReason": "Born",
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Heifers born 13 March 2020",
    "count": 3,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "uk.lis.breed"
    },
    "birthPeriod": "2020-03",
    "reproductiveStatus": "NotPregnant",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Milk",
      "Meat"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "0ZK674",
    "name": "Fictitious LIS test birth set",
    "purpose": "Reproduction",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0244220",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788227",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788231",
        "scheme": "uk.lis"
      }
    ]
  },
  "id": "302dc48a-a056-4e82-8ea5-7e800a9608c9",
  "eventDateTime": "2020-03-13T12:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Birth",
    "scheme": "uk.lis.trait"
  },
  "responsible": "Boris Johnson",
  "contemporaryGroup": "Elite heifers",
  "remark": "Heifers born 13 March 2020",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.lis",
    "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
    "isDeleted": false,
    "modified": "2023-02-10T14:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@bzagri.com.au",
    "validFrom": "2023-02-10T14:00:00+00:00",
    "validTo": "2023-12-10T14:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "uk.cph"
  },
  "dataPointKey": "sample-data-movement-group-birth-f"
}
Mime type: text/json 
{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/movement/group-birth-registrations

Gets the group birth registrations for a holding via pagination

Request
GET /data/holdings/{holdingId}/movement/group-birth-registrations[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the group birth registrations for
limit

the maximum number of group birth registration on a page
offset

the number of group birth registration in the total set before the first one on the page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementBirthEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementBirthEventResource",
      "registrationReason": "Born",
      "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
      "countObserved": 3,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Heifers born 13 March 2020",
        "count": 3,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "uk.lis.breed"
        },
        "birthPeriod": "2020-03",
        "reproductiveStatus": "NotPregnant",
        "lactationStatus": "Dry",
        "productionPurposes": [
          "Milk",
          "Meat"
        ]
      },
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "0ZK674",
        "name": "Fictitious LIS test birth set",
        "purpose": "Reproduction",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0244220",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788227",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788231",
            "scheme": "uk.lis"
          }
        ]
      },
      "id": "302dc48a-a056-4e82-8ea5-7e800a9608c9",
      "eventDateTime": "2020-03-13T12:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Birth",
        "scheme": "uk.lis.trait"
      },
      "responsible": "Boris Johnson",
      "contemporaryGroup": "Elite heifers",
      "remark": "Heifers born 13 March 2020",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.lis",
        "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
        "isDeleted": false,
        "modified": "2023-02-10T14:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@bzagri.com.au",
        "validFrom": "2023-02-10T14:00:00+00:00",
        "validTo": "2023-12-10T14:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "uk.cph"
      },
      "dataPointKey": "sample-data-movement-group-birth-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}]}

GET data/holdings/{holdingId}/livestock/movement/group-birth-registrations/{birthRegistrationId}

Gets a single group birth registration with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/livestock/movement/group-birth-registrations/{birthRegistrationId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the group birth registration for
*birthRegistrationId

The Id of the group birth registration to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementBirthEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementBirthEventResource",
  "registrationReason": "Born",
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Heifers born 13 March 2020",
    "count": 3,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "uk.lis.breed"
    },
    "birthPeriod": "2020-03",
    "reproductiveStatus": "NotPregnant",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Milk",
      "Meat"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "0ZK674",
    "name": "Fictitious LIS test birth set",
    "purpose": "Reproduction",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0244220",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788227",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788231",
        "scheme": "uk.lis"
      }
    ]
  },
  "id": "302dc48a-a056-4e82-8ea5-7e800a9608c9",
  "eventDateTime": "2020-03-13T12:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Birth",
    "scheme": "uk.lis.trait"
  },
  "responsible": "Boris Johnson",
  "contemporaryGroup": "Elite heifers",
  "remark": "Heifers born 13 March 2020",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.lis",
    "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
    "isDeleted": false,
    "modified": "2023-02-10T14:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@bzagri.com.au",
    "validFrom": "2023-02-10T14:00:00+00:00",
    "validTo": "2023-12-10T14:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "uk.cph"
  },
  "dataPointKey": "sample-data-movement-group-birth-f"
}
Mime type: text/json 
{"resourceType":"icarGroupMovementBirthEventResource","registrationReason":"Born","groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Heifers born 13 March 2020","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2020-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZK674","name":"Fictitious LIS test birth set","purpose":"Reproduction","member":[{"resourceType":"icarIdentifierType","id":"UK0244220","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788227","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788231","scheme":"uk.lis"}]},"id":"302dc48a-a056-4e82-8ea5-7e800a9608c9","eventDateTime":"2020-03-13T12:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Birth","scheme":"uk.lis.trait"},"responsible":"Boris Johnson","contemporaryGroup":"Elite heifers","remark":"Heifers born 13 March 2020","meta":{"resourceType":"icarMetaDataType","source":"uk.lis","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"},"dataPointKey":"sample-data-movement-group-birth-f"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Group deaths

GET data/livestock/movement/group-deaths

Request
GET /data/livestock/movement/group-deaths[?offset&limit]
Parameters
Name Type Default Notes
offset
limit
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementDeathEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementDeathEventResource",
      "deathreason": "Accident",
      "explanation": "Fell over a bluff",
      "disposalMethod": "ApprovedService",
      "disposalOperator": "Wallace Corporation Limited",
      "disposalReference": "WC37X-7821",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "DTH396666",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "12345",
          "scheme": "nz.nait.pica-location"
        },
        "originAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
        "originPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "destinationLocation": {
          "id": "597392",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
        "destinationPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "loadingDateTime": "2022-10-12T11:45:00+00:00",
        "unloadingDateTime": "2022-10-12T15:24:00+00:00",
        "expectedDuration": 4.1,
        "transportOperator": "Wallace Corporation Limited",
        "vehicle": "KKM384",
        "transportReference": "WCL22-9148",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-377",
          "scheme": "nz.mpi.ar"
        }
      },
      "deathMethod": "Accident",
      "groupMethod": "InventoryClassification",
      "countObserved": 12,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "First batch of wether lambs 2022",
        "count": 12,
        "species": "Sheep",
        "sex": "MaleNeuter",
        "birthPeriod": "2022-04-01",
        "productionPurposes": [
          "Meat",
          "Wool"
        ]
      },
      "id": "86030efb-eb6f-48f2-8568-0f47fcc21984",
      "eventDateTime": "2022-10-12T20:00:00+00:00",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
        "isDeleted": false,
        "modified": "2023-01-03T11:00:00+00:00",
        "created": "2023-01-03T09:00:00+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2023-01-03T11:00:01+00:00",
        "validTo": "2023-03-03T11:00:02+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "123456",
        "scheme": "nz.nait.pica-location"
      },
      "dataPointKey": "sample-data-movement-death-f",
      "animal": {
        "resourceType": "JObject",
        "scheme": "iso.std.11785",
        "id": "641 754394666666"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/livestock/movement/group-deaths/{groupDeathId}

Request
GET /data/livestock/movement/group-deaths/{groupDeathId}
Parameters
Name Type Default Notes
*groupDeathId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementDeathEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementDeathEventResource",
  "deathreason": "Accident",
  "explanation": "Fell over a bluff",
  "disposalMethod": "ApprovedService",
  "disposalOperator": "Wallace Corporation Limited",
  "disposalReference": "WC37X-7821",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "DTH396666",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "12345",
      "scheme": "nz.nait.pica-location"
    },
    "originAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
    "originPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "destinationLocation": {
      "id": "597392",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
    "destinationPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "loadingDateTime": "2022-10-12T11:45:00+00:00",
    "unloadingDateTime": "2022-10-12T15:24:00+00:00",
    "expectedDuration": 4.1,
    "transportOperator": "Wallace Corporation Limited",
    "vehicle": "KKM384",
    "transportReference": "WCL22-9148",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-377",
      "scheme": "nz.mpi.ar"
    }
  },
  "deathMethod": "Accident",
  "groupMethod": "InventoryClassification",
  "countObserved": 12,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "First batch of wether lambs 2022",
    "count": 12,
    "species": "Sheep",
    "sex": "MaleNeuter",
    "birthPeriod": "2022-04-01",
    "productionPurposes": [
      "Meat",
      "Wool"
    ]
  },
  "id": "86030efb-eb6f-48f2-8568-0f47fcc21984",
  "eventDateTime": "2022-10-12T20:00:00+00:00",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
    "isDeleted": false,
    "modified": "2023-01-03T11:00:00+00:00",
    "created": "2023-01-03T09:00:00+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2023-01-03T11:00:01+00:00",
    "validTo": "2023-03-03T11:00:02+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "123456",
    "scheme": "nz.nait.pica-location"
  },
  "dataPointKey": "sample-data-movement-death-f",
  "animal": {
    "resourceType": "JObject",
    "scheme": "iso.std.11785",
    "id": "641 754394666666"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/group-deaths

Request
GET /data/holdings/{holdingId}/livestock/movement/group-deaths[?limit&offset]
Parameters
Name Type Default Notes
*holdingId
limit
offset
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementDeathEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementDeathEventResource",
      "deathreason": "Accident",
      "explanation": "Fell over a bluff",
      "disposalMethod": "ApprovedService",
      "disposalOperator": "Wallace Corporation Limited",
      "disposalReference": "WC37X-7821",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "DTH396666",
          "scheme": "nz.nait.consign"
        },
        "originLocation": {
          "id": "12345",
          "scheme": "nz.nait.pica-location"
        },
        "originAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
        "originPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "destinationLocation": {
          "id": "597392",
          "scheme": "nz.nait.pica-location"
        },
        "destinationAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
        "destinationPostalAddress": {
          "addressCountry": "New Zealand",
          "addressLocality": "Omokoroa",
          "addressRegion": "Bay of Plenty",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Whakamarama Road"
        },
        "loadingDateTime": "2022-10-12T11:45:00+00:00",
        "unloadingDateTime": "2022-10-12T15:24:00+00:00",
        "expectedDuration": 4.1,
        "transportOperator": "Wallace Corporation Limited",
        "vehicle": "KKM384",
        "transportReference": "WCL22-9148",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-377",
          "scheme": "nz.mpi.ar"
        }
      },
      "deathMethod": "Accident",
      "groupMethod": "InventoryClassification",
      "countObserved": 12,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "First batch of wether lambs 2022",
        "count": 12,
        "species": "Sheep",
        "sex": "MaleNeuter",
        "birthPeriod": "2022-04-01",
        "productionPurposes": [
          "Meat",
          "Wool"
        ]
      },
      "id": "86030efb-eb6f-48f2-8568-0f47fcc21984",
      "eventDateTime": "2022-10-12T20:00:00+00:00",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.myfarmco.livestock.xxx",
        "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
        "isDeleted": false,
        "modified": "2023-01-03T11:00:00+00:00",
        "created": "2023-01-03T09:00:00+00:00",
        "creator": "don.wilson@myfarmco.com",
        "validFrom": "2023-01-03T11:00:01+00:00",
        "validTo": "2023-03-03T11:00:02+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "123456",
        "scheme": "nz.nait.pica-location"
      },
      "dataPointKey": "sample-data-movement-death-f",
      "animal": {
        "resourceType": "JObject",
        "scheme": "iso.std.11785",
        "id": "641 754394666666"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-deaths?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/group-deaths/{groupDeathId}

Request
GET /data/holdings/{holdingId}/livestock/movement/group-deaths/{groupDeathId}
Parameters
Name Type Default Notes
*groupDeathId
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementDeathEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementDeathEventResource",
  "deathreason": "Accident",
  "explanation": "Fell over a bluff",
  "disposalMethod": "ApprovedService",
  "disposalOperator": "Wallace Corporation Limited",
  "disposalReference": "WC37X-7821",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "DTH396666",
      "scheme": "nz.nait.consign"
    },
    "originLocation": {
      "id": "12345",
      "scheme": "nz.nait.pica-location"
    },
    "originAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
    "originPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "destinationLocation": {
      "id": "597392",
      "scheme": "nz.nait.pica-location"
    },
    "destinationAddress": "Morrinsville Rendering, 4 Keith Street, Morrinsville",
    "destinationPostalAddress": {
      "addressCountry": "New Zealand",
      "addressLocality": "Omokoroa",
      "addressRegion": "Bay of Plenty",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Whakamarama Road"
    },
    "loadingDateTime": "2022-10-12T11:45:00+00:00",
    "unloadingDateTime": "2022-10-12T15:24:00+00:00",
    "expectedDuration": 4.1,
    "transportOperator": "Wallace Corporation Limited",
    "vehicle": "KKM384",
    "transportReference": "WCL22-9148",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-377",
      "scheme": "nz.mpi.ar"
    }
  },
  "deathMethod": "Accident",
  "groupMethod": "InventoryClassification",
  "countObserved": 12,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "First batch of wether lambs 2022",
    "count": 12,
    "species": "Sheep",
    "sex": "MaleNeuter",
    "birthPeriod": "2022-04-01",
    "productionPurposes": [
      "Meat",
      "Wool"
    ]
  },
  "id": "86030efb-eb6f-48f2-8568-0f47fcc21984",
  "eventDateTime": "2022-10-12T20:00:00+00:00",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.myfarmco.livestock.xxx",
    "sourceId": "243aa8e4-6694-49f1-b8f3-8aa29ca7d268",
    "isDeleted": false,
    "modified": "2023-01-03T11:00:00+00:00",
    "created": "2023-01-03T09:00:00+00:00",
    "creator": "don.wilson@myfarmco.com",
    "validFrom": "2023-01-03T11:00:01+00:00",
    "validTo": "2023-03-03T11:00:02+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "123456",
    "scheme": "nz.nait.pica-location"
  },
  "dataPointKey": "sample-data-movement-death-f",
  "animal": {
    "resourceType": "JObject",
    "scheme": "iso.std.11785",
    "id": "641 754394666666"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupMovementDeathEventResource","deathreason":"Accident","explanation":"Fell over a bluff","disposalMethod":"ApprovedService","disposalOperator":"Wallace Corporation Limited","disposalReference":"WC37X-7821","consignment":{"resourceType":"icarConsignmentType","id":{"id":"DTH396666","scheme":"nz.nait.consign"},"originLocation":{"id":"12345","scheme":"nz.nait.pica-location"},"originAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","originPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"destinationLocation":{"id":"597392","scheme":"nz.nait.pica-location"},"destinationAddress":"Morrinsville Rendering, 4 Keith Street, Morrinsville","destinationPostalAddress":{"addressCountry":"New Zealand","addressLocality":"Omokoroa","addressRegion":"Bay of Plenty","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Whakamarama Road"},"loadingDateTime":"2022-10-12T11:45:00+00:00","unloadingDateTime":"2022-10-12T15:24:00+00:00","expectedDuration":4.1,"transportOperator":"Wallace Corporation Limited","vehicle":"KKM384","transportReference":"WCL22-9148","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-377","scheme":"nz.mpi.ar"}},"deathMethod":"Accident","groupMethod":"InventoryClassification","countObserved":12,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"First batch of wether lambs 2022","count":12.0,"species":"Sheep","sex":"MaleNeuter","birthPeriod":"2022-04-01","productionPurposes":["Meat","Wool"]},"id":"86030efb-eb6f-48f2-8568-0f47fcc21984","eventDateTime":"2022-10-12T20:00:00+00:00","meta":{"resourceType":"icarMetaDataType","source":"nz.myfarmco.livestock.xxx","sourceId":"243aa8e4-6694-49f1-b8f3-8aa29ca7d268","isDeleted":false,"modified":"2023-01-03T11:00:00+00:00","created":"2023-01-03T09:00:00+00:00","creator":"don.wilson@myfarmco.com","validFrom":"2023-01-03T11:00:01+00:00","validTo":"2023-03-03T11:00:02+00:00"},"location":{"resourceType":"icarIdentifierType","id":"123456","scheme":"nz.nait.pica-location"},"dataPointKey":"sample-data-movement-death-f","animal":{"resourceType":"JObject","scheme":"iso.std.11785","id":"641 754394666666"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Movement :: Group departures

GET data/livestock/movement/group-departures

Request
GET /data/livestock/movement/group-departures[?offset&limit]
Parameters
Name Type Default Notes
offset
limit
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementDepartureEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"c2c5f492-fb7c-4140-9648-f74ea65bfa86","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/c2c5f492-fb7c-4140-9648-f74ea65bfa86","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementDepartureEventResource",
      "departureKind": "Sale",
      "departureReason": "Production",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "GGK89898",
          "scheme": "uk.cph"
        },
        "originLocation": {
          "id": "33/444/5555",
          "scheme": "uk.cph"
        },
        "destinationLocation": {
          "id": "76/666/66666",
          "scheme": "uk.cph"
        },
        "destinationPostalAddress": {
          "addressCountry": "England",
          "addressLocality": "West Country",
          "addressRegion": "Jupiter",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Walker Road"
        },
        "loadingDateTime": "2022-09-01T09:14:00+00:00",
        "unloadingDateTime": "2022-09-01T15:20:00+00:00",
        "expectedDuration": 6.1,
        "transportOperator": "F & D Lacy Ltd",
        "vehicle": "ZKF555",
        "transportReference": "BUC1248",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-666",
          "scheme": "uk.lis.ar"
        }
      },
      "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
      "countObserved": 3,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Brightside heifer sale",
        "count": 3,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "uk.lis.breed"
        },
        "birthPeriod": "2021-03",
        "reproductiveStatus": "NotPregnant",
        "lactationStatus": "Dry",
        "productionPurposes": [
          "Milk",
          "Meat"
        ]
      },
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "0ZX994",
        "name": "Ficitious LIS test departure set",
        "purpose": "Movement",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788123",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0244456",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788789",
            "scheme": "uk.lis"
          }
        ]
      },
      "id": "c2c5f492-fb7c-4140-9648-f74ea65bfa86",
      "eventDateTime": "2022-09-01T09:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Departure",
        "scheme": "uk.lis.trait"
      },
      "responsible": "Vicky Barton",
      "contemporaryGroup": "Calving heifers",
      "remark": "Brightside heifer sale",
      "@self": "https://api.dev.purefarming.com/data/livestock/movement/c2c5f492-fb7c-4140-9648-f74ea65bfa86",
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "uk.cph"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"c2c5f492-fb7c-4140-9648-f74ea65bfa86","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/c2c5f492-fb7c-4140-9648-f74ea65bfa86","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/livestock/movement/group-departures/{groupDepartureId}

Request
GET /data/livestock/movement/group-departures/{groupDepartureId}
Parameters
Name Type Default Notes
*groupDepartureId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementDepartureEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"af23b8a3-07cd-4187-8fc1-373294b30b5a","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/af23b8a3-07cd-4187-8fc1-373294b30b5a","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementDepartureEventResource",
  "departureKind": "Sale",
  "departureReason": "Production",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "GGK89898",
      "scheme": "uk.cph"
    },
    "originLocation": {
      "id": "33/444/5555",
      "scheme": "uk.cph"
    },
    "destinationLocation": {
      "id": "76/666/66666",
      "scheme": "uk.cph"
    },
    "destinationPostalAddress": {
      "addressCountry": "England",
      "addressLocality": "West Country",
      "addressRegion": "Jupiter",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Walker Road"
    },
    "loadingDateTime": "2022-09-01T09:14:00+00:00",
    "unloadingDateTime": "2022-09-01T15:20:00+00:00",
    "expectedDuration": 6.1,
    "transportOperator": "F & D Lacy Ltd",
    "vehicle": "ZKF555",
    "transportReference": "BUC1248",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-666",
      "scheme": "uk.lis.ar"
    }
  },
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Brightside heifer sale",
    "count": 3,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "uk.lis.breed"
    },
    "birthPeriod": "2021-03",
    "reproductiveStatus": "NotPregnant",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Milk",
      "Meat"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "0ZX994",
    "name": "Ficitious LIS test departure set",
    "purpose": "Movement",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788123",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0244456",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788789",
        "scheme": "uk.lis"
      }
    ]
  },
  "id": "af23b8a3-07cd-4187-8fc1-373294b30b5a",
  "eventDateTime": "2022-09-01T09:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Departure",
    "scheme": "uk.lis.trait"
  },
  "responsible": "Vicky Barton",
  "contemporaryGroup": "Calving heifers",
  "remark": "Brightside heifer sale",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/af23b8a3-07cd-4187-8fc1-373294b30b5a",
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "uk.cph"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"af23b8a3-07cd-4187-8fc1-373294b30b5a","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/af23b8a3-07cd-4187-8fc1-373294b30b5a","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/movement/group-departures

Request
GET /data/holdings/{holdingId}/livestock/movement/group-departures[?offset&limit]
Parameters
Name Type Default Notes
*holdingId
offset
limit
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementDepartureEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"21bb5c3e-59f5-4d9e-91c9-46ab285b7baa","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/21bb5c3e-59f5-4d9e-91c9-46ab285b7baa","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarGroupMovementDepartureEventResource",
      "departureKind": "Sale",
      "departureReason": "Production",
      "consignment": {
        "resourceType": "icarConsignmentType",
        "id": {
          "id": "GGK89898",
          "scheme": "uk.cph"
        },
        "originLocation": {
          "id": "33/444/5555",
          "scheme": "uk.cph"
        },
        "destinationLocation": {
          "id": "76/666/66666",
          "scheme": "uk.cph"
        },
        "destinationPostalAddress": {
          "addressCountry": "England",
          "addressLocality": "West Country",
          "addressRegion": "Jupiter",
          "postOfficeBoxNumber": "54",
          "postalCode": "4734",
          "streetAddress": "225 Walker Road"
        },
        "loadingDateTime": "2022-09-01T09:14:00+00:00",
        "unloadingDateTime": "2022-09-01T15:20:00+00:00",
        "expectedDuration": 6.1,
        "transportOperator": "F & D Lacy Ltd",
        "vehicle": "ZKF555",
        "transportReference": "BUC1248",
        "isolationFacilityUsed": false,
        "farmAssuranceReference": {
          "id": "740-666",
          "scheme": "uk.lis.ar"
        }
      },
      "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
      "countObserved": 3,
      "inventoryClassification": {
        "resourceType": "icarInventoryClassificationType",
        "name": "Brightside heifer sale",
        "count": 3,
        "species": "Cattle",
        "sex": "Female",
        "primaryBreed": {
          "id": "FF",
          "scheme": "uk.lis.breed"
        },
        "birthPeriod": "2021-03",
        "reproductiveStatus": "NotPregnant",
        "lactationStatus": "Dry",
        "productionPurposes": [
          "Milk",
          "Meat"
        ]
      },
      "embeddedAnimalSet": {
        "resourceType": "icarAnimalSetResource",
        "id": "0ZX994",
        "name": "Ficitious LIS test departure set",
        "purpose": "Movement",
        "member": [
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788123",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0244456",
            "scheme": "uk.lis"
          },
          {
            "resourceType": "icarIdentifierType",
            "id": "UK0788789",
            "scheme": "uk.lis"
          }
        ]
      },
      "id": "21bb5c3e-59f5-4d9e-91c9-46ab285b7baa",
      "eventDateTime": "2022-09-01T09:46:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Departure",
        "scheme": "uk.lis.trait"
      },
      "responsible": "Vicky Barton",
      "contemporaryGroup": "Calving heifers",
      "remark": "Brightside heifer sale",
      "@self": "https://api.dev.purefarming.com/data/livestock/movement/21bb5c3e-59f5-4d9e-91c9-46ab285b7baa",
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "33/444/5555",
        "scheme": "uk.cph"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/movement/group-birth-registrations?offset=0&limit=1"},"items":[{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"21bb5c3e-59f5-4d9e-91c9-46ab285b7baa","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/21bb5c3e-59f5-4d9e-91c9-46ab285b7baa","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}]}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/livestock/movement/group-departure/{groupDepartureId}

Request
GET /data/holdings/{holdingId}/livestock/movement/group-departure/{groupDepartureId}
Parameters
Name Type Default Notes
*groupDepartureId
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupMovementDepartureEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"17c5ff64-6136-40d8-a075-0ddf9af2a716","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/17c5ff64-6136-40d8-a075-0ddf9af2a716","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
Mime type: application/json 
{
  "resourceType": "icarGroupMovementDepartureEventResource",
  "departureKind": "Sale",
  "departureReason": "Production",
  "consignment": {
    "resourceType": "icarConsignmentType",
    "id": {
      "id": "GGK89898",
      "scheme": "uk.cph"
    },
    "originLocation": {
      "id": "33/444/5555",
      "scheme": "uk.cph"
    },
    "destinationLocation": {
      "id": "76/666/66666",
      "scheme": "uk.cph"
    },
    "destinationPostalAddress": {
      "addressCountry": "England",
      "addressLocality": "West Country",
      "addressRegion": "Jupiter",
      "postOfficeBoxNumber": "54",
      "postalCode": "4734",
      "streetAddress": "225 Walker Road"
    },
    "loadingDateTime": "2022-09-01T09:14:00+00:00",
    "unloadingDateTime": "2022-09-01T15:20:00+00:00",
    "expectedDuration": 6.1,
    "transportOperator": "F & D Lacy Ltd",
    "vehicle": "ZKF555",
    "transportReference": "BUC1248",
    "isolationFacilityUsed": false,
    "farmAssuranceReference": {
      "id": "740-666",
      "scheme": "uk.lis.ar"
    }
  },
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Brightside heifer sale",
    "count": 3,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "uk.lis.breed"
    },
    "birthPeriod": "2021-03",
    "reproductiveStatus": "NotPregnant",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Milk",
      "Meat"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "0ZX994",
    "name": "Ficitious LIS test departure set",
    "purpose": "Movement",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788123",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0244456",
        "scheme": "uk.lis"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "UK0788789",
        "scheme": "uk.lis"
      }
    ]
  },
  "id": "17c5ff64-6136-40d8-a075-0ddf9af2a716",
  "eventDateTime": "2022-09-01T09:46:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Departure",
    "scheme": "uk.lis.trait"
  },
  "responsible": "Vicky Barton",
  "contemporaryGroup": "Calving heifers",
  "remark": "Brightside heifer sale",
  "@self": "https://api.dev.purefarming.com/data/livestock/movement/17c5ff64-6136-40d8-a075-0ddf9af2a716",
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/444/5555",
    "scheme": "uk.cph"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupMovementDepartureEventResource","departureKind":"Sale","departureReason":"Production","consignment":{"resourceType":"icarConsignmentType","id":{"id":"GGK89898","scheme":"uk.cph"},"originLocation":{"id":"33/444/5555","scheme":"uk.cph"},"destinationLocation":{"id":"76/666/66666","scheme":"uk.cph"},"destinationPostalAddress":{"addressCountry":"England","addressLocality":"West Country","addressRegion":"Jupiter","postOfficeBoxNumber":"54","postalCode":"4734","streetAddress":"225 Walker Road"},"loadingDateTime":"2022-09-01T09:14:00+00:00","unloadingDateTime":"2022-09-01T15:20:00+00:00","expectedDuration":6.1,"transportOperator":"F & D Lacy Ltd","vehicle":"ZKF555","transportReference":"BUC1248","isolationFacilityUsed":false,"farmAssuranceReference":{"id":"740-666","scheme":"uk.lis.ar"}},"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Brightside heifer sale","count":3.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2021-03","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"0ZX994","name":"Ficitious LIS test departure set","purpose":"Movement","member":[{"resourceType":"icarIdentifierType","id":"UK0788123","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0244456","scheme":"uk.lis"},{"resourceType":"icarIdentifierType","id":"UK0788789","scheme":"uk.lis"}]},"id":"17c5ff64-6136-40d8-a075-0ddf9af2a716","eventDateTime":"2022-09-01T09:46:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Departure","scheme":"uk.lis.trait"},"responsible":"Vicky Barton","contemporaryGroup":"Calving heifers","remark":"Brightside heifer sale","@self":"https://api.dev.purefarming.com/data/livestock/movement/17c5ff64-6136-40d8-a075-0ddf9af2a716","location":{"resourceType":"icarIdentifierType","id":"33/444/5555","scheme":"uk.cph"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Pregnancy check events

GET data/livestock/pregnancy-check-events

Gets all of the pregnancy check events the user has access to via pagination

Request
GET /data/livestock/pregnancy-check-events[?limit&offset]
Parameters
Name Type Default Notes
limit

the maximum number of items per page
offset

the number of items offset from the start of the set for the current page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfPregnancyCheckEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1"},"items":[{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfPregnancyCheckEvent",
      "expectedParturitionDate": "2023-09-14T00:00:00+00:00",
      "impliedInseminationDate": "2022-12-07T00:00:00+00:00",
      "method": "Echography",
      "result": "Pregnant",
      "foetalAge": 65,
      "foetusCount": 1,
      "foetusCountMale": 0,
      "foetusCountFemale": 1,
      "exceptions": [
        "Abnormal Calf"
      ],
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "UK001001001001",
        "scheme": "uk.cts.eartag"
      },
      "id": "30017d05-9ebf-4276-abbe-000372296309",
      "eventDateTime": "2023-02-10T13:00:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "PregnancyCheck",
        "scheme": "uk.fmapp.trait"
      },
      "responsible": "Ben Stokes",
      "contemporaryGroup": "2 year old heifers",
      "remark": "Cherry Lane Dairy Services",
      "@self": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.fmapp.farm",
        "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
        "isDeleted": false,
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@newco.com",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-12-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD666",
        "scheme": "uk.cph"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1"},"items":[{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}]}

GET data/holdings/{holdingId}/livestock/pregnancy-check-events

Gets the pregnancy check events for a holding via pagination

Request
GET /data/holdings/{holdingId}/livestock/pregnancy-check-events[?limit&offset]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the pregnancy check events for
limit

the maximum number of pregnancy check events on a page
offset

the number of pregnancy check events in the total set before the first one on the page
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfPregnancyCheckEvent]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1"},"items":[{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "pfPregnancyCheckEvent",
      "expectedParturitionDate": "2023-09-14T00:00:00+00:00",
      "impliedInseminationDate": "2022-12-07T00:00:00+00:00",
      "method": "Echography",
      "result": "Pregnant",
      "foetalAge": 65,
      "foetusCount": 1,
      "foetusCountMale": 0,
      "foetusCountFemale": 1,
      "exceptions": [
        "Abnormal Calf"
      ],
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "UK001001001001",
        "scheme": "uk.cts.eartag"
      },
      "id": "30017d05-9ebf-4276-abbe-000372296309",
      "eventDateTime": "2023-02-10T13:00:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "PregnancyCheck",
        "scheme": "uk.fmapp.trait"
      },
      "responsible": "Ben Stokes",
      "contemporaryGroup": "2 year old heifers",
      "remark": "Cherry Lane Dairy Services",
      "@self": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "uk.fmapp.farm",
        "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
        "isDeleted": false,
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@newco.com",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-12-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD666",
        "scheme": "uk.cph"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events?offset=0&limit=1"},"items":[{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}]}

GET data/livestock/pregnancy-check-events/{eventId}

Gets a single pregnancy check event by Id

Request
GET /data/livestock/pregnancy-check-events/{eventId}
Parameters
Name Type Default Notes
*eventId

The Id of the pregnancy check event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfPregnancyCheckEvent

Success
Mime type: text/plain 
{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}
Mime type: application/json 
{
  "resourceType": "pfPregnancyCheckEvent",
  "expectedParturitionDate": "2023-09-14T00:00:00+00:00",
  "impliedInseminationDate": "2022-12-07T00:00:00+00:00",
  "method": "Echography",
  "result": "Pregnant",
  "foetalAge": 65,
  "foetusCount": 1,
  "foetusCountMale": 0,
  "foetusCountFemale": 1,
  "exceptions": [
    "Abnormal Calf"
  ],
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "UK001001001001",
    "scheme": "uk.cts.eartag"
  },
  "id": "30017d05-9ebf-4276-abbe-000372296309",
  "eventDateTime": "2023-02-10T13:00:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "PregnancyCheck",
    "scheme": "uk.fmapp.trait"
  },
  "responsible": "Ben Stokes",
  "contemporaryGroup": "2 year old heifers",
  "remark": "Cherry Lane Dairy Services",
  "@self": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.fmapp.farm",
    "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
    "isDeleted": false,
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@newco.com",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-12-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD666",
    "scheme": "uk.cph"
  }
}
Mime type: text/json 
{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/pregnancy-check-events/{eventId}

Gets a single pregnancy check event event with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/livestock/pregnancy-check-events/{eventId}
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the pregnancy check event for
*eventId

The Id of the pregnancy check event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfPregnancyCheckEvent

Success
Mime type: text/plain 
{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}
Mime type: application/json 
{
  "resourceType": "pfPregnancyCheckEvent",
  "expectedParturitionDate": "2023-09-14T00:00:00+00:00",
  "impliedInseminationDate": "2022-12-07T00:00:00+00:00",
  "method": "Echography",
  "result": "Pregnant",
  "foetalAge": 65,
  "foetusCount": 1,
  "foetusCountMale": 0,
  "foetusCountFemale": 1,
  "exceptions": [
    "Abnormal Calf"
  ],
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "UK001001001001",
    "scheme": "uk.cts.eartag"
  },
  "id": "30017d05-9ebf-4276-abbe-000372296309",
  "eventDateTime": "2023-02-10T13:00:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "PregnancyCheck",
    "scheme": "uk.fmapp.trait"
  },
  "responsible": "Ben Stokes",
  "contemporaryGroup": "2 year old heifers",
  "remark": "Cherry Lane Dairy Services",
  "@self": "https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.fmapp.farm",
    "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
    "isDeleted": false,
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@newco.com",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-12-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD666",
    "scheme": "uk.cph"
  }
}
Mime type: text/json 
{"resourceType":"pfPregnancyCheckEvent","expectedParturitionDate":"2023-09-14T00:00:00+00:00","impliedInseminationDate":"2022-12-07T00:00:00+00:00","method":"Echography","result":"Pregnant","foetalAge":65,"foetusCount":1,"foetusCountMale":0,"foetusCountFemale":1,"exceptions":["Abnormal Calf"],"animal":{"resourceType":"icarIdentifierType","id":"UK001001001001","scheme":"uk.cts.eartag"},"id":"30017d05-9ebf-4276-abbe-000372296309","eventDateTime":"2023-02-10T13:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"PregnancyCheck","scheme":"uk.fmapp.trait"},"responsible":"Ben Stokes","contemporaryGroup":"2 year old heifers","remark":"Cherry Lane Dairy Services","@self":"https://api.dev.purefarming.com/data/livestock/pregnancy-check-events/30017d05-9ebf-4276-abbe-000372296309","meta":{"resourceType":"icarMetaDataType","source":"uk.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-12-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD666","scheme":"uk.cph"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Stock reconciliation

GET data/livestock/stock-reconciliations

Gets all of the stock reconciliations that you have access to, optional filters can be applied

Request
GET /data/livestock/stock-reconciliations[?StartPeriodStart&StartPeriodEnd&EndDate&DurationType]
Parameters
Name Type Default Notes
StartPeriodStart

The Start Date for the start period to filter on
StartPeriodEnd

The End Date for the start period to filter on
EndDate

The End Date to search before
DurationType

Duration type to filter on, valid values: W, M, Y
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfStockReconciliation[]

Success
Mime type: text/plain 
[{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/29080c1a-d785-4729-be7f-4faa1c7ca87d","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"323d3821-182b-453b-873f-13515abf039d","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}]
Mime type: application/json 
[
  {
    "resourceType": "pfStockReconciliation",
    "startDate": "2022-09-01T00:00:00+00:00",
    "endDate": "2022-09-30T23:59:59+00:00",
    "duration": "M",
    "inventoryClassification": {
      "resourceType": "icarInventoryClassificationType",
      "name": "Breeding ewes",
      "count": 375,
      "species": "Sheep",
      "sex": "Female",
      "primaryBreed": {
        "id": "FF",
        "scheme": "uk.lis.breed"
      },
      "birthPeriod": "2016-01-01/2021-12-31",
      "reproductiveStatus": "NotPregnant",
      "lactationStatus": "Dry",
      "productionPurposes": [
        "Milk",
        "Meat"
      ]
    },
    "open": 375,
    "arrivalsTotal": 17,
    "arrivals": [
      {
        "resourceType": "pfStockArrivalReasonType",
        "reason": "Purchase",
        "count": 15
      },
      {
        "resourceType": "pfStockArrivalReasonType",
        "reason": "Imported",
        "count": 2
      }
    ],
    "departuresTotal": 4,
    "departures": [
      {
        "resourceType": "pfStockDepartureKindType",
        "kind": "Sale",
        "count": 4
      }
    ],
    "births": 10,
    "deaths": 3,
    "agedIn": 33,
    "agedOut": 10,
    "close": 418,
    "@self": "https://api.dev.purefarming.com/data/livestock/stock-reconciliation/29080c1a-d785-4729-be7f-4faa1c7ca87d",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "uk.stockco.suppliers.xxx",
      "sourceId": "323d3821-182b-453b-873f-13515abf039d",
      "modified": "2022-10-03T11:00:00+00:00",
      "created": "2022-10-03T09:00:00+00:00",
      "creator": "don.wilson@newco.com",
      "validFrom": "2022-10-03T11:00:00+00:00",
      "validTo": "2022-12-03T11:00:00+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "33/44/5555",
      "scheme": "uk.cph"
    }
  }
]
Mime type: text/json 
[{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/29080c1a-d785-4729-be7f-4faa1c7ca87d","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"323d3821-182b-453b-873f-13515abf039d","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}]
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/livestock/stock-reconciliations/{stockReconciliationId}

Request
GET /data/livestock/stock-reconciliations/{stockReconciliationId}
Parameters
Name Type Default Notes
*stockReconciliationId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfStockReconciliation

Success
Mime type: text/plain 
{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/a9964dd0-a0c1-4285-a9ac-a5bd0932cf74","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"74185527-a4b1-41d5-a1d3-a5cc2453c93d","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}
Mime type: application/json 
{
  "resourceType": "pfStockReconciliation",
  "startDate": "2022-09-01T00:00:00+00:00",
  "endDate": "2022-09-30T23:59:59+00:00",
  "duration": "M",
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Breeding ewes",
    "count": 375,
    "species": "Sheep",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "uk.lis.breed"
    },
    "birthPeriod": "2016-01-01/2021-12-31",
    "reproductiveStatus": "NotPregnant",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Milk",
      "Meat"
    ]
  },
  "open": 375,
  "arrivalsTotal": 17,
  "arrivals": [
    {
      "resourceType": "pfStockArrivalReasonType",
      "reason": "Purchase",
      "count": 15
    },
    {
      "resourceType": "pfStockArrivalReasonType",
      "reason": "Imported",
      "count": 2
    }
  ],
  "departuresTotal": 4,
  "departures": [
    {
      "resourceType": "pfStockDepartureKindType",
      "kind": "Sale",
      "count": 4
    }
  ],
  "births": 10,
  "deaths": 3,
  "agedIn": 33,
  "agedOut": 10,
  "close": 418,
  "@self": "https://api.dev.purefarming.com/data/livestock/stock-reconciliation/a9964dd0-a0c1-4285-a9ac-a5bd0932cf74",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "uk.stockco.suppliers.xxx",
    "sourceId": "74185527-a4b1-41d5-a1d3-a5cc2453c93d",
    "modified": "2022-10-03T11:00:00+00:00",
    "created": "2022-10-03T09:00:00+00:00",
    "creator": "don.wilson@newco.com",
    "validFrom": "2022-10-03T11:00:00+00:00",
    "validTo": "2022-12-03T11:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "33/44/5555",
    "scheme": "uk.cph"
  }
}
Mime type: text/json 
{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/a9964dd0-a0c1-4285-a9ac-a5bd0932cf74","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"74185527-a4b1-41d5-a1d3-a5cc2453c93d","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/stock-reconciliations

Request
GET /data/holdings/{holdingId}/livestock/stock-reconciliations
Parameters
Name Type Default Notes
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfStockReconciliation[]

Success
Mime type: text/plain 
[{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/8fb3cbd0-1f93-468b-b092-572e84fcfd13","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"3dd4e475-5bb0-409d-9436-67b0dc299ec1","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}]
Mime type: application/json 
[
  {
    "resourceType": "pfStockReconciliation",
    "startDate": "2022-09-01T00:00:00+00:00",
    "endDate": "2022-09-30T23:59:59+00:00",
    "duration": "M",
    "inventoryClassification": {
      "resourceType": "icarInventoryClassificationType",
      "name": "Breeding ewes",
      "count": 375,
      "species": "Sheep",
      "sex": "Female",
      "primaryBreed": {
        "id": "FF",
        "scheme": "uk.lis.breed"
      },
      "birthPeriod": "2016-01-01/2021-12-31",
      "reproductiveStatus": "NotPregnant",
      "lactationStatus": "Dry",
      "productionPurposes": [
        "Milk",
        "Meat"
      ]
    },
    "open": 375,
    "arrivalsTotal": 17,
    "arrivals": [
      {
        "resourceType": "pfStockArrivalReasonType",
        "reason": "Purchase",
        "count": 15
      },
      {
        "resourceType": "pfStockArrivalReasonType",
        "reason": "Imported",
        "count": 2
      }
    ],
    "departuresTotal": 4,
    "departures": [
      {
        "resourceType": "pfStockDepartureKindType",
        "kind": "Sale",
        "count": 4
      }
    ],
    "births": 10,
    "deaths": 3,
    "agedIn": 33,
    "agedOut": 10,
    "close": 418,
    "@self": "https://api.dev.purefarming.com/data/livestock/stock-reconciliation/8fb3cbd0-1f93-468b-b092-572e84fcfd13",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "uk.stockco.suppliers.xxx",
      "sourceId": "3dd4e475-5bb0-409d-9436-67b0dc299ec1",
      "modified": "2022-10-03T11:00:00+00:00",
      "created": "2022-10-03T09:00:00+00:00",
      "creator": "don.wilson@newco.com",
      "validFrom": "2022-10-03T11:00:00+00:00",
      "validTo": "2022-12-03T11:00:00+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "33/44/5555",
      "scheme": "uk.cph"
    }
  }
]
Mime type: text/json 
[{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/8fb3cbd0-1f93-468b-b092-572e84fcfd13","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"3dd4e475-5bb0-409d-9436-67b0dc299ec1","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}]
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/livestock/stock-reconciliations/{stockReconciliationId}

Request
GET /data/holdings/{holdingId}/livestock/stock-reconciliations/{stockReconciliationId}
Parameters
Name Type Default Notes
*holdingId
*stockReconciliationId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.pfStockReconciliation[]

Success
Mime type: text/plain 
[{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/f50f342c-ce1f-410b-b379-0600a0e5ee15","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"b57a9d29-d30e-49b2-911e-2f8b7698d8e0","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}]
Mime type: application/json 
[
  {
    "resourceType": "pfStockReconciliation",
    "startDate": "2022-09-01T00:00:00+00:00",
    "endDate": "2022-09-30T23:59:59+00:00",
    "duration": "M",
    "inventoryClassification": {
      "resourceType": "icarInventoryClassificationType",
      "name": "Breeding ewes",
      "count": 375,
      "species": "Sheep",
      "sex": "Female",
      "primaryBreed": {
        "id": "FF",
        "scheme": "uk.lis.breed"
      },
      "birthPeriod": "2016-01-01/2021-12-31",
      "reproductiveStatus": "NotPregnant",
      "lactationStatus": "Dry",
      "productionPurposes": [
        "Milk",
        "Meat"
      ]
    },
    "open": 375,
    "arrivalsTotal": 17,
    "arrivals": [
      {
        "resourceType": "pfStockArrivalReasonType",
        "reason": "Purchase",
        "count": 15
      },
      {
        "resourceType": "pfStockArrivalReasonType",
        "reason": "Imported",
        "count": 2
      }
    ],
    "departuresTotal": 4,
    "departures": [
      {
        "resourceType": "pfStockDepartureKindType",
        "kind": "Sale",
        "count": 4
      }
    ],
    "births": 10,
    "deaths": 3,
    "agedIn": 33,
    "agedOut": 10,
    "close": 418,
    "@self": "https://api.dev.purefarming.com/data/livestock/stock-reconciliation/f50f342c-ce1f-410b-b379-0600a0e5ee15",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "uk.stockco.suppliers.xxx",
      "sourceId": "b57a9d29-d30e-49b2-911e-2f8b7698d8e0",
      "modified": "2022-10-03T11:00:00+00:00",
      "created": "2022-10-03T09:00:00+00:00",
      "creator": "don.wilson@newco.com",
      "validFrom": "2022-10-03T11:00:00+00:00",
      "validTo": "2022-12-03T11:00:00+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "33/44/5555",
      "scheme": "uk.cph"
    }
  }
]
Mime type: text/json 
[{"resourceType":"pfStockReconciliation","startDate":"2022-09-01T00:00:00+00:00","endDate":"2022-09-30T23:59:59+00:00","duration":"M","inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Breeding ewes","count":375.0,"species":"Sheep","sex":"Female","primaryBreed":{"id":"FF","scheme":"uk.lis.breed"},"birthPeriod":"2016-01-01/2021-12-31","reproductiveStatus":"NotPregnant","lactationStatus":"Dry","productionPurposes":["Milk","Meat"]},"open":375,"arrivalsTotal":17,"arrivals":[{"resourceType":"pfStockArrivalReasonType","reason":"Purchase","count":15},{"resourceType":"pfStockArrivalReasonType","reason":"Imported","count":2}],"departuresTotal":4,"departures":[{"resourceType":"pfStockDepartureKindType","kind":"Sale","count":4}],"births":10,"deaths":3,"agedIn":33,"agedOut":10,"close":418,"@self":"https://api.dev.purefarming.com/data/livestock/stock-reconciliation/f50f342c-ce1f-410b-b379-0600a0e5ee15","meta":{"resourceType":"icarMetaDataType","source":"uk.stockco.suppliers.xxx","sourceId":"b57a9d29-d30e-49b2-911e-2f8b7698d8e0","modified":"2022-10-03T11:00:00+00:00","created":"2022-10-03T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2022-10-03T11:00:00+00:00","validTo":"2022-12-03T11:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"33/44/5555","scheme":"uk.cph"}}]
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Treatment :: Animal treatment events

GET data/livestock/treatment/animal-treatment-events

Gets all of the animal treatment events the user has access to via pagination

Request
GET /data/livestock/treatment/animal-treatment-events[?limit&offset&animalIdentifier&animalIdentifierScheme]
Parameters
Name Type Default Notes
limit

the maximum number of items per page
offset

the number of items offset from the start of the set for the current page
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarTreatmentEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarTreatmentEventResource",
      "medicine": {
        "resourceType": "icarMedicineReferenceType",
        "name": "MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS",
        "approved": "Registered",
        "registeredIdentifier": {
          "id": "49851",
          "scheme": "au.gov.apvma"
        },
        "identifier": {
          "id": "49851",
          "scheme": "au.gov.apvma"
        },
        "reltype": "ProductCharacteristics",
        "href": "https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"
      },
      "procedure": "Injection",
      "batches": [
        {
          "resourceType": "icarMedicineBatchType",
          "identifier": "DST001",
          "expiryDate": "2023-06-16T00:00:00+00:00"
        }
      ],
      "withdrawals": [
        {
          "resourceType": "icarMedicineWithdrawalType",
          "productType": "Meat",
          "endDate": "2022-11-18T17:06:00+00:00",
          "market": "au.gov.apvma.whp"
        },
        {
          "resourceType": "icarMedicineWithdrawalType",
          "productType": "Milk",
          "endDate": "2022-10-26T17:06:00+00:00"
        }
      ],
      "dose": {
        "resourceType": "icarMedicineDoseType",
        "doseQuantity": 10,
        "doseUnits": "MLT"
      },
      "site": "Intra Mammary",
      "positions": [
        {
          "resourceType": "icarPositionType",
          "position": "UdderFrontLeft"
        }
      ],
      "comment": "Severe inflammation",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "641 123456789012",
        "scheme": "au.nlis"
      },
      "id": "testId",
      "eventDateTime": "2023-02-10T09:06:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Milk production",
        "scheme": "au.nvd"
      },
      "responsible": "John Bishop",
      "contemporaryGroup": "2022 Heifers",
      "remark": "Mastitis treatment 10 February 2023",
      "@self": "testUri",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "au.bzagri.app",
        "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
        "isDeleted": false,
        "modified": "2023-02-10T14:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@bzagri.com.au",
        "validFrom": "2023-02-10T14:00:00+00:00",
        "validTo": "2023-12-10T14:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD000",
        "scheme": "au.nlis.pic"
      },
      "dataPointKey": "sample-animal-treatment-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}]}

GET data/livestock/treatment/animal-treatment-events/{treatmentId}

Gets a single animal treatment event by Id

Request
GET /data/livestock/treatment/animal-treatment-events/{treatmentId}
Parameters
Name Type Default Notes
*treatmentId

The Id of the animal treatment event to get
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarTreatmentEventResource

Success
Mime type: text/plain 
{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}
Mime type: application/json 
{
  "resourceType": "icarTreatmentEventResource",
  "medicine": {
    "resourceType": "icarMedicineReferenceType",
    "name": "MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS",
    "approved": "Registered",
    "registeredIdentifier": {
      "id": "49851",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "49851",
      "scheme": "au.gov.apvma"
    },
    "reltype": "ProductCharacteristics",
    "href": "https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"
  },
  "procedure": "Injection",
  "batches": [
    {
      "resourceType": "icarMedicineBatchType",
      "identifier": "DST001",
      "expiryDate": "2023-06-16T00:00:00+00:00"
    }
  ],
  "withdrawals": [
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Meat",
      "endDate": "2022-11-18T17:06:00+00:00",
      "market": "au.gov.apvma.whp"
    },
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Milk",
      "endDate": "2022-10-26T17:06:00+00:00"
    }
  ],
  "dose": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 10,
    "doseUnits": "MLT"
  },
  "site": "Intra Mammary",
  "positions": [
    {
      "resourceType": "icarPositionType",
      "position": "UdderFrontLeft"
    }
  ],
  "comment": "Severe inflammation",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "641 123456789012",
    "scheme": "au.nlis"
  },
  "id": "testId",
  "eventDateTime": "2023-02-10T09:06:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Milk production",
    "scheme": "au.nvd"
  },
  "responsible": "John Bishop",
  "contemporaryGroup": "2022 Heifers",
  "remark": "Mastitis treatment 10 February 2023",
  "@self": "testUri",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "au.bzagri.app",
    "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
    "isDeleted": false,
    "modified": "2023-02-10T14:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@bzagri.com.au",
    "validFrom": "2023-02-10T14:00:00+00:00",
    "validTo": "2023-12-10T14:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD000",
    "scheme": "au.nlis.pic"
  },
  "dataPointKey": "sample-animal-treatment-f"
}
Mime type: text/json 
{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/treatment/animal-treatment-events

Gets the animal treatment events for a holding via pagination

Request
GET /data/holdings/{holdingId}/livestock/treatment/animal-treatment-events[?limit&offset&animalIdentifier&animalIdentifierScheme]
Parameters
Name Type Default Notes
*holdingId

the Id of the holding to get the animal treatments for
limit

the maximum number of treatment events on a page
offset

the number of treatment events in the total set before the first one on the page
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarTreatmentEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarTreatmentEventResource",
      "medicine": {
        "resourceType": "icarMedicineReferenceType",
        "name": "MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS",
        "approved": "Registered",
        "registeredIdentifier": {
          "id": "49851",
          "scheme": "au.gov.apvma"
        },
        "identifier": {
          "id": "49851",
          "scheme": "au.gov.apvma"
        },
        "reltype": "ProductCharacteristics",
        "href": "https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"
      },
      "procedure": "Injection",
      "batches": [
        {
          "resourceType": "icarMedicineBatchType",
          "identifier": "DST001",
          "expiryDate": "2023-06-16T00:00:00+00:00"
        }
      ],
      "withdrawals": [
        {
          "resourceType": "icarMedicineWithdrawalType",
          "productType": "Meat",
          "endDate": "2022-11-18T17:06:00+00:00",
          "market": "au.gov.apvma.whp"
        },
        {
          "resourceType": "icarMedicineWithdrawalType",
          "productType": "Milk",
          "endDate": "2022-10-26T17:06:00+00:00"
        }
      ],
      "dose": {
        "resourceType": "icarMedicineDoseType",
        "doseQuantity": 10,
        "doseUnits": "MLT"
      },
      "site": "Intra Mammary",
      "positions": [
        {
          "resourceType": "icarPositionType",
          "position": "UdderFrontLeft"
        }
      ],
      "comment": "Severe inflammation",
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "641 123456789012",
        "scheme": "au.nlis"
      },
      "id": "testId",
      "eventDateTime": "2023-02-10T09:06:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Milk production",
        "scheme": "au.nvd"
      },
      "responsible": "John Bishop",
      "contemporaryGroup": "2022 Heifers",
      "remark": "Mastitis treatment 10 February 2023",
      "@self": "testUri",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "au.bzagri.app",
        "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
        "isDeleted": false,
        "modified": "2023-02-10T14:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@bzagri.com.au",
        "validFrom": "2023-02-10T14:00:00+00:00",
        "validTo": "2023-12-10T14:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "3ABCD000",
        "scheme": "au.nlis.pic"
      },
      "dataPointKey": "sample-animal-treatment-f"
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/treatment/animal-treatment-events?offset=0&limit=1"},"items":[{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}]}

GET data/holdings/{holdingId}/livestock/treatment/animal-treatment-events/{treatmentId}

Gets a single animal treatment event with the given Id on the given holding

Request
GET /data/holdings/{holdingId}/livestock/treatment/animal-treatment-events/{treatmentId}
Parameters
Name Type Default Notes
*holdingId
*treatmentId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarTreatmentEventResource

Success
Mime type: text/plain 
{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}
Mime type: application/json 
{
  "resourceType": "icarTreatmentEventResource",
  "medicine": {
    "resourceType": "icarMedicineReferenceType",
    "name": "MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS",
    "approved": "Registered",
    "registeredIdentifier": {
      "id": "49851",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "49851",
      "scheme": "au.gov.apvma"
    },
    "reltype": "ProductCharacteristics",
    "href": "https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"
  },
  "procedure": "Injection",
  "batches": [
    {
      "resourceType": "icarMedicineBatchType",
      "identifier": "DST001",
      "expiryDate": "2023-06-16T00:00:00+00:00"
    }
  ],
  "withdrawals": [
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Meat",
      "endDate": "2022-11-18T17:06:00+00:00",
      "market": "au.gov.apvma.whp"
    },
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Milk",
      "endDate": "2022-10-26T17:06:00+00:00"
    }
  ],
  "dose": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 10,
    "doseUnits": "MLT"
  },
  "site": "Intra Mammary",
  "positions": [
    {
      "resourceType": "icarPositionType",
      "position": "UdderFrontLeft"
    }
  ],
  "comment": "Severe inflammation",
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "641 123456789012",
    "scheme": "au.nlis"
  },
  "id": "testId",
  "eventDateTime": "2023-02-10T09:06:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Milk production",
    "scheme": "au.nvd"
  },
  "responsible": "John Bishop",
  "contemporaryGroup": "2022 Heifers",
  "remark": "Mastitis treatment 10 February 2023",
  "@self": "testUri",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "au.bzagri.app",
    "sourceId": "78328ab6-b79b-41ed-b177-6d0b59caa047",
    "isDeleted": false,
    "modified": "2023-02-10T14:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@bzagri.com.au",
    "validFrom": "2023-02-10T14:00:00+00:00",
    "validTo": "2023-12-10T14:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD000",
    "scheme": "au.nlis.pic"
  },
  "dataPointKey": "sample-animal-treatment-f"
}
Mime type: text/json 
{"resourceType":"icarTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"MASTALONE INTRAMAMMARY SUSPENSION FOR LACTATING COWS","approved":"Registered","registeredIdentifier":{"id":"49851","scheme":"au.gov.apvma"},"identifier":{"id":"49851","scheme":"au.gov.apvma"},"reltype":"ProductCharacteristics","href":"https://myhealthbox.eu/en/view/1400444/95fd21950bdae5de3f4903e677affa12/leaflet"},"procedure":"Injection","batches":[{"resourceType":"icarMedicineBatchType","identifier":"DST001","expiryDate":"2023-06-16T00:00:00+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2022-11-18T17:06:00+00:00","market":"au.gov.apvma.whp"},{"resourceType":"icarMedicineWithdrawalType","productType":"Milk","endDate":"2022-10-26T17:06:00+00:00"}],"dose":{"resourceType":"icarMedicineDoseType","doseQuantity":10.0,"doseUnits":"MLT"},"site":"Intra Mammary","positions":[{"resourceType":"icarPositionType","position":"UdderFrontLeft"}],"comment":"Severe inflammation","animal":{"resourceType":"icarIdentifierType","id":"641 123456789012","scheme":"au.nlis"},"id":"testId","eventDateTime":"2023-02-10T09:06:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Milk production","scheme":"au.nvd"},"responsible":"John Bishop","contemporaryGroup":"2022 Heifers","remark":"Mastitis treatment 10 February 2023","@self":"testUri","meta":{"resourceType":"icarMetaDataType","source":"au.bzagri.app","sourceId":"78328ab6-b79b-41ed-b177-6d0b59caa047","isDeleted":false,"modified":"2023-02-10T14:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@bzagri.com.au","validFrom":"2023-02-10T14:00:00+00:00","validTo":"2023-12-10T14:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD000","scheme":"au.nlis.pic"},"dataPointKey":"sample-animal-treatment-f"}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Treatments :: Group events

GET data/livestock/treatments/group-events

Get all group treatment events that you have access to

Request
GET /data/livestock/treatments/group-events
Parameters
Name Type Default Notes
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupTreatmentEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9776448+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.9776462+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"0f538a38-9bac-44ee-9f95-5ba198370023","eventDateTime":"2024-02-26T03:19:33.9776426+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/0f538a38-9bac-44ee-9f95-5ba198370023","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"ced5ac5b-33e5-48df-95b0-f673b84b61a6","modified":"2024-02-26T03:19:33.9776423+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarGroupTreatmentEventResource",
  "medicine": {
    "resourceType": "icarMedicineReferenceType",
    "name": "SURESHOT DUO COMBINATION POUR-ON FOR CATTLE",
    "approved": "Registered",
    "registeredIdentifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "reltype": "Tech sheet",
    "href": "https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"
  },
  "procedure": "Pour-on",
  "batches": [
    {
      "resourceType": "icarMedicineBatchType",
      "identifier": "KFK001",
      "expiryDate": "2024-02-26T03:19:33.9776448+00:00"
    }
  ],
  "withdrawals": [
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Meat",
      "endDate": "2024-02-26T03:19:33.9776462+00:00",
      "market": "au.gov.apvma.whp"
    }
  ],
  "dosePerAnimal": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 27.5,
    "doseUnits": "MLT"
  },
  "totalMedicineUsed": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 84,
    "doseUnits": "MLT"
  },
  "site": "Back",
  "positions": [
    {
      "resourceType": "icarPositionType",
      "position": "Back"
    }
  ],
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Milking Herd 2022",
    "count": 300,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "birthPeriod": "2016-07-01/2020-08-31",
    "reproductiveStatus": "Pregnant",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Milk"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "7BGK640",
    "name": "Animals with gastrointestinal worms",
    "purpose": "Health",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "641 123477437171",
        "scheme": "au.nlis"
      }
    ]
  },
  "id": "0f538a38-9bac-44ee-9f95-5ba198370023",
  "eventDateTime": "2024-02-26T03:19:33.9776426+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Health Treatment",
    "scheme": "au.nvd"
  },
  "responsible": "Zoey Smith",
  "contemporaryGroup": "Milking Herd 2022",
  "remark": "Gastrointestinal worms treatment event 5 September",
  "@self": "https://api.dev.purefarming.com/data/livestock/treatment/group-event/0f538a38-9bac-44ee-9f95-5ba198370023",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.data-source.example",
    "sourceId": "ced5ac5b-33e5-48df-95b0-f673b84b61a6",
    "modified": "2024-02-26T03:19:33.9776423+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD777",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9776448+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.9776462+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"0f538a38-9bac-44ee-9f95-5ba198370023","eventDateTime":"2024-02-26T03:19:33.9776426+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/0f538a38-9bac-44ee-9f95-5ba198370023","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"ced5ac5b-33e5-48df-95b0-f673b84b61a6","modified":"2024-02-26T03:19:33.9776423+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}

GET data/livestock/treatments/group-events/{treatmentId}

Get a single group treatment event

Request
GET /data/livestock/treatments/group-events/{treatmentId}
Parameters
Name Type Default Notes
*treatmentId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupTreatmentEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9799997+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.9800009+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"337d317f-0c46-4f4d-8997-be66874a44b0","eventDateTime":"2024-02-26T03:19:33.9799984+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/337d317f-0c46-4f4d-8997-be66874a44b0","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"76918c7a-b3f3-4302-bbba-720e9b1fea91","modified":"2024-02-26T03:19:33.9799981+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarGroupTreatmentEventResource",
  "medicine": {
    "resourceType": "icarMedicineReferenceType",
    "name": "SURESHOT DUO COMBINATION POUR-ON FOR CATTLE",
    "approved": "Registered",
    "registeredIdentifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "reltype": "Tech sheet",
    "href": "https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"
  },
  "procedure": "Pour-on",
  "batches": [
    {
      "resourceType": "icarMedicineBatchType",
      "identifier": "KFK001",
      "expiryDate": "2024-02-26T03:19:33.9799997+00:00"
    }
  ],
  "withdrawals": [
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Meat",
      "endDate": "2024-02-26T03:19:33.9800009+00:00",
      "market": "au.gov.apvma.whp"
    }
  ],
  "dosePerAnimal": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 27.5,
    "doseUnits": "MLT"
  },
  "totalMedicineUsed": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 84,
    "doseUnits": "MLT"
  },
  "site": "Back",
  "positions": [
    {
      "resourceType": "icarPositionType",
      "position": "Back"
    }
  ],
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Milking Herd 2022",
    "count": 300,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "birthPeriod": "2016-07-01/2020-08-31",
    "reproductiveStatus": "Pregnant",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Milk"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "7BGK640",
    "name": "Animals with gastrointestinal worms",
    "purpose": "Health",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "641 123477437171",
        "scheme": "au.nlis"
      }
    ]
  },
  "id": "337d317f-0c46-4f4d-8997-be66874a44b0",
  "eventDateTime": "2024-02-26T03:19:33.9799984+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Health Treatment",
    "scheme": "au.nvd"
  },
  "responsible": "Zoey Smith",
  "contemporaryGroup": "Milking Herd 2022",
  "remark": "Gastrointestinal worms treatment event 5 September",
  "@self": "https://api.dev.purefarming.com/data/livestock/treatment/group-event/337d317f-0c46-4f4d-8997-be66874a44b0",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.data-source.example",
    "sourceId": "76918c7a-b3f3-4302-bbba-720e9b1fea91",
    "modified": "2024-02-26T03:19:33.9799981+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD777",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9799997+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.9800009+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"337d317f-0c46-4f4d-8997-be66874a44b0","eventDateTime":"2024-02-26T03:19:33.9799984+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/337d317f-0c46-4f4d-8997-be66874a44b0","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"76918c7a-b3f3-4302-bbba-720e9b1fea91","modified":"2024-02-26T03:19:33.9799981+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/treatments/group-events

Get all group treatment events associated with a holding

Request
GET /data/holdings/{holdingId}/livestock/treatments/group-events
Parameters
Name Type Default Notes
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupTreatmentEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9820601+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.9820615+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"5e273528-dfee-4cde-a8d0-991ed1debf26","eventDateTime":"2024-02-26T03:19:33.9820588+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/5e273528-dfee-4cde-a8d0-991ed1debf26","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"909e059c-98b6-45eb-b7d6-dfff105dad8f","modified":"2024-02-26T03:19:33.9820585+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarGroupTreatmentEventResource",
  "medicine": {
    "resourceType": "icarMedicineReferenceType",
    "name": "SURESHOT DUO COMBINATION POUR-ON FOR CATTLE",
    "approved": "Registered",
    "registeredIdentifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "reltype": "Tech sheet",
    "href": "https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"
  },
  "procedure": "Pour-on",
  "batches": [
    {
      "resourceType": "icarMedicineBatchType",
      "identifier": "KFK001",
      "expiryDate": "2024-02-26T03:19:33.9820601+00:00"
    }
  ],
  "withdrawals": [
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Meat",
      "endDate": "2024-02-26T03:19:33.9820615+00:00",
      "market": "au.gov.apvma.whp"
    }
  ],
  "dosePerAnimal": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 27.5,
    "doseUnits": "MLT"
  },
  "totalMedicineUsed": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 84,
    "doseUnits": "MLT"
  },
  "site": "Back",
  "positions": [
    {
      "resourceType": "icarPositionType",
      "position": "Back"
    }
  ],
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Milking Herd 2022",
    "count": 300,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "birthPeriod": "2016-07-01/2020-08-31",
    "reproductiveStatus": "Pregnant",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Milk"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "7BGK640",
    "name": "Animals with gastrointestinal worms",
    "purpose": "Health",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "641 123477437171",
        "scheme": "au.nlis"
      }
    ]
  },
  "id": "5e273528-dfee-4cde-a8d0-991ed1debf26",
  "eventDateTime": "2024-02-26T03:19:33.9820588+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Health Treatment",
    "scheme": "au.nvd"
  },
  "responsible": "Zoey Smith",
  "contemporaryGroup": "Milking Herd 2022",
  "remark": "Gastrointestinal worms treatment event 5 September",
  "@self": "https://api.dev.purefarming.com/data/livestock/treatment/group-event/5e273528-dfee-4cde-a8d0-991ed1debf26",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.data-source.example",
    "sourceId": "909e059c-98b6-45eb-b7d6-dfff105dad8f",
    "modified": "2024-02-26T03:19:33.9820585+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD777",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9820601+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.9820615+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"5e273528-dfee-4cde-a8d0-991ed1debf26","eventDateTime":"2024-02-26T03:19:33.9820588+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/5e273528-dfee-4cde-a8d0-991ed1debf26","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"909e059c-98b6-45eb-b7d6-dfff105dad8f","modified":"2024-02-26T03:19:33.9820585+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}

GET data/holdings/{holdingId}/livestock/treatments/group-events/{treatmentId}

Get a single group treatment event associated with a holding

Request
GET /data/holdings/{holdingId}/livestock/treatments/group-events/{treatmentId}
Parameters
Name Type Default Notes
*holdingId
*treatmentId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupTreatmentEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9854255+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.985428+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"266ccee0-233c-4494-ab9d-17846276efb1","eventDateTime":"2024-02-26T03:19:33.9854221+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/266ccee0-233c-4494-ab9d-17846276efb1","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"34b80e34-5682-40ae-893f-99851d10d7ec","modified":"2024-02-26T03:19:33.9854215+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
Mime type: application/json 
{
  "resourceType": "icarGroupTreatmentEventResource",
  "medicine": {
    "resourceType": "icarMedicineReferenceType",
    "name": "SURESHOT DUO COMBINATION POUR-ON FOR CATTLE",
    "approved": "Registered",
    "registeredIdentifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "identifier": {
      "id": "87741",
      "scheme": "au.gov.apvma"
    },
    "reltype": "Tech sheet",
    "href": "https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"
  },
  "procedure": "Pour-on",
  "batches": [
    {
      "resourceType": "icarMedicineBatchType",
      "identifier": "KFK001",
      "expiryDate": "2024-02-26T03:19:33.9854255+00:00"
    }
  ],
  "withdrawals": [
    {
      "resourceType": "icarMedicineWithdrawalType",
      "productType": "Meat",
      "endDate": "2024-02-26T03:19:33.985428+00:00",
      "market": "au.gov.apvma.whp"
    }
  ],
  "dosePerAnimal": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 27.5,
    "doseUnits": "MLT"
  },
  "totalMedicineUsed": {
    "resourceType": "icarMedicineDoseType",
    "doseQuantity": 84,
    "doseUnits": "MLT"
  },
  "site": "Back",
  "positions": [
    {
      "resourceType": "icarPositionType",
      "position": "Back"
    }
  ],
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 3,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Milking Herd 2022",
    "count": 300,
    "species": "Cattle",
    "sex": "Female",
    "primaryBreed": {
      "id": "FF",
      "scheme": "au.nlis.breed"
    },
    "birthPeriod": "2016-07-01/2020-08-31",
    "reproductiveStatus": "Pregnant",
    "lactationStatus": "Lactating",
    "productionPurposes": [
      "Milk"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "7BGK640",
    "name": "Animals with gastrointestinal worms",
    "purpose": "Health",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "641 123477437171",
        "scheme": "au.nlis"
      }
    ]
  },
  "id": "266ccee0-233c-4494-ab9d-17846276efb1",
  "eventDateTime": "2024-02-26T03:19:33.9854221+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Health Treatment",
    "scheme": "au.nvd"
  },
  "responsible": "Zoey Smith",
  "contemporaryGroup": "Milking Herd 2022",
  "remark": "Gastrointestinal worms treatment event 5 September",
  "@self": "https://api.dev.purefarming.com/data/livestock/treatment/group-event/266ccee0-233c-4494-ab9d-17846276efb1",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.data-source.example",
    "sourceId": "34b80e34-5682-40ae-893f-99851d10d7ec",
    "modified": "2024-02-26T03:19:33.9854215+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "3ABCD777",
    "scheme": "au.nlis.pic"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupTreatmentEventResource","medicine":{"resourceType":"icarMedicineReferenceType","name":"SURESHOT DUO COMBINATION POUR-ON FOR CATTLE","approved":"Registered","registeredIdentifier":{"id":"87741","scheme":"au.gov.apvma"},"identifier":{"id":"87741","scheme":"au.gov.apvma"},"reltype":"Tech sheet","href":"https://cdn.specialistsales.com.au/wp-content/uploads/2022/06/10154413/Sureshot_Duo_Combination_Pour-On_For_Cattle__TechSheet.pdf"},"procedure":"Pour-on","batches":[{"resourceType":"icarMedicineBatchType","identifier":"KFK001","expiryDate":"2024-02-26T03:19:33.9854255+00:00"}],"withdrawals":[{"resourceType":"icarMedicineWithdrawalType","productType":"Meat","endDate":"2024-02-26T03:19:33.985428+00:00","market":"au.gov.apvma.whp"}],"dosePerAnimal":{"resourceType":"icarMedicineDoseType","doseQuantity":27.5,"doseUnits":"MLT"},"totalMedicineUsed":{"resourceType":"icarMedicineDoseType","doseQuantity":84.0,"doseUnits":"MLT"},"site":"Back","positions":[{"resourceType":"icarPositionType","position":"Back"}],"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":3,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Milking Herd 2022","count":300.0,"species":"Cattle","sex":"Female","primaryBreed":{"id":"FF","scheme":"au.nlis.breed"},"birthPeriod":"2016-07-01/2020-08-31","reproductiveStatus":"Pregnant","lactationStatus":"Lactating","productionPurposes":["Milk"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"7BGK640","name":"Animals with gastrointestinal worms","purpose":"Health","member":[{"resourceType":"icarIdentifierType","id":"641 123477437171","scheme":"au.nlis"}]},"id":"266ccee0-233c-4494-ab9d-17846276efb1","eventDateTime":"2024-02-26T03:19:33.9854221+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Health Treatment","scheme":"au.nvd"},"responsible":"Zoey Smith","contemporaryGroup":"Milking Herd 2022","remark":"Gastrointestinal worms treatment event 5 September","@self":"https://api.dev.purefarming.com/data/livestock/treatment/group-event/266ccee0-233c-4494-ab9d-17846276efb1","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.data-source.example","sourceId":"34b80e34-5682-40ae-893f-99851d10d7ec","modified":"2024-02-26T03:19:33.9854215+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"3ABCD777","scheme":"au.nlis.pic"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Weight :: Group weight events

GET data/livestock/weight/group-weight-events

Get all group weight events

Request
GET /data/livestock/weight/group-weight-events
Parameters
Name Type Default Notes
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupWeightEventResource[]

Success
Mime type: text/plain 
[{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/bc0477cd-5312-4f11-aeaa-fc7a1848d690","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"4560600a-fb15-4718-8d48-da995e0788e7","modified":"2024-02-26T03:19:33.9940528+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"acdc7be3-b918-4557-9ff0-a8eee4901592","eventDateTime":"2024-02-26T03:19:33.9940494+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/acdc7be3-b918-4557-9ff0-a8eee4901592","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"c630a038-32d9-4813-b27a-7aa3e984050b","modified":"2024-02-26T03:19:33.994049+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}]
Mime type: application/json 
[
  {
    "resourceType": "icarGroupWeightEventResource",
    "units": "KGM",
    "method": "LoadCell",
    "resolution": 0.5,
    "animalWeights": [
      {
        "resourceType": "icarIndividualWeightType",
        "animal": {
          "id": "982 000192369311",
          "scheme": "iso.std.11785"
        },
        "weight": 13.4
      },
      {
        "resourceType": "icarIndividualWeightType",
        "animal": {
          "id": "982 000194000328",
          "scheme": "iso.std.11785"
        },
        "weight": 14.2
      }
    ],
    "statistics": [
      {
        "resourceType": "icarStatisticsType",
        "metric": {
          "id": "Liveweight",
          "scheme": "org.icar"
        },
        "unit": "Kgm",
        "aggregation": "Average",
        "value": 13.1
      },
      {
        "resourceType": "icarStatisticsType",
        "metric": {
          "id": "Liveweight",
          "scheme": "org.icar"
        },
        "aggregation": "Count",
        "value": 4
      }
    ],
    "device": {
      "resourceType": "icarDeviceReferenceType",
      "model": "T10",
      "serial": "sample serial",
      "@context": "sample device context",
      "@id": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html",
      "@type": "Link",
      "identifier": {
        "id": "XKF142",
        "scheme": "iso.std.9001"
      },
      "reltype": "Te Pari weigh scales",
      "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
    },
    "timeOffFeed": 10.5,
    "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
    "countObserved": 4,
    "inventoryClassification": {
      "resourceType": "icarInventoryClassificationType",
      "name": "Docking data session 72-IC",
      "count": 4,
      "species": "Buffalo",
      "sex": "Male",
      "primaryBreed": {
        "id": "Romney",
        "scheme": "nz.sil.breed"
      },
      "birthPeriod": "2015-08",
      "reproductiveStatus": "Open",
      "lactationStatus": "Dry",
      "productionPurposes": [
        "Meat",
        "Wool"
      ]
    },
    "embeddedAnimalSet": {
      "resourceType": "icarAnimalSetResource",
      "id": "DR1KF",
      "name": "Docking 2011",
      "purpose": "Session",
      "member": [
        {
          "resourceType": "icarIdentifierType",
          "id": "982 000192369311",
          "scheme": "iso.std.11785"
        },
        {
          "resourceType": "icarIdentifierType",
          "id": "982 000192369311",
          "scheme": "iso.std.11785"
        }
      ],
      "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/bc0477cd-5312-4f11-aeaa-fc7a1848d690",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.groupweightevent",
        "sourceId": "4560600a-fb15-4718-8d48-da995e0788e7",
        "modified": "2024-02-26T03:19:33.9940528+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.sil.location"
      }
    },
    "id": "acdc7be3-b918-4557-9ff0-a8eee4901592",
    "eventDateTime": "2024-02-26T03:19:33.9940494+00:00",
    "traitLabel": {
      "resourceType": "icarIdentifierType",
      "id": "Docking Weight",
      "scheme": "nz.sil.trait"
    },
    "responsible": "Frank Nobilo",
    "contemporaryGroup": "2011 born lambs",
    "remark": "2011 docking data - ids and weights",
    "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/acdc7be3-b918-4557-9ff0-a8eee4901592",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.groupweightevent",
      "sourceId": "c630a038-32d9-4813-b27a-7aa3e984050b",
      "modified": "2024-02-26T03:19:33.994049+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "11111",
      "scheme": "nz.sil.location"
    }
  }
]
Mime type: text/json 
[{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/bc0477cd-5312-4f11-aeaa-fc7a1848d690","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"4560600a-fb15-4718-8d48-da995e0788e7","modified":"2024-02-26T03:19:33.9940528+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"acdc7be3-b918-4557-9ff0-a8eee4901592","eventDateTime":"2024-02-26T03:19:33.9940494+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/acdc7be3-b918-4557-9ff0-a8eee4901592","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"c630a038-32d9-4813-b27a-7aa3e984050b","modified":"2024-02-26T03:19:33.994049+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}]
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/livestock/weight/group-weight-events/{groupWeightEventId}

Get a specific group weight event

Request
GET /data/livestock/weight/group-weight-events/{groupWeightEventId}
Parameters
Name Type Default Notes
*groupWeightEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupWeightEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/9dfeca36-e076-4b0e-9490-8d371d1e8952","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"497253a1-cf7b-4181-ab26-3a6365e5c313","modified":"2024-02-26T03:19:33.9970026+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"261c723f-5443-48bd-9c28-3dac61813525","eventDateTime":"2024-02-26T03:19:33.9969982+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/261c723f-5443-48bd-9c28-3dac61813525","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"158ed23b-9e27-4912-b61e-6de7e6bad26d","modified":"2024-02-26T03:19:33.9969979+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}
Mime type: application/json 
{
  "resourceType": "icarGroupWeightEventResource",
  "units": "KGM",
  "method": "LoadCell",
  "resolution": 0.5,
  "animalWeights": [
    {
      "resourceType": "icarIndividualWeightType",
      "animal": {
        "id": "982 000192369311",
        "scheme": "iso.std.11785"
      },
      "weight": 13.4
    },
    {
      "resourceType": "icarIndividualWeightType",
      "animal": {
        "id": "982 000194000328",
        "scheme": "iso.std.11785"
      },
      "weight": 14.2
    }
  ],
  "statistics": [
    {
      "resourceType": "icarStatisticsType",
      "metric": {
        "id": "Liveweight",
        "scheme": "org.icar"
      },
      "unit": "Kgm",
      "aggregation": "Average",
      "value": 13.1
    },
    {
      "resourceType": "icarStatisticsType",
      "metric": {
        "id": "Liveweight",
        "scheme": "org.icar"
      },
      "aggregation": "Count",
      "value": 4
    }
  ],
  "device": {
    "resourceType": "icarDeviceReferenceType",
    "model": "T10",
    "serial": "sample serial",
    "@context": "sample device context",
    "@id": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html",
    "@type": "Link",
    "identifier": {
      "id": "XKF142",
      "scheme": "iso.std.9001"
    },
    "reltype": "Te Pari weigh scales",
    "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
  },
  "timeOffFeed": 10.5,
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 4,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Docking data session 72-IC",
    "count": 4,
    "species": "Buffalo",
    "sex": "Male",
    "primaryBreed": {
      "id": "Romney",
      "scheme": "nz.sil.breed"
    },
    "birthPeriod": "2015-08",
    "reproductiveStatus": "Open",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Meat",
      "Wool"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "DR1KF",
    "name": "Docking 2011",
    "purpose": "Session",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "982 000192369311",
        "scheme": "iso.std.11785"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "982 000192369311",
        "scheme": "iso.std.11785"
      }
    ],
    "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/9dfeca36-e076-4b0e-9490-8d371d1e8952",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.groupweightevent",
      "sourceId": "497253a1-cf7b-4181-ab26-3a6365e5c313",
      "modified": "2024-02-26T03:19:33.9970026+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "11111",
      "scheme": "nz.sil.location"
    }
  },
  "id": "261c723f-5443-48bd-9c28-3dac61813525",
  "eventDateTime": "2024-02-26T03:19:33.9969982+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Docking Weight",
    "scheme": "nz.sil.trait"
  },
  "responsible": "Frank Nobilo",
  "contemporaryGroup": "2011 born lambs",
  "remark": "2011 docking data - ids and weights",
  "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/261c723f-5443-48bd-9c28-3dac61813525",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.groupweightevent",
    "sourceId": "158ed23b-9e27-4912-b61e-6de7e6bad26d",
    "modified": "2024-02-26T03:19:33.9969979+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.sil.location"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/9dfeca36-e076-4b0e-9490-8d371d1e8952","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"497253a1-cf7b-4181-ab26-3a6365e5c313","modified":"2024-02-26T03:19:33.9970026+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"261c723f-5443-48bd-9c28-3dac61813525","eventDateTime":"2024-02-26T03:19:33.9969982+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/261c723f-5443-48bd-9c28-3dac61813525","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"158ed23b-9e27-4912-b61e-6de7e6bad26d","modified":"2024-02-26T03:19:33.9969979+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/weight/group-weight-events

Get all of the group weight events associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/weight/group-weight-events
Parameters
Name Type Default Notes
*holdingId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupWeightEventResource[]

Success
Mime type: text/plain 
[{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/9848e5af-f4b9-4311-aea4-cb052b865703","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"cbb2a7d4-aec2-4f40-bab6-658405b03b71","modified":"2024-02-26T03:19:34.000028+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"4a4a0755-0221-4639-8188-0b3f2eb00495","eventDateTime":"2024-02-26T03:19:34.0000247+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/4a4a0755-0221-4639-8188-0b3f2eb00495","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"c73908a6-2ba4-4f6c-9f25-05217da53acb","modified":"2024-02-26T03:19:34.0000243+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}]
Mime type: application/json 
[
  {
    "resourceType": "icarGroupWeightEventResource",
    "units": "KGM",
    "method": "LoadCell",
    "resolution": 0.5,
    "animalWeights": [
      {
        "resourceType": "icarIndividualWeightType",
        "animal": {
          "id": "982 000192369311",
          "scheme": "iso.std.11785"
        },
        "weight": 13.4
      },
      {
        "resourceType": "icarIndividualWeightType",
        "animal": {
          "id": "982 000194000328",
          "scheme": "iso.std.11785"
        },
        "weight": 14.2
      }
    ],
    "statistics": [
      {
        "resourceType": "icarStatisticsType",
        "metric": {
          "id": "Liveweight",
          "scheme": "org.icar"
        },
        "unit": "Kgm",
        "aggregation": "Average",
        "value": 13.1
      },
      {
        "resourceType": "icarStatisticsType",
        "metric": {
          "id": "Liveweight",
          "scheme": "org.icar"
        },
        "aggregation": "Count",
        "value": 4
      }
    ],
    "device": {
      "resourceType": "icarDeviceReferenceType",
      "model": "T10",
      "serial": "sample serial",
      "@context": "sample device context",
      "@id": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html",
      "@type": "Link",
      "identifier": {
        "id": "XKF142",
        "scheme": "iso.std.9001"
      },
      "reltype": "Te Pari weigh scales",
      "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
    },
    "timeOffFeed": 10.5,
    "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
    "countObserved": 4,
    "inventoryClassification": {
      "resourceType": "icarInventoryClassificationType",
      "name": "Docking data session 72-IC",
      "count": 4,
      "species": "Buffalo",
      "sex": "Male",
      "primaryBreed": {
        "id": "Romney",
        "scheme": "nz.sil.breed"
      },
      "birthPeriod": "2015-08",
      "reproductiveStatus": "Open",
      "lactationStatus": "Dry",
      "productionPurposes": [
        "Meat",
        "Wool"
      ]
    },
    "embeddedAnimalSet": {
      "resourceType": "icarAnimalSetResource",
      "id": "DR1KF",
      "name": "Docking 2011",
      "purpose": "Session",
      "member": [
        {
          "resourceType": "icarIdentifierType",
          "id": "982 000192369311",
          "scheme": "iso.std.11785"
        },
        {
          "resourceType": "icarIdentifierType",
          "id": "982 000192369311",
          "scheme": "iso.std.11785"
        }
      ],
      "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/9848e5af-f4b9-4311-aea4-cb052b865703",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "com.purefarming.ingestor.groupweightevent",
        "sourceId": "cbb2a7d4-aec2-4f40-bab6-658405b03b71",
        "modified": "2024-02-26T03:19:34.000028+00:00",
        "created": "2022-10-01T19:49:34+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.sil.location"
      }
    },
    "id": "4a4a0755-0221-4639-8188-0b3f2eb00495",
    "eventDateTime": "2024-02-26T03:19:34.0000247+00:00",
    "traitLabel": {
      "resourceType": "icarIdentifierType",
      "id": "Docking Weight",
      "scheme": "nz.sil.trait"
    },
    "responsible": "Frank Nobilo",
    "contemporaryGroup": "2011 born lambs",
    "remark": "2011 docking data - ids and weights",
    "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/4a4a0755-0221-4639-8188-0b3f2eb00495",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.groupweightevent",
      "sourceId": "c73908a6-2ba4-4f6c-9f25-05217da53acb",
      "modified": "2024-02-26T03:19:34.0000243+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "11111",
      "scheme": "nz.sil.location"
    }
  }
]
Mime type: text/json 
[{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/9848e5af-f4b9-4311-aea4-cb052b865703","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"cbb2a7d4-aec2-4f40-bab6-658405b03b71","modified":"2024-02-26T03:19:34.000028+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"4a4a0755-0221-4639-8188-0b3f2eb00495","eventDateTime":"2024-02-26T03:19:34.0000247+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/4a4a0755-0221-4639-8188-0b3f2eb00495","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"c73908a6-2ba4-4f6c-9f25-05217da53acb","modified":"2024-02-26T03:19:34.0000243+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}]
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

GET data/holdings/{holdingId}/livestock/weight/group-weight-events/{groupWeightEventId}

Get a single group weight event associated with the given holding

Request
GET /data/holdings/{holdingId}/livestock/weight/group-weight-events/{groupWeightEventId}
Parameters
Name Type Default Notes
*holdingId
*groupWeightEventId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarGroupWeightEventResource

Success
Mime type: text/plain 
{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/081d4ff2-bf3e-4e17-a4b2-0c7cf4e5e5b2","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"d031e006-b317-4222-b48b-309cfa1f32c0","modified":"2024-02-26T03:19:34.0039543+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"cc7f7fbf-7838-4b48-8684-dc74fec47459","eventDateTime":"2024-02-26T03:19:34.0039484+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/cc7f7fbf-7838-4b48-8684-dc74fec47459","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"1dcba8da-ac92-4238-82a9-03808d44cf94","modified":"2024-02-26T03:19:34.0039477+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}
Mime type: application/json 
{
  "resourceType": "icarGroupWeightEventResource",
  "units": "KGM",
  "method": "LoadCell",
  "resolution": 0.5,
  "animalWeights": [
    {
      "resourceType": "icarIndividualWeightType",
      "animal": {
        "id": "982 000192369311",
        "scheme": "iso.std.11785"
      },
      "weight": 13.4
    },
    {
      "resourceType": "icarIndividualWeightType",
      "animal": {
        "id": "982 000194000328",
        "scheme": "iso.std.11785"
      },
      "weight": 14.2
    }
  ],
  "statistics": [
    {
      "resourceType": "icarStatisticsType",
      "metric": {
        "id": "Liveweight",
        "scheme": "org.icar"
      },
      "unit": "Kgm",
      "aggregation": "Average",
      "value": 13.1
    },
    {
      "resourceType": "icarStatisticsType",
      "metric": {
        "id": "Liveweight",
        "scheme": "org.icar"
      },
      "aggregation": "Count",
      "value": 4
    }
  ],
  "device": {
    "resourceType": "icarDeviceReferenceType",
    "model": "T10",
    "serial": "sample serial",
    "@context": "sample device context",
    "@id": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html",
    "@type": "Link",
    "identifier": {
      "id": "XKF142",
      "scheme": "iso.std.9001"
    },
    "reltype": "Te Pari weigh scales",
    "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
  },
  "timeOffFeed": 10.5,
  "groupMethod": "EmbeddedAnimalSetAndInventoryClassification",
  "countObserved": 4,
  "inventoryClassification": {
    "resourceType": "icarInventoryClassificationType",
    "name": "Docking data session 72-IC",
    "count": 4,
    "species": "Buffalo",
    "sex": "Male",
    "primaryBreed": {
      "id": "Romney",
      "scheme": "nz.sil.breed"
    },
    "birthPeriod": "2015-08",
    "reproductiveStatus": "Open",
    "lactationStatus": "Dry",
    "productionPurposes": [
      "Meat",
      "Wool"
    ]
  },
  "embeddedAnimalSet": {
    "resourceType": "icarAnimalSetResource",
    "id": "DR1KF",
    "name": "Docking 2011",
    "purpose": "Session",
    "member": [
      {
        "resourceType": "icarIdentifierType",
        "id": "982 000192369311",
        "scheme": "iso.std.11785"
      },
      {
        "resourceType": "icarIdentifierType",
        "id": "982 000192369311",
        "scheme": "iso.std.11785"
      }
    ],
    "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/081d4ff2-bf3e-4e17-a4b2-0c7cf4e5e5b2",
    "meta": {
      "resourceType": "icarMetaDataType",
      "source": "com.purefarming.ingestor.groupweightevent",
      "sourceId": "d031e006-b317-4222-b48b-309cfa1f32c0",
      "modified": "2024-02-26T03:19:34.0039543+00:00",
      "created": "2022-10-01T19:49:34+00:00"
    },
    "location": {
      "resourceType": "icarIdentifierType",
      "id": "11111",
      "scheme": "nz.sil.location"
    }
  },
  "id": "cc7f7fbf-7838-4b48-8684-dc74fec47459",
  "eventDateTime": "2024-02-26T03:19:34.0039484+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Docking Weight",
    "scheme": "nz.sil.trait"
  },
  "responsible": "Frank Nobilo",
  "contemporaryGroup": "2011 born lambs",
  "remark": "2011 docking data - ids and weights",
  "@self": "https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/cc7f7fbf-7838-4b48-8684-dc74fec47459",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "com.purefarming.ingestor.groupweightevent",
    "sourceId": "1dcba8da-ac92-4238-82a9-03808d44cf94",
    "modified": "2024-02-26T03:19:34.0039477+00:00",
    "created": "2022-10-01T19:49:34+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.sil.location"
  }
}
Mime type: text/json 
{"resourceType":"icarGroupWeightEventResource","units":"KGM","method":"LoadCell","resolution":0.5,"animalWeights":[{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000192369311","scheme":"iso.std.11785"},"weight":13.4},{"resourceType":"icarIndividualWeightType","animal":{"id":"982 000194000328","scheme":"iso.std.11785"},"weight":14.2}],"statistics":[{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"unit":"Kgm","aggregation":"Average","value":13.1},{"resourceType":"icarStatisticsType","metric":{"id":"Liveweight","scheme":"org.icar"},"aggregation":"Count","value":4.0}],"device":{"resourceType":"icarDeviceReferenceType","model":"T10","serial":"sample serial","@context":"sample device context","@id":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html","@type":"Link","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":10.5,"groupMethod":"EmbeddedAnimalSetAndInventoryClassification","countObserved":4,"inventoryClassification":{"resourceType":"icarInventoryClassificationType","name":"Docking data session 72-IC","count":4.0,"species":"Buffalo","sex":"Male","primaryBreed":{"id":"Romney","scheme":"nz.sil.breed"},"birthPeriod":"2015-08","reproductiveStatus":"Open","lactationStatus":"Dry","productionPurposes":["Meat","Wool"]},"embeddedAnimalSet":{"resourceType":"icarAnimalSetResource","id":"DR1KF","name":"Docking 2011","purpose":"Session","member":[{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"},{"resourceType":"icarIdentifierType","id":"982 000192369311","scheme":"iso.std.11785"}],"@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/081d4ff2-bf3e-4e17-a4b2-0c7cf4e5e5b2","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"d031e006-b317-4222-b48b-309cfa1f32c0","modified":"2024-02-26T03:19:34.0039543+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}},"id":"cc7f7fbf-7838-4b48-8684-dc74fec47459","eventDateTime":"2024-02-26T03:19:34.0039484+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Docking Weight","scheme":"nz.sil.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2011 born lambs","remark":"2011 docking data - ids and weights","@self":"https://api.dev.purefarming.com/data/livestock/weight/group-weight-events/cc7f7fbf-7838-4b48-8684-dc74fec47459","meta":{"resourceType":"icarMetaDataType","source":"com.purefarming.ingestor.groupweightevent","sourceId":"1dcba8da-ac92-4238-82a9-03808d44cf94","modified":"2024-02-26T03:19:34.0039477+00:00","created":"2022-10-01T19:49:34+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.sil.location"}}
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Livestock :: Weights :: Animal weight events

GET data/livestock/weights/animal-weight-events

Gets all of the animal weight events that the user has access to via pagination

Request
GET /data/livestock/weights/animal-weight-events[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
limit

The limit of results to return
offset

The offset to specify at what row to start querying
animalIdentifier

The animal identifier to search for
animalIdentifierScheme

The animal identifier scheme to search for
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarWeightEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1"},"items":[{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"ba33135e-04f0-47d0-81e5-b5be439251e1","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/ba33135e-04f0-47d0-81e5-b5be439251e1","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarWeightEventResource",
      "weight": {
        "resourceType": "icarMassMeasureType",
        "measurement": 164,
        "units": "KGM",
        "method": "LoadCell",
        "resolution": 0.5
      },
      "device": {
        "resourceType": "icarDeviceReferenceType",
        "model": "T10",
        "identifier": {
          "id": "XKF142",
          "scheme": "iso.std.9001"
        },
        "reltype": "Te Pari weigh scales",
        "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
      },
      "timeOffFeed": 3.5,
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "982 091004501874",
        "scheme": "iso.std.11785"
      },
      "id": "ba33135e-04f0-47d0-81e5-b5be439251e1",
      "eventDateTime": "2023-02-10T08:00:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Weaning Weight",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Frank Nobilo",
      "contemporaryGroup": "2022 born calves",
      "remark": "Testing new indicator unit",
      "@self": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/ba33135e-04f0-47d0-81e5-b5be439251e1",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.fmapp.farm",
        "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
        "isDeleted": false,
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@newco.com",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-02-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1"},"items":[{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"ba33135e-04f0-47d0-81e5-b5be439251e1","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/ba33135e-04f0-47d0-81e5-b5be439251e1","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}

GET data/livestock/weights/animal-weight-events/{animalWeightEventId}

Gets a specific Animal Weight Event by its ID

Request
GET /data/livestock/weights/animal-weight-events/{animalWeightEventId}
Parameters
Name Type Default Notes
*animalWeightEventId

The Id of the Animal Weight Event to return
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarWeightEventResource

Success
Mime type: text/plain 
{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"f6d2e89a-daa7-40d3-bbdf-188d90404be1","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/f6d2e89a-daa7-40d3-bbdf-188d90404be1","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarWeightEventResource",
  "weight": {
    "resourceType": "icarMassMeasureType",
    "measurement": 164,
    "units": "KGM",
    "method": "LoadCell",
    "resolution": 0.5
  },
  "device": {
    "resourceType": "icarDeviceReferenceType",
    "model": "T10",
    "identifier": {
      "id": "XKF142",
      "scheme": "iso.std.9001"
    },
    "reltype": "Te Pari weigh scales",
    "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
  },
  "timeOffFeed": 3.5,
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "982 091004501874",
    "scheme": "iso.std.11785"
  },
  "id": "f6d2e89a-daa7-40d3-bbdf-188d90404be1",
  "eventDateTime": "2023-02-10T08:00:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Weaning Weight",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Frank Nobilo",
  "contemporaryGroup": "2022 born calves",
  "remark": "Testing new indicator unit",
  "@self": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/f6d2e89a-daa7-40d3-bbdf-188d90404be1",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.fmapp.farm",
    "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
    "isDeleted": false,
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@newco.com",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-02-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"f6d2e89a-daa7-40d3-bbdf-188d90404be1","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/f6d2e89a-daa7-40d3-bbdf-188d90404be1","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/weights/animal-weight-events

Gets all of the animal weight events for the specified holding via pagination

Request
GET /data/holdings/{holdingId}/livestock/weights/animal-weight-events[?limit&offset&animalIdentifier&animalIdentifierScheme&includeDeleted]
Parameters
Name Type Default Notes
*holdingId
limit
offset
animalIdentifier
animalIdentifierScheme
includeDeleted False
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarWeightEventResource]

Success
Mime type: text/plain 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1"},"items":[{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"a9c454ff-5185-4db2-8451-93e50f840be6","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/a9c454ff-5185-4db2-8451-93e50f840be6","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
Mime type: application/json 
{
  "totalPages": 1,
  "itemsPerPage": 1,
  "offset": 0,
  "totalItems": 1,
  "page": 1,
  "links": {
    "first": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1",
    "next": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1",
    "previous": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1",
    "last": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1"
  },
  "items": [
    {
      "resourceType": "icarWeightEventResource",
      "weight": {
        "resourceType": "icarMassMeasureType",
        "measurement": 164,
        "units": "KGM",
        "method": "LoadCell",
        "resolution": 0.5
      },
      "device": {
        "resourceType": "icarDeviceReferenceType",
        "model": "T10",
        "identifier": {
          "id": "XKF142",
          "scheme": "iso.std.9001"
        },
        "reltype": "Te Pari weigh scales",
        "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
      },
      "timeOffFeed": 3.5,
      "animal": {
        "resourceType": "icarIdentifierType",
        "id": "982 091004501874",
        "scheme": "iso.std.11785"
      },
      "id": "a9c454ff-5185-4db2-8451-93e50f840be6",
      "eventDateTime": "2023-02-10T08:00:00+00:00",
      "traitLabel": {
        "resourceType": "icarIdentifierType",
        "id": "Weaning Weight",
        "scheme": "nz.minda.trait"
      },
      "responsible": "Frank Nobilo",
      "contemporaryGroup": "2022 born calves",
      "remark": "Testing new indicator unit",
      "@self": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/a9c454ff-5185-4db2-8451-93e50f840be6",
      "meta": {
        "resourceType": "icarMetaDataType",
        "source": "nz.fmapp.farm",
        "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
        "isDeleted": false,
        "modified": "2023-02-10T09:00:00+00:00",
        "created": "2023-02-10T09:00:00+00:00",
        "creator": "don.wilson@newco.com",
        "validFrom": "2023-02-10T09:00:00+00:00",
        "validTo": "2023-02-10T09:00:00+00:00"
      },
      "location": {
        "resourceType": "icarIdentifierType",
        "id": "11111",
        "scheme": "nz.nait.pica-location"
      }
    }
  ]
}
Mime type: text/json 
{"totalPages":1,"itemsPerPage":1,"offset":0,"totalItems":1,"page":1,"links":{"first":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","next":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","previous":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1","last":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events?offset=0&limit=1"},"items":[{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"a9c454ff-5185-4db2-8451-93e50f840be6","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/a9c454ff-5185-4db2-8451-93e50f840be6","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}]}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/livestock/weights/animal-weight-events/{animalWeightId}

Gets a specific animal weight event by the holding and the event ID

Request
GET /data/holdings/{holdingId}/livestock/weights/animal-weight-events/{animalWeightId}
Parameters
Name Type Default Notes
*holdingId
*animalWeightId
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.icarWeightEventResource

Success
Mime type: text/plain 
{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"228f7577-bfa1-49a2-8d76-8df340b9a11c","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/228f7577-bfa1-49a2-8d76-8df340b9a11c","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
Mime type: application/json 
{
  "resourceType": "icarWeightEventResource",
  "weight": {
    "resourceType": "icarMassMeasureType",
    "measurement": 164,
    "units": "KGM",
    "method": "LoadCell",
    "resolution": 0.5
  },
  "device": {
    "resourceType": "icarDeviceReferenceType",
    "model": "T10",
    "identifier": {
      "id": "XKF142",
      "scheme": "iso.std.9001"
    },
    "reltype": "Te Pari weigh scales",
    "href": "https://www.manualslib.com/products/Te-Pari-T10-11132203.html"
  },
  "timeOffFeed": 3.5,
  "animal": {
    "resourceType": "icarIdentifierType",
    "id": "982 091004501874",
    "scheme": "iso.std.11785"
  },
  "id": "228f7577-bfa1-49a2-8d76-8df340b9a11c",
  "eventDateTime": "2023-02-10T08:00:00+00:00",
  "traitLabel": {
    "resourceType": "icarIdentifierType",
    "id": "Weaning Weight",
    "scheme": "nz.minda.trait"
  },
  "responsible": "Frank Nobilo",
  "contemporaryGroup": "2022 born calves",
  "remark": "Testing new indicator unit",
  "@self": "https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/228f7577-bfa1-49a2-8d76-8df340b9a11c",
  "meta": {
    "resourceType": "icarMetaDataType",
    "source": "nz.fmapp.farm",
    "sourceId": "783e8c73-7ca1-4636-8291-499bb0dc96a0",
    "isDeleted": false,
    "modified": "2023-02-10T09:00:00+00:00",
    "created": "2023-02-10T09:00:00+00:00",
    "creator": "don.wilson@newco.com",
    "validFrom": "2023-02-10T09:00:00+00:00",
    "validTo": "2023-02-10T09:00:00+00:00"
  },
  "location": {
    "resourceType": "icarIdentifierType",
    "id": "11111",
    "scheme": "nz.nait.pica-location"
  }
}
Mime type: text/json 
{"resourceType":"icarWeightEventResource","weight":{"resourceType":"icarMassMeasureType","measurement":164.0,"units":"KGM","method":"LoadCell","resolution":0.5},"device":{"resourceType":"icarDeviceReferenceType","model":"T10","identifier":{"id":"XKF142","scheme":"iso.std.9001"},"reltype":"Te Pari weigh scales","href":"https://www.manualslib.com/products/Te-Pari-T10-11132203.html"},"timeOffFeed":3.5,"animal":{"resourceType":"icarIdentifierType","id":"982 091004501874","scheme":"iso.std.11785"},"id":"228f7577-bfa1-49a2-8d76-8df340b9a11c","eventDateTime":"2023-02-10T08:00:00+00:00","traitLabel":{"resourceType":"icarIdentifierType","id":"Weaning Weight","scheme":"nz.minda.trait"},"responsible":"Frank Nobilo","contemporaryGroup":"2022 born calves","remark":"Testing new indicator unit","@self":"https://api.dev.purefarming.com/data/livestock/weight/animal-weight-events/228f7577-bfa1-49a2-8d76-8df340b9a11c","meta":{"resourceType":"icarMetaDataType","source":"nz.fmapp.farm","sourceId":"783e8c73-7ca1-4636-8291-499bb0dc96a0","isDeleted":false,"modified":"2023-02-10T09:00:00+00:00","created":"2023-02-10T09:00:00+00:00","creator":"don.wilson@newco.com","validFrom":"2023-02-10T09:00:00+00:00","validTo":"2023-02-10T09:00:00+00:00"},"location":{"resourceType":"icarIdentifierType","id":"11111","scheme":"nz.nait.pica-location"}}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Plots

GET data/plots

Get a list of all plots that the user has permission to access.

Warning, the response may be large

Request
GET /data/plots[?offset&limit]
Parameters
Name Type Default Notes
offset

How many plots to skip to start the current page.
limit

The number of plots to be returned per page.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.plotResource[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/plots

Get a list of plots that are linked to the provided holding id.

Request
GET /data/holdings/{holdingId}/plots[?offset&limit]
Parameters
Name Type Default Notes
*holdingId

The PureFarming of the Holding that you want to get plots for
offset

How many plots to skip to start the current page.
limit

The number of plots to be returned per page.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.plotResource[]

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/holdings/{holdingId}/plots/{plotId}

Gets the specified plot that are linked to the provided holding id.

Request
GET /data/holdings/{holdingId}/plots/{plotId}
Parameters
Name Type Default Notes
*holdingId

The Purefarming ID for the holding the plot is linked to
*plotId

The PureFarming ID for the plot
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.plotResource

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET data/plots/{id}

Gets the specified plot

Request
GET /data/plots/{id}
Parameters
Name Type Default Notes
*id

The plot id that have come from the route.
X-Requested-Region

A 2 letter country code (ISO3166-1 alpha 2 code) to the region the data should be pulled from.
Responses
Status Code Type Description Samples
200 PureFarming.Schema.plotResource

Success
400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Definitions

MoA.Platform.Data.Api.Common.CropContracts.CropLoadReceivalContract

Name Type Notes
loads MoA.Platform.Data.Api.Common.CropContracts.Load[]
operation string

Constant value in any concrete class for the operation type
priority MoA.Platform.Data.Api.Common.CropContracts.LoadPriority
status MoA.Platform.Data.Api.Common.CropContracts.LoadReceivalStatus

Allowable statuses of a work item
feature MoA.Platform.Data.Api.Common.CropContracts.Feature
featureId string (uuid)

Internal purefarming feature id. To be used in internal versions of the schema, in place of the feature object (cannot have both, but valid to have neither!)
holding MoA.Platform.Data.Api.Common.CropContracts.Holding
holdingId string (uuid)

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!)
observationDate string (date-time)

UTC Date (required) and time (optional) the sample was taken
phenomenonTime string

ISO UTC Period (two dates separated by / or a date and ISO Duration)
remark string

Notes or remarks field
responsible string

Identifier of the person responsible for the observation
internalId string (uuid)

A single immutable internal PureFarming identifier for the entity associated with this resource. Could be a holding/organisation/enterprise
id string

Unique identifier (UUID) used within the current server to identify the resource.
meta MoA.Platform.Data.Api.Common.CropContracts.Meta

Meta-data for the resource. Mandatory if you wish to support synchronization.
self string

Uniform resource identifier (URI) of the resource (rel=self).
identifiers MoA.Platform.Data.Api.Common.CropContracts.IdentifierElement[]

Identifiers for the resource (see well-known/schemes... for example identity schemes).
links MoA.Platform.Data.Api.Common.CropContracts.Link[]

Linked resources that are related to the current resource.
name string

A user-readable name for the resource.
resourceType string

The Pure Farming resource type name

MoA.Platform.Data.Api.Common.CropContracts.Load

Name Type Notes
analysis MoA.Platform.Data.Api.Common.CropContracts.Analysis[]
crops MoA.Platform.Data.Api.Common.CoreContracts.Crop[]
destination MoA.Platform.Data.Api.Common.CropContracts.Destination

Destination endpoint of the load
logisticUnit MoA.Platform.Data.Api.Common.CropContracts.LogisticUnit

Enumerated value of logistic units
quantity number (double)

Quantity in the load
rawQuantity number (double)

Raw quantity before standardisation
rawUnits string
source MoA.Platform.Data.Api.Common.CropContracts.Source

Source endpoint of the load
status MoA.Platform.Data.Api.Common.CropContracts.LoadStatus

Consignment statuses
units string

Units for the quantity metric
internalId string (uuid)

A single immutable internal PureFarming identifier for the entity associated with this resource. Could be a holding/organisation/enterprise
id string

Unique identifier (UUID) used within the current server to identify the resource.
meta MoA.Platform.Data.Api.Common.CropContracts.Meta

Meta-data for the resource. Mandatory if you wish to support synchronization.
self string

Uniform resource identifier (URI) of the resource (rel=self).
identifiers MoA.Platform.Data.Api.Common.CropContracts.IdentifierElement[]

Identifiers for the resource (see well-known/schemes... for example identity schemes).
links MoA.Platform.Data.Api.Common.CropContracts.Link[]

Linked resources that are related to the current resource.
name string

A user-readable name for the resource.

MoA.Platform.Data.Api.Common.CropContracts.Analysis

Name Type Notes
laboratory MoA.Platform.Data.Api.Common.CropContracts.Laboratory

Brief reference to the laboratory providing the analysis.
laboratoryIdentifier string

Unique identifier for the sample analysis within the laboratory
responsible string

Identifiers the person responsible for the analysis
results MoA.Platform.Data.Api.Common.CropContracts.Result[]

Provides the results of the analysis - really hoping this doesn't actually inherit all of Observation type
sessionIdentifier string

Identifies the analytical session within the lab

MoA.Platform.Data.Api.Common.CropContracts.Laboratory

Brief reference to the laboratory providing the analysis.

Name Type Notes
registration object
leiCode string

Provides a unique ID for the organisation
name string

Provides a human-readable name for the organisation
uri string (uri)

Provides a URI link to the organisation
globalLocationNumber string

Provides the Global Location Number of the organisation

MoA.Platform.Data.Api.Common.CropContracts.Result

Provides the results of the analysis - really hoping this doesn't actually inherit all of Observation type

Name Type Notes
abbreviation
errorStatistic number (double)

Error statistics (see OGC QR)
method string (uri)

URI to the method employed
metric string (uri)

URI to the test
name string

Human readable description of the test result
rawUnit string

Units of the test result
rawValue string

Value of the test result as supplied from the lab
resolution number (double)

Resolution of numeric metrics
status MoA.Platform.Data.Api.Common.CropContracts.ResultStatus

One of a set of enumerated values
unit string

Units of the test result
value number (double)

Value of the test result converted to standard units
limit number (double)
qualitativeGrade string

MoA.Platform.Data.Api.Common.CropContracts.ResultStatus

One of a set of enumerated values

MoA.Platform.Data.Api.Common.CoreContracts.Crop

Name Type Notes
establishmentDate string (date-time)

The establishment date of the crop or species if known.
harvestDate string (date-time)

The target or actual harvest date of the crop or species if known. Most useful for historic reference.
identifiers MoA.Platform.Data.Api.Common.CoreContracts.CropIdentifier[]

A list of official identifiers of different sorts, idenfified by scheme and id.
maturityDate string (date-time)

The target or actual maturity date of the crop or species if known.
name string

The human-readable name of the crop or species.
taxonomicName string

Taxonomic name of the species. Developers should check this against official databases or taxonomic registers.
variety string

Recognised plant variety.

MoA.Platform.Data.Api.Common.CoreContracts.CropIdentifier

A list of official identifiers of different sorts, idenfified by scheme and id.

Name Type Notes
id string

A unique identification for the resource issued under the auspices of the scheme.
scheme string

The identifier (in reverse domain format) of an official scheme that manages unique identifiers.

MoA.Platform.Data.Api.Common.CropContracts.Destination

Destination endpoint of the load

Name Type Notes
consignmentDate string (date-time)

The date the load/consignment was sent or received by the party
feature MoA.Platform.Data.Api.Common.CropContracts.Feature
organisation MoA.Platform.Data.Api.Common.CropContracts.Organisation

Reference or identification of the organisation or organisation point

MoA.Platform.Data.Api.Common.CropContracts.Feature

Name Type Notes
contentType string

Identifies the type of feature referenced
identifier MoA.Platform.Data.Api.Common.CropContracts.FeatureIdentifier

A compound identifier that can uniquely identify resources or other items.
name string

Provides a human-readable name
uri string (uri)

Provides a URI link to the feature

MoA.Platform.Data.Api.Common.CropContracts.FeatureIdentifier

A compound identifier that can uniquely identify resources or other items.

Name Type Notes
id string

A unique identification for the resource issued under the auspices of the scheme.
scheme string

The identifier (in reverse domain format) of an official scheme that manages unique identifiers.

MoA.Platform.Data.Api.Common.CropContracts.Organisation

Reference or identification of the organisation or organisation point

Name Type Notes
gln string

Global Location Number
leiCode string

Provides a unique ID for the organisation
name string

Provides a human-readable name for the organisation
registration MoA.Platform.Data.Api.Common.CropContracts.IdentifierElement

A compound identifier that can uniquely identify resources or other items.
uri string (uri)

Provides a URI link to the organisation

MoA.Platform.Data.Api.Common.CropContracts.IdentifierElement

A compound identifier that can uniquely identify resources or other items.

Name Type Notes
id string

A unique identification for the resource issued under the auspices of the scheme.
scheme string

The identifier (in reverse domain format) of an official scheme that manages unique identifiers.

MoA.Platform.Data.Api.Common.CropContracts.LogisticUnit

Enumerated value of logistic units

MoA.Platform.Data.Api.Common.CropContracts.Source

Source endpoint of the load

Name Type Notes
consignmentDate string (date-time)

The date the load/consignment was sent or received by the party
feature MoA.Platform.Data.Api.Common.CropContracts.Feature
organisation MoA.Platform.Data.Api.Common.CropContracts.Organisation

Reference or identification of the organisation or organisation point

MoA.Platform.Data.Api.Common.CropContracts.LoadStatus

Consignment statuses

MoA.Platform.Data.Api.Common.CropContracts.Meta

Meta-data for the resource. Mandatory if you wish to support synchronization.

Name Type Notes
created string (date-time)

The date and time at which the object was created. SHOULD be set if known.
creator string

Person or organisation who created the object
modified string (date-time)

The date and time at which the object was last modified.
sourceId MoA.Platform.Data.Api.Common.CropContracts.SourceId

A compound identifier that can uniquely identify resources or other items.
validFrom string (date-time)

The earliest date and time from which the object is valid.
validTo string (date-time)

The latest date and time to which the object is valid.

MoA.Platform.Data.Api.Common.CropContracts.SourceId

A compound identifier that can uniquely identify resources or other items.

Name Type Notes
id string

A unique identification for the resource issued under the auspices of the scheme.
scheme string

The identifier (in reverse domain format) of an official scheme that manages unique identifiers.

MoA.Platform.Data.Api.Common.CropContracts.Link

Linked resources that are related to the current resource.

Name Type Notes
contentType string

The type of the referenced entity (see well-known/ResourceType).
related string

A URL that may be used to retrieve the related resource.
relationship string

How the referenced resource relates to the current resource (see well-known/known-RelationType for examples).

MoA.Platform.Data.Api.Common.CropContracts.LoadPriority

MoA.Platform.Data.Api.Common.CropContracts.LoadReceivalStatus

Allowable statuses of a work item

MoA.Platform.Data.Api.Common.CropContracts.Holding

Name Type Notes
contentType string

Identifies the type of feature referenced
identifier MoA.Platform.Data.Api.Common.CropContracts.HoldingIdentifier

A compound identifier that can uniquely identify resources or other items.
name string

Provides a human-readable name
uri string (uri)

Provides a URI link to the feature

MoA.Platform.Data.Api.Common.CropContracts.HoldingIdentifier

A compound identifier that can uniquely identify resources or other items.

Name Type Notes
id string

A unique identification for the resource issued under the auspices of the scheme.
scheme string

The identifier (in reverse domain format) of an official scheme that manages unique identifiers.

Microsoft.AspNetCore.Mvc.ProblemDetails

Name Type Notes
type string
title string
status integer (int32)
detail string
instance string

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfPastureCoverEvent]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfPastureCoverEvent[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfPastureCoverEvent

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
holding PureFarming.Schema.featureReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
features PureFarming.Schema.featureReferenceType[]
responsible string
remark string
dryMatter PureFarming.Schema.pfDryMatterMeasureType[]
pastureHeight PureFarming.Schema.lengthMeasureType[]
pastureArea PureFarming.Schema.areaMeasureType[]
methodUsed PureFarming.Schema.pfPastureDmAssessmentMethod
device PureFarming.Schema.pfDeviceType[]
equationIntercept number (double)
equationSlope number (double)
metabolisableEnergy number (double)
pastureState PureFarming.Schema.pfPastureStateType

PureFarming.Schema.identifierType

Name Type Notes
scheme string
id string
additionalProperties object

PureFarming.Schema.relationType

Name Type Notes
relationship string
contentType string
related string
additionalProperties object

PureFarming.Schema.metaDataType

Name Type Notes
sourceId PureFarming.Schema.identifierType[]
modified string (date-time)
created string (date-time)
creator string
validFrom string (date-time)
validTo string (date-time)
isDeleted boolean
additionalProperties object

PureFarming.Schema.featureReferenceType

Name Type Notes
relationship string
contentType string
related string
additionalProperties object
identifier PureFarming.Schema.identifierType[]
name string
uri string (uri)

PureFarming.Schema.pfDryMatterMeasureType

Name Type Notes
measure PureFarming.Schema.massOrVolumeMeasurementType[]
areaMetric PureFarming.Schema.areaMeasureType[]
additionalProperties object

PureFarming.Schema.massOrVolumeMeasurementType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactMassOrVolumeUnits

PureFarming.Schema.uncefactMassOrVolumeUnits

PureFarming.Schema.areaMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactAreaUnits

PureFarming.Schema.uncefactAreaUnits

PureFarming.Schema.lengthMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactLengthUnits

PureFarming.Schema.uncefactLengthUnits

PureFarming.Schema.pfPastureDmAssessmentMethod

PureFarming.Schema.pfDeviceType

Name Type Notes
id string
serial string
name string
description string
softwareVersion string
hardwareVersion string
manufacturer string
deviceCategory string
additionalProperties object

PureFarming.Schema.pfPastureStateType

MoA.Platform.Data.Api.Common.Shared.PagedResultLinks

Name Type Notes
first string
next string
previous string
last string

MoA.Platform.Data.Api.Common.CropContracts.CropSampleAnalysisContract

Name Type Notes
operation string
status MoA.Platform.Data.Api.Common.CropContracts.SampleAnalysisStatus
analysis MoA.Platform.Data.Api.Common.CropContracts.Analysis[]
priority MoA.Platform.Data.Api.Common.CropContracts.Priority
sampledOrganism string

Name or identifier of the plant or organism sampled
samplingMethod string

Citation or other URI to page describing the sampling method
id string

Unique identifier (UUID) used within the current server to identify the resource.
meta MoA.Platform.Data.Api.Common.CropContracts.Meta

Meta-data for the resource. Mandatory if you wish to support synchronization.
observationDate string (date-time)

UTC Date (required) and time (optional) the sample was taken
feature MoA.Platform.Data.Api.Common.CropContracts.Feature
featureId string (uuid)

Internal purefarming feature id. To be used in internal versions of the schema, in place of the feature object (cannot have both, but valid to have neither!)
holding MoA.Platform.Data.Api.Common.CropContracts.Holding
holdingId string (uuid)

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!)
phenomenonTime string

ISO UTC Period (two dates separated by / or a date and ISO Duration)
remark string

Notes or remarks field
responsible string

Identifier of the person responsible for the observation
internalId string (uuid)

A single immutable internal PureFarming identifier for the entity associated with this resource. Could be a holding/organisation/enterprise
self string

Uniform resource identifier (URI) of the resource (rel=self).
identifiers MoA.Platform.Data.Api.Common.CropContracts.IdentifierElement[]

Identifiers for the resource (see well-known/schemes... for example identity schemes).
links MoA.Platform.Data.Api.Common.CropContracts.Link[]

Linked resources that are related to the current resource.
name string

A user-readable name for the resource.
resourceType string

MoA.Platform.Data.Api.Common.CropContracts.SampleAnalysisStatus

MoA.Platform.Data.Api.Common.CropContracts.Priority

MoA.Platform.Data.Api.Common.CropContracts.CropSamplePlanContract

Name Type Notes
operation string
status MoA.Platform.Data.Api.Common.CropContracts.Status
priority MoA.Platform.Data.Api.Common.CropContracts.Priority
sampledOrganism string

Name or identifier of the plant or organism sampled
samplingMethod string

Citation or other URI to page describing the sampling method
id string

Unique identifier (UUID) used within the current server to identify the resource.
meta MoA.Platform.Data.Api.Common.CropContracts.Meta

Meta-data for the resource. Mandatory if you wish to support synchronization.
observationDate string (date-time)

UTC Date (required) and time (optional) the sample was taken
feature MoA.Platform.Data.Api.Common.CropContracts.Feature
featureId string (uuid)

Internal purefarming feature id. To be used in internal versions of the schema, in place of the feature object (cannot have both, but valid to have neither!)
holding MoA.Platform.Data.Api.Common.CropContracts.Holding
holdingId string (uuid)

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!)
phenomenonTime string

ISO UTC Period (two dates separated by / or a date and ISO Duration)
remark string

Notes or remarks field
responsible string

Identifier of the person responsible for the observation
internalId string (uuid)

A single immutable internal PureFarming identifier for the entity associated with this resource. Could be a holding/organisation/enterprise
self string

Uniform resource identifier (URI) of the resource (rel=self).
identifiers MoA.Platform.Data.Api.Common.CropContracts.IdentifierElement[]

Identifiers for the resource (see well-known/schemes... for example identity schemes).
links MoA.Platform.Data.Api.Common.CropContracts.Link[]

Linked resources that are related to the current resource.
name string

A user-readable name for the resource.
resourceType string

MoA.Platform.Data.Api.Common.CropContracts.Status

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.workRecordResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.workRecordResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.workRecordResource

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
holding PureFarming.Schema.featureReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
features PureFarming.Schema.featureReferenceType[]
responsible string
remark string
operation string
status PureFarming.Schema.workItemStatusType
priority PureFarming.Schema.workItemPriorityType
workedArea PureFarming.Schema.areaMeasureType[]
nonOverlapWorkedArea PureFarming.Schema.areaMeasureType[]
loggedOperations PureFarming.Schema.operationRecordResource[]

PureFarming.Schema.workItemStatusType

PureFarming.Schema.workItemPriorityType

PureFarming.Schema.operationRecordResource

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
holding PureFarming.Schema.featureReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
features PureFarming.Schema.featureReferenceType[]
responsible string
remark string
operation string
operationName string
method string
summaryGeometry PureFarming.Schema.feature[]
loggedGeometry PureFarming.Schema.feature[]
products PureFarming.Schema.operationProductType[]
environment PureFarming.Schema.operationEnvironmentType[]

PureFarming.Schema.feature

Name Type Notes
bbox array
id string
type PureFarming.Schema.geoJsonObjectTypes
geometry PureFarming.Schema.geoJsonGeometry[]
properties

PureFarming.Schema.geoJsonObjectTypes

PureFarming.Schema.geoJsonGeometry

Name Type Notes
type PureFarming.Schema.geoJsonGeometryTypes
bbox array
coordinates

PureFarming.Schema.geoJsonGeometryTypes

PureFarming.Schema.operationProductType

Name Type Notes
applicationRate PureFarming.Schema.massOrVolumeMeasurementType[]
spatialMetric PureFarming.Schema.spatialMeasureType[]
applicationTotal PureFarming.Schema.massOrVolumeMeasurementType[]
waterVolume PureFarming.Schema.volumeMeasureType[]
components PureFarming.Schema.componentProductType[]
additionalProperties object

PureFarming.Schema.spatialMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactSpatialUnits

PureFarming.Schema.uncefactSpatialUnits

PureFarming.Schema.volumeMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactVolumeUnits

PureFarming.Schema.uncefactVolumeUnits

PureFarming.Schema.componentProductType

Name Type Notes
mixSequence number (double)
percent number (double)
product PureFarming.Schema.productResource[]
quantity PureFarming.Schema.massOrVolumeMeasurementType[]
additionalProperties object

PureFarming.Schema.productResource

Name Type Notes
relationship string
contentType string
related string
additionalProperties object
identifiers PureFarming.Schema.identifierType[]
name string
type PureFarming.Schema.productTypeType
manufacturer string
brand string
form PureFarming.Schema.productPhysicalFormType
uri string
crop PureFarming.Schema.cropType[]
specificGravity number (double)
bulkDensity PureFarming.Schema.massPerVolumeMeasurementType[]
matterState PureFarming.Schema.matterStateType
analysis PureFarming.Schema.productAnalysisType[]
activeIngredients PureFarming.Schema.productIngredientType[]
withdrawals PureFarming.Schema.withdrawalPeriodType[]
claims PureFarming.Schema.registrationType[]
registrations PureFarming.Schema.registrationType[]

PureFarming.Schema.productTypeType

PureFarming.Schema.productPhysicalFormType

PureFarming.Schema.cropType

Name Type Notes
name string
taxonomicName string
variety string
identifiers PureFarming.Schema.identifierType[]
establishmentDate string (date-time)
maturityDate string (date-time)
harvestDate string (date-time)
additionalProperties object

PureFarming.Schema.massPerVolumeMeasurementType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
denominator number (double)
units PureFarming.Schema.uncefactMassUnits
denominatorUnits PureFarming.Schema.uncefactVolumeUnits

PureFarming.Schema.uncefactMassUnits

PureFarming.Schema.matterStateType

PureFarming.Schema.productAnalysisType

Name Type Notes
id PureFarming.Schema.identifierType[]
name string
percent number (double)
additionalProperties object

PureFarming.Schema.productIngredientType

Name Type Notes
id PureFarming.Schema.identifierType[]
name string
additionalProperties object

PureFarming.Schema.withdrawalPeriodType

Name Type Notes
scheme string
hours number (double)
additionalProperties object

PureFarming.Schema.registrationType

Name Type Notes
scheme string
id string
additionalProperties object

PureFarming.Schema.operationEnvironmentType

Name Type Notes
windSpeed PureFarming.Schema.velocityMeasureType[]
windDirectionCompass PureFarming.Schema.windDirectionType
windDirectionDegrees number (double)
airTemperature PureFarming.Schema.temperatureMeasureType[]
humidity PureFarming.Schema.humidityMeasureType[]
soilTemperature PureFarming.Schema.temperatureMeasureType[]
solarRadiation24hr PureFarming.Schema.irradianceMeasureType[]
rainfall24hr PureFarming.Schema.distanceMeasureType[]
additionalProperties object

PureFarming.Schema.velocityMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactVelocityUnits

PureFarming.Schema.uncefactVelocityUnits

PureFarming.Schema.windDirectionType

PureFarming.Schema.temperatureMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactTemperatureUnits

PureFarming.Schema.uncefactTemperatureUnits

PureFarming.Schema.humidityMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactHumidityUnits

PureFarming.Schema.uncefactHumidityUnits

PureFarming.Schema.irradianceMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactIrradianceUnits

PureFarming.Schema.uncefactIrradianceUnits

PureFarming.Schema.distanceMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactLengthUnits

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfMilkCollection]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfMilkCollection[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfMilkCollection

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
holding PureFarming.Schema.featureReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
features PureFarming.Schema.featureReferenceType[]
responsible string
remark string
productionDays number (double)
source PureFarming.Schema.pfConsignmentEndPointType[]
destination PureFarming.Schema.pfConsignmentEndPointType[]
logisticUnit PureFarming.Schema.pfLogisticsUnit
quantity number (double)
units string
rawQuantity number (double)
rawUnits string
analysis PureFarming.Schema.pfLaboratoryAnalysisType[]
status PureFarming.Schema.pfLoadStatus

PureFarming.Schema.pfConsignmentEndPointType

Name Type Notes
consignmentDate string (date-time)
organisation PureFarming.Schema.pfOrganisationReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
additionalProperties object

PureFarming.Schema.pfOrganisationReferenceType

Name Type Notes
leiCode string
name string
uri string (uri)
registration PureFarming.Schema.identifierType[]
gln string
additionalProperties object

PureFarming.Schema.pfLogisticsUnit

PureFarming.Schema.pfLaboratoryAnalysisType

Name Type Notes
laboratory PureFarming.Schema.pfOrganisationReferenceType[]
laboratoryIdentifier string
sessionIdentifier string
responsible string
results PureFarming.Schema.pfAnalysisResultType[]
additionalProperties object

PureFarming.Schema.pfAnalysisResultType

Name Type Notes
name string
status PureFarming.Schema.pfAnalysisResultTypeStatus
abbreviation string
metric string (uri)
method string (uri)
rawValue string
rawUnit string
value number (double)
unit string
resolution number (double)
errorStatistic number (double)
qualitativeGrade string
limit number (double)
additionalProperties object

PureFarming.Schema.pfAnalysisResultTypeStatus

PureFarming.Schema.pfLoadStatus

PureFarming.Schema.pfEnterpriseStatistics

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType
location PureFarming.Schema.icarIdentifierType
additionalProperties object
id string
enterprise PureFarming.Schema.pfEnterpriseType
groupMethod PureFarming.Schema.pfGroupMethod
animalSetReference string
startDate string (date-time)
endDate string (date-time)
duration PureFarming.Schema.pfDurationUnitsType
inventoryClassification PureFarming.Schema.icarInventoryClassificationType
statistics PureFarming.Schema.pfEnterpriseStatisticsType[]

PureFarming.Schema.icarMetaDataType

Name Type Notes
source string
sourceId string
isDeleted boolean
modified string (date-time)
created string (date-time)
creator string
validFrom string (date-time)
validTo string (date-time)
additionalProperties object

PureFarming.Schema.icarIdentifierType

Name Type Notes
id string
scheme string
additionalProperties object

PureFarming.Schema.pfEnterpriseType

PureFarming.Schema.pfGroupMethod

PureFarming.Schema.pfDurationUnitsType

PureFarming.Schema.icarInventoryClassificationType

Name Type Notes
name string
count number (double)
species PureFarming.Schema.icarAnimalSpecieType
sex PureFarming.Schema.icarAnimalGenderType
primaryBreed PureFarming.Schema.icarIdentifierType
birthPeriod string
reproductiveStatus PureFarming.Schema.icarAnimalReproductionStatusType
lactationStatus PureFarming.Schema.icarAnimalLactationStatusType
productionPurposes PureFarming.Schema.icarProductionPurposeType[]
additionalProperties object

PureFarming.Schema.icarAnimalSpecieType

PureFarming.Schema.icarAnimalGenderType

PureFarming.Schema.icarAnimalReproductionStatusType

PureFarming.Schema.icarAnimalLactationStatusType

PureFarming.Schema.icarProductionPurposeType

PureFarming.Schema.pfEnterpriseStatisticsType

Name Type Notes
metric PureFarming.Schema.icarIdentifierType
method PureFarming.Schema.icarIdentifierType
units string
value number (double)
lastKnownValue number (double)
lastKnownValueDate string (date-time)
aggregation PureFarming.Schema.icarAggregationType
additionalProperties object

PureFarming.Schema.icarAggregationType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfClimateObservationsEvent]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfClimateObservationsEvent[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfClimateObservationsEvent

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
holding PureFarming.Schema.featureReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
features PureFarming.Schema.featureReferenceType[]
responsible string
remark string
sampledFeature PureFarming.Schema.featureReferenceType[]
sensorResults PureFarming.Schema.pfSensorResultType[]
device PureFarming.Schema.pfDeviceType[]

PureFarming.Schema.pfSensorResultType

Name Type Notes
phenomenon PureFarming.Schema.identifierType[]
method string
value number (double)
units string
aggregation PureFarming.Schema.aggregationType
resolution number (double)
duration number (double)
durationUnits PureFarming.Schema.uncefactTimeUnits
qualitativeValue string
observationStatus PureFarming.Schema.observationStatusType
problemDetail string
additionalProperties object

PureFarming.Schema.aggregationType

PureFarming.Schema.uncefactTimeUnits

PureFarming.Schema.observationStatusType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfHydrologicalObservationsEvent]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfHydrologicalObservationsEvent[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfHydrologicalObservationsEvent

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
holding PureFarming.Schema.featureReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
features PureFarming.Schema.featureReferenceType[]
responsible string
remark string
sampledFeature PureFarming.Schema.featureReferenceType[]
sensorResults PureFarming.Schema.pfSensorResultType[]
device PureFarming.Schema.pfDeviceType[]

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.catchLandingObservation]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.catchLandingObservation[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.catchLandingObservation

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
responsible string
remark string
trip PureFarming.Schema.fisheriesTripType[]
processor string
port string
numberShots integer (int32)
numberBins integer (int32)
potsPulled integer (int32)
numberTakeHome integer (int32)
tagRangeStart string
tagRangeEnd string
catch PureFarming.Schema.speciesQuantityType[]
bycatch PureFarming.Schema.speciesQuantityType[]

PureFarming.Schema.fisheriesTripType

Name Type Notes
tripId PureFarming.Schema.identifierType[]
skipper string
vesselName string
vesselIdentifier PureFarming.Schema.identifierType[]
licences array
startDateTime string (date-time)
endDateTime string (date-time)
fishery string
manDays number (double)
effortActive number (double)
effortNets number (double)
environmentalObservations PureFarming.Schema.environmentalObservationType[]
additionalProperties object

PureFarming.Schema.environmentalObservationType

Name Type Notes
metric PureFarming.Schema.identifierType[]
value number (double)
units string
aggregation PureFarming.Schema.aggregationType
additionalProperties object

PureFarming.Schema.speciesQuantityType

Name Type Notes
species string
grade string
weight PureFarming.Schema.massMeasureType[]
count integer (int32)
additionalProperties object

PureFarming.Schema.massMeasureType

Name Type Notes
measurement number (double)
resolution number (double)
additionalProperties object
units PureFarming.Schema.uncefactMassUnits

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfHoldingResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfHoldingResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfHoldingResource

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
totalArea PureFarming.Schema.areaMeasureType[]
totalLength PureFarming.Schema.lengthMeasureType[]
featureCatalog string
spatialFeature PureFarming.Schema.geoJsonFeature[]
centroid PureFarming.Schema.geoJsonPoint[]

PureFarming.Schema.geoJsonFeature

Name Type Notes
bbox array
id string
type PureFarming.Schema.geoJsonObjectTypes
geometry PureFarming.Schema.geoJsonGeometry[]
properties

PureFarming.Schema.geoJsonPoint

Name Type Notes
type PureFarming.Schema.geoJsonGeometryTypes
bbox array
coordinates array

MoA.Platform.Data.Api.Mediatr.Holdings.PostHoldingSummaryResponse

A list of summary data for holdings that is used for billing

Name Type Notes
holdings MoA.Platform.Data.Api.Mediatr.Holdings.HoldingSummary[]

A list of summary data for holdings that is used for billing purposes

MoA.Platform.Data.Api.Mediatr.Holdings.HoldingSummary

A list of summary data for holdings that is used for billing purposes

Name Type Notes
id string (uuid)

The internal entity ID of the holding
cropHarvestCount integer (int32)

The number of Crop Harvest records associated with this holding
cropLoadReceivalCount integer (int32)

The number of Crop Load Receivals records associated with this holding
cropSampleCount integer (int32)

The number of Crop Sampling records associated with this holding
plotCount integer (int32)

The number of Plots associated with this holding
soilSampleCount integer (int32)

The number of Soil Samples that are associated with this holding

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarFeedTransactionResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarFeedTransactionResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarFeedTransactionResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
transactionKind PureFarming.Schema.icarInventoryTransactionKindType
quantity number (double)
units string
supplierName string
expiryDate string (date-time)
totalCost number (double)
currency string
packSize number (double)
numberOfPacks number (double)
product PureFarming.Schema.icarFeedReferenceType[]

PureFarming.Schema.icarInventoryTransactionKindType

PureFarming.Schema.icarFeedReferenceType

Name Type Notes
context string
id string (uri)
type PureFarming.Schema.icarIdentifierType[]
identifier PureFarming.Schema.icarIdentifierType[]
reltype string
href string (uri)
additionalProperties object
category PureFarming.Schema.icarFeedCategoryType
reason PureFarming.Schema.icarFeedTransactionReasonType

PureFarming.Schema.icarFeedCategoryType

PureFarming.Schema.icarFeedTransactionReasonType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfFertiliserTransaction]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfFertiliserTransaction[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfFertiliserTransaction

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType[]
name string
self string
additionalProperties object
observationDate string (date-time)
phenomenonStartTime string (date-time)
phenomenonEndTime string (date-time)
holding PureFarming.Schema.featureReferenceType[]
feature PureFarming.Schema.featureReferenceType[]
features PureFarming.Schema.featureReferenceType[]
responsible string
remark string
transactionKind PureFarming.Schema.inventoryTransactionKindType
quantity number (double)
units string
supplierName string
expiryDate string (date-time)
totalCost number (double)
currency string
packSize number (double)
numberOfPacks number (double)
product PureFarming.Schema.productResource[]

PureFarming.Schema.inventoryTransactionKindType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMedicineTransactionResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarMedicineTransactionResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarMedicineTransactionResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
transactionKind PureFarming.Schema.icarInventoryTransactionKindType
quantity number (double)
units string
supplierName string
expiryDate string (date-time)
totalCost number (double)
currency string
packSize number (double)
numberOfPacks number (double)
product PureFarming.Schema.icarMedicineReferenceType[]

PureFarming.Schema.icarMedicineReferenceType

Name Type Notes
context string
id string (uri)
type PureFarming.Schema.icarResourceReferenceTypeType
identifier PureFarming.Schema.icarIdentifierType[]
reltype string
href string (uri)
additionalProperties object
name string
approved string
registeredIdentifier PureFarming.Schema.icarIdentifierType[]

PureFarming.Schema.icarResourceReferenceTypeType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarInventoryTransactionResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarInventoryTransactionResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarInventoryTransactionResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
transactionKind PureFarming.Schema.icarInventoryTransactionKindType
quantity number (double)
units string
supplierName string
expiryDate string (date-time)
totalCost number (double)
currency string
packSize number (double)
numberOfPacks number (double)
product PureFarming.Schema.icarProductReferenceType[]

PureFarming.Schema.icarProductReferenceType

Name Type Notes
context string
id string (uri)
type PureFarming.Schema.icarResourceReferenceTypeType
identifier PureFarming.Schema.icarIdentifierType[]
reltype string
href string (uri)
additionalProperties object
identifiers PureFarming.Schema.icarIdentifierType[]
family PureFarming.Schema.icarProductFamilyType
name string
gtin string
unspc string

PureFarming.Schema.icarProductFamilyType

PureFarming.Schema.pfLandCoverResource

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType
name string
self string
additionalProperties object
totalArea PureFarming.Schema.areaMeasureType
totalLength PureFarming.Schema.lengthMeasureType
classifications PureFarming.Schema.classificationType[]
activities PureFarming.Schema.landUseActivityType[]
landCoverClass PureFarming.Schema.classificationType
speciesPresent PureFarming.Schema.speciesPresenceType[]
eligibility PureFarming.Schema.complianceEligibilityType
spatialFeature PureFarming.Schema.geoJsonFeature
centroid PureFarming.Schema.geoJsonPoint

PureFarming.Schema.classificationType

Name Type Notes
scheme string
primary string
secondary string
tertiary string
additionalProperties object

PureFarming.Schema.landUseActivityType

Name Type Notes
id PureFarming.Schema.identifierType
name string
isPrimary boolean
productiveArea PureFarming.Schema.areaMeasureType
additionalProperties object

PureFarming.Schema.speciesPresenceType

Name Type Notes
name string
taxonomicName string
classfication PureFarming.Schema.classificationType
abundance PureFarming.Schema.dAFORabundance
additionalProperties object

PureFarming.Schema.dAFORabundance

PureFarming.Schema.complianceEligibilityType

Name Type Notes
scheme string
primary string
secondary string
tertiary string
additionalProperties object
eligible string

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfAnimalAssessmentEvent]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfAnimalAssessmentEvent[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfAnimalAssessmentEvent

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
metric PureFarming.Schema.icarIdentifierType[]
score number (double)
assessment string

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfAnimalGroup]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfAnimalGroup[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfAnimalGroup

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
classification PureFarming.Schema.icarInventoryClassificationType[]

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfComplianceAssessment]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfComplianceAssessment[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfComplianceAssessment

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
id string
reason string
assessmentSummary string
complianceProgramme PureFarming.Schema.icarIdentifierType[]
assessor PureFarming.Schema.icarIdentifierType[]
compliances PureFarming.Schema.pfAnimalComplianceType[]

PureFarming.Schema.icarGroupEventMethodType

PureFarming.Schema.icarAnimalSetResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
name string
purpose PureFarming.Schema.icarSetPurposeType
member PureFarming.Schema.icarIdentifierType[]

PureFarming.Schema.icarSetPurposeType

PureFarming.Schema.icarResourceReferenceType

Name Type Notes
context string
id string (uri)
type PureFarming.Schema.icarResourceReferenceTypeType
identifier PureFarming.Schema.icarIdentifierType[]
reltype string
href string (uri)
additionalProperties object

PureFarming.Schema.pfAnimalComplianceType

Name Type Notes
metric PureFarming.Schema.icarIdentifierType[]
method PureFarming.Schema.icarIdentifierType[]
units string
value number (double)
lastKnownValue number (double)
lastKnownValueDate string (date-time)
aggregation PureFarming.Schema.icarAggregationType
additionalProperties object
status string
name string

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetJoinEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarAnimalSetJoinEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarAnimalSetJoinEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
animalSetId string

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetLeaveEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarAnimalSetLeaveEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarAnimalSetLeaveEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
animalSetId string

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalSetResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarAnimalSetResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarAnimalCoreResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarAnimalCoreResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarAnimalCoreResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
identifier PureFarming.Schema.icarIdentifierType[]
alternativeIdentifiers PureFarming.Schema.icarIdentifierType[]
specie PureFarming.Schema.icarAnimalSpecieType
gender PureFarming.Schema.icarAnimalGenderType
birthDate string (date-time)
primaryBreed PureFarming.Schema.icarIdentifierType[]
breedFractions PureFarming.Schema.icarBreedFractionsType[]
coatColor string
coatColorIdentifier PureFarming.Schema.icarIdentifierType[]
managementTag string
name string
officialName string
productionPurpose PureFarming.Schema.icarProductionPurposeType
status PureFarming.Schema.icarAnimalStatusType
reproductionStatus PureFarming.Schema.icarAnimalReproductionStatusType
lactationStatus PureFarming.Schema.icarAnimalLactationStatusType
parentage PureFarming.Schema.icarParentageType[]
healthStatus PureFarming.Schema.icarAnimalHealthStatusType

PureFarming.Schema.icarBreedFractionsType

Name Type Notes
denominator integer (int32)
fractions PureFarming.Schema.fractions[]
additionalProperties object

PureFarming.Schema.fractions

Name Type Notes
breed PureFarming.Schema.icarIdentifierType[]
fraction number (double)
additionalProperties object

PureFarming.Schema.icarAnimalStatusType

PureFarming.Schema.icarParentageType

Name Type Notes
parentOf PureFarming.Schema.icarIdentifierType[]
gender PureFarming.Schema.icarAnimalGenderType
relation PureFarming.Schema.icarAnimalRelationType
identifier PureFarming.Schema.icarIdentifierType[]
officialName string
additionalProperties object

PureFarming.Schema.icarAnimalRelationType

PureFarming.Schema.icarAnimalHealthStatusType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarCarcassObservationsEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarCarcassObservationsEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarCarcassObservationsEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
carcass PureFarming.Schema.icarCarcassType[]
observations PureFarming.Schema.icarCarcassObservationType[]
side PureFarming.Schema.icarCarcassSideType
primal PureFarming.Schema.icarCarcassPrimalType
carcassState PureFarming.Schema.icarCarcassStateType
device PureFarming.Schema.icarDeviceResource[]

PureFarming.Schema.icarCarcassType

Name Type Notes
processingLot PureFarming.Schema.icarProcessingLotType[]
killDateTime string (date-time)
bodyNo integer (int32)
identifiers PureFarming.Schema.icarIdentifierType[]
sex PureFarming.Schema.icarAnimalGenderType
birthDate string (date-time)
birthDateConfidence string
primaryBreed PureFarming.Schema.icarIdentifierType[]
plantBoningRun integer (int32)
plantBoningRunTemplate string
destinationCode string
processorGrid string
additionalProperties object

PureFarming.Schema.icarProcessingLotType

Name Type Notes
id string
name string
chain PureFarming.Schema.icarPlantChainType[]
killDateTime string (date-time)
startBodyNumber integer (int32)
endBodyNumber integer (int32)
lotCount integer (int32)
targetMarket string
killType string
species PureFarming.Schema.icarAnimalSpecieType
consignment PureFarming.Schema.icarConsignmentType[]
interestedParties PureFarming.Schema.icarInterestedPartyType[]
additionalProperties object

PureFarming.Schema.icarPlantChainType

Name Type Notes
plant PureFarming.Schema.icarOrganizationType[]
chainId string
chainProcess PureFarming.Schema.icarChainProcessType
additionalProperties object

PureFarming.Schema.icarOrganizationType

Name Type Notes
name string
leiCode string
globalLocationNumber string
uri string (uri)
additionalProperties object
establishmentIdentifiers PureFarming.Schema.icarIdentifierType[]
address PureFarming.Schema.postalAddress[]
parentOrganization PureFarming.Schema.icarOrganizationIdentityType[]
membershipIdentifiers PureFarming.Schema.icarIdentifierType[]

PureFarming.Schema.postalAddress

Name Type Notes
addressCountry string
addressLocality string
addressRegion string
postOfficeBoxNumber string
postalCode string
streetAddress string
additionalProperties object

PureFarming.Schema.icarOrganizationIdentityType

Name Type Notes
name string
leiCode string
globalLocationNumber string
uri string (uri)
additionalProperties object

PureFarming.Schema.icarChainProcessType

PureFarming.Schema.icarConsignmentType

Name Type Notes
id PureFarming.Schema.icarIdentifierType[]
originLocation PureFarming.Schema.icarIdentifierType[]
originAddress string
originPostalAddress PureFarming.Schema.postalAddress[]
originOrganization PureFarming.Schema.icarOrganizationType[]
destinationLocation PureFarming.Schema.icarIdentifierType[]
destinationAddress string
destinationPostalAddress PureFarming.Schema.postalAddress[]
destinationOrganization PureFarming.Schema.icarOrganizationType[]
loadingDateTime string (date-time)
unloadingDateTime string (date-time)
expectedDuration number (double)
transportOperator string
vehicle string
transportReference string
isolationFacilityUsed boolean
farmAssuranceReference PureFarming.Schema.icarIdentifierType[]
countConsigned integer (int32)
countReceived integer (int32)
hoursOffFeed integer (int32)
hoursOffWater integer (int32)
references PureFarming.Schema.icarIdentifierType[]
interestedParties PureFarming.Schema.icarInterestedPartyType[]
declarations PureFarming.Schema.icarConsignmentDeclarationType[]
additionalProperties object

PureFarming.Schema.icarInterestedPartyType

Name Type Notes
name string
leiCode string
globalLocationNumber string
uri string (uri)
additionalProperties object
establishmentIdentifiers PureFarming.Schema.icarIdentifierType[]
address PureFarming.Schema.postalAddress[]
parentOrganization PureFarming.Schema.icarOrganizationIdentityType[]
membershipIdentifiers PureFarming.Schema.icarIdentifierType[]
interests array

PureFarming.Schema.icarConsignmentDeclarationType

Name Type Notes
declarationId PureFarming.Schema.icarDeclarationIdentifierType[]
declaredValue string
additionalProperties object

PureFarming.Schema.icarDeclarationIdentifierType

Name Type Notes
id string
scheme string
additionalProperties object

PureFarming.Schema.icarCarcassObservationType

Name Type Notes
metric PureFarming.Schema.icarCarcassMetricType[]
value number (double)
units string
resolution number (double)
qualitativeValue string
observationStatus PureFarming.Schema.icarObservationStatusType
problemDetail string
additionalProperties object

PureFarming.Schema.icarCarcassMetricType

Name Type Notes
id PureFarming.Schema.icarIdentifierType[]
method string
qualifier string
additionalProperties object

PureFarming.Schema.icarObservationStatusType

PureFarming.Schema.icarCarcassSideType

PureFarming.Schema.icarCarcassPrimalType

PureFarming.Schema.icarCarcassStateType

PureFarming.Schema.icarDeviceResource

Name Type Notes
id string
serial string
name string
description string
softwareVersion string
hardwareVersion string
isActive boolean
supportedMessages PureFarming.Schema.supportedMessages[]
manufacturer PureFarming.Schema.icarDeviceManufacturerType[]
additionalProperties object

PureFarming.Schema.supportedMessages

Name Type Notes
messages PureFarming.Schema.icarMessageType
additionalProperties object

PureFarming.Schema.icarMessageType

PureFarming.Schema.icarDeviceManufacturerType

Name Type Notes
id string
deviceType string
deviceName string
deviceDescription string
deviceConfiguration string
additionalProperties object

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupFeedingEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarGroupFeedingEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarGroupFeedingEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
feedingStartingDateTime string (date-time)
feedVisitDuration PureFarming.Schema.icarFeedDurationType[]
feedPerAnimal PureFarming.Schema.icarConsumedFeedType[]
rationPerAnimal PureFarming.Schema.icarConsumedRationType[]
device PureFarming.Schema.icarDeviceReferenceType[]

PureFarming.Schema.icarFeedDurationType

Name Type Notes
unitCode PureFarming.Schema.icarFeedDurationTypeUnitCode
value number (double)
additionalProperties object

PureFarming.Schema.icarFeedDurationTypeUnitCode

PureFarming.Schema.icarConsumedFeedType

Name Type Notes
feedId PureFarming.Schema.icarIdentifierType[]
entitlement PureFarming.Schema.icarFeedQuantityType[]
feedConsumption PureFarming.Schema.icarFeedQuantityType[]
additionalProperties object

PureFarming.Schema.icarFeedQuantityType

Name Type Notes
unitCode PureFarming.Schema.uncefactMassUnitsType
value number (double)
additionalProperties object

PureFarming.Schema.uncefactMassUnitsType

PureFarming.Schema.icarConsumedRationType

Name Type Notes
rationId string
entitlement PureFarming.Schema.icarFeedQuantityType[]
feedConsumption PureFarming.Schema.icarFeedQuantityType[]
additionalProperties object

PureFarming.Schema.icarDeviceReferenceType

Name Type Notes
context string
id string (uri)
type PureFarming.Schema.icarResourceReferenceTypeType
identifier PureFarming.Schema.icarIdentifierType[]
reltype string
href string (uri)
additionalProperties object
model string
serial string

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfGroupLaboratoryAnalysesEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfGroupLaboratoryAnalysesEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfGroupLaboratoryAnalysesEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
sampleDate string (date-time)
sampleType PureFarming.Schema.pfGroupLaboratoryAnalysesEventResourceSampleType
analyses PureFarming.Schema.pfLaboratoryAnalysisType[]

PureFarming.Schema.pfGroupLaboratoryAnalysesEventResourceSampleType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementArrivalEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarMovementArrivalEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarMovementArrivalEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
arrivalReason PureFarming.Schema.icarArrivalReasonType
animalDetail PureFarming.Schema.icarAnimalCoreResource[]
consignment PureFarming.Schema.icarConsignmentType[]

PureFarming.Schema.icarArrivalReasonType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementBirthEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarMovementBirthEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarMovementBirthEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
registrationReason PureFarming.Schema.icarRegistrationReasonType
animalDetail PureFarming.Schema.icarAnimalCoreResource[]

PureFarming.Schema.icarRegistrationReasonType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementDeathEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarMovementDeathEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarMovementDeathEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
deathReason PureFarming.Schema.icarDeathReasonType
explanation string
disposalMethod PureFarming.Schema.icarDeathDisposalMethodType
disposalOperator string
disposalReference string
consignment PureFarming.Schema.icarConsignmentType[]
deathMethod PureFarming.Schema.icarDeathMethodType

PureFarming.Schema.icarDeathReasonType

PureFarming.Schema.icarDeathDisposalMethodType

PureFarming.Schema.icarDeathMethodType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarMovementDepartureEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarMovementDepartureEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarMovementDepartureEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
departureKind PureFarming.Schema.icarDepartureKindType
departureReason PureFarming.Schema.icarDepartureReasonType
consignment PureFarming.Schema.icarConsignmentType[]

PureFarming.Schema.icarDepartureKindType

PureFarming.Schema.icarDepartureReasonType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementArrivalEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarGroupMovementArrivalEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarGroupMovementArrivalEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
arrivalReason PureFarming.Schema.icarArrivalReasonType
consignment PureFarming.Schema.icarConsignmentType[]

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementBirthEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarGroupMovementBirthEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarGroupMovementBirthEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
registrationReason PureFarming.Schema.icarRegistrationReasonType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementDeathEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarGroupMovementDeathEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarGroupMovementDeathEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
deathreason PureFarming.Schema.icarDeathReasonType
explanation string
disposalMethod PureFarming.Schema.icarDeathDisposalMethodType
disposalOperator string
disposalReference string
consignment PureFarming.Schema.icarConsignmentType[]
deathMethod PureFarming.Schema.icarDeathMethodType

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarGroupMovementDepartureEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarGroupMovementDepartureEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarGroupMovementDepartureEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
departureKind PureFarming.Schema.icarDepartureKindType
departureReason PureFarming.Schema.icarDepartureReasonType
consignment PureFarming.Schema.icarConsignmentType[]

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.pfPregnancyCheckEvent]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.pfPregnancyCheckEvent[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.pfPregnancyCheckEvent

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
method PureFarming.Schema.icarReproPregnancyMethodType
result PureFarming.Schema.icarReproPregnancyResultType
foetalAge integer (int32)
foetusCount integer (int32)
foetusCountMale integer (int32)
foetusCountFemale integer (int32)
exceptions array
expectedParturitionDate string (date-time)
impliedInseminationDate string (date-time)

PureFarming.Schema.icarReproPregnancyMethodType

PureFarming.Schema.icarReproPregnancyResultType

PureFarming.Schema.pfStockReconciliation

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType
location PureFarming.Schema.icarIdentifierType
additionalProperties object
startDate string (date-time)
endDate string (date-time)
duration PureFarming.Schema.pfDurationUnitsType
inventoryClassification PureFarming.Schema.icarInventoryClassificationType
open integer (int32)
arrivalsTotal integer (int32)
arrivals PureFarming.Schema.pfStockArrivalReasonType[]
departuresTotal integer (int32)
departures PureFarming.Schema.pfStockDepartureKindType[]
births integer (int32)
deaths integer (int32)
agedIn integer (int32)
agedOut integer (int32)
close integer (int32)

PureFarming.Schema.pfStockArrivalReasonType

Name Type Notes
reason PureFarming.Schema.icarArrivalReasonType
count integer (int32)
additionalProperties object

PureFarming.Schema.pfStockDepartureKindType

Name Type Notes
kind PureFarming.Schema.icarDepartureKindType
count integer (int32)
additionalProperties object

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarTreatmentEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarTreatmentEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarTreatmentEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
medicine PureFarming.Schema.icarMedicineReferenceType[]
procedure string
batches PureFarming.Schema.icarMedicineBatchType[]
withdrawals PureFarming.Schema.icarMedicineWithdrawalType[]
dose PureFarming.Schema.icarMedicineDoseType[]
site string
positions PureFarming.Schema.icarPositionType[]
comment string

PureFarming.Schema.icarMedicineBatchType

Name Type Notes
identifier string
expiryDate string (date-time)
additionalProperties object

PureFarming.Schema.icarMedicineWithdrawalType

Name Type Notes
productType PureFarming.Schema.icarWithdrawalProductType
endDate string (date-time)
market string
additionalProperties object

PureFarming.Schema.icarWithdrawalProductType

PureFarming.Schema.icarMedicineDoseType

Name Type Notes
doseQuantity number (double)
doseUnits PureFarming.Schema.uncefactDoseUnitsType
additionalProperties object

PureFarming.Schema.uncefactDoseUnitsType

PureFarming.Schema.icarPositionType

Name Type Notes
position PureFarming.Schema.icarPositionOnAnimalType
additionalProperties object

PureFarming.Schema.icarPositionOnAnimalType

PureFarming.Schema.icarGroupTreatmentEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType[]
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource[]
animalSetReference PureFarming.Schema.icarResourceReferenceType[]
medicine PureFarming.Schema.icarMedicineReferenceType[]
procedure string
batches PureFarming.Schema.icarMedicineBatchType[]
withdrawals PureFarming.Schema.icarMedicineWithdrawalType[]
dosePerAnimal PureFarming.Schema.icarMedicineDoseType[]
totalMedicineUsed PureFarming.Schema.icarMedicineDoseType[]
site string
positions PureFarming.Schema.icarPositionType[]

PureFarming.Schema.icarGroupWeightEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType
location PureFarming.Schema.icarIdentifierType
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType
responsible string
contemporaryGroup string
remark string
groupMethod PureFarming.Schema.icarGroupEventMethodType
countObserved integer (int32)
inventoryClassification PureFarming.Schema.icarInventoryClassificationType
embeddedAnimalSet PureFarming.Schema.icarAnimalSetResource
animalSetReference PureFarming.Schema.icarResourceReferenceType
units PureFarming.Schema.uncefactMassUnitsType
method PureFarming.Schema.icarWeightMethodType
resolution number (double)
animalWeights PureFarming.Schema.icarIndividualWeightType[]
statistics PureFarming.Schema.icarStatisticsType[]
device PureFarming.Schema.icarDeviceReferenceType
timeOffFeed number (double)

PureFarming.Schema.icarWeightMethodType

PureFarming.Schema.icarIndividualWeightType

Name Type Notes
animal PureFarming.Schema.icarIdentifierType
weight number (double)
additionalProperties object

PureFarming.Schema.icarStatisticsType

Name Type Notes
metric PureFarming.Schema.icarIdentifierType
unit string
aggregation PureFarming.Schema.icarAggregationType
value number (double)
additionalProperties object

MoA.Platform.Data.Api.Common.Shared.PagedResult`1[PureFarming.Schema.icarWeightEventResource]

A page in a paged result set.

Name Type Notes
items PureFarming.Schema.icarWeightEventResource[]
totalPages integer (int32)

Total number of pages in the result set.
limit integer (int32)

Number of items per page.
offset integer (int32)
totalItems integer (int32)

Total number of items in the result set.
page integer (int32)

The current page number.
links MoA.Platform.Data.Api.Common.Shared.PagedResultLinks[]

PureFarming.Schema.icarWeightEventResource

Name Type Notes
self string
meta PureFarming.Schema.icarMetaDataType[]
location PureFarming.Schema.icarIdentifierType[]
additionalProperties object
id string
eventDateTime string (date-time)
traitLabel PureFarming.Schema.icarIdentifierType[]
responsible string
contemporaryGroup string
remark string
animal PureFarming.Schema.icarIdentifierType[]
weight PureFarming.Schema.icarMassMeasureType[]
device PureFarming.Schema.icarDeviceReferenceType[]
timeOffFeed number (double)

PureFarming.Schema.icarMassMeasureType

Name Type Notes
measurement number (double)
units PureFarming.Schema.uncefactMassUnitsType
method PureFarming.Schema.icarWeightMethodType
resolution number (double)
additionalProperties object

PureFarming.Schema.plotResource

Name Type Notes
id string
identifiers PureFarming.Schema.identifierType[]
links PureFarming.Schema.relationType[]
meta PureFarming.Schema.metaDataType
name string
self string
additionalProperties object
totalArea PureFarming.Schema.areaMeasureType
totalLength PureFarming.Schema.lengthMeasureType
classifications PureFarming.Schema.classificationType[]
activities PureFarming.Schema.landUseActivityType[]
crops PureFarming.Schema.cropType[]
historicCrops PureFarming.Schema.cropType[]
spatialFeature PureFarming.Schema.geoJsonFeature
centroid PureFarming.Schema.geoJsonPoint