AirDocIssue

1.1 Functional Description

version:  2.38 

Functionality:

AirDocIssue.zip message examples

The purpose of this service is to pay for a previously created order and have the documents (ETKT, EMD) issued.

Although the AirDocIssue is a stateless method, it is mandatory to invoke OrderCreate to obtain an Order with Time Limit.

EndPoint:

Add = New

1.2 Request Body

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY FOR

PrimaryLangID

Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers.

2 alpha

EN

ES


Version

The IATA version of the message

numeric

any

Shema

<PointOfSale>

Location / CountryCode

Country code

2 alpha

List of countries

If toggle feature for market validation is activated.

<Document>(Schema)

ReferenceVersion

The IATA Schema version.

numeric

any

Schema
NAME DESCRIPTION FORMAT ALLOWED VALUES MANDATORY FOR

<Party>(Schema)

Sender / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 numeric

7 numbers

NDC Mandatory

Sender / AgencyID

Name of the Sender / Agency

alphanumeric

any

Schema

Participant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 numeric

7 numbers

Mandatory for schema if 'Participants' tag is indicated.

< Query > (Schema)

TicketDocQuantity

Number of tickets

Numeric

any

Schema
TicketDocInfo / TravelerInfo / EmailContact / Address Passenger email address contact information. alphanumeric any Mandatory for in case of credit card payment type.
TicketDocInfo / TravelerInfo / PhoneContact / Number Passenger phone number contact information. alphanumeric any Mandatory for in case of credit card payment type

TicketDocInfo / TravelerInfo / Surname

Passenger's surname

alphanumeric

any

Schema

TicketDocInfo / TravelerInfo / Given

Passenger's name

alphanumeric

any

Schema
EmailContact / Address Passenger's mail addres alphanumeric any Mandatory for in case of credit card payment type.
PhoneContact / Number Passenger's phone number numeric any Mandatory for in case of credit card payment type.

OrderID

Order ID

alphanumeric

any


TicketDocInfo / Payments / Payment / Type / Code

Code of payment

2 alpha

Forms of payment

Schema

TicketDocInfo / Payments / Payment / Amount

Total offer amount

Numeric

any


Method 

Payment Method, can be Cash for IATA Entities and Credit Card for non IATA .

In case of credit card payment the following elements are required:

  • TicketDocInfo / TravelerInfo / EmailContact / Address
  • TicketDocInfo / TravelerInfo / PhoneContact / Number

Payment format

any


1.3 Response Body (OrderViewRS)

NAME

DESCRIPTION

FORMAT

Nullable

< Passengers / Passenger>

ObjectKey (attribute)

Passenger Object Key

alphanumeric

False

 PTC

Passenger Type Code

3 alpha

False

 PassengerAssociation  Reference to Infant PassengerID  alphanumeric False

Passenger / Age / Birthdate

Birthdate of the passenger

Date

False

Passenger / Name / Surname

Surname of the passenger

alpha

False

Passenger / Name / Given

Name of the passenger

alphanumeric

False

Passenger / Name / Title

Title of the passenger (Mandatory for secure flights)

alpha

False

Passenger / Contacts / Contact / EmailContact / Address

Email address

alphanumeric

True

Passenger / Contacts / Contact / PhoneContact / Number

Number of the phone contact

alphanumeric

False
Contacts / Contact ContactType="Emergency" / PhoneContact / NumberAdd Phone number of emergency contact numeric
Contacts / Contact ContactType="Emergency" / Name / SurnameAdd Name of emergenvy contact

Gender

Gender of the passenger (Mandatory for Infants)

alphabetic

False

Remarks/Remark Additional Resident Discount Info alphabetic (message) True

Passenger / PassengerIDInfo / FOID / Type

Type of the passenger ID Info

2 alpha

False

Passenger / PassengerIDInfo / FOID / ID

ID of the passenger

alphanumeric

False

PassengerDocument / Type  Type of the passenger ID Info alphanumeric False
PassengerDocument / ID  Residence certificate number / Large Family certificate number alphanumeric False
PassengerDocument / ApplicabilityLocation  Municipality of residence / Community code for large family alphanumeric False

< Order >

OrderID

Order ID

alphanumeric

False

BookingReferences / BookingReference / ID

Order's Locator

alphanumeric

False

BookingReferences / BookingReference / Airline ID

Airline ID

2 alpha

False

TotalOrderPrice / DetailCurrencyPrice / Total

Total amount of the order

numeric

False

TotalOrderPrice / DetailCurrencyPrice / Taxes

Taxes amount

numeric

False

< Order / OrderItems / OrderItem >

OrderItemID

OrderItem ID

alphanumeric

False

< Order / OrderItems / OrderItem / FlightItem / Price >




BaseAmount

Attribute

Code="[CurrencyCode]"

Amount of the OrderItem.The suitable Code attribute provide the associated currency, though its code, in which the amount is expressed.

Example
<BaseAmount Code="EUR">260.45</BaseAmount>

 

numeric

False

 / Price / Taxes/Total

Attribute

Code="[CurrencyCode]"

Total amount of taxes and breakdown.

The suitable Code attribute provide the associated currency, though its code, in which the amount is expressed.

Example
<Total Code="EUR">59.91</Total>

numeric

False

<Order / OrderItems / OrderItem / FlightItem / Price / Taxes / BreakDown / Tax>
Attribute

Code="[CurrencyCode]"

Current tax amount.

The suitable Code attribute provide the associated currency, though its code, in which the amount is expressed.

Example
<Amount Code="EUR">15.75</Amount>
numeric False
/  Price / Taxes / BreakDown / Tax/ TaxCode The associated tax code which has been applied. alphanumeric False
<Order / OrderItems / OrderItem / FlightItem / OriginDestination>

OriginDestinatioKey

OriginDestination Key

alphanumeric

False

<Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight>

SegmentKey

Segment Key

alphanumeric

False

<Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / Departure>

AirportCode

Departure airport code

3 alpha

False

Date

Departure date

date

False

Time

Departure time

time

False

AirportName Airport Name City alphabetic False

Terminal

Departure Terminal number

number

True

<Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / Arrival>

 AirportCode

Arrival airport code

3 alpha

False

Date

Arrival date

date

False

Time

Arrival time

time

False

ChangeOfDay

Days between the departure and the arrival

numeric

True

Terminal

Arrival Terminal number

number

False

<Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / MarketingCarrier>

AirlineID

Airline ID of marketing carrier

2 alpha

False

Name

Airline name of marketing carrier

alphabetic

False

Flight number

Flight Number of marketing carrier

numeric

False

<Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / OperatingCarrier>

Airline ID

Airline ID of operating carrier

2 alpha

False

Name

Airline name of operating carrier

alphabetic

False

Flight number

Flight Number of marketing carrier

numeric

False

<Order / OrderItems / OrderItem / FlightItem / OriginDestination / Flight / OperatingCarrier / Disclosures / Description>

Text

Disclosures text

2 alpha

False

<Order / OrderItems / OrderItem / Associations / Passengers>

PassengerReferences

Passenger references of OrderItem

alphanumeric

False

<TicketDocInfos / TicketDocInfo / TicketDocument>

TicketDocNbr

Ticket number

numeric

True

Type / Code

Ticket code

3 alpha

True

 Number of Booklets

Number of tickets

numeric

True

 DateofIssue

Date of issue

date

True

 TimeOfIssue

Time of issue

time

True

<TicketDocInfos / TicketDocInfo>

Passenger Reference

Ticket Passenger Reference

alphanumeric

True

<Commisions>  

Percentage

Percentage of commision

Numeric

True

Amount

Amount of commision

Numeric

False

<DataLists / ServiceList >  
Service Service with mandatory ObjectKey alphabetic False
<DataLists / ServiceList / Service>
ServiceID Service ID with mandatory owner alphanumeric False
Name Service's name alphanumeric False
Descriptions / Description / Text Description of the service
Total Total amount of the service numeric False
Taxes Total taxes of the service numeric False
SSRCode SSR code alphabetic False

1.4 Error messages

NDC Standard allow errors and warnings to be returned inside an 200 OK response. Errors returned with 200 OK will always be controlled errors result of external limitations as "Max accepted non-infant passengers is 9".

The following codes are enclosed in the response returned with a 200 OK.

PADIS STATUS CODE

EXAMPLE MESSAGE ERROR

REASON

795

There's a mismatch between payment amount and total offer prices

Incorrect amount

486

Form of payment missing or invalid for ticket

Without payment

486

Full order must be paid/issued. Missing documents

Payment not included for everything

486

Form of payment missing or invalid for ticket/document

Payment must be for everything in the order.