iSAMS Customer API Web Service

iSAMS Customer API

Click here for a complete list of operations.

Export

Exports all customers with the specified file type retrievable via HTTP.

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

<?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>
    <Export xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <exportSettings>
        <Path>string</Path>
        <RecordsPerFile>int</RecordsPerFile>
        <Format>CSV or JSON or XML</Format>
        <FilenamePrefix>string</FilenamePrefix>
      </exportSettings>
    </Export>
  </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>
    <ExportResponse xmlns="http://www.estaronline.com/api/">
      <ExportResult>
        <Data>
          <string>string</string>
          <string>string</string>
        </Data>
      </ExportResult>
    </ExportResponse>
  </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/Customers.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>
    <Export xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <exportSettings>
        <Path>string</Path>
        <RecordsPerFile>int</RecordsPerFile>
        <Format>CSV or JSON or XML</Format>
        <FilenamePrefix>string</FilenamePrefix>
      </exportSettings>
    </Export>
  </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>
    <ExportResponse xmlns="http://www.estaronline.com/api/">
      <ExportResult>
        <Data>
          <string>string</string>
          <string>string</string>
        </Data>
      </ExportResult>
    </ExportResponse>
  </soap12:Body>
</soap12:Envelope>