GET api/v{version}/ForecastPoints

Gets the forecast points for the current project.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

None.

Response Information

Resource Description

A list of forecast points.

Collection of ForecastPoint
NameDescriptionTypeAdditional information
Id

The ID of the forecast point.

integer

Required

Name

The name of the forecast point.

string

None.

Latitude

The latitude of the location of the forecast point.

decimal number

None.

Longitude

The longitude of the location of the forecast point.

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "Forecast point 1",
    "Latitude": 0.0,
    "Longitude": 0.0
  },
  {
    "Id": 2,
    "Name": "Forecast point 2",
    "Latitude": 1.0,
    "Longitude": 0.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfForecastPoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
  <ForecastPoint>
    <HotSpotCoordinates i:nil="true" />
    <HotSpotType i:nil="true" />
    <Id>1</Id>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <Name>Forecast point 1</Name>
  </ForecastPoint>
  <ForecastPoint>
    <HotSpotCoordinates i:nil="true" />
    <HotSpotType i:nil="true" />
    <Id>2</Id>
    <Latitude>1</Latitude>
    <Longitude>0.1</Longitude>
    <Name>Forecast point 2</Name>
  </ForecastPoint>
</ArrayOfForecastPoint>