Queue request message

Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.

NodeDescriptionValuesOccursExample
<QueueRQ>
The QueueRQ request suppports two distinct modes of operation: regular mode and "queue mode".

In regular mode each QueueRQ request - whether send within an XX/1 session or not - is "atomic", meaning its effect is unrelated to previous or subsequent QueueRQ requests sent.
The following QueueRQ child elements may only be used in regular mode: Clean, Count, List, Move, Place and Remove.

"Queue mode" on the other hand serves to perform multi step workflows on a specific queue.
The following QueueRQ child elements may only be used in "queue mode": Access, Bounce, EndTransaction, Exit.

All requests of a "queue mode" workflow must be performed within a single XX/1 session. The first step of a "queue mode" workflow is to access a specific queue with QueueRQ/Access. The last step is to exit the queue with QueueRQ/Exit. In between, any number of QueueRQ requests with Bounce and/or EndTransaction may be used to iterate through the PNRs on the queue. It is also possible to send PNRCreateRQ requests to modify PNRs (do not include a RecordLocator - PNRCreateRQ will modify the PNR currently accessed while iterating through the queue!).
1
@NoFareRetrieval
Setting @NoFareRetrieval to "Y" will prevent the retrieval of stored fares when retrieving PNRs. For those CRS where this attribute is supported it will reduce the number of CRS transactions and save processing time.
Values:
Y = do NOT retrieve fares
N = retrieve fares

Default if left out: N

[Y] [N] 0..1 Y
<Access>
Access queue group.
ENTER QUEUE MODE (Lock session before!)
The response message will return the first PNR on the queue.
0..1
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
<PseudoCityCode/>
Agency's pseudo city code. 0..1 LNJ2
<QueueCategory>
Queue category. 0..1 7
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
</Access>
<Bounce>
Bounce queue group. Step through queue (must be in queue mode). The response message will return a new PNR from the queue.0..1
@Action
Action to apply to current PNR before moving ("bouncing") to next PNR.

Values are:
I = Ignore changes to current PNR (if any) and leave it on queue.

R = Ignore changes to current PNR (if any) and remove PNR from queue.

E = End transact changes to current PNR and remove it from queue.

[I] [R] [E] 1 I
<ForwardNumber/>
Allows the capability to move forward a specified number of pnrs or messages while working in a queue. 1 7
<BackwardNumber/>
Allows the capability to move backward a specified number of pnrs or messages while working in a queue. 1 10
</Bounce>
<Count>
Count queue group.
IMPORTANT: DO NOT USE IN QUEUE MODE (will result in error message)!
0..1
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
<PseudoCityCode/>
Agency's pseudo city code. 0..1 LNJ2
<QueueCategory>
Queue category. 0..1 7
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
<AllQueues/>
Retrieve the count of all queues. Possible value: Y
[Y] 1 Y
</Count>
<List>
List group.
IMPORTANT: DO NOT USE IN QUEUE MODE (will result in error message)!
0..1
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Timeout
Timeout in seconds. Only supported by some adapters which send multiple parallel backend requests to gather information for the XX/1 response.

If a timeout is specified, XX/1 will only wait for the specified number of seconds for the parallel backend requests to complete. Information from backend requests which have not completed when the timeout is reached are ignored in the XX/1 response without issuing an error message.

0..1 3
@Timeout
Timeout in seconds. Only supported by some adapters which send multiple parallel backend requests to gather information for the XX/1 response.

If a timeout is specified, XX/1 will only wait for the specified number of seconds for the parallel backend requests to complete. Information from backend requests which have not completed when the timeout is reached are ignored in the XX/1 response without issuing an error message.

0..1 3
<PseudoCityCode/>
Agency's pseudo city code. 0..1 LNJ2
<RecordLocator/>
Record locator of a PNR.
Can be provided as an additional filter option.
0..1
<QueueCategory>
Queue category. 0..1 7
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
</List>
<Move>
Move queue group. Use to move one or more PNRs from one queue (category) to another.

IMPORTANT: DO NOT USE IN QUEUE MODE (will result in error message)!
0..1
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
<FromQueue>
Move from queue group1
<PseudoCityCode/>
Agency's pseudo city code. 0..1 LNJ2
<QueueCategory>
Queue category.

NOTE: Currently only supported for Amadeus, Worldspan and Galileo!

0..1 11
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
</FromQueue>
<ToQueue>
Move to queue group1
<PseudoCityCode/>
Agency's pseudo city code. 0..1 LNJ2
<QueueCategory>
Queue category.

NOTE: Currently only supported for Amadeus, Worldspan and Galileo!

0..1 11
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
</ToQueue>
<RecordLocator/>
Record locator of a PNR to move from one queue to another.

NOTE: Currently only supported for Amadeus!

1 LNJ20K
<NumberItems/>
Number of PNRs (starting from the head of the "from" queue) to be moved.

If both RecordLocator and NumberItems are left out, all PNRs on the "from" queue will be moved.

1 50
</Move>
<Place>
Place a PNR on one or more queues. In general the PNR to place is specified by the RecordLocator child element with two exceptions:

1) Some CRS may allow to place the current PNR on queue when working in a session. In that case it must not be specified by RecordLocator.

2) For CRS which do not support the retrieval of an existing PNR, the XX1 queues component allows to place PNRs on XX1-own queues by pproviding a complete PNRViewRS document which is then stored in XX1 and placed on the queue(s) specified at the same time.
0..1
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
<RecordLocator/>
The record locator of the PNR to place on queue.

Example ABC123
0..1
<PNRViewRS/>
Please see PNRViewRS or TicketImageRS documentation for further details.0..1
<QueueCategory>
Queue category. 0..1 7
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<PseudoCityCode/>
Agency's pseudo city code. 1 LNJ2
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
<Queue>
1..N
<QueueCategory>
Queue category. 0..1 7
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<PseudoCityCode/>
Agency's pseudo city code. 1 LNJ2
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
</Queue>
<Date/>
The future date to for queue placement.

0..1 2009-10-21
<Time/>
The future time for queue placement.

Time in ISO 8601 format (hh:mm:ss).
0..1 12:45
</Place>
<Remove>
Remove queue group.
IMPORTANT: DO NOT USE IN QUEUE MODE (will result in error message)!
0..1
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
<RecordLocator/>
Record locator of a PNR to be removed from queue. If not present, either the current PNR (if there is one in the AAA) will be removed from the specified queue or all PNRs on this queue.0..1
<PseudoCityCode/>
Agency's pseudo city code. 0..1 LNJ2
<QueueCategory>
Queue category. 0..1 7
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
</Remove>
<Clean>
Removes from a specific queue, PNRs that have past dates or have no itinerarys.
IMPORTANT: DO NOT USE IN QUEUE MODE (will result in error message)!
0..1
<PseudoCityCode/>
Agency's pseudo city code. 0..1 LNJ2
<QueueCategory>
Queue category. 0..1 7
@DateRange
Date range identifier for a specific date range defined for this queue category. The format of the identifier is GDS/CRS specific.

0..1 2
</QueueCategory>
<QueueNumber/>
Queue number. 1 12
<QueueName/>
Queue name. 1 PASS
</Clean>
<Exit>
Exit queue group.
EXIT QUEUE MODE (Release session afterwards!)
0..1
@TransactionType
Exit transaction type. Possible values are:
E = Exit and End Transact
RN = Exit and Remove from Queue
QEP = Exit and Queue place
I = Exit and Ignore
OFF = Exit Queue

[E] [I] [OFF] [RN] [QEP] 0..1 E
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
</Exit>
<EndTransaction>
End transaction (for use in queue mode). Depending on the @TransactionType the response message will return the next or current PNR from the queue.0..1
@TransactionType
End transact request.
Values are:
ER = End transaction and redisplay pnr while on queue
IN = Ignore and place pnr back on queue/ displays next pnr on queue
RN= End transaction and remove pnr from queue/ displays next pnr on queue
LN = End transaction and leave pnr on queue/ displays next pnr on queue

[ER] [IN] [RN] [LN] 1 IN
</EndTransaction>
</QueueRQ>

Legend

ColumnDescription
NodeName of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath.
DescriptionDescription of meaning and usage of the node.
ValuesList of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema.
OccursMinimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples:
0..3 Node is optional and may occur up to 3 times.
1..N Node must occur at least one (mandatory) and may occur any number of times.
2 Node must occur exactly twice.
ExampleExample value for the node.

XML Schema documentation generated with XX/1 server