POST api/PlanOrder/GetPlanOrdersView
Request Information
URI Parameters
None.
Body Parameters
Ships.Haifa.General.DataContracts.PlanOrdersViewRequestName | Description | Type | Additional information |
---|---|---|---|
SelectedDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{ "SelectedDate": "2025-03-15T03:21:17.0166131+02:00" }
application/xml, text/xml
Sample:
<PlanOrdersViewRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SelectedDate>2025-03-15T03:21:17.0166131+02:00</SelectedDate> </PlanOrdersViewRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Ships.Haifa.General.DataContracts.PlanOrdersViewResponseName | Description | Type | Additional information |
---|---|---|---|
Orders | Collection of Ships.Haifa.General.DataContracts.PlanOrderView |
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" }, "Orders": [ { "RegionId": 1, "RegionName": "sample string 2", "TerminalName": "sample string 3", "ShipTypeName": "sample string 4", "MovementTypeName": "sample string 5", "CurrentQuayName": "sample string 6", "DestinationQuayName": "sample string 7", "BollardsStr": "sample string 8", "TyingSideName": "sample string 9", "ShiftingRequestName": "sample string 10", "MovementShiftRequestName": "sample string 11", "ClassificationName": "sample string 12", "PlanOrderStatusName": "sample string 13", "PlanOrderId": 14, "CompanyId": "sample string 15", "UnLoCode": "sample string 16", "LoydsNumber": "sample string 17", "ShipType": "sample string 18", "ShipName": "sample string 19", "ShipLength": "sample string 20", "ManifestNumber": "sample string 21", "ShipAgentId": "sample string 22", "ShipAgentName": "sample string 23", "MovementType": 24, "CurrentQuayId": 25, "DestinationQuayId": 1, "FromBollard": 1.1, "ToBollard": 1.1, "TyingSide": 1, "ShiftingRequest": 1, "MovementDateRequest": "2025-03-15T03:21:17.0166131+02:00", "MovementShiftRequest": 1, "Classification": 1, "Remarks": "sample string 27", "RejectionRemarks": "sample string 28", "ActionType": "sample string 29", "PlanOrderStatusId": 30, "Version": 31, "UpdateDate": "2025-03-15T03:21:17.0166131+02:00", "UpdateBy": 33, "UpdateByUserName": "sample string 34", "IsObserved": true, "IsCancel": true, "ArriveSailDate": "2025-03-15T03:21:17.0166131+02:00", "PilotOnBoardState": true, "PlanOrderGroupNum": 38, "Revisit": true, "FromBollardProximity": "sample string 40", "ToBollardProximity": "sample string 41", "FacilityTerminalId": 1, "TerminalNameForShow": "sample string 42", "UnLoCodeForShow": "sample string 43" }, { "RegionId": 1, "RegionName": "sample string 2", "TerminalName": "sample string 3", "ShipTypeName": "sample string 4", "MovementTypeName": "sample string 5", "CurrentQuayName": "sample string 6", "DestinationQuayName": "sample string 7", "BollardsStr": "sample string 8", "TyingSideName": "sample string 9", "ShiftingRequestName": "sample string 10", "MovementShiftRequestName": "sample string 11", "ClassificationName": "sample string 12", "PlanOrderStatusName": "sample string 13", "PlanOrderId": 14, "CompanyId": "sample string 15", "UnLoCode": "sample string 16", "LoydsNumber": "sample string 17", "ShipType": "sample string 18", "ShipName": "sample string 19", "ShipLength": "sample string 20", "ManifestNumber": "sample string 21", "ShipAgentId": "sample string 22", "ShipAgentName": "sample string 23", "MovementType": 24, "CurrentQuayId": 25, "DestinationQuayId": 1, "FromBollard": 1.1, "ToBollard": 1.1, "TyingSide": 1, "ShiftingRequest": 1, "MovementDateRequest": "2025-03-15T03:21:17.0166131+02:00", "MovementShiftRequest": 1, "Classification": 1, "Remarks": "sample string 27", "RejectionRemarks": "sample string 28", "ActionType": "sample string 29", "PlanOrderStatusId": 30, "Version": 31, "UpdateDate": "2025-03-15T03:21:17.0166131+02:00", "UpdateBy": 33, "UpdateByUserName": "sample string 34", "IsObserved": true, "IsCancel": true, "ArriveSailDate": "2025-03-15T03:21:17.0166131+02:00", "PilotOnBoardState": true, "PlanOrderGroupNum": 38, "Revisit": true, "FromBollardProximity": "sample string 40", "ToBollardProximity": "sample string 41", "FacilityTerminalId": 1, "TerminalNameForShow": "sample string 42", "UnLoCodeForShow": "sample string 43" } ] }
application/xml, text/xml
Sample:
<PlanOrdersViewResponse 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> <Orders> <PlanOrderView> <PlanOrderId>14</PlanOrderId> <CompanyId>sample string 15</CompanyId> <UnLoCode>sample string 16</UnLoCode> <LoydsNumber>sample string 17</LoydsNumber> <ShipType>sample string 18</ShipType> <ShipName>sample string 19</ShipName> <ShipLength>sample string 20</ShipLength> <ManifestNumber>sample string 21</ManifestNumber> <ShipAgentId>sample string 22</ShipAgentId> <ShipAgentName>sample string 23</ShipAgentName> <MovementType>24</MovementType> <CurrentQuayId>25</CurrentQuayId> <DestinationQuayId>1</DestinationQuayId> <FromBollard>1.1</FromBollard> <ToBollard>1.1</ToBollard> <TyingSide>1</TyingSide> <ShiftingRequest>1</ShiftingRequest> <MovementDateRequest>2025-03-15T03:21:17.0166131+02:00</MovementDateRequest> <MovementShiftRequest>1</MovementShiftRequest> <Classification>1</Classification> <Remarks>sample string 27</Remarks> <RejectionRemarks>sample string 28</RejectionRemarks> <ActionType>sample string 29</ActionType> <PlanOrderStatusId>30</PlanOrderStatusId> <Version>31</Version> <UpdateDate>2025-03-15T03:21:17.0166131+02:00</UpdateDate> <UpdateBy>33</UpdateBy> <UpdateByUserName>sample string 34</UpdateByUserName> <IsObserved>true</IsObserved> <IsCancel>true</IsCancel> <ArriveSailDate>2025-03-15T03:21:17.0166131+02:00</ArriveSailDate> <PilotOnBoardState>true</PilotOnBoardState> <PlanOrderGroupNum>38</PlanOrderGroupNum> <Revisit>true</Revisit> <FromBollardProximity>sample string 40</FromBollardProximity> <ToBollardProximity>sample string 41</ToBollardProximity> <FacilityTerminalId>1</FacilityTerminalId> <TerminalNameForShow>sample string 42</TerminalNameForShow> <UnLoCodeForShow>sample string 43</UnLoCodeForShow> <RegionId>1</RegionId> <RegionName>sample string 2</RegionName> <TerminalName>sample string 3</TerminalName> <ShipTypeName>sample string 4</ShipTypeName> <MovementTypeName>sample string 5</MovementTypeName> <CurrentQuayName>sample string 6</CurrentQuayName> <DestinationQuayName>sample string 7</DestinationQuayName> <BollardsStr>sample string 8</BollardsStr> <TyingSideName>sample string 9</TyingSideName> <ShiftingRequestName>sample string 10</ShiftingRequestName> <MovementShiftRequestName>sample string 11</MovementShiftRequestName> <ClassificationName>sample string 12</ClassificationName> <PlanOrderStatusName>sample string 13</PlanOrderStatusName> </PlanOrderView> <PlanOrderView> <PlanOrderId>14</PlanOrderId> <CompanyId>sample string 15</CompanyId> <UnLoCode>sample string 16</UnLoCode> <LoydsNumber>sample string 17</LoydsNumber> <ShipType>sample string 18</ShipType> <ShipName>sample string 19</ShipName> <ShipLength>sample string 20</ShipLength> <ManifestNumber>sample string 21</ManifestNumber> <ShipAgentId>sample string 22</ShipAgentId> <ShipAgentName>sample string 23</ShipAgentName> <MovementType>24</MovementType> <CurrentQuayId>25</CurrentQuayId> <DestinationQuayId>1</DestinationQuayId> <FromBollard>1.1</FromBollard> <ToBollard>1.1</ToBollard> <TyingSide>1</TyingSide> <ShiftingRequest>1</ShiftingRequest> <MovementDateRequest>2025-03-15T03:21:17.0166131+02:00</MovementDateRequest> <MovementShiftRequest>1</MovementShiftRequest> <Classification>1</Classification> <Remarks>sample string 27</Remarks> <RejectionRemarks>sample string 28</RejectionRemarks> <ActionType>sample string 29</ActionType> <PlanOrderStatusId>30</PlanOrderStatusId> <Version>31</Version> <UpdateDate>2025-03-15T03:21:17.0166131+02:00</UpdateDate> <UpdateBy>33</UpdateBy> <UpdateByUserName>sample string 34</UpdateByUserName> <IsObserved>true</IsObserved> <IsCancel>true</IsCancel> <ArriveSailDate>2025-03-15T03:21:17.0166131+02:00</ArriveSailDate> <PilotOnBoardState>true</PilotOnBoardState> <PlanOrderGroupNum>38</PlanOrderGroupNum> <Revisit>true</Revisit> <FromBollardProximity>sample string 40</FromBollardProximity> <ToBollardProximity>sample string 41</ToBollardProximity> <FacilityTerminalId>1</FacilityTerminalId> <TerminalNameForShow>sample string 42</TerminalNameForShow> <UnLoCodeForShow>sample string 43</UnLoCodeForShow> <RegionId>1</RegionId> <RegionName>sample string 2</RegionName> <TerminalName>sample string 3</TerminalName> <ShipTypeName>sample string 4</ShipTypeName> <MovementTypeName>sample string 5</MovementTypeName> <CurrentQuayName>sample string 6</CurrentQuayName> <DestinationQuayName>sample string 7</DestinationQuayName> <BollardsStr>sample string 8</BollardsStr> <TyingSideName>sample string 9</TyingSideName> <ShiftingRequestName>sample string 10</ShiftingRequestName> <MovementShiftRequestName>sample string 11</MovementShiftRequestName> <ClassificationName>sample string 12</ClassificationName> <PlanOrderStatusName>sample string 13</PlanOrderStatusName> </PlanOrderView> </Orders> </PlanOrdersViewResponse>