Skip to main content

Exposed Workflow Extension Points (deprecated)

Note
Please be aware that Nudge API is available only for Private Red Apps and is not deprecated.

The table below summarizes exposed workflow extension points briefly.

Flow Id Extension Point Id Data Model Contributions

dynamo.air.lowfareshopping

beforeShoppingRequest

RedAppAirShoppingRq

FrontEnd/BackEnd

dynamo.air.lowfareshopping

afterShoppingResponse

RedAppAirShoppingRs

FrontEnd/BackEnd

dynamo.pnr.end

beforeEndCommand

RedAppEndTransactionRq (optional), RedAppTravelItineraryReadRs (optional)

FrontEnd/BackEnd

dynamo.pnr.end

afterEndCommand

RedAppEndTransactionRq (optional), RedAppEndTransactionRs (optional)

FrontEnd/BackEnd

dynamo.pnr.ignore

beforeIgnoreCommand

-

FrontEnd/BackEnd

dynamo.pnr.ignore

afterIgnoreCommand

-

FrontEnd/BackEnd

dynamo.air.airbooking

beforePricingRequest

RedAppAirShoppingRq

FrontEnd/BackEnd

dynamo.air.airbooking

afterPricingRequest

-

FrontEnd/BackEnd

dynamo.air.pricing

beforePricingRequest

RedAppAirPriceRQ (optional)

FrontEnd/BackEnd

dynamo.air.pricing

afterPricingRequest

-

FrontEnd/BackEnd

dynamo.pricing.advanced

beforePricingRequest

RedAppAirPriceRQ

FrontEnd/BackEnd

dynamo.pricing.advanced

afterPricingRequest

-

FrontEnd/BackEnd

dynamo.nudge

nudgeInitCommand

RedAppNudgeInitRQ, RedAppNudgeInitRS

BackEnd

dynamo.nudge

nudgeActionCommand

RedAppNudgeActionRQ, RedAppNudgeActionRS

BackEnd

com.sabre.edge.dynamo.link_payment_flow

afterPaymentValidation

RedAppFopPqLink, RedAppCreditCardVerificationResult, RedAppTravelItineraryReadRs

BackEnd

dynamo.exchange.confirmation

afterExchangeConfirmation

CommandMessageExchangeRs

FrontEnd/BackEnd

dynamo.air.lowfareshopping
Figure 1. dynamo.air.lowfareshopping flow
dynamo.pnr.end
Figure 2. dynamo.pnr.end flow
dynamo.pnr.ignore
Figure 3. dynamo.pnr.ignore flow
dynamo.air.airbooking
Figure 4. dynamo.air.airbooking flow
dynamo.air.airpricing flow
Figure 5. dynamo.air.airpricing flow
dynamo.pricing.advanced
Figure 6. dynamo.pricing.advanced flow
dynamo.nudge
Figure 7. dynamo.nudge flow
com.sabre.edge.dynamo.link_payment_flow
Figure 8. com.sabre.edge.dynamo.link_payment_flow flow

Extension dynamo.air.lowfareshopping:beforeShoppingRequest

Execution time

It will be executed after filling and submitting the LowFareShopping search form, but before sending request to the Shopping service.

Data model

com.sabre.stl.pos.srw.nextgen.redapp.airshopping.rq.v1.RedAppAirShoppingRq carrying the shopping request information like:

  • Origin airport code

  • Destination airport code

  • Departure data and time

  • Arrival data and time

  • Segment number

  • Preferred and excluded cities

  • Travelers code, quantity and age

  • Excluded carriers codes

  • Preferred carries codes

  • Cabins codes

  • Corporate IDs

  • Account codes

  • Retailer rules codes

  • Commissions codes

  • Validating Carrier

  • Tour Codes

  • Endorsements

  • Discounts (Amount/Percent)

  • Commissions (Amount/Percent)

  • Form of Payment (Cash/Check/Card)

  • Special Penalty Info

  • Air Itinerary Pricing Information (Base Fare/Taxes)

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.air.lowfareshopping:afterShoppingResponse

Execution time

It will be executed after receiving response from the Shopping service.

Data model

com.sabre.stl.pos.srw.nextgen.redapp.airshopping.rs.v1.RedAppAirShoppingRs carrying the shopping response information like:

  • list of itineraries

    • air itinerary

      • list of origin destination options

        • flight segment

        • elapsed time

    • air itinerary pricing info

      • itinerary total fare

        • total fare

      • list of ptc fare breakdowns

        • passenger type quantity

        • fare basis codes

        • passenger fare

        • endorsements

      • list of fare infos

        • fare reference

        • tpa extensions

        • validating carrier

      • pricing source

      • pricing sub source

    • tpa extensions

    • sequence number

*number of itineraries

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.pnr.end:beforeEndCommand

Execution time

It will be executed when the user typed end command or finished PNR from the panel, but before the command will be sent to Sabre Host.

Data model

  • com.sabre.stl.pos.srw.nextgen.redapp.pnr.end.rq.v1.RedAppEndTransactionRq - available only for graphical flow

  • com.sabre.stl.pos.srw.nextgen.redapp.travelitineraryread.rs.v1.RedAppTravelItineraryReadRs - available only for graphical flow

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.pnr.end:afterEndCommand

Execution time

It will be executed when the user typed end command or finished PNR from the panel and after the command has been sent to Sabre Host.

Data model

  • com.sabre.stl.pos.srw.nextgen.redapp.pnr.end.rq.v1.RedAppEndTransactionRq - available only for graphical flow

  • com.sabre.stl.pos.srw.nextgen.redapp.pnr.end.rs.v1.RedAppEndTransactionRs - available only for graphical flow

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.pnr.ignore:beforeIgnoreCommand

Execution time

It will be executed after the user typed ignore command or when ignored PNR from the panel, but before the command is sent to Sabre Host.

Data model

There is no data model available for this extension point.

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.pnr.ignore:afterIgnoreCommand

Execution time

It will be executed after the user typed ignore command or when ignored PNR from the panel, but after the command is sent to Sabre Host.

Data model

There is no data model available for this extension point.

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.air.airbooking:beforePricingRequest

Execution time

It will be executed after user clicked Save & Sell Price button in Advanced Pricing, before sending request.

Data model

com.sabre.stl.pos.srw.nextgen.redapp.airshopping.rq.v1.RedAppAirShoppingRq carrying the shopping request information like:

  • Origin airport code

  • Destination airport code

  • Departure data and time

  • Arrival data and time

  • Segment number

  • Segment RPH

  • Brand ID

  • Booking class

  • Preferred and excluded cities

  • Travelers code, quantity and age

  • Excluded carriers codes

  • Preferred carries codes

  • Cabins codes

  • Corporate IDs

  • Account codes

  • Retailer rules codes

  • Commissions codes

  • Validating Carrier

  • Tour Codes

  • Endorsements

  • Discounts (Amount/Percent)

  • Commissions (Amount/Percent)

  • Form of Payment (Cash/Check/Card)

  • Special Penalty Info

  • Air Itinerary Pricing Information (Base Fare/Taxes)

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.air.airbooking:afterPricingRequest

Execution time

It will be executed after user clicked Save & Sell Price button in Advanced Pricing, after request was sent.

Data model

There is no data model available for this extension point.

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.air.pricing:beforePricingRequest

Execution time

It will be executed after user typed WP* command.

Data model

com.sabre.stl.pos.srw.nextgen.redapp.airprice.rq.v1.RedAppAirPriceRQ which can be added by redapp to add to the pricing request information like:

- PriceRequestInformation
  |- OptionalQualifiers
  |  |- MiscQualifiers
  |  |  |- Commission
  |  |  |  |- amount
  |  |  |  \- percent
  |  |  |- Endorsements
  |  |  |  |- overrride
  |  |  |  \- text
  |  |  \- TourCode
  |  |     |- ShowFareITandTC
  |  |     |  \- ind
  |  |     |- SuppressFareReplaceWithBT
  |  |     |  \- ind
  |  |     |- SuppressFareReplaceWithIT
  |  |     |  \- ind
  |  |     |- SuppressIT
  |  |     |  \- ind
  |  |     |- SuppressITSupressFare
  |  |     |  \- ind
  |  |     \- text
  |  \- PricingQualifiers
  |     |- AlternativePricingQualifiers
  |     |  |- al
  |     |  \- xm
  |     |- FareOptions
  |     |  |- _private
  |     |  \- _public
  |     |- Overrides
  |     |- GoverningCarrierOverride
  |     |  \- airlineCode
  |     |- ItineraryOptions
  |     |  |- SegmentSelect
  |     |     |- number
  |     |     \- rph
  |     |- RetailerRuleQualifier
  |     |  |- force
  |     |  \- qualifier
  |     |- SpecificPenalty
  |     |  |- amount
  |     |  \- currency
  |     |- Brand
  |     |  |- value
  |     |  \- rph
  |     |- CommandPricing
  |     |  |- Discount
  |     |     |-Amount
  |     |     \-Percent
  |     |- commissionContract
  |     |- accountCode
  |     |- buyingDate
  |     |- corporateId
  |     |- currencyCode
  |     |- advancePurchase
  |     |- noMinMaxStay
  |     |- noPenalty
  |     |- roundTheWorldTrip
  |     |- exemptAllTaxes
  |     |- exemptSpecificTax
  |     |- validatingCarrierCode
  |     |- spanishResidentDiscount
  |     |- spanishLargeFamilyDiscount
  |     \- cabin
  \- retain

Mapping TourCode type

TourCode type ShowFareITandTC SuppressFareReplaceWithBT SuppressFareReplaceWithIT SuppressIT SuppressITSupressFare

U

X

UB

X

UI

X

UN

X

UX

X

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.air.pricing:afterPricingRequest

Execution time

It will be executed after user typed WP* command.

Data model

There is no data model available for this extension point.

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.pricing.advanced:beforePricingRequest

Execution time

It will be executed after user clicked Save & Sell Price button in Advanced Pricing, before sending request.

Data model

com.sabre.stl.pos.srw.nextgen.redapp.airprice.rq.v1.RedAppAirPriceRQ described in dynamo.air.pricing:beforePricingRequest extension point

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.pricing.advanced:afterPricingRequest

Execution time

It will be executed after user clicked Save & Sell Price button in Advanced Pricing, after request was sent.

Data model

There is no data model available for this extension point.

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.

Extension dynamo.nudge:nudgeInitCommand

Execution time

It will be executed when search results will be returned for:

  • Air availability

  • Air shopping

  • Hotel availability

  • Car availability

  • Sell

  • Pricing

Moreover, nudges from many RedApps are sorted alphabetically using serviceCallback defined in extension point declaration

Data model

  • com.sabre.stl.pos.srw.nextgen.redapp.nudge.v1.RedAppNudgeInitRQ

    • Entries is typeof RedAppNudgeInitEntry - carrying information required to display nudge

  • com.sabre.stl.pos.srw.nextgen.redapp.nudge.v1.RedAppNudgeInitEntry

    • Location - carries information from where RedAppNudgeInitRQ was send, possible options are AIR_AVAILABILITY, SHOPPING, HOTEL, CAR, SELL, PRICING

    • Origin - carries information about departure location

    • Destination - carries information about destination location

    • Start - carries information about start date of the trip

    • End - carries information about end date of the trip

  • com.sabre.stl.pos.srw.nextgen.redapp.nudge.v1.RedAppNudgeInitRS

    • Item is typeof RedAppNudgeItem - it carriers information about nudge to UI

  • com.sabre.stl.pos.srw.nextgen.redapp.nudge.v1.RedAppNudgeInitRS

    • Icon - it carries information about icon which will be display in Nudge. Nudge supports following icon options:

      • INFO

      • WARNING

      • DANGER

      • icon in BASE64 format e.g.

iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAABJ0lEQVRYR83XsQ3CMBAFUG
caRkqBWIGWJgUFDS0rIApGYht00lmyHPvu37cCoSEI7P+I7Ys9pT+/psH8Rdvf2H5GABJ+
1WB5pxAsIIcfFfBSTBjBAMrwtwLmlBKFiAJa4Xn4KUQEYIXTCBSAhFMIBGCFnzX1US1DeD
g8gPfPnxp8atQBCGEBvHDJtADyvYvoAZBwBOAiWgA0HAWYiBoQCY8AuogSEA2PApqIDGDC
GcAKsRuAyJi74C3DujysluWuJmHWRu7EXRtdnB1RtyCNFiJkJ2ZWw9FSfFDBpyOhSzE6HJ
s+jBDE5o9jBOEuNWuiePuBsi2yOtwxrzERgFeswuHSYRTQQ1DhLKBGyGfqTDACKBFy/fOj
Wbk65Dp8JMsdMHMAKb/wb756N3sh+j5jAgAAAABJRU5ErkJggg==
  • Message - it carries text which will be display next to the icon

  • Action is typeof RedAppNudgeAction - it carries information about action which will be invoke

    • com.sabre.stl.pos.srw.nextgen.redapp.nudge.v1.RedAppNudgeAction

  • Id - it carries action identifier which will be return after invoking the action

  • Label - it carries text which Nudge displays in the action button

Type of contribution

It supports only BackEnd type of contribution.

Extension dynamo.nudge:nudgeActionCommand

Execution time

It will be executed after user clicked action button configured in nudge API.

Data model

  • com.sabre.stl.pos.srw.nextgen.redapp.nudge.v1.RedAppNudgeActionRQ

    • ActionId - it carries action identifier which helps to determine what kind of action was invoked

    • Entries - is typeof RedAppNudgeInitEntry - carrying information required to display nudge

Type of contribution

It supports only BackEnd type of contribution.

Execution time

It will be executed after sending data with payments from payment form which is trigger by LinkPayment API. Extension point will be executed only when payment will be successfully validated.

Data model

  • com.sabre.stl.pos.srw.nextgen.redapp.creditcardverification.rs.v1.RedAppCreditCardVerificationResult carrying credit cards data and approval codes:

    • verification result list

      • application result

        • list of successes

        • list of warnings

        • list of errors

        • status

          • COMPLETE

          • INCOMPLETE

          • NOT_PROCESSED

          • UNKNOWN

      • text description

      • version

    • list of credit card data

      • airline code

      • vendor code

      • expiration date

      • anonymised credit card number

      • amount

      • currency code

    • list of passenger approval codes

      • passenger number

      • approval text

  • com.sabre.stl.pos.srw.nextgen.redapp.foppqlink.rq.v1.RedAppFopPqLink carrying information about form of payments:

    • form of payment data

      • operation type

        • C

        • U

      • id

      • payment type

        • CASH

        • CHECK

        • CREDIT_CARD

      • credit card info

        • credit card code

        • anonymised credit card number

        • expiration month

        • expiration year

        • carier code

        • suppress approval code

        • full amount auth

      • list of traveller numbers to be added

      • list of traveller numbers to be deleted

    • price quote number

    • passenger name number

  • com.sabre.stl.pos.srw.nextgen.redapp.travelitineraryread.rs.v1.RedAppTravelItineraryReadRs - available only for graphical flow

    • application result

      • list of successes

      • list of warnings

      • list of errors

      • status

        • COMPLETE

        • INCOMPLETE

        • NOT_PROCESSED

        • UNKNOWN

    • travel itinerary

      • customer info

        • person name

          • email

          • given name

          • profile index

          • surname

          • with infant

          • name number

          • name reference

          • passanger type

          • element id

      • itinerary info

        • itinerary pricing

          • price quote

        • reservation items

        • item

          • flight segment

      • itinerary ref

        • header

        • source

          • AAA pseudo city code

          • create datetime

          • creation agent

          • home pseudo city code

          • pseudo city code

          • received from

          • last update time

          • sequence number

        • travel policy

      • remark info

        • remark

          • text

          • person name

          • code

          • segment number

          • type

      • special service info

        • service

          • airline

          • person name

          • text

          • ssr code

          • ssr type

        • type

      • open reservation elements

        • openReservationElement

          • form of payment

          • service request

    • price quote

      • details

        • segment info

          • flight

          • fare basis

          • number

        • transaction info

          • last date to purchase

          • local create date time

        • name association info

          • name number

          • name id

          • first name

          • last name

        • fare info

          • total fare

        • miscellaneous info

          • validating carrier

        • number

        • passenger type

    • version

Type of contribution

It supports only BackEnd contribution.

Extension dynamo.exchange.confirmation:afterExchangeConfirmation

Execution time - it will be executed after the exchange is confirmed.

Data model

  • com.sabre.stl.pos.srw.nextgen.commsg.exchange.CommandMessageExchangeRs

    • data - This represents the response object. Contains information about processin and the types of com.sabre.stl.pos.srw.nextgen.pos.ExchangeRS.

  • com.sabre.stl.pos.srw.nextgen.pos.ExchangeRS

    • PqrNumber - PQR number.

Type of contribution

It supports both types of contribution: FrontEnd and BackEnd.