SOAP API - GetCountries

GetCountries( username ) : Country[]

Since: EngageIP v25.2

Returns the list of Countries for the specified user name.

The returned value from this method call is an array of Country objects. A country object consists of the following properties:

ID (Integer) - The unique ID of the country
Name (String) - The name of the country
SortOrder (Integer) - The sort order number of this country for where it belongs in the list of countries.
OwnerID (Integer) - The owner ID for which this country belongs
CountryAddressFormatID (Integer) - Reference to the required address components for this country
DataTypePostalCodeID (Integer) - Reference to the postal code format validation used for the country
CountryCode (String) - Unique country code

Parameters:

username (String) - The username for which to retrieve the list of countries. An exception will be thrown if the username does not exist.

Returns:

An array of Country objects for the specified user

Possible Exceptions:

INVALID USERNAME

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>
    <GetCountries xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetCountries>
  </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>
    <GetCountriesResponse xmlns="Logisense_EngageIP">
      <GetCountriesResult>
        <Country>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <SortOrder>int</SortOrder>
          <OwnerID>int</OwnerID>
          <CountryAddressFormatID>int</CountryAddressFormatID>
          <DataTypePostalCodeID>int</DataTypePostalCodeID>
          <CountryCode>string</CountryCode>
        </Country>
        <Country>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <SortOrder>int</SortOrder>
          <OwnerID>int</OwnerID>
          <CountryAddressFormatID>int</CountryAddressFormatID>
          <DataTypePostalCodeID>int</DataTypePostalCodeID>
          <CountryCode>string</CountryCode>
        </Country>
      </GetCountriesResult>
    </GetCountriesResponse>
  </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/GetCountries"

<?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>
    <GetCountries xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetCountries>
  </soap:Body>
</soap:Envelope>