Clear Voice Surveys API Web Service

Clear Voice Surveys API

Click here for a complete list of operations.

GetAvailableSurveys

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 /CVSWebservices.asmx HTTP/1.1
Host: api.clearvoicesurveys.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.clearvoicesurveys.com/GetAvailableSurveys"

<?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>
    <GetAvailableSurveys xmlns="http://api.clearvoicesurveys.com/">
      <orgGUID>string</orgGUID>
      <memberGUID>string</memberGUID>
    </GetAvailableSurveys>
  </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>
    <GetAvailableSurveysResponse xmlns="http://api.clearvoicesurveys.com/">
      <GetAvailableSurveysResult>
        <AvailableSurveys>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
        </AvailableSurveys>
        <RewardBalance>decimal</RewardBalance>
        <PendingRewards>decimal</PendingRewards>
        <DynamicSurveys>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
        </DynamicSurveys>
      </GetAvailableSurveysResult>
    </GetAvailableSurveysResponse>
  </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 /CVSWebservices.asmx HTTP/1.1
Host: api.clearvoicesurveys.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>
    <GetAvailableSurveys xmlns="http://api.clearvoicesurveys.com/">
      <orgGUID>string</orgGUID>
      <memberGUID>string</memberGUID>
    </GetAvailableSurveys>
  </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>
    <GetAvailableSurveysResponse xmlns="http://api.clearvoicesurveys.com/">
      <GetAvailableSurveysResult>
        <AvailableSurveys>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
        </AvailableSurveys>
        <RewardBalance>decimal</RewardBalance>
        <PendingRewards>decimal</PendingRewards>
        <DynamicSurveys>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
          <Survey>
            <SurveyGUID>string</SurveyGUID>
            <ProjectQuotaId>int</ProjectQuotaId>
            <ProjectQuotaGuid>string</ProjectQuotaGuid>
            <SurveyId>int</SurveyId>
            <SurveyName>string</SurveyName>
            <SurveyUrl>string</SurveyUrl>
            <RewardAmount>decimal</RewardAmount>
            <RewardText>string</RewardText>
            <SurveyLength>int</SurveyLength>
            <SurveyCategoryImage>string</SurveyCategoryImage>
            <SurveyCategoryClass>string</SurveyCategoryClass>
            <IsQuickSurvey>boolean</IsQuickSurvey>
            <RecencyScore>int</RecencyScore>
            <DashboardScore>decimal</DashboardScore>
            <ProjectOpenDt>dateTime</ProjectOpenDt>
            <ProjectId>int</ProjectId>
          </Survey>
        </DynamicSurveys>
      </GetAvailableSurveysResult>
    </GetAvailableSurveysResponse>
  </soap12:Body>
</soap12:Envelope>