LogicService Resource

GET /rest/organization

Response Body
media type data type description
application/json array of Organization (JSON)

Example

Request
GET /rest/rest/organization
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "defaultGridWeatherStationDataSource" : {
    "isGrid" : true,
    "weatherStationDataSourceId" : 12345,
    "name" : "...",
    "defaultDescription" : "...",
    "uri" : "...",
    "datafetchUriExpression" : "...",
    "infoUriExpression" : "..."
  },
  "organizationId" : 12345,
  "organizationName" : "...",
  "address1" : "...",
  "address2" : "...",
  "postalCode" : "...",
  "parentOrganizationId" : {
    "defaultGridWeatherStationDataSource" : {
      "isGrid" : true,
      "weatherStationDataSourceId" : 12345,
      "name" : "...",
      "defaultDescription" : "...",
      "uri" : "...",
      "datafetchUriExpression" : "...",
      "infoUriExpression" : "..."
    },
    "organizationId" : 12345,
    "organizationName" : "...",
    "address1" : "...",
    "address2" : "...",
    "postalCode" : "...",
    "parentOrganizationId" : { },
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "defaultLocale" : "...",
    "defaultMapZoom" : 12345,
    "defaultMapCenter" : {
      "boundaryDimension" : 12345,
      "empty" : true,
      "geometryType" : "...",
      "coordinateSequence" : { },
      "numPoints" : 12345,
      "y" : 12345.0,
      "dimension" : 12345,
      "boundary" : { },
      "x" : 12345.0,
      "coordinate" : { },
      "simple" : true,
      "coordinates" : [ { }, { } ],
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "precisionModel" : { },
      "numGeometries" : 12345,
      "rectangle" : true,
      "envelopeInternal" : { },
      "valid" : true,
      "centroid" : { }
    },
    "defaultTimeZone" : "...",
    "city" : "...",
    "defaultVipsCoreUserId" : 12345,
    "vipswebUrl" : "...",
    "archiveUser" : {
      "userId" : 12345,
      "email" : "...",
      "firstName" : "...",
      "lastName" : "...",
      "organization_id" : 12345,
      "userUuid" : "...",
      "preferredLocale" : "...",
      "phone" : "...",
      "phoneCountryCode" : "..."
    }
  },
  "countryCode" : {
    "countryCode" : "...",
    "phoneCode" : "..."
  },
  "defaultLocale" : "...",
  "defaultMapZoom" : 12345,
  "defaultMapCenter" : {
    "boundaryDimension" : 12345,
    "empty" : true,
    "geometryType" : "...",
    "coordinateSequence" : {
      "dimension" : 12345,
      "measures" : 12345
    },
    "numPoints" : 12345,
    "y" : 12345.0,
    "dimension" : 12345,
    "boundary" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "x" : 12345.0,
    "coordinate" : {
      "x" : 12345.0,
      "valid" : true,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0
    },
    "simple" : true,
    "coordinates" : [ {
      "x" : 12345.0,
      "valid" : true,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0
    }, {
      "x" : 12345.0,
      "valid" : true,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0
    } ],
    "area" : 12345.0,
    "SRID" : 12345,
    "userData" : { },
    "envelope" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "factory" : {
      "precisionModel" : { },
      "coordinateSequenceFactory" : { },
      "SRID" : 12345
    },
    "length" : 12345.0,
    "interiorPoint" : { },
    "precisionModel" : {
      "scale" : 12345.0,
      "maximumSignificantDigits" : 12345,
      "offsetX" : 12345.0,
      "type" : { },
      "floating" : true,
      "offsetY" : 12345.0
    },
    "numGeometries" : 12345,
    "rectangle" : true,
    "envelopeInternal" : {
      "diameter" : 12345.0,
      "minY" : 12345.0,
      "maxX" : 12345.0,
      "maxY" : 12345.0,
      "width" : 12345.0,
      "minX" : 12345.0,
      "height" : 12345.0,
      "null" : true,
      "area" : 12345.0
    },
    "valid" : true,
    "centroid" : { }
  },
  "defaultTimeZone" : "...",
  "city" : "...",
  "defaultVipsCoreUserId" : 12345,
  "vipswebUrl" : "...",
  "archiveUser" : {
    "userId" : 12345,
    "email" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "organization_id" : 12345,
    "userUuid" : "...",
    "preferredLocale" : "...",
    "phone" : "...",
    "phoneCountryCode" : "..."
  }
} ]

GET /rest/forecastconfigurations/{forecastConfigurationId}

Get the configuration of the specified forecast

Request Parameters
name type description constraints
forecastConfigurationId path The ID of the requested configuration (crop, pest, model, location, period, owner etc.) long
userUUID query if the forecast is private, the correct userUUID must be supplied.  
Response Body
media type data type description
application/json ForecastConfiguration (JSON) the configuration (crop, pest, model, location, period, owner etc.) of the specified forecast

Example

Request
GET /rest/rest/forecastconfigurations/{forecastConfigurationId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "useGridWeatherData" : true,
  "forecastConfigurationId" : 12345,
  "modelId" : "...",
  "dateStart" : 12345,
  "dateEnd" : 12345,
  "vipsLogicUserId" : {
    "userId" : 12345,
    "email" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "organization_id" : 12345,
    "userUuid" : "...",
    "preferredLocale" : "...",
    "phone" : "...",
    "phoneCountryCode" : "..."
  },
  "locationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "weatherStationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "cropOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "forecastSummaries" : [ {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  }, {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  } ],
  "pestOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "timeZone" : "...",
  "dateStartInTimeZone" : 12345,
  "dateEndInTimeZone" : 12345,
  "isPrivate" : true,
  "gridWeatherStationPointOfInterestIds" : [ 12345, 12345 ]
}

GET /rest/forecastconfigurationsincludeorgs/{organizationId}

Request Parameters
name type description constraints
organizationId path The primary organization to get forecast configurations from int
from query Dateformat = "yyyy-MM-dd"  
includeOrganizationIds query Additional organizations to get forecast configurations from  
to query Dateformat = "yyyy-MM-dd"  
Response Body
media type data type description
application/json array of ForecastConfiguration (JSON) A list of forecast configurations (for (a) given organization(s))

Example

Request
GET /rest/rest/forecastconfigurationsincludeorgs/{organizationId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "useGridWeatherData" : true,
  "forecastConfigurationId" : 12345,
  "modelId" : "...",
  "dateStart" : 12345,
  "dateEnd" : 12345,
  "vipsLogicUserId" : {
    "userId" : 12345,
    "email" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "organization_id" : 12345,
    "userUuid" : "...",
    "preferredLocale" : "...",
    "phone" : "...",
    "phoneCountryCode" : "..."
  },
  "locationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "weatherStationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "cropOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "forecastSummaries" : [ {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  }, {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  } ],
  "pestOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "timeZone" : "...",
  "dateStartInTimeZone" : 12345,
  "dateEndInTimeZone" : 12345,
  "isPrivate" : true,
  "gridWeatherStationPointOfInterestIds" : [ 12345, 12345 ]
} ]

GET /rest/forecastresults/{forecastConfigurationId}

Get all results for one pest prediction

Request Parameters
name type description constraints
forecastConfigurationId path Database id of the configured forecast long
userUUID query if the forecast is private, the correct userUUID must be supplied.  
Response Body
media type data type description
application/json array of ForecastResult (JSON) JSON with result data. A list of ForecastResult objects.

Example

Request
GET /rest/rest/forecastresults/{forecastConfigurationId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "forecastResultId" : 5710137,
  "validTimeStart" : "2019-01-22T23:00:00.000+0000",
  "validTimeEnd" : null,
  "warningStatus" : 0,
  "forecastConfigurationId" : -1000,
  "validGeometry" : {
    "type" : "Point",
    "coordinates" : [ 10.333252, 57.179002 ]
  },
  "keys" : [ "GRIDZYMOSE.WHS" ],
  "allValues" : {
    "GRIDZYMOSE.WHS" : "0"
  }
}

GET /rest/model/{modelId}

Request Parameters
name type description
modelId path
Response Body
media type data type description
application/json ModelInformation (JSON)

Example

Request
GET /rest/rest/model/{modelId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "modelId" : "...",
  "dateFirstRegistered" : 12345,
  "dateLastRegistered" : 12345,
  "defaultName" : "...",
  "copyrightHolder" : "...",
  "license" : "...",
  "defaultDescription" : "...",
  "sampleConfig" : "...",
  "usage" : "...",
  "vipsCoreInstanceId" : {
    "vipscoreInstanceId" : 12345,
    "uri" : "...",
    "username" : "...",
    "password" : "..."
  }
}

GET /rest/organization/{organizationId}

Request Parameters
name type description constraints
organizationId path int
Response Body
media type data type description
application/json array of Organization (JSON)

Example

Request
GET /rest/rest/organization/{organizationId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "defaultGridWeatherStationDataSource" : {
    "isGrid" : true,
    "weatherStationDataSourceId" : 12345,
    "name" : "...",
    "defaultDescription" : "...",
    "uri" : "...",
    "datafetchUriExpression" : "...",
    "infoUriExpression" : "..."
  },
  "organizationId" : 12345,
  "organizationName" : "...",
  "address1" : "...",
  "address2" : "...",
  "postalCode" : "...",
  "parentOrganizationId" : {
    "defaultGridWeatherStationDataSource" : {
      "isGrid" : true,
      "weatherStationDataSourceId" : 12345,
      "name" : "...",
      "defaultDescription" : "...",
      "uri" : "...",
      "datafetchUriExpression" : "...",
      "infoUriExpression" : "..."
    },
    "organizationId" : 12345,
    "organizationName" : "...",
    "address1" : "...",
    "address2" : "...",
    "postalCode" : "...",
    "parentOrganizationId" : { },
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "defaultLocale" : "...",
    "defaultMapZoom" : 12345,
    "defaultMapCenter" : {
      "boundaryDimension" : 12345,
      "empty" : true,
      "geometryType" : "...",
      "coordinateSequence" : { },
      "numPoints" : 12345,
      "y" : 12345.0,
      "dimension" : 12345,
      "boundary" : { },
      "x" : 12345.0,
      "coordinate" : { },
      "simple" : true,
      "coordinates" : [ { }, { } ],
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "precisionModel" : { },
      "numGeometries" : 12345,
      "rectangle" : true,
      "envelopeInternal" : { },
      "valid" : true,
      "centroid" : { }
    },
    "defaultTimeZone" : "...",
    "city" : "...",
    "defaultVipsCoreUserId" : 12345,
    "vipswebUrl" : "...",
    "archiveUser" : {
      "userId" : 12345,
      "email" : "...",
      "firstName" : "...",
      "lastName" : "...",
      "organization_id" : 12345,
      "userUuid" : "...",
      "preferredLocale" : "...",
      "phone" : "...",
      "phoneCountryCode" : "..."
    }
  },
  "countryCode" : {
    "countryCode" : "...",
    "phoneCode" : "..."
  },
  "defaultLocale" : "...",
  "defaultMapZoom" : 12345,
  "defaultMapCenter" : {
    "boundaryDimension" : 12345,
    "empty" : true,
    "geometryType" : "...",
    "coordinateSequence" : {
      "dimension" : 12345,
      "measures" : 12345
    },
    "numPoints" : 12345,
    "y" : 12345.0,
    "dimension" : 12345,
    "boundary" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "x" : 12345.0,
    "coordinate" : {
      "x" : 12345.0,
      "valid" : true,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0
    },
    "simple" : true,
    "coordinates" : [ {
      "x" : 12345.0,
      "valid" : true,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0
    }, {
      "x" : 12345.0,
      "valid" : true,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0
    } ],
    "area" : 12345.0,
    "SRID" : 12345,
    "userData" : { },
    "envelope" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "factory" : {
      "precisionModel" : { },
      "coordinateSequenceFactory" : { },
      "SRID" : 12345
    },
    "length" : 12345.0,
    "interiorPoint" : { },
    "precisionModel" : {
      "scale" : 12345.0,
      "maximumSignificantDigits" : 12345,
      "offsetX" : 12345.0,
      "type" : { },
      "floating" : true,
      "offsetY" : 12345.0
    },
    "numGeometries" : 12345,
    "rectangle" : true,
    "envelopeInternal" : {
      "diameter" : 12345.0,
      "minY" : 12345.0,
      "maxX" : 12345.0,
      "maxY" : 12345.0,
      "width" : 12345.0,
      "minX" : 12345.0,
      "height" : 12345.0,
      "null" : true,
      "area" : 12345.0
    },
    "valid" : true,
    "centroid" : { }
  },
  "defaultTimeZone" : "...",
  "city" : "...",
  "defaultVipsCoreUserId" : 12345,
  "vipswebUrl" : "...",
  "archiveUser" : {
    "userId" : 12345,
    "email" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "organization_id" : 12345,
    "userUuid" : "...",
    "preferredLocale" : "...",
    "phone" : "...",
    "phoneCountryCode" : "..."
  }
} ]

GET /rest/organizationforecastconfigurations/{organizationId}

Returns a list of forecasts for given organization

Request Parameters
name type description constraints multivalued
organizationId path int no
cropOrganismId query int yes
from query format="yyyy-MM-dd"   no
to query format="yyyy-MM-dd"   no
Response Body
media type data type description
application/json array of ForecastConfiguration (JSON)

Example

Request
GET /rest/rest/organizationforecastconfigurations/{organizationId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "useGridWeatherData" : true,
  "forecastConfigurationId" : 12345,
  "modelId" : "...",
  "dateStart" : 12345,
  "dateEnd" : 12345,
  "vipsLogicUserId" : {
    "userId" : 12345,
    "email" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "organization_id" : 12345,
    "userUuid" : "...",
    "preferredLocale" : "...",
    "phone" : "...",
    "phoneCountryCode" : "..."
  },
  "locationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "weatherStationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "cropOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "forecastSummaries" : [ {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  }, {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  } ],
  "pestOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "timeZone" : "...",
  "dateStartInTimeZone" : 12345,
  "dateEndInTimeZone" : 12345,
  "isPrivate" : true,
  "gridWeatherStationPointOfInterestIds" : [ 12345, 12345 ]
} ]

DELETE /rest/user/deleteme

Allows a user to delete their account

Request Parameters
name type description constraints
keepData query if true, move all data to default user. boolean
Response Body
media type data type description
application/json object (JSON)

Example

Request
DELETE /rest/rest/user/deleteme
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

POST /rest/user/register

Registers a user and grants limited access to certain functionalities in the VIPSLogic system:

  • Adding observations - default not approved
  • Adding POIs (Points Of Interest)
The user must be approved

Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /rest/rest/user/register
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /rest/forecastresults/{forecastConfigurationId}/csv

Get all results for one pest prediction

Request Parameters
name type description constraints
forecastConfigurationId path long
userUUID query if the forecast is private, the correct userUUID must be supplied.  
Response Body
media type data type description
text/csv;charset=UTF-8 object

Example

Request
GET /rest/rest/forecastresults/{forecastConfigurationId}/csv
Content-Type: */*
Accept: text/csv;charset=UTF-8

                
...
Response
HTTP/1.1 200 OK
Content-Type: text/csv;charset=UTF-8

                
...

GET /rest/forecastresults/{forecastConfigurationId}/{latestDays}

Get the latestDays results for one pest prediction

Request Parameters
name type description constraints
forecastConfigurationId path long
latestDays path int
userUUID query if the forecast is private, the correct userUUID must be supplied.  
Response Body
media type data type description
application/json array of ForecastResult (JSON)

Example

Request
GET /rest/rest/forecastresults/{forecastConfigurationId}/{latestDays}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "forecastResultId" : 5710137,
  "validTimeStart" : "2019-01-22T23:00:00.000+0000",
  "validTimeEnd" : null,
  "warningStatus" : 0,
  "forecastConfigurationId" : -1000,
  "validGeometry" : {
    "type" : "Point",
    "coordinates" : [ 10.333252, 57.179002 ]
  },
  "keys" : [ "GRIDZYMOSE.WHS" ],
  "allValues" : {
    "GRIDZYMOSE.WHS" : "0"
  }
}

GET /rest/organism/search/latinnames

Look up (an) organism(s) by its/their latin name(s)

Request Parameters
name type description
keywords query comma separated list of latin names
Response Body
media type data type description
application/json array of Organism (JSON) List of matching organisms (pests and crops)

Example

Request
GET /rest/rest/organism/search/latinnames
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "organismId" : 12345,
  "latinName" : "...",
  "tradeName" : "...",
  "logicallyDeleted" : true,
  "organismLocaleSet" : [ {
    "organismLocalePK" : {
      "organismId" : 12345,
      "locale" : "..."
    },
    "localName" : "..."
  }, {
    "organismLocalePK" : {
      "organismId" : 12345,
      "locale" : "..."
    },
    "localName" : "..."
  } ],
  "organismExternalResourceSet" : [ {
    "organismExternalResourcePK" : {
      "organismId" : 12345,
      "externalResourceId" : 12345
    },
    "resourceIdentifier" : "...",
    "organism" : {
      "organismId" : 12345,
      "latinName" : "...",
      "tradeName" : "...",
      "logicallyDeleted" : true,
      "organismLocaleSet" : [ { }, { } ],
      "organismExternalResourceSet" : [ { }, { } ],
      "parentOrganismId" : 12345,
      "hierarchyCategoryId" : 12345,
      "childOrganisms" : [ { }, { } ],
      "isPest" : true,
      "isCrop" : true,
      "extraProperties" : {
        "property1" : { },
        "property2" : { }
      },
      "observationDataSchema" : "...",
      "observationData" : "..."
    },
    "externalResource" : {
      "externalResourceId" : 12345,
      "uri" : "...",
      "identifierTemplate" : "...",
      "name" : "...",
      "externalResourceTypeId" : { }
    },
    "resourceUrl" : "..."
  }, {
    "organismExternalResourcePK" : {
      "organismId" : 12345,
      "externalResourceId" : 12345
    },
    "resourceIdentifier" : "...",
    "organism" : {
      "organismId" : 12345,
      "latinName" : "...",
      "tradeName" : "...",
      "logicallyDeleted" : true,
      "organismLocaleSet" : [ { }, { } ],
      "organismExternalResourceSet" : [ { }, { } ],
      "parentOrganismId" : 12345,
      "hierarchyCategoryId" : 12345,
      "childOrganisms" : [ { }, { } ],
      "isPest" : true,
      "isCrop" : true,
      "extraProperties" : {
        "property1" : { },
        "property2" : { }
      },
      "observationDataSchema" : "...",
      "observationData" : "..."
    },
    "externalResource" : {
      "externalResourceId" : 12345,
      "uri" : "...",
      "identifierTemplate" : "...",
      "name" : "...",
      "externalResourceTypeId" : { }
    },
    "resourceUrl" : "..."
  } ],
  "parentOrganismId" : 12345,
  "hierarchyCategoryId" : 12345,
  "childOrganisms" : [ {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  }, {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  } ],
  "isPest" : true,
  "isCrop" : true,
  "extraProperties" : {
    "property1" : { },
    "property2" : { }
  },
  "observationDataSchema" : "...",
  "observationData" : "..."
} ]

GET /rest/pois/kml/{organizationId}

Get a KML list of locations (pois) for a given organization

Request Parameters
name type description constraints
organizationId path int
excludePoiId query int
highlightPoiId query use this if you want to highlight a specific POI. Should be used in conjunction with excludePoiId int
Response Body
media type data type description
application/vnd.google-earth.kml+xml;charset=utf-8 object KML

Example

Request
GET /rest/rest/pois/kml/{organizationId}
Content-Type: */*
Accept: application/vnd.google-earth.kml+xml;charset=utf-8

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.google-earth.kml+xml;charset=utf-8

                
...

GET /rest/weatherstations/kml/{organizationId}

Get a list of weather stations for a given organization

Request Parameters
name type description constraints
organizationId path int
excludeWeatherStationId query Exclude this weather station from the KML int
highlightWeatherStationId query Show highlight icon for this weather station int
Response Body
media type data type description
application/vnd.google-earth.kml+xml;charset=utf-8 object a KML with weather stations for an organization

Example

Request
GET /rest/rest/weatherstations/kml/{organizationId}
Content-Type: */*
Accept: application/vnd.google-earth.kml+xml;charset=utf-8

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.google-earth.kml+xml;charset=utf-8

                
...

GET /rest/forecastconfigurations/model/{modelId}/{year}

Returns public forecast configurations for the given model and season

Request Parameters
name type description constraints
modelId path The ID of the model. 10 character string. E.g. PSILARTEMP  
year path The year for which to find the configured forecasts int
Response Body
media type data type description
application/json array of ForecastConfiguration (JSON)

Example

Request
GET /rest/rest/forecastconfigurations/model/{modelId}/{year}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "useGridWeatherData" : true,
  "forecastConfigurationId" : 12345,
  "modelId" : "...",
  "dateStart" : 12345,
  "dateEnd" : 12345,
  "vipsLogicUserId" : {
    "userId" : 12345,
    "email" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "organization_id" : 12345,
    "userUuid" : "...",
    "preferredLocale" : "...",
    "phone" : "...",
    "phoneCountryCode" : "..."
  },
  "locationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "weatherStationPointOfInterestId" : {
    "isPrivate" : true,
    "pointOfInterestId" : 12345,
    "name" : "...",
    "longitude" : 12345.0,
    "latitude" : 12345.0,
    "altitude" : 12345.0,
    "countryCode" : {
      "countryCode" : "...",
      "phoneCode" : "..."
    },
    "timeZone" : "...",
    "properties" : {
      "property1" : { },
      "property2" : { }
    },
    "userId" : 12345,
    "weatherForecastProviderId" : {
      "weatherForecastProviderId" : 12345,
      "name" : "...",
      "description" : "...",
      "infoUrl" : "..."
    },
    "pointOfInterestExternalResourceSet" : [ {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    }, {
      "pointOfInterestExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "externalResource" : { },
      "externalResourceUrl" : "..."
    } ],
    "pointOfInterestTypeId" : 12345,
    "gisGeom" : {
      "area" : 12345.0,
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "simple" : true,
      "factory" : { },
      "length" : 12345.0,
      "interiorPoint" : { },
      "empty" : true,
      "precisionModel" : { },
      "numGeometries" : 12345,
      "geometryType" : "...",
      "rectangle" : true,
      "boundary" : { },
      "envelopeInternal" : { },
      "numPoints" : 12345,
      "valid" : true,
      "dimension" : 12345,
      "centroid" : { },
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "boundaryDimension" : 12345
    },
    "geoJSON" : "...",
    "isForecastLocation" : true,
    "lastEditedTime" : 12345
  },
  "cropOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "forecastSummaries" : [ {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  }, {
    "forecastSummaryPK" : {
      "forecastConfigurationId" : 12345,
      "summaryForDate" : 12345
    },
    "summaryCreatedTime" : 12345,
    "warningStatus" : 12345
  } ],
  "pestOrganismId" : {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  },
  "timeZone" : "...",
  "dateStartInTimeZone" : 12345,
  "dateEndInTimeZone" : 12345,
  "isPrivate" : true,
  "gridWeatherStationPointOfInterestIds" : [ 12345, 12345 ]
} ]

GET /rest/forecastresults/latest/poi/{poiId}

Request Parameters
name type description constraints
poiId path int
Response Body
media type data type description
application/json object (JSON) The latest forecast results (within the current season) for a given Point Of Interest (poi)

Example

Request
GET /rest/rest/forecastresults/latest/poi/{poiId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /rest/forecastresults/{forecastConfigurationId}/{dateStart}/{dateEnd}

Get the forecast results for a particular forecast configuration in a given period

Request Parameters
name type description constraints
dateEnd path format "yyyy-MM-dd"  
dateStart path format "yyyy-MM-dd"  
forecastConfigurationId path long
Response Body
media type data type description
application/json array of ForecastResult (JSON) The forecast results for a particular forecast configuration in a given period

Example

Request
GET /rest/rest/forecastresults/{forecastConfigurationId}/{dateStart}/{dateEnd}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "forecastResultId" : 5710137,
  "validTimeStart" : "2019-01-22T23:00:00.000+0000",
  "validTimeEnd" : null,
  "warningStatus" : 0,
  "forecastConfigurationId" : -1000,
  "validGeometry" : {
    "type" : "Point",
    "coordinates" : [ 10.333252, 57.179002 ]
  },
  "keys" : [ "GRIDZYMOSE.WHS" ],
  "allValues" : {
    "GRIDZYMOSE.WHS" : "0"
  }
}

GET /rest/organism/search/localnames/{locale}

Look up organisms by local names

Request Parameters
name type description
locale path two-letter language code
keywords query Comma separated list of local name
Response Body
media type data type description
application/json array of Organism (JSON) List of matching organisms (pests and crops)

Example

Request
GET /rest/rest/organism/search/localnames/{locale}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "organismId" : 12345,
  "latinName" : "...",
  "tradeName" : "...",
  "logicallyDeleted" : true,
  "organismLocaleSet" : [ {
    "organismLocalePK" : {
      "organismId" : 12345,
      "locale" : "..."
    },
    "localName" : "..."
  }, {
    "organismLocalePK" : {
      "organismId" : 12345,
      "locale" : "..."
    },
    "localName" : "..."
  } ],
  "organismExternalResourceSet" : [ {
    "organismExternalResourcePK" : {
      "organismId" : 12345,
      "externalResourceId" : 12345
    },
    "resourceIdentifier" : "...",
    "organism" : {
      "organismId" : 12345,
      "latinName" : "...",
      "tradeName" : "...",
      "logicallyDeleted" : true,
      "organismLocaleSet" : [ { }, { } ],
      "organismExternalResourceSet" : [ { }, { } ],
      "parentOrganismId" : 12345,
      "hierarchyCategoryId" : 12345,
      "childOrganisms" : [ { }, { } ],
      "isPest" : true,
      "isCrop" : true,
      "extraProperties" : {
        "property1" : { },
        "property2" : { }
      },
      "observationDataSchema" : "...",
      "observationData" : "..."
    },
    "externalResource" : {
      "externalResourceId" : 12345,
      "uri" : "...",
      "identifierTemplate" : "...",
      "name" : "...",
      "externalResourceTypeId" : { }
    },
    "resourceUrl" : "..."
  }, {
    "organismExternalResourcePK" : {
      "organismId" : 12345,
      "externalResourceId" : 12345
    },
    "resourceIdentifier" : "...",
    "organism" : {
      "organismId" : 12345,
      "latinName" : "...",
      "tradeName" : "...",
      "logicallyDeleted" : true,
      "organismLocaleSet" : [ { }, { } ],
      "organismExternalResourceSet" : [ { }, { } ],
      "parentOrganismId" : 12345,
      "hierarchyCategoryId" : 12345,
      "childOrganisms" : [ { }, { } ],
      "isPest" : true,
      "isCrop" : true,
      "extraProperties" : {
        "property1" : { },
        "property2" : { }
      },
      "observationDataSchema" : "...",
      "observationData" : "..."
    },
    "externalResource" : {
      "externalResourceId" : 12345,
      "uri" : "...",
      "identifierTemplate" : "...",
      "name" : "...",
      "externalResourceTypeId" : { }
    },
    "resourceUrl" : "..."
  } ],
  "parentOrganismId" : 12345,
  "hierarchyCategoryId" : 12345,
  "childOrganisms" : [ {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  }, {
    "organismId" : 12345,
    "latinName" : "...",
    "tradeName" : "...",
    "logicallyDeleted" : true,
    "organismLocaleSet" : [ {
      "organismLocalePK" : { },
      "localName" : "..."
    }, {
      "organismLocalePK" : { },
      "localName" : "..."
    } ],
    "organismExternalResourceSet" : [ {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    }, {
      "organismExternalResourcePK" : { },
      "resourceIdentifier" : "...",
      "organism" : { },
      "externalResource" : { },
      "resourceUrl" : "..."
    } ],
    "parentOrganismId" : 12345,
    "hierarchyCategoryId" : 12345,
    "childOrganisms" : [ { }, { } ],
    "isPest" : true,
    "isCrop" : true,
    "extraProperties" : {
      "property1" : { },
      "property2" : { }
    },
    "observationDataSchema" : "...",
    "observationData" : "..."
  } ],
  "isPest" : true,
  "isCrop" : true,
  "extraProperties" : {
    "property1" : { },
    "property2" : { }
  },
  "observationDataSchema" : "...",
  "observationData" : "..."
} ]