21.3 IATA_OrderViewRS (Order Cancel Flow)
- Nadhiya S M (Unlicensed)
- Gopika R
User Guidance - Service Input Parameters | ||
Input Parameters | Type | Optional/Mandatory |
Request Object | IATA_OrderViewRS | M |
Â
<Response>
<PayloadAttributes>
<PaymentFunctions>
<PayloadAttributes> | ||
|---|---|---|
XML Example for the following elements<ns4:PayloadAttributes> | ||
Elements | Details | Mandatory/Optional |
PayloadAttributes | IATA payload standard attributes. | O |
VersionNumber | The version of the message | O |
<Response> | ||
|---|---|---|
Elements | Details | Mandatory/Optional |
Response | Order View RS response information. | M |
<DataLists> | ||
Elements | Details | Mandatory/Optional |
DataLists | Data List definition for this message. | O |
<ContactInfoList> | ||
<ns2:ContactInfoList> | ||
Elements | Details | Mandatory/Optional |
ContactInfoList | Contact info data list definition | O |
ContactInfo | The electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number. | M |
ContactInfoID | Â | M |
ContactPurposeText | Uniquely Identifies a set of Contact Information, | O |
EmailAddress | The email address which should be used for contact purposes. | O |
ContactTypeText | Uniquely Identifies a set of Contact Information | O |
EmailAddressText | The email address which should be used for contact purposes. | M |
Individual | A single human being as distinct from a group, class, or family. | O |
TitleName | A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender, profession or marital status. | O |
GivenName | A personal name given to the individual at birth and used before a family name. Also called first name. | O |
Surname | Individual's hereditary name(s) common to all members of a family. Also known as family name or last name. | M |
Phone | A telephone number | O |
ContactTypeText | PADIS code list | O |
CountryDialingCode | Numeric telephone dialing prefixes for the member countries of the International Telecommunication Union | O |
PhoneNumber | Phone number text | O |
PostalAddress | Natural or physical address used for postal service. | O |
StreetText | Street name and number | O |
PostalCode | Postal Code | O |
<DatedMarketingSegmentList> | ||
XML Example for the following elements<ns2:DatedMarketingSegmentList> Â Â Â Â Â Â Â Â Â Â Â Â </ns2:DatedMarketingSegment> | ||
Elements | Details | Mandatory/Optional |
DatedMarketingSegmentList | A list of dated marketing segments | O |
DatedMarketingSegment | The commercial designation under which a Dated Operating Segment can be booked, either under the operating carrier's designator or that of another carrier | M |
Arrival | Arrival Transport point location | M |
AircraftScheduledDateTime | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | O |
IATA_LocationCode | IATA 3-letter code defining the city or airport code. | M |
CarrierDesigCode | Airline code assigned to a carrier. | M |
DatedMarketingSegmentId | Unique identifier of a dated marketing segment | M |
DatedOperatingSegmentRefId | Reference to a unique identifier of a dated operating segment | M |
Dep | Departure Transport point Location | M |
<DatedOperatingLegList> | ||
XML Example for the following elements<ns2:DatedOperatingLegList> Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â <ns2:Arrival> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingLegList | A list of dated operating legs | O |
DatedOperatingLeg | The nonstop operation of a transport vehicle between the departure station and the arrival station | M |
Arrival | Arrival transport point location | M |
AircraftScheduledDateTime | The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport. | O |
IATA_LocationCode | IATA 3-letter code defining the city or airport code. | M |
DatedOperatingLegID | Uniquely identifies a leg | M |
Dep | Departure transport point location | M |
<DatedOperatingSegmentList> | ||
XML Example for the following elements<ns2:DatedOperatingSegmentList> Â Â Â Â Â Â Â Â Â Â Â Â Â Â <ns2:CarrierDesigCode>XQ</ns2:CarrierDesigCode> | ||
Elements | Details | Mandatory/Optional |
DatedOperatingSegmentList | A list of dated operating segments | O |
DatedOperatingSegment | An operation between board point and any subsequent off point within the same flight designator. Could be one or more legs | M |
CarrierDesigCode | Airline code assigned to a carrier | M |
DatedOperatingLegRefID | Uniquely identifies a leg | O |
DatedOperatingSegmentId | Unique identifier of a dated operating segment | M |
Duration | Total segment time including the combined air time and connection times of any legs | O |
<PaxJourneyList> | ||
XML Example for the following elements<ns2:PaxJourneyList> | ||
Elements | Details | Mandatory/Optional |
PaxJourneyList | Journey data list definition. | O |
PaxJourney | A collection of segments which satisfies transportation of a passenger for a given origin and destination. | M |
Duration | Total journey time including the combined air time and connection times. | O |
PaxJourneyID | Uniquely identifies a Passenger Journey. | M |
PaxSegmentRefID | Reference to a Passenger Segment ID | M |
<PaxList> | ||
XML Example for the following elements <ns2:PaxList> | ||
Elements | Details | Mandatory/Optional |
PaxList | Passenger data list definition | O |
Pax | Any person except members of the crew carried or to be carried with the consent of the carrie | M |
Individual | A single human being as distinct from a group, class, or family. | O |
Birthdate | Birth date | O |
GenderCode | Gender of the individual | O |
GivenName | A personal name given to the individual at birth and used before a family name. | O |
Surname | Individual's hereditary name(s) common to all members of a family. | M |
TitleName | A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender, profession or marital status | O |
LangUsage | Language Code representation. | O |
LangCode | Language Code representation. | M |
LangUsageText | Written or Spoken language. | O |
PaxID | Uniquely identifies a Passenger | M |
PTC | Type code applying to the Passenger | O |
<PaxSegmentList> | ||
XML Example for the following elements<ns2:PaxSegmentList> | ||
Elements | Details | Mandatory/Optional |
PaxSegmentList | Segment data list definition. | O |
PaxSegment | Transportation of a passenger on a Dated Operating Segment. | M |
CabinTypeAssociationChoice | A choice of Cabin Type Association to leg(s) or a segment | O |
SegmentCabinType | Type of compartment of an aircraft, offering specific services | M |
CabinTypeCode | Cabin Type Code as defined by ATSB codeset 9873. | O |
CabinTypeName | Name given to a cabin compartment | O |
DatedMarketingSegmentRefId | A reference to a unique identifier of a dated marketing segment | M |
MarketingCarrierRBD_Code | Code used to identify a particular RBDÂ | O |
PaxSegmentID | Uniquely identifies a Passenger Segment | M |
<Order> | ||
Elements | Details | Mandatory/Optional |
Order | A uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions. | M |
CreationDateTime | The date time by which the order is created. | O |
LastModifiedDateTime | The date time by which the order is modified. | O |
OrderID | Carrier assigned ID which uniquely identifies a specific Order across several messages. | M |
OwnerCode | Airline code assigned to a carrier. | M |
StatusCode | Status of the Order Status instance. | O |
<OrderItem> | ||
Elements | Details | Mandatory/Optional |
OrderItem | An Ordered individually priced item within an Ordered Order, made up of one or more Services. | M |
CreationDateTime | Order Item creation Timestamp. | O |
OrderItemID | Carrier assigned ID which exists uniquely within an Offer. | M |
OwnerCode | Airline code assigned to a carrier. | M |
StatusCode | Status of the Order Item Status instance. | O |
<Service> | ||
XML Example for the following elements <!--1 or more repetitions:--> | ||
Elements | Details | Mandatory/Optional |
Service | Ordered Service is the instance of a specific flight or Service Definition as it has been offered. | M |
OrderServiceAssociation | Order Service Association. | M |
PaxSegmentRef | Reference to a PaxSegmentID . | M |
PaxSegmentRefID | Reference to a PaxSegmentID | M |
PaxRefID | Reference to a Passenger ID. | M |
ServiceID | Uniquely Identifies a Service . | M |
StatusCode | Status of the Order Status instance. | O |
<PaymentFunctions> | ||
Elements | Details | Mandatory/Optional |
PaymentFunctions | Information related to the settlement of a transaction through monetary or other compensations. | O |
<PaymentProcessingSummary> | Â | Â |
XML Example for the following elements <ns2:PaymentProcessingSummary> | ||
Elements | Details | Mandatory/Optional |
PaymentProcessingSummary | Information relating to a payment transaction including payment status. | O |
Amount | The amount applied to the associated payment method. | M |
PaymentCommitmentDateTime | The date when the Payment including information about amount and payment method is accepted by ORA to be enough to lead to successful payment. | O |
PaymentID | Uniquely identifies payment information. | M |
PaymentRefID | If creating the order after payment authorization it is a way of linking an order to an existing payment reference. | O |
PaymentStatusCode | Indicates the current status of this payment information. | O |
<PaymentSupportedMethod> | Â | Â |
XML Example for the following elements <ns2:PaymentSupportedMethod> | ||
PaymentSupportedMethod | Contains information relating to payment method acceptance. | O |
PaymentTypeCode | A Payment Type code assigned according to ATS Codeset PAYT | M |