Universal Record (UR) Modify While on Queue allows the customer to update any component in an existing Universal Record from a queue and update the UR History with the details of the queue information. The customer can then view the original booking again, get the next PNR in the queue, or exit the queue using the QueueNextModifiers element.
Schema
Located in GDSQueue.xsd:
Request
Universal Record (UR) Modify, while on Queue request, updates the existing PNR from the queue that the customer has accessed, then updates the UR history with the details of the queue information. The Modify request determines the next actions: view the original booking again, get the next PNR on the queue, or exit the queue.
Note: The customer must already be on queue. See Entering Queues for details.
Set @ReturnRecord="true" to return the updated Universal Record in the response so that you do not have to make a follow-on UniversalRecordRetrieve request to see the updated Universal Record after the modify.
Use the attributes in UniversalRecordModifyReq/QueueNextModifiers to further define the action that occurs when the current PNR is modified while on queue.
Note: Modifying a UR on a Queue using QueueNextModifiers is not available for Worldspan (1P).
The following queue modifiers are mutually exclusive; only on can be set to "true" in the request:
- @NextOnQueue: Set to "true" to retrieve the next PNR on Queue. If not set, or set to "false", the current PNR is returned in the response.
- @ProviderLocatorCode: Specify the ProviderLocatorCode to return the specified locator code in Queue mode.
- @ReQueueCurrent: Set to "true" to place the current PNR back on Queue.
Multiple Queues
To support multiple sessions, the value of the session token from the previous GdsEnterQueueReq or GDSNextOnQueueReq response must be sent in QueueNextModifiers @QueueSessionToken. The token is maintained until GDSQueueExit or until queue processing places an orphaned Universal Record back to the queue.
Consolidator Queues
Consolidators with permission to emulate an agency's PCC can manage and ticket Universal Records/PNRs for specified queues (consolidator queues) on the agency's behalf. On Queue Next, only URs that are accessible for the consolidator can be retrieved or modified. If the PNR on Queue did not originate in Universal API, the PNR is imported into Universal API. If a corresponding Universal Record does not already exist for the PNR, a new Universal Record is created.
Response
The UniversalRecordModifyRsp is returned. It may contain the updated UR if ReturnRecord was set to "true" in the request.
Because a Universal Record could have multiple UR/PNR locators, the client application needs to know if the UR/PNRlocator that is currently on the queue has been accessed by the customer. This information is sent in the response in GdsEnterQueueRsp/UniversalRecord/ProviderReservationInfo @InQueueMode:
- InQueueMode = "true" if the UR/PNR record locator that is returned is the one that is currently on the Queue.
- InQueueMode = "false" if the UR/PNRlocator that is returned is NOT the one that is currently on the Queue.
Multiple Queues
Multiple simultaneous Queues are supported. The value of @QueueSessionToken entered in the request is returned in the response. The token is used on a subsequent GDSNextOnQueueReq or GDSQueueExit requests.
Consolidator Queues
Depending on the @RemoveCurrent setting, Universal API either places active PNRs for that Agent back in Queue (RemoveCurrent= False) or removes all instances of the active PNRs from the Queue (RemoveCurrent= True).
Universal Record history indicates:
- When a PNR is removed from the GDS queue.
- When the Provider PNR was Queue Placed.
Errors and Warnings
For GDSQueue:
- If a value is not provided in @QueueSessionToken, an error is returned: Queue Session Token is required for the requested service.
- If the value in @QueueSessionToken is incorrect, an error is returned: Requested Queue Session Token is invalid.
-
During Universal Record Modify with QueueNextModifiers (Provider Locator Code or Next on Queue Boolean), if Universal API encounters the PNR import failure and the unsynchronized Universal Record can be displayed:
-
A warning message is returned: Please use GDSNextonQueueReq to get the next PNR in queue or use GDSExitQueueReq to exit the queue.
-
The GDSNextOnQueue request must be resent to sign into the GDS Queue. The Queue Session Info table is updated with a new PNR and Universal Record.
-
Exceptions
Modifying a UR on a Queue using QueueNextModifiers is not available for Worldspan (1P).
ACH does not support queues.
Feedback / Support
