Dev:PAX Portal API: Difference between revisions
Jump to navigation
Jump to search
Stefanseiler (talk | contribs) No edit summary |
No edit summary |
||
| (25 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
* <code>/paxportal-authorize-travelid-start</code> - this triggers the user authentication a TravelID-account | * <code>/paxportal-authorize-travelid-start</code> - this triggers the user authentication a TravelID-account | ||
* <code>/paxportal-authorize-travelid-callback</code> - 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 [[Dev:PPA - Overview Screen|Passenger Overview Screen]] | * <code>/paxportal-authorize-travelid-callback</code> - 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 [[Dev:PPA - Overview Screen|Passenger Overview Screen]] | ||
*<code>/authorize-travelagent</code>- endpoint invoked by the [[Dev:PPA - TravelagentLoginScreen|travel agent login screen]], which does the b-op delegated authentication, which after success, stores the cookie and redirects to the [[Dev:PPA - Travel Partner Overview Screen]] | *<code>/authorize-travelagent</code>- endpoint invoked by the [[Dev:PPA - TravelagentLoginScreen|travel agent login screen]], which does the b-op delegated authentication, which after success, stores the cookie and redirects to the [[Dev:PPA - Travel Partner Overview Screen|Travel Partner Overview Screen]] | ||
=== | === Special Assistance Request endpoints === | ||
* <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]] | |||
* <code>/specialassistancerequest/groups/load-all</code> - 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>[[Dev:PAX Portal API - CreateNewRequest|/]][[Dev:PAX Portal API - get-passenger-requestdata|specialassistancerequest]]/create</code> - Creates a new request, is done before entering the [[Dev:PPA - Screen personal & flight data entry|personal & flight data entry screen]] | |||
* <code>/specialassistancerequest/cancel</code>- Cancels a request. If request was submitted, performs a request for cancellation, which has to be confirmed by other side. | |||
* [[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]]) | |||
* [[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 | |||
=== Special Assistance Request Group endpoints === | |||
* <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/create-travelgroup</code> | |||
* <code>/specialassistancerequestgroups/change-travelgroup-name</code> | |||
* <code>/specialassistancerequestgroups/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 | |||
=== 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 === | |||
===== 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 - load-availabletravelserviceinfo-for-passengerrequest|/load-availabletravelserviceinfo-for-passengerrequest]]</code> - returns all information required for all display options in the [[Dev:PPA - Required Services Screen|service selection screen]] | |||
== See also == | == See also == | ||
* [[Dev:PAX.Portal Application Development]] | * [[Dev:PAX.Portal Application Development]] | ||
Latest revision as of 08:33, 5 September 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
Special Assistance Request 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/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
Special Assistance Request Group endpoints
/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
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/load-availabletravelserviceinfo-for-passengerrequest- returns all information required for all display options in the service selection screen