Examinare API - Ülevaade

Alustage Examinare küsitluse tööriista API kasutamist

Videoõpetus Examinare API aktiveerimise kohta

Aktiveeri Examinare küsitluse tööriista API

Punane Kõik väljad on kohustuslikud ja neil peab olema väärtus. XML-andmed saadetakse HTTPS-i kasutades POST-andmetena.
Käesoleva dokumendi alguses on kokkuvõte olemasolevatest funktsioonidest. Sellele järgneb üksikasjalikum osa.

Kõigi funktsioonide URL on
https://api.examinare.com/framework
Ühenduse loomiseks on vaja POST andmetele lisada kolm käsku:

apiKey – seda pakub Examinare teie kontole.
apiCompany – kasutatav ettevõtte andmebaas.
Käsk – käsk, mille te kõne jaoks annate.
Tähelepanu: Teie poolt kutsutava funktsiooni järgi võib vaja minna rohkem käske.

Mobiilne API ja mitte jagatud API võtmed.

Kui soovite mis tahes põhjusel hoida oma API võtit privaatsena ja kasutada Login-tüüpi stiili Statsionaarse Examinare API võtme asemel, võite kasutada Mobile API käsku setPhoneID, seda käsku saab kasutada, et saada Mobile API token, mida saab kasutada asemel staatilise API token. Kõiki mobiilse API tokeneid saab kustutada igal ajal oma Examinare konto seadetes -> Täpsemad seaded.

PHP wrapperi teek

PHP näide

<?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 wrapperi teek kood.

Ei allalaadimisi ega pikki readme faile.

Lihtsalt kopeeri ja kleebi sinna, kuhu soovid koodi panna.

Kui valite failinime “examinare-api.php”, siis kõik PHP koodi näited sellel saidil töötavad URL-idega.

Vastasel juhul peate uuendama oma koodi ülaosas olevat lause include. Meie PHP wrapper on saadaval GitHub. https://github.com/examinare/examinare-php-wrapper

setPhoneID (kasutage mobiilset API-d)

XML-i näide

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

Koos setPhoneID Saate luua oma API võtmed, mis on ühendatud reaalajas administraatori kasutajaga teie süsteemis. Examinare konto. Te peate aktiveerima mobiilsete võtmete funktsioonid oma konfiguratsiooni vahekaardil oma mobiiltelefonis. Examinare konto.

POST andmete teave:
(Punane teave on kohustuslik), kõik POST andmete pealkirjad on tõstutundlik.

apiCompany	Ettevõtte ID
user	Kasutajanimi või e-posti aadress
pass	Logi sisse või registreeru MD5 krüpteerimine.
deviceInformation	Valikuline tekst API-konnektori seadme kirjeldamiseks. See kuvatakse teie konto API tokenite nimekirjas.

Kas soovite luua Examinare’il põhinevaid lahendusi?

Pakume arendaja kontot, mida saab kasutada liivakasti loomiseks või Examinare API jaoks väliste rakenduste loomiseks, kus teie kliendid saavad seejärel teie lahendust oma Examinare kontoga kasutada.

Arendaja kontol on kõik tavalise konto funktsioonid, kuna selle madal hind ei saa neid kontosid kasutada äriliseks kasutamiseks.

Arendaja konto
99 USA dollarit

Piiramatu arv vastuseid, küsitlusi ja adressaate
Avalda 1 küsitlus korraga
Valmis mallide teek
Ainult e-posti tugi
Iga-aastane tellimus
Examinare API juurdepääs
Äriliseks kasutamiseks mitte

Järjekord

Uuringud

clearVotes

Eelvaade puudub

Kustutage küsitluse hääled. Kustutab kõik küsitluse hääled, kasuta ettevaatusega!

POST andmete teave:

(Punane Posti info on kohustuslik, must on valikuline), kõik POST andmete pealkirjad on tõstutundlikud.

surveyID

Küsitluse ID Examinares.

Tagastamise andmed

See API-kõne tagastab ühe olekuteabe, kui see on edukas, vastasel juhul tõrketeate, et küsitlust ei leitud.

copySurvey

Eelvaade puudub

Küsitluse kopeerimine ja äsja loodud küsitluse teabe tagastamine.

POST andmete teave:

(Punane Posti info on kohustuslik, must on valikuline), kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
name	Küsitluse nimi (näidatakse ainult kontos)

Tagastamise andmed

See API-kõne tagastab ühe XML-küsitluse konteineri. XML-küsitluse konteiner sisaldab teavet, sealhulgas surveyID, mida kasutatakse teie raamistikku tehtavate kõnede puhul.

(Vaata listSurveys vormindamine abi.)

fetchResults

PHP näide

<?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.*/
                        
?>

Näide väljund

XML-i näide

<?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>

Küsitluse tulemuste toomine ilma taustade filtreerimiseta.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
timestamp1	Kasutatakse koos timestamp2-ga häälte valimiseks vahemikus 2 kuupäevad. Peab olema kujul UNIX ajatempel.
timestamp2	UNIXi ajatempel.
allowcomments	Määra see parameeter nii, et kõik tagastaks küsitluse küsimustele sisestatud kommentaarid.

fetchResultsByInfoReg

Näide väljund

XML-i näide

<?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>

Too tulemused küsitlusest tehingu ID-ga.

POST andmete teave:

(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
timestamp1	Kasutatakse koos timestamp2-ga häälte valimiseks vahemikus 2 kuupäevad. Peab olema kujul UNIX ajatempel.
timestamp2	UNIXi ajatempel.
infoReg	Tehingu ID, mida saab koguda, kui kasutate URL-is jälgimiskoodiga automaatset tagastamist. Lisateabe saamiseks võtke ühendust tehnilise toega.

Wildcard enabled => Apply * Wildcard kasutamiseks. Näide: Nisse võib olla “N*e”

fetchResultsByUser

Näide väljund

XML-i näide

<?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>

Küsitluse tulemuste toomine taustandmete filtreerimisega.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
timestamp1	Kasutatakse koos timestamp2-ga häälte valimiseks vahemikus 2 kuupäevad. Peab olema kujul UNIX ajatempel.
timestamp2	UNIXi ajatempel.
contactID	contactID Vastuvõtjaga ühenduse loomine. (Metamärgid lubatud)
email	Adressaadile kuuluv e-posti aadress. (Metamärgid lubatud)
group	Grupi nimi, mis kuulub adressaadile. (Metamärgid lubatud)
title	Adressaadile kuuluv tiitel. (Metamärgid lubatud)
company	Ettevõtte nimi, mis kuulub adressaadile. (Metamärgid lubatud)
company-title	Adressaadi ettevõtte nimi. (Metamärgid lubatud)
department	Ettevõtte osakond. (Wildcard lubatud)
customer-group	Kliendirühm. (Metamärgid lubatud)
gender	Vaata kliendiinfot.
address	Aadress (Metamärgid lubatud)
state	Olek (metsamärk lubatud)
country	Riik (Wildcard lubatud)
city	Linna (Wildcard lubatud)
postal-code	Postiindeks (Metamärgid lubatud)

Wildcard enabled => Apply * Wildcard kasutamiseks. Näide: Nisse võib olla N*e

getRecipientsBasedByResults

Eelvaade puudub

See funktsioon kasutab sama sisendandmeid nagu fetchResultsByUser ja näitab vastuvõtjaid, kes on vastanud sisendandmete alusel.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
timestamp1	Kasutatakse koos timestamp2-ga häälte valimiseks vahemikus 2 kuupäevad. Peab olema kujul UNIX ajatempel.
timestamp2	UNIXi ajatempel.
contactID	contactID Vastuvõtjaga ühenduse loomine. (Metamärgid lubatud)
email	Adressaadile kuuluv e-posti aadress. (Metamärgid lubatud)
group	Grupi nimi, mis kuulub adressaadile. (Metamärgid lubatud)
title	Adressaadile kuuluv tiitel. (Metamärgid lubatud)
company	Ettevõtte nimi, mis kuulub adressaadile. (Metamärgid lubatud)
company-title	Adressaadi ettevõtte nimi. (Metamärgid lubatud)
department	Ettevõtte osakond. (Wildcard lubatud)
customer-group	Kliendirühm. (Metamärgid lubatud)
gender	Vaata kliendiinfot.
address	Aadress (Metamärgid lubatud)
state	Olek (metsamärk lubatud)
country	Riik (Wildcard lubatud)
city	Linna (Wildcard lubatud)
postal-code	Postiindeks (Metamärgid lubatud)

Wildcard enabled => Apply * Wildcard kasutamiseks. Näide: Nisse võib olla N*e

importSurvey

Eelvaade puudub

Importige Examinare fail oma kontole.

POST andmete teave:
(Punane teave on kohustuslik), kõik POST andmete pealkirjad on tõstutundlik.

examinarexml

Examinare küsitlusfaili (.examinare) faili sisu

Pange tähele: soovitame saata süsteemi ainult eelnevalt vormindatud või tõlgitud Examinare küsitluse faili.

Kui muudate faili struktuuri, siis võib see tekitada viga küsitluse kasutamisel. Kui tõlgid faili ise, siis kasuta kindlasti tööriista sees olevat tõlkefunktsiooni.

listSurveys

Näide väljund

XML-i näide

<?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 andmete teave:
See funktsioon ei vaja täiendavaid POST-andmeid.

Tagastamise andmed

See API-kõne tagastab mitme XML-küsitluse konteineri. XML-küsitluse konteiner sisaldab teavet, sealhulgas surveyID, mida kasutatakse teie raamistikku tehtavate kõnede puhul.

questionsInSurveys

Näide väljund

XML-i näide

<?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>

Toob kõik küsitluse küsimused.

POST andmete teave:
(Punane teave on kohustuslik), kõik POST andmete pealkirjad on tõstutundlik.

surveyID

Küsitluse ID Examinares.

searchFreeText

Koodi eelvaade puudub

POST andmete teave:
(Punane teave on kohustuslik), kõik POST andmete pealkirjad on tõstutundlik.

surveyID	SurveyID Valige küsitlus, mida soovite otsida
Text	Otsitav fraas. Metamärk (*) on lubatud.

sendMessageEmail

PHP Näide Code

PHP näide

<?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.*/
                        
?>

Näide väljund

<?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 andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

kasutaja_ *	Kontaktandmetest contactID. * tuleb muuta numbriteks. Näiteks user_1, user_2 jne.
delivery_message	Sõnum saadetakse e-posti teel. Maksimaalselt 220 märki.
delivery_subject	Sõnumi teema.
rtl	Kasutage araabia ja heebrea keele jaoks RTL-kodeerimist. Määrake 1 jah või ei määrata ei.
includelogo	Kasutage logo ülemises bänneris. Määrake 1 jah või ei määrata ei.

sendMessageSMS

PHP Näide Code

<?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.*/
                        
?>

Näide väljund

<?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>

Saada SMS-sõnum adressaatidele.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

kasutaja_ *	Kontaktandmetest contactID. * tuleb muuta numbriteks. Näiteks user_1, user_2 jne.
delivery_message	Sõnum saadetakse SMS-iga. Maksimaalselt 220 märki.
rtl	Kasutage araabia ja heebrea keele jaoks RTL-kodeerimist. Määrake 1 jah või ei määrata ei.

Märkus.: Sellel sõnumil ei ole linki küsitluse või hääletuse juurde. Kui soovite lisada linki küsitlusele, siis kasutage API Calli nimega “sendSurvey (SMS)”.

sendSurvey (E-post)

PHP koodi näide

<?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.*/
                        
?>

Proovi väljund

<?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>

Saate adressaatidele saata e-posti kutseid.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
kasutaja_ *	Kontaktandmetest contactID. * tuleb muuta numbriteks. Näiteks user_1, user_2 jne.
delivery_message	Sõnum saadetakse e-posti teel. Maksimaalselt 220 märki.
delivery_subject	Sõnumi teema.
includelogo	Kasutage logo ülemises bänneris. Määrake 1 jah või ei määrata ei.
schedule	Ajastage see e-kiri hilisemaks kohaletoimetamiseks. Peab sisaldama UNIXi ajatemplit

sendSurvey (SMS)

PHP koodi näide

<?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.*/
                        
?>

Proovi väljund

<?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>

Saada SMS kutsed adressaatidele.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
kasutaja_ *	Kontaktandmetest contactID. * tuleb muuta numbriteks. Näiteks user_1, user_2 jne.
delivery_message	Sõnum saadetakse SMS-iga.
delivery_by	Peab olema seatud SMS.
schedule	Plaani see SMS hilisemaks kohaletoimetamiseks. Peab sisaldama UNIXi ajatemplit

updateInstructionText

Eelvaade puudub

Uuenda juhendteksti QuestionNumber küsitluses.

POST andmete teave:
(Punane Posti info on kohustuslik, must on valikuline), kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	SurveyID, vaata listSurveys rohkem infot
instructionText	Uus juhendtekst sellele küsimusele. (Reavahetuse asemel kasuta \|\|!reapiir!\|\|)
questionNumber	Küsimuse number leitud listSurveys.

Tagastamise andmed

See API-kõne tagastab XML-vastuse staatusega Success, kui see on uuendatud, error, kui on kutsutud viga. Tagastatakse nimekirja struktuur, vaata questionInSurveys struktuuri kohta lisateabe saamiseks.

updateQuestionText

Eelvaade puudub

Uuenda Küsimuste teksti QuestionNumber küsitluses.

POST andmete teave:
(Punane Posti info on kohustuslik, must on valikuline), kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	SurveyID, vaata listSurveys rohkem infot
questionText	Küsitluse uus küsimus. (Reavahetuse asemel kasuta \|\|!reavahetust!\|\|)
questionNumber	Küsimuse number leitud listSurveys.

Tagastamise andmed

Vastuvõtjad

addRecipient

Tagastamise andmed

See API-kõne tagastab XML-vastuse staatusega Success, kui see on loodud, error, kui viga on kutsutud. XML kontaktid konteiner sisaldab teavet, sealhulgas contactID, mis kasutatakse teie kõnesid raamistikule. See sisaldab ka kontakti ID.

PHP koodi näide

<?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.*/
                        
?>

Proovi väljund

<?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>

Lisa adressaat ettevõtte andmebaasi.

POST andmete teave:

(Punane Posti info on kohustuslik, must on valikuline), kõik POST andmete pealkirjad on tõstutundlikud.

name	Saaja eesnimi.
lastname	Saaja perekonnanimi.
email	Saaja e-posti aadress.
mobile	Mobiiltelefoni number. (Vorming 00[riigi kood][piirkonnakood][telefoninumber]) Näide : 00467031234567
group	Rühma nimi.
title	Isiklik tiitel.
company	Ettevõtte nimi.
company-title	Saaja ettevõtte nimi.
department	Osakond ettevõttes.
customer-group	Kliendirühm.
gender	Vastuvõtja sugu. (mees meeste puhul, naine naiste puhul).
birth-year	Sünniaasta (YYYY), ainult numbrid.
birth-month	Sünnikuu (MM), ainult numbrid.
birth-day	Sünnipäev (DD), ainult numbrid.
phonenumber	Saaja telefoninumber.
attention	Saaja tähelepanu aadress.
address	Saaja aadress.
city	Linna nimi
state	Osariigi nimi.
postal-code	Postiindeks.
country	Riigi nimi.
crmserial	Seeria integreerimismoodulist ex. Zendeski pileti ID.
extrafieldkey	Sisestage lisaväljade võti allpool toodud vormingus.

delRecipient

PHP koodi näide

<?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.*/
                        
?>

Kustutab adressaadi ettevõtte andmebaasist.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

contactID

Kontakti ID teie Examinare andmebaasist.

Tagastamise andmed

See API-kõne tagastab XML-vastuse staatusega Success, kui see on kustutatud, error, kui on kutsutud viga.

listRecipientByContactID

Tagastamise andmed

See API-kõne tagastab ühe XML-kontaktide konteineri. XML kontaktide konteiner sisaldab infot, sealhulgas contactID, mida kasutatakse teie raamistikku tehtavates kõnedes (vt addRecipient).

PHP koodi näide

<?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.*/
                        
?>

Ühe adressaadi kohta teabe loetlemine adressaadi e-posti aadressi abil contactID.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

contactID

Kontakti ID teie Examinare andmebaasist.

listRecipientByCRMSerial

Tagastamise andmed

See API-kõne tagastab ühe XML-kontaktide konteineri. XML kontaktid konteiner sisaldab teavet, sealhulgas contactID, mis kasutatakse teie kõnesid raamistikku. Pange tähele, et see kõne võib tagastada mitu kontakti. (Vaata addRecipient)

PHP koodi näide

<?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.*/
                        
?>

Loetle üksiku adressaadi andmed CRM Seriali abil, mis on loodud Examinare laiendustes, mis on saadaval.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

crmserial

Crm Serial sealhulgas plugin struktuur. Vaadake üksikasju adressaadi ekraanil.

listRecipientByEmail

Tagastamise andmed

PHP koodi näide

<?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.*/
                        
?>

Ühe adressaadi teabe loendamine adressaadi meiliaadressi abil.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

Kontakti e-posti aadress teie Examinare andmebaasist.

listRecipients

Tagastamise andmed

See API-kõne tagastab mitme XML-kontaktide konteineri. XML kontaktide konteiner sisaldab infot, sealhulgas contactID, mida kasutatakse teie raamistikku tehtavates kõnedes (vt addRecipient).

PHP koodi näide

<?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.*/
                        
?>

Hankige täielik nimekiri kõigist vastuvõtjatest oma Examinare andmebaasis.

POST andmete teave:

See funktsioon ei vaja täiendavaid POST-andmeid.

listRecipientsByGroup

Tagastamise andmed

See API-kõne tagastab ühe XML-kontaktide konteineri. XML kontaktide konteiner sisaldab infot, sealhulgas contactID, mida kasutatakse teie raamistikku tehtavates kõnedes (vt addRecipient).

Teave, sealhulgas contactID, mida kasutatakse teie raamistikku tehtavates kõnedes. (Vaata addRecipient)

PHP koodi näide

<?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.*/
                        
?>

Adressaatide loend rühma nime järgi.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

group

Rühma nimi

listRecipientsExtraFields

Teave, sealhulgas contactID, mida kasutatakse teie raamistikku tehtavates kõnedes. (Vaata addRecipient)

PHP koodi näide

<?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>

Vastuvõtja profiili saab laiendada Extra Fieldidega ja need saadetakse vastuvõtjate lisamisel, laadimisel, uuendamisel.

POST andmete teave:

See funktsioon ei võta POST parameetreid.

Tagastamise andmed

key	Vastuvõtja andmetes kasutatav võti.
caption	Välja pealkiri Examinare seadetest.
type	Välja tüüp (valimine, tekst, märkeruut)
options	Suvandid valikutüübi välja kasutamisel.

listRecipientsToSurvey

PHP koodi näide

<?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.*/
                        
?>

Näide väljund

<?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>

Loetle kõik saajate lingid ja Examinare’i poolt saadetud kutsete staatus.

Pange tähele: Selle käsuga saab kasutada ainult anonüümseid ja privaatseid küsitlusi.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID

Küsitluse ID Examinares.

listSurveysByUser

Tagastamise andmed

See API-kõne tagastab mitme XML-küsitluse konteineri. XML-küsitluse konteiner sisaldab teavet, sealhulgas surveyID, mida kasutatakse teie raamistikku tehtavate kõnede puhul.

PHP koodi näide

<?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.*/
                        
?>

Loetle kõik saajaga ja olekuga seotud küsitlused.

POST andmeteave

(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

contactID

Kontakti ID teie Examinare andmebaasist.

markRecipientsToSurvey

Näide väljund

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

Märgistage Examinare olekulogis adressaadid kui ühele küsitlusele kutsutud isikud.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
kasutaja_ *	Kontaktandmetest contactID. * tuleb muuta numbriteks. Näiteks user_1, user_2 jne.

listSurveysByUser

Tagastamise andmed

See API-kõne tagastab mitme XML-küsitluse konteineri. XML-küsitluse konteiner sisaldab teavet, sealhulgas surveyID, mida kasutatakse teie raamistikku tehtavate kõnede puhul.

PHP koodi näide

<?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.*/
                        
?>

Proovi väljund

<?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>

Loetle kõik saajaga ja olekuga seotud küsitlused.

POST andmeteave

(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

contactID

Kontakti ID teie Examinare andmebaasist.

markRecipientsToSurvey

Eelvaade puudub

Märgistage Examinare olekulogis adressaadid kui ühele küsitlusele kutsutud isikud.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
kasutaja_ *	Kontaktandmetest contactID. * tuleb muuta numbriteks. Näiteks user_1, user_2 jne.

updateGenderRecipient

Tagastamise andmed

See API-kõne tagastab XML-vastuse staatusega Success, kui see on uuendatud, error, kui viga on kutsutud. XML-kontaktide konteiner sisaldab teavet, sealhulgas contactID Kasutajad saavad määrata, milliseid andmeid kasutatakse raamistiku väljakutsetes. (Vaata addRecipient)

Pange tähele, et allpool toodud näide on addrecipient ja tuleb kohandada, et kasutada uuendamise funktsiooni.

Proovi väljund

XML-i näide

<?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>

Värskendage ühe adressaadi sooteavet.

POST andmete teave:

(Punane Posti info on kohustuslik, must on valikuline), kõik POST andmete pealkirjad on tõstutundlikud.

contactID	Kontakti ID teie Examinare andmebaasist.
gender	Vastuvõtja sugu. (mees meeste puhul, naine naiste puhul).

updateRecipient

Tagastamise andmed

See API-kõne tagastab XML-vastuse staatusega Success, kui see on uuendatud, error, kui on kutsutud viga. XML kontaktide konteiner sisaldab teavet, sealhulgas contactID, mida kasutatakse teie raamistikku tehtavatel kõnedel. (Vaata ka XML kontaktide konteiner). addRecipient)

Pange tähele, et allpool toodud näide on addrecipient ja tuleb kohandada, et kasutada uuendamise funktsiooni.

Proovi väljund

XML-i näide

<?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>

Uuendage Examinare andmebaasis olevat vastuvõtjate infot.

POST andmete teave:

(Punane Posti info on kohustuslik, must on valikuline), kõik POST andmete pealkirjad on tõstutundlikud.

contactID	Kontakti ID teie Examinare andmebaasist.
name	Saaja eesnimi.
lastname	Saaja perekonnanimi.
email	Saaja e-posti aadress.
mobile	Mobiiltelefoni number. (Vorming 00[riigi kood][piirkonnakood][telefoninumber]) Näide : 00467031234567
group	Rühma nimi.
title	Isiklik tiitel.
company	Ettevõtte nimi.
company-title	Saaja ettevõtte nimi.
department	Osakond ettevõttes.
customer-group	Kliendirühm.
gender	Vastuvõtja sugu. (mees meeste puhul, naine naiste puhul).
birth-year	Sünniaasta (YYYY), ainult numbrid.
birth-month	Sünnikuu (MM), ainult numbrid.
birth-day	Sünnipäev (DD), ainult numbrid.
phonenumber	Saaja telefoninumber.
attention	Saaja tähelepanu aadress.
address	Saaja aadress.
city	Linna nimi
state	Osariigi nimi.
postal-code	Postiindeks.
country	Riigi nimi.
extrafieldkey	Võti ekstraväljadelt.

Uuringu aruande failid

fetchReportFile

PHP näide

<?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.*/
                        
?>

Proovi väljund

Koodi näide

RAW FILE CONTENT

Tooge oma kontolt aruanne, mis sisaldab teavet funktsioonist fetchReportFileList.

MÄRKUS: See funktsioon tagastab tegeliku faili päiste ja mitte XML struktuuri. Veenduge, et uuendate oma wrapperit uusimale versioonile, et oleks võimalik kasutada PHP Wrapperit selle funktsiooni jaoks.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
reportID	Aruande ID funktsioonist fetchReportFileList.

fetchReportFileList

PHP näide

<?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.*/
                        
?>

Proovi väljund

XML-i näide

<?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>

Too küsitlusest aruannete loend, mida saab kasutada funktsiooniga fetchReportFile.

POST andmete teave:
(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID

Küsitluse ID Examinares.

Magic Polls

fetchMagicPollSummary

Proovi tagastamine 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>

Proovi tagastamine 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 andmete teave:
Seda funktsiooni saab kasutada koos valikulise POST-võtmega magicID. Kui magicID on määratletud, lisatakse XML-i tagastusele üksikasjalikumad tulemused.

Tagastamise andmed

See API-kõne tagastab mitme XML Magic Poll konteineri, kui magicID ei ole määratletud (Sample return 1).

Kui magicID on määratletud, tagastab see üksikasjalikuma info (Sample return 2).

Proovi tagastamine 1

Näidistagastus 1

Põhiteave 1

magicID	Magic Poll’i ID Examinare’is.
magicName	Küsimus küsiti.
completedAnswers	Küsitluses täidetud vastused.
Options	Valikuvõimalused küsitluse tulemustega. Kui lisatud Valikud. Kui valikuid pole, on see väli tühi.
– Number	Küsitlusvaliku identifitseerimisnumber.
– Optiontext	Küsitluse tekst
– Result	Küsitlusvaliku tulemus
– Percent	Küsitlusvaliku protsent võrreldes täidetud vastuste kokkuvõttega.

Proovi tagastamine 2

Näidistagastus 2

Põhiteave 2

Käesolevas jaotises sisalduvate üldväljade puhul kontrollige võtmeteavet 1, kuna selles osas käsitletakse ainult võtmeteabe 1 ja 2 erinevust.

SMS	Konteiner SMS-hääletusteks
– Answer	Konteiner individuaalse SMS-vastuse jaoks.
– – id	Selle hääletuse ID Examinare’is.
– – when	Hääletuse kuupäev Y-M-D formaadis Aeg
– – stamp	Unix Hääletuse ajatempel
– – phrase	Fraas saadetud.
– – from	Telefoninumber, kes selle saatis.
Web	Veebihääletuste konteiner
– Answer	Konteiner individuaalsete veebi hääletustega.
– – id	Selle hääletuse ID Examinare’is.
– – when	Hääletuse kuupäev Y-M-D formaadis Aeg
– – stamp	Unix Hääletuse ajatempel
– – phrase	Fraas saadetud.
– – from	Hääletusvormi URL.
– – ip	Hääletusele siseneva seadme ip-aadress.

voteMagicPoll

Eelvaade puudub

POST andmete teave:

magicID	Magic Poll’i ID Examinare’is.
Option	Kutsutud arv fetchMagicPollSummary sees (valikuline, kuid soovitatav)
Text	Vaba teksti vastus. (Vabatahtlik, kuid soovitatav)
GadgetID	Saate määratleda GadgetID (vabatekst), et saaksite jälgida, kust hääl pärineb. (valikuline)

Tagastamise andmed

See funktsioon tagastab edu korral oleku Status = OK ja tõrke korral oleku Status = Error.

Phone Surveys

listPhoneSurveys

Tagastamise andmed

See API-kõne tagastab mitme XML-küsitluse konteineri. XML-küsitluse konteiner sisaldab teavet, sealhulgas surveyID, mida kasutatakse teie raamistikku tehtavate kõnede puhul.

Proovi väljund

<?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>

Loetle kõik uuringud, mis on avaldatud kui telefoni uuring ja nende staatus.

POST andmete teave:
See funktsioon ei vaja täiendavaid POST-andmeid.

Põhiteave

surveyID	Küsitluse ID Examinares.
surveyName	Telefoniküsitluse nimi.
surveyTaggName	Examinares kasutatav silt.
status	– Sissetulev – väljaminev
callerIDs	Näitab ainult siis, kui Väljaminev ja see callerID Taotlusega tuleb saata: sendPhoneSurvey. Kui teil on vaja lisada veel üks CallerID Võta ühendust klienditoega, et see autoriseerida.
phoneNumbers	Näitab ainult siis, kui Inbound ja näitab, milline telefoninumber teie Telefon Küsitlus on ligipääsetav ja milline callerID teil on vaja, et see vastata.
completedAnswers	Küsitluse vastuste arv (kogu küsitluse kohta).
stoppedAnswers	Vastuste arv, mis on blokeeritud küsitluse käigus (kogu küsitluse kohta).
surveyLanguage	Telefoniküsitluses kasutatava keele lühikood.

sendPhoneSurvey

Eelvaade puudub

Tehke tegelik valimistaotlus.

Funktsionaalsus töötab ainult siis, kui teil on Telefon Küsitlus lubatud oma kontole!

Lubamiseks võtke ühendust müügiga.

POST andmete teave:

(Punane Kõik POST andmete pealkirjad on tõstutundlikud.

surveyID	Küsitluse ID Examinares.
kasutaja_ *	Kontaktandmetest contactID. * tuleb muuta numbriteks. Näiteks user_1, user_2 jne.
callerID	Callerid aktiveeritud oma kontole. Neid saab leida helistamise listPhoneSurveys. (VALIK)