SOAP API - AddCity
AddCity( user, countryName, stateName, cityName, countyName, sortOrder) : void
Since: EngageIP v25.2
Adds a city to a state for this user, or throws and error if the user does not exist
Parameters:
user (String) - The username of the user in which to add a new city. An exception will be thrown if the username does not exist.
countryName (String) - Name of the country in which this city resides. An exception will be thrown if the country name does not exist.
stateName (String) - Name of the state/province in which this city resides. An exception will be thrown if the state/province name does not exist.
cityName (String) - The name of the city to add.
countyName (String) - Optional name of the county in which the city resides. An exception will be thrown if the county name does not exist. Use null if not required.
sortOrder (Integer) - Optional sort order parameter to allow you to move the order of the city up or down in the list of cities. Use -2,147,483,648 if not required.
Possible Exceptions:
INVALID USERNAME
INVALID COUNTRY
INVALID STATE
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthHeader xmlns="Logisense_EngageIP">
<Username>string</Username>
<Password>string</Password>
</AuthHeader>
</soap12:Header>
<soap12:Body>
<AddCity xmlns="Logisense_EngageIP">
<user>string</user>
<countryName>string</countryName>
<stateName>string</stateName>
<cityName>string</cityName>
<countyName>string</countyName>
<sortOrder>int</sortOrder>
</AddCity>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddCityResponse xmlns="Logisense_EngageIP" />
</soap12:Body>
</soap12:Envelope>
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/AddCity"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthHeader xmlns="Logisense_EngageIP">
<Username>string</Username>
<Password>string</Password>
</AuthHeader>
</soap:Header>
<soap:Body>
<AddCity xmlns="Logisense_EngageIP">
<user>string</user>
<countryName>string</countryName>
<stateName>string</stateName>
<cityName>string</cityName>
<countyName>string</countyName>
<sortOrder>int</sortOrder>
</AddCity>
</soap:Body>
</soap:Envelope>