Overview
With the add-on FCFS Shipper API Service, you can book Direct FCFS capacity at different network points. You can test this functionality on the Swagger platform. For those purposes, the KON environment will be made available to you.
Overall, the booking process consists in the following steps:
I. Network Point Identification (Optional): you should first request the ID number of the network point at which you wish to book direct FCFS capacity;
II. Availability Check: once you have the ID of the network point at which you'd like to book Direct FCFS capacity, you can proceed to query for available products. You will then receive a list of possible product types;
III. Offer Request: after you determine the product type you'd like to book, you must submit an offer request. In turn, PRISMA will send you the offer details with the price of the capacity - keep in mind that, in Direct FCFS, the displayed price is always the total price;
IV. Booking Request: with the offer details in hand, you can decide whether or not you want to proceed to the booking stage. After you've made your decision, you can finally submit your booking request. You will then receive a booking confirmation from PRISMA.
V. Successful Booking Retrieval: once the booking is concluded, you may retrieve a list of successful bookings from PRISMA.
The diagram below illustrates this process.
Instructions
To book Direct FCFS through the Shipper API, you must first retrieve the Bearer token to be used for authentication of API calls (either from Swagger documentation, your system or other tools).
To do so, do as follows:
1. After subscribing to the Shipper API service with the FCFS add-on, log into your admin account;
2. Click on the gear icon at the top right corner of the page;
3. Then, on the drop-down menu, click on "Premium Services;"
4. Scroll down and copy the API bearer token to the clipboard by clicking on "Copy to Clickboard."
5. Then, go to the Swagger page and click on "Authorize;"
6. Now, use the copied token to authorize your access;
Once you've authorized the API use, you can begin the Regular FCFS booking process.
I. Network Point Identification (Optional)
If you don't know the network point at which you'd like to book regular FCFS capacity, you can use the Shipper API to retrieve it. The most accurate way of doing so is to query for the specific Network Point Type.
On Swagger, do as follows:
1. After authorizing your use of Swagger, expand the "Get/Network Point" bar and click on "Try It Out;"
2. Then, click on the "connectionPointType" drop-down menu and select the relevant network point;
3. Now, choose the direction of the network point;
4. Finally, click on "Execute."
You will then be able to see the results in the "Response Body:"
You can use the "ID" to submit your regular FCFS booking.
II. Availability Check
With the network point ID, you can check which products are available at that network point.
To do so, do the following:
1. Expand the "Get/fcfs-booking/direct/available-products" tab and click on "Try It Out;"
2. Enter the shipper user email in the appropriate field;
3. Enter the network point ID in the appropriate field;
4. Last, click on "Execute."
The available products will then be displayed in the response field:
Note the relevant details of the offer you'd like to request and go on to the next step.
III. Offer Request
Once you retrieve the details of the available product at a particular network point, you can proceed to request an offer. It's possible for you to see the mandatory fields (marked by asterisks) by clicking on "Model" in the "Post/fcfs-booking/direct/request-offer" tab:
To request an offer, do as follows:
1. Expand the "Post/fcfs-booking/direct/request-offer" tab and click on "Try It Out;"
2. Edit the json file with the necessary details;
3. Then, click on "Execute."
The response message will then be displayed in the response field below:
This message includes all the necessary details for the submission of a direct FCFS booking. Note that TTPC/Transmed offers do not include a total price. In such bookings, the total price will be determined later based on the assessment of the regulators.
IV. Booking Request
Once you have the necessary details of the offer, you can submit your direct FCFS booking. The mandatory fields of this json message (marked by an asterisk) can be viewed in the "Post/fcfs-booking/direct/booking" tab after you click on "Model:"
If, however, the price was not provided in the offer request (step III), you can delete those lines from the json file. Likewise, if the product is unbundled, you can delete the PeerTotalPrice lines. In contrast, if the price is provided in the offer, then you must include it in the booking request.
Now, to submit a booking request, do as follows:
1. After authorizing your use of Swagger, expand the "Post/fcfs-booking/direct/booking" tab and click on "Try It Out;"
2. Then, edit the json file with the mandatory details of your booking request;
3. Finally, click on "Execute."
The resulting message will be displayed in the "Response" field. It contains all the details of your booking request including the Request Identifier, which you can use to check the status of your Direct FCFS Booking:
V. Successful Booking Retrieval
After you successfully submit your Direct FCFS booking, the TSO will process your request. You can use the details of your booking to check its status.
To do so, do as follows:
1. Expand the "Get/fcfs-booking/direct/bookings" tab and click on "Try It Out;"
2. Enter the email with which you booked Direct FCFS capacity (this field is mandatory);
3. Then, enter one or more of the booking details in the fields below. If you're looking for a specific booking, the Request Identifier is the most straightforward method to retrieve it. If you're looking for bookings at a specific network point, then use the Network Point ID, and so forth;
4. Finally, Click on "Execute."
The resulting message can be viewed in the "Response" field. The status of your booking will be displayed in the "Status" line:
