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

Request Information

URI Parameters

Name	Description	Type	Additional 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

The ID of the schedule image.

ImageWithIdentifier

Name	Description	Type	Additional information
Id		integer	None.
ImageData		string	None.

Response Formats

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>