Definition Type: ComplexType
Name: BillOfLadingHeaderType
Namespace: http://www.api.org/pidXML
Containing Schema: BillOfLadingCreate.xsd
Abstract
Collapse XSD Schema Diagram:
Drilldown into ShipToInformation in schema billofladingcreate_xsd Drilldown into BillToInformation in schema billofladingcreate_xsd Drilldown into CarrierInformation in schema billofladingcreate_xsd Drilldown into TerminalInformation in schema pidxlib_xsd Drilldown into FinalShipper in schema billofladingcreate_xsd Drilldown into ThirdParty in schema billofladingcreate_xsd Drilldown into ExchangeOrThroughputPartnerInformation in schema billofladingcreate_xsd Drilldown into SupplierInformation in schema billofladingcreate_xsd Drilldown into PurchaseOrderInformation in schema pidxlib_xsd Drilldown into BillOfLadingNumber in schema billofladingcreate_xsd Drilldown into TransactionType in schema billofladingcreate_xsd Drilldown into StartLoadTime in schema billofladingcreate_xsd Drilldown into StartLoadDate in schema billofladingcreate_xsd Drilldown into LoadSpot in schema billofladingcreate_xsd Drilldown into ExitTime in schema billofladingcreate_xsd Drilldown into ExitDate in schema billofladingcreate_xsd Drilldown into EntryTime in schema billofladingcreate_xsd Drilldown into EntryDate in schema billofladingcreate_xsd Drilldown into EndLoadTime in schema billofladingcreate_xsd Drilldown into EndLoadDate in schema billofladingcreate_xsd Drilldown into DispatchOrderNumber in schema billofladingcreate_xsd Drilldown into ConsigneeNumber in schema billofladingcreate_xsd Drilldown into AuthorizationCode in schema billofladingcreate_xsdXSD Diagram of BillOfLadingHeaderType in schema billofladingcreate_xsd (PIDX - Petroleum Industry Data Exchange)
Collapse XSD Schema Code:
<complexType name="BillOfLadingHeaderType">
    <annotation>
        <documentation />
    </annotation>
    <sequence>
        <element ref="pidx:PurchaseOrderInformation" minOccurs="0" />
        <element ref="pidx:SupplierInformation" />
        <element ref="pidx:ExchangeOrThroughputPartnerInformation" minOccurs="0" />
        <element ref="pidx:ThirdParty" minOccurs="0" maxOccurs="6" />
        <element ref="pidx:FinalShipper" minOccurs="0" />
        <element ref="pidx:TerminalInformation" />
        <element ref="pidx:CarrierInformation" />
        <element ref="pidx:BillToInformation" />
        <element ref="pidx:ShipToInformation" />
    </sequence>
    <attribute name="AuthorizationCode">
        <annotation>
            <documentation>For real-time (PDXR) type authorizations, this is the number assigned/returned from the load authorizing application.</documentation>
        </annotation>
        <simpleType>
            <restriction base="NMTOKEN">
                <pattern value="[0-9]{8}" />
            </restriction>
        </simpleType>
    </attribute>
    <attribute name="ConsigneeNumber" type="string" use="required">
        <annotation>
            <documentation>An alpha-numeric field which identifies the consignee as it appears on the BOL. 
						This field may include the following two data fields: 'Bill To ID' and (optionally) 'Ship To ID'.</documentation>
        </annotation>
    </attribute>
    <attribute name="DispatchOrderNumber">
        <annotation>
            <documentation>A system generated load verification number</documentation>
        </annotation>
        <simpleType>
            <restriction base="NMTOKEN">
                <pattern value="[0-9a-zA-Z]{50}" />
            </restriction>
        </simpleType>
    </attribute>
    <attribute name="EndLoadDate" type="date">
        <annotation>
            <documentation>The date when the driver stops the load/transaction.  Typically, this is when the driver is finished loading at the truck rack load lane and “cards out.”</documentation>
        </annotation>
    </attribute>
    <attribute name="EndLoadTime" type="time">
        <annotation>
            <documentation>The time when the driver stops the load/transaction.  Typically, this is when the driver is finished loading at the truck rack load lane and “cards out.”</documentation>
        </annotation>
    </attribute>
    <attribute name="EntryDate" type="date">
        <annotation>
            <documentation>The date when the driver entered the terminal.</documentation>
        </annotation>
    </attribute>
    <attribute name="EntryTime" type="time">
        <annotation>
            <documentation>The time when the driver entered the terminal.</documentation>
        </annotation>
    </attribute>
    <attribute name="ExitDate" type="date">
        <annotation>
            <documentation>The date when the driver finished (either when carded out and did the BOL print, or when carded out to exit the terminal).</documentation>
        </annotation>
    </attribute>
    <attribute name="ExitTime" type="time">
        <annotation>
            <documentation>The time when the driver finished (either when carded out and did the BOL print, or when carded out to exit the terminal).</documentation>
        </annotation>
    </attribute>
    <attribute name="LoadSpot">
        <annotation>
            <documentation>Identifies which lane or loading area the driver loaded the product.</documentation>
        </annotation>
        <simpleType>
            <restriction base="NMTOKEN">
                <pattern value="[0-9a-zA-Z]{1,30}" />
            </restriction>
        </simpleType>
    </attribute>
    <attribute name="StartLoadDate" type="date" use="required">
        <annotation>
            <documentation>The date when the driver started the load/transaction.  Typically, this is when the driver “cards in” at the truck rack load lane to begin loading.</documentation>
        </annotation>
    </attribute>
    <attribute name="StartLoadTime" type="time" use="required">
        <annotation>
            <documentation>The time when the driver started the load/transaction.  Typically, this is when the driver “cards in” at the truck rack load lane to begin loading.</documentation>
        </annotation>
    </attribute>
    <attribute name="TransactionType" type="pidx:TransactionTypeCodeType" use="required" />
    <attribute name="BillOfLadingNumber" use="required">
        <annotation>
            <documentation>An alpha-numeric field, which contains the significant digits of the bill of lading number.  Right justification and padding with leading zeros is not required.</documentation>
        </annotation>
        <simpleType>
            <restriction base="NMTOKEN">
                <pattern value="[0-9,a-zA-Z]{1,16}" />
            </restriction>
        </simpleType>
    </attribute>
</complexType>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
PurchaseOrderInformation pidx:PurchaseOrderInformation 0 (1)
SupplierInformation pidx:SupplierInformation (1) (1)
ExchangeOrThroughputPartnerInformation pidx:ExchangeOrThroughputPartnerInformation 0 (1)
ThirdParty pidx:ThirdParty 0 6
FinalShipper pidx:FinalShipper 0 (1)
TerminalInformation pidx:TerminalInformation (1) (1)
CarrierInformation pidx:CarrierInformation (1) (1)
BillToInformation pidx:BillToInformation (1) (1)
ShipToInformation pidx:ShipToInformation (1) (1)
Collapse Child Attributes:
Name Type Default Value Use
AuthorizationCode pidx:AuthorizationCode (Optional)
ConsigneeNumber pidx:ConsigneeNumber Required
DispatchOrderNumber pidx:DispatchOrderNumber (Optional)
EndLoadDate pidx:EndLoadDate (Optional)
EndLoadTime pidx:EndLoadTime (Optional)
EntryDate pidx:EntryDate (Optional)
EntryTime pidx:EntryTime (Optional)
ExitDate pidx:ExitDate (Optional)
ExitTime pidx:ExitTime (Optional)
LoadSpot pidx:LoadSpot (Optional)
StartLoadDate pidx:StartLoadDate Required
StartLoadTime pidx:StartLoadTime Required
TransactionType pidx:TransactionType Required
BillOfLadingNumber pidx:BillOfLadingNumber Required
Collapse Derivation Tree:
Collapse References:
pidx:BillOfLadingHeader