Operation queue_list retrieves a list of artifacts (PNRs) placed in a queue. Additionally, the operation provides the capability to specify the queue category to display only certain PNRs within the queue. It is permissible to specify multiple queues within a single request. The response includes, in addition to the PNR reference, several associated parameters necessary for further processing of the queued artifacts.
Limitations
This operation is applicable only to active queues.
No more than 10 queues can be requested simultaneously.
The queue numbers invoked should correspond to those returned by the count-total method.
The resulting queue list will include only those PNRs for which the agent has retrieval rights.
Table of contents
Request
| parameter | Description | xPath |
|---|---|---|
QueueNumber | Queue number | /soapenv:Envelope/soapenv:Body/iata:IATA_OrderListRQ/iata:AugmentationPoint/List/GetList/@QueueNumber |
QueueCategory | Name of category | /soapenv:Envelope/soapenv:Body/iata:IATA_OrderListRQ/iata:AugmentationPoint/List/GetList/@QueueCategory |
Party | Use credentials that you received from our technical support. Check out Quick Start for how to get it and References for more details | /soapenv:Envelope/soapenv:Body/iata:IATA_OrderListRQ/iata:Party |
Remarks
The category name must be transmitted exactly as it appears in the count-total response, preserving all characters, case, spaces, and other specific formatting. For example, "RESERVATION REQUEST CONFIRMED".
Response
| parameter | Description | xPath |
|---|---|---|
CategoryRef | Category Reference | /SOAP-ENV:Envelope/SOAP-ENV:Body/ns2:IATA_OrderListRS/ns2:AugmentationPoint/ns3:QueueListRS/ns3:ListItems/ns3:ListItem/@CategoryRef |
ItemRef | Queue item reference | /SOAP-ENV:Envelope/SOAP-ENV:Body/ns2:IATA_OrderListRS/ns2:AugmentationPoint/ns3:QueueListRS/ns3:ListItems/ns3:ListItem/@ItemRef |
PNRRef | Record Locator reference | /SOAP-ENV:Envelope/SOAP-ENV:Body/ns2:IATA_OrderListRS/ns2:AugmentationPoint/ns3:QueueListRS/ns3:ListItems/ns3:ListItem/@PNRRef |
QueueNumber
| Queue number | /SOAP-ENV:Envelope/SOAP-ENV:Body/ns2:IATA_OrderListRS/ns2:AugmentationPoint/ns3:QueueListRS/ns3:ListItems/ns3:ListItem/@QueueNumber |
QueueRef
| Queue identifier reference | /SOAP-ENV:Envelope/SOAP-ENV:Body/ns2:IATA_OrderListRS/ns2:AugmentationPoint/ns3:QueueListRS/ns3:ListItems/ns3:ListItem/@QueueRef |
isEmpty
| empty queue identifier | /SOAP-ENV:Envelope/SOAP-ENV:Body/ns2:IATA_OrderListRS/ns2:AugmentationPoint/ns3:QueueListRS/ns3:ListItems/ns3:ListItem/@isEmpty |