Definition Type: ComplexType
Name: DocumentType
Containing Schema: OTA_CommonTypes.xsd
Abstract
Documentation:
Provides information on a specific document.
Collapse XSD Schema Diagram:
Drilldown into AdditionalPersonNames in schema ota_commontypes_xsd Drilldown into DocLimitations in schema ota_commontypes_xsd Drilldown into DocHolderFormattedName in schema ota_commontypes_xsd Drilldown into DocHolderName in schema ota_commontypes_xsd Drilldown into PostalCode in schema ota_commontypes_xsd1 Drilldown into Remark in schema ota_commontypes_xsd1 Drilldown into HolderType in schema ota_commontypes_xsd1 Drilldown into ContactName in schema ota_commontypes_xsd1 Drilldown into DocHolderNationality in schema ota_commontypes_xsd1 Drilldown into BirthCountry in schema ota_commontypes_xsd1 Drilldown into DocIssueCountry in schema ota_commontypes_xsd1 Drilldown into DocIssueStateProv in schema ota_commontypes_xsd1 Drilldown into ExpireDateExclusiveIndicator in schema ota_commontypes_xsd1 Drilldown into ExpireDate in schema ota_commontypes_xsd1 Drilldown into EffectiveDate in schema ota_commontypes_xsd1 Drilldown into EffectiveExpireOptionalDateGroup in schema ota_commontypes_xsd Drilldown into BirthDate in schema ota_commontypes_xsd1 Drilldown into BirthDateGroup in schema ota_commontypes_xsd Drilldown into Gender in schema ota_commontypes_xsd1 Drilldown into GenderGroup in schema ota_commontypes_xsd Drilldown into DocType in schema ota_commontypes_xsd1 Drilldown into DocID in schema ota_commontypes_xsd1 Drilldown into DocIssueLocation in schema ota_commontypes_xsd1 Drilldown into DocIssueAuthority in schema ota_commontypes_xsd1 Drilldown into ShareMarketInd in schema ota_commontypes_xsd1 Drilldown into ShareSynchInd in schema ota_commontypes_xsd1 Drilldown into PrivacyGroup in schema ota_commontypes_xsdXSD Diagram of DocumentType in schema ota_commontypes_xsd (Open Travel (OTA))
Collapse XSD Schema Code:
<xs:complexType name="DocumentType">
    <xs:annotation>
        <xs:documentation xml:lang="en">Provides information on a specific document.</xs:documentation>
    </xs:annotation>
    <xs:sequence>
        <xs:choice minOccurs="0">
            <xs:element name="DocHolderName" type="StringLength1to64" minOccurs="0">
                <xs:annotation>
                    <xs:documentation xml:lang="en">The name of the document holder in unformatted text (Mr. Sam Jones). </xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="DocHolderFormattedName" type="PersonNameType" minOccurs="0">
                <xs:annotation>
                    <xs:documentation xml:lang="en">The name of document holder in formatted text.</xs:documentation>
                </xs:annotation>
            </xs:element>
        </xs:choice>
        <xs:element name="DocLimitations" type="StringLength1to64" minOccurs="0" maxOccurs="9">
            <xs:annotation>
                <xs:documentation xml:lang="en">Used to indicate any limitations on the document (e.g. as a person may only be allowed to spend a max of 30 days in country on a visitor's visa).</xs:documentation>
            </xs:annotation>
        </xs:element>
        <xs:element name="AdditionalPersonNames" minOccurs="0">
            <xs:annotation>
                <xs:documentation xml:lang="en">A container for additional person names.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="AdditionalPersonName" type="StringLength1to64" maxOccurs="99">
                        <xs:annotation>
                            <xs:documentation xml:lang="en">The name of an additional person listed on this document. </xs:documentation>
                        </xs:annotation>
                    </xs:element>
                </xs:sequence>
            </xs:complexType>
        </xs:element>
    </xs:sequence>
    <xs:attributeGroup ref="PrivacyGroup">
        <xs:annotation>
            <xs:documentation xml:lang="en">Allows for control of the sharing of document data between parties.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attribute name="DocIssueAuthority" type="StringLength1to64" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Indicates the group or association that granted the document.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="DocIssueLocation" type="StringLength1to64" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Indicates the location where the document was issued.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="DocID" type="StringLength1to32" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Unique number assigned by authorities to document.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="DocType" type="OTA_CodeType" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Indicates the type of document (e.g. Passport, Military ID, Drivers License, national ID, Vaccination Certificate). Refer to OTA Code List Document Type (DOC).</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attributeGroup ref="GenderGroup">
        <xs:annotation>
            <xs:documentation xml:lang="en">The gender of the document holder.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attributeGroup ref="BirthDateGroup">
        <xs:annotation>
            <xs:documentation xml:lang="en">The birth date of the document holder.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attributeGroup ref="EffectiveExpireOptionalDateGroup">
        <xs:annotation>
            <xs:documentation xml:lang="en">The effective and expiry date of the document.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attribute name="DocIssueStateProv" type="StateProvCodeType" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">State or Province where the document was issued.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="DocIssueCountry" type="ISO3166" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Country where the document was issued.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="BirthCountry" type="ISO3166" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Specifies the birth country of the document holder.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="DocHolderNationality" type="ISO3166" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">The country code of the nationality of the document holder.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="ContactName" type="StringLength1to64" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Provides contact name associated with the document.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="HolderType" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Provides the type of document holder.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
            <xs:restriction base="xs:NMTOKEN">
                <xs:enumeration value="Infant">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The document holder is an infant.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="HeadOfHousehold">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The document holder is a head of household.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
            </xs:restriction>
        </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="Remark" type="StringLength1to128" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">A remark associated with the document.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="PostalCode" type="StringLength1to16" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Defines the postal code (e.g., ZIP code) on the document.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
</xs:complexType>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
DocHolderName DocHolderName 0 (1)
DocHolderFormattedName DocHolderFormattedName 0 (1)
DocLimitations DocLimitations 0 9
AdditionalPersonNames AdditionalPersonNames 0 (1)
Collapse Child Attributes:
Name Type Default Value Use
ShareSynchInd ShareSynchInd Optional
ShareMarketInd ShareMarketInd Optional
DocIssueAuthority DocIssueAuthority Optional
DocIssueLocation DocIssueLocation Optional
DocID DocID Optional
DocType DocType Optional
Gender Gender Optional
BirthDate BirthDate Optional
EffectiveDate EffectiveDate Optional
ExpireDate ExpireDate Optional
ExpireDateExclusiveIndicator ExpireDateExclusiveIndicator Optional
DocIssueStateProv DocIssueStateProv Optional
DocIssueCountry DocIssueCountry Optional
BirthCountry BirthCountry Optional
DocHolderNationality DocHolderNationality Optional
ContactName ContactName Optional
HolderType HolderType Optional
Remark Remark Optional
PostalCode PostalCode Optional
Collapse Derivation Tree:
Collapse References:
Document