V2User's Guide
|
V2 User's Guide |
The Powered Queue interface provides an interface to Global Core Queue functionality.
The PoweredQueue interface supports the following functions:
This interface displays total of PNRs in queue by half-month increments for the next eleven months.
The queue count planner enables you to view future queue placement for ticketing, option and delay queues.
The queue count represents the queue workload. You can request a full queue count, including categories and date ranges. Categories and date ranges appear in the queue count only when there are PNRs or messages requiring action.
Move Item provides several options to copy PNRs or messages from one queue to another.
This interface is used to place a free flow text message in queue.
Place PNR verb gives the possibility to place one or several PNRs onto a Queue.
Powered Queue Remove Item verb enables you to remove a PNR from queue independently from queue mode.
The Powered Queue List interface introduces a new concept of Queue display. It is now possible to have a list of PNRs Record Locator placed in a queue and retrieve one among them with no need to display all PNRs one by one. Even more, the Powered Queue List provides PNRs search criteria to display only some PNRs placed in a queue.
Not applicable
Not applicable
The PoweredQueue interface cannot be used to display a Queue message and its content. This operation is only possible with the Queue_Start verb.
Not applicable
This verb provides count by half-month increments for the next eleven months, for Ticketing, Option and Delay queues.
PNRs that have been delayed for action from the queue and that will be returned to the queue at a future time or date.
PNRs that are queued to the ticketing queue at a future date.
PNRs that are queued to the option queue at a future date.
A total of all PNRs on the delay, ticketing, and option planners.
Not applicable
Not applicable
Not applicable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
This example shows the Count Half Month Summary Planner for all Ticketing, Option and Delay queues planned for the next eleven months.
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
This query is a basic query to display the Half Monthly Summary for your own office Id.
See "Error messages" section
Count Half Month for Ticketing on Queue one, office ID NYCP02001.
See "Error Messages" section
The queue count planner gives a view of future queues on date or time base.
The queue count planner consists of four parts. These are:
PNRs that have been delayed for action from the queue and that will be returned to the queue at a future time or date.
PNRs that are queued to the ticketing queue at a future date.
PNRs that are queued to the option queue at a future date.
A total of all PNRs on the delay, ticketing, and option planners.
Not applicable
Not applicable
Not applicable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
The example below shows the Count Planner for date-deferred delayed queues in a different office Id.
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
Deferred date for count planner.
See "Error messages" section
Deferred count planner for the ticketing queue.
See "Error Messages" section
Count Planner for Date Deferred Option Queue.
See "Error Messages" section
The queue count provides you with details about:
The following operations are currently supported for Queues counts :
Not appliccable
Not appliccable
Not appliccable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
The example shows the Queue Count Total (all queues and categories)
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
Queue Count Total.
See "Error messages" section
Queue Count all queues.
See "Error Messages" section
Queue Count activity for Queue 3C0.
See "Error Messages" section
The Powered Queue Move Item verb provides several options to copy PNRs or messages from one queue to another with the possibility to retain them on the current queue.
Not applicable
Not applicable
Not applicable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
This example shows the positive response of a Move Item
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
Copy PNR to Queue 3C0 and retain it on Queue 0C0.
See "Error messages" section
Copy a specified number of PNRs (2) from queue 0C0 to queue 3C0.
See "Error Messages" section
The Powered Queue Place Message verb gives the possibility to place a free flow text message onto a Queue Message.
You can use the QEQ option code to place a message on queue.
Messages can contain up to 199 alpha-numeric characters.
Not applicable
Not applicable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
This is the response to a Place Message query of a free-flow text message onto Queue 97C0D1 in Office NCE1A950
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
Place a free flow text on queue 97.
See "Error messages" section
The Powered Queue_Place PNR verb gives the possibility to place one or several PNRs onto a Queue.
You can use the QEQ option code to place one or several PNRs on queue. If you do not specify a category, the PNR is placed in category 0 of the specified queue. If you attempt to place a PNR on a queue that has been deactivated, the system automatically places the PNR on queue 0, category 0 instead. It is possible to specify a different target Office Id to place a PNR in a different office.
The option QED allows you to place a PNR onto a queue at a specific time/date.
Not applicable
Not applicable
Not applicable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
The example shows the reply to a Place PNR query
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
Place PNR ZGHXJZ on Queue 3C0.
See "Error messages" section
Place PNR ZE6YM5 on Delay Queue 0C0 on the 021004.
See "Error Messages" section
The verb enables you to remove a PNR from queue independently from queue mode.
you can remove all PNRs and messages from a queue. You can specify a category, date range or office identification if required.
It is possible to remove one or several specific PNRs from a queue by giving the Record Locator(s).
It is possible to remove one or several PNRs from a specific Delay Date Queue or to entirely purge the Delay Queues.
It is possible to remove one or several PNRs from a Delay Time Queue.
Not applicable
Not applicable
Not applicable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
This example shows the reply to a RemoveItem
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
Remove specific PNR (ZGHXJZ) from Queue 3C0
See "Error messages" section
Remove all messages from Queue 97C0D1.
See "Error Messages" section
Remove all PNRs from a specific Delay Date (060704) queue.
See "Error Messages" section
Provides a list a PNRs placed in a queue with search criterias and order display options.
It is possible to request a list of PNRs placed in a queue and displayed according to the Departure date, Creation date and/or Ticketing date. You can also request a list of a specific number of PNRs placed in a queue (I.E. the 10 first PNRs).
It is possible to request a List of PNRs placed in a queue based on the Departure date, Creation Date or Ticketing date.
This function applies only for PNRs queue.
It is not possible to request a list for Message Queue. The QueueStart verb has to be used to display a message Queue.
Not applicable
Depending on the flavor of the API that is used, each query will follow a given structure. The queries for the function operations are clearly explained with data element examples in a generic table view that can be adapted to the specific flavor of the API in use. It is important to note that the examples in each chapter are only illustrations and are meant to provide the basis for a better understanding on which fields are mandatory for basic operation utilisation. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
This example displays a List of the queue 3C0 in the office NYCP02001 and sort by ticketing date
| Error number | Error message |
|---|---|
| 1 | Invalid date |
| 360 | Invalid PNR file address |
| 723 | Invalid category |
| 727 | Invalid amount |
| 79A | Invalid office identification |
| 79B | Already working another queue |
| 79C | Not allowed to access queues for specified office identification |
| 79D | Queue identifier has not been assigned for specified office identification |
| 79E | Attempting to perform a queue function when not associated with a queue |
| 79F | Queue placement or add new queue item is not allowed for the specified office identification and queue identifier |
| 911 | Unable to process - system error |
| 912 | Incomplete message - data missing in query |
| 913 | Item/data not found or data not existing in processing host |
| 914 | Invalid format/data - data does not match EDIFACT rules |
| 915 | No action - processing host cannot support function |
| 916 | EDIFACT version not supported |
| 917 | EDIFACT message size exceeded |
| 918 | enter message in remarks |
| 919 | no PNR in AAA |
| 91A | inactive queue bank |
| 91B | nickname not found |
| 91C | invalid record locator |
| 91D | invalid format |
| 91F | invalid queue number |
| 920 | queue/date range empty |
| 921 | target not specified |
| 922 | targetted queue has wrong queue type |
| 923 | invalid time |
| 924 | invalid date range |
| 925 | queue number not specified |
| 926 | queue category empty |
| 927 | no items exist |
| 928 | queue category not assigned |
| 929 | No more items |
| 92A | queue category full |
Queue List with Ticketing date order display option.
See "Error messages" section
Queue List with Creation date order display option.
Queue List with Departure date order display option.
See "Error Messages" section
Queue List of queue 15 for the first PNR to the 10th PNR.
See "Error Messages" section
Display a List of the queue 12C0 in the office NCE1a0950 and search with Ticketing date between 20APR and 21 APR
See "Error Messages" section
Display a List of the queue 12C0 in the office NCE1A0950 and search with Ticketing date between 20APR and 21 APR and departure Date between 3 May and 4 May.
See "Error Messages" section