Dev:PAX Portal API: Difference between revisions
Jump to navigation
Jump to search
Stefanseiler (talk | contribs) No edit summary |
Stefanseiler (talk | contribs) |
||
| Line 14: | Line 14: | ||
* <code>/remove-travelgroup</code>- is only possible on groups without any group membership | * <code>/remove-travelgroup</code>- is only possible on groups without any group membership | ||
* <code>/archive-travelgroup</code> - is only possible, if all requests in group are cancelled or archived | * <code>/archive-travelgroup</code> - is only possible, if all requests in group are cancelled or archived | ||
=== Documents handling === | |||
* <code>/upload-document</code> - 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. | |||
* <code>/download-document</code> - will download a document from the local DMA instance. | |||
=== Request management endpoints === | === Request management endpoints === | ||
Revision as of 11:34, 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
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
/createNewRequest- Creates a new request, is done before entering the personal & flight data entry screen/cancelRequest- Cancels a request. If request was submitted, performs a request for cancellation, which has to be confirmed by other side./get-passenger-requestdata- retrieves the data which is already known on this request (for all screens of the flow, not only personal & flight data entry screen)/save-passenger-requestdata- saves the entire request data
Service edit flow
/resolve-flightdetails-from-flightnumber-and-date- retrieves 0 or 1 matching flight details/resolve-flights-fromto-and-date- retrieves all possible flights for a certain date for this departure and arrival port/get-availabletravelserviceinfo-for-passengerrequest- returns all information required for all display options in the service selection screen
--> 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