Dev:PAX Portal API: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 7: | Line 7: | ||
=== Overview screens endpoints === | === Overview screens endpoints === | ||
* <code>[[Dev:PAX Portal API - get-assistancerequests-of-pax|/specialassistancerequest/]]<nowiki/>load-all</code> - Provides the passenger-digital-UID and returns the data required for the [[Dev:PPA - Overview Screen|Passenger Overview Screen]] | * <code>[[Dev:PAX Portal API - get-assistancerequests-of-pax|/specialassistancerequest/]]<nowiki/>passengers/load-all</code> - Provides the passenger-digital-UID and returns the data required for the [[Dev:PPA - Overview Screen|Passenger Overview Screen]] | ||
* /specialassistancerequest<code><nowiki/></code>/groups/load-all - Provides group-UID and returns the data required for the list of special assistance requests on the [[Dev:PPA - Travel Partner Overview Screen|Travel Partner Overview Screen]] | |||
* <code>/specialassistancerequestgroups/load-all</code> - gets the groups (from / limit) for inifinite scroll for the travel-partner-uid and travel-agent-user-uid on the [[Dev:PPA - Travel Partner Overview Screen|Travel Partner Overview Screen]] | * <code>/specialassistancerequestgroups/load-all</code> - gets the groups (from / limit) for inifinite scroll for the travel-partner-uid and travel-agent-user-uid on the [[Dev:PPA - Travel Partner Overview Screen|Travel Partner Overview Screen]] | ||
* <code>/ | * <code>/specialassistancerequestgroups/create-travelgroup</code> | ||
* <code>/specialassistancerequestgroups/change-travelgroup-name</code> | |||
* <code>/change-travelgroup-name</code> | * <code>/specialassistancerequestgroups/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>/specialassistancerequestgroups/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 === | === Documents handling === | ||
Revision as of 14:01, 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/passengers/load-all- Provides the passenger-digital-UID and returns the data required for the Passenger Overview Screen- /specialassistancerequest
/groups/load-all - Provides group-UID and returns the data required for the list of special assistance requests on the Travel Partner Overview Screen /specialassistancerequestgroups/load-all- gets the groups (from / limit) for inifinite scroll for the travel-partner-uid and travel-agent-user-uid on the Travel Partner Overview Screen/specialassistancerequestgroups/create-travelgroup/specialassistancerequestgroups/change-travelgroup-name/specialassistancerequestgroups/remove-travelgroup- is only possible on groups without any group membership/specialassistancerequestgroups/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
/specialassistancerequest/create- Creates a new request, is done before entering the personal & flight data entry screen/specialassistancerequest/cancel- Cancels a request. If request was submitted, performs a request for cancellation, which has to be confirmed by other side./specialassistancerequest/load-by-uid- retrieves the data which is already known on this request (for all screens of the flow, not only personal & flight data entry screen)/specialassistancerequest/save- 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