SOAP API - AddState

AddState( user, countryName, stateName, sortOrder) : void

Since: EngageIP v25.2

Adds a state to a country for this user, or throws an error if the country or user does not exist.

Parameters:

  • user (String) - The username of the user in which to add a new state.  An exception will be thrown if the username does not exist.

  • countryName (String)  - Name of the country in which this state resides. An exception will be thrown if the country does not exist.

  • stateName (String) - Name of the state to add to this user.

  • sortOrder (Integer) - Optional sort order parameter to allow you to move the order of the state up or down in the list of states.  If sort order is not required supply -2,147,483,648 for this value.

Possible Exceptions:

  • INVALID USERNAME

  • INVALID COUNTRY

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> <AddState xmlns="Logisense_EngageIP"> <user>string</user> <countryName>string</countryName> <stateName>string</stateName> <sortOrder>int</sortOrder> </AddState> </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> <AddStateResponse 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/AddState" <?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> <AddState xmlns="Logisense_EngageIP"> <user>string</user> <countryName>string</countryName> <stateName>string</stateName> <sortOrder>int</sortOrder> </AddState> </soap:Body> </soap:Envelope>