KIU_PurchaseItemRQ/RS
Functionality:
This method allow users to issue EMD-S (Electronic Miscellaneous document - Standalone). This documents works as a ticket and allow users to offer final consumers, air extras services.
KIU_PurchaseItemRQ
Request model.
<KIU_PurchaseItemRQ EchoToken="1" TimeStamp="2015-11-04T12:45:57-03:00" Target="Testing" Version="3.0" SequenceNmbr="1" PrimaryLangID="en-us" ForceIssue="true"> <POS> <Source AgentSine="AEP00XXSM" TerminalID="AEP00XX816"> <RequestorID Type="5" /> <BookingChannel Type="1" /> </Source> </POS> <Orders CarrierCode="XX"> <Order> <Products> <Product ProductID="D98F" ProductIssueDate="2015-11-30" LocationCode="BUE" Amount="1200.00" CurrencyCode="ARS" /> <Product ProductID="D98J" ProductIssueDate="2015-11-30" LocationCode="BUE" Amount="500.00" CurrencyCode="ARS" /> </Products> <Taxes> <Tax TaxCode="AR" Amount="120.00" /> <Tax TaxCode="DL" Amount="45.00" /> </Taxes> </Order> </Orders> <PaymentInformation PaymentType="5"> <PaymentCard CardType="1" CardCode="VI" CardNumber="4242424242424242" SeriesCode="123" ExpireDate="1213" /> <FiscalCode>123456789</FiscalCode> <Endorsement Text="ENDOSO" /> </PaymentInformation> <RecipientInfos> <RecipientInfo> <PersonName> <GivenName>JUAN</GivenName> <Surname>PEREZ</Surname> </PersonName> <Document DocID="123456789" DocType="NI" /> </RecipientInfo> </RecipientInfos> <Comments> <Comment> <Text>COMENTARIO</Text> </Comment> </Comments> </KIU_PurchaseItemRQ>
<KIU_PurchaseItemRQ EchoToken="1" TimeStamp="2015-11-04T12:45:57-03:00" Target="Testing" Version="3.0" SequenceNmbr="1" PrimaryLangID="en-us" ForceIssue="true"> <POS> <Source AgentSine="AEP00XXSM" TerminalID="AEP00XX818"> <RequestorID Type="5" /> <BookingChannel Type="1" /> </Source> </POS> <Orders CarrierCode="XX"> <Order> <Products> <Product ProductID="E0BX" ProductIssueDate="2019-01-03" LocationCode="BUE" Amount="1200.00" CurrencyCode="ARS" /> </Products> <Taxes> <Tax TaxCode="AR" Amount="120.00" /> <Tax TaxCode="DL" Amount="45.00" /> </Taxes> <TicketItemInfo TicketNumber="9990210003329" CouponNumber="1" /> </Order> </Orders> <PaymentInformation PaymentType="5"> <PaymentCard CardType="1" CardCode="VI" CardNumber="4242424242424242" SeriesCode="123" ExpireDate="1219" /> <FiscalCode>123456789</FiscalCode> <Endorsement Text="ENDOSO" /> </PaymentInformation> <RecipientInfos> <RecipientInfo RPH="1" /> </RecipientInfos> <Comments> <Comment> <Text>COMENTARIO</Text> </Comment> </Comments> <UniqueID ID="BCECPI" /> </KIU_PurchaseItemRQ>
Components of KIU_PurchaseItemRQ:
EchoToken: Attribute. xs:string. Required. Enable users to adopt a session identification for log purposes.Â
TimeStamp: Attribute. xs:datetimestamp. Date time of origin request.Â
Target: Attribute. List [Production|Testing]. Indicate the environment to execute the method.
Version: Attribute. Decimal. Number of version of the method implemented and published by KIU System.
SequenceNmbr: Attribute. Required. Always match 1. It is normally used for synchronous messages. To be implemented in future.
PrimaryLangID: Attribute. Responsive language of API.Â
ForceIssue: Attribute. Boolean [true|false]. Optional.. In case of true it will force the execution of the action. The default value is false.
POS:Â Element. ComplexType. Required. Information about the point of sale that originate the request.Â
Source:Â Element. ComplexType. Required. Contain the data of POS.
AgentSine: Attribute. Required. Alphanumeric[9]. Agent identification code.
TerminalID: Attribute. Required. Alphanumeric[10]. Identification code of valid KIU Device that makes the request.Â
Orders:Â Element. Complex type. Contain the detail of query for an EMD-S issues. It contain the list of Order to process.
CarrierCode:Â Attribute. Optional. Alphanumeric[2]. Airline IATA code.It should be used by travel agencies.
Order:Â Element. ComplexType. MinOccurs=1. It group the detail of each EMD to be processed.
Products: Element. Complex Type. Required. Only one product by order is supported.
Product:Â Element. Complex Type. MinOccurs=1|MaxOccurs=4. Contain the detail of each item to be process. It Product represent a coupon of the EMD-S. No further than 4 by document.
ProductID:Â Attribute. Alphanumeric[4]. Required. Identification code of the product to be issue from the TMP* table.Â
ProductIssueDate:Â Attribute. Alphanumeric. xs:date. Optional. Date of consume EMD. Some product required mandatory and some must not be present. Please verify conditions of each code on TMP*.
LocationCode:Â Attribute. Alphabetical[3]. Optional. Airport code where the product is consumed. Some codes Must be present on other Must not, please verify conditions of each code on TMP*.
Amount:Â Attribute. Decimal. Required. Amount of service code.Â
CurrencyCode:Â Attribute. Alphabetical[3]. ISO currency code of printed documento. It has been the same for all product to be processed.
Taxes:Â Element. Complex Type. Opcional. Group a list of taxes to be applied on the EMDs document.
Tax:Â Element. ComplexType. Contain the singular description of tax item to apply.
TaxCode:Â Attribute. Alphanumeric[2]. Identification code of tax to apply.
Amount:Â Attribute. Decimal. Amount of tax.
TicketItemInfo:Â Element. Complex type. Optional. Hold the information of a ticket to be associated to EMDs Document.Â
TicketNumber:Â Attribute. Integer[13]. Required. Ticket number to be associated to EMDs document.Â
CouponNumber:Â Attribute. Integer. Required. Coupon number to associate with the EMDs document.
PaymentInformation:Â Element. ComplexType. Contain information of form of payment for the EMDs document.
PaymentType:Â Attribute. Integer. OTA code to identify the form of payment based on the OpenTravel Code List Payment Type (1: Cash, 5: Credit Card, 6: Debit Card, 7: Check, 34: Invoice, 37: Miscellaneous).
PaymentCard:Â Element. ComplexType. Optional. This element is required with the paymentType 5 and 6. Contain the details of payment card.
CardType:Â Attribute. Integer. Required. OTA Code to identify the type of card to be used from OpenTravel Code List Card Type (1: credit, 2: debit).
CardCode:Â Attribute. Alphabetical[2-3].Required. Code of payment card. (VI, AX, EL, MC, CA, IK).
CardNumber:Â Attribute. Integer[14-16]. Required. Number of payment card.Â
SeriesCode:Â Attribute. Integer.[3-4]. Required. CVS or security card code. It should be required for PaymentType 5.
ExpireDate:Â Attribute. Integer[4]. Expiration date of Credit card.Â
- ApprovalCode: Attribute. Integer[6-10]. Approval code for the card payment debit.Â
ChequeNumber:Â Attribute. Integer. Optional. Check number. It should be present with paymentType 7.
InvoiceCode:Â Attribute. Alphanumeric. Optional. Code of corporate account to be used in case of paymentType=34.
MiscellaneousCode:Â Attribute. Alphabetical[2]. Misc code for payment type 37.
FiscalCode:Â Element. SimpleType. Integer. Optional. Fiscal identification key of customer to purchase the EMDs document.Â
Endorsement:Â Element. ComplexType. Optional. Regarding endorsment text box of the EMDs Document.
Text:Â Attribute. xs:string[50]. Required. Specify the text to be entered on the endorsement box of EMDs document.
RecipientInfos:Â Element. ComplexType. Required. Group the information regarding passenger to be issue.
RecipientInfo:Â Element. ComplexType. Required.Contain the identification of each passenger.Â
RPH: Attribute. Integer. Optional. Order number of passenger into the list of passenger of PNR. UniqueID (ver más abajo), caso contrario será desestimado. This element is mandatory in case of UniqueID that is used to process a reservation.
PersonName:Â Element. ComplexType. Optional. It is used to enter passenger data in case the issue of EMDs document is outside a PNR. (Not UniqueID declared).
GivenName: Element. SimpleType. Alphabetical [30]. Passenger´s names.
Surname: Element. Alphabetical[18]. Passenger´s last name.
Document:Â Element. ComplexType. Required. Contain the information of the passenger identification, type and ID.
DocID:Â Attribute. Alfphanumeric[46]. Identification ID of passenger.
DocType:Â Attribute. List. Type of identification document. (NI: National Identity Document, PP: Passport, ID: Locally defined ID number) .
Comments:Â Element. ComplexType. Optional. Element that contain the information of remarks associated with the purchase of EMDs documento.Â
Comment:Â Element. ComplexType. Required. Contain a single remark.
Text:Â Attribute. xs:string[100]. Text to be entered as remark into the EMD-s Document.
UniqueID:Â Element. ComplexType. Optional. Contain the information of PNR to be associate to the EMDs document.
ID:Â Attribute. Alphabetical[6]. Required. Record locator for KIU SYSTEM that identifies a reservation.
KIU_PurchaseItemRS
Example of response
<?xml version="1.0" encoding="UTF-8"?> <KIU_PurchaseItemRS EchoToken="1" TimeStamp="2015-11-04T12:45:57-03:00" Target="Testing" Version="3.0" SequenceNmbr="1"> <Success /> <Orders OrderID="9995570005038" /> </KIU_PurchaseItemRS>
Components of KIU_PurchaseItemRS:
- Orders: Element. Complex type. Group the data of documents issued by each set of products required.
- OrderID:Â Attribute. Integer[13]. Number of EMD-S issued.
Possible error messages:
Code | Message |
10047 | Only one currency is allowed for all Products. |
10048 | All Comments cannot be over 100 characters. |
11020 | Error at parameter GivenName. |
11021 | Error at parameter SurName. |
11023 | Error at parameter PaymentType. |
11026 | Error at parameter Endorsement. |
11031 | Error at parameter Document ID. |
11039 | Error at parameter PNR. |
11040 | Error at parameter Ticket Number. |
11042 | Error at parameter Document Type. |
11056 | Error at parameter RPH. |
Code | Message |
11059 | Error at parameter Text. |
11070 | Error at parameter CardCode. |
11076 | Error at parameter tax Amount. |
11077 | Error at parameter tax Code. |
11078 | Error at parameter CardNumber. |
11079 | Error at parameter CardType. |
11080 | Error at parameter SeriesCode. |
11081 | Error at parameter ExpireDate. |
11082 | Error at parameter InvoiceCode. |
11083 | Error at parameter MiscellaneousCode. |
11102 | Error at parameter CurrencyCode. |
11103 | Error at parameter CouponNumber. |
Code | Message |
11104 | Error at parameter ChequeNumber. |
11105 | Error at parameter FiscalCode. |
11106 | Error at parameter ForceIssue |
12002 | The PNR does not correspond with an active reservation. |
12007 | There are no more available areas for operation. Please try again. |
12008 | The supplied AgentSine does not have the proper duties for this action. |
12017 | At least one of the requested Product Code is not supported. |
12018 | The ProductIssueDate parameter is mandatory for at least one of the requested Product Code. |
12019 | The requested Product Codes combination is not supported. |
12020 | The LocationCode parameter is mandatory for at least one of the requested Product Code. |
12021 | At least one of the requested ProductIssueDate is out of the range supported by the airline. |
12022 | The Carrier does not support the selected form of payment. |
12023 | At least one of the requested Product can only be issued with flown status. |
12024 | The requested Ticket number could not be found. |
Code | Message |
12025 | The requested Coupon number could not be found. |
12026 | At least one of the requested Product does not allow a ProductIssueDate. |
12027 | The ExpiredDate of the provided PaymentCard is invalid. |
12028 | The CardCode of the provided PaymentCard is invalid. |