GET api/v{version}/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.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of a transfer plan.

 integer

Required
vesselId

The ID of a vessel in the transfer plan.

 integer

Required
start

The date and time at which the vessel will start its first operation.

 date

Required
version

string

None.

Body Parameters

None.

Response Information

Resource Description

A complex object with an ID for the schedule and the PNG image as a Base64 encoded string.

ImageWithIdentifier
NameDescriptionTypeAdditional information
Id

integer

None.
ImageData

string

None.

Response Formats

image/png

Sample:

application/json, text/json

Sample: 
{
  "Id": 1,
  "ImageData": "sample string 2"
}

application/xml, text/xml

Sample: 
<ImageWithIdentifier xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.OAndM">
  <Id>1</Id>
  <ImageData>sample string 2</ImageData>
</ImageWithIdentifier>