Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Properties
Source
Used by
Main schema DocumentListRQ.xsd
Namespace No namespace
Properties
attribute form default: unqualified
element form default: qualified
[ top ]
Element DocumentListRQ
Namespace No namespace
Annotations
root level of DocumentList message.

Response is an item list if one or more matching tickets are found.
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_SearchParameters
Properties
content: complex
Model SearchParameters
Children SearchParameters
Instance
<DocumentListRQ>
  <SearchParameters Source="">{1,1}</SearchParameters>
</DocumentListRQ>
Source
<xsd:element name="DocumentListRQ">
  <xsd:annotation>
    <xsd:documentation>root level of DocumentList message. Response is an item list if one or more matching tickets are found.</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="SearchParameters">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="Location">
              <xsd:annotation>
                <xsd:documentation>Agency IATA ID and PCCs to include in the query</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="IATA">
                    <xsd:annotation>
                      <xsd:documentation>Agency IATA ID Mandatory and highest search level Example: 10834257</xsd:documentation>
                    </xsd:annotation>
                    <xsd:complexType>
                      <xsd:simpleContent>
                        <xsd:extension base="xsd:string">
                          <xsd:attribute name="AllPCCs">
                            <xsd:annotation>
                              <xsd:documentation>Y = will include all PCCs under specified IATA number to be included in query</xsd:documentation>
                            </xsd:annotation>
                          </xsd:attribute>
                        </xsd:extension>
                      </xsd:simpleContent>
                    </xsd:complexType>
                  </xsd:element>
                  <xsd:element name="PCC" minOccurs="0" maxOccurs="unbounded">
                    <xsd:annotation>
                      <xsd:documentation>List of all PCCs belonging to this IATA ID and to be included in this query</xsd:documentation>
                    </xsd:annotation>
                    <xsd:complexType>
                      <xsd:simpleContent>
                        <xsd:extension base="xsd:string">
                          <xsd:attribute name="AgentID">
                            <xsd:annotation>
                              <xsd:documentation>If entered only the transactions issued by this agent ID will be included</xsd:documentation>
                            </xsd:annotation>
                          </xsd:attribute>
                        </xsd:extension>
                      </xsd:simpleContent>
                    </xsd:complexType>
                  </xsd:element>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
            <xsd:choice minOccurs="0">
              <xsd:element name="TravelerName">
                <xsd:annotation>
                  <xsd:documentation>If included will search for tickets belonging to this particular passenger</xsd:documentation>
                </xsd:annotation>
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="Surname">
                      <xsd:annotation>
                        <xsd:documentation>Traveler family (last) name. Example: SMITH</xsd:documentation>
                      </xsd:annotation>
                      <xsd:simpleType>
                        <xsd:restriction base="xsd:string">
                          <xsd:minLength value="1"/>
                        </xsd:restriction>
                      </xsd:simpleType>
                    </xsd:element>
                    <xsd:element name="GivenName">
                      <xsd:annotation>
                        <xsd:documentation>Traveler given (first) name. Example: JOHN</xsd:documentation>
                      </xsd:annotation>
                      <xsd:simpleType>
                        <xsd:restriction base="xsd:string">
                          <xsd:minLength value="1"/>
                        </xsd:restriction>
                      </xsd:simpleType>
                    </xsd:element>
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
              <xsd:element ref="FrequentTravelerGroup"/>
            </xsd:choice>
            <xsd:element name="Carrier" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>Carrier group identifying the validating carriers for the tickets to be included in the search The validating carrier(s) here determine the source of the document issuing system, e.g. AA, EK</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="ValidatingCarrier" minOccurs="0" maxOccurs="unbounded">
                    <xsd:annotation>
                      <xsd:documentation>Validating carrier code (IATA 2-letter airline code). Example: AA</xsd:documentation>
                    </xsd:annotation>
                    <xsd:simpleType>
                      <xsd:restriction base="xsd:string">
                        <xsd:length value="2"/>
                      </xsd:restriction>
                    </xsd:simpleType>
                  </xsd:element>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
            <xsd:element name="DocParameters" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>If this parameter is used, status and type must be provided, coupon status is optional</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="Type">
                    <xsd:annotation>
                      <xsd:documentation>Allowed values: TKTT (ETkt) Y (EMD-A) J (EMD-S) M (MCO,VMD)</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                  <xsd:element name="DocumentStatus">
                    <xsd:annotation>
                      <xsd:documentation>Values depend on specified type and are currently as follows: for TKTT (E-Tkt) "Ticketed" "TICKETED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED" for EMD "Issued" "ISSUED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED"</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                  <xsd:element name="IssueDates">
                    <xsd:annotation>
                      <xsd:documentation>Establishes the start and end date of the query as it relates to the "TicketIssueDate" as found in: TicketImage/TicketIdentification/TicketIssueDate If not provided the search will go back 365 days from current date.</xsd:documentation>
                    </xsd:annotation>
                    <xsd:complexType>
                      <xsd:sequence>
                        <xsd:element name="StartDate">
                          <xsd:annotation>
                            <xsd:documentation>the earliest date of issuance. Only tickets issued on a date equal or higher (after) than this date will be included.</xsd:documentation>
                          </xsd:annotation>
                        </xsd:element>
                        <xsd:element name="EndDate">
                          <xsd:annotation>
                            <xsd:documentation>the last date of issuance. Only tickets issued on a date equal or less (prior) than this date will be included.</xsd:documentation>
                          </xsd:annotation>
                        </xsd:element>
                      </xsd:sequence>
                    </xsd:complexType>
                  </xsd:element>
                  <xsd:element name="FCICode" minOccurs="0">
                    <xsd:annotation>
                      <xsd:documentation>If entered only the transactions carrying the specified FCI code will be included Allowed values: 0 = auto priced 1 = manually priced</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
            <xsd:element name="CouponParameters" minOccurs="0">
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="CouponStatus" minOccurs="0">
                    <xsd:annotation>
                      <xsd:documentation>Sample values are: O = Open for use E = Exchanged/Reissued F = Flown/Used V = Void R = Refunded, and others</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                  <xsd:element name="TravelDates" minOccurs="0">
                    <xsd:annotation>
                      <xsd:documentation>Establishes the start and end date of the query as it relates to the Travel Dates as found by looping through all coupons: TicketImage/Itinerary/TicketCoupon/Flight/Departure + Arrival nodes</xsd:documentation>
                    </xsd:annotation>
                    <xsd:complexType>
                      <xsd:sequence>
                        <xsd:element name="StartDate" minOccurs="0">
                          <xsd:annotation>
                            <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or HIGHER (after) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
                          </xsd:annotation>
                        </xsd:element>
                        <xsd:element name="EndDate" minOccurs="0">
                          <xsd:annotation>
                            <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or LOWER (prior) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
                          </xsd:annotation>
                        </xsd:element>
                      </xsd:sequence>
                    </xsd:complexType>
                  </xsd:element>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
          </xsd:sequence>
          <xsd:attribute name="Source" use="required">
            <xsd:annotation>
              <xsd:documentation>Airline or GDS hosting the ticket database Example: 1S</xsd:documentation>
            </xsd:annotation>
          </xsd:attribute>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters
Namespace No namespace
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_Source DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_Location DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_TravelerName DocumentListRQ.tmp#FrequentTravelerGroup DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_Carrier DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_CouponParameters
Properties
content: complex
Model Location , (TravelerName | FrequentTravelerGroup) , Carrier{0,1} , DocParameters{0,1} , CouponParameters{0,1}
Children Carrier, CouponParameters, DocParameters, FrequentTravelerGroup, Location, TravelerName
Instance
<SearchParameters Source="">
  <Location>{1,1}</Location>
  <TravelerName>{1,1}</TravelerName>
  <FrequentTravelerGroup>{1,1}</FrequentTravelerGroup>
  <Carrier>{0,1}</Carrier>
  <DocParameters>{0,1}</DocParameters>
  <CouponParameters>{0,1}</CouponParameters>
</SearchParameters>
Attributes
QName Type Fixed Default Use Annotation
Source required
Airline or GDS hosting the ticket database 
Example: 1S
Source
<xsd:element name="SearchParameters">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="Location">
        <xsd:annotation>
          <xsd:documentation>Agency IATA ID and PCCs to include in the query</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="IATA">
              <xsd:annotation>
                <xsd:documentation>Agency IATA ID Mandatory and highest search level Example: 10834257</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:simpleContent>
                  <xsd:extension base="xsd:string">
                    <xsd:attribute name="AllPCCs">
                      <xsd:annotation>
                        <xsd:documentation>Y = will include all PCCs under specified IATA number to be included in query</xsd:documentation>
                      </xsd:annotation>
                    </xsd:attribute>
                  </xsd:extension>
                </xsd:simpleContent>
              </xsd:complexType>
            </xsd:element>
            <xsd:element name="PCC" minOccurs="0" maxOccurs="unbounded">
              <xsd:annotation>
                <xsd:documentation>List of all PCCs belonging to this IATA ID and to be included in this query</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:simpleContent>
                  <xsd:extension base="xsd:string">
                    <xsd:attribute name="AgentID">
                      <xsd:annotation>
                        <xsd:documentation>If entered only the transactions issued by this agent ID will be included</xsd:documentation>
                      </xsd:annotation>
                    </xsd:attribute>
                  </xsd:extension>
                </xsd:simpleContent>
              </xsd:complexType>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
      <xsd:choice minOccurs="0">
        <xsd:element name="TravelerName">
          <xsd:annotation>
            <xsd:documentation>If included will search for tickets belonging to this particular passenger</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Surname">
                <xsd:annotation>
                  <xsd:documentation>Traveler family (last) name. Example: SMITH</xsd:documentation>
                </xsd:annotation>
                <xsd:simpleType>
                  <xsd:restriction base="xsd:string">
                    <xsd:minLength value="1"/>
                  </xsd:restriction>
                </xsd:simpleType>
              </xsd:element>
              <xsd:element name="GivenName">
                <xsd:annotation>
                  <xsd:documentation>Traveler given (first) name. Example: JOHN</xsd:documentation>
                </xsd:annotation>
                <xsd:simpleType>
                  <xsd:restriction base="xsd:string">
                    <xsd:minLength value="1"/>
                  </xsd:restriction>
                </xsd:simpleType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
        <xsd:element ref="FrequentTravelerGroup"/>
      </xsd:choice>
      <xsd:element name="Carrier" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>Carrier group identifying the validating carriers for the tickets to be included in the search The validating carrier(s) here determine the source of the document issuing system, e.g. AA, EK</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="ValidatingCarrier" minOccurs="0" maxOccurs="unbounded">
              <xsd:annotation>
                <xsd:documentation>Validating carrier code (IATA 2-letter airline code). Example: AA</xsd:documentation>
              </xsd:annotation>
              <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                  <xsd:length value="2"/>
                </xsd:restriction>
              </xsd:simpleType>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
      <xsd:element name="DocParameters" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>If this parameter is used, status and type must be provided, coupon status is optional</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="Type">
              <xsd:annotation>
                <xsd:documentation>Allowed values: TKTT (ETkt) Y (EMD-A) J (EMD-S) M (MCO,VMD)</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <xsd:element name="DocumentStatus">
              <xsd:annotation>
                <xsd:documentation>Values depend on specified type and are currently as follows: for TKTT (E-Tkt) "Ticketed" "TICKETED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED" for EMD "Issued" "ISSUED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED"</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <xsd:element name="IssueDates">
              <xsd:annotation>
                <xsd:documentation>Establishes the start and end date of the query as it relates to the "TicketIssueDate" as found in: TicketImage/TicketIdentification/TicketIssueDate If not provided the search will go back 365 days from current date.</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="StartDate">
                    <xsd:annotation>
                      <xsd:documentation>the earliest date of issuance. Only tickets issued on a date equal or higher (after) than this date will be included.</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                  <xsd:element name="EndDate">
                    <xsd:annotation>
                      <xsd:documentation>the last date of issuance. Only tickets issued on a date equal or less (prior) than this date will be included.</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
            <xsd:element name="FCICode" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>If entered only the transactions carrying the specified FCI code will be included Allowed values: 0 = auto priced 1 = manually priced</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
      <xsd:element name="CouponParameters" minOccurs="0">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="CouponStatus" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>Sample values are: O = Open for use E = Exchanged/Reissued F = Flown/Used V = Void R = Refunded, and others</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <xsd:element name="TravelDates" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>Establishes the start and end date of the query as it relates to the Travel Dates as found by looping through all coupons: TicketImage/Itinerary/TicketCoupon/Flight/Departure + Arrival nodes</xsd:documentation>
              </xsd:annotation>
              <xsd:complexType>
                <xsd:sequence>
                  <xsd:element name="StartDate" minOccurs="0">
                    <xsd:annotation>
                      <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or HIGHER (after) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                  <xsd:element name="EndDate" minOccurs="0">
                    <xsd:annotation>
                      <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or LOWER (prior) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
                    </xsd:annotation>
                  </xsd:element>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
    <xsd:attribute name="Source" use="required">
      <xsd:annotation>
        <xsd:documentation>Airline or GDS hosting the ticket database Example: 1S</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / Location
Namespace No namespace
Annotations
Agency IATA ID and PCCs to include in the query
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_Location_IATA DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_Location_PCC
Properties
content: complex
Model IATA , PCC*
Children IATA, PCC
Instance
<Location>
  <IATA AllPCCs="">{1,1}</IATA>
  <PCC AgentID="">{0,unbounded}</PCC>
</Location>
Source
<xsd:element name="Location">
  <xsd:annotation>
    <xsd:documentation>Agency IATA ID and PCCs to include in the query</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="IATA">
        <xsd:annotation>
          <xsd:documentation>Agency IATA ID Mandatory and highest search level Example: 10834257</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:simpleContent>
            <xsd:extension base="xsd:string">
              <xsd:attribute name="AllPCCs">
                <xsd:annotation>
                  <xsd:documentation>Y = will include all PCCs under specified IATA number to be included in query</xsd:documentation>
                </xsd:annotation>
              </xsd:attribute>
            </xsd:extension>
          </xsd:simpleContent>
        </xsd:complexType>
      </xsd:element>
      <xsd:element name="PCC" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>List of all PCCs belonging to this IATA ID and to be included in this query</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:simpleContent>
            <xsd:extension base="xsd:string">
              <xsd:attribute name="AgentID">
                <xsd:annotation>
                  <xsd:documentation>If entered only the transactions issued by this agent ID will be included</xsd:documentation>
                </xsd:annotation>
              </xsd:attribute>
            </xsd:extension>
          </xsd:simpleContent>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / Location / IATA
Namespace No namespace
Annotations
Agency IATA ID

Mandatory and highest search level

Example: 10834257
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_Location_DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_Location_IATA_AllPCCs
Type extension of xsd:string
Properties
content: complex
Attributes
QName Type Fixed Default Use Annotation
AllPCCs optional
Y = will include all PCCs under specified IATA number to be included in query
Source
<xsd:element name="IATA">
  <xsd:annotation>
    <xsd:documentation>Agency IATA ID Mandatory and highest search level Example: 10834257</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:simpleContent>
      <xsd:extension base="xsd:string">
        <xsd:attribute name="AllPCCs">
          <xsd:annotation>
            <xsd:documentation>Y = will include all PCCs under specified IATA number to be included in query</xsd:documentation>
          </xsd:annotation>
        </xsd:attribute>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / Location / PCC
Namespace No namespace
Annotations
List of all PCCs belonging to this IATA ID and to be included in this query
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_Location_DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_Location_PCC_AgentID
Type extension of xsd:string
Properties
content: complex
minOccurs: 0
maxOccurs: unbounded
Attributes
QName Type Fixed Default Use Annotation
AgentID optional
If entered only the transactions issued by this agent ID will be included
Source
<xsd:element name="PCC" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation>List of all PCCs belonging to this IATA ID and to be included in this query</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:simpleContent>
      <xsd:extension base="xsd:string">
        <xsd:attribute name="AgentID">
          <xsd:annotation>
            <xsd:documentation>If entered only the transactions issued by this agent ID will be included</xsd:documentation>
          </xsd:annotation>
        </xsd:attribute>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / TravelerName
Namespace No namespace
Annotations
If included will search for tickets belonging to this particular passenger
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_TravelerName_Surname DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_TravelerName_GivenName
Properties
content: complex
Model Surname , GivenName
Children GivenName, Surname
Instance
<TravelerName>
  <Surname>{1,1}</Surname>
  <GivenName>{1,1}</GivenName>
</TravelerName>
Source
<xsd:element name="TravelerName">
  <xsd:annotation>
    <xsd:documentation>If included will search for tickets belonging to this particular passenger</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="Surname">
        <xsd:annotation>
          <xsd:documentation>Traveler family (last) name. Example: SMITH</xsd:documentation>
        </xsd:annotation>
        <xsd:simpleType>
          <xsd:restriction base="xsd:string">
            <xsd:minLength value="1"/>
          </xsd:restriction>
        </xsd:simpleType>
      </xsd:element>
      <xsd:element name="GivenName">
        <xsd:annotation>
          <xsd:documentation>Traveler given (first) name. Example: JOHN</xsd:documentation>
        </xsd:annotation>
        <xsd:simpleType>
          <xsd:restriction base="xsd:string">
            <xsd:minLength value="1"/>
          </xsd:restriction>
        </xsd:simpleType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / TravelerName / Surname
Namespace No namespace
Annotations
Traveler family (last) name.
Example: SMITH
Diagram
Diagram
Type restriction of xsd:string
Properties
content: simple
Facets
minLength 1
Source
<xsd:element name="Surname">
  <xsd:annotation>
    <xsd:documentation>Traveler family (last) name. Example: SMITH</xsd:documentation>
  </xsd:annotation>
  <xsd:simpleType>
    <xsd:restriction base="xsd:string">
      <xsd:minLength value="1"/>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / TravelerName / GivenName
Namespace No namespace
Annotations
Traveler given (first) name.
Example: JOHN
Diagram
Diagram
Type restriction of xsd:string
Properties
content: simple
Facets
minLength 1
Source
<xsd:element name="GivenName">
  <xsd:annotation>
    <xsd:documentation>Traveler given (first) name. Example: JOHN</xsd:documentation>
  </xsd:annotation>
  <xsd:simpleType>
    <xsd:restriction base="xsd:string">
      <xsd:minLength value="1"/>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:element>
[ top ]
Element FrequentTravelerGroup
Namespace No namespace
Annotations
FrequentTravelerGroup
Diagram
Diagram DocumentListRQ.tmp#FFCompanyCode DocumentListRQ.tmp#FFNumber
Properties
content: complex
Used by
Model FFCompanyCode , FFNumber
Children FFCompanyCode, FFNumber
Instance
<FrequentTravelerGroup>
  <FFCompanyCode>{1,1}</FFCompanyCode>
  <FFNumber>{1,1}</FFNumber>
</FrequentTravelerGroup>
Source
<xsd:element name="FrequentTravelerGroup">
  <xsd:annotation>
    <xsd:documentation>FrequentTravelerGroup</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="FFCompanyCode"/>
      <xsd:element ref="FFNumber"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element FFCompanyCode
Namespace No namespace
Annotations
Frequent flyer company code.  Example: AF
Diagram
Diagram
Type xsd:string
Properties
content: simple
Used by
Source
<xsd:element name="FFCompanyCode" type="xsd:string">
  <xsd:annotation>
    <xsd:documentation>Frequent flyer company code. Example: AF</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element FFNumber
Namespace No namespace
Annotations
Frequent flyer number.  Example: 0956301007
Diagram
Diagram
Type xsd:string
Properties
content: simple
Used by
Source
<xsd:element name="FFNumber" type="xsd:string">
  <xsd:annotation>
    <xsd:documentation>Frequent flyer number. Example: 0956301007</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / Carrier
Namespace No namespace
Annotations
Carrier group identifying the validating carriers for the tickets to be included in the search

The validating carrier(s) here determine the source of the document issuing system, e.g. AA, EK
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_Carrier_ValidatingCarrier
Properties
content: complex
minOccurs: 0
Model ValidatingCarrier*
Children ValidatingCarrier
Instance
<Carrier>
  <ValidatingCarrier>{0,unbounded}</ValidatingCarrier>
</Carrier>
Source
<xsd:element name="Carrier" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>Carrier group identifying the validating carriers for the tickets to be included in the search The validating carrier(s) here determine the source of the document issuing system, e.g. AA, EK</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="ValidatingCarrier" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>Validating carrier code (IATA 2-letter airline code). Example: AA</xsd:documentation>
        </xsd:annotation>
        <xsd:simpleType>
          <xsd:restriction base="xsd:string">
            <xsd:length value="2"/>
          </xsd:restriction>
        </xsd:simpleType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / Carrier / ValidatingCarrier
Namespace No namespace
Annotations
Validating carrier code (IATA 2-letter airline code). Example: AA
Diagram
Diagram
Type restriction of xsd:string
Properties
content: simple
minOccurs: 0
maxOccurs: unbounded
Facets
length 2
Source
<xsd:element name="ValidatingCarrier" minOccurs="0" maxOccurs="unbounded">
  <xsd:annotation>
    <xsd:documentation>Validating carrier code (IATA 2-letter airline code). Example: AA</xsd:documentation>
  </xsd:annotation>
  <xsd:simpleType>
    <xsd:restriction base="xsd:string">
      <xsd:length value="2"/>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / DocParameters
Namespace No namespace
Annotations
If this parameter is used, status and type must be provided, coupon status is optional
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_Type DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_DocumentStatus DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_IssueDates DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_FCICode
Properties
content: complex
minOccurs: 0
Model Type , DocumentStatus , IssueDates , FCICode{0,1}
Children DocumentStatus, FCICode, IssueDates, Type
Instance
<DocParameters>
  <Type>{1,1}</Type>
  <DocumentStatus>{1,1}</DocumentStatus>
  <IssueDates>{1,1}</IssueDates>
  <FCICode>{0,1}</FCICode>
</DocParameters>
Source
<xsd:element name="DocParameters" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>If this parameter is used, status and type must be provided, coupon status is optional</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="Type">
        <xsd:annotation>
          <xsd:documentation>Allowed values: TKTT (ETkt) Y (EMD-A) J (EMD-S) M (MCO,VMD)</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="DocumentStatus">
        <xsd:annotation>
          <xsd:documentation>Values depend on specified type and are currently as follows: for TKTT (E-Tkt) "Ticketed" "TICKETED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED" for EMD "Issued" "ISSUED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED"</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="IssueDates">
        <xsd:annotation>
          <xsd:documentation>Establishes the start and end date of the query as it relates to the "TicketIssueDate" as found in: TicketImage/TicketIdentification/TicketIssueDate If not provided the search will go back 365 days from current date.</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="StartDate">
              <xsd:annotation>
                <xsd:documentation>the earliest date of issuance. Only tickets issued on a date equal or higher (after) than this date will be included.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <xsd:element name="EndDate">
              <xsd:annotation>
                <xsd:documentation>the last date of issuance. Only tickets issued on a date equal or less (prior) than this date will be included.</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
      <xsd:element name="FCICode" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>If entered only the transactions carrying the specified FCI code will be included Allowed values: 0 = auto priced 1 = manually priced</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / DocParameters / Type
Namespace No namespace
Annotations
Allowed values:

TKTT (ETkt)
Y (EMD-A)
J (EMD-S)
M (MCO,VMD)
Diagram
Diagram
Source
<xsd:element name="Type">
  <xsd:annotation>
    <xsd:documentation>Allowed values: TKTT (ETkt) Y (EMD-A) J (EMD-S) M (MCO,VMD)</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / DocParameters / DocumentStatus
Namespace No namespace
Annotations
Values depend on specified type and are currently as follows:

for TKTT (E-Tkt)
"Ticketed" "TICKETED"
"Refunded" "REFUNDED"
"Voided" "VOIDED"
"Exchanged""EXCHANGED" 

for EMD
"Issued" "ISSUED"
"Refunded" "REFUNDED"
"Voided" "VOIDED"
"Exchanged""EXCHANGED"
Diagram
Diagram
Source
<xsd:element name="DocumentStatus">
  <xsd:annotation>
    <xsd:documentation>Values depend on specified type and are currently as follows: for TKTT (E-Tkt) "Ticketed" "TICKETED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED" for EMD "Issued" "ISSUED" "Refunded" "REFUNDED" "Voided" "VOIDED" "Exchanged""EXCHANGED"</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / DocParameters / IssueDates
Namespace No namespace
Annotations
Establishes the start and end date of the query as it relates to the "TicketIssueDate" 
as found in: TicketImage/TicketIdentification/TicketIssueDate

If not provided the search will go back 365 days from current date.
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_IssueDates_StartDate DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocParameters_IssueDates_EndDate
Properties
content: complex
Model StartDate , EndDate
Children EndDate, StartDate
Instance
<IssueDates>
  <StartDate>{1,1}</StartDate>
  <EndDate>{1,1}</EndDate>
</IssueDates>
Source
<xsd:element name="IssueDates">
  <xsd:annotation>
    <xsd:documentation>Establishes the start and end date of the query as it relates to the "TicketIssueDate" as found in: TicketImage/TicketIdentification/TicketIssueDate If not provided the search will go back 365 days from current date.</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="StartDate">
        <xsd:annotation>
          <xsd:documentation>the earliest date of issuance. Only tickets issued on a date equal or higher (after) than this date will be included.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="EndDate">
        <xsd:annotation>
          <xsd:documentation>the last date of issuance. Only tickets issued on a date equal or less (prior) than this date will be included.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / DocParameters / IssueDates / StartDate
Namespace No namespace
Annotations
the earliest date of issuance. Only tickets issued on a date equal or higher (after) than this date will be included.
Diagram
Diagram
Source
<xsd:element name="StartDate">
  <xsd:annotation>
    <xsd:documentation>the earliest date of issuance. Only tickets issued on a date equal or higher (after) than this date will be included.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / DocParameters / IssueDates / EndDate
Namespace No namespace
Annotations
the last date of issuance. Only tickets issued on a date equal or less (prior) than this date will be included.
Diagram
Diagram
Source
<xsd:element name="EndDate">
  <xsd:annotation>
    <xsd:documentation>the last date of issuance. Only tickets issued on a date equal or less (prior) than this date will be included.</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / DocParameters / FCICode
Namespace No namespace
Annotations
If entered only the transactions carrying the specified FCI code will be included

Allowed values:
0 = auto priced
1 = manually priced
Diagram
Diagram
Properties
minOccurs: 0
Source
<xsd:element name="FCICode" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>If entered only the transactions carrying the specified FCI code will be included Allowed values: 0 = auto priced 1 = manually priced</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / CouponParameters
Namespace No namespace
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_CouponParameters_CouponStatus DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_CouponParameters_TravelDates
Properties
content: complex
minOccurs: 0
Model CouponStatus{0,1} , TravelDates{0,1}
Children CouponStatus, TravelDates
Instance
<CouponParameters>
  <CouponStatus>{0,1}</CouponStatus>
  <TravelDates>{0,1}</TravelDates>
</CouponParameters>
Source
<xsd:element name="CouponParameters" minOccurs="0">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="CouponStatus" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>Sample values are: O = Open for use E = Exchanged/Reissued F = Flown/Used V = Void R = Refunded, and others</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="TravelDates" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>Establishes the start and end date of the query as it relates to the Travel Dates as found by looping through all coupons: TicketImage/Itinerary/TicketCoupon/Flight/Departure + Arrival nodes</xsd:documentation>
        </xsd:annotation>
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="StartDate" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or HIGHER (after) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
            <xsd:element name="EndDate" minOccurs="0">
              <xsd:annotation>
                <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or LOWER (prior) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
              </xsd:annotation>
            </xsd:element>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / CouponParameters / CouponStatus
Namespace No namespace
Annotations
Sample values are:

O = Open for use
E = Exchanged/Reissued
F = Flown/Used
V = Void
R = Refunded,
and others
Diagram
Diagram
Properties
minOccurs: 0
Source
<xsd:element name="CouponStatus" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>Sample values are: O = Open for use E = Exchanged/Reissued F = Flown/Used V = Void R = Refunded, and others</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / CouponParameters / TravelDates
Namespace No namespace
Annotations
Establishes the start and end date of the query as it relates to the Travel Dates 
as found by looping through all coupons: TicketImage/Itinerary/TicketCoupon/Flight/Departure + Arrival nodes
Diagram
Diagram DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_CouponParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_CouponParameters_TravelDates_StartDate DocumentListRQ.tmp#DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_CouponParameters_DocumentListRQ_DocumentListRQ_SearchParameters_DocumentListRQ_DocumentListRQ_SearchParameters_CouponParameters_TravelDates_EndDate
Properties
content: complex
minOccurs: 0
Model StartDate{0,1} , EndDate{0,1}
Children EndDate, StartDate
Instance
<TravelDates>
  <StartDate>{0,1}</StartDate>
  <EndDate>{0,1}</EndDate>
</TravelDates>
Source
<xsd:element name="TravelDates" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>Establishes the start and end date of the query as it relates to the Travel Dates as found by looping through all coupons: TicketImage/Itinerary/TicketCoupon/Flight/Departure + Arrival nodes</xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element name="StartDate" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or HIGHER (after) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="EndDate" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or LOWER (prior) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / CouponParameters / TravelDates / StartDate
Namespace No namespace
Annotations
the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or HIGHER (after) to the date provided here are included in the result set.

The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date
Diagram
Diagram
Properties
minOccurs: 0
Source
<xsd:element name="StartDate" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or HIGHER (after) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Element DocumentListRQ / SearchParameters / CouponParameters / TravelDates / EndDate
Namespace No namespace
Annotations
the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or LOWER (prior) to the date provided here are included in the result set.

The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date
Diagram
Diagram
Properties
minOccurs: 0
Source
<xsd:element name="EndDate" minOccurs="0">
  <xsd:annotation>
    <xsd:documentation>the starting date of travel. Only tickets where the departure date of any coupon is EQUAL or LOWER (prior) to the date provided here are included in the result set. The date to compare is found by checking 1st coupon of ticket image: TicketImage/Itinerary/TicketCoupon/Flight/Departure/Date</xsd:documentation>
  </xsd:annotation>
</xsd:element>
[ top ]
Attribute DocumentListRQ / SearchParameters / Location / IATA / @AllPCCs
Namespace No namespace
Annotations
Y = will include all PCCs under specified IATA number to be included in query
Used by
Source
<xsd:attribute name="AllPCCs">
  <xsd:annotation>
    <xsd:documentation>Y = will include all PCCs under specified IATA number to be included in query</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
[ top ]
Attribute DocumentListRQ / SearchParameters / Location / PCC / @AgentID
Namespace No namespace
Annotations
If entered only the transactions issued by this agent ID will be included
Used by
Source
<xsd:attribute name="AgentID">
  <xsd:annotation>
    <xsd:documentation>If entered only the transactions issued by this agent ID will be included</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
[ top ]
Attribute DocumentListRQ / SearchParameters / @Source
Namespace No namespace
Annotations
Airline or GDS hosting the ticket database 
Example: 1S
Properties
use: required
Used by
Source
<xsd:attribute name="Source" use="required">
  <xsd:annotation>
    <xsd:documentation>Airline or GDS hosting the ticket database Example: 1S</xsd:documentation>
  </xsd:annotation>
</xsd:attribute>
[ top ]