Crew.Travel API Logs

In Compas, this feature can be found through: Admin | Crew.Travel | Crew.Travel API logs.

When the customer decides to do the integration with a travel services provider via an API, there is an exchange of messages between Compas and the supplier service, whereas each action happening on either side is communicated.

This exchange of messages is not visible in the front end of Crew.Travel, the user is only able to see the outcome of such communication. To be able to see and check in case of any incidence what was sent back and forth under the Crew.Travel section in the admin panel, we have the API Logs, where all the messages are visible and can be traced by the user.

This is not an access visible by the Customer and restricted to Ocean Technologies Group personnel.

The Log

Once the user clicks on the API Logs, the screen opens with following elements:

1. Date range the system will display data
2. Log Type Inbound (Received)/ Outbound (Sent) for the messages
3. Additional Seach functionabilities to find the messages related to a crewid, vessel..it will look through the body of all messages. The search can also be made by RequestID from Crew.Travel
4. LogID is the reference number
5. RequestID as it was created in Crew.Travel
6. SystemID.- this will be the reference given to the supplier´s system
7. LogType.- Inbound/Outbound based messages received or sent
8. Message Code: Success or Fail. If Fail, there will a subsequent code in SenderErrorCode
9. SenderErrorCode: if the message failed to be delivered to the provider, will have an error message code and column 17 (Raw Response) will be empty
10. ResponseMessageCode.- for each message sent, the API should return a response based on action requested. If message is successfully received by Compas, will appear as Success or an Error. Below sequence shows for RequestID 903957, a message received (a quote), quote has been approved and the agent has reverted with a remark in the system.
11. ResponseErrorCode.- same as SenderErrorCode, if the message failed to be received, there will be an error message and column 17 will be empty
12. Log Time, when communication was sent/received
13. RequestStatus.- New, Approved, Cancelled, Issued and None (when a remark has been added)
14. Request Type.- it tallies with service request
15. Action Type.- what has been the action happening in the request
16. Raw Sent.- This will open the xml/txt message sent via the API from Compas to the Travel Supplier System
17. RawResponse.- This will show the message sent back by the supplier system as message received in case of success. If blank is because the message failed to be delivered. See response to message showed aboved with status and action for an approved quote