Dev:PAX Portal API: Difference between revisions

From Kordeus Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 25: Line 25:
* <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 - 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 - 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]])
* [[Dev:PAX Portal API - get-assistancerequests-of-pax|<code></code>]]<code>[[Dev:PAX Portal API - get-passenger-requestdata|/specialassistancerequest]]/load-by-uid</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  
* [[Dev:PAX Portal API - get-passenger-requestdata|<code></code>]]<code>[[Dev:PAX Portal API - save-passenger-requestdata|/specialassistancerequest]]/save</code> - saves the entire request data  


===== Service edit flow =====
===== Service edit flow =====

Revision as of 09:52, 27 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

  • /specialassistancerequest/get-overview - Provides the passenger-digital-UID and returns the data required for the Passenger Overview Screen
  • /specialassistancerequestgroups/get-travelpartneroverview-fetchgroups - gets the groups (from / limit) for inifinite scroll for the travel-partner-uid and travel-agent-user-uid 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

Documents handling

  • /upload-document - will upload a file to a temporary folder, from which the backend will take the document into the real request location. WIll be cleared every 2 days.
  • /download-document - will download a document from the local DMA instance.

Request management endpoints

General
Service edit flow

See also