Table of Contents

Pure Farming Reference API

BirthPeriod

GET reference/birthPeriods

Gets all the saved birth periods for the given species and country

Request
GET /reference/birthPeriods[?species&country]
Parameters
Name Type Default Notes
species

The species name to search on
country

The country name to search on
Responses
Status Code Type Description Samples
200 MoA.Platform.Reference.Api.Mediatr.GetBirthPeriods.GetBirthPeriodsResponse[]

Success
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

Treatment

GET reference/treatment/medicine-products

Request
GET /reference/treatment/medicine-products[?registration_authority&species&classification]
Parameters
Name Type Default Notes
registration_authority
species
classification
Responses
Status Code Type Description Samples
200 MoA.Platform.Schema.MedicineResource[]

Success
Mime type: application/json 
[
  {
    "activeIngredients": [
      {
        "id": {
          "id": "b5a92394-01db-41bb-8af1-9c31de670cbd",
          "scheme": "au.gov.apvma"
        },
        "name": "Thaicloprid"
      }
    ],
    "approved": "Registered",
    "classification": "Parasiticides",
    "expiryDate": "2023-06-03T12:00:00+00:00",
    "form": "TopicalSolutionSuspension",
    "location": {
      "id": "AUS",
      "scheme": "iso.iso3c"
    },
    "meta": {
      "created": "2023-01-16T14:00:00+00:00",
      "creator": "Swagger Example",
      "isDeleted": false,
      "modified": "2023-01-16T14:53:00+00:00",
      "source": "CSV Import",
      "sourceId": "8ba7c12b-bb39-454e-a8f3-95c050b7cb70",
      "validFrom": "2023-01-16T12:00:00+00:00",
      "validTo": "2024-01-16T12:00:00+00:00"
    },
    "name": "Thipan Dip for Sheep",
    "registeredId": {
      "id": "92718",
      "scheme": "au.gov.apvma"
    },
    "registrant": "Abbey Laboratories Pty Ltd",
    "registrationDate": "2022-11-21T13:00:00+00:00",
    "resourceType": "livestock/treatment/medicine-product",
    "self": "https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718",
    "species": [
      "Sheep"
    ],
    "withholdings": [
      {
        "hours": 1008,
        "market": "au.gov.apvma.whp",
        "productType": "Meat",
        "species": "Sheep"
      }
    ]
  }
]
Mime type: text/json 
[{"activeIngredients":[{"id":{"id":"b5a92394-01db-41bb-8af1-9c31de670cbd","scheme":"au.gov.apvma"},"name":"Thaicloprid"}],"approved":"Registered","classification":"Parasiticides","expiryDate":"2023-06-03T12:00:00+00:00","form":"TopicalSolutionSuspension","location":{"id":"AUS","scheme":"iso.iso3c"},"meta":{"created":"2023-01-16T14:00:00+00:00","creator":"Swagger Example","isDeleted":false,"modified":"2023-01-16T14:53:00+00:00","source":"CSV Import","sourceId":"8ba7c12b-bb39-454e-a8f3-95c050b7cb70","validFrom":"2023-01-16T12:00:00+00:00","validTo":"2024-01-16T12:00:00+00:00"},"name":"Thipan Dip for Sheep","registeredId":{"id":"92718","scheme":"au.gov.apvma"},"registrant":"Abbey Laboratories Pty Ltd","registrationDate":"2022-11-21T13:00:00+00:00","resourceType":"livestock/treatment/medicine-product","self":"https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718","species":["Sheep"],"withholdings":[{"hours":1008,"market":"au.gov.apvma.whp","productType":"Meat","species":"Sheep"}]}]
Mime type: text/plain 
[{"activeIngredients":[{"id":{"id":"b5a92394-01db-41bb-8af1-9c31de670cbd","scheme":"au.gov.apvma"},"name":"Thaicloprid"}],"approved":"Registered","classification":"Parasiticides","expiryDate":"2023-06-03T12:00:00+00:00","form":"TopicalSolutionSuspension","location":{"id":"AUS","scheme":"iso.iso3c"},"meta":{"created":"2023-01-16T14:00:00+00:00","creator":"Swagger Example","isDeleted":false,"modified":"2023-01-16T14:53:00+00:00","source":"CSV Import","sourceId":"8ba7c12b-bb39-454e-a8f3-95c050b7cb70","validFrom":"2023-01-16T12:00:00+00:00","validTo":"2024-01-16T12:00:00+00:00"},"name":"Thipan Dip for Sheep","registeredId":{"id":"92718","scheme":"au.gov.apvma"},"registrant":"Abbey Laboratories Pty Ltd","registrationDate":"2022-11-21T13:00:00+00:00","resourceType":"livestock/treatment/medicine-product","self":"https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718","species":["Sheep"],"withholdings":[{"hours":1008,"market":"au.gov.apvma.whp","productType":"Meat","species":"Sheep"}]}]

GET reference/treatment/medicine-products/{identifierScheme}/{identifierId}

Request
GET /reference/treatment/medicine-products/{identifierScheme}/{identifierId}
Parameters
Name Type Default Notes
*identifierScheme
*identifierId
Responses
Status Code Type Description Samples
200 MoA.Platform.Schema.MedicineResource

Success
Mime type: application/json 
{
  "activeIngredients": [
    {
      "id": {
        "id": "aea9b989-7348-4b87-a01f-809678191a3d",
        "scheme": "au.gov.apvma"
      },
      "name": "Thaicloprid"
    }
  ],
  "approved": "Registered",
  "classification": "Parasiticides",
  "expiryDate": "2023-06-03T12:00:00+00:00",
  "form": "TopicalSolutionSuspension",
  "location": {
    "id": "AUS",
    "scheme": "iso.iso3c"
  },
  "meta": {
    "created": "2023-01-16T14:00:00+00:00",
    "creator": "Swagger Example",
    "isDeleted": false,
    "modified": "2023-01-16T14:53:00+00:00",
    "source": "CSV Import",
    "sourceId": "481097f6-4dfd-4c1f-9309-cebeb9b0dbfc",
    "validFrom": "2023-01-16T12:00:00+00:00",
    "validTo": "2024-01-16T12:00:00+00:00"
  },
  "name": "Thipan Dip for Sheep",
  "registeredId": {
    "id": "92718",
    "scheme": "au.gov.apvma"
  },
  "registrant": "Abbey Laboratories Pty Ltd",
  "registrationDate": "2022-11-21T13:00:00+00:00",
  "resourceType": "livestock/treatment/medicine-product",
  "self": "https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718",
  "species": [
    "Sheep"
  ],
  "withholdings": [
    {
      "hours": 1008,
      "market": "au.gov.apvma.whp",
      "productType": "Meat",
      "species": "Sheep"
    }
  ]
}
Mime type: text/json 
{"activeIngredients":[{"id":{"id":"aea9b989-7348-4b87-a01f-809678191a3d","scheme":"au.gov.apvma"},"name":"Thaicloprid"}],"approved":"Registered","classification":"Parasiticides","expiryDate":"2023-06-03T12:00:00+00:00","form":"TopicalSolutionSuspension","location":{"id":"AUS","scheme":"iso.iso3c"},"meta":{"created":"2023-01-16T14:00:00+00:00","creator":"Swagger Example","isDeleted":false,"modified":"2023-01-16T14:53:00+00:00","source":"CSV Import","sourceId":"481097f6-4dfd-4c1f-9309-cebeb9b0dbfc","validFrom":"2023-01-16T12:00:00+00:00","validTo":"2024-01-16T12:00:00+00:00"},"name":"Thipan Dip for Sheep","registeredId":{"id":"92718","scheme":"au.gov.apvma"},"registrant":"Abbey Laboratories Pty Ltd","registrationDate":"2022-11-21T13:00:00+00:00","resourceType":"livestock/treatment/medicine-product","self":"https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718","species":["Sheep"],"withholdings":[{"hours":1008,"market":"au.gov.apvma.whp","productType":"Meat","species":"Sheep"}]}
Mime type: text/plain 
{"activeIngredients":[{"id":{"id":"aea9b989-7348-4b87-a01f-809678191a3d","scheme":"au.gov.apvma"},"name":"Thaicloprid"}],"approved":"Registered","classification":"Parasiticides","expiryDate":"2023-06-03T12:00:00+00:00","form":"TopicalSolutionSuspension","location":{"id":"AUS","scheme":"iso.iso3c"},"meta":{"created":"2023-01-16T14:00:00+00:00","creator":"Swagger Example","isDeleted":false,"modified":"2023-01-16T14:53:00+00:00","source":"CSV Import","sourceId":"481097f6-4dfd-4c1f-9309-cebeb9b0dbfc","validFrom":"2023-01-16T12:00:00+00:00","validTo":"2024-01-16T12:00:00+00:00"},"name":"Thipan Dip for Sheep","registeredId":{"id":"92718","scheme":"au.gov.apvma"},"registrant":"Abbey Laboratories Pty Ltd","registrationDate":"2022-11-21T13:00:00+00:00","resourceType":"livestock/treatment/medicine-product","self":"https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718","species":["Sheep"],"withholdings":[{"hours":1008,"market":"au.gov.apvma.whp","productType":"Meat","species":"Sheep"}]}
404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

GET reference/treatment/medicine-products/{search}

Request
GET /reference/treatment/medicine-products/{search}
Parameters
Name Type Default Notes
*search
Responses
Status Code Type Description Samples
200 MoA.Platform.Schema.MedicineResource

Success
Mime type: application/json 
{
  "activeIngredients": [
    {
      "id": {
        "id": "795e43fd-f354-4da4-9ba8-9b6afc417b36",
        "scheme": "au.gov.apvma"
      },
      "name": "Thaicloprid"
    }
  ],
  "approved": "Registered",
  "classification": "Parasiticides",
  "expiryDate": "2023-06-03T12:00:00+00:00",
  "form": "TopicalSolutionSuspension",
  "location": {
    "id": "AUS",
    "scheme": "iso.iso3c"
  },
  "meta": {
    "created": "2023-01-16T14:00:00+00:00",
    "creator": "Swagger Example",
    "isDeleted": false,
    "modified": "2023-01-16T14:53:00+00:00",
    "source": "CSV Import",
    "sourceId": "5cebea15-a43a-49d6-88f5-165a6498e15d",
    "validFrom": "2023-01-16T12:00:00+00:00",
    "validTo": "2024-01-16T12:00:00+00:00"
  },
  "name": "Thipan Dip for Sheep",
  "registeredId": {
    "id": "92718",
    "scheme": "au.gov.apvma"
  },
  "registrant": "Abbey Laboratories Pty Ltd",
  "registrationDate": "2022-11-21T13:00:00+00:00",
  "resourceType": "livestock/treatment/medicine-product",
  "self": "https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718",
  "species": [
    "Sheep"
  ],
  "withholdings": [
    {
      "hours": 1008,
      "market": "au.gov.apvma.whp",
      "productType": "Meat",
      "species": "Sheep"
    }
  ]
}
Mime type: text/json 
{"activeIngredients":[{"id":{"id":"795e43fd-f354-4da4-9ba8-9b6afc417b36","scheme":"au.gov.apvma"},"name":"Thaicloprid"}],"approved":"Registered","classification":"Parasiticides","expiryDate":"2023-06-03T12:00:00+00:00","form":"TopicalSolutionSuspension","location":{"id":"AUS","scheme":"iso.iso3c"},"meta":{"created":"2023-01-16T14:00:00+00:00","creator":"Swagger Example","isDeleted":false,"modified":"2023-01-16T14:53:00+00:00","source":"CSV Import","sourceId":"5cebea15-a43a-49d6-88f5-165a6498e15d","validFrom":"2023-01-16T12:00:00+00:00","validTo":"2024-01-16T12:00:00+00:00"},"name":"Thipan Dip for Sheep","registeredId":{"id":"92718","scheme":"au.gov.apvma"},"registrant":"Abbey Laboratories Pty Ltd","registrationDate":"2022-11-21T13:00:00+00:00","resourceType":"livestock/treatment/medicine-product","self":"https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718","species":["Sheep"],"withholdings":[{"hours":1008,"market":"au.gov.apvma.whp","productType":"Meat","species":"Sheep"}]}
Mime type: text/plain 
{"activeIngredients":[{"id":{"id":"795e43fd-f354-4da4-9ba8-9b6afc417b36","scheme":"au.gov.apvma"},"name":"Thaicloprid"}],"approved":"Registered","classification":"Parasiticides","expiryDate":"2023-06-03T12:00:00+00:00","form":"TopicalSolutionSuspension","location":{"id":"AUS","scheme":"iso.iso3c"},"meta":{"created":"2023-01-16T14:00:00+00:00","creator":"Swagger Example","isDeleted":false,"modified":"2023-01-16T14:53:00+00:00","source":"CSV Import","sourceId":"5cebea15-a43a-49d6-88f5-165a6498e15d","validFrom":"2023-01-16T12:00:00+00:00","validTo":"2024-01-16T12:00:00+00:00"},"name":"Thipan Dip for Sheep","registeredId":{"id":"92718","scheme":"au.gov.apvma"},"registrant":"Abbey Laboratories Pty Ltd","registrationDate":"2022-11-21T13:00:00+00:00","resourceType":"livestock/treatment/medicine-product","self":"https://api.dev.purefarming.com/reference/treatment/medicine-products/au.gov.apvma/92718","species":["Sheep"],"withholdings":[{"hours":1008,"market":"au.gov.apvma.whp","productType":"Meat","species":"Sheep"}]}

Definitions

MoA.Platform.Reference.Api.Mediatr.GetBirthPeriods.GetBirthPeriodsResponse

Name Type Notes
country string
endDay string
groupingName string
species string
startDay string

Microsoft.AspNetCore.Mvc.ProblemDetails

Name Type Notes
detail string
instance string
status integer (int32)
title string
type string

MoA.Platform.Schema.MedicineResource

Name Type Notes
activeIngredients MoA.Platform.Schema.MedicineIngredientType[]
approved string
classification MoA.Platform.Schema.MedicineClassificationEnum
expiryDate string (date-time)
form MoA.Platform.Schema.MedicineFormEnum
location MoA.Platform.Schema.IcarProductIdentifierType
meta MoA.Platform.Schema.FeedTransactionMeta
name string
registeredId MoA.Platform.Schema.IcarProductIdentifierType
registrant string
registrationDate string (date-time)
resourceType string
self string
species MoA.Platform.Schema.Species[]
withholdings MoA.Platform.Schema.MedicineWithholdingType[]

MoA.Platform.Schema.MedicineIngredientType

Name Type Notes
id MoA.Platform.Schema.IcarProductIdentifierType
name string

MoA.Platform.Schema.IcarProductIdentifierType

Name Type Notes
id string
scheme string

MoA.Platform.Schema.MedicineClassificationEnum

Enum Values
ActiveConstituent
AlimentaryAntibiotic
AlimentarySystem
AnaestheticsAnalgesics
AnalgesicMusculoskeletal
AntibioticGenitourinary
AntibioticNutritional
AntibioticRelated
Antidotes
Antihistamines
BrandingSubstance
CentralNervousSystem
DermalEquipDisinfectant
DermatologicalPreparations
Disinfectant
EndocrineSystem
Euthanasiates
GenitourinarySystem
ImmunoParasiteNutrition
Immunotherapy
MiscellaneousVeterinary
MusculoskeletalSystem
NutritionMetabolism
OphthalmicPreparations
ParasiticideNutritional
Parasiticides
RespiratorySystem

MoA.Platform.Schema.MedicineFormEnum

Enum Values
Aerosol
AqueousConcentrate
AuralOphthalmicOroNasoPharyngeal
EarTag
Injection
IntraMammary
IntraRuminalDevice
IntraVaginalUterinePrepDevice
Liquid
LiquidConcentrate
MedicatedDressingTopicalDevice
OralBlockLick
OralBolusChewable
OralBolusIntraVaginalUterine
OralCapsule
OralFoodCanSemiDryDry
OralGranulesPellets
OralPaste
OralPowderPreMix
OralSeleniumFertilizer
OralSolutionSuspension
OralTablet
ParenteralImplantDevice
ParenteralLiquidSolutionSuspension
Powder
Shampoo
TopicalAerosolSpray
TopicalCreamOintmentPasteGelLotion
TopicalDustPowder
TopicalOralSolutionSuspension
TopicalPumpSpray
TopicalSolutionSuspension
TopicalSprayLotion
Unknown
VaccinesOrAntiSera

MoA.Platform.Schema.FeedTransactionMeta

Name Type Notes
created string (date-time)
creator string
isDeleted boolean
modified string (date-time)
source string
sourceId string
validFrom string (date-time)
validTo string (date-time)

MoA.Platform.Schema.Species

MoA.Platform.Schema.MedicineWithholdingType

Name Type Notes
hours number (double)
market string
productType MoA.Platform.Schema.ProductTypeEnum
species MoA.Platform.Schema.Species

MoA.Platform.Schema.ProductTypeEnum

Enum Values
Eggs
Fibre
Honey
Meat
Milk
Other
Velvet