Shipreporting APIs - List of services

A - LIVE DATA SERVICES:

1. Active trips:

http://<REMOTE_IP>:3000/activeTripsNow?id_portinformer=<id_portinformer>

2. Roadstead now:

http://<REMOTE_IP>:3000/roadsteadNow?id_portinformer=<id_portinformer>&id_activity=2

3. Moored now:

http://<REMOTE_IP>:3000/mooredNow?id_portinformer=<id_portinformer>&id_activity=5

4. Arrivals now:

http://<REMOTE_IP>:3000/arrivalsNow?id_portinformer=<id_portinformer>

5. Departures now:

http://<REMOTE_IP>:3000/departuresNow?id_portinformer=<id_portinformer>

6. Arrival previsions:

http://<REMOTE_IP>:3000/arrivalPrevisionsNow?id_portinformer=<id_portinformer>

7. Shipped goods:

http://<REMOTE_IP>:3000/shippedGoodsNow?id_portinformer=<id_portinformer>

8. RO/RO + RO/PAX:

http://<REMOTE_IP>:3000/trafficListNow?id_portinformer=<id_portinformer>

9. Shifting previsions:

http://<REMOTE_IP>:3000/shiftingPrevisionsNow?id_portinformer=<id_portinformer>

10. Departure previsions:

http://<REMOTE_IP>:3000/departurePrevisionsNow?id_portinformer=<id_portinformer>

B - ARCHIVE DATA SERVICES:

1. Trips archive [global recap, one row per trip]:

http://<REMOTE_IP>:3000/tripsArchive?id_portinformer=<ID_PORTINFORMER>

2. Trips archive [global recap, one row per commercial operation]:

http://<REMOTE_IP>:3000/tripsArchiveMultiRows?id_portinformer=<ID_PORTINFORMER>

3. Trip data archive [shipreport core]:

http://<REMOTE_IP>:3000/shipReportList?id_portinformer=<ID_PORTINFORMER>

4. Trip data archive detailed [shipreport]:

http://<REMOTE_IP>:3000/shipReportDetails?id_portinformer=<ID_PORTINFORMER>

5. Arrivals archive:

http://<REMOTE_IP>:3000/arrivalsArchive?id_portinformer=<id_portinformer>

6. Departures archive:

http://<REMOTE_IP>:3000/departuresArchive?id_portinformer=<id_portinformer>

7. Shipped goods archive:

http://<REMOTE_IP>:3000/shippedGoodsArchive?id_portinformer=<id_portinformer>

8. Traffic list archive:

http://<REMOTE_IP>:3000/trafficListArchive?id_portinformer=<id_portinformer>

C - DAILY REGISTER SERVICES:

1. Arrivals:

http://<REMOTE_IP>:3000/registerArrivals?id_portinformer=<ID_PORTINFORMER>

2. Moored:

http://<REMOTE_IP>:3000/registerMoored?id_portinformer=<ID_PORTINFORMER>

3. Roadstead:

http://<REMOTE_IP>:3000/registerRoadstead?id_portinformer=<ID_PORTINFORMER>

4. Departures:

http://<REMOTE_IP>:3000/registerDepartures?id_portinformer=<ID_PORTINFORMER>

5. Shiftings:

http://<REMOTE_IP>:3000/registerShiftings?id_portinformer=<ID_PORTINFORMER>

6. Arrival previsions:

http://<REMOTE_IP>:3000/registerPlannedArrivals?id_portinformer=<ID_PORTINFORMER>

7. Shipped goods:

http://<REMOTE_IP>:3000/registerShippedGoods?id_portinformer=<ID_PORTINFORMER>

8. RO/RO + RO/PAX:

http://<REMOTE_IP>:3000/registerTrafficList?id_portinformer=<ID_PORTINFORMER>

D - BUSINESS INTELLIGENCE SERVICES:

1. Shiftings/maneuverings [per quay/berth]:

http://<REMOTE_IP>:3000/tripsManeuverings?id_portinformer=<ID_PORTINFORMER>

2. Shipped goods recap:

http://<REMOTE_IP>:3000/shippedGoodsRecap?id_portinformer=<ID_PORTINFORMER>

3. RO/RO + RO/PAX recap:

http://<REMOTE_IP>:3000/trafficListRecap?id_portinformer=<ID_PORTINFORMER>

E - METEO DATA

1. Meteo data archive:

http://<REMOTE_IP>:3000/meteoArchive?id_portinformer=<ID_PORTINFORMER>

Deploy, start & stop server:

$ cat /lib/systemd/system/shipreporting.service 
[Unit]
Description=Shipreporting service middleware
Documentation=https://github.com/deeper-x/shipreporting-api
After=network.target

[Service]
Environment=NODE_PORT=3000
Type=simple
User=<YOUR_USER>
WorkingDirectory=/home/<YOUR_USER>/shipreporting-api
ExecStart=/usr/bin/npm start
Restart=on-failure

[Install]
WantedBy=multi-user.target

Create database and set configuration data:

$ vim settings/db_auth.js 

Then:

$ sudo systemctl start shipreporting.service
$ sudo systemctl stop shipreporting.service

Local deploy [on dev environment]:

$ npm install
[...omissis]
$ npm start

> [email protected] start /home/<YOUR_USER>/NodeProjects/shipreporting-api
> ./node_modules/nodemon/bin/nodemon.js index.js

[nodemon] 1.18.9
[nodemon] to restart at any time, enter `rs`
[nodemon] watching: *.*
[nodemon] starting `node index.js`
running on http://0.0.0.0:3000...