V2User's Guide
|
V2 User's Guide |
The Powered Profile interface has been designed and implemented to facilitate the creation, manipulation, display, deactivation and reactivation of a profile. The profile record created contains helpful information about a specific type of profile when creating a reservation. The profile is stored and maintained in the system once it has been created, it can be retrieved whenever it is required to be used.
A Traveler profile is a unique customer profile that holds useful information about a traveling passenger that supports the activity of creating a reservation. It will hold information such, as preferences, any special needs and or requirements.
Each time a profile is created a record locator is assigned to the record, so that it can be easily referenced in the system. Hence, each time a reservation is requested, the agent retrieves this traveler record and this saves time and speeds up the process of making a reservation.
* The minimum requirement for a Traveler profile is a passenger name.
The system automatically adds the office identification of the office creating the profile and the Traveler's name as an automatic transfer PNR (Passenger Name Record) element under the section - PNR transferable data. It is possible to update a profile at any time; it is also possible to create a PNR from a profile.
A Company profile is one kind of customer profile that contains helpful information about a company that can help you when you make a reservation.
The system automatically adds the office identification of the office creating the profile and the Traveler's name as an automatic transfer PNR element under the section - PNR transferable data. It is possible to update a profile at any time; it is also possible to create a PNR from a profile. The trip and traveler categories section of a company profile to store the categories of traveler and the trip purposes related to a particular company. For the API the system does not add the trip and traveler category section, this must added to the profile at creation time.
A company profile name must contain at least three characters to be valid and up to 20 traveler categories and 20 trip purposes in a company profile.
It is possible to associate a traveler to a company Profile, however the company profile must be created and stored in the system prior to being used. The traveler profile must be loaded before you can associate it.
An agency profile contains information related to your own Office. An agency profile is used to store information such as special phone numbers, remarks, and preferred providers.
Only one agency profile can be created for your own office but, if the required security agreement exists, you can also create an agency profile for another office. Only one agency profile can exist per office ID.
After you create an agency profile, it is stored and maintained in the system, it can be updated whenever you need. It is possible to create a PNR automatically from an agency profile.
The system automatically adds the following to the general information section of the profile: Office identification of the office creating the profile (MUC1A0701) Agency name (AMERICAN EXPRESS)
Profiles for staff are owned and maintained by the Airline, for that reason each Airline will create their own staff profiles and maintain them outside of the API. These profiles will have their own unique reference number given to them by the Airline and they will be updated via a synchronisation process from the airline system.
Staff profiles are used for the airline staff when they travel professional or non-professionally (Stand-by or booked). The profile not only extends to the airline staff themselves but likewise they can have member profiles that are for relatives.
Note: It should also be noted that it is not possible to associate a staff profile to a company profile.
The traveler categories that are defined in a company profile can then be stored in individual traveler profiles associated to a company.
Reminder: Defining a traveler category (company profile only)
Trip purposes are not stored in traveler profiles. It is possible to store a traveler category in a traveler profile that is associated to a company profile, however, the category you enter MUST already be defined in the company profile.
Reminder: Storing a traveler category (traveler profile only)
The PoweredProfile operations have been categorised into the following functions:
Main operation used for creating and updating a profile.
Operation that will disply an existing profile.
Operation used to deactivate or reactivate a company, traveler and an agency profile
The List Deactivated Profile function allows you to view a list of deactivated Company and Traveler profiles.
The message value 'P45' indicates a creation of a profile is in progress, whereas the Value 'P46' indicates that a modification of the profile is taken place.
It is possible to update any of the four kinds of profile, such as traveler profile, company profile, traveler associated to a company profile and an agency profile. It is important to note that for a profile update all the elements in the profile that are replaced in the profile after the update, even if only one certain elements are modified. In addition to the update that is made, it is also necessary to specify the record locator, profile type and profile sequence number 'owningOfficeSection/sequenceNumber' (taken from the previous reply structure) when specifying an update. This sequence number identifies the most recent profile.
The management of the updates of Staff profiles is a transparent matter for the API, as this is handled by the airlines.
Important: It should be noted that it is not possible to create a profile and modify a profile simultaneously, the create function and the update function are two independent actions, in that they have to be performed apart. Moreover, it is not possible to perform the update profile function unless a create profile action has taken place.
It should also be noted that this current version of profiles only supports 'FULL' update versus Partial updates, this means that in order to update a profile you must re-send the complete profile record in addition to the changes that you require.
The transferable data section of a Traveler, Company, or Agency profile contains all elements that you can transfer to a PNR or that are automatically transferred by the system.
Name is the only PNR element for which you can not change the transfer indicator.
Transferable elements are stored in two sections in the profile: PNR transferable data and itinerary. PNR transferable data elements can be entered in any order, as the system accepts each element, it assigns it a number and places it in the correct sequence. The same formats are used to enter PNR elements in a profile as for creating a PNR. The system automatically appends the letter A, S, or M after each element number each letter is called a transfer indicator (Reference Code set 002C) For each element, the system assigns the transfer indicator that is stored for each element in the management profile.
It is possible to override the default transfer indicator, or guarantee that a transfer indicator is not updated if the management Profile is updated, by adding an asterisk (*) and the transfer Indicator when you enter the element in the profile.
It is recommended that you do not change the default indicators for the fare elements or any element that generates a special service request
In addition to transfer indicators, the system also appends the sign of the agent creating the profile, in the general Information section.
There are five types of Remarks
Note: The remark category field is mandatory for all RI remarks and never used for RQ remark types.
The Remark Category field allows you to further pesonalise the comments within a profile. It enables the user to easily identify remarks in the same category. The entry for a category remark is RM followed by any letter of the alphabet from A to Z, a passenger association as an option. Remarks having the same category value are then grouped together, for example RMH for all remarks relating to Hotels and RMC for all remarks relating to Cars, and so on.
From a profile display it is possible to deactivate a profile. A Traveler profile, a Company profile without associated travelers, a Company profile with associated travelers and an Agency profile can be deactivated.
The values hereinafter are the minimum requirements needed to retrieve a Staff profile. There are a few peculiarities that must be noted, the record locator is in fact the staff number that is unique to the airline, for example '666'. Furthermore, the airline is considered as the company in this example it is 'BA' which is the value used for the airline. The format used for the date is 'YYYYMMDD', Hence, year, month and day.
The Staff Profiles application will only be available to AIRLINE Agents working from AIRLINE offices; No franchisee office staff will have access to the application. The security rules for profile retrieval allow that a staff member may retrieve his own profile and staff members who are part of the Staff Travel group (ST duty code) may retrieve all profiles. Further information on the security for staff profiles may be found in the Frequent Flyers/Staff Security Analysis document.
A profile that is deactivated is placed on a deactivated profile list for 30 days, if the profile is not reactivated in days, the profile record will be deleted (purged) from both the deactivated profile list and from the system.
When deactivating a profile by record locator you must indicate whether the profile is a traveler or company profile.
There are currently no known limitations to the actual Interface itself. All functional limitations are listed within the applicable function areas of this document.
Note: the ability to create and modify a customer profile is determined by your agent security profile.
There are currently no known pre-requisites to using this interface.
The Create/Update profile function is used to create a profile and thereafter at a later stage to update a profile. The same function is used to perform both actions, however the actions create and update are independent.
The Powered Profile function allows for the following operations:
The creation of a Traveler profile.
The creation of a Company profile
The creation of an alike Traveler profile
The modification of a traveler profile
The modification of a company profile
Not applicable.
Not applicable.
Not applicable.
The following is an example showing the minimum requirement needed for creating a Traveler profile. It is not necessary to specify the type of profile (e.g. Traveler, Company or Agency) if the profile that you require is a Traveler profile, as there is system default of Traveler for all newly created profiles. Likewise, it is not necessary to have an existing PNR (passenger name record) to create a profile.
The 'codeListResponsibleAgency' value should be set to '3' in all cases, as this is equivalent to the IATA.
It is important to note that the statusOfProfile value must be set to 'A' to allow the profile to be validated.
| Data Element | Value |
|---|---|
| /messageActionDetails/messageDetails/ function | P45 |
| /messageActionDetails/messageDetails/ codeListResponsibleAgency | 3 |
| /travellerInformationSection/travellerInformation/traveller/ surname | SMITH |
| /travellerInformationSection/travellerInformation/traveller/ groupIndicator | ADT |
| /travellerInformationSection/travellerInformation/traveller/ quantity | 1 |
| /travellerInformationSection/travellerInformation/otherInformation/ firstName | JOHN MR |
| /owningOfficeSection/ statusOfProfile | A |
Note: It is optional to enter the officeID value when a profile is created, as the system will take as the default the agency information. However, if this field is used a validity check is made to confirm that the office ID is valid.
| Data Element | Value |
|---|---|
| /owningOfficeSection/owningOffice/ officeID | MIA1S1101 |
| /owningOfficeSection/ sequenceNumber | 0 |
When creating a profile, the following is a typical response that will be received in all cases that are successful.
As a result of the Traveler profile creation, 3 items are listed in the reply: A record locator of six characters '93GO4Y', a profile type of 'T', used to identify the type of profile that has just been created and the value '1' which is a sequence number indicating the version number of the profile. ('owningOfficeSection/sequenceNumber').
Each time you make an update to the profile you have to reference the most recent profile sequence number, as the next sequence number is generated automatically by the system using this number. There are three profile types, 'T' for traveler, 'C', for Corporate and 'A' for Agency profile, this information is from the Code set 052C, Type of Profile, as listed earlier in the document.
If the request was not successful, an error message will be returned indicating whether the error is an input error or a processing error.
If the request was not successful, a profile will not be created and an appropriate error message will be returned. The error message returned depends upon the specific situation encountered.
| Code | Error Text | Description |
|---|---|---|
| 3357 | MANDATORY ITEMS | Missing a mandatory field, for example when you create a new profile you must specify the StatusOfProfile to 'Active' |
| 9250 | DUPLICATE COMPANY | This message is a result of trying to create a company profile with a name that already exists |
| 9251 | COMPANY NAME NOT FOUND | This message is a result of not entering a valid Record Locator number for the company profile |
| 9255 | RECORD LOCATOR NOT FOUND | This message is a result of not entering a valid Record Locator number of six characters |
| 1319 | SIMULTANEOUS CHANGES | This message is a result of specifying an incorrect profile sequence number owningOfficeSection/sequenceNumber |
| 22407 | DUPLICATE SEQUENCE NUMBERS | This message is a result of specifying the same sequence number for several elements |
This example demonstrates the creation of a Traveler profile using the API.
See "Error Messages" section
Creation of a Traveler profile (only name is specified).
See "Error Messages" section
The following structure is an example query to create a Airlinesics company profile. The profile type 'C' indicates that this is a company profile.
Note: it is mandatory to create a category and a description to complete this profile successfully, a company profile name must contain at least three characters to be valid. Important: the 'statusOfProfile' value must be set to 'A' to allow the profile to be validated.
See "Error Messages" section
This next example demonstrates the creation of a more elaborate Company profile that includes PNR elements.
Note: a company profile name must contain at least three characters to be valid and likewise the same company name can not be used.
During the creation of this example profile, the following PNR elements are added:
| Profile | Walt Disney corporation |
| 1 business phone | NYC 567 123 767 |
| 1 Fax number | NYC 567 123 700 |
| 1 Address (mailing) | 155 Boston Drive, Menlo Park, CA 12000 |
| 1 Address (billing) | 12 ZAC La Vallee, Marne la vallee 60100 Paris |
See "Error Messages" section
Traveler profile associated to a company profile.
See "Error Messages" section
This query makes the assumption that the concerned profile is an existing profile and has just been created or has been retrieved using the profile retrieve options. The function value to update a profile is P46.
Note: If you can not recall the most recent profile sequence number that was used for the profile that you are trying to retrieve. It is possible to retrieve the profile by its record locator and or by its name. Reference the chapter entitled Display (retrieve) a profile in this document.
This scenario demonstrates in 3 steps one way to update a traveler profile.
See "Error Messages" section
In addition to the update that is made, it is also necessary to specify the record locator, profile type and profile sequence number 'owningOfficeSection/sequenceNumber' (taken from the previous reply structure) when specifying an update.
A Standard profile response is received with one exception, the automatically generated profile sequence number 'owningOfficeSection/sequenceNumber' value has incremented by '1', indicating a modification to the profile.
See "Error Messages" section
In this query a general remark is added to the traveler profile. This remark is visible to all users who have the authority to view the records. In addition to the modification, it is also necessary to specify the record locator, profile type and profile sequence number 'owningOfficeSection/sequenceNumber' that is now '2' (taken from the previous reply structure).
See "Error Messages" section
This query makes the assumption that the concerned profile is an existing profile and has just been created or has been retrieved using the profile retrieve options. The function value to update a company profile is P46, the same as for a traveler profile.
Note: If you can not recall the most recent profile sequence number that was used for the profile that you are trying to retrieve. It is possible to retrieve the profile by its record locator and or by its name. Reference the chapter entitled Display (retrieve) a profile in this document.
This scenario demonstrates in 4 steps one way to update a Company profile.See "Error Messages" section
In this query the name of the company is modified, however it is also necessary to specify the record locator, profile type and profile sequence number 'owningOfficeSection/sequenceNumber' (taken from the previous reply structure) when specifying an update.
A Standard profile response is received with one exception, the automatically generated profile sequence number 'owningOfficeSection/sequenceNumber' value has incremented by '1', indicating a modification to the profile. The value is now '2'.
See "Error Messages" section
In this query a PNR element is added to the company profile. In addition to the modification, it is also necessary to specify the record locator, profile type and profile sequence number 'owningOfficeSection/sequenceNumber' that is now '2' (taken from the previous reply structure).
A Standard profile response is received with one exception, the automatically generated profile sequence number 'owningOfficeSection/sequenceNumber' value has incremented by '1', indicating a modification to the profile. The value is now '3'.
See "Error Messages" section
In this query the profile address was deleted that had been created at the beginning (of the create process). In addition to the modification, it is also necessary to specify the record locator, profile type and profile sequence number 'owningOfficeSection/sequenceNumber' that is now '3' (taken from the previous reply structure).
A Standard profile response is received with one exception, the automatically generated profile sequence number 'owningOfficeSection/sequenceNumber' value has incremented by '1', indicating a modification to the profile. The value is now '4'.
See "Error Messages" section
This query shows the usage of the fax and e-mail element, using code values P10 and P02.
See "Error Messages" section
The Display Retrieve profile function allows you to retrieve filed profiles and to display the content of these profiles. The display can be selective, such that it is possible to display all the PNR transferable section of a profile. A profile has a number of separate data sections that can also be displayed. Each section is identified with a unique three-letter Code.
The data sections are:
| PNR | PNR transferable data |
| ITI | Itinerary |
| STO | Pre-stored entries |
| PRI | Priority |
| GEN | General information |
| DOC | Documents (traveler profile only) |
| FOL | Follow up |
| GLO | GloAirlinel search |
| AIR | Travel policies - Air |
| HOT | Travel policies - Hotel |
| CAR | Travel policies - Car |
| TRA | Travel management information |
| PTV | Traveler category |
| FFN | Frequent flyer numbers (traveler profile only) |
Note: If a requested data section does not contain any information it will not be displayed.
It is also possible to retrieve profiles by specific information, such as a profile record locator, which is the unique identifier for the record and or by a name of the company profile or by the name of the traveler in the traveler profile.
The Powered Profile function allows for the following operations:
Retrieve a traveler profile using its record locator
Retrieve a traveler company profile using its record locator
Retrieve a specific profile by traveler name
Retrieve a specific company profiles by it name
Retrieve all the travelers in a profile associated to current agency and or anther Agency if security permits
Retrieve all the corporate profiles
Retrieve all the profiles that belong to a particular company
Retrieve a staff profile that belongs to a particular Airline
Not applicable.
Future Implementations:
For a traveler or a company profile, it must exist and be filed on the system. Profiles for staff must exist on the airlines system and the API application trying to access the records must have a valid agency sign to be able to access the records.
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 utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
When retrieving a profile, the following is a typical successful response.
If the request was not successful, an error message will be returned indicating whether the error is an input error or a processing error.
| Code | Error Text | Description |
|---|---|---|
| 9255 | RECORD LOCATOR NOT FOUND | This message is a result of not entering a valid Record Locator number of six characters |
| 10470 | INVALID PROFILE TYPE | This message is a result of entering a Record Locator that is greater than six characters |
| 2705 | ACCESS RESTRICTED | This message is a result of not entering a valid Office ID when trying to retrieve a profile. |
| 3357 | MANDATORY ITEMS | This message is a result of not entering a valid Surname. |
| 9263 | NO COMPANY PROFILE FOUND | This message is a result of the search not finding a company profile with the requested company profile name. |
| 9294 | INVALID DATA | This message is a result of specifying a traveler 't' as the type of search when the query is for company. |
| 2644 | OFFICE ID NOT FOUND | This message is a result of an incorrect office id. |
| 9262 | NO TRAVELLER PROFILE FOUND | This message is a result of specifying a company that does not have any corporate travelers. The resolution to this error message is to retrieve the traveler profile and to associate the required company profile to it. |
| TBC | CHECK TRANSACTION CODE | The transaction code is invalid |
| TBC | CHECK FORMAT | Format is incorrect or mandatory data is missing |
| TBC | ENTRY NOT AUTHORISED | Agent is not allowed to perform the PDSE transaction. |
| 11601 | DISPLAY OF THIS PROFILE NOT | Even though the user is authorized to perform the PDSE (Profile Display by Employee number) transaction, he is not entitled to display the profile Agent is not allowed to perform the PDSE transaction. |
| 11602 | CHECK DATE OF BIRTH ENTERED | Attempt to retrieve staff profile using staff number and date of birth with an incorrect date of birth. |
| TBC | PROFILE DOES NOT EXIST | There are no profile matching the specified criteria. |
| 11603 | CHECK DATE FORMAT | The agent has entered an incorrect date format. |
Retrieve a traveler profile by record locator.
See "Error Messages" section
Retrieve a company profile by record locator.
See "Error Messages" section
This query retrieves a traveler profile by a similar name search. It is important to specify the officeID as well as the name of the traveler. The field /inputIndicator/numberOfLinesToBeReturned indicates the number of items selected in the search that are to be returned, if the screen display is exhausted, in other words if it exceeds this limit, there is a possibility to request to display the remainder of items.
See "Error Messages" section
This query retrieves a company profile by a similar name search. It is important to specify the officeID in addition to the company name. The field inputIndicator/numberOfLinesToBeReturned indicates the number of items selected in the search that are to be returned, if the screen display is exhausted, in other words if it exceeds this limit, there is a possibility to request to display the remainder of items. It is important to specify the profile type that you require to retrieve, in this case the value is 'C'.
Note: a similar name search is possible by entering a partial profile name, the search will still work. For example it is possible to enter "The New Amadeus Sw" even though the full name of the profile is "The New Amadeus Sweet Co".
See "Error Messages" section
Retrieve A List Of Traveler Profiles.
See "Error Messages" section
Access the next block of lines (i.e. next travelers in list)
See "Error Messages" section.
Retrieve a list of all company profiles.
See "Error Messages" section
Access the next block of lines (i.e. next company profiles in list)
See "Error Messages" section.
Retrieve a list of corporate travellers associated to a specific company.
See "Error Messages" section
Access the next block of lines (i.e. next travelers in list)
See "Error Messages" section.
This query demonstrates the retrieval of a staff profile, it is important to note that in the reply structure that the principal item returned is a record locator from the Amadeus system, the record locator that was used in the query (from the airline) is referred to as the staffNumber.
For example:
/travellerInformationSection/staffInformation/staff/staffIdentification/staffNumber
See "Error Messages" section
Retrieve staff profile with relatives.
See "Error Messages" section
The DeactivateProfile function allows you to reactivate and or deactivate a profile. This function can be performed on a Company, Traveler and or an Agency profile.
When a profile is selected for deactivation it is placed on a deactivated profile list for 30 days, if it is not reactivated within this timeframe then the profile is deleted from the system as well as from the deactivated profile list. When you deactivate a profile, the information is stored in profile history. This information includes the date, time, and agent sign of the agent making the deactivation entry.
Deactivating a profile removes a profile from the follow-up List, but does not delete the follow-up information stored in the profile. Once you have deactivated a profile, it can only be accessed later from the deactivated profile list.
You can not create:
The Powered Profile function allows for the following operations:
Deactivate a profile
Deactivate a profile
Re-activate a profile
Display the deactivated Profile list
Not applicable.
Not applicable.
An active profile that has not already been deactivated
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 utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
The following example shows the reply after requesting that a traveler profile is deactivated.
If the request was not successful, an error message will be returned indicating whether the error is an input error or a processing error.
| Code | Error Text | Description |
|---|---|---|
| 568 | ALREADY DEACTIVATED | This message is a result of trying to deactivate a Traveler profile that has already been deactivated. |
| 9265 | NO DEACTIVATED PROFILES LIST | This message is a result of the system not finding any deactivate profiles to display. |
| 9258 | ALREADY ACTIVE | This message is a result of trying to re-activate a Traveler profile. |
This example demonstrates the deactivation of a Traveler profile.
See "Error Messages" section
This example demonstrates the deactivation of a Company profile with zero Travelers associated to the profile.
The field value nAirlinessociatedTravelers in the reply shows the number of Travelers that are associated to an office that has been de-activated.
See "Error Messages" section
Re-activate a profile uses the same interface as the De-activate profile.
See "Error Messages" section
Re-activate a profile uses the same interface as the De-activate profile.
See "Error Messages" section
The List Deactivated Profile function allows you to view a list of deactivated Company and Traveler profiles.
Not applicable.
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 utilization. It is not a full explanation of every field that can be utilised for the operation, but rather a guideline to its use.
The following example shows a reply after requesting a deactivated profile list.
If the request was not successful, an error message will be returned indicating whether the error is an input error or a processing error.
| Code | Error Text | Description |
|---|---|---|
| 2644 | OFFICE ID NOT FOUND | This message is a result of trying to deactivate a profile without specifying the correct office ID |
| 29265 | NO DEACTIVATED PROFILES LIST | This message is a result of the system not finding any deactivate profiles to display. |
| 3357 | MANDATORY ITEMS | This message is a result of not entering the office ID in the request. |
This example demonstrates how to list deactivated profiles, this query selects both the Company and Traveler profiles that are deactivated for the office ID.
See "Error Messages" section