LBCT ============================================================================= :Provider Information: +-----------------+------------------------------------------------+ | **Id** | lbct | +-----------------+------------------------------------------------+ | **Type** | terminal | +-----------------+------------------------------------------------+ | **Trace Type** | API | +-----------------+------------------------------------------------+ | **Credentials** | API Key for every customer | +-----------------+------------------------------------------------+ | **Limits** | Maximum number of containers per request is 20 | +-----------------+------------------------------------------------+ | **Status** | draft | +-----------------+------------------------------------------------+ | **Doc Status** | draft | +-----------------+------------------------------------------------+ | **Doc Version** | 1 | +-----------------+------------------------------------------------+ :URLs: +---------+--------------------------+-------------+ | Type | URL | Environment | +=========+==========================+=============+ | Request | https://api.lbct.com/ | PRD | +---------+--------------------------+-------------+ | Request | https://tstapi.lbct.com/ | DEV/STG | +---------+--------------------------+-------------+ :Sites: +------+---------+-----------------+ | Name | Site Id | Description | +======+=========+=================+ | name | ern | the description | +------+---------+-----------------+ Request ----------------------------------------------------------------------------- Query Containers Request ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Query containers using the following request by adding the API_KEY for the customer in the request url as following. .. code-block:: shell GET http://api.lbct.com//API/LBCTCargoSearchWebService/cargo-numbers/{ContainerNumbers} .. note:: Container numbers in the request should be separated with commas. Responses ----------------------------------------------------------------------------- Query Containers Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Next response is for two containers CSLU6264322 and FSCU5014182. .. code-block:: json { "id": 77033661363153, "service": "com.lbct.plugins.webservices.LBCTCargoSearchWebService", "payload": { "search-results": { "requested": 2, "found-containers": 2, "found-orders": 0, "not-found": 0, "not-found-numbers": [] }, "orders": [], "containers": [ { "id": "CSLU6264322", "gkey": 5459903117, "ufv-gkey": 5459903120, "is-in-yard": false, "category": "IMPRT", "freight-kind": "Full", "visit-state": "Departed", "transit-state": "Departed", "time-in": "2021-12-04T19:05:25.497-08:00", "time-out": "2021-12-19T09:41:30.871-08:00", "equipment-height": 96, "equipment-type": "40HQ", "equipment-size": 40, "line-operator": "OOL", "bill-of-lading-number": "2127609670", "gross-weight": 13300.0, "watch": "false", "discharged": "12/04/2021 19:05 (Actual)", "inbound-voyage-number": "018", "vessel-name": "COSCO SHIPPING AQUARIUS", "is-available-for-pickup": false, "availability-status": "NO (CONTAINER DEPARTED)", "location": "DEPARTED", "notifications": [ { "gkey": 1097962991, "status": "READ", "description": "Received Truck Pre-Arrival Data from TMS", "scac": "PFCH", "id": "AppointmentTMSTruckPreArrivalNotification", "actions": [], "type": "APPOINTMENT", "container-id": "CSLU6264322", "truck-visit-appointment-number": "122797", "is-notes-read": false, "ufv-gkey": 5459903120, "gate-appointment-gkey": 5750193363, "created": "2021-12-19T07:00:00.000-08:00", "event-date": "2021-12-19T07:00:00.000-08:00", "creator": "api.profittools@pfch", "changed": "2021-12-24T10:24:01.000-08:00", "changer": "derick@pfch" } ] }, { "id": "FSCU5014182", "gkey": 5662435782, "ufv-gkey": 5662435785, "is-in-yard": false, "category": "IMPRT", "freight-kind": "Full", "visit-state": "Active", "transit-state": "Inbound", "equipment-height": 86, "equipment-type": "40GP", "equipment-size": 40, "line-operator": "OOL", "impediment-road": "CUSTOMS_DEFAULT_HOLD,TMF_CONTAINER_HOLD", "bill-of-lading-number": "2684925670", "gross-weight": 18400.0, "watch": "false", "inbound-voyage-number": "049", "vessel-name": "COSCO ENGLAND", "is-available-for-pickup": false, "availability-status": "NO (NOT DISCHARGED)", "location": "ON VESSEL", "impediments": [ { "name": "TMF_CONTAINER_HOLD", "type": "HOLD", "hold-description": "PierPass TMF Container Hold", "entity": "UNIT", "apply-date": "2021-12-29T12:50:30.698-08:00", "applied-by": "groovy.job", "note": "Applied on Unit Activate", "status": "ACTIVE" }, { "name": "CUSTOMS_DEFAULT_HOLD", "type": "HOLD", "hold-description": "Customs BL Genereal Release", "entity": "BL", "apply-date": "2021-12-03T02:31:51.369-08:00", "applied-by": "-edi-", "note": "BL 2684925670 is on HOLD with manifested qty = null", "reference-id": "2684925670", "status": "ACTIVE" }, { "name": "FREIGHT_BL_HOLD", "type": "HOLD", "hold-description": "Hold Placed on the BL by the Lines", "entity": "BL", "apply-date": "2021-12-03T02:31:51.349-08:00", "applied-by": "-edi-", "status": "RELEASED" } ], "notifications": [] } ] }, "status": "OK", "type": "CargoSearch", "date": "2022-01-10T12:01:29.878-08:00", "node": "PRDAPI001", "environment": "PRD" } Not found containers Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If containers TTUT1234567 and TTUT3456789 are given as not found containers then API returns the next response. .. code-block:: json { "id": 115492732764297, "service": "com.lbct.plugins.webservices.LBCTCargoSearchWebService", "payload": { "search-results": { "requested": 2, "found-containers": 0, "found-orders": 0, "not-found": 2, "not-found-numbers": [ "TTUT1234567", "TTUT3456789" ] }, "orders": [], "containers": [] }, "status": "OK", "type": "CargoSearch", "date": "2022-01-10T12:05:22.761-08:00", "node": "PRDAPI001", "environment": "PRD" } :Data Mapping: +------------------------+----------------------------------------+---------------------------------------------------------------+ | Property | Source Property | Description | +========================+========================================+===============================================================+ | container_number | containers[n].id | The container reference number | +------------------------+----------------------------------------+---------------------------------------------------------------+ | steamshipBL | containers[n].bill-of-lading-number | Bill of lading | +------------------------+----------------------------------------+---------------------------------------------------------------+ | carrier.steamshipLine | containers[n].notification.scac | Carrier scac. | +------------------------+----------------------------------------+---------------------------------------------------------------+ | carrier.vessel | containers[n].vessel-name | Carrier vessel number | +------------------------+----------------------------------------+---------------------------------------------------------------+ | carrier.voyage | containers[n].inbound-voyage-number | Carrier voyage number | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].code | containers[n].time-in | Arrived event is created if time-in has a date | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].code | containers[n].discharged | Grounded event is created if discharged has a date | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].code | containers[n].good-thru-day | Lfd event is created if good-thru-day has a date | +------------------------+----------------------------------------+---------------------------------------------------------------+ || event[n].code || containers[n].is-available-for-pickup || Released event is created if is-available-for-pickup is True | || || containers[n].good-thru-day || And good-thru-day has a date which represents lfd | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].code | containers[n].time-out | Outgated event is created if discharged has a date | +------------------------+----------------------------------------+---------------------------------------------------------------+ || event[n].code || containers[n].impediments.name || Indicate which hold event is created if condition is matched | || || || And impediments.status is set to Active | || || || Hold: Condition | || || || TMF Hold: if name is TMF_CONTAINER_HOLD | || || || Customs Hold: if name is CUSTOMS_DEFAULT_HOLD | || || || Freight Hold: if name is FREIGHT_BL_HOLD | || || || Steamship Hold: if name is STEAMSHIP_HOLD | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].date | Default | Today date is a default date | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].location.name | Default | LBCT | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +------------------------+----------------------------------------+---------------------------------------------------------------+ | event[n].data.lfd | containers[n].good-thru-day | LFD for the container. | +------------------------+----------------------------------------+---------------------------------------------------------------+ .. note:: ETA event is determined on a seperate request, which will be covered next. Arrived Event Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json { "id": 400854854483170, "service": "com.lbct.plugins.webservices.LBCTCargoSearchWebService", "payload": { "search-results": { "requested": 20, "found-containers": 1, "found-orders": 0, "not-found": 0, "not-found-numbers": [] }, "orders": [], "containers": [ { "id": "SEKU4563686", "gkey": 5617553087, "ufv-gkey": 5617553089, "is-in-yard": false, "category": "IMPRT", "freight-kind": "Full", "visit-state": "Departed", "transit-state": "Departed", "time-in": "2022-01-06T08:43:55.051-08:00", "time-out": "2022-01-06T20:34:40.800-08:00", "equipment-height": 96, "equipment-type": "40HQ", "equipment-size": 40, "line-operator": "OOL", "bill-of-lading-number": "2685264910", "gross-weight": 12700.0, "watch": "false", "discharged": "01/06/2022 08:43 (Actual)", "inbound-voyage-number": "049", "vessel-name": "CSCL BOHAI SEA", "is-available-for-pickup": false, "availability-status": "NO (CONTAINER DEPARTED)", "location": "DEPARTED", "notifications": [ { "gkey": 1118234639, "status": "UNREAD", "description": "Received Truck Pre-Arrival Data from TMS", "scac": "PFCH", "id": "AppointmentTMSTruckPreArrivalNotification", "actions": [], "type": "APPOINTMENT", "container-id": "SEKU4563686", "truck-visit-appointment-number": "262706", "is-notes-read": false, "ufv-gkey": 5617553089, "gate-appointment-gkey": 5856720785, "created": "2022-01-06T19:20:02.000-08:00", "event-date": "2022-01-06T19:20:02.000-08:00", "creator": "api.profittools@pfch" } ] }, ], }, "status": "OK", "type": "CargoSearch", "date": "2022-01-11T06:07:28.146-08:00", "node": "PRDAPI001", "environment": "PRD" } .. note:: Arrived event is created if **time-in** has a date like the one in the previous response. :Arrived Event Data Mapping: +------------------------+-----------------------+-------------------------------+ | Property | Source Property | Description | +========================+=======================+===============================+ | event[n].code | Default | Value is defaulted to arrived | +------------------------+-----------------------+-------------------------------+ | event[n].date | Default | Today date is a default date | +------------------------+-----------------------+-------------------------------+ | event[n].location.name | Default | LBCT | +------------------------+-----------------------+-------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +------------------------+-----------------------+-------------------------------+ | event[n].data.arrived | containers[n].time-in | Date of the arrived event. | +------------------------+-----------------------+-------------------------------+ Grounded Event Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json { "id": 400854854483170, "service": "com.lbct.plugins.webservices.LBCTCargoSearchWebService", "payload": { "search-results": { "requested": 20, "found-containers": 1, "found-orders": 0, "not-found": 0, "not-found-numbers": [] }, "orders": [], "containers": [ { "id": "SEKU4563686", "gkey": 5617553087, "ufv-gkey": 5617553089, "is-in-yard": false, "category": "IMPRT", "freight-kind": "Full", "visit-state": "Departed", "transit-state": "Departed", "time-in": "2022-01-06T08:43:55.051-08:00", "time-out": "2022-01-06T20:34:40.800-08:00", "equipment-height": 96, "equipment-type": "40HQ", "equipment-size": 40, "line-operator": "OOL", "bill-of-lading-number": "2685264910", "gross-weight": 12700.0, "watch": "false", "discharged": "01/06/2022 08:43 (Actual)", "inbound-voyage-number": "049", "vessel-name": "CSCL BOHAI SEA", "is-available-for-pickup": false, "availability-status": "NO (CONTAINER DEPARTED)", "location": "DEPARTED", "notifications": [ { "gkey": 1118234639, "status": "UNREAD", "description": "Received Truck Pre-Arrival Data from TMS", "scac": "PFCH", "id": "AppointmentTMSTruckPreArrivalNotification", "actions": [], "type": "APPOINTMENT", "container-id": "SEKU4563686", "truck-visit-appointment-number": "262706", "is-notes-read": false, "ufv-gkey": 5617553089, "gate-appointment-gkey": 5856720785, "created": "2022-01-06T19:20:02.000-08:00", "event-date": "2022-01-06T19:20:02.000-08:00", "creator": "api.profittools@pfch" } ] }, ], }, "status": "OK", "type": "CargoSearch", "date": "2022-01-11T06:07:28.146-08:00", "node": "PRDAPI001", "environment": "PRD" } .. note:: Grounded event is created if **discharged** has a date like the one in the previous response. :Grounded Event Data Mapping: +------------------------+--------------------------+--------------------------------+ | Property | Source Property | Description | +========================+==========================+================================+ | event[n].code | Default | Value is defaulted to grounded | +------------------------+--------------------------+--------------------------------+ | event[n].date | Default | Today date is a default date | +------------------------+--------------------------+--------------------------------+ | event[n].location.name | Default | LBCT | +------------------------+--------------------------+--------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +------------------------+--------------------------+--------------------------------+ | event[n].data.grounded | containers[n].discharged | Date of the grounded event. | +------------------------+--------------------------+--------------------------------+ Released Event Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json { "id": 400854854483170, "service": "com.lbct.plugins.webservices.LBCTCargoSearchWebService", "payload": { "search-results": { "requested": 20, "found-containers": 1, "found-orders": 0, "not-found": 0, "not-found-numbers": [] }, "orders": [], "containers": [ { "id": "CCLU7495259", "gkey": 5717793080, "ufv-gkey": 5717793082, "is-in-yard": true, "category": "IMPRT", "freight-kind": "Full", "visit-state": "Active", "transit-state": "Yard", "time-in": "2022-01-11T00:18:08.320-08:00", "equipment-height": 96, "equipment-type": "40HQ", "equipment-size": 40, "line-operator": "OOL", "bill-of-lading-number": "2128250360", "gross-weight": 17673.0, "watch": "false", "discharged": "01/11/2022 00:18 (Actual)", "inbound-voyage-number": "050", "vessel-name": "COSCO ITALY", "is-available-for-pickup": true, "availability-status": "YES", "good-thru-day": "2022-01-14T00:16:45.303-08:00", "demurrage-owed": 0, "terminal-demurrage-owed": 0, "location": "GROUNDED", "impediments": [ { "name": "TMF_CONTAINER_HOLD", "type": "HOLD", "hold-description": "PierPass TMF Container Hold", "entity": "UNIT", "apply-date": "2021-12-29T12:13:19.053-08:00", "applied-by": "groovy.job", "note": "Applied on Unit Activate", "status": "RELEASED" }, { "name": "CUSTOMS_DEFAULT_HOLD", "type": "HOLD", "hold-description": "Customs BL Genereal Release", "entity": "BL", "apply-date": "2021-12-11T03:02:56.929-08:00", "applied-by": "-edi-", "note": "BL 2128250360 is on HOLD with manifested qty = null", "reference-id": "2128250360", "status": "RELEASED" }, { "name": "FREIGHT_BL_HOLD", "type": "HOLD", "hold-description": "Hold Placed on the BL by the Lines", "entity": "BL", "apply-date": "2021-12-11T03:02:56.903-08:00", "applied-by": "-edi-", "status": "RELEASED" } ], "notifications": [] }, ], }, "status": "OK", "type": "CargoSearch", "date": "2022-01-11T06:07:28.146-08:00", "node": "PRDAPI001", "environment": "PRD" } .. note:: Released event is created if **is-available-for-pickup** is set to true and **good-thru-day** has a date which represents lfd like the one in the previous response. :Lfd Event Data Mapping: +------------------------+-----------------------------+-----------------------------------+ | Property | Source Property | Description | +========================+=============================+===================================+ | event[n].code | Default | Value is defaulted to lfd | +------------------------+-----------------------------+-----------------------------------+ | event[n].date | Default | Today date is a default date | +------------------------+-----------------------------+-----------------------------------+ | event[n].location.name | Default | LBCT | +------------------------+-----------------------------+-----------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +------------------------+-----------------------------+-----------------------------------+ | event[n].data.lfd | containers[n].good-thru-day | Last free date for container | +------------------------+-----------------------------+-----------------------------------+ :Released Event Data Mapping: +------------------------+-----------------------------+-----------------------------------+ | Property | Source Property | Description | +========================+=============================+===================================+ | event[n].code | Default | Value is defaulted to released | +------------------------+-----------------------------+-----------------------------------+ | event[n].date | Default | Today date is a default date | +------------------------+-----------------------------+-----------------------------------+ | event[n].location.name | Default | LBCT | +------------------------+-----------------------------+-----------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +------------------------+-----------------------------+-----------------------------------+ | event[n].data.released | Default | Date is defaulted to empty string | +------------------------+-----------------------------+-----------------------------------+ Outgated Event Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json { "id": 400854854483170, "service": "com.lbct.plugins.webservices.LBCTCargoSearchWebService", "payload": { "search-results": { "requested": 20, "found-containers": 1, "found-orders": 0, "not-found": 0, "not-found-numbers": [] }, "orders": [], "containers": [ { "id": "SEKU4563686", "gkey": 5617553087, "ufv-gkey": 5617553089, "is-in-yard": false, "category": "IMPRT", "freight-kind": "Full", "visit-state": "Departed", "transit-state": "Departed", "time-in": "2022-01-06T08:43:55.051-08:00", "time-out": "2022-01-06T20:34:40.800-08:00", "equipment-height": 96, "equipment-type": "40HQ", "equipment-size": 40, "line-operator": "OOL", "bill-of-lading-number": "2685264910", "gross-weight": 12700.0, "watch": "false", "discharged": "01/06/2022 08:43 (Actual)", "inbound-voyage-number": "049", "vessel-name": "CSCL BOHAI SEA", "is-available-for-pickup": false, "availability-status": "NO (CONTAINER DEPARTED)", "location": "DEPARTED", "notifications": [ { "gkey": 1118234639, "status": "UNREAD", "description": "Received Truck Pre-Arrival Data from TMS", "scac": "PFCH", "id": "AppointmentTMSTruckPreArrivalNotification", "actions": [], "type": "APPOINTMENT", "container-id": "SEKU4563686", "truck-visit-appointment-number": "262706", "is-notes-read": false, "ufv-gkey": 5617553089, "gate-appointment-gkey": 5856720785, "created": "2022-01-06T19:20:02.000-08:00", "event-date": "2022-01-06T19:20:02.000-08:00", "creator": "api.profittools@pfch" } ] }, ], }, "status": "OK", "type": "CargoSearch", "date": "2022-01-11T06:07:28.146-08:00", "node": "PRDAPI001", "environment": "PRD" } .. note:: Outgated event is created if **time-out** has a date like the one in the previous response. :Outgated Event Data Mapping: +----------------------------------+------------------------+--------------------------------+ | Property | Source Property | Description | +==================================+========================+================================+ | event[n].code | Default | Value is defaulted to outgated | +----------------------------------+------------------------+--------------------------------+ | event[n].date | Default | Today date is a default date | +----------------------------------+------------------------+--------------------------------+ | event[n].location.name | Default | LBCT | +----------------------------------+------------------------+--------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +----------------------------------+------------------------+--------------------------------+ | event[n].data.outgated | containers[n].time-out | Date of the outgated event. | +----------------------------------+------------------------+--------------------------------+ || event[n].data.outgate_confirmed || Default || Value is set to True as it is | || || || and indicator for event as | || || || outgated or not | +----------------------------------+------------------------+--------------------------------+ Hold Event Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json { "id":264730634515680, "service":"com.lbct.plugins.webservices.LBCTCargoSearchWebService", "payload":{ "search-results":{ "requested":2, "found-containers":2, "found-orders":0, "not-found":0, "not-found-numbers":[ ] }, "orders":[ ], "containers":[ { "id":"CSNU7799244", "gkey":5688431087, "ufv-gkey":5688431091, "is-in-yard":true, "category":"IMPRT", "freight-kind":"Full", "visit-state":"Active", "transit-state":"Yard", "yard-block":"A08", "time-in":"2022-09-13T16:58:31.332-07:00", "equipment-height":96, "equipment-type":"40HQ", "equipment-size":40, "line-operator":"OOL", "impediment-road":"TMF_CONTAINER_HOLD,CTF_CONTAINER_HOLD,!IMPORT_UNIT_NO_BL", "gross-weight":12647, "watch":"false", "discharged":"09/13/2022 16:58 (Actual)", "inbound-voyage-number":"114", "vessel-name":"OOCL SOUTHAMPTON", "is-available-for-pickup":false, "availability-status":"NO (HOLD | FEES OWED)", "good-thru-day":"2022-09-17T16:57:21.540-07:00", "demurrage-owed":25630, "terminal-demurrage-owed":13925, "location":"GROUNDED", "impediments":[ { "name":"IMPORT_UNIT_NO_BL", "type":"PERMISSION", "hold-description":"Used to prevent FCL import units with no BL from leaving the terminal", "entity":"UNIT", "note":"Represents a missing permission", "status":"REQUIRED" }, { "name":"CTF_CONTAINER_HOLD", "type":"HOLD", "hold-description":"Pierpass Clean Truck Hold", "entity":"UNIT", "apply-date":"2022-09-07T09:48:17.429-07:00", "applied-by":"pat.wallace", "note":"Apply on Unit Activate ", "status":"ACTIVE" }, { "name":"TMF_CONTAINER_HOLD", "type":"HOLD", "hold-description":"PierPass TMF Container Hold", "entity":"UNIT", "apply-date":"2022-09-07T09:48:17.386-07:00", "applied-by":"pat.wallace", "note":"Applied on Unit Activate", "status":"ACTIVE" } ], "notifications":[ ], "container-fees":{ "total":39555, "fees":[ { "code":"Line Demurrage", "amount":25630, "expires-on":"09/17/2022" }, { "code":"Extended Dwell Time Fee", "amount":13925, "expires-on":"09/18/2022" } ] } } ] }, "status":"OK", "type":"CargoSearch", "date":"2022-12-22T16:07:43.644-08:00", "node":"TSTAPP002", "environment":"PRD" } :Hold Event Data Mapping: +--------------------------+---------------------------------+---------------------------------------------------------------+ | Property | Source Property | Description | +==========================+=================================+===============================================================+ | event[n].code | Default | Hold is the default value for the event | +--------------------------+---------------------------------+---------------------------------------------------------------+ | event[n].date | Default | Today date is the default date value | +--------------------------+---------------------------------+---------------------------------------------------------------+ | event[n].location.name | Default | LBCT | +--------------------------+---------------------------------+---------------------------------------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +--------------------------+---------------------------------+---------------------------------------------------------------+ || event[n].data.hold_type || containers[n].impediments.name || Indicate which hold event is created if condition is matched | || || || And impediments.status is set to Active | || || || Hold: Condition | || || || tmf: if name is TMF_CONTAINER_HOLD | || || || customs: if name is CUSTOMS_DEFAULT_HOLD | || || || freight: if name is FREIGHT_BL_HOLD | || || || steamship: if name is STEAMSHIP_HOLD | || || || ctf: if name is CTF_CONTAINER_HOLD | || || || obl: if name is IMPORT_UNIT_NO_BL | || || containers[n].container-fees || If any of amounts in the fees has value greater than zero | || || || Then demurrage hold event is created | +--------------------------+---------------------------------+---------------------------------------------------------------+ | event[n].data.code | Default | Code is defaulted to Hold | +--------------------------+---------------------------------+---------------------------------------------------------------+ .. note:: Demurrage hold event is created with fees if there is a positive value for the fees like the one in the previous response. Event returned should have .. code-block:: json { "data": { "code": "HOLD", "holdType": "demurrage", "fees":[ { "type": "Line Demurrage", "amount": 25630, "expiresOn": "2022-09-17" }, { "type": "Extended Dwell Time Fee", "amount": 13925, "expiresOn": "2022-09-18" } ] }, "location": { "name": "LBCT", "siteId": "", "type": "terminal" }, "eventDate": "2023-02-03T00:45:22" } ETA Request ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Getting Eta for all the vessels using the following request by adding the API_KEY for the customer in the request url as following. .. code-block:: shell GET http://api.lbct.com//API/LBCTGetActiveVesselVisitsWebService .. note:: Response is used to retrieve the vessel schedule of all vessels, So to get the ETA for specific container we have to use **inbound-voyage-number** from previous request, Then search using that number in the next response to get ETA for that container. ETA Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: json { "id": 44298056665725, "service": "LBCTGetActiveVesselVisitsWebService", "payload": [ { "facility-id": "E", "inbound-voyage-number": "024", "outbound-voyage-number": "024", "outbound-call-number": 1, "vessel-visit-id": "CDEN024", "service": "LOOP6", "operator-id": "COS", "dry-cutoff": "2022-02-18T16:00:00.000-08:00", "haz-cutoff": "2022-02-17T12:00:00.000-08:00", "reefer-cutoff": "2022-02-18T16:00:00.000-08:00", "begin-receive": "2022-02-14T07:00:00.000-08:00", "vessel-id": "CDEN", "vessel-name": "COSCO SHIPPING DENALI", "lloyds-id": "9757876", "flex-string-01": "YES", "flex-string-04": "NO", "oog-breakbulk-cutoff": "2022-02-17T12:00:00.000-08:00", "vessel-class": "CKIL", "eta": "2022-01-29T14:59:01.413-08:00", "ata": "2022-02-19T18:00:01.413-08:00", "etd": "2022-02-23T18:00:00.000-08:00", "atd": "2022-02-23T18:00:00.000-08:00" }, { "facility-id": "E", "inbound-voyage-number": "048", "outbound-voyage-number": "048", "outbound-call-number": 1, "vessel-visit-id": "CNET048", "service": "LOOP6", "operator-id": "OOL", "dry-cutoff": "2022-02-11T16:00:00.000-08:00", "haz-cutoff": "2022-02-10T12:00:00.000-08:00", "reefer-cutoff": "2022-02-11T16:00:00.000-08:00", "begin-receive": "2022-02-07T07:00:00.000-08:00", "vessel-id": "CNET", "vessel-name": "COSCO NETHERLANDS", "lloyds-id": "9516430", "flex-string-01": "YES", "flex-string-04": "NO", "oog-breakbulk-cutoff": "2022-02-10T12:00:00.000-08:00", "vessel-class": "CENG", "eta": "2022-01-11T13:51:35.100-08:00", "ata": "2022-02-12T18:00:35.100-08:00", "etd": "2022-02-16T18:00:00.000-08:00", "atd": "2022-02-16T18:00:00.000-08:00" }, ], "status": "OK", "type": "vessel-visit-details", "date": "2022-01-11T09:12:26.223-08:00", "node": "PRDAPI001", "environment": "PRD" } :ETA Event Data Mapping: .. note:: ETA event is created only if **inbound-voyage-number** has a value matches the same value from query containers response. +------------------------+-----------------+------------------------------+ | Property | Source Property | Description | +========================+=================+==============================+ | event[n].code | Default | Value is defaulted to eta | +------------------------+-----------------+------------------------------+ | event[n].date | Default | Today date is a default date | +------------------------+-----------------+------------------------------+ | event[n].location.name | Default | LBCT | +------------------------+-----------------+------------------------------+ | event[n].location.type | Default | Default value is Terminal. | +------------------------+-----------------+------------------------------+ | event[n].data.eta | payload[n].eta | Date of the eta event. | +------------------------+-----------------+------------------------------+