Stop Object

Last updated
Save as PDF

Details about a stop are defined in the Stop object. The attributes of the Stop object are:

Attribute	Description
loadId	A string of maximum length 20 that uniquely identifies the load. It is case-sensitive.
stopId	A string of maximum length 20 that uniquely identifies the stop. It is case-sensitive.
sequenceNum	A floating point (double) value containing the sequence number of the stop within the load. Valid values are 0 - 999.99.
type	A string of maximum length 1 that identifies the type of stop. Valid values are: P - Pickup D - Dropoff F - Fuel O - Other
customerCode	A string of maximum length 256 containing the customer code of the stop.
latitude	A floating point (double) value containing the stop's latitude, expressed in signed decimal degrees.
longitude	A floating point (double) value containing the stop's longitude, expressed in signed decimal degrees.
name	A string of maximum length 256 containing name of the stop.
address1	A string of maximum length 256 containing the street address of the stop.
address2	A string of maximum length 256 containing an additional street address of the stop.
city	A string of maximum length 256 containing the city of the stop.
state	A string of maximum length 2 containing the state of the stop.
postalCode	A string of maximum length 12 containing the postal code of the stop.
region	A string of maximum length 20 containing the region of the stop.
country	A string of maximum length 5 containing the country code of the stop. Valid values are: CA - Canada CO - Colombia MX - Mexico PE - Peru US - United States VE - Venezuela
contact	A string of maximum length 256 containing the stop's contact.
phone	A string of maximum length 15 containing the contact's phone number.
earlyTime	A string that contains the earliest date and time the load can arrive at the stop, expressed in the following format in GMT timezone: yyyy-mm-ddThh:mm:ssZ.
lateTime	A string that contains the latest date and time the load can arrive at the stop, expressed in the following format in GMT timezone: yyyy-mm-ddThh:mm:ssZ.
completeTime	A string that contains the date and time when the stop was completed, expressed in the following format in GMT timezone: yyyy-mm-ddThh:mm:ssZ.
billOfLadingNum	A string of maximum length 256 containing the bill of lading number of the stop.
pieces	A string of maximum length 20 representing the number of pieces.
weight	A string of maximum length 20 representing the weight.
commodity	A string of maximum length 256 containing the commodity code of the stop.
temperature	A string of maximum length 20 representing the temperature.
hazmatCodes	A string of maximum length 256 containing hazmat codes for the stop.
comments	A string of maximum length 256 containing comments about the stop.
generalUse1	A string of maximum length 256 that may be used as desired.
generalUse2	A string of maximum length 256 that may be used as desired.
generalUse3	A string of maximum length 256 that may be used as desired.

WSDL Definition

Here is how the Stop object is defined within the WSDL.

<complexType name="Stop">

<sequence>

<element name="loadId" nillable="true" type="xsd:string"/>

<element name="stopId" nillable="true" type="xsd:string"/>

<element name="sequenceNum" type="xsd:double"/>

<element name="type" nillable="true" type="xsd:string"/>

<element name="customerCode" nillable="true" type="xsd:string"/>

<element name="latitude" type="xsd:double"/>

<element name="longitude" type="xsd:double"/>

<element name="name" nillable="true" type="xsd:string"/>

<element name="address1" nillable="true" type="xsd:string"/>

<element name="address2" nillable="true" type="xsd:string"/>

<element name="city" nillable="true" type="xsd:string"/>

<element name="state" nillable="true" type="xsd:string"/>

<element name="postalCode" nillable="true" type="xsd:string"/>

<element name="region" nillable="true" type="xsd:string"/>

<element name="country" nillable="true" type="xsd:string"/>

<element name="contact" nillable="true" type="xsd:string"/>

<element name="phone" nillable="true" type="xsd:string"/>

<element name="earlyTime" nillable="true" type="xsd:string"/>

<element name="lateTime" nillable="true" type="xsd:string"/>

<element name="completeTime" nillable="true" type="xsd:string"/>

<element name="billOfLadingNum" nillable="true" type="xsd:string"/>

<element name="pieces" nillable="true" type="xsd:string"/>

<element name="weight" nillable="true" type="xsd:string"/>

<element name="commodity" nillable="true" type="xsd:string"/>

<element name="temperature" nillable="true" type="xsd:string"/>

<element name="hazmatCodes" nillable="true" type="xsd:string"/>

<element name="comments" nillable="true" type="xsd:string"/>

<element name="generalUse1" nillable="true" type="xsd:string"/>

<element name="generalUse2" nillable="true" type="xsd:string"/>

<element name="generalUse3" nillable="true" type="xsd:string"/>

</sequence>

</complexType>

Sample XML

Here is some sample XML that shows what the Stop object will look like in XML.

<stop>

<loadId>3631</loadId>

<stopId>Southern CA</stopId>

<sequenceNum>1</sequenceNum>

<type>P</type>

<customerCode>ACME</customerCode>

<latitude>32.8952</latitude>

<longitude>-117.1957</longitude>

<name>ACME FRUIT</name>

<address1>100 MAIN ST</address1>

<address2/>

<city>San Diego</city>

<state>CA</state>

<postalCode>92121</postalCode>

<region/>

<country>US</country>

<contact>Jim Smith</contact>

<phone/>

<earlyTime>2012-11-05T16:00:00Z</earlyTime>

<lateTime>2012-11-05T20:00:00Z</lateTime>

<completeTime/>

<billOfLadingNum>752</billOfLadingNum>

<pieces>100 bags</pieces>

<weight>225 lbs.</weight>

<commodity/>

<temperature>40</temperature>

<hazmatCodes>1.3</hazmatCodes>

<comments>Use loading dock in back</comments>

<generalUse1/>

<generalUse2/>

<generalUse3/>

</stop>