GET api/v{version}/Assets?id={id}

Gets the asset with the given ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the asset.

integer

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

The requested asset.

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
  }
}

application/xml, text/xml

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