Depot->CreateDepot

Last updated
Save as PDF

CreateDepot (Depot Function)

This function creates one depot with the given parameter values and returns the depot id of the newly created depot.

XML Request

Parameters

This web service method takes the following input parameters:

Parameter	Type	Optional	Description
DepotID	Short	Yes	The depot ID to be created (0 to 32,767. If not provided or a value of -1 is passed, an ID will cause the lowest available ID to be assigned by the system
DepotName	String	No	The name for the created ID
TimeZone	Enumeration	No	The time zone for the Depot. See possible values below
StartOfDay	Short	Yes	Start of Day for the Depot, in minutes. (24 hours is considered as one day and day starts at 12 midnight). If not provided or -1 is passed in, the start of day is set to 0 minutes i.e., midnight.
StreetAddress	String	No	Street Address
StreetAddress2	String	No	Street Address - line 2
City	String	No	City Name
Region	String	No	State or Province
Postal	String	No	Postal Code

TimeZone Enum
Hawaiian
Alaskan
Pacific
Mountain
Arizona
Central
Eastern
Indiana
Atlantic
Newfoundland
Saskatchewan

XML Structure

  
<soap:Body>  
    <CreateDepot xmlns="http://www.qualcomm.com">  
      <CreateDepotRequest>  
        <DepotId>short</DepotId>  
        <DepotName>string</DepotName>  
        <TimeZone>Hawaiian or Alaskan or Pacific or Mountain or Arizona or Central or Eastern or Indiana or Atlantic or Newfoundland or Saskatchewan</TimeZone>  
        <StartOfDay>short</StartOfDay>  
        <StreetAddress>string</StreetAddress>  
        <StreetAddress2>string</StreetAddress2>  
        <City>string</City>  
        <Region>string</Region>  
        <Postal>string</Postal>  
      </CreateDepotRequest>  
    </CreateDepot>  
  </soap:Body>

XML Response

Parameters

The web service method provides the following information in the response document.

Parameter	Type	Optional	Description
DepotID	Short	No	The Depot ID

XML Structure

  
<soap:Body>  
    <CreateDepotResponse xmlns="http://www.qualcomm.com">  
      <CreateDepotResult>  
        <DepotId>short</DepotId>  
      </CreateDepotResult>  
    </CreateDepotResponse>  
</soap:Body>