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. .. code-block:: Authorization: Basic .. code-block:: shell 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 .. code-block:: HTTP Status 401 � Unauthorized

HTTP Status 401 � Unauthorized

TypeStatus Report

DescriptionThe request has not been applied because it lacks valid authentication credentials for the target resource.

Apache Tomcat/8.0.53

.. 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 .. code-block:: xml

Last Move Unit Nbr Type ISO Category V-State T-State Position Line Op I/B Actual Visit I/B Actual Phase O/B Actual Visit O/B Actual Phase O/B Actual Mode POD Frght Kind Reqs Power Unit Impediments Stop-Vsl Stop-Rail Stop-Road Hold Status Appt status Appt Slot Start Date Appt Slot End Date Appointable Status LastFreeDay 22-Jul-20 0625 CGMU5165515 45R1 Import Active Inbound V-CLE0DBD0-461116 CMA CLE0DBD0 Inbound GEN_TRUCK Created Truck SPQ FCL false CUSTOMS,BL LINE HOLD false true true On Hold NO --no time 22-Jul-25 0857 GESU6126768 45G1 Import Active Yard Grounded CMA CVA0GVBF Complete GEN_TRUCK Created Truck SPQ FCL false false false false CREATED 2022-07-27 08:00:00.0 2022-07-27 08:29:00.0 NO 2022-Jul-28

: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 || Arrived event is created if value is EC/In (or EC-In) | || || field matching I/B Actual Phase column || 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 || Event is created if value is EC/In (or EC-In) | || || field matching I/B Actual Phase column || 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 | +------------------------+-----------------------------------------+-----------------------------------------+