Pure Farming OGC Features API

Ogc

GET ogc/collections

A list of all feature collection classes specified in a standard that the server conforms to or, Metadata describing the collections of data available from API

Request

GET /ogc/collections

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	MoA.Platform.Data.Api.Common.Ogc.Collections	Success

GET ogc/collections/holdings

Request

GET /ogc/collections/holdings

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	MoA.Platform.Data.Api.Common.Ogc.Collection	Success

GET ogc/collections/holdings/{holdingId}/collections

Describe the collection for a specific holding

Request

GET /ogc/collections/holdings/{holdingId}/collections

Parameters

Name	Type	Default	Notes
*holdingId			The PureFarming ID for the 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	MoA.Platform.Data.Api.Common.Ogc.Collections	Success

GET ogc/collections/plots

Describe the plots collection

Request

GET /ogc/collections/plots

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	MoA.Platform.Data.Api.Common.Ogc.Collection	Success

GET ogc/collections/holdings/{holdingId}/collections/plots

Describe the plots collection for a specific holding

Request

GET /ogc/collections/holdings/{holdingId}/collections/plots

Parameters

Name	Type	Default	Notes
*holdingId			The PureFarming ID for the 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	MoA.Platform.Data.Api.Common.Ogc.Collection	Success

GET ogc/collections/land-covers

Describe the land covers collection

Request

GET /ogc/collections/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	MoA.Platform.Data.Api.Common.Ogc.Collection	Success

GET ogc/collections/holdings/{holdingId}/collections/land-covers

Describe the land covers collection for a specific holding

Request

GET /ogc/collections/holdings/{holdingId}/collections/land-covers

Parameters

Name	Type	Default	Notes
*holdingId			The PureFarming ID for the 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	MoA.Platform.Data.Api.Common.Ogc.Collection	Success

GET ogc

The landing page provides links to the API definition, the conformance statements and to the feature collections in this data set.

Request

GET /ogc

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	MoA.Platform.Data.Api.Common.Ogc.LandingPage	Success

GET ogc/conformance

A list of all conformance classes specified in a standard that the server conforms to

Request

GET /ogc/conformance

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	MoA.Platform.Data.Api.Common.Ogc.Conformance	Success

GET ogc/collections/holdings/items

Gets features of the feature collection. Every feature in a data set belongs to a collection. A data set may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.

Request

GET /ogc/collections/holdings/items[?limit&offset&bbox]

Parameters

Name	Type	Default	Notes
limit		10	The optional limit parameter limits the number of items that are presented in the response document. Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next) Minimum = 1, Maximum = 10000 Default value : 10
offset		0	The no. of features to exclude from the result
bbox			The bbox parameter can be used to select only a subset of the features in the collection (the features that are in the bounding box). The bbox parameter matches all features in the collection that are not associated with a location, too. minx, miny, maxx, maxy
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.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.pfHoldingResource]	Success
400	Microsoft.AspNetCore.Mvc.ProblemDetails	Bad Request
404	Microsoft.AspNetCore.Mvc.ProblemDetails	Not Found

GET ogc/collections/holdings/items/{id}

Fetch the holding feature with id

Request

GET /ogc/collections/holdings/items/{id}

Parameters

Name	Type	Default	Notes
*id			The identifier of the 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	MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.pfHoldingResource]	Success
400	Microsoft.AspNetCore.Mvc.ProblemDetails	Bad Request
404	Microsoft.AspNetCore.Mvc.ProblemDetails	Not Found

GET ogc/collections/land-covers/items

Gets features of the feature collection. Every feature in a data set belongs to a collection. A data set may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.

Request

GET /ogc/collections/land-covers/items[?limit&offset&bbox]

Parameters

Name	Type	Default	Notes
limit		10	The optional limit parameter limits the number of items that are presented in the response document. Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next) Minimum = 1, Maximum = 10000 Default value : 10
offset		0	The no. of features to exclude from the result
bbox			The bbox parameter can be used to select only a subset of the features in the collection (the features that are in the bounding box). The bbox parameter matches all features in the collection that are not associated with a location, too. minx, miny, maxx, maxy
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.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.pfLandCoverResource]	Success

GET ogc/collections/holdings/{holdingId}/collections/land-covers/items

Gets features of the feature collection. Every feature in a data set belongs to a collection. A data set may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.

Request

GET /ogc/collections/holdings/{holdingId}/collections/land-covers/items[?limit&offset&bbox]

Parameters

Name	Type	Default	Notes
*holdingId			The PureFarming ID of a holding
limit		10	The optional limit parameter limits the number of items that are presented in the response document. Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next) Minimum = 1, Maximum = 10000 Default value : 10
offset		0	The no. of features to exclude from the result
bbox			The bbox parameter can be used to select only a subset of the features in the collection (the features that are in the bounding box). The bbox parameter matches all features in the collection that are not associated with a location, too.
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.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.pfLandCoverResource]	Success
400	Microsoft.AspNetCore.Mvc.ProblemDetails	Bad Request
404	Microsoft.AspNetCore.Mvc.ProblemDetails	Not Found

GET ogc/collections/holdings/{holdingId}/collections/land-covers/items/{id}

Fetch the land cover feature for specified holding and land cover identifier

Request

GET /ogc/collections/holdings/{holdingId}/collections/land-covers/items/{id}

Parameters

Name	Type	Default	Notes
*holdingId			The PureFarming ID of the holding.
*id			The PureFarming ID of the land cover
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.Ogc.FeatureGeoJson`1[PureFarming.Schema.pfLandCoverResource]	Success

GET ogc/collections/land-covers/items/{id}

Fetch the land cover feature with id

Request

GET /ogc/collections/land-covers/items/{id}

Parameters

Name	Type	Default	Notes
*id			The identifier of the land cover.
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.Ogc.FeatureGeoJson`1[PureFarming.Schema.pfLandCoverResource]	Success

GET ogc/collections/plots/items

Gets features of the feature collection. Every feature in a data set belongs to a collection. A data set may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.

Request

GET /ogc/collections/plots/items[?limit&offset&bbox]

Parameters

Name	Type	Default	Notes
limit		10	The optional limit parameter limits the number of items that are presented in the response document. Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next) Minimum = 1, Maximum = 10000 Default value : 10
offset		0	The no. of features to exclude from the result
bbox			The bbox parameter can be used to select only a subset of the features in the collection (the features that are in the bounding box). The bbox parameter matches all features in the collection that are not associated with a location, too. minx, miny, maxx, maxy
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.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.plotResource]	Success

GET ogc/collections/holdings/{holdingId}/collections/plots/items

Gets features of the feature collection. Every feature in a data set belongs to a collection. A data set may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.

Request

GET /ogc/collections/holdings/{holdingId}/collections/plots/items[?limit&offset&bbox]

Parameters

Name	Type	Default	Notes
*holdingId			The PureFarming ID of a holding
limit		10	The optional limit parameter limits the number of items that are presented in the response document. Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next) Minimum = 1, Maximum = 10000 Default value : 10
offset		0	The no. of features to exclude from the result
bbox			The bbox parameter can be used to select only a subset of the features in the collection (the features that are in the bounding box). The bbox parameter matches all features in the collection that are not associated with a location, too.
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.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.pfLandCoverResource]	Success

GET ogc/collections/plots/items/{id}

Fetch the plot feature with id

Request

GET /ogc/collections/plots/items/{id}

Parameters

Name	Type	Default	Notes
*id			The identifier of 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	MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.plotResource]	Success
400	Microsoft.AspNetCore.Mvc.ProblemDetails	Bad Request
404	Microsoft.AspNetCore.Mvc.ProblemDetails	Not Found

GET ogc/collections/holdings/{holdingId}/collections/plots/items/{id}

Fetch the plot feature for specified holding and plot

Request

GET /ogc/collections/holdings/{holdingId}/collections/plots/items/{id}

Parameters

Name	Type	Default	Notes
*holdingId			The PureFarming ID of the holding.
*id			The PureFarming ID of 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	MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.plotResource]	Success
400	Microsoft.AspNetCore.Mvc.ProblemDetails	Bad Request
404	Microsoft.AspNetCore.Mvc.ProblemDetails	Not Found

Definitions

MoA.Platform.Data.Api.Common.Ogc.Collections

Provides information about and access to the collections

Name	Type	Notes
links	MoA.Platform.Data.Api.Common.Ogc.Link[]	Required, Links
items	MoA.Platform.Data.Api.Common.Ogc.Collection[]	Required, The items in the collection

MoA.Platform.Data.Api.Common.Ogc.Link

Required, Links

Name	Type	Notes
href	string (uri)	Supplies the URI to a remote resource (or resource fragment)
rel	string	The type or semantics of the relation
type	string	A hint indicating what the media type of the result of dereferencing the link should be
hrefLang	string	A hint indicating what the language of the result of dereferencing the link should be
title	string	Used to label the destination of a link such that it can be used as a human-readable identifier

MoA.Platform.Data.Api.Common.Ogc.Collection

Required, The items in the collection

Name	Type	Notes
id	string	Identifier of the collection used, for example, in URIs
links	MoA.Platform.Data.Api.Common.Ogc.Link[]	Links of the collection used

MoA.Platform.Data.Api.Common.Ogc.LandingPage

JSON schema for the OGC API - Common landing page

Name	Type	Notes
title	string	Human readable title of the API
description	string	A textual description of the API
links	MoA.Platform.Data.Api.Common.Ogc.Link[]	Links to the resources exposed through this API

MoA.Platform.Data.Api.Common.Ogc.Conformance

Conformance Class Core

Name	Type	Notes
conformsTo	array	The URIs of all conformance classes supported by the server

MoA.Platform.Data.Api.Common.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.pfHoldingResource]

Custom feature items

Name	Type	Notes
type	string	The type of collection. In this case => "FeatureCollection"
timeStamp	string (date-time)	This property indicates the time and date when the response was generated
numberMatched	integer (int32)	The number of features of the feature type that match the selection parameters like 'bbox'
numberReturned	integer (int32)	The number of features in the feature collection. A server may omit this information in a response, if the information about the number of features is not known or difficult to compute. If the value is provided, the value shall be identical to the number of items in the "features" array.
links	MoA.Platform.Data.Api.Common.Ogc.Link[]
features	MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.pfHoldingResource][]

MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.pfHoldingResource]

Name	Type	Notes
type	string	The type of collection. In this case => "Feature"
geometry	PureFarming.Schema.geoJsonGeometry[]
links	MoA.Platform.Data.Api.Common.Ogc.Link[]
properties	MoA.Platform.Data.Api.Common.Ogc.AgricultureProperties`1[PureFarming.Schema.pfHoldingResource][]

PureFarming.Schema.geoJsonGeometry

Name	Type	Notes
type	PureFarming.Schema.geoJsonGeometryTypes
bbox	array
coordinates

PureFarming.Schema.geoJsonGeometryTypes

MoA.Platform.Data.Api.Common.Ogc.AgricultureProperties`1[PureFarming.Schema.pfHoldingResource]

Name	Type	Notes
agriculture	PureFarming.Schema.pfHoldingResource[]

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.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.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.geoJsonFeature

Name	Type	Notes
bbox	array
id	string
type	PureFarming.Schema.geoJsonObjectTypes
geometry	PureFarming.Schema.geoJsonGeometry[]
properties

PureFarming.Schema.geoJsonObjectTypes

PureFarming.Schema.geoJsonPoint

Name	Type	Notes
type	PureFarming.Schema.geoJsonGeometryTypes
bbox	array
coordinates	array

Microsoft.AspNetCore.Mvc.ProblemDetails

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

MoA.Platform.Data.Api.Common.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.pfLandCoverResource]

Custom feature items

Name	Type	Notes
type	string	The type of collection. In this case => "FeatureCollection"
timeStamp	string (date-time)	This property indicates the time and date when the response was generated
numberMatched	integer (int32)	The number of features of the feature type that match the selection parameters like 'bbox'
numberReturned	integer (int32)	The number of features in the feature collection. A server may omit this information in a response, if the information about the number of features is not known or difficult to compute. If the value is provided, the value shall be identical to the number of items in the "features" array.
links	MoA.Platform.Data.Api.Common.Ogc.Link[]
features	MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.pfLandCoverResource][]

MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.pfLandCoverResource]

Name	Type	Notes
type	string	The type of collection. In this case => "Feature"
geometry	PureFarming.Schema.geoJsonGeometry[]
links	MoA.Platform.Data.Api.Common.Ogc.Link[]
properties	MoA.Platform.Data.Api.Common.Ogc.AgricultureProperties`1[PureFarming.Schema.pfLandCoverResource][]

MoA.Platform.Data.Api.Common.Ogc.AgricultureProperties`1[PureFarming.Schema.pfLandCoverResource]

Name	Type	Notes
agriculture	PureFarming.Schema.pfLandCoverResource[]

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.Ogc.FeatureItemsGeoJson`1[PureFarming.Schema.plotResource]

Custom feature items

Name	Type	Notes
type	string	The type of collection. In this case => "FeatureCollection"
timeStamp	string (date-time)	This property indicates the time and date when the response was generated
numberMatched	integer (int32)	The number of features of the feature type that match the selection parameters like 'bbox'
numberReturned	integer (int32)	The number of features in the feature collection. A server may omit this information in a response, if the information about the number of features is not known or difficult to compute. If the value is provided, the value shall be identical to the number of items in the "features" array.
links	MoA.Platform.Data.Api.Common.Ogc.Link[]
features	MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.plotResource][]

MoA.Platform.Data.Api.Common.Ogc.FeatureGeoJson`1[PureFarming.Schema.plotResource]

Name	Type	Notes
type	string	The type of collection. In this case => "Feature"
geometry	PureFarming.Schema.geoJsonGeometry[]
links	MoA.Platform.Data.Api.Common.Ogc.Link[]
properties	MoA.Platform.Data.Api.Common.Ogc.AgricultureProperties`1[PureFarming.Schema.plotResource][]

MoA.Platform.Data.Api.Common.Ogc.AgricultureProperties`1[PureFarming.Schema.plotResource]

Name	Type	Notes
agriculture	PureFarming.Schema.plotResource[]

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[]

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