iSAMS Stores API


Click here for a complete list of operations.

ListAreasByName

List all store areas by name.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
authenticationToken:
areaName:

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 /global/api/Stores.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/ListAreasByName"

<?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>
    <ListAreasByName xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <areaName>string</areaName>
    </ListAreasByName>
  </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>
    <ListAreasByNameResponse xmlns="http://www.estaronline.com/api/">
      <ListAreasByNameResult>
        <Data>
          <Area>
            <Name>string</Name>
            <Country>string</Country>
          </Area>
          <Area>
            <Name>string</Name>
            <Country>string</Country>
          </Area>
        </Data>
      </ListAreasByNameResult>
    </ListAreasByNameResponse>
  </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 /global/api/Stores.asmx HTTP/1.1
Host: demo.viare.io
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>
    <ListAreasByName xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <areaName>string</areaName>
    </ListAreasByName>
  </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>
    <ListAreasByNameResponse xmlns="http://www.estaronline.com/api/">
      <ListAreasByNameResult>
        <Data>
          <Area>
            <Name>string</Name>
            <Country>string</Country>
          </Area>
          <Area>
            <Name>string</Name>
            <Country>string</Country>
          </Area>
        </Data>
      </ListAreasByNameResult>
    </ListAreasByNameResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /global/api/Stores.asmx/ListAreasByName?authenticationToken=string&areaName=string HTTP/1.1
Host: demo.viare.io
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AreaApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Area>
      <Name>string</Name>
      <Country>string</Country>
    </Area>
    <Area>
      <Name>string</Name>
      <Country>string</Country>
    </Area>
  </Data>
</AreaApiResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /global/api/Stores.asmx/ListAreasByName HTTP/1.1
Host: demo.viare.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authenticationToken=string&areaName=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AreaApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Area>
      <Name>string</Name>
      <Country>string</Country>
    </Area>
    <Area>
      <Name>string</Name>
      <Country>string</Country>
    </Area>
  </Data>
</AreaApiResponse>