Definition Type: AttributeGroup
Name: OTA_PayloadStdAttributes
Containing Schema: OTA_CommonTypes.xsd
Documentation:
The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OTA payloads.
Collapse XSD Schema Diagram:
Drilldown into RetransmissionIndicator in schema ota_commontypes_xsd1 Drilldown into AltLangID in schema ota_commontypes_xsd1 Drilldown into AltLangID_Group in schema ota_commontypes_xsd Drilldown into PrimaryLangID in schema ota_commontypes_xsd1 Drilldown into PrimaryLangID_Group in schema ota_commontypes_xsd Drilldown into TransactionStatusCode in schema ota_commontypes_xsd1 Drilldown into SequenceNmbr in schema ota_commontypes_xsd1 Drilldown into TransactionIdentifier in schema ota_commontypes_xsd1 Drilldown into Version in schema ota_commontypes_xsd1 Drilldown into Target in schema ota_commontypes_xsd1 Drilldown into TimeStamp in schema ota_commontypes_xsd1 Drilldown into EchoToken in schema ota_commontypes_xsd1XSD Diagram of OTA_PayloadStdAttributes in schema ota_commontypes_xsd (Open Travel (OTA))
Collapse XSD Schema Code:
<xs:attributeGroup name="OTA_PayloadStdAttributes">
    <xs:annotation>
        <xs:documentation xml:lang="en">The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OTA payloads.</xs:documentation>
    </xs:annotation>
    <xs:attribute name="EchoToken" type="StringLength1to128" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="TimeStamp" type="xs:dateTime" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Target" use="optional" default="Production">
        <xs:annotation>
            <xs:documentation xml:lang="en">Used to indicate whether the request is for the Test or Production system.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
            <xs:restriction base="xs:NMTOKEN">
                <xs:enumeration value="Test" />
                <xs:enumeration value="Production" />
            </xs:restriction>
        </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="Version" type="xs:decimal" use="required">
        <xs:annotation>
            <xs:documentation xml:lang="en">For all OTA versioned messages, the version of the message is indicated by a decimal value.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="TransactionIdentifier" type="StringLength1to32" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">A unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="SequenceNmbr" type="xs:nonNegativeInteger" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Used to identify the sequence number of the transaction as assigned by the sending system; allows for an application to process messages in a certain order or to request a resynchronization of messages in the event that a system has been off-line and needs to retrieve messages that were missed. </xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="TransactionStatusCode" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">This indicates where this message falls within a sequence of messages. </xs:documentation>
        </xs:annotation>
        <xs:simpleType>
            <xs:restriction base="xs:NMTOKEN">
                <xs:enumeration value="Start">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This is the first message within a transaction.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="End">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This is the last message within a transaction.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="Rollback">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This indicates that all messages within the current transaction must be ignored.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="InSeries">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This is any message that is not the first or last message within a transaction.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="Continuation">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Specifies that this is a followup request asking for more of what was requested in the previous request.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="Subsequent">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This request message is a subsequent request based on the previous message sent in this transaction.
</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
            </xs:restriction>
        </xs:simpleType>
    </xs:attribute>
    <xs:attributeGroup ref="PrimaryLangID_Group">
        <xs:annotation>
            <xs:documentation xml:lang="en">Identifes the primary language for the message.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attributeGroup ref="AltLangID_Group">
        <xs:annotation>
            <xs:documentation xml:lang="en">Identifes the alternate language for the message.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attribute name="RetransmissionIndicator" type="xs:boolean" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">When true, indicates the message is being re-sent after a failure. It is recommended that this attribute is used (i.e., set to TRUE) only when a message is retransmitted.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
</xs:attributeGroup>
Collapse Child Attributes:
Name Type Default Value Use
EchoToken EchoToken Optional
TimeStamp TimeStamp Optional
Target Target Production Optional
Version Version Required
TransactionIdentifier TransactionIdentifier Optional
SequenceNmbr SequenceNmbr Optional
TransactionStatusCode TransactionStatusCode Optional
PrimaryLangID PrimaryLangID Optional
AltLangID AltLangID Optional
RetransmissionIndicator RetransmissionIndicator Optional