GET api/Assets

Gets all assets in the user's current project.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of assets.

Collection of Asset
NameDescriptionTypeAdditional information
Id

The ID of the asset.

integer

Required

Name

The name of the asset.

string

None.

Identifier

A name for the asset that must be unique for all assets within a project.

string

None.

Latitude

The latitude of the location of the asset.

decimal number

None.

Longitude

The longitude of the location of the asset.

decimal number

None.

ForecastPoint

The forecast point assigned to the asset.

ForecastPoint

Required

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "Port",
    "Identifier": "Asset 1",
    "Latitude": 0.0,
    "Longitude": 1.0,
    "ForecastPoint": {
      "Id": 10,
      "Name": "Forecast point 10",
      "Latitude": 0.0,
      "Longitude": 1.0
    }
  },
  {
    "Id": 2,
    "Name": "A1",
    "Identifier": "Asset 2",
    "Latitude": 1.0,
    "Longitude": 0.0,
    "ForecastPoint": {
      "Id": 3,
      "Name": "Forecast point 3",
      "Latitude": 1.1,
      "Longitude": 0.0
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfAsset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.OAndM">
  <Asset>
    <ForecastPoint xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
      <d3p1:HotSpotCoordinates i:nil="true" />
      <d3p1:HotSpotType i:nil="true" />
      <d3p1:Id>10</d3p1:Id>
      <d3p1:Latitude>0</d3p1:Latitude>
      <d3p1:Longitude>1</d3p1:Longitude>
      <d3p1:Name>Forecast point 10</d3p1:Name>
    </ForecastPoint>
    <Id>1</Id>
    <Identifier>Asset 1</Identifier>
    <Latitude>0</Latitude>
    <Longitude>1</Longitude>
    <Name>Port</Name>
    <ProjectId>0</ProjectId>
  </Asset>
  <Asset>
    <ForecastPoint xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
      <d3p1:HotSpotCoordinates i:nil="true" />
      <d3p1:HotSpotType i:nil="true" />
      <d3p1:Id>3</d3p1:Id>
      <d3p1:Latitude>1.1</d3p1:Latitude>
      <d3p1:Longitude>0</d3p1:Longitude>
      <d3p1:Name>Forecast point 3</d3p1:Name>
    </ForecastPoint>
    <Id>2</Id>
    <Identifier>Asset 2</Identifier>
    <Latitude>1</Latitude>
    <Longitude>0</Longitude>
    <Name>A1</Name>
    <ProjectId>0</ProjectId>
  </Asset>
</ArrayOfAsset>