OnlineAPI


Click here for a complete list of operations.

GetCountryStates

This will return the available states for one country or all states stored by country. Optional Inputs: Country are optional, if you don't provide a Country, complete list of states and country will be returned. INVALID_CREDENTIALS:Means that credentials are incorrect or invalid. COUNTRY_NOT_FOUND: Means that provided Country was not found in the system or no Country States are setup. TRANSACTION_DISPATCHED_EXCEPTION: In case we get an error in the transaction, we will comunicate that by this message. SUCCESS: Means that API method retrieved country states correctly. Deprecation Note: This API has been deprecated in favor of our REST API: ~/api/order/Address/CountryStates?cartCountry={cartCountry}.

Test

The test form is only available for requests from the local machine.

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/GetCountryStates"

<?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:Body>
    <GetCountryStates xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Country>string</Country>
    </GetCountryStates>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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:Body>
    <GetCountryStatesResponse xmlns="http://www.securefreedom.com/">
      <GetCountryStatesResult>
        <CountryStateList>
          <CountryStatesRecord>
            <Country>string</Country>
            <State>string</State>
            <Abbreviation>string</Abbreviation>
            <Active>boolean</Active>
            <SortOrder>int</SortOrder>
          </CountryStatesRecord>
          <CountryStatesRecord>
            <Country>string</Country>
            <State>string</State>
            <Abbreviation>string</Abbreviation>
            <Active>boolean</Active>
            <SortOrder>int</SortOrder>
          </CountryStatesRecord>
        </CountryStateList>
      </GetCountryStatesResult>
    </GetCountryStatesResponse>
  </soap:Body>
</soap:Envelope>

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.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:Body>
    <GetCountryStates xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Country>string</Country>
    </GetCountryStates>
  </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>
    <GetCountryStatesResponse xmlns="http://www.securefreedom.com/">
      <GetCountryStatesResult>
        <CountryStateList>
          <CountryStatesRecord>
            <Country>string</Country>
            <State>string</State>
            <Abbreviation>string</Abbreviation>
            <Active>boolean</Active>
            <SortOrder>int</SortOrder>
          </CountryStatesRecord>
          <CountryStatesRecord>
            <Country>string</Country>
            <State>string</State>
            <Abbreviation>string</Abbreviation>
            <Active>boolean</Active>
            <SortOrder>int</SortOrder>
          </CountryStatesRecord>
        </CountryStateList>
      </GetCountryStatesResult>
    </GetCountryStatesResponse>
  </soap12:Body>
</soap12:Envelope>