isave.API


Click here for a complete list of operations.

GetContactsFromSFTP

Downloads file with contacts from (s)ftp server to isave.DIALOG (sftpAddress = IP address), Foldername (on sftp server, if located on root set foldername=NULL) format 'bigcompany/files/images/', Filename must always be unique and end with .csv/txt, unless if its a zip file (isZip = true, can only contain one file with .csv extention). ListName in isave.DIALOG will be the same as fileName. Delete = true : deletes file from sftp after download. Set DatalistID = 0 if you want a new datalist to be created, UpdateColumn : 1 = Email, 2 = ExtContactNumber

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
username:
password:
CompanyID:
sFtpAddress:
sFtpUserName:
sFtpPassword:
sFtpFolder:
DatalistID:
IsZip:
UpdateColumn:
Delete:

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 /mrm/services/api.asmx HTTP/1.1
Host: portal.isave.no
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://isave.no/GetContactsFromSFTP"

<?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>
    <GetContactsFromSFTP xmlns="http://isave.no/">
      <username>string</username>
      <password>string</password>
      <CompanyID>int</CompanyID>
      <sFtpAddress>string</sFtpAddress>
      <sFtpUserName>string</sFtpUserName>
      <sFtpPassword>string</sFtpPassword>
      <sFtpFolder>string</sFtpFolder>
      <DatalistID>int</DatalistID>
      <IsZip>boolean</IsZip>
      <UpdateColumn>int</UpdateColumn>
      <Delete>boolean</Delete>
    </GetContactsFromSFTP>
  </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>
    <GetContactsFromSFTPResponse xmlns="http://isave.no/" />
  </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 /mrm/services/api.asmx HTTP/1.1
Host: portal.isave.no
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>
    <GetContactsFromSFTP xmlns="http://isave.no/">
      <username>string</username>
      <password>string</password>
      <CompanyID>int</CompanyID>
      <sFtpAddress>string</sFtpAddress>
      <sFtpUserName>string</sFtpUserName>
      <sFtpPassword>string</sFtpPassword>
      <sFtpFolder>string</sFtpFolder>
      <DatalistID>int</DatalistID>
      <IsZip>boolean</IsZip>
      <UpdateColumn>int</UpdateColumn>
      <Delete>boolean</Delete>
    </GetContactsFromSFTP>
  </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>
    <GetContactsFromSFTPResponse xmlns="http://isave.no/" />
  </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 /mrm/services/api.asmx/GetContactsFromSFTP?username=string&password=string&CompanyID=string&sFtpAddress=string&sFtpUserName=string&sFtpPassword=string&sFtpFolder=string&DatalistID=string&IsZip=string&UpdateColumn=string&Delete=string HTTP/1.1
Host: portal.isave.no

HTTP/1.1 200 OK

HTTP POST

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

POST /mrm/services/api.asmx/GetContactsFromSFTP HTTP/1.1
Host: portal.isave.no
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&CompanyID=string&sFtpAddress=string&sFtpUserName=string&sFtpPassword=string&sFtpFolder=string&DatalistID=string&IsZip=string&UpdateColumn=string&Delete=string
HTTP/1.1 200 OK