Clear Voice Surveys API Web Service

Clear Voice Surveys API

Click here for a complete list of operations.

GetMemberByEmailAddress

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/GetMemberByEmailAddress"

<?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>
    <GetMemberByEmailAddress xmlns="http://api.clearvoicesurveys.com/">
      <orgGUID>string</orgGUID>
      <emailAddress>string</emailAddress>
    </GetMemberByEmailAddress>
  </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>
    <GetMemberByEmailAddressResponse xmlns="http://api.clearvoicesurveys.com/">
      <GetMemberByEmailAddressResult>
        <Member>
          <MemberId>int</MemberId>
          <MemberGuid>guid</MemberGuid>
          <OrgId>int</OrgId>
          <ReferrerId>int</ReferrerId>
          <SourceId>int</SourceId>
          <MemberTypeCode>string</MemberTypeCode>
          <SubId1>string</SubId1>
          <SubId2>string</SubId2>
          <SubId3>string</SubId3>
          <IsActive>boolean</IsActive>
          <IsEnabled>boolean</IsEnabled>
          <IsDeleted>boolean</IsDeleted>
          <IsDoi>boolean</IsDoi>
          <IsBounce>boolean</IsBounce>
          <IsDnc>boolean</IsDnc>
          <IsFraud>boolean</IsFraud>
          <IsScrub>boolean</IsScrub>
          <IsRegpath>boolean</IsRegpath>
          <Gender>string</Gender>
          <LoginCount>short</LoginCount>
          <FailedLoginCount>short</FailedLoginCount>
          <FraudReasonId>int</FraudReasonId>
          <IpCountryId>int</IpCountryId>
          <CountryId>int</CountryId>
          <EmailAddress>string</EmailAddress>
          <AddDate>dateTime</AddDate>
          <AddDt>dateTime</AddDt>
          <UpdateDt>dateTime</UpdateDt>
          <ComplaintCount>int</ComplaintCount>
          <CountDemographic>short</CountDemographic>
          <IsActiveOverride>boolean</IsActiveOverride>
          <LocalizedCultureId>int</LocalizedCultureId>
          <VerifiedBitField>short</VerifiedBitField>
          <IsDigestEmailEnabled>boolean</IsDigestEmailEnabled>
          <IsAvailableEmail>boolean</IsAvailableEmail>
          <IsAvailableDynamic>boolean</IsAvailableDynamic>
          <IsDoNotInvite>boolean</IsDoNotInvite>
          <CancellationReasonId>int</CancellationReasonId>
          <CurrencyId>int</CurrencyId>
          <IsSmsInvitationsOptIn>boolean</IsSmsInvitationsOptIn>
          <SmsInvitationsOptInDt>dateTime</SmsInvitationsOptInDt>
          <MiddleName>string</MiddleName>
          <DoNotInviteDt>dateTime</DoNotInviteDt>
          <CancellationDt>dateTime</CancellationDt>
          <ActiveOverrideDt>dateTime</ActiveOverrideDt>
          <CarrierId>int</CarrierId>
          <IsScrubRewards>boolean</IsScrubRewards>
          <ReactivateDt>dateTime</ReactivateDt>
          <LastComplaintDt>dateTime</LastComplaintDt>
          <UpdateBy>string</UpdateBy>
          <AddBy>string</AddBy>
          <Password>string</Password>
          <Dob>dateTime</Dob>
          <ZipCode>string</ZipCode>
          <ZipCodePlus4>string</ZipCodePlus4>
          <HomePhone>string</HomePhone>
          <WorkPhone>string</WorkPhone>
          <MobilePhone>string</MobilePhone>
          <MemberInactiveDate>dateTime</MemberInactiveDate>
          <MemberDuration>int</MemberDuration>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <IsAddressVerified>boolean</IsAddressVerified>
          <City>string</City>
          <StateId>int</StateId>
          <ScrubDt>dateTime</ScrubDt>
          <IpAddress>string</IpAddress>
          <DoiIpAddress>string</DoiIpAddress>
          <LastLogonDt>dateTime</LastLogonDt>
          <DeleteDt>dateTime</DeleteDt>
          <DoiDt>dateTime</DoiDt>
          <BounceDt>dateTime</BounceDt>
          <DncDt>dateTime</DncDt>
          <FraudDt>dateTime</FraudDt>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MemberExternalId>string</MemberExternalId>
          <History>
            <History xsi:nil="true" />
            <History xsi:nil="true" />
          </History>
          <MemberAchievements>
            <Achievement xsi:nil="true" />
            <Achievement xsi:nil="true" />
          </MemberAchievements>
          <CompletedSurveys>int</CompletedSurveys>
          <PhysicianData>
            <member_id>int</member_id>
            <upin>string</upin>
            <kol_email_1>string</kol_email_1>
            <kol_email_2>string</kol_email_2>
            <kol_first_name_1>string</kol_first_name_1>
            <kol_first_name_2>string</kol_first_name_2>
            <kol_last_name_1>string</kol_last_name_1>
            <kol_last_name_2>string</kol_last_name_2>
            <is_kol>boolean</is_kol>
            <fax_number>string</fax_number>
            <me_number>string</me_number>
            <business_phone>string</business_phone>
            <practice_name>string</practice_name>
            <member xsi:nil="true" />
          </PhysicianData>
          <MedicalProfession>int</MedicalProfession>
        </Member>
      </GetMemberByEmailAddressResult>
    </GetMemberByEmailAddressResponse>
  </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>
    <GetMemberByEmailAddress xmlns="http://api.clearvoicesurveys.com/">
      <orgGUID>string</orgGUID>
      <emailAddress>string</emailAddress>
    </GetMemberByEmailAddress>
  </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>
    <GetMemberByEmailAddressResponse xmlns="http://api.clearvoicesurveys.com/">
      <GetMemberByEmailAddressResult>
        <Member>
          <MemberId>int</MemberId>
          <MemberGuid>guid</MemberGuid>
          <OrgId>int</OrgId>
          <ReferrerId>int</ReferrerId>
          <SourceId>int</SourceId>
          <MemberTypeCode>string</MemberTypeCode>
          <SubId1>string</SubId1>
          <SubId2>string</SubId2>
          <SubId3>string</SubId3>
          <IsActive>boolean</IsActive>
          <IsEnabled>boolean</IsEnabled>
          <IsDeleted>boolean</IsDeleted>
          <IsDoi>boolean</IsDoi>
          <IsBounce>boolean</IsBounce>
          <IsDnc>boolean</IsDnc>
          <IsFraud>boolean</IsFraud>
          <IsScrub>boolean</IsScrub>
          <IsRegpath>boolean</IsRegpath>
          <Gender>string</Gender>
          <LoginCount>short</LoginCount>
          <FailedLoginCount>short</FailedLoginCount>
          <FraudReasonId>int</FraudReasonId>
          <IpCountryId>int</IpCountryId>
          <CountryId>int</CountryId>
          <EmailAddress>string</EmailAddress>
          <AddDate>dateTime</AddDate>
          <AddDt>dateTime</AddDt>
          <UpdateDt>dateTime</UpdateDt>
          <ComplaintCount>int</ComplaintCount>
          <CountDemographic>short</CountDemographic>
          <IsActiveOverride>boolean</IsActiveOverride>
          <LocalizedCultureId>int</LocalizedCultureId>
          <VerifiedBitField>short</VerifiedBitField>
          <IsDigestEmailEnabled>boolean</IsDigestEmailEnabled>
          <IsAvailableEmail>boolean</IsAvailableEmail>
          <IsAvailableDynamic>boolean</IsAvailableDynamic>
          <IsDoNotInvite>boolean</IsDoNotInvite>
          <CancellationReasonId>int</CancellationReasonId>
          <CurrencyId>int</CurrencyId>
          <IsSmsInvitationsOptIn>boolean</IsSmsInvitationsOptIn>
          <SmsInvitationsOptInDt>dateTime</SmsInvitationsOptInDt>
          <MiddleName>string</MiddleName>
          <DoNotInviteDt>dateTime</DoNotInviteDt>
          <CancellationDt>dateTime</CancellationDt>
          <ActiveOverrideDt>dateTime</ActiveOverrideDt>
          <CarrierId>int</CarrierId>
          <IsScrubRewards>boolean</IsScrubRewards>
          <ReactivateDt>dateTime</ReactivateDt>
          <LastComplaintDt>dateTime</LastComplaintDt>
          <UpdateBy>string</UpdateBy>
          <AddBy>string</AddBy>
          <Password>string</Password>
          <Dob>dateTime</Dob>
          <ZipCode>string</ZipCode>
          <ZipCodePlus4>string</ZipCodePlus4>
          <HomePhone>string</HomePhone>
          <WorkPhone>string</WorkPhone>
          <MobilePhone>string</MobilePhone>
          <MemberInactiveDate>dateTime</MemberInactiveDate>
          <MemberDuration>int</MemberDuration>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <IsAddressVerified>boolean</IsAddressVerified>
          <City>string</City>
          <StateId>int</StateId>
          <ScrubDt>dateTime</ScrubDt>
          <IpAddress>string</IpAddress>
          <DoiIpAddress>string</DoiIpAddress>
          <LastLogonDt>dateTime</LastLogonDt>
          <DeleteDt>dateTime</DeleteDt>
          <DoiDt>dateTime</DoiDt>
          <BounceDt>dateTime</BounceDt>
          <DncDt>dateTime</DncDt>
          <FraudDt>dateTime</FraudDt>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MemberExternalId>string</MemberExternalId>
          <History>
            <History xsi:nil="true" />
            <History xsi:nil="true" />
          </History>
          <MemberAchievements>
            <Achievement xsi:nil="true" />
            <Achievement xsi:nil="true" />
          </MemberAchievements>
          <CompletedSurveys>int</CompletedSurveys>
          <PhysicianData>
            <member_id>int</member_id>
            <upin>string</upin>
            <kol_email_1>string</kol_email_1>
            <kol_email_2>string</kol_email_2>
            <kol_first_name_1>string</kol_first_name_1>
            <kol_first_name_2>string</kol_first_name_2>
            <kol_last_name_1>string</kol_last_name_1>
            <kol_last_name_2>string</kol_last_name_2>
            <is_kol>boolean</is_kol>
            <fax_number>string</fax_number>
            <me_number>string</me_number>
            <business_phone>string</business_phone>
            <practice_name>string</practice_name>
            <member xsi:nil="true" />
          </PhysicianData>
          <MedicalProfession>int</MedicalProfession>
        </Member>
      </GetMemberByEmailAddressResult>
    </GetMemberByEmailAddressResponse>
  </soap12:Body>
</soap12:Envelope>