Load Plan

From UG

(Difference between revisions)
Jump to: navigation, search
(→DocLoadPlan)
(→DocLoadPlan)
Line 21: Line 21:
===== DocLoadPlan =====
===== DocLoadPlan =====
-
 
+
Example:
  <DocLoadPlan BilledAsUOM="200" BilledAsUnitCost="0" BilledAsValue="0" BillingOptionDescription="0" CarContract="JWEL Contract 1"  
  <DocLoadPlan BilledAsUOM="200" BilledAsUnitCost="0" BilledAsValue="0" BillingOptionDescription="0" CarContract="JWEL Contract 1"  
Line 29: Line 29:
   CarrierName="Jewels Transportation" Reason="0" TransportMode="TL" ContractModeDesc="TL" TotalLadingQty="1">
   CarrierName="Jewels Transportation" Reason="0" TransportMode="TL" ContractModeDesc="TL" TotalLadingQty="1">
 +
Child elements:
 +
 +
<xs:sequence>
 +
<xs:element ref="BillToInformation" minOccurs="0"/>
 +
<xs:element minOccurs="0" maxOccurs="1" ref="DocLoadRate"/>
 +
<xs:element ref="BOLInformation" maxOccurs="unbounded"/>
 +
<xs:element ref="DocLoadStop" minOccurs="1" maxOccurs="unbounded"/>
 +
</xs:sequence>
 +
Attributes:
 +
<pre>
 +
<xs:attribute name="MasterShipmentNumber" type="xs:string" use="required"/>
 +
<xs:attribute name="TotalCharge" type="xs:double" use="optional"/>
 +
<xs:attribute name="TotalDeclaredValue" type="xs:double" use="optional"/>
 +
+
 +
<xs:attribute name="BilledAsValue" type="xs:string" use="optional">
 +
−
 +
<xs:annotation>
 +
−
 +
<xs:documentation>
 +
Quantity basis for rating calculation (distance, weight, pallets, etc)
 +
</xs:documentation>
 +
</xs:annotation>
 +
</xs:attribute>
 +
<xs:attribute ref="BilledAsUOM" use="optional"/>
 +
+
 +
<xs:attribute name="BilledAsUnitCost" type="xs:string" use="optional">
 +
−
 +
<xs:annotation>
 +
<xs:documentation>Cost per unit of the BilledAsValue</xs:documentation>
 +
</xs:annotation>
 +
</xs:attribute>
 +
+
 +
<xs:attribute name="ManualRate" type="xs:byte" use="optional">
 +
−
 +
<xs:annotation>
 +
<xs:documentation>If Manual Rate then 1, else 0</xs:documentation>
 +
</xs:annotation>
 +
</xs:attribute>
 +
<xs:attribute name="BaseRate" type="xs:decimal" use="optional"/>
 +
<xs:attribute name="FixedRate" type="xs:string" use="optional"/>
 +
<xs:attribute name="OtherCharges" type="xs:string" use="optional"/>
 +
<xs:attribute name="CarContract" type="xs:string" use="optional"/>
 +
<xs:attribute name="TotalWeight" type="xs:float" use="required"/>
 +
<xs:attribute ref="WeightUOM" use="required"/>
 +
<xs:attribute name="Distance" type="xs:double" use="optional"/>
 +
<xs:attribute ref="DistanceUOM" use="optional"/>
 +
<xs:attribute ref="CurrencyCode" use="optional"/>
 +
<xs:attribute name="TotalStops" type="xs:integer" use="required"/>
 +
<xs:attribute name="TransitTime" type="xs:decimal" use="optional"/>
 +
<xs:attribute name="LinearLength" type="xs:float" use="optional"/>
 +
<xs:attribute ref="DimensionUOM" use="optional"/>
 +
<xs:attribute name="TotalVolume" type="xs:string" use="optional"/>
 +
<xs:attribute ref="VolUOM" use="optional"/>
 +
<xs:attribute name="EquipmentName" type="xs:string" use="required"/>
 +
<xs:attribute name="CarrierCode" type="xs:string" use="optional"/>
 +
<xs:attribute name="CarrierName" type="xs:string" use="optional"/>
 +
+
 +
<xs:attribute name="TransportMode" use="optional">
 +
−
 +
<xs:simpleType>
 +
<xs:list itemType="xs:string"/>
 +
</xs:simpleType>
 +
</xs:attribute>
 +
<xs:attribute name="TotalLadingQty" type="xs:unsignedInt" use="optional"/>
 +
<xs:attribute ref="Service" use="optional"/>
 +
<xs:attribute ref="BillingOption" use="optional"/>
 +
<xs:attribute name="BillingOptionDescription" type="xs:string" use="optional"/>
 +
<xs:attribute name="ConfirmationNo" type="xs:string" use="optional"/>
 +
<xs:attribute name="RequestorFullName" type="xs:string"/>
 +
<xs:attribute name="RequestorPhoneNo" type="xs:string"/>
 +
<xs:attribute name="RequestorEmailAddress" type="xs:string"/>
 +
<xs:attribute name="ProNumber" type="xs:string"/>
 +
<xs:attribute name="Reason" type="xs:string"/>
 +
<xs:attribute name="ContractModeDesc" type="xs:string" use="optional"/>
 +
<xs:attribute name="ReasonCode" type="xs:string" use="optional"/>
 +
<xs:attribute name="Manual" type="xs:string"/>
 +
<xs:attribute name="SpecialInstructions" type="xs:string"/>
 +
</pre>
====== BillToInformation ======
====== BillToInformation ======

Revision as of 16:53, 3 September 2010



Contents

S:Envelope

S:Header

wsa:From

wsa:To

wsa:Action

ebi:Sequence

S:Body

Inbound

DocLoadPlan

Example: 

<DocLoadPlan BilledAsUOM="200" BilledAsUnitCost="0" BilledAsValue="0" BillingOptionDescription="0" CarContract="JWEL Contract 1" 
 FixedRate="0" Service="1" TotalCharge="172.63" TotalDeclaredValue="0" MasterShipmentNumber="LD000022469" TotalWeight="7" 
 BillingOption="0" Distance="2624.84" WeightUOM="200" DistanceUOM="100" CurrencyCode="USD" TotalStops="2" TransitTime="3" 
 TotalVolume="0" DimensionUOM="400" VolUOM="300" BaseRate="125" OtherCharges="47.63" EquipmentName="VN" CarrierCode="JWEL" 
 CarrierName="Jewels Transportation" Reason="0" TransportMode="TL" ContractModeDesc="TL" TotalLadingQty="1">

Child elements: 

<xs:sequence>
<xs:element ref="BillToInformation" minOccurs="0"/>
<xs:element minOccurs="0" maxOccurs="1" ref="DocLoadRate"/>
<xs:element ref="BOLInformation" maxOccurs="unbounded"/>
<xs:element ref="DocLoadStop" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>

Attributes: 


<xs:attribute name="MasterShipmentNumber" type="xs:string" use="required"/>
<xs:attribute name="TotalCharge" type="xs:double" use="optional"/>
<xs:attribute name="TotalDeclaredValue" type="xs:double" use="optional"/>
+
<xs:attribute name="BilledAsValue" type="xs:string" use="optional">
−
<xs:annotation>
−
<xs:documentation>
Quantity basis for rating calculation (distance, weight, pallets, etc)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute ref="BilledAsUOM" use="optional"/>
+
<xs:attribute name="BilledAsUnitCost" type="xs:string" use="optional">
−
<xs:annotation>
<xs:documentation>Cost per unit of the BilledAsValue</xs:documentation>
</xs:annotation>
</xs:attribute>
+
<xs:attribute name="ManualRate" type="xs:byte" use="optional">
−
<xs:annotation>
<xs:documentation>If Manual Rate then 1, else 0</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="BaseRate" type="xs:decimal" use="optional"/>
<xs:attribute name="FixedRate" type="xs:string" use="optional"/>
<xs:attribute name="OtherCharges" type="xs:string" use="optional"/>
<xs:attribute name="CarContract" type="xs:string" use="optional"/>
<xs:attribute name="TotalWeight" type="xs:float" use="required"/>
<xs:attribute ref="WeightUOM" use="required"/>
<xs:attribute name="Distance" type="xs:double" use="optional"/>
<xs:attribute ref="DistanceUOM" use="optional"/>
<xs:attribute ref="CurrencyCode" use="optional"/>
<xs:attribute name="TotalStops" type="xs:integer" use="required"/>
<xs:attribute name="TransitTime" type="xs:decimal" use="optional"/>
<xs:attribute name="LinearLength" type="xs:float" use="optional"/>
<xs:attribute ref="DimensionUOM" use="optional"/>
<xs:attribute name="TotalVolume" type="xs:string" use="optional"/>
<xs:attribute ref="VolUOM" use="optional"/>
<xs:attribute name="EquipmentName" type="xs:string" use="required"/>
<xs:attribute name="CarrierCode" type="xs:string" use="optional"/>
<xs:attribute name="CarrierName" type="xs:string" use="optional"/>
+
<xs:attribute name="TransportMode" use="optional">
−
<xs:simpleType>
<xs:list itemType="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="TotalLadingQty" type="xs:unsignedInt" use="optional"/>
<xs:attribute ref="Service" use="optional"/>
<xs:attribute ref="BillingOption" use="optional"/>
<xs:attribute name="BillingOptionDescription" type="xs:string" use="optional"/>
<xs:attribute name="ConfirmationNo" type="xs:string" use="optional"/>
<xs:attribute name="RequestorFullName" type="xs:string"/>
<xs:attribute name="RequestorPhoneNo" type="xs:string"/>
<xs:attribute name="RequestorEmailAddress" type="xs:string"/>
<xs:attribute name="ProNumber" type="xs:string"/>
<xs:attribute name="Reason" type="xs:string"/>
<xs:attribute name="ContractModeDesc" type="xs:string" use="optional"/>
<xs:attribute name="ReasonCode" type="xs:string" use="optional"/>
<xs:attribute name="Manual" type="xs:string"/>
<xs:attribute name="SpecialInstructions" type="xs:string"/>
BillToInformation
DocLoadRate
BOLInformation
DocLoadStop
DocLoadStop

Example

Structure is based on the following example: 

 <?xml version="1.0" encoding="utf-8" ?> 
- <S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope" xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:rs="urn:schemas-microsoft-com:rowset" xmlns:Num="Num-namespace-URI" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:ebi="http://www.myvan.descartes.com/ebi/2004/r1" xmlns:dcf="DCF-namespace-URI" xmlns:D2P="D2P-namespace-URI">
- <S:Header>
- <wsa:From>
  <wsa:Address>urn:duns:123456789</wsa:Address> 
  </wsa:From>
  <wsa:To>urn:duns:123456789</wsa:To> 
  <wsa:Action>urn:myvan:220</wsa:Action> 
- <ebi:Sequence>
  <ebi:MessageNumber>BAT2010-08-3121-18-42Z273</ebi:MessageNumber> 
  </ebi:Sequence>
  </S:Header>
- <S:Body>
- <Inbound xmlns="Num-namespace-URI">
- <DocLoadPlan BilledAsUOM="200" BilledAsUnitCost="0" BilledAsValue="0" BillingOptionDescription="0" CarContract="JWEL Contract 1" FixedRate="0" Service="1" TotalCharge="172.63" TotalDeclaredValue="0" MasterShipmentNumber="LD000022469" TotalWeight="7" BillingOption="0" Distance="2624.84" WeightUOM="200" DistanceUOM="100" CurrencyCode="USD" TotalStops="2" TransitTime="3" TotalVolume="0" DimensionUOM="400" VolUOM="300" BaseRate="125" OtherCharges="47.63" EquipmentName="VN" CarrierCode="JWEL" CarrierName="Jewels Transportation" Reason="0" TransportMode="TL" ContractModeDesc="TL" TotalLadingQty="1" xmlns="">
  <BillToInformation StreetNo="10" Address="Fifth Street - 3rd Floor" City="Valley Stream" State="NY" PostalCode="11581" Country="US" LocationNo="00210000" ContactFName="Jaguar" F="Freight" PhoneNumber="516-239-1900" CompanyName="Jaguar Freight Services" /> 
- <DocLoadRate BilledAsValue="3.1751999999999998" BaseRate="125" OtherCharges="47.63" Service="1" ContractName="JWEL Contract 1" TotalCharge="172.63" Discount="0" MinCharge="125" BilledAsUOM="200" BilledAsQty="200" BilledAsUnitCost="0.82142999999999999" MaxCost="0" FixedRate="0" CurrencyCode="USD" TransitTime="3" Reason="0">
  <CtyLoadAccRate Charge="37" AccName="JWEL Contract 1 - Hazardous Material" CurrencyCode="USD" AccCode="HAZF" /> 
  <CtyLoadAccRate Charge="10.625" AccName="Monthly LTL %" CurrencyCode="USD" AccCode="FUEL" /> 
  </DocLoadRate>
- <BOLInformation BOLNo="BOL000032076" MethodOfPayment="0" WeightUOM="200" VolUOM="300" TotalWeight="7" TotalLadingQty="1">
- <ShipFromInformation SeqNo="1" StopTypeCode="1" StartDateTime="2010-08-31T08:00:00" EndDateTime="2010-08-31T17:00:00" StreetNo="100" Address="Main St" City="Newark" State="NJ" PostalCode="12345" Country="US" LocationNo="64534" ContactFName="Bob" ContactLName="Smith" PhoneNumber="123-345-3353" CompanyName="Supplier" AddressType="4">
  <AddressType AddressType="3" AddressTypeDesc="Pool Point" /> 
  </ShipFromInformation>
  <ShipToInformation SeqNo="2" StopTypeCode="2" StartDateTime="2010-09-01T11:00:00" EndDateTime="2010-09-01T14:00:00" Address="149 Grand Ave" City="Roanoke" State="VA" PostalCode="76456" Country="US" LocationNo="865765" CompanyName="Manufacturer" /> 
- <DocShipment AllocatedCharges="0" CreationDate="2010-08-30T16:01:11.037000000" ShipmentNumber="1097865" EarliestAvailDate="2010-08-31T08:00:00" EarliestDelDate="2010-09-01T11:00:00" LatestAvailDate="2010-08-31T17:00:00" LatestDelDate="2010-09-01T14:00:00" TotalWeight="7" WeightUOM="200" TotalVolume="0" VolUOM="300">
  <DocShpLineItem Hazardous="1" LineCreationDate="" LadingQty="1" Description="Goods" TotalWeight="7" WeightUOM="200" LadingQtyUOM="15" AcntLineItemNo="1" ContainerTypeDescription="Freight" /> 
  <DSGReferenceNumbers RefNoType="Sample RefNo 1" Value="Sample Value 1" /> 
  <DSGReferenceNumbers RefNoType="Sample RefNo 2" Value="Sample Value 2" /> 
  <DSGReferenceNumbers RefNoType="Sample RefNo 3" Value="Sample RefNo 3" /> 
  <DSGReferenceNumbers RefNoType="Sample RefNo 4" Value="Sample RefNo 4" /> 
  </DocShipment>
  </BOLInformation>
- <DocLoadStop SeqNo="1" StopTypeCode="1" StartDateTime="2010-08-31T14:14:00" EndDateTime="2010-08-31T12:01:00">
- <StopLocation StreetNo="100" Address="Main Street" City="Newark" State="NJ" PostalCode="12345" Country="US" LocationNo="64534" ContactFName="Bob" ContactLName="Smith" PhoneNumber="123-345-3353" CompanyName="Supplier" AddressType="4">
  <AddressType AddressType="3" AddressTypeDesc="Pool Point" /> 
  </StopLocation>
  <BOLInformation BOLNo="BOL000032076" WeightUOM="200" VolUOM="300" TotalWeight="7" TotalLadingQty="1" /> 
  </DocLoadStop>
- <DocLoadStop SeqNo="2" StopTypeCode="2" StartDateTime="2010-09-02T12:13:00" EndDateTime="2010-09-02T10:00:00">
  <StopLocation Address="149 Grand Ave" City="Roanoke" State="VA" PostalCode="76456" Country="US" LocationNo="865765" CompanyName="Manufacturer" /> 
  <BOLInformation BOLNo="BOL000032076" WeightUOM="200" VolUOM="300" TotalWeight="7" TotalLadingQty="1" /> 
  </DocLoadStop>
  </DocLoadPlan>
  </Inbound>
  </S:Body>
  </S:Envelope>
Retrieved from "https://wiki.jaguarfreight.com/Load_Plan"
Personal tools