Dev:PAX Portal API: Difference between revisions
Jump to navigation
Jump to search
Stefanseiler (talk | contribs) No edit summary |
Stefanseiler (talk | contribs) |
||
| Line 5: | Line 5: | ||
*<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]] | *<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]] | ||
=== | === Overview screens endpoints === | ||
* <code>[[Dev:PAX Portal API - get-assistancerequests-of-pax|/get-assistancerequests-of-pax]]</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|/get-assistancerequests-of-pax]]</code> - Provides the passenger-digital-UID and returns the data required for the [[Dev:PPA - Overview Screen|Passenger Overview Screen]] | ||
* <code>/get- | * <code>/get-travelpartneroverview-fetchgroups</code> - gets the groups (from / limit) for inifinite scroll for the travel-partner-uid and travel-agent-userID on the [[Dev:PPA - Travel Partner Overview Screen|Travel Partner Overview Screen]] | ||
* <code>/ | * <code>/get-assistancerequests-of-travelgroup</code> - Provides 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>/create-travelgroup</code> | |||
* <code>/change-travelgroup-name</code> | |||
* <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 | |||
=== Request management endpoints === | |||
* <code>[[Dev:PAX Portal API - CreateNewRequest|/CreateNewRequest]]</code> - Creates a new request, is done when entering | |||
--> PAXUID (if knwon) | --> PAXUID (if knwon) | ||
Revision as of 10:32, 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
/CreateNewRequest- Creates a new request, is done when entering
--> PAXUID (if knwon)
--> TravelpartnerUID (if knwon)
--> TravelagentUID (if knwon)
--> TargetGroupUID (if knwon)
<-- RequestUID
--> get-headerpage-data
--> RequestUID
<-- Headerdetails
--> send-headerpage-data
--> HeaderDetails
<-- StateOfPersistance
--> get-serviceselectionpage-data
--> RequestUID
<-- ServiceSelectionPageDataAndOptions
--> send-serviceselectionpage-data
--> ServiceSelectionData
<-- State of Persistance
--> get-finalizationpage-data
--> RequestUID
<-- PageDataAndOptions
--> send-finalizationpage-data
--> ServiceSelectionData
<-- State of Persistance
--> cancel-request
--> requestID
<-- OK
--> file-request
--> requestID
<-- OK