Assets
| API | Description |
|---|---|
| POST api/Assets |
Creates a new asset. |
| GET api/Assets |
Gets all assets in the user's current project. |
| GET api/Assets?id={id} |
Gets the asset with the given ID. |
| GET api/Assets?identifier={identifier} |
Gets the asset with the given identifier. |
| POST api/Assets/Update |
Updates an asset. |
| GET api/Assets/Delete?id={id} |
Deletes an asset. |
ForecastPoints
| API | Description |
|---|---|
| GET api/ForecastPoints?id={id} |
Gets the forecast point with the given ID. |
| GET api/ForecastPoints |
Gets the forecast points for the current project. |
| GET api/ForecastPoints/LastUpdate?id={id} |
Gets the last time that the forecast was updated. |
Projects
| API | Description |
|---|---|
| GET api/Projects |
Gets a list of projects to which the user has access. |
| GET api/Projects?id={id} |
Gets the project with the given ID. |
| GET api/Projects?identifier={identifier} |
Gets the project with the given identifier. |
TransitStageDurations
| API | Description |
|---|---|
| POST api/TransitStageDurations/Templates |
Creates a new transit stage duration template. |
| GET api/TransitStageDurations/Templates/Delete?startAssetId={startAssetId}&endAssetId={endAssetId}&order={order} |
Deletes a transit stage duration template. |
| POST api/TransitStageDurations/Templates/Update |
Updates a transit stage duration template. |
| GET api/TransitStageDurations/Templates |
Gets all transit stage duration templates in a project. |
| GET api/TransitStageDurations/Templates?startAssetId={startAssetId}&endAssetId={endAssetId} |
Gets all transit stage duration templates between two assets. |
| GET api/TransitStageDurations/Templates?startAssetId={startAssetId}&endAssetId={endAssetId}&order={order} |
Gets the transit stage duration template with the given order between two assets. |
| GET api/TransitStageDurations?startAssetId={startAssetId}&endAssetId={endAssetId} |
Gets all transit stage durations that are saved as templates between two assets, in a format which can be used in a transfer plan operation. |
| GET api/TransitStageDurations?startAssetId={startAssetId}&endAssetId={endAssetId}&order={order} |
Gets the transit stage duration that is saved as a template with the given order between two assets, in a format which can be used in a transfer plan operation. |
Variables
| API | Description |
|---|---|
| GET api/Variables |
Gets the variables for a project. |
| GET api/Variables?id={id} |
Gets the variable with the given ID. |
| GET api/Variables?name={name} |
Gets the variable with the given name. |
TransferPlans
| API | Description |
|---|---|
| GET api/TransferPlans?id={id} |
Gets the transfer plan with the given ID. |
| GET api/TransferPlans?minStart={minStart}&maxStart={maxStart} |
Gets a list of transfer plans for the current project. |
| POST api/TransferPlans |
Creates a transfer plan in the user's current project. |
| GET api/TransferPlans/GenerateStartTimes?id={id}&vesselId={vesselId}&maxStart={maxStart} |
Generates possible start times for a transfer plan within the current forecast range. Generated start times are 'on the hour'. |
| GET api/TransferPlans/GenerateScheduleImageId?id={id}&vesselId={vesselId}&start={start} |
Generates a new image of a transfer plan schedule, archives it for later use, and returns its ID. |
| GET api/TransferPlans/GenerateScheduleImage?id={id}&vesselId={vesselId}&start={start} |
Generates and returns new image of a transfer plan schedule along with its ID. Archives the schedule image for later use. |
| GET api/TransferPlans/ScheduleImages?id={id} |
Gets a previously generated image of a transfer plan schedule from the archive. |
| GET api/TransferPlans/Update?id={id}&start={start} |
Updates the start date of a transfer plan. |
| POST api/TransferPlans/Update?operationId={operationId} |
Replaces the existing stage durations of a transfer plan operation with another set of stage durations. |
| POST api/TransferPlans/Update?updateDetailsOnly={updateDetailsOnly} |
Updates a transfer plan. |
| GET api/TransferPlans/Delete?id={id} |
Deletes a transfer plan. |
Vessels
Handles API requests to get or change the vessels that are used for transfer planning.
| API | Description |
|---|---|
| GET api/Vessels |
Gets all vessels in the user's current project. |
| GET api/Vessels?identifier={identifier} |
Gets the vessel with the given identifier. |
| GET api/Vessels?id={id} |
Gets the vessel with the given ID. |
| POST api/Vessels |
Creates a vessel in the user's current project. |
| POST api/Vessels/Update?updateDetailsOnly={updateDetailsOnly} |
Updates a vessel. |
| POST api/Vessels/Update?thresholdsGroupId={thresholdsGroupId} |
Replaces the existing thresholds of a vessel thresholds group with another set of thresholds. |
| GET api/Vessels/Delete?id={id} |
Deletes a vessel. |
| GET api/Vessels/GenerateWeatherWindows?vesselId={vesselId}&assetId={assetId}&date={date} |
Generates the weather windows for the given vessel at the given asset on the given day. Weather windows are based on deterministic data only. |
| GET api/Vessels/GenerateWeatherWindowsImage?vesselId={vesselId}&assetIds[0]={assetIds[0]}&assetIds[1]={assetIds[1]}&date={date} |
Generates the weather windows image for the given vessel at the given assets on the given day. Weather windows are based on deterministic data only. |
| GET api/Vessels/GetWeatherData?vesselId={vesselId}&assetIds[0]={assetIds[0]}&assetIds[1]={assetIds[1]}&date={date} |
Gets the deterministic weather data at the given assets on the given day for the metocean conditions to which the given vessel is sensitive. |