examinare
Kirjaudu sisään
Valitse kieli English
Aloita Examinare-tili

Examinare API - Yleiskatsaus

Aloita Examinaren kyselytyökalu API:n käyttö

Video-opas Examinare API:n aktivoinnista

Aktivoi Examinaren kyselytyökalu API

Punainen XML-data lähetetään HTTPS-protokollan kautta POST-datana, joten se ei ole käytettävissä HTTPS-protokollan kautta.
Tämän asiakirjan alussa on yhteenveto käytettävissä olevista toiminnoista, ja sen jälkeen on yksityiskohtaisempi osa, jossa kerrotaan tarkemmin toiminnoista.

Kaikkien toimintojen URL-osoite on
https://api.examinare.com/framework
Yhteyden muodostamiseksi sinun täytyy lisätä kolme komentoa POST-tietoihin:

apiKey – Tämän tarjoaa Examinare tililläsi.
apiCompany – Käytettävä yritystietokanta.
Komento – Komento, jonka annat puhelulle.
Huomaa: Lisää komentoja saattaa tarvita sen mukaan, mitä funktiota kutsut.

Mobile API ja ei-jaettu API avaimet.

Jos jostain syystä haluat pitää API-avaimesi yksityisenä ja käyttää Login-tyyppistä tyyliä Static Examinare API -avaimen sijaan, voit käyttää Mobile API -komentoa. setPhoneID, tätä komentoa voidaan käyttää Mobile API -tunnuksen saamiseen, jota voidaan käyttää staattisen API-tunnuksen sijaan.  Kaikki mobiili API -tunnukset voidaan poistaa milloin tahansa Examinare-tililtäsi kohdassa Asetukset -> Lisäasetukset.

PHP Wrapper -kirjasto

PHP-esimerkki 
<?php 
class ExaminareAPIConnector{
public $credentials;
public $command;
public $sendinfo;
public $returnjson=0;

	public function __construct ($apiuser,$apikey,$apiurl){
		if($apiurl==""){$apiurl="api.examinare.com";}
		$url="https://".$apiurl."/framework";
		$companyid=$apiuser;
		$token=$apikey;


		$this->sendinfo['apiKey']=$token;
		$this->sendinfo['apiCompany']=$companyid;
		$this->sendinfo['url']=$url;
		
	}
	public function setCommand($Command){
		$this->sendinfo['Command']=$Command;
	}

	public function Data($sendinfo){
		foreach ($sendinfo as $key => $value)
    	{$this->sendinfo[$key]=$value;}
	}
	public function JsonEnable(){
		$this->returnjson=1;
	}
	public function Execute(){
		$sendinfo=$this->sendinfo;
		$method = "POST";
		$action=$this->sendinfo['url'];
		$fields="";
    	foreach ($sendinfo as $key => $value)
    	{
        	if ($key != 'url')
        	{
            	$fields .= $key . '=' . rawurlencode($value) . '&';
        	}
    	}
			$fields = substr($fields, 0, strlen($fields) - 1);
			$ch = curl_init();
    		curl_setopt($ch, CURLOPT_URL, $action);
    		curl_setopt($ch, CURLOPT_POST, 1);
    		curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
			$result = curl_exec($ch);
			$info_arrays = curl_getinfo($ch);
			curl_close($ch);
			if($result === false ){
				return false;
			}else{
				if($this->returnjson==1){
				return json_decode($result,1);
				}else{
				return $this->toArray(new SimpleXMLElement($result));
				}
			}
			
		}
		
	public function ExecuteRaw(){ // Used to get the raw file from the url.
		$sendinfo=$this->sendinfo;
		$method = "POST";
		$action=$this->sendinfo['url'];
		$fields="";
    	foreach ($sendinfo as $key => $value)
    	{
        	if ($key != 'url')
        	{
            	$fields .= $key . '=' . rawurlencode($value) . '&';
        	}
    	}
			$fields = substr($fields, 0, strlen($fields) - 1);
			$ch = curl_init();
    		curl_setopt($ch, CURLOPT_URL, $action);
    		curl_setopt($ch, CURLOPT_POST, 1);
    		curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
			$result = curl_exec($ch);
			$info_arrays = curl_getinfo($ch);
			curl_close($ch);
			if($result === false ){
				return false;
			}else{
				return $result;
			}
			
		}
	public function toArray($xml) {
        $array = json_decode(json_encode($xml), TRUE);
        
        foreach ( array_slice($array, 0) as $key => $value ) {
            if ( empty($value) ) $array[$key] = NULL;
            elseif ( is_array($value) ) $array[$key] = $this->toArray($value);
        }

        return $array;
    }
}
?>

PHP Wrapper Kirjastokoodi.

Ei latauksia TAI pitkiä readme-tiedostoja.

Kopioi vain koodi ja liitä se kohtaan, johon haluat sen.

Jos valitset tiedoston nimen ”examinare-api.php”, kaikki PHP-koodiesimerkit tällä sivustolla toimivat URL-osoitteiden kanssa.

Muussa tapauksessa sinun on päivitettävä koodin yläosassa oleva include-lauseke. PHP-wrapper on saatavilla osoitteessa GitHub. https://github.com/examinare/examinare-php-wrapper

setPhoneID (Käytä Mobile API)

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?>
<response> 
	<status>Success</status> 
	<tokens>
  		<token>UMOBI:7182101920d9s9f7d8f6d76f7sd8sd98as</token>
  		<cname>CNAME</cname>
	</tokens>
</response>

Yhdistettynä setPhoneID Voit luoda omia API-avaimia, jotka yhdistetään live-järjestelmänvalvojan käyttäjään verkkopalvelussasi. Examinare Sinun täytyy aktivoida Mobile Keys -toiminnot asetusten välilehdellä Android-puhelimessasi tai -tabletissasi. Examinare Kirjaudu sisään tiliisi.

POST-tietotiedot:
(Punaiset tiedot ovat pakollisia), kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia.

apiCompany Yrityksen tunnus
user Käyttäjätunnus tai sähköpostiosoite
pass Salasana sisäänkirjautumiseen MD5-salaus.
deviceInformation Valinnainen teksti, jolla kuvataan API-liitäntälaite. Näytetään tilin API-tunnusten luettelossa. API-tunnukset

Haluatko rakentaa Examinareen perustuvia ratkaisuja?

Tarjoamme kehittäjätilin, jota voidaan käyttää hiekkalaatikon luomiseen tai ulkoisten sovellusten rakentamiseen Examinare API:lle, jolloin asiakkaasi voivat käyttää ratkaisuasi Examinare-tilinsä kautta. Kehittäjätili on käytettävissä vain kehittäjille.

Kehittäjätilillä on kaikki normaalin tilin toiminnot, koska sen alhainen hinta ei voi käyttää näitä tilejä kaupalliseen käyttöön.

Kehittäjän tili
99 dollaria
  • Rajoittamattomat vastaukset, kyselyt ja vastaanottajat
  • Julkaise 1 kyselytutkimus samanaikaisesti
  • Valmis mallikirjasto
  • Vain sähköpostituki
  • Vuosittainen tilaus
  • Examinare API-käyttöoikeus
  • Ei kaupalliseen käyttöön

Järjestys

Tutkimukset

clearVotes

Ei esikatselua

Tyhjennä äänet kyselytutkimuksesta. Poistaa kaikki äänet kyselyssä, käytä varoen!

POST-tietotiedot:

(Punainen Postin tieto on pakollista, musta on valinnaista), kaikki POST-tietojen kuvatekstit erottavat kirjainkokoja.

surveyID Kyselyn ID Examinaressa.

Palautustiedot

Tämä API-kutsu palauttaa yksittäisen tilatiedon, jos se onnistuu, muussa tapauksessa virheviesti, että kyselyä ei löydy.

copySurvey

Ei esikatselua

Kopioi kysely ja palauta vasta luodun kyselyn tiedot.

POST-tietotiedot:

(Punainen Postin tieto on pakollista, musta on valinnaista), kaikki POST-tietojen kuvatekstit erottavat kirjainkokoja.

surveyID Kyselyn ID Examinaressa.
name Kyselyn nimi (Näytetään vain Tilillä)

Palautustiedot

Tämä API-kutsu palauttaa yksittäisen XML-kyselykontin, joka sisältää kyselyn tiedot, mukaan lukien kyselylomakkeen. surveyID Tätä käytetään kehykseen tehtävissä kutsuissa.

(Katso listSurveys muotoiluohjeita.)

fetchResults

PHP-esimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("fetchResults");
	
      
                        
	$api2->Data(array("surveyID"=>"REPLACE WITH YOUR SURVEY ID"));
	// Timestamps are not needed but good to use.
	//This example below is for results between 1 january 2015 and 31 december 2015.
	$api2->Data(array("timestamp1"=>1420070400));//01/01/2015 @ 12:00am (UTC)
	$api2->Data(array("timestamp2"=>1451606400));//01/01/2016 @ 12:00am (UTC)
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Survey Results ready to use.*/
                        
?>

Esimerkkilähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?> 
<response> 
	<status>Success</status> 
	<result> 
		<surveyInfo surveyID="1315983192"> 
			<surveyID>1315983192</surveyID> 
			<surveyCount>2</surveyCount> 
		</surveyInfo>
	</result> 
	<results> 
		<question Number="1"> 
		<questionNumber>1</questionNumber> 
		<questionInfo>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<questionType>Multichoise_question</questionType>
			<questionTypeID>1</questionTypeID>
		</questionInfo>
		<alternative>
			<captionText>Yes</captionText>
			<numResult>0</numResult>
		</alternative>
		<alternative>
			<captionText>No</captionText>
			<numResult>2</numResult>
		</alternative>
		</question>
	</results>
</response>


Hae tulokset kyselytutkimuksesta ilman taustatietojen suodattamista.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
timestamp1 Käytetään yhdessä timestamp2:n kanssa valitsemaan äänet väliltä 2 Päivämäärän on oltava UNIX-aikaleiman muodossa.
timestamp2 UNIX-aikaleima.
allowcomments Aseta tämä parametri niin, että kaikki palauttavat kyselykysymyksiin syötetyt kommentit.

fetchResultsByInfoReg

Esimerkkilähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?> 
<response> 
	<status>Success</status> 
	<result> 
		<surveyInfo surveyID="1315983192"> 
			<surveyID>1315983192</surveyID> 
			<surveyCount>2</surveyCount> 
		</surveyInfo>
	</result> 
	<results> 
		<question Number="1"> 
		<questionNumber>1</questionNumber> 
		<questionInfo>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<questionType>Multichoise_question</questionType>
			<questionTypeID>1</questionTypeID>
		</questionInfo>
		<alternative>
			<captionText>Yes</captionText>
			<numResult>0</numResult>
		</alternative>
		<alternative>
			<captionText>No</captionText>
			<numResult>2</numResult>
		</alternative>
		</question>
	</results>
</response>


Hae tulokset kyselytutkimuksesta tapahtumatunnuksella.

POST-tietotiedot:

(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
timestamp1 Käytetään yhdessä timestamp2:n kanssa valitsemaan äänet väliltä 2 Päivämäärän on oltava UNIX-aikaleiman muodossa.
timestamp2 UNIX-aikaleima.
infoReg Tapahtuman tunnus, voidaan kerätä, kun käytetään automaattista palauttamista URL-osoitteessa olevan seurantakoodin kanssa.Ota yhteyttä tekniseen tukeen saadaksesi lisätietoja.

Yleismerkki käytössä => Käytä * käyttääksesi yleismerkkiä. Esimerkki : Nisse voi olla “N*e”

fetchResultsByUser

Esimerkkilähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?> 
<response> 
	<status>Success</status> 
	<result> 
		<surveyInfo surveyID="1315983192"> 
			<surveyID>1315983192</surveyID> 
			<surveyCount>2</surveyCount> 
		</surveyInfo>
	</result> 
	<results> 
		<question Number="1"> 
		<questionNumber>1</questionNumber> 
		<questionInfo>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<questionType>Multichoise_question</questionType>
			<questionTypeID>1</questionTypeID>
		</questionInfo>
		<alternative>
			<captionText>Yes</captionText>
			<numResult>0</numResult>
		</alternative>
		<alternative>
			<captionText>No</captionText>
			<numResult>2</numResult>
		</alternative>
		</question>
	</results>
</response>


Hae tulokset kyselytutkimuksesta taustatietojen suodattamisen avulla.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
timestamp1 Käytetään yhdessä timestamp2:n kanssa valitsemaan äänet väliltä 2 Päivämäärän on oltava UNIX-aikaleiman muodossa.
timestamp2 UNIX-aikaleima.
contactID Vastaanottajaan yhdistetty contactID. (Wildcard käytössä)
email Vastaanottajaan kuuluva sähköpostiosoite. (Wildcard käytössä)
group Vastaanottajaan kuuluvan ryhmän nimi. (Yleismerkit käytössä)
title Vastaanottajaan kuuluva otsikko. (Wildcard käytössä)
company Vastaanottajaan kuuluva yrityksen nimi. (Wildcard käytössä)
company-title Vastaanottajan yrityksen nimi. (Wildcard käytössä)
department Yrityksen osasto. (Wildcard käytössä)
customer-group Asiakasryhmä. (Wildcard käytössä)
gender Katso asiakastiedot.
address Osoite (Wildcard käytössä)
state Tila (Wildcard käytössä)
country Maa (Wildcard käytössä)
city Kaupunki (Wildcard käytössä)
postal-code Postinumero (Wildcard käytössä)

Jokerimerkki käytössä => Käytä merkkiä * jokerimerkkinä. Esimerkki: Nisse voidaan kirjoittaa muodossa N*e.

getRecipientsBasedByResults

Ei esikatselua

Tämä funktio käyttää samaa indataa kuin fetchResultsByUser ja näyttää vastaanottajat, jotka ovat vastanneet in-datan perusteella.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
timestamp1 Käytetään yhdessä timestamp2:n kanssa valitsemaan äänet väliltä 2 Päivämäärän on oltava UNIX-aikaleiman muodossa.
timestamp2 UNIX-aikaleima.
contactID Vastaanottajaan yhdistetty contactID. (Wildcard käytössä)
email Vastaanottajaan kuuluva sähköpostiosoite. (Wildcard käytössä)
group Vastaanottajaan kuuluvan ryhmän nimi. (Yleismerkit käytössä)
title Vastaanottajaan kuuluva otsikko. (Wildcard käytössä)
company Vastaanottajaan kuuluva yrityksen nimi. (Wildcard käytössä)
company-title Vastaanottajan yrityksen nimi. (Wildcard käytössä)
department Yrityksen osasto. (Wildcard käytössä)
customer-group Asiakasryhmä. (Wildcard käytössä)
gender Katso asiakastiedot.
address Osoite (Wildcard käytössä)
state Tila (Wildcard käytössä)
country Maa (Wildcard käytössä)
city Kaupunki (Wildcard käytössä)
postal-code Postinumero (Wildcard käytössä)

Jokerimerkki käytössä => Käytä merkkiä * jokerimerkkinä. Esimerkki: Nisse voidaan kirjoittaa muodossa N*e.

importSurvey

Ei esikatselua

Tuo Examinare-tiedosto tilillesi.

POST-tietotiedot:
(Punaiset tiedot ovat pakollisia), kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia.

examinarexml Examinare-kyselytutkimustiedoston (.examinare) sisältö

Huomaa: Suosittelemme, että lähetät vain valmiiksi muotoillun tai käännetyn Examinare-kyselytutkimustiedoston järjestelmään. 

Tiedoston rakenteen muuttaminen voi aiheuttaa virheen kyselyä käytettäessä. Jos käännät tiedoston, käytä työkalun omaa käännöstoimintoa.

listSurveys

Esimerkkilähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?>
<response> 
<status>Status</status>
 <surveys>
  <surveyInfo surveyID=”surveyID”>
  	<surveyID>829128191289</surveyID>
	<surveyName>Survey name</ surveyName>
	<surveyTaggName>Name of the tag</surveyTaggName>
	<status>Public survey</status>
	<surveyLinkWeb>{URL}</surveyLinkWeb>
	<surveyLinkMobile>{URL}</surveyLinkMobile>
	<completedAnswers>150</completedAnswers>
	<stoppedAnswers>0</stoppedAnswers>
	<surveyLanguage>sv</surveyLanguage>
  </surveyInfo>
 </surveys>
</response>


POST-tietotiedot:
Tämä toiminto ei tarvitse mitään ylimääräisiä POST-tietoja.

Palautustiedot

Tämä API-kutsu palauttaa useita XML-kyselyjä sisältävän säiliön. XML-kyselyjä sisältävä säiliö sisältää tiedot, mukaan lukien surveyID-tunnuksen, joita käytetään kehystä koskevissa kutsuissasi.

questionsInSurveys

Esimerkkilähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?>
	<response>
		<status>Success</status>
		<survey> 
			<surveyInfosurveyID="1315983192">
				<surveyID>1315983192</surveyID>
			</surveyInfo> 
		</survey> 
		<questions> 
		  <question Number="1">
			<questionNumber>1</questionNumber>
			<questionText>Do you have a Customer Service system in place?||!linebreak!||(A process that ensures a minimum level of service)</questionText>
			<InstructionText></InstructionText>
			<InstructionPos></InstructionPos>
			<questionType>Multichoise_question</questionType>
			<alternative>
				<alternativeID>1</alternativeID>
				<captionText>Yes</captionText>
			</alternative>
			<alternative>
				<alternativeID>2</alternativeID>
				<captionText>No</captionText>
			</alternative>
		  </question>
		</questions>
	</response>

Nouda kaikki kyselytutkimuksen kysymykset.

POST-tietotiedot:
(Punaiset tiedot ovat pakollisia), kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia.

surveyID Kyselyn ID Examinaressa.

searchFreeText

Ei koodin esikatselua

POST-tietotiedot:
(Punaiset tiedot ovat pakollisia), kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia.

surveyID SurveyID Valitse kysely, josta haluat etsiä
Text Lause, jota haluat etsiä. Yleismerkki (*) käytössä.

sendMessageEmail

PHP-esimerkkikoodi

PHP-esimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendMessageEmail");
	$details = Array();
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Esimerkkilähtö 
<?xml version="1.0" encoding="utf-8"?>
<response>
	<status>Success</status>
	<reports>
		<report>
			<contactID>UA1317237650U4e8373923c16b</contactID>
			<status>ADDED</status>
		</report>
		<report>
			<contactID>UE1317299990U4e8373923c70c</contactID>
			<status>ERROR</status>
		</report>
	</reports>
</response>

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

Käyttäjätunnus Yhteystietoihin on lisättävä contactID. * on muutettava numeroiksi, esim. user_1, user_2 jne.
delivery_message Viesti lähetetään sähköpostilla. Enintään 220 merkkiä.
delivery_subject Viestin aihe.
rtl Käytä arabian ja heprean RTL-koodausta. Aseta 1, jos vastaus on kyllä, tai älä aseta, jos vastaus on ei.
includelogo Käytä logoa yläosan bannerissa. Aseta 1 kyllä tai älä aseta ei.

sendMessageSMS

PHP-esimerkkikoodi 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendMessageSMS");
	$details = Array();
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	$details["delivery_by"]="SMS";// Must be set otherwise it will be sent by Email.
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Esimerkkilähtö 
<?xml version="1.0" encoding="utf-8"?>
<response>
	<status>Success</status>
	<reports>
		<report>
			<contactID>UA1317237650U4e8373923c16b</contactID>
			<status>ADDED</status>
		</report>
		<report>
			<contactID>UE1317299990U4e8373923c70c</contactID>
			<status>ERROR</status>
		</report>
	</reports>
</response>

Lähetä tekstiviesti vastaanottajille.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

Käyttäjätunnus Yhteystietoihin on lisättävä contactID. * on muutettava numeroiksi, esim. user_1, user_2 jne.
delivery_message Viesti lähetetään tekstiviestinä. Enintään 220 merkkiä.
rtl Käytä arabian ja heprean RTL-koodausta. Aseta 1, jos vastaus on kyllä, tai älä aseta, jos vastaus on ei.

Huomaa: Tässä viestissä ei ole linkkiä kyselyyn tai äänestykseen. Jos haluat lisätä linkin kyselyyn, käytä API Callia nimeltä “sendSurvey (SMS)”.

sendSurvey (sähköposti)

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendSurvey");
	$details = Array();
	$details["surveyID"]="SURVEYID";
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Näytteen lähtö 
<?xml version="1.0" encoding="utf-8"?>
<response> 
<status>Success</status>
<reports> 
	<report> 
		<contactID>UA1317237650U4e8373923c16b</contactID>
 		<status>ADDED</status>
  	</report>
   <report>
   		<contactID>UE1317299990U4e8373923c70c</contactID>
   		<status>ERROR</status>
   </report>
</reports>
</response>

Lähetä sähköpostikutsuja vastaanottajille.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
Käyttäjätunnus Yhteystietoihin on lisättävä contactID. * on muutettava numeroiksi, esim. user_1, user_2 jne.
delivery_message Viesti lähetetään sähköpostilla. Enintään 220 merkkiä.
delivery_subject Viestin aihe.
includelogo Käytä logoa yläosan bannerissa. Aseta 1 kyllä tai älä aseta ei.
schedule Ajoita tämä sähköpostiviesti myöhempää toimitusta varten. Täytyy sisältää UNIX-aikaleima

sendSurvey (SMS)

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("sendSurvey");
	$details = Array();
	$details["surveyID"]="SURVEYID";
	$details["user_1"]="ContactID";
    $details["delivery_message"]=$emailmessage["body"];
	$details["delivery_subject"]=$emailmessage["subject"];	
	$details["delivery_by"]="SMS";// Must be set otherwise it will be sent by Email.
	
                        
	$api2->Data($details);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the send ID.*/
                        
?>
Näytteen lähtö 
<?xml version="1.0" encoding="utf-8"?>
<response> 
<status>Success</status>
<reports> 
	<report> 
		<contactID>UA1317237650U4e8373923c16b</contactID>
 		<status>ADDED</status>
  	</report>
   <report>
   		<contactID>UE1317299990U4e8373923c70c</contactID>
   		<status>ERROR</status>
   </report>
</reports>
</response>

Lähetä SMS-kutsuja vastaanottajille.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
Käyttäjätunnus Yhteystietoihin on lisättävä contactID. * on muutettava numeroiksi, esim. user_1, user_2 jne.
delivery_message Viesti lähetetään tekstiviestillä.
delivery_by Asetuksena on oltava SMS.
schedule Ajoita tämän tekstiviestin toimitus myöhemmäksi. Täytyy sisältää UNIX-aikaleima

updateInstructionText

Ei esikatselua

Päivitä ohjeteksti QuestionNumber Julkaistu kategoriassa Survey.

POST-tietotiedot:
(Punainen Postin tieto on pakollista, musta on valinnaista), kaikki POST-tietojen kuvatekstit erottavat kirjainkokoja.

surveyID SurveyID, katso listSurveys lisätietoja
instructionText Uusi ohjeteksti tähän kysymykseen. (Käytä ||!rivinvaihto!|| rivinvaihtojen sijaan)
questionNumber Kysymyksen numero löytyi listSurveys.

Palautustiedot

Tämä API-kutsu palauttaa XML-vastauksen, jossa on status Success, jos se on päivitetty, error, jos virhe on kutsuttu.Luettelon rakenne palautetaan, katso questionInSurveys saadaksesi lisätietoja rakenteesta.

updateQuestionText

Ei esikatselua

Päivitä kysymysteksti seuraavasti: QuestionNumber Julkaistu kategoriassa Survey.

POST-tietotiedot:
(Punainen Postin tieto on pakollista, musta on valinnaista), kaikki POST-tietojen kuvatekstit erottavat kirjainkokoja.

surveyID SurveyID, katso listSurveys lisätietoja
questionText Kyselyn uusi kysymys. (Käytä ||!rivinvaihto!|| rivinvaihtojen sijaan)
questionNumber Kysymyksen numero löytyi listSurveys.

Palautustiedot

Tämä API-kutsu palauttaa XML-vastauksen, jossa on status Success, jos se on päivitetty, error, jos virhe on kutsuttu.Luettelon rakenne palautetaan, katso questionInSurveys saadaksesi lisätietoja rakenteesta.

Vastaanottajat

addRecipient

Palautustiedot

Tämä API-kutsu palauttaa XML-vastauksen, jonka tila on onnistunut, jos se on luotu, virhe, jos virhe on kutsuttu.XML-yhteystiedot-säiliö sisältää tiedot, mukaan lukien contactID, jota käytetään kehystä koskevissa kutsuissa.

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("addRecipient");
	$recipient_r = Array();
                        
	$recipient_r["name"]="My name";
	$recipient_r["email"]="myname@mydomain.com";
	$recipient_r["group"]="My Group";
                        
	$api2->Data($recipient_r);
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipient record to use.*/
                        
?>
Näytteen lähtö 
<?xml version="1.0" encoding="utf-8"?>
 <response> 
 <status>Status</status>
 <contacts> 
 <contact cid="contactID">
    <contactID>829128191289</contactID>
      	<authCode>829108</authCode>
		<name>Name</name>
		<lastname>Last name</lastname>
		<email>info@domain.com</email>
		<mobile>+467031234567</mobile>
		<group>Groupname</group>
		<title>Mr</title>
		<company>Company name</company>
		<company-title>Company name</company-title>
		<department>Sales</department>
		<customer-group>Sales groups</customer-group>
		<gender>male</gender>
		<birth-year>1919</birth-year>
		<birth-month>1919</birth-month>
		<birth-day>1919</birth-day>
		<phonenumber>+46844444444</ phonenumber>
		<attention>Attention</attention>
		<address>Adress</address>
		<city>Kristianstad</city>
		<postal-code>29184</postal-code>
		<state>Skane</state>
		<country>Sweden</country>
		<crmserial>15001</crmserial>		
		<extrafields>
			<extrafield>
				<key>f54601af5d3377</key>
				<value>Testar åäö</value>
			</extrafield>
			<extrafield>
				<key>f5461293d9b22d</key>
				<value></value>
			</extrafield>
			<extrafield>
				<key>f5460eb07e2f93</key>
				<value>7</value>
			</extrafield>
		</extrafields>
	</contact>
</contacts>
</response>

Lisää vastaanottaja yritystietokantaan.

POST-tietotiedot:

(Punainen Postin tieto on pakollista, musta on valinnaista), kaikki POST-tietojen kuvatekstit erottavat kirjainkokoja.

name Vastaanottajan etunimi.
lastname Vastaanottajan sukunimi.
email Vastaanottajan sähköposti.
mobile Matkapuhelinnumero. (Muoto 00[Maakoodi][Suuntakoodi][Puhelinnumero]) Esimerkki : 00467031234567
group Ryhmän nimi.
title Henkilökohtainen otsikko.
company Yrityksen nimi.
company-title Vastaanottajan yritysnimike.
department Osasto yrityksessä.
customer-group Asiakasryhmä.
gender Vastaanottajan sukupuoli. (mies, jos vastaanottaja on mies, nainen, jos vastaanottaja on nainen).
birth-year Syntymävuosi (YYYY), vain numeroita.
birth-month Syntymäkuukausi (MM), vain numeroita.
birth-day Syntymäpäivä (DD), vain numeroita.
phonenumber Vastaanottajan puhelinnumero.
attention Vastaanottajan osoite.
address Vastaanottajan osoite.
city Kaupungin nimi.
state Osavaltion nimi.
postal-code Postinumero.
country Country name.
crmserial Sarjakoodi integraatiomoduulista esim. Zendesk ticket ID:lle.
extrafieldkey Avain extrafields alla olevassa muodossa.

delRecipient

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("delRecipient");
	                        
	$api2->Data(array("contactID"=>"Change with ContactID from Examinare"));
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any.*/
                        
?>

Poistaa vastaanottajan yritystietokannasta.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

contactID Yhteystietotunnus Examinare-tietokannastasi.

Palautustiedot

Tämä API-kutsu palauttaa XML-vastauksen, jossa on tila Success, jos se poistetaan, virhe, jos virhe on kutsuttu.

listRecipientByContactID

Palautustiedot

Tämä API-kutsu palauttaa yhden XML-yhteystietosäiliön. XML-yhteystietosäiliö sisältää tiedot, mukaan lukien contactID-tunnuksen, joita käytetään kehystä koskevissa kutsuissasi. (Katso addRecipient)

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientByContactID");
	 
                        
	$api2->Data(array("contactID"=>"ContactID of your Survey in Examinare"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Luettelo yksittäisen vastaanottajan tiedot käyttämällä vastaanottajan contactID.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

contactID Yhteystietotunnus Examinare-tietokannastasi.

listRecipientByCRMSerial

Palautustiedot

Tämä API-kutsu palauttaa yhden XML-yhteystietosäiliön. XML-yhteystietosäiliö sisältää tiedot, mukaan lukien contactID, joita käytetään kehystä koskevissa kutsuissasi. Huomaa, että tämä kutsu voi palauttaa useita yhteystietoja. (Katso addRecipient)

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientByCRMSerial");
	
      /* Example for the Zendesk ticket id 1*/ 
                        
	$api2->Data(array("crmserial"=>"Zendesk:1"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Listaa yhden vastaanottajan tiedot käyttämällä CRM-sarjanumeroa, joka on luotu Examinare-laajennuksissa, jotka ovat käytettävissä.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

crmserial Crm Serial mukaan lukien plugin rakenne. Tarkista vastaanottajan näytön yksityiskohdat.

listRecipientByEmail

Palautustiedot

Tämä API-kutsu palauttaa yhden XML-yhteystietosäiliön. XML-yhteystietosäiliö sisältää tiedot, mukaan lukien contactID, joita käytetään kehystä koskevissa kutsuissasi. Huomaa, että tämä kutsu voi palauttaa useita yhteystietoja. (Katso addRecipient)

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientByEmail");
	
      
                        
	$api2->Data(array("email"=>"my@email.xxx"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Luettelo yksittäisen vastaanottajan tiedot käyttämällä vastaanottajan sähköpostiosoitetta.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

email Yhteystiedot Sähköpostiosoite Examinare-tietokannasta.

listRecipients

Palautustiedot

Tämä API-kutsu palauttaa useita XML-yhteystietoja sisältävän säiliön. XML-yhteystietosäiliö sisältää tiedot, mukaan lukien contactID-tunnuksen, jota käytetään kehystä koskevissa kutsuissasi. (Katso addRecipient)

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipients");
	 
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the all Recipients in an array.*/
                        
?>

Hae täydellinen luettelo kaikista Examinare-tietokannassasi olevista Vastaanottajista.

POST-tietotiedot:

Tämä toiminto ei tarvitse mitään ylimääräisiä POST-tietoja.

listRecipientsByGroup

Palautustiedot

Tämä API-kutsu palauttaa yhden XML-yhteystietosäiliön. XML-yhteystietosäiliö sisältää tiedot, mukaan lukien contactID-tunnuksen, joita käytetään kehystä koskevissa kutsuissasi. (Katso addRecipient)

Tietoja, mukaan lukien contactID, jota käytetään kehystä koskevissa kutsuissasi (katso addRecipient).

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientsByGroup");
	
      
                        
	$api2->Data(array("group"=>"Name of your Group in Examinare"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>

Listaa vastaanottajien tiedot ryhmänimellä.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

group Ryhmän nimi

listRecipientsExtraFields

Tietoja, mukaan lukien contactID, jota käytetään kehystä koskevissa kutsuissasi (katso addRecipient).

PHP-koodiesimerkki 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
<extrafields>
	<extrafield>
		<key>f54601af5d3377</key>
		<caption>Field1</caption>
		<type>text</type>
		<options></options>
	</extrafield>
	<extrafield>
		<key>f5461293d9b22d</key>
		<caption>Field3</caption>
		<type>checkbox</type>
		<options></options>
	</extrafield>
	<extrafield>
		<key>f5460eb07e2f93</key>
		<caption>Testing</caption>
		<type>select</type>
		<options>
			<option>1</option>
			<option>2</option>
			<option>3</option>
			<option>4</option>
			<option>5</option>
			<option>6</option>
			<option>7</option>
			<option>8</option>
			<option>9</option>
			<option>10</option>
		</options>
	</extrafield>
</extrafields>
</response>

Vastaanottajaprofiili voidaan laajentaa Extra Fields -kentillä, jotka lähetetään vastaanottajien lisäämisen, lataamisen ja päivittämisen yhteydessä.

POST-tietotiedot:

Tämä funktio ei ota mitään POST-parametreja.

Palautustiedot

key Vastaanottajatiedoissa käytetty avain.
caption Kentän kuvateksti Examinaren asetuksista.
type Kentän tyyppi (valinta, teksti, valintaruutu)
options Valinnat käytettäessä valita kentän tyyppi.

listRecipientsToSurvey

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listRecipientsToSurvey");
	 
                        
	$api2->Data(array("surveyID"=>"Survey ID of your Survey in Examinare"));
	
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the Recipients in an array.*/
                        
?>
Esimerkkilähtö 
<?xml version=”1.0" encoding=”utf-8"?> 
<response> 
	<status>Success</status> 
	<contacts>
		<contact cid=”UI1317137541U4e81ec85c8c61">
			<contactID>UI1317137541U4e81ec85c8c61</contactID>
			<authCode>258848</authCode>
			<name>Peter</name>
			<lastname>Lastname</lastname>
			<email>peter@domain.com</email>
			<mobile>+4670000000</mobile>
			<group>Customer Service Rating</group>
			<title></title>
			<company></company>
			<company-title></company-title>
			<department></department>
			<customer-group></customer-group>
			<gender>none</gender>
			<birth-year></birth-year>
			<birth-month></birth-month>
			<birth-day></birth-day>
			<phonenumber></phonenumber>
			<attention></attention>
			<address></address>
			<city></city>
			<postal-code></postal-code>
			<state></state>
			<country></country>
			<surveyLinkWeb>LINK</surveyLinkWeb>
			<surveyLinkMobile>LINK</surveyLinkMobile>
			<surveyStatus>ANSWERED</surveyStatus>
		</contact>
	</contacts>
</response>

Listaa kaikki vastaanottajien linkit ja Examinaren lähettämien kutsujen tila.

Huomaa: Vain anonyymejä ja yksityisiä kyselyjä voidaan käyttää tämän komennon kanssa.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.

listSurveysByUser

Palautustiedot

Tämä API-kutsu palauttaa useita XML-kyselyjä sisältävän säiliön. XML-kyselyjä sisältävä säiliö sisältää tiedot, mukaan lukien surveyID-tunnuksen, joita käytetään kehystä koskevissa kutsuissasi.

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listSurveysByUser");
	 
	$api2->Data(array("contactID"=>"Contact ID in Examinare"));
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the contact information with all Surveys in an array.*/
                        
?>

Luettelo kaikista kyselytutkimuksista, jotka on liitetty vastaanottajaan ja tilaan.

POST-datatiedot

(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

contactID Yhteystietotunnus Examinare-tietokannastasi.

markRecipientsToSurvey

Esimerkkilähtö 
<?xml version="1.0" encoding="utf-8"?>
<response> 
 <status>Success</status>
 <reports> 
 	<report> 
 		<contactID>UA1317237650U4e8373923c16b</contactID>
  		<status>MARKED</status>
   </report>
  </reports>
</response>

Merkitse vastaanottajat kutsutuiksi yhteen kyselyyn Examinaren tilalokissa.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
Käyttäjätunnus Yhteystietoihin on lisättävä contactID. * on muutettava numeroiksi, esim. user_1, user_2 jne.

listSurveysByUser

Palautustiedot

Tämä API-kutsu palauttaa useita XML-kyselyjä sisältävän säiliön. XML-kyselyjä sisältävä säiliö sisältää tiedot, mukaan lukien surveyID-tunnuksen, joita käytetään kehystä koskevissa kutsuissasi.

PHP-koodiesimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api2 = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api2->setCommand("listSurveysByUser");
	 
	$api2->Data(array("contactID"=>"Contact ID in Examinare"));
						
	$result=$api2->Execute();
						
                        
	/* In $result you will now find all 
	returnable errors if any or the contact information with all Surveys in an array.*/
                        
?>
Näytteen lähtö 
<?xml version="1.0" encoding="utf-8"?>
<response> 
	<status>Success</status> 
	<contacts> 
	 <contact cid="UQ1289426855U4cdb17a7dde8c"> 
		<contactID>UQ1289426855U4cdb17a7dde8c</contactID> 
		<authCode>178059</authCode> 
		<name>John</name>
		<lastname>Doe</lastname> 
		<email>info@email.go</email> 
		<mobile></mobile> 
		<group>Facebook</group> 
		<title>none</title> 
		<company></company> 
		<company-title></company-title> 
		<department></department> 
		<customer-group>Facebook</customer-group> 
		<gender>man</gender> 
		<birth-year>2002</birth-year> 
		<birth-month>01</birth-month> 
		<birth-day>02</birth-day> 
		<phonenumber></phonenumber> 
		<attention></attention> 
		<address></address> 
		<city></city> 
		<postal-code></postal-code> 
		<state></state> 
		<country>en_US</country> 
		<surveys> 
		 <surveyInfo surveyID="1321866201"> 
			<surveyID>1321866201</surveyID> 
			<surveyName>Survey1</surveyName> 
			<surveyTaggName></surveyTaggName> 
			<completed>FALSE</completed> 
			<attending>TRUE</attending> 
			<surveyLinkWeb>URL</surveyLinkWeb> 
			<surveyLinkMobile>URL</surveyLinkMobile> 
			<surveyLanguage>th</surveyLanguage> </surveyInfo> 
			<surveyInfo surveyID="1260279826"> 
			<surveyID>1260279826</surveyID> 
			<surveyName>Survey2</surveyName> 
			<surveyTaggName></surveyTaggName> 
			<completed>FALSE</completed> 
			<attending>FALSE</attending> 
			<surveyLinkWeb>URL</surveyLinkWeb> 
			<surveyLinkMobile>URL</surveyLinkMobile> 
			<surveyLanguage>hi</surveyLanguage> 
		 </surveyInfo> 
		</surveys> 
	 </contact>
	</contacts>  

</response>

Luettelo kaikista kyselytutkimuksista, jotka on liitetty vastaanottajaan ja tilaan.

POST-datatiedot

(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

contactID Yhteystietotunnus Examinare-tietokannastasi.

markRecipientsToSurvey

Ei esikatselua

Merkitse vastaanottajat kutsutuiksi yhteen kyselyyn Examinaren tilalokissa.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
Käyttäjätunnus Yhteystietoihin on lisättävä contactID. * on muutettava numeroiksi, esim. user_1, user_2 jne.

updateGenderRecipient

Palautustiedot

Tämä API-kutsu palauttaa XML-vastauksen, jonka tila on onnistunut, jos se on päivitetty, virhe, jos virhe on kutsuttu. XML-yhteystietosäiliö sisältää tiedot, mukaan lukien contactID, joita käytetään kehystä koskevissa kutsuissasi. (Katso addRecipient)

Huomaa, että alla oleva esimerkki on addrecipient ja on säädettävä käyttää päivitystoimintoa.

Näytteen lähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?>
 <response> 
 <status>Status</status>
 <contacts> 
 <contact cid="contactID">
    <contactID>829128191289</contactID>
      	<authCode>829108</authCode>
		<name>Name</name>
		<lastname>Last name</lastname>
		<email>info@domain.com</email>
		<mobile>+467031234567</mobile>
		<group>Groupname</group>
		<title>Mr</title>
		<company>Company name</company>
		<company-title>Company name</company-title>
		<department>Sales</department>
		<customer-group>Sales groups</customer-group>
		<gender>male</gender>
		<birth-year>1919</birth-year>
		<birth-month>1919</birth-month>
		<birth-day>1919</birth-day>
		<phonenumber>+46844444444</ phonenumber>
		<attention>Attention</attention>
		<address>Adress</address>
		<city>Kristianstad</city>
		<postal-code>29184</postal-code>
		<state>Skane</state>
		<country>Sweden</country>
		<crmserial>15001</crmserial>		
		<extrafields>
			<extrafield>
				<key>f54601af5d3377</key>
				<value>Testar åäö</value>
			</extrafield>
			<extrafield>
				<key>f5461293d9b22d</key>
				<value></value>
			</extrafield>
			<extrafield>
				<key>f5460eb07e2f93</key>
				<value>7</value>
			</extrafield>
		</extrafields>
	</contact>
</contacts>
</response>

Päivitä yhden vastaanottajan sukupuolitiedot.

POST-tietotiedot:

(Punainen Postin tieto on pakollista, musta on valinnaista), kaikki POST-tietojen kuvatekstit erottavat kirjainkokoja.

contactID Yhteystietotunnus Examinare-tietokannastasi.
gender Vastaanottajan sukupuoli. (mies, jos vastaanottaja on mies, nainen, jos vastaanottaja on nainen).

updateRecipient

Palautustiedot

Tämä API-kutsu palauttaa XML-vastauksen, jonka tila on Success, jos se on päivitetty, error, jos virhe on kutsuttu. XML-yhteystietosäiliö sisältää tiedot, mukaan lukien contactID, joita käytetään kehystä koskevissa kutsuissasi. addRecipient)

Huomaa, että alla oleva esimerkki on addrecipient ja on säädettävä käyttää päivitystoimintoa.

Näytteen lähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?>
 <response> 
 <status>Status</status>
 <contacts> 
 <contact cid="contactID">
    <contactID>829128191289</contactID>
      	<authCode>829108</authCode>
		<name>Name</name>
		<lastname>Last name</lastname>
		<email>info@domain.com</email>
		<mobile>+467031234567</mobile>
		<group>Groupname</group>
		<title>Mr</title>
		<company>Company name</company>
		<company-title>Company name</company-title>
		<department>Sales</department>
		<customer-group>Sales groups</customer-group>
		<gender>male</gender>
		<birth-year>1919</birth-year>
		<birth-month>1919</birth-month>
		<birth-day>1919</birth-day>
		<phonenumber>+46844444444</ phonenumber>
		<attention>Attention</attention>
		<address>Adress</address>
		<city>Kristianstad</city>
		<postal-code>29184</postal-code>
		<state>Skane</state>
		<country>Sweden</country>
		<crmserial>15001</crmserial>		
		<extrafields>
			<extrafield>
				<key>f54601af5d3377</key>
				<value>Testar åäö</value>
			</extrafield>
			<extrafield>
				<key>f5461293d9b22d</key>
				<value></value>
			</extrafield>
			<extrafield>
				<key>f5460eb07e2f93</key>
				<value>7</value>
			</extrafield>
		</extrafields>
	</contact>
</contacts>
</response>

Päivitä Examinaren tietokannan vastaanottajien tiedot.

POST-tietotiedot:

(Punainen Postin tieto on pakollista, musta on valinnaista), kaikki POST-tietojen kuvatekstit erottavat kirjainkokoja.

contactID Yhteystietotunnus Examinare-tietokannastasi.
name Vastaanottajan etunimi.
lastname Vastaanottajan sukunimi.
email Vastaanottajan sähköposti.
mobile Matkapuhelinnumero. (Muoto 00[Maakoodi][Suuntakoodi][Puhelinnumero]) Esimerkki : 00467031234567
group Ryhmän nimi.
title Henkilökohtainen otsikko.
company Yrityksen nimi.
company-title Vastaanottajan yritysnimike.
department Osasto yrityksessä.
customer-group Asiakasryhmä.
gender Vastaanottajan sukupuoli. (mies, jos vastaanottaja on mies, nainen, jos vastaanottaja on nainen).
birth-year Syntymävuosi (YYYY), vain numeroita.
birth-month Syntymäkuukausi (MM), vain numeroita.
birth-day Syntymäpäivä (DD), vain numeroita.
phonenumber Vastaanottajan puhelinnumero.
attention Vastaanottajan osoite.
address Vastaanottajan osoite.
city Kaupungin nimi.
state Osavaltion nimi.
postal-code Postinumero.
country Country name.
extrafieldkey Avain ulkokentältä.

Tutkimusraportin tiedostot

fetchReportFile

PHP-esimerkki

PHP-esimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api->setCommand("fetchResults");
	
      $api->setCommand("fetchReportFileList");
	
	$api->Data(array('surveyID'=>"SURVEYID GOES HERE", "reportID" => 'REPORT ID FROM fetchReportFileList goes here.');
    
			$file =  $api->ExecuteRaw();
			$quoted = "FILE NAME GOES HERE . extension";
			header('Content-Description: File Transfer');
			header('Content-Type: application/octet-stream');
			header('Content-Disposition: attachment; filename=' . $quoted); 
			header('Content-Transfer-Encoding: binary');
			header('Connection: Keep-Alive');
			header('Expires: 0');
			header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
			header('Pragma: public');
			header('Content-Length: ' . strlen($file));			
	
			echo $file;
	
						
                        
	/* In $reports_r you will now find all 
	returnable errors if any or the Report File ID's ready to use with fetchReportFile.*/
                        
?>

Näytteen lähtö

Esimerkki koodista 
RAW FILE CONTENT

Nouda tililtäsi raportti, joka sisältää fetchReportFileList-komennon tiedot.

HUOMAUTUS: Tämä funktio palauttaa varsinaisen tiedoston otsikoineen, EI XML-rakennetta. Varmista, että päivität käärijäsi uusimpaan versioon, jotta voit käyttää PHP Wrapperia tähän funktioon. PHP Wrapper on PHP-ohjelmointikielellä kirjoitettu ohjelmisto.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
reportID Raportin id funktiosta fetchReportFileList.

fetchReportFileList

PHP-esimerkki

PHP-esimerkki 
<?php 						
	include_once("examinare-api.php");
	$key["apicompany"]="XXXX";						
	$key["apikey"]="YYYYYY";	
							
	/* Change the top information 
	according to your account details. */
						
	$api = new ExaminareAPIConnector($key["apicompany"],$key["apikey"],"");
	$api->setCommand("fetchResults");
	
      $api->setCommand("fetchReportFileList");
	
	$api->Data(array('surveyID'=>"1314773374");
         
						
	$reports_r=$api->Execute();
						
                        
	/* In $reports_r you will now find all 
	returnable errors if any or the Report File ID's ready to use with fetchReportFile.*/
                        
?>

Näytteen lähtö

XML-esimerkki 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
<surveys><surveyInfo surveyID="1314773374">
<surveyID>1314773374</surveyID>
<surveyName>Company Service Rating</surveyName>
<surveyTaggName></surveyTaggName>
<reportUrls>
<reportUrl>
	<reportID>mainexcel</reportID>
	<name>Company Service Rating - Main Report.xls</name>
</reportUrl>
<reportUrl>
	<reportID>maindocx</reportID>
	<name>Company Service Rating - Main Report.docx</name>
</reportUrl>
<reportUrl>
	<reportID>mainpdf</reportID>
	<name>Company Service Rating - Main Report.pdf</name>
</reportUrl>
<reportUrl>
	<reportID>rawspss</reportID>
	<name>Company Service Rating - Raw.sps</name>
</reportUrl>
</reportUrls>
</surveyInfo>
</surveys>
</response>

Hae raporttien luettelo Surveysta, jota käytetään fetchReportFile-toiminnon kanssa.

POST-tietotiedot:
(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.

Magic Polls

fetchMagicPollSummary

Näytteen palautus 1 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
 <MagicPolls>
  <MagicPollInfo magicID="1365745486">
  <magicID>1365745486</magicID>
  <magicName>Magic Poll Question</magicName>
  <completedAnswers>
	<Summary>0</Summary>
	<Options>
		<Option>
			<Number>1</Number>
			<OptionText>Option 1</OptionText>
			<Result>0</Result>
			<Percent></Percent>
		</Option>
		<Option>
			<Number>2</Number>
			<OptionText>Option 2</OptionText>
			<Result>0</Result>
			<Percent></Percent>
		</Option>
	</Options>
  </completedAnswers>
  <stoppedAnswers>
		<Summary>0</Summary>
  </stoppedAnswers>
  </MagicPollInfo>
 </MagicPolls>
</response>
Näytteen palautus 2 
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>Success</status>
<MagicPolls>
<MagicPollInfo magicID="1365745486">
<magicID>1365745486</magicID>
<magicName>TestPoll</magicName>
<completedAnswers>
	<Summary>5</Summary>
<Options>
	<Option>
		<Number>1</Number>
		<OptionText>Option 1</OptionText>
		<Result>2</Result>
		<Percent>40</Percent>
	</Option>
	<Option>
		<Number>2</Number>
		<OptionText>Option 2</OptionText>
		<Result>3</Result>
		<Percent>60</Percent>
	</Option>
</Options>
  <SMS>
	<answer>
		<id>MOBILE;+46XXXXXXXX.1381480943</id>
		<when>2013-10-11 10:42:23</when>
		<stamp>1381480943</stamp>
		<phrase>2</phrase>
		<from>+46XXXXXXXX</from>
	</answer>
	<answer>
		<id>MOBILE;+46XXXXXXXX.1381479624</id>
		<when>2013-10-11 10:20:24</when>
		<stamp>1381479624</stamp>
		<phrase>2</phrase>
		<from>+46XXXXXXXX</from>
	</answer>
	<answer>
		<id>MOBILE;+46XXXXXXXX.1381479600</id>
		<when>2013-10-11 10:20:00</when>
		<stamp>1381479600</stamp>
		<phrase>1</phrase>
		<from>+46XXXXXXXX</from>
	</answer>
  </SMS>
  <Web>
	<answer>
		<id>WEBSITE;j186hntcn28efok6t6oeg94fv5;XXX.XXX.XXX.XXX.1381479661</id>
		<when>2013-10-11 10:21:01</when>
		<stamp>1381479661</stamp>
		<phrase>Option 2</phrase>
		<from>http://XXX.examinare.net/mp/1365745486/</from>
		<ip>XXX.XXX.XXX.XXX</ip>
	</answer>
  </Web>
 </completedAnswers>
 <stoppedAnswers>
	<Summary>0</Summary>
 </stoppedAnswers>
</MagicPollInfo>
</MagicPolls>
</response>

POST-tietotiedot:
Tätä funktiota voidaan käyttää valinnaisen POST-avaimen kanssa nimeltä magicID.Kun magicID on määritetty, yksityiskohtaisemmat tulokset lisätään XML-palautukseen.

Palautustiedot

Tämä API-kutsu palauttaa usean XML Magic Poll -säiliön, jos magicID ei ole määritetty (Sample return 1).

Jos magicID on määritetty, se palauttaa yksityiskohtaisempia tietoja (Esimerkki palautus 2).

Näytteen palautus 1

Näytepalautus 1

Avaintiedot 1

 magicID Magic Poll -kyselytutkimuksen tunnus Examinaressa.
magicName Kysymys kysyttiin.
completedAnswers Kyselyyn vastatut vastaukset.
Options Vaihtoehdot äänestyksen tuloksilla. Jos lisätty Vaihtoehtoja. Jos ei ole vaihtoehtoja, tämä kenttä on tyhjä.
–       Number Äänestysvaihtoehdon tunnistenumero.
–       Optiontext Äänestysvaihtoehdon teksti
–       Result Äänestysvaihtoehdon tulos
–       Percent Kyselyn vaihtoehdon prosenttiosuus verrattuna Yhteenveto valmiista vastauksista -kohtaan.

Näytteen palautus 2

Näytepalautus 2

Avaintiedot 2

Tässä osiossa olevien yleisten kenttien osalta tarkista Avaintiedot 1, koska tässä osassa käsitellään vain Avaintiedot 1:n ja 2:n välistä eroa.

 SMS Säiliö tekstiviestiäänestyksille
–       Answer Säiliö yksittäiselle SMS-vastaukselle.
–       – id Tämän Examinare-äänestyksen tunnus.
–       – when Äänestyksen päivämäärä Y-M-D aikamuodossa
–       – stamp Unix Äänestyksen aikaleima
–       – phrase Lause lähetetty.
–       – from Puhelinnumero, joka lähetti sen.
 Web Säiliö verkkoäänestyksille
–       Answer Säiliö yksittäisille Web-äänestyksille.
–       – id Tämän Examinare-äänestyksen tunnus.
–       – when Äänestyksen päivämäärä Y-M-D aikamuodossa
–       – stamp Unix Äänestyksen aikaleima
–       – phrase Lause lähetetty.
–       – from Äänestyslomakkeen URL.
–       – ip Äänestykseen osallistuvan laitteen ip-osoite.

voteMagicPoll

Ei esikatselua

POST-tietotiedot:

magicID Magic Poll -kyselytutkimuksen tunnus Examinaressa.
Option Soitettu numero sisällä fetchMagicPollSummary (Valinnainen, mutta suositeltava)
Text Vapaa teksti vastaus. (Valinnainen, mutta suositeltavaa)
GadgetID Voit määrittää GadgetID:n (vapaa teksti), jotta voit jäljittää, mistä ääni on peräisin (valinnainen).

Palautustiedot

Tämä funktio palauttaa Status = OK onnistuessaan ja Status = Error, kun virhe on tapahtunut.

Phone Surveys

listPhoneSurveys

Palautustiedot

Tämä API-kutsu palauttaa useita XML-kyselyjä sisältävän säiliön. XML-kyselyjä sisältävä säiliö sisältää tiedot, mukaan lukien surveyID-tunnuksen, joita käytetään kehystä koskevissa kutsuissasi.

Näytteen lähtö 
<?xml version="1.0" encoding="utf-8"?><response>
<status>Success</status>
<surveys>
	<surveyInfo surveyID="1379659109">
		<surveyID>1379659109</surveyID>
		<surveyName>Outbound Phone Survey</surveyName>
		<surveyTaggName></surveyTaggName>
		<status>Outbound</status>
		<callerIDs>
			<callerID>+46188008080</callerID>
			<callerID>+46703121234</callerID>
			<callerID>+46855926800</callerID>
			<callerID>+61865558135</callerID>
			<callerID>+6624028269</callerID>
			<callerID>+14088894369</callerID>
			<callerID>+46840809736</callerID>
		</callerIDs>
		<completedAnswers>6</completedAnswers>
		<stoppedAnswers>0</stoppedAnswers>
		<surveyLanguage>sv</surveyLanguage>
	</surveyInfo>
	<surveyInfo surveyID="1390898671">
		<surveyID>1390898671</surveyID>
		<surveyName>Inbound Phone Survey</surveyName>
		<surveyTaggName></surveyTaggName>
		<status>Inbound</status>
		<phoneNumbers>
		  <phoneNumber>
			<to>+46188008020</to>
			<from>*</from>
		  </phoneNumber>
		</phoneNumbers>
		<completedAnswers>9</completedAnswers>
		<stoppedAnswers>0</stoppedAnswers>
		<surveyLanguage>en</surveyLanguage>
	</surveyInfo>
</surveys>
</response>

Luettelo kaikista tutkimuksista, jotka on julkaistu puhelintutkimuksena ja niiden tila.

POST-tietotiedot:
Tämä toiminto ei tarvitse mitään ylimääräisiä POST-tietoja.

Avaintiedot

surveyID Kyselyn ID Examinaressa.
surveyName Puhelinkyselyn nimi.
surveyTaggName Examinaressa käytetty tunniste.
status – Saapuva – lähtevä liikenne
callerIDs Näytetään vain, kun Outbound ja tämä callerID Lähetetään pyynnön mukana sendPhoneSurvey. Jos haluat lisätä toisen CallerID Ota yhteyttä Tukitiimiin valtuuttaaksesi sen.
phoneNumbers Näyttää vain, kun Inbound ja näyttää, mikä puhelinnumero puhelinkyselyyn on tavoitettavissa ja mitä callerID Sinun täytyy olla, jotta se vastaa.
completedAnswers Kyselyyn saatujen vastausten määrä (koko kyselyn osalta).
stoppedAnswers Kyselyssä estettyjen vastausten määrä (koko kyselyn osalta).
surveyLanguage Puhelinkyselyssä käytetyn kielen lyhytkoodi.

sendPhoneSurvey

Ei esikatselua

Tee varsinainen soittopyyntö.

Toiminto toimii vain, jos sinulla on Puhelin Kysely käytössä tililläsi!

Ota yhteyttä myyntiin.

POST-tietotiedot:

(Punainen Kaikki POST-tietojen kuvatekstit ovat kirjainkokoerotteisia (kaikki tiedot ovat pakollisia).

surveyID Kyselyn ID Examinaressa.
Käyttäjätunnus Yhteystietoihin on lisättävä contactID. * on muutettava numeroiksi, esim. user_1, user_2 jne.
callerID Tililläsi aktivoidut calleridit. Nämä löytyvät soittolistan kohdasta Calleridit. listPhoneSurveys. (VAIHTOEHTOISTA)
Tämä sivusto on rekisteröity wpml.org-palvelimelle kehityssivustona. Vaihda tuotantosivuston avaimeen remove this banner.