Dev:PAX Portal API: Difference between revisions

From Kordeus Wiki
Jump to navigation Jump to search
Stefanseiler (talk | contribs)
Stefanseiler (talk | contribs)
No edit summary
Line 17: Line 17:
=== Request management endpoints ===
=== Request management endpoints ===


* <code>[[Dev:PAX Portal API - CreateNewRequest|/CreateNewRequest]]</code> - Creates a new request, is done before entering the [[Dev:PPA - Screen personal & flight data entry|personal & flight data entry screen]]
===== General =====
* <code>[[Dev:PAX Portal API - get-passenger-requestdata|/get-passenger-requestdata]]</code> - retrieves the data which is already known on this request (for all screens of the flow, not only [[Dev:PPA - Screen personal & flight data entry|personal & flight data entry screen]])  
* <code>[[Dev:PAX Portal API - CreateNewRequest|/createNewRequest]]</code> - Creates a new request, is done before entering the [[Dev:PPA - Screen personal & flight data entry|personal & flight data entry screen]]
* <code>[[Dev:PAX Portal API - cancelRequest|/cancelRequest]]</code> - Cancels a request. If request was submitted, performs a request for cancellation, which has to be confirmed by other side.
* <code>[[Dev:PAX Portal API - get-passenger-requestdata|/get-passenger-requestdata]]</code> - retrieves the data which is already known on this request (for all screens of the flow, not only [[Dev:PPA - Screen personal & flight data entry|personal & flight data entry screen]])
* <code>[[Dev:PAX Portal API - save-passenger-requestdata|/save-passenger-requestdata]]</code> - saves the entire request data


--> send-headerpage-data
===== Service edit flow =====
* <code>[[Dev:PAX Portal API - resolve-flightdetails-from-flightnumber-and-date|/resolve-flightdetails-from-flightnumber-and-date]]</code> - retrieves 0 or 1 matching flight details
* <code>[[Dev:PAX Portal API - resolve-flights-fromto-and-date|/resolve-flights-fromto-and-date]]</code> - retrieves all possible flights for a certain date for this departure and arrival port
* <code>[[Dev:PAX Portal API - get-availabletravelserviceinfo-for-passengerrequest|/get-availabletravelserviceinfo-for-passengerrequest]]</code> - returns all information required for all display options in the service selection screen


    --> HeaderDetails
    <-- StateOfPersistance


--> get-serviceselectionpage-data
--> get-serviceselectionpage-data
Line 50: Line 53:
    <-- State of Persistance
    <-- State of Persistance


--> cancel-request
-->  


    --> requestID
    --> requestID

Revision as of 11:08, 25 August 2025

User authentication endpoints

  • /paxportal-authorize-travelid-start - this triggers the user authentication a TravelID-account
  • /paxportal-authorize-travelid-callback - the callback endpoint for travelID, which creates after successful authentication a local user access token and stores it as cookie and redirects the user to the Passenger Overview Screen
  • /authorize-travelagent- endpoint invoked by the travel agent login screen, which does the b-op delegated authentication, which after success, stores the cookie and redirects to the Travel Partner Overview Screen

Overview screens endpoints

  • /get-assistancerequests-of-pax - Provides the passenger-digital-UID and returns the data required for the Passenger Overview Screen
  • /get-travelpartneroverview-fetchgroups - gets the groups (from / limit) for inifinite scroll for the travel-partner-uid and travel-agent-userID on the Travel Partner Overview Screen
  • /get-assistancerequests-of-travelgroup - Provides and returns the data required for the list of special assistance requests on the Travel Partner Overview Screen
  • /create-travelgroup
  • /change-travelgroup-name
  • /remove-travelgroup- is only possible on groups without any group membership
  • /archive-travelgroup - is only possible, if all requests in group are cancelled or archived

Request management endpoints

General
Service edit flow


--> get-serviceselectionpage-data

    --> RequestUID

    <-- ServiceSelectionPageDataAndOptions

--> send-serviceselectionpage-data

    --> ServiceSelectionData

    <-- State of Persistance

--> get-finalizationpage-data

    --> RequestUID

    <-- PageDataAndOptions

--> send-finalizationpage-data

    --> ServiceSelectionData

    <-- State of Persistance

-->

    --> requestID

    <-- OK

--> file-request

    --> requestID

    <-- OK

See also