Party Elements
- 1 Introduction
- 2 Section Elements
- 3 Examples:
- 3.1 1. TravelAgencySender with no Aggregator (Direct Connect):
- 3.2 2. TravelAgencySender with one or more Aggregators:
- 3.3 3. CorporateSender with TravelAgencyParticipant:
- 3.4 4. CorporateSender with just TravelAgencyParticipant:
- 3.5 5. CorporateSender with TravelAgencyParticipant and Aggregator Participant:
- 3.6 6. When using IATA Delegation
Introduction
The Party section of the messages can vary depending on the following scenarios:
The Seller/Sender (Travel Agent) is connected directly to Iberia’s NDC API
The Seller/Sender is using an Aggregator who is connected to Iberia’s NDC API
There is a Corporate involved which can occur in both scenarios one and two
The IATA Delegation functionality is being used, which can only be done with scenarios two and three
In the case whereby the Seller is connected directly to Iberia the last element with the AggregatorID is simply omitted from the message.
If one or more Aggregators are involved they are simply included in the Participant section.
When a Corporate is involved, and is identified as the Sender, then the Travel Agency becomes a participant, with or without an Aggregator participant depending on whether an Aggregator is involved.
Section Elements
Sender Section
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES | NDC SERVICES |
---|---|---|---|---|
<Party> | ||||
Sender / TravelAgencySender / Name | Agency Name Iberia will always use the Name stored in our system when the Seller/Sender registered to use our NDC. | Alphanumeric | Any | All Request messages and OrderViewRS |
Sender / TravelAgencySender / Contacts / Contact Attribute ContactType | Used to indicate to whom to send email confirmation emails and what information to include. More information can be found here | Only as per allowed values |
or
| All Request messages and OrderViewRS |
Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address | Email to contact the Travel Agency Mandatory for schema if 'EmailContact' tag is indicated. | Alphanumeric | Any | All Request messages and OrderViewRS |
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application
| To indicate whether the Travel Agency phone is a fixed line or mobile. | Only as per allowed values |
or
| All Request messages and OrderViewRS |
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number Attribute CountryCode | Phone number to contact the Travel Agency, with CountryCode. <Number CountryCode="+34">666666666</Number> | Numeric | Any valid telephone number with Country code. | All Request messages and OrderViewRS |
Sender / TravelAgencySender / Contacts / Contact / Name / Surname | The surname of the person to contact in the Travel Agency. Mandatory for schema if 'Name' tag is indicated. | Alphanumeric | Any | All Request messages and OrderViewRS |
Sender / TravelAgencySender / Contacts / Contact / Name / Given | The given name of the person to contact in the Travel Agency | Alphanumeric | Any | All Request messages and OrderViewRS |
Sender / TravelAgencySender / IATA_Number | Sender IATA identifier: IATA number (used by IATA accredited Travel Agents) TIDs number (recommended if you are not an IATA Accredited agent) If using the IATA Delegation functionality for Servicing orders, and no CorporateSender information is included in the message, then the Servicing IATA's number is included here. | Numeric | 7/8 Numbers | All Request messages and OrderViewRS |
Sender / TravelAgencySender / OtherIDs / OtherID | Pseudo IATA (assigned by Iberia) NDC Mandatory | Numeric | 7/8 Numbers | All Request messages and OrderViewRS |
Sender / TravelAgencySender / AgencyID | Presently, Iberia does not make use of this field. Mandatory for Schema. | Alphanumeric | Any | All Request messages and OrderViewRS |
Sender / CorporateSender / ID | ID for the Corporate. These are issued by Iberia and British Airways, and are sometimes referred to as a “JBID”. Not applicable to OrderList. NDC Mandatory | Alphanumeric | Identifier assigned by Iberia. | All Request messages and OrderViewRS |
Sender / ORA_Sender / AirlineID | Code of the Offer/Order Responsible Airline sending the message. Used in the OCN message. | Two Alphabetical Letters | IB | OrderChangeNotif |
Sender / ORA_Sender / Name | Name of the Offer/Order Responsible Airline sending the message. Used in the OCN message. | Alphabetical | Iberia | OrderChangeNotif |
Participant Section
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES | NDC SERVICES |
---|---|---|---|---|
<Party> | ||||
Participants / Participant / TravelAgencyParticipant / Name | Travel Agency Name. This is the Travel Agent who is registered with Iberia and British Airways as managing travel for the above Corporate. A validation check is run against our Sales database. | Alphanumeric | Any | All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation.
|
Participants / Participant / TravelAgencyParticipant / Type | Only when using IATA Delegation functionality. Mandatory for IATA Delegation when CorporateSender is used. This is used to indicate whether the TravelAgencyParticipant is the agency undertaking the Servicing or the agency that created or paid for the order. see example: Party Elements | Only as per allowed values |
or
| This element is returned in all services except: AirShopping OfferPrice OrderCreate OrderList |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact Attribute ContactType | Used to indicate to whom to send email confirmation emails and what information to include | Only as per allowed values |
or
| All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation. |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address | Email to contact the Agency | Alphanumeric | Any | All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation. |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application | To indicate whether the Travel Agency phone is a fixed line or mobile. | Only as per allowed values |
or
| All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation. |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number | Phone number to contact the Travel Agency | Numeric | Any | All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation. |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname | The surname of the person to contact in the Travel Agency. Mandatory for schema if 'Name' tag is indicated. | Alphanumeric | Any | All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation. |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given | The given name of the person to contact in the Travel Agency | Alphanumeric | Any | All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation. |
Participants / Participant / TravelAgencyParticipant
| Sequence number related to the Participants, irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below. | Numeric |
| All messages when there are more than one Participant. |
Participants / Participant / TravelAgencyParticipant / IATA_Number | The Travel Agency’s unique identifier: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) If using the IATA Delegation functionality for Servicing orders:
See examples below | 7/8 Numeric | The identifier registered with Iberia. | All Request messages, and OrderView when using CorporateSender. All Servicing Request messages (except OrderListRQ), and OrderView when using IATA Delegation. |
Participants / Participant / TravelAgencyParticipant / AgencyID
| Iberia do not presently use this field, although it is mandatory as per the schema. | Alphanumeric | Any | All Request messages. |
Participants / Participant / AggregatorParticipant | Sequence number related to the Participants irrespective of their type (TravelAgency, Aggregator, etc…), sent in the request. The order of the sequence number must follow the order in which the parties are connecting to our API. With the highest number being the party whose API key is being used to connect to us, and the lowest number (1) being the party in contact with the travelling passenger. See example 5 below. | Numeric |
| All Request messages. |
Participants / Participant / AggregatorParticipant / AggregatorID | The unique identifier of the Aggregator. This can be any of the following: IATA number (if you have one) TIDs number (recommended if you do not have an IATA) Pseudo IATA(assigned by Iberia and British Airways) | 7/8 Numeric | The identifier registered with Iberia. | This element is returned in all services except: OrderViewRS |
Participants / Participant / AggregatorParticipant / Name | The name of the Aggregator as stored in our database associated to the AggregatorID. following: | Alphanumeric | The name registered with Iberia. | This element is ONLY used and returned in the: OrderChangeNotification |
Recipient Section - (only for OCN message)
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES | NDC SERVICES |
---|---|---|---|---|
<Party> | ||||
Recipient / TravelAgencyRecipient / IATA_Number | Used in the OCN message to identify the IATA of the TravelAgency/Seller to whom this message is being directed. | 7/8 Numeric | N/A | OrderChangeNotification |
Recipient / TravelAgencyRecipient / AgencyID | Used in the OCN message to include the name, as per our database, of TravelAgency/Seller to whom this message is being directed. | Alphanumeric | N/A | OrderChangeNotification |
Examples:
1. TravelAgencySender with no Aggregator (Direct Connect):
2. TravelAgencySender with one or more Aggregators:
3. CorporateSender with TravelAgencyParticipant:
4. CorporateSender with just TravelAgencyParticipant:
5. CorporateSender with TravelAgencyParticipant and Aggregator Participant:
6. When using IATA Delegation
6.1. Example TravelAgencySender with Aggregator Participant:
6.2. Example CorporateSender with TravelAgencyParticipant and AggregatorParticipant:
UPDATE as of December 17, only people with an Iberia or IAGGBS account will be able to access them. Write to jira.support.ib@iberia.es and we will help you with the change. ACTUALIZACIÓN a partir del 17 de diciembre, sólo podrán acceder a ellas personas con cuenta de Iberia o IAGGBS. Escribe a jira.support.ib@iberia.es y te ayudaremos con el cambio.