Eagle Marine

Provider Information:

Id

eagle_marine

Type

terminal

Trace Type

API

Credentials

Uses username and password and it is envase based

Limits

Maximum number of containers per request is 20

Status

draft

Doc Status

draft/final

Doc Version

1
URLs:

Type

URL

Environment

Page

http://n4.fenixmarineservices.com:9081/

DEV/STG/PRD
Sites:

Name

Site Id

Description

name

ern

the description

Request

Query Containers Request

Query containers using the request by adding the encrypted base64 access token in the headers as following.

Authorization: Basic <encrypted base64 token for username:password>

http://n4.fenixmarineservices.com:9081/apex/api/codeextension?PARM_CTRNBR={ContainerNumbers}&extensionname=FenixCheckCtrAvailability&PARM_filterName=UNIT_FINDER_QUERY&complexId=USSPQ&operatorId=FMS&facilityId=FMS&yardId=FMS

Note

  • Container numbers in the request should be separated with commas.

  • This request needs authorization token which is encrypted base64 of “username:password”

  • Query parameters sent on the request are required, otherwise failure responses will be returnedt

Responses

Query Containers Response

If token is invalid, it returns the following response.

Returned status code: 401 Unauthorized

<html lang="en">
            <head>
                    <title>HTTP Status 401 � Unauthorized</title>
                    <style type="text/css">H1 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:22px;} H2 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:16px;} H3 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:14px;} BODY {font-family:Tahoma,Arial,sans-serif;color:black;background-color:white;} B {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;} P {font-family:Tahoma,Arial,sans-serif;background:white;color:black;font-size:12px;}A {color : black;}A.name {color : black;}.line {height: 1px; background-color: #525D76; border: none;}</style>
            </head>
            <body>
                    <h1>
                            HTTP Status 401 � Unauthorized
                    </h1>
                    <hr class="line" />
                    <p><b>Type</b>Status Report</p>
                    <p><b>Description</b>The request has not been applied because it lacks valid authentication credentials for the target resource.</p>
                    <hr class="line" />
                    <h3>Apache Tomcat/8.0.53</h3>
             </body>
    </html

If a given container number was invalid or valid but not found it returns an empty response.

Returned status code: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<query-response>
<data-table filter="UNIT_FINDER_QUERY" count="2">
    <columns>
        <column>Last Move</column>
        <column>Unit Nbr</column>
        <column>Type ISO</column>
        <column>Category</column>
        <column>V-State</column>
        <column>T-State</column>
        <column>Position</column>
        <column>Line Op</column>
        <column>I/B Actual Visit</column>
        <column>I/B Actual Phase</column>
        <column>O/B Actual Visit</column>
        <column>O/B Actual Phase</column>
        <column>O/B Actual Mode</column>
        <column>POD</column>
        <column>Frght Kind</column>
        <column>Reqs Power</column>
        <column>Unit Impediments</column>
        <column>Stop-Vsl</column>
        <column>Stop-Rail</column>
        <column>Stop-Road</column>
        <column>Hold Status</column>
        <column>Appt status</column>
        <column>Appt Slot Start Date</column>
        <column>Appt Slot End Date</column>
        <column>Appointable Status</column>
        <column>LastFreeDay</column>
    </columns>
    <rows />
</data-table>
</query-response>

Note

If given containers contained valid and found containers and other invalid and/or not found containers, it returns the results for the found and ignores the invalid or not found.

Successful response for containers

Returned status code: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<query-response>
<data-table filter="UNIT_FINDER_QUERY" count="2">
    <columns>
        <column>Last Move</column>
        <column>Unit Nbr</column>
        <column>Type ISO</column>
        <column>Category</column>
        <column>V-State</column>
        <column>T-State</column>
        <column>Position</column>
        <column>Line Op</column>
        <column>I/B Actual Visit</column>
        <column>I/B Actual Phase</column>
        <column>O/B Actual Visit</column>
        <column>O/B Actual Phase</column>
        <column>O/B Actual Mode</column>
        <column>POD</column>
        <column>Frght Kind</column>
        <column>Reqs Power</column>
        <column>Unit Impediments</column>
        <column>Stop-Vsl</column>
        <column>Stop-Rail</column>
        <column>Stop-Road</column>
        <column>Hold Status</column>
        <column>Appt status</column>
        <column>Appt Slot Start Date</column>
        <column>Appt Slot End Date</column>
        <column>Appointable Status</column>
        <column>LastFreeDay</column>
    </columns>
    <rows>
        <row primary-key="10193586">
            <field>22-Jul-20 0625</field>
            <field>CGMU5165515</field>
            <field>45R1</field>
            <field>Import</field>
            <field>Active</field>
            <field>Inbound</field>
            <field>V-CLE0DBD0-461116</field>
            <field>CMA</field>
            <field>CLE0DBD0</field>
            <field>Inbound</field>
            <field>GEN_TRUCK</field>
            <field>Created</field>
            <field>Truck</field>
            <field>SPQ</field>
            <field>FCL</field>
            <field>false</field>
            <field>CUSTOMS,BL LINE HOLD</field>
            <field>false</field>
            <field>true</field>
            <field>true</field>
            <field>On Hold</field>
            <field />
            <field />
            <field />
            <field>NO</field>
            <field>--no time</field>
        </row>
        <row primary-key="10136235">
            <field>22-Jul-25 0857</field>
            <field>GESU6126768</field>
            <field>45G1</field>
            <field>Import</field>
            <field>Active</field>
            <field>Yard</field>
            <field>Grounded</field>
            <field>CMA</field>
            <field>CVA0GVBF</field>
            <field>Complete</field>
            <field>GEN_TRUCK</field>
            <field>Created</field>
            <field>Truck</field>
            <field>SPQ</field>
            <field>FCL</field>
            <field>false</field>
            <field />
            <field>false</field>
            <field>false</field>
            <field>false</field>
            <field />
            <field>CREATED</field>
            <field>2022-07-27 08:00:00.0</field>
            <field>2022-07-27 08:29:00.0</field>
            <field>NO</field>
            <field>2022-Jul-28</field>
        </row>
    </rows>
</data-table>
</query-response>
Data Mapping:

Property

Source Property

Description

container_number

field matching Unit Nbr column

The container number
loaded
field matching Frght Kind column
Container status according to value
If value is FCL then it is loaded
If value is Empty then empty

carrier.steamshipLine

field matching Line Op column

The shipping company scac

carrier.vessel

field matching Position column

Carrier vessel number if position != Yard
event[n].code
field matching T-State column
field matching I/B Actual Phase column
Arrived event is created if value is EC/In (or EC-In)
Arrived event is created if value is Complete

event[n].code

field matching T-State column

Grounded event is created if value is Yard

event[n].code

field matching T-State column

Outgated event is created if value is Departed

event[n].code

field matching LastFreeDay column

Released event is created if LastFreeDay has a date

event[n].code

field matching Unit Impediments column

Hold event is created if field has CUSTOMS,BL LINE HOLD

event[n].location.name

Default

eagle marine

event[n].location.type

Default

Terminal as eagle marine is a terminal

event[n].date

Default

Today date is a default date
Arrived Event:

Property

Source Property

Description
event[n].code
field matching T-State column
field matching I/B Actual Phase column
Event is created if value is EC/In (or EC-In)
Event is created if value is Complete

event[n].location.name

Default

eagle marine

event[n].location.type

Default

Terminal as eagle marine is a terminal

event[n].date

Default

Today date is a default date

event[n].data.arrived

Default

Today date is a default date

Note

Grounded event is created if T-State column is equal to Yard.

Grounded Event:

Property

Source Property

Description

event[n].code

Default

code is defaulted to grounded

event[n].location.name

Default

eagle marine

event[n].location.type

Default

Terminal as eagle marine is a terminal

event[n].date

Default

Today date is a default date

event[n].data.grounded

Default

Today date is a default date
Lfd Event:

Property

Source Property

Description

event[n].code

field matching LastFreeDay column

Lfd event is created if LastFreeDay has a date

event[n].location.name

Default

eagle marine

event[n].location.type

Default

Terminal as eagle marine is a terminal

event[n].date

Default

Today date is a default date

event[n].data.lfd

field matching LastFreeDay column

The last free date for container
Released Event:

Property

Source Property

Description

event[n].code

field matching LastFreeDay column

Released event is created if LastFreeDay has a date

event[n].location.name

Default

eagle marine

event[n].location.type

Default

Terminal as eagle marine is a terminal

event[n].date

Default

Today date is a default date

event[n].data.released

Today date is a default date
Outgated Event:

Property

Source Property

Description

event[n].code

field matching T-State column

Outgated event is created if value is Departed

event[n].location.name

Default

eagle marine

event[n].location.type

Default

Terminal as eagle marine is a terminal

event[n].date

Default

Today date is a default date

event[n].data.outgated

Default

Today date is a default date

event[n].data.outgate_scac

field matching Line Op column

The trucking company scac

event[n].data.outgate_confirmed

Default

True
Hold Events:

Property

Source Property

Description

event[n].code

Hold

Hold is the default value for the event

event[n].date

Default

Today date is the default date value

event[n].location.name

Default

Eagle marine

event[n].location.type

Default

Terminal as eagle marine is a terminal
event[n].code
field matching Unit Impediments column
Hold can be any of:
CUSTOMS,BL LINE HOLD,TMF-HOLD,CTF-HOLD

event[n].data.code

field matching Unit Impediments column

Provider dependent code