POST api/PlanOrder/SaveSinglePlanOrder

Request Information

URI Parameters

None.

Body Parameters

Ships.Haifa.General.DataContracts.SinglePlanOrderRequest

Name	Description	Type	Additional information
PlanOrder		Ships.Haifa.General.DataContracts.PlanOrderContract	None.

Request Formats

application/json, text/json

Sample:

{
  "PlanOrder": {
    "PlanOrderId": 1,
    "CompanyId": "sample string 2",
    "UnLoCode": "sample string 3",
    "LoydsNumber": "sample string 4",
    "ShipType": "sample string 5",
    "ShipName": "sample string 6",
    "ShipLength": "sample string 7",
    "ManifestNumber": "sample string 8",
    "ShipAgentId": "sample string 9",
    "ShipAgentName": "sample string 10",
    "MovementType": 11,
    "CurrentQuayId": 12,
    "DestinationQuayId": 1,
    "FromBollard": 1.1,
    "ToBollard": 1.1,
    "TyingSide": 1,
    "ShiftingRequest": 1,
    "MovementDateRequest": "2025-03-14T19:07:59.6008845+02:00",
    "MovementShiftRequest": 1,
    "Classification": 1,
    "Remarks": "sample string 14",
    "RejectionRemarks": "sample string 15",
    "ActionType": "sample string 16",
    "PlanOrderStatusId": 17,
    "Version": 18,
    "UpdateDate": "2025-03-14T19:07:59.6008845+02:00",
    "UpdateBy": 20,
    "UpdateByUserName": "sample string 21",
    "IsObserved": true,
    "IsCancel": true,
    "ArriveSailDate": "2025-03-14T19:07:59.6008845+02:00",
    "PilotOnBoardState": true,
    "PlanOrderGroupNum": 25,
    "Revisit": true,
    "FromBollardProximity": "sample string 27",
    "ToBollardProximity": "sample string 28",
    "FacilityTerminalId": 1,
    "TerminalNameForShow": "sample string 29",
    "UnLoCodeForShow": "sample string 30"
  }
}

application/xml, text/xml

Sample:

<SinglePlanOrderRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PlanOrder>
    <PlanOrderId>1</PlanOrderId>
    <CompanyId>sample string 2</CompanyId>
    <UnLoCode>sample string 3</UnLoCode>
    <LoydsNumber>sample string 4</LoydsNumber>
    <ShipType>sample string 5</ShipType>
    <ShipName>sample string 6</ShipName>
    <ShipLength>sample string 7</ShipLength>
    <ManifestNumber>sample string 8</ManifestNumber>
    <ShipAgentId>sample string 9</ShipAgentId>
    <ShipAgentName>sample string 10</ShipAgentName>
    <MovementType>11</MovementType>
    <CurrentQuayId>12</CurrentQuayId>
    <DestinationQuayId>1</DestinationQuayId>
    <FromBollard>1.1</FromBollard>
    <ToBollard>1.1</ToBollard>
    <TyingSide>1</TyingSide>
    <ShiftingRequest>1</ShiftingRequest>
    <MovementDateRequest>2025-03-14T19:07:59.6008845+02:00</MovementDateRequest>
    <MovementShiftRequest>1</MovementShiftRequest>
    <Classification>1</Classification>
    <Remarks>sample string 14</Remarks>
    <RejectionRemarks>sample string 15</RejectionRemarks>
    <ActionType>sample string 16</ActionType>
    <PlanOrderStatusId>17</PlanOrderStatusId>
    <Version>18</Version>
    <UpdateDate>2025-03-14T19:07:59.6008845+02:00</UpdateDate>
    <UpdateBy>20</UpdateBy>
    <UpdateByUserName>sample string 21</UpdateByUserName>
    <IsObserved>true</IsObserved>
    <IsCancel>true</IsCancel>
    <ArriveSailDate>2025-03-14T19:07:59.6008845+02:00</ArriveSailDate>
    <PilotOnBoardState>true</PilotOnBoardState>
    <PlanOrderGroupNum>25</PlanOrderGroupNum>
    <Revisit>true</Revisit>
    <FromBollardProximity>sample string 27</FromBollardProximity>
    <ToBollardProximity>sample string 28</ToBollardProximity>
    <FacilityTerminalId>1</FacilityTerminalId>
    <TerminalNameForShow>sample string 29</TerminalNameForShow>
    <UnLoCodeForShow>sample string 30</UnLoCodeForShow>
  </PlanOrder>
</SinglePlanOrderRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SinglePlanOrderRequest'.

Response Information

Resource Description

Ships.Haifa.General.DataContracts.SinglePlanOrderResponse

Name	Type	Additional information
PlanOrder	Ships.Haifa.General.DataContracts.PlanOrderContract	None.
IsRejected	boolean	None.
Error	Ships.Haifa.General.DataContracts.ErrorStatusItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsRejected": true,
  "Error": {
    "Description": "sample string 1",
    "Level": "sample string 2"
  },
  "PlanOrder": {
    "PlanOrderId": 1,
    "CompanyId": "sample string 2",
    "UnLoCode": "sample string 3",
    "LoydsNumber": "sample string 4",
    "ShipType": "sample string 5",
    "ShipName": "sample string 6",
    "ShipLength": "sample string 7",
    "ManifestNumber": "sample string 8",
    "ShipAgentId": "sample string 9",
    "ShipAgentName": "sample string 10",
    "MovementType": 11,
    "CurrentQuayId": 12,
    "DestinationQuayId": 1,
    "FromBollard": 1.1,
    "ToBollard": 1.1,
    "TyingSide": 1,
    "ShiftingRequest": 1,
    "MovementDateRequest": "2025-03-14T19:07:59.6165073+02:00",
    "MovementShiftRequest": 1,
    "Classification": 1,
    "Remarks": "sample string 14",
    "RejectionRemarks": "sample string 15",
    "ActionType": "sample string 16",
    "PlanOrderStatusId": 17,
    "Version": 18,
    "UpdateDate": "2025-03-14T19:07:59.6165073+02:00",
    "UpdateBy": 20,
    "UpdateByUserName": "sample string 21",
    "IsObserved": true,
    "IsCancel": true,
    "ArriveSailDate": "2025-03-14T19:07:59.6165073+02:00",
    "PilotOnBoardState": true,
    "PlanOrderGroupNum": 25,
    "Revisit": true,
    "FromBollardProximity": "sample string 27",
    "ToBollardProximity": "sample string 28",
    "FacilityTerminalId": 1,
    "TerminalNameForShow": "sample string 29",
    "UnLoCodeForShow": "sample string 30"
  }
}

application/xml, text/xml

Sample:

<SinglePlanOrderResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsRejected>true</IsRejected>
  <Error>
    <Description>sample string 1</Description>
    <Level>sample string 2</Level>
  </Error>
  <PlanOrder>
    <PlanOrderId>1</PlanOrderId>
    <CompanyId>sample string 2</CompanyId>
    <UnLoCode>sample string 3</UnLoCode>
    <LoydsNumber>sample string 4</LoydsNumber>
    <ShipType>sample string 5</ShipType>
    <ShipName>sample string 6</ShipName>
    <ShipLength>sample string 7</ShipLength>
    <ManifestNumber>sample string 8</ManifestNumber>
    <ShipAgentId>sample string 9</ShipAgentId>
    <ShipAgentName>sample string 10</ShipAgentName>
    <MovementType>11</MovementType>
    <CurrentQuayId>12</CurrentQuayId>
    <DestinationQuayId>1</DestinationQuayId>
    <FromBollard>1.1</FromBollard>
    <ToBollard>1.1</ToBollard>
    <TyingSide>1</TyingSide>
    <ShiftingRequest>1</ShiftingRequest>
    <MovementDateRequest>2025-03-14T19:07:59.6165073+02:00</MovementDateRequest>
    <MovementShiftRequest>1</MovementShiftRequest>
    <Classification>1</Classification>
    <Remarks>sample string 14</Remarks>
    <RejectionRemarks>sample string 15</RejectionRemarks>
    <ActionType>sample string 16</ActionType>
    <PlanOrderStatusId>17</PlanOrderStatusId>
    <Version>18</Version>
    <UpdateDate>2025-03-14T19:07:59.6165073+02:00</UpdateDate>
    <UpdateBy>20</UpdateBy>
    <UpdateByUserName>sample string 21</UpdateByUserName>
    <IsObserved>true</IsObserved>
    <IsCancel>true</IsCancel>
    <ArriveSailDate>2025-03-14T19:07:59.6165073+02:00</ArriveSailDate>
    <PilotOnBoardState>true</PilotOnBoardState>
    <PlanOrderGroupNum>25</PlanOrderGroupNum>
    <Revisit>true</Revisit>
    <FromBollardProximity>sample string 27</FromBollardProximity>
    <ToBollardProximity>sample string 28</ToBollardProximity>
    <FacilityTerminalId>1</FacilityTerminalId>
    <TerminalNameForShow>sample string 29</TerminalNameForShow>
    <UnLoCodeForShow>sample string 30</UnLoCodeForShow>
  </PlanOrder>
</SinglePlanOrderResponse>