V2
User's Guide

Interface: PoweredQueue


1 Introduction

PlaceMessage

This interface is used to place a free flow text message in queue.

MoveItem

Move Item provides several options to copy PNRs or messages from one queue to another.

CountHalfMonth

This service displays total of PNRs in queue by half-month increments for the next eleven months.

CountTotal

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 ormessages requiring action.

Queue_List

This function provides a list a PNRs placed in a queue with search criterias and order display options.

CountPlanner

The queue count planner enables you to view future queue placement for ticketing, option and delay queues.

PlacePNR

Place PNR verb gives the possibility to place one or several PNRs onto a Queue.

RemoveItem

This function enables you to remove a PNR from queue independently from queue mode.

2 Considerations

Not applicable

3 Limitations

Not applicable

4 Unsupported Functions

Not applicable

5 Prerequisites

Not applicable





Function: PlaceMessage


1 Overview

The Powered Queue Place Message verb gives the possibility to place a free flow text message onto a Queue Message.

1.1 Supported Operations

You can use the QEQ option code to place a message on queue.

If queue or category specified in the input are not active and the QCH office profile indicator (queue category check) is equal to “Q” or “QO”,  then error message is displayed and the queue placement does not take place.

If queue or category specified in the input are not active and the QCH office profile indicator (queue category check) is not equal to “Q” nor “QO”, then the default queue placement takes place (default queue is queue 0, default category is category 0).

1.2 Limitations

Messages can contain up to 199 alpha-numeric characters.

1.3 Unsupported Operations

Not applicable

1.4 Prerequisites

Not applicable

2 Building A Query

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.

3 Receiving A Reply



Reply Structure

This is the response to a Place Message query of a free-flow text message onto Queue 97C0D1 in Office NCE1A950

4 Error Messages

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


5 Operations

5.1 Operation: Flow Text On Queue

Place a free flow text on queue 97.

5.1.1 Query Structure


Double Click To Show XML

4 nce1a0950 97 c 0 1 3 This is an example of a message placed in Queue 97 in office NCE1A0950

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error messages" section






Function: MoveItem


1 Overview

The Move Item service provides several options to copy PNRs or messages from one queue to another with the possibility to retain them on the current queue.

1.1 Supported Operations

1.2 Limitations

Not applicable

1.3 Unsupported Operations

Not applicable

1.4 Prerequisites

Not applicable

2 Building A Query

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.

3 Receiving A Reply

4 Error Messages

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


5 Operations

5.1 Operation: Copy PNR To Queue

Copy PNR to Queue 3C0 and retain it on Queue 0C0.

5.1.1 Query Structure


Double Click To Show XML

3 0 c 0 3 3 c 0

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error messages" section


5.2 Operation: Copy Specified Number Of PNRs

Copy a specified number of PNRs (2) from queue 0C0 to queue 3C0.

5.2.1 Query Structure


Double Click To Show XML

3 0 c 0 3 3 c 0 2

5.2.2 Reply Structure


Double Click To Show XML

5.2.3 Possible Errors

See "Error Messages" section






Function: CountHalfMonth


1 Overview

This service provides count by half-month increments for the next eleven months, for Ticketing, Option and Delay queues.

1.1 Supported Operations

Delay Planner

PNRs that have been delayed for action from the queue and that will be returned to the queue at a future time or date.

Ticketing Planner

PNRs that are queued to the ticketing queue at a future date.

Option Planner

PNRs that are queued to the option queue at a future date.

Summary Planner

A total of all PNRs on the delay, ticketing, and option planners.

1.2 Limitations

Not applicable

1.3 Unsupported Operations

Not applicable

1.4 Prerequisites

Not applicable

2 Building A Query

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.

3 Receiving A Reply

4 Error Messages

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


5 Operations

5.1 Operation: Count Half Month For Ticketing

Count Half Month for Ticketing on Queue one, office ID NYCP02001.

5.1.1 Query Structure


Double Click To Show XML

4 nycp02001 1

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error Messages" section


5.2 Operation: Half Monthly Summary

This query is a basic query to display the Half Monthly Summary for your own office Id.

5.2.1 Query Structure


Double Click To Show XML

5.2.2 Reply Structure


Double Click To Show XML

5.2.3 Possible Errors

See "Error messages" section






Function: CountTotal


1 Overview

The queue count provides you with details about:

1.1 Supported Operations

The following operations are currently supported for Queues counts :

1.2 Limitations

Not appliccable

1.3 Unsupported Operations

Not appliccable

1.4 Prerequisites

Not appliccable

2 Building A Query

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.

3 Receiving A Reply

4 Error Messages

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


5 Operations

5.1 Operation: All Queues

Queue Count all queues.

5.1.1 Query Structure


Double Click To Show XML

4 NYCP02001

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error Messages" section


5.2 Operation: Specific Queue Activity

Queue Count activity for Queue 3C0.

5.2.1 Query Structure


Double Click To Show XML

4 NYCP02001 3 c 0

5.2.2 Reply Structure


Double Click To Show XML

5.2.3 Possible Errors

See "Error Messages" section


5.3 Operation: Total

Queue Count Total.

5.3.1 Query Structure


Double Click To Show XML

4 NYCP02001

5.3.2 Reply Structure


Double Click To Show XML

5.3.3 Possible Errors

See "Error messages" section






Function: Queue_List


1 Overview

This function retrieves a list of PNRs Record Locator placed in a queue and retrieves one among them with no need to display all PNRs one by one. Even more, the function provides PNRs search criteria to display only some PNRs placed in a queue.

1.1 Supported Operations

List with display option

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).

List with search criteria

It is possible to request a List of PNRs placed in a queue based on the departure date, creation date or ticketing date.

1.2 Limitations

This function applies only for PNRs queue.

1.3 Unsupported Operations

It is not possible to request a list for Message Queue. The start queue function has to be used to display a message Queue.

1.4 Prerequisites

Not applicable

2 Building A Query

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.

3 Receiving A Reply

4 Error Messages

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


5 Operations

5.1 Operation: Display Queue By Office And Date

Display a List of the queue 12C0 in the office NCE1A0950 and search with ticketing date between 20 APR and 21 APR and departure date between 3 May and 4 May.

/targetOffice /originatorDetails /inHouseIdentification1 NCE1A0950
/queueNumber /number 12
/categoryDetails /identificationType C
/categoryDetails /itemNumber 0
/searchCriteria [1] /searchOption /selectionDetails /option TD
/searchCriteria [1] /dates /beginDateTime /year 2009
/searchCriteria [1] /dates /beginDateTime /month 4
/searchCriteria [1] /dates /beginDateTime /day 20
/searchCriteria [1] /dates /endDateTime /year 2009
/searchCriteria [1] /dates /endDateTime /month 4
/searchCriteria [1] /dates /endDateTime /day 21
/searchCriteria [2] /searchOption /selectionDetails /option DD
/searchCriteria [2] /dates /beginDateTime /year 2009
/searchCriteria [2] /dates /beginDateTime /month 5
/searchCriteria [2] /dates /beginDateTime /day 3
/searchCriteria [2] /dates /endDateTime /year 2009
/searchCriteria [2] /dates /endDateTime /month 5
/searchCriteria [2] /dates /endDateTime /day 4

5.1.1 Query Structure


Double Click To Show XML

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error Messages" section


5.2 Operation: Display Queue By Office And Ticketing Date

Display a List of the queue 12C0 in the office NCE1A0950 andsearch with ticketing date between 20 APR and 21 APR

5.2.1 Query Structure


Double Click To Show XML

4 NCE1A0950 12 C 0 2004 4 20 2004 4 21

5.2.2 Reply Structure


Double Click To Show XML

5.2.3 Possible Errors

See "Error Messages" section


5.3 Operation: Queue List By Creation Date

Queue List with creation date order display option.

5.3.1 Query Structure


Double Click To Show XML

0 C 0

5.3.2 Reply Structure


Double Click To Show XML

5.3.3 Possible Errors


5.4 Operation: Queue List By Departure Date

Queue List with departure date order display option.

5.4.1 Query Structure


Double Click To Show XML

0 C 0

5.4.2 Reply Structure


Double Click To Show XML

5.4.3 Possible Errors

See "Error Messages" section


5.5 Operation: Queue List By Ticketing Date

Queue List with ticketing date order display option.

5.5.1 Query Structure


Double Click To Show XML

4 NYCP02001 3 C 0

5.5.2 Reply Structure


Double Click To Show XML

5.5.3 Possible Errors

See "Error messages" section


5.6 Operation: Queue List First Ten PNRs

Queue List of queue 15 for the first PNR to the 10th PNR.

5.6.1 Query Structure


Double Click To Show XML

15 C 0 701 0 10

5.6.2 Reply Structure


Double Click To Show XML

5.6.3 Possible Errors

See "Error Messages" section






Function: CountPlanner


1 Overview

The queue count planner gives a view of future queues on date or time base.

1.1 Supported Operations

The queue count planner consists of four parts. These are:

Delay Planner

PNRs that have been delayed for action from the queue and that will be returned to the queue at a future time or date.

Ticketing Planner

PNRs that are queued to the ticketing queue at a future date.

Option Planner

PNRs that are queued to the option queue at a future date.

Summary Planner

A total of all PNRs on the delay, ticketing, and option planners.

1.2 Limitations

Not applicable

1.3 Unsupported Operations

Not applicable

1.4 Prerequisites

Not applicable

2 Building A Query

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.

3 Receiving A Reply

4 Error Messages

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


5 Operations

5.1 Operation: Date Deferred Count Planner

Deferred date for count planner.

5.1.1 Query Structure


Double Click To Show XML

4 NYCP02001

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error messages" section


5.2 Operation: Date Deferred Option Queue

Count Planner for Date Deferred Option Queue.

5.2.1 Query Structure


Double Click To Show XML

04 08 15

5.2.2 Reply Structure


Double Click To Show XML

5.2.3 Possible Errors

See "Error Messages" section


5.3 Operation: Deferred For Ticketing Queue

Deferred count planner for the ticketing queue.

5.3.1 Query Structure


Double Click To Show XML

04 08 23

5.3.2 Reply Structure


Double Click To Show XML

5.3.3 Possible Errors

See "Error Messages" section






Function: PlacePNR


1 Overview

The Queue_PlacePNR verb gives the possibility to place one or several PNRs onto a Queue.

1.1 Supported Operations

Place PNR onto 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. It is possible to specify a different target Office Id to place a PNR in a different office. If you place a PNR in a non-existing queue an error is raised.

If queue or category specified in the input are not active and the QCH office profile indicator (queue category check) is equal to “Q” or “QO”,  then error message is displayed and the queue placement does not take place.

If queue or category specified in the input are not active and the QCH office profile indicator (queue category check) is not equal to “Q” nor “QO”, then the default queue placement takes place (default queue is queue 0, default category is category 0).

Place PNR onto Delay queue

The option QED allows you to place a PNR onto a queue at a specific time/date.

1.2 Limitations

Not applicable

1.3 Unsupported Operations

Not applicable

1.4 Prerequisites

Not applicable

2 Building A Query

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.

3 Receiving A Reply

4 Error Messages

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


5 Operations

5.1 Operation: Delay Queue

Place PNR ZE6YM5 on Delay Queue 0C0 on the 021004.

5.1.1 Query Structure


Double Click To Show XML

3 0 c 0 2004 10 02 ZE6YM5

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error Messages" section


5.2 Operation: Place PNR On Queue

Place PNR ZGHXJZ on Queue 3C0.

5.2.1 Query Structure


Double Click To Show XML

3 NYCP02001 3 C 0 ZGHXJZ

5.2.2 Reply Structure


Double Click To Show XML

5.2.3 Possible Errors

See "Error messages" section






Function: RemoveItem


1 Overview

The function RemoveItem enables you to remove a PNR from queue independently from queue mode.

1.1 Supported Operations

Remove PNRs/Messages from queue

You can remove all PNRs and messages from a queue. You can specify a category, date range or office identification if required.

Remove specific PNRs from queue

It is possible to remove one or several specific PNRs from a queue by giving the Record Locator(s).

Remove PNRs from Delay Date queue

It is possible to remove one or several PNRs from a specific Delay Date Queue or to entirely purge the Delay Queues.

Remove PNRs from Delay Time Queue

It is possible to remove one or several PNRs from a Delay Time Queue.

1.2 Limitations

Not applicable

1.3 Unsupported Operations

Not applicable

1.4 Prerequisites

Not applicable

2 Building A Query

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.

3 Receiving A Reply

4 Error Messages

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


5 Operations

5.1 Operation: Remove All Messages

Remove all messages from Queue 97C0D1.

5.1.1 Query Structure


Double Click To Show XML

3 97 c 0 1

5.1.2 Reply Structure


Double Click To Show XML

5.1.3 Possible Errors

See "Error Messages" section


5.2 Operation: Remove All PNRs From Delay Date Queue

Remove all PNRs from a specific Delay Date (060704) queue.

5.2.1 Query Structure


Double Click To Show XML

3 2004 07 06

5.2.2 Reply Structure


Double Click To Show XML

5.2.3 Possible Errors

See "Error Messages" section


5.3 Operation: Remove Specific PNR From Queue

Remove specific PNR (ZGHXJZ) from Queue 3C0

5.3.1 Query Structure


Double Click To Show XML

3 NYCP02001 3 c 0 ZGHXJZ

5.3.2 Reply Structure


Double Click To Show XML

5.3.3 Possible Errors

See "Error messages" section