Vous êtes sur la page 1sur 9

The iSURVEY Export Web Service API

Version: 1 Page 1 of 9


Consuming the iSURVEY Export Web Service v5
The web service
The iSURVEY Export Web Service uses SOAP for communication.
The Export Web Service URL: https://www.isurveysoft.com/servicesv5/exportservice.asmx
The Export Web Service WSDL: https://www.isurveysoft.com/servicesv5/exportservice.asmx?wsdl
There are two Web Service operations exposed by this webservice ExportSurvey and
ExportSurveyResults. These two operations are intended to be used together - the ExportSurvey response
contains reference information needed to interpret the ExportSurveyResults response data.
The operations provided use up to four message parameters Company Identifier, Survey Password,
Results Surveyed From Date, Results Surveyed To Date. For more information about obtaining the
Company Identifier and Survey Password, see iSURVEY Company Identifier and Survey Password.
ExportSurvey provides the question and answer sets for the survey.
ExportSurveyResults provides the survey result set in XML which would otherwise be provided as a CSV
file.


The iSURVEY Export Web Service API

Version: 1 Page 2 of 9


Web Service Operation - Export Survey
This ExportSurvey Web Service operation accepts two parameters the Company Identifier(cp), and the
Survey PIN (sp) for authentication.
Information on where to find the Company Identifier and the Survey PIN on the isurveysoft.com web site
is described at the end of this document.
REQUEST
The sample SOAP request is provided below for SOAP 1.1 and 1.2.
SOAP 1.1
POST /servicesv5/exportservice.asmx HTTP/1.1
Host: www.isurveysoft.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.isurveysoft.com/servicesv5/ExportSurvey"

<?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>
<ExportSurvey xmlns="https://www.isurveysoft.com/servicesv5/">
<cp>string</cp>
<sp>string</sp>
</ExportSurvey>
</soap:Body>
</soap:Envelope>
SOAP 1.2
POST /servicesv5/exportservice.asmx HTTP/1.1
Host: www.isurveysoft.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>
<ExportSurvey xmlns="https://www.isurveysoft.com/servicesv5/">
<cp>string</cp>
<sp>string</sp>
</ExportSurvey>
</soap12:Body>
</soap12:Envelope>


The iSURVEY Export Web Service API

Version: 1 Page 3 of 9


RESPONSE
The Survey is exported as a Serialised Survey object. The sample SOAP response is provided below for
SOAP 1.1 and 1.2.
SOAP 1.1
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>
<ExportSurveyResponse xmlns="https://www.isurveysoft.com/servicesv5/">
<ExportSurveyResult>
<SurveyId>long</SurveyId>
<SurveyName>string</SurveyName>
<ScreenIdFirst>long</ScreenIdFirst>
<SurveyThemeId>long</SurveyThemeId>
<SurveyTestMode>boolean</SurveyTestMode>
<SurveyVersion>long</SurveyVersion>
<SurveyIsPurchased>boolean</SurveyIsPurchased>
<IsDemoSurvey>boolean</IsDemoSurvey>
<Screens>
<Screen type="string" nextScreenIsLinked="boolean">
<ScreenId>long</ScreenId>
<ScreenIdNext>long</ScreenIdNext>
<ScreenText>string</ScreenText>
<ScreenInstruction>string</ScreenInstruction>
<ThemeClassId>long</ThemeClassId>
<ScreenOptions xsi:nil="true" />
<Answers xsi:nil="true" />
<Questions xsi:nil="true" />
</Screen>
<Screen type="string" nextScreenIsLinked="boolean">
<ScreenId>long</ScreenId>
<ScreenIdNext>long</ScreenIdNext>
<ScreenText>string</ScreenText>
<ScreenInstruction>string</ScreenInstruction>
<ThemeClassId>long</ThemeClassId>
<ScreenOptions xsi:nil="true" />
<Answers xsi:nil="true" />
<Questions xsi:nil="true" />
</Screen>
</Screens>
<SurveyOptions>
<SurveyOption>
<SurveyOptionRefCode>string</SurveyOptionRefCode>
<SurveyOptionValueText>string</SurveyOptionValueText>
</SurveyOption>
<SurveyOption>
<SurveyOptionRefCode>string</SurveyOptionRefCode>
<SurveyOptionValueText>string</SurveyOptionValueText>
</SurveyOption>
</SurveyOptions>
</ExportSurveyResult>
</ExportSurveyResponse>
</soap:Body></soap:Envelope>


The iSURVEY Export Web Service API

Version: 1 Page 4 of 9


SOAP 1.2
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>
<ExportSurveyResponse xmlns="https://www.isurveysoft.com/servicesv5/">
<ExportSurveyResult>
<SurveyId>long</SurveyId>
<SurveyName>string</SurveyName>
<ScreenIdFirst>long</ScreenIdFirst>
<SurveyThemeId>long</SurveyThemeId>
<SurveyTestMode>boolean</SurveyTestMode>
<SurveyVersion>long</SurveyVersion>
<SurveyIsPurchased>boolean</SurveyIsPurchased>
<IsDemoSurvey>boolean</IsDemoSurvey>
<Screens>
<Screen type="string" nextScreenIsLinked="boolean">
<ScreenId>long</ScreenId>
<ScreenIdNext>long</ScreenIdNext>
<ScreenText>string</ScreenText>
<ScreenInstruction>string</ScreenInstruction>
<ThemeClassId>long</ThemeClassId>
<ScreenOptions xsi:nil="true" />
<Answers xsi:nil="true" />
<Questions xsi:nil="true" />
</Screen>
<Screen type="string" nextScreenIsLinked="boolean">
<ScreenId>long</ScreenId>
<ScreenIdNext>long</ScreenIdNext>
<ScreenText>string</ScreenText>
<ScreenInstruction>string</ScreenInstruction>
<ThemeClassId>long</ThemeClassId>
<ScreenOptions xsi:nil="true" />
<Answers xsi:nil="true" />
<Questions xsi:nil="true" />
</Screen>
</Screens>
<SurveyOptions>
<SurveyOption>
<SurveyOptionRefCode>string</SurveyOptionRefCode>
<SurveyOptionValueText>string</SurveyOptionValueText>
</SurveyOption>
<SurveyOption>
<SurveyOptionRefCode>string</SurveyOptionRefCode>
<SurveyOptionValueText>string</SurveyOptionValueText>
</SurveyOption>
</SurveyOptions>
</ExportSurveyResult>
</ExportSurveyResponse>
</soap12:Body>
</soap12:Envelope>

The iSURVEY Export Web Service API

Version: 1 Page 5 of 9


Web Service Operation - Export Survey Results
The survey results webmethod is to be used to export uploaded survey results from iSURVEY. This method
accepts four parameters your Company Identifier (cp) and the Survey PIN (sp), Results Surveyed From
Date (fromDate), Results Surveyed To Date (toDate).
Supplying values for the toDate and/or fromDate is optional. If you wish to use these, the dates must be
supplied in the Date Format yyyy-MM-dd (year-month-date). E.g. 2010-12-31 represents 31 Dec 2010.
REQUEST
The sample SOAP request is provided below for SOAP 1.1 and 1.2.
SOAP 1.1Message
POST /servicesv5/exportservice.asmx HTTP/1.1
Host: www.isurveysoft.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.isurveysoft.com/servicesv5/ExportSurveyResults"

<?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>
<ExportSurveyResults xmlns="https://www.isurveysoft.com/servicesv5/">
<cp>string</cp>
<sp>string</sp>
<fromDate>string</fromDate>
<toDate>string</toDate>
</ExportSurveyResults>
</soap:Body>
</soap:Envelope>

SOAP 1.2 Message
POST /servicesv5/exportservice.asmx HTTP/1.1
Host: www.isurveysoft.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>
<ExportSurveyResults xmlns="https://www.isurveysoft.com/servicesv5/">
<cp>string</cp>
<sp>string</sp>
<fromDate>string</fromDate>
<toDate>string</toDate>
</ExportSurveyResults>
</soap12:Body>
</soap12:Envelope>



The iSURVEY Export Web Service API

Version: 1 Page 6 of 9


RESULTS
The sample SOAP response is provided below for SOAP 1.1 and 1.2.
SOAP 1.1Message
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>
<ExportSurveyResultsResponse
xmlns="https://www.isurveysoft.com/servicesv5/">
<ExportSurveyResultsResult>
<SurveyResult>
<ScreenResults>
<Result xsi:nil="true" />
<Result xsi:nil="true" />
</ScreenResults>
<ResultId>long</ResultId>
<ResultDeviceName>string</ResultDeviceName>
<IsDemoSurvey>boolean</IsDemoSurvey>
<SurveyId>long</SurveyId>
<SurveyVersion>long</SurveyVersion>
<SurveyStartDate>string</SurveyStartDate>
<SurveyEndDate>string</SurveyEndDate>
<ResultLocationAccuracy>double</ResultLocationAccuracy>
<ResultLocationAltitude>double</ResultLocationAltitude>
<ResultLocationLatitude>double</ResultLocationLatitude>
<ResultLocationLongitude>double</ResultLocationLongitude>
<ResultDeviceGuid>string</ResultDeviceGuid>
<ResultLocationStatus>long</ResultLocationStatus>
<IsIncomplete>boolean</IsIncomplete>
</SurveyResult>
<SurveyResult>
<ScreenResults>
<Result xsi:nil="true" />
<Result xsi:nil="true" />
</ScreenResults>
<ResultId>long</ResultId>
<ResultDeviceName>string</ResultDeviceName>
<IsDemoSurvey>boolean</IsDemoSurvey>
<SurveyId>long</SurveyId>
<SurveyVersion>long</SurveyVersion>
<SurveyStartDate>string</SurveyStartDate>
<SurveyEndDate>string</SurveyEndDate>
<ResultLocationAccuracy>double</ResultLocationAccuracy>
<ResultLocationAltitude>double</ResultLocationAltitude>
<ResultLocationLatitude>double</ResultLocationLatitude>
<ResultLocationLongitude>double</ResultLocationLongitude>
<ResultDeviceGuid>string</ResultDeviceGuid>
<ResultLocationStatus>long</ResultLocationStatus>
<IsIncomplete>boolean</IsIncomplete>
</SurveyResult>
</ExportSurveyResultsResult>
</ExportSurveyResultsResponse>
</soap:Body>
</soap:Envelope>

The iSURVEY Export Web Service API

Version: 1 Page 7 of 9



SOAP 1.2 Message
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>
<ExportSurveyResultsResponse
xmlns="https://www.isurveysoft.com/servicesv5/">
<ExportSurveyResultsResult>
<SurveyResult>
<ScreenResults>
<Result xsi:nil="true" />
<Result xsi:nil="true" />
</ScreenResults>
<ResultId>long</ResultId>
<ResultDeviceName>string</ResultDeviceName>
<IsDemoSurvey>boolean</IsDemoSurvey>
<SurveyId>long</SurveyId>
<SurveyVersion>long</SurveyVersion>
<SurveyStartDate>string</SurveyStartDate>
<SurveyEndDate>string</SurveyEndDate>
<ResultLocationAccuracy>double</ResultLocationAccuracy>
<ResultLocationAltitude>double</ResultLocationAltitude>
<ResultLocationLatitude>double</ResultLocationLatitude>
<ResultLocationLongitude>double</ResultLocationLongitude>
<ResultDeviceGuid>string</ResultDeviceGuid>
<ResultLocationStatus>long</ResultLocationStatus>
<IsIncomplete>boolean</IsIncomplete>
</SurveyResult>
</SurveyResult>
<SurveyResult>
<ScreenResults>
<Result xsi:nil="true" />
<Result xsi:nil="true" />
</ScreenResults>
<ResultId>long</ResultId>
<ResultDeviceName>string</ResultDeviceName>
<IsDemoSurvey>boolean</IsDemoSurvey>
<SurveyId>long</SurveyId>
<SurveyVersion>long</SurveyVersion>
<SurveyStartDate>string</SurveyStartDate>
<SurveyEndDate>string</SurveyEndDate>
<ResultLocationAccuracy>double</ResultLocationAccuracy>
<ResultLocationAltitude>double</ResultLocationAltitude>
<ResultLocationLatitude>double</ResultLocationLatitude>
<ResultLocationLongitude>double</ResultLocationLongitude>
<ResultDeviceGuid>string</ResultDeviceGuid>
<ResultLocationStatus>long</ResultLocationStatus>
<IsIncomplete>boolean</IsIncomplete>
</SurveyResult>
</ExportSurveyResultsResult>
</ExportSurveyResultsResponse>
</soap12:Body>
</soap12:Envelope>

The iSURVEY Export Web Service API

Version: 1 Page 8 of 9




The iSURVEY Export Web Service API

Version: 1 Page 9 of 9


iSURVEY Company Identifier and Survey Password
To access your Company Identifier, follow these steps:
1. Log in to your iSURVEY account using https://www.isurveysoft.com/Account/LogOn
2. Navigate to https://www.isurveysoft.com/Account
3. Your Company Identifier is located on this screen before your Company Name.
To access your survey password, follow these steps:
1. Log into your iSURVEY account using https://www.isurveysoft.com/Account/LogOn
2. Select the survey you wish to export from the Survey Management Screen
https://www.isurveysoft.com/Survey
3. Select the 4. Test tab. Click the Secure Preview button. Your survey password can be found
here:

Vous aimerez peut-être aussi