Examinare API – översikt

Kom igång med Examinares enkät-API

Videoguide: aktivera Examinare API

Aktivera Examinare Survey Tool API

Röda fält är obligatoriska och behöver ett värde. XML-data skickas som POST-data över HTTPS.
Dokumentet börjar med en översikt över tillgängliga funktioner. Därefter följer detaljerna.

Adressen för alla funktioner är
https://api.examinare.com/framework
Lägg till tre värden i POST-data för att ansluta:

apiKey – finns i ditt Examinare-konto.
apiCompany – företagsdatabasen som ska användas.
Command – kommandot som ska anropas.
Funktionen du anropar kan behöva fler parametrar.

Mobilt API och separata API-nycklar

Om du vill använda ett inloggningsbaserat arbetssätt i stället för att dela den statiska API-nyckeln kan du använda kommandot setPhoneID, som ger en mobil API-token. Den kan användas i stället för den statiska tokenen. Mobila API-token kan tas bort under Inställningar → Avancerade inställningar i kontot.

PHP-bibliotek

PHP-exempel

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

Kod för PHP-biblioteket

Bibliotekets kod visas nedan.

Kopiera koden till din implementation.

Om filen heter examinare-api.php stämmer filnamnet med PHP-exemplen på den här webbplatsen.

Om du använder ett annat filnamn behöver du ändra include-satsen. PHP-biblioteket finns på GitHub. https://github.com/examinare/examinare-php-wrapper

setPhoneID – använd mobilt API

XML-exempel

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

Med setPhoneID kan du skapa API-nycklar kopplade till en aktiv administrativ användare. Funktionen för mobila nycklar behöver aktiveras i kontots konfiguration.

Information om POST-data:
Röd information är obligatorisk. Parameternamn är skiftlägeskänsliga.

apiCompany	Företags-ID
user	Administratörens användarnamn
pass	Administratörens lösenord som MD5-hash.
deviceInformation	Valfri text som beskriver enheten eller API-kopplingen. Visas i kontots lista över API-token.

Planerar du en lösning som bygger på Examinare?

Kontakta Examinare för att bekräfta API-åtkomst, testmiljö och kontokrav för din implementation. Externa program behöver kopplas till rätt Examinare-konto.

Bekräfta villkoren för utveckling, test och kommersiell användning innan du börjar.

Enkäter

clearVotes

Ingen förhandsvisning

Radera svaren i en enkät. Alla enkätsvar tas bort. Använd funktionen med försiktighet.

Information om POST-data:

(Röda information är obligatorisk och svart är valfri. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID

Enkätens ID i Examinare.

Svarsdata

Vid lyckat anrop returneras en status. Om enkäten inte hittas returneras ett felmeddelande.

copySurvey

Ingen förhandsvisning

Kopiera en enkät och returnera uppgifter om den nya enkäten.

Information om POST-data:

(Röda information är obligatorisk och svart är valfri. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
name	Enkätens namn. Visas endast i kontot.

Svarsdata

Anropet returnerar en XML-behållare för en enkät. Den innehåller bland annat surveyID, som används vid senare anrop.

Se listSurveys för formatet.

fetchResults

PHP-exempel

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

Exempel på utdata

XML-exempel

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

Hämta enkätresultat utan filtrering på bakgrundsuppgifter.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
timestamp1	Används tillsammans med timestamp2 för att välja svar mellan två datum. Ska anges som en Unix-tidsstämpel.
timestamp2	Unix-tidsstämpel.
allowcomments	Ange ett värde för parametern för att returnera kommentarer till enkätfrågorna.

fetchResultsByInfoReg

Exempel på utdata

XML-exempel

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

Hämta enkätresultat med transaktions-ID.

Information om POST-data:

(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
timestamp1	Används tillsammans med timestamp2 för att välja svar mellan två datum. Ska anges som en Unix-tidsstämpel.
timestamp2	Unix-tidsstämpel.
infoReg	Transaktions-ID kan hämtas vid automatisk återkoppling med tracecode i adressen. Kontakta teknisk support via e-post för mer information.

Jokertecken stöds. Använd *. Exempel: Nisse kan anges som N*e.

fetchResultsByUser

Exempel på utdata

XML-exempel

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

Hämta enkätresultat med filtrering på bakgrundsuppgifter.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
timestamp1	Används tillsammans med timestamp2 för att välja svar mellan två datum. Ska anges som en Unix-tidsstämpel.
timestamp2	Unix-tidsstämpel.
contactID	Mottagarens contactID. Jokertecken stöds.
email	Mottagarens e-postadress. Jokertecken stöds.
group	Mottagarens gruppnamn. Jokertecken stöds.
title	Mottagarens titel. Jokertecken stöds.
company	Mottagarens företagsnamn. Jokertecken stöds.
company-title	Mottagarens befattning. Jokertecken stöds.
department	Avdelning i företaget. Jokertecken stöds.
customer-group	Kundgrupp. Jokertecken stöds.
gender	Se kundinformationen.
address	Adress. Jokertecken stöds.
state	Delstat eller region. Jokertecken stöds.
country	Land. Jokertecken stöds.
city	Ort. Jokertecken stöds.
postal-code	Postnummer. Jokertecken stöds.

Jokertecken stöds. Använd *. Exempel: Nisse kan anges som N*e.

getRecipientsBasedByResults

Ingen förhandsvisning

Funktionen använder samma indata som fetchResultsByUser och visar mottagarna som har svarat enligt sökvillkoren.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
timestamp1	Används tillsammans med timestamp2 för att välja svar mellan två datum. Ska anges som en Unix-tidsstämpel.
timestamp2	Unix-tidsstämpel.
contactID	Mottagarens contactID. Jokertecken stöds.
email	Mottagarens e-postadress. Jokertecken stöds.
group	Mottagarens gruppnamn. Jokertecken stöds.
title	Mottagarens titel. Jokertecken stöds.
company	Mottagarens företagsnamn. Jokertecken stöds.
company-title	Mottagarens befattning. Jokertecken stöds.
department	Avdelning i företaget. Jokertecken stöds.
customer-group	Kundgrupp. Jokertecken stöds.
gender	Se kundinformationen.
address	Adress. Jokertecken stöds.
state	Delstat eller region. Jokertecken stöds.
country	Land. Jokertecken stöds.
city	Ort. Jokertecken stöds.
postal-code	Postnummer. Jokertecken stöds.

Jokertecken stöds. Använd *. Exempel: Nisse kan anges som N*e.

importSurvey

Ingen förhandsvisning

Importera en Examinare-fil till ditt konto.

Information om POST-data:
Röd information är obligatorisk. Parameternamn är skiftlägeskänsliga.

examinarexml

Innehållet i enkätfilen med filändelsen .examinare.

Skicka bara en färdigformaterad eller översatt Examinare-enkätfil till systemet.

Ändringar av filstrukturen kan orsaka fel i enkäten. Använd verktygets översättningsfunktion om filen ska översättas.

listSurveys

Exempel på utdata

XML-exempel

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

Information om POST-data:
Funktionen behöver inga ytterligare POST-parametrar.

Svarsdata

Anropet returnerar XML-behållare för flera enkäter. De innehåller bland annat surveyID, som används vid senare anrop.

questionsInSurveys

Exempel på utdata

XML-exempel

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

Hämta alla frågor från en enkät.

Information om POST-data:
Röd information är obligatorisk. Parameternamn är skiftlägeskänsliga.

surveyID

Enkätens ID i Examinare.

searchFreeText

Ingen kodförhandsvisning

Information om POST-data:
Röd information är obligatorisk. Parameternamn är skiftlägeskänsliga.

surveyID	surveyID för enkäten som ska sökas igenom.
Text	Frasen som ska sökas. Jokertecknet * stöds.

sendMessageEmail

PHP-kodexempel

PHP-exempel

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

Exempel på utdata

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

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

user_*	contactID från kontaktuppgifterna. Ersätt * med ett nummer, till exempel user_1 eller user_2.
delivery_message	Meddelande som skickas via e-post. Högst 220 tecken enligt API-referensen.
delivery_subject	Meddelandets ämnesrad.
rtl	Använd RTL för arabiska och hebreiska. Ange 1 för ja eller utelämna parametern för nej.
includelogo	Visa logotyp i den övre bannern. Ange 1 för ja eller utelämna parametern för nej.

sendMessageSMS

PHP-kodexempel

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

Exempel på utdata

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

Skicka SMS till mottagare.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

user_*	contactID från kontaktuppgifterna. Ersätt * med ett nummer, till exempel user_1 eller user_2.
delivery_message	Meddelande som skickas via SMS. Högst 220 tecken enligt API-referensen.
rtl	Använd RTL för arabiska och hebreiska. Ange 1 för ja eller utelämna parametern för nej.

Meddelandet innehåller ingen länk till en enkät eller omröstning. Använd sendSurvey (SMS) om du vill skicka en enkätlänk.

sendSurvey (Email)

PHP-kodexempel

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

Exempel på utdata

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

Skicka enkätinbjudningar via e-post.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
user_*	contactID från kontaktuppgifterna. Ersätt * med ett nummer, till exempel user_1 eller user_2.
delivery_message	Meddelande som skickas via e-post. Högst 220 tecken enligt API-referensen.
delivery_subject	Meddelandets ämnesrad.
includelogo	Visa logotyp i den övre bannern. Ange 1 för ja eller utelämna parametern för nej.
schedule	Schemalägg e-postmeddelandet för senare utskick. Ange en Unix-tidsstämpel.

sendSurvey (SMS)

PHP-kodexempel

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

Exempel på utdata

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

Skicka enkätinbjudningar via SMS.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
user_*	contactID från kontaktuppgifterna. Ersätt * med ett nummer, till exempel user_1 eller user_2.
delivery_message	Meddelandet som ska skickas via SMS.
delivery_by	Ska anges som SMS.
schedule	Schemalägg SMS:et för senare utskick. Ange en Unix-tidsstämpel.

updateInstructionText

Ingen förhandsvisning

Uppdatera instruktionstext för ett visst frågenummer i enkäten.

Information om POST-data:
(Röda information är obligatorisk och svart är valfri. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	surveyID. Se listSurveys för mer information.
instructionText	Ny instruktionstext för frågan. Använd \|\|!linebreak!\|\| för radbrytningar.
questionNumber	Frågenumret finns i listSurveys.

Svarsdata

Anropet returnerar ett XML-svar med status Success vid uppdatering eller error vid fel. Strukturen returneras som en lista. Se questionInSurveys för mer information.

updateQuestionText

Ingen förhandsvisning

Uppdatera frågetext för ett visst frågenummer i enkäten.

Information om POST-data:
(Röda information är obligatorisk och svart är valfri. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	surveyID. Se listSurveys för mer information.
questionText	Ny frågetext i enkäten. Använd \|\|!linebreak!\|\| för radbrytningar.
questionNumber	Frågenumret finns i listSurveys.

Svarsdata

Anropet returnerar ett XML-svar med status Success vid uppdatering eller error vid fel. Strukturen returneras som en lista. Se questionInSurveys för mer information.

Mottagare

addRecipient

Svarsdata

Anropet returnerar ett XML-svar med status Success om mottagaren skapas eller error vid fel. XML-behållaren för kontakter innehåller bland annat contactID, som används vid senare anrop.

PHP-kodexempel

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

Exempel på utdata

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

Lägg till en mottagare i företagsdatabasen.

Information om POST-data:

(Röda information är obligatorisk och svart är valfri. Parameternamn i POST-data är skiftlägeskänsliga.

name	Mottagarens förnamn.
lastname	Mottagarens efternamn.
email	Mottagarens e-postadress.
mobile	Mobilnummer. Format: 00[landskod][riktnummer][telefonnummer]. Exempel: 00467031234567.
group	Gruppnamn.
title	Personlig titel.
company	Företagsnamn.
company-title	Mottagarens befattning.
department	Avdelning i företaget.
customer-group	Kundgrupp.
gender	Mottagarens kön. Ange male för man eller female för kvinna enligt API-värdena.
birth-year	Födelseår, YYYY. Endast siffror.
birth-month	Födelsemånad, MM. Endast siffror.
birth-day	Födelsedag, DD. Endast siffror.
phonenumber	Mottagarens telefonnummer.
attention	Mottagarens referens i adressen.
address	Mottagarens adress.
city	Ortsnamn.
state	Delstat eller region.
postal-code	Postnummer.
country	Landets namn.
crmserial	ID från integrationsmodul, till exempel ett Zendesk-ärendenummer.
extrafieldkey	Nyckel för extrafält i formatet nedan.

delRecipient

PHP-kodexempel

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

Ta bort en mottagare från företagsdatabasen.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

contactID

Kontaktens ID i din Examinare-databas.

Svarsdata

Anropet returnerar ett XML-svar med status Success vid borttagning eller error vid fel.

listRecipientByContactID

Svarsdata

Anropet returnerar en XML-behållare för en kontakt. Den innehåller bland annat contactID för senare anrop. Se addRecipient.

PHP-kodexempel

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

Visa en mottagares uppgifter med hjälp av contactID.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

contactID

Kontaktens ID i din Examinare-databas.

listRecipientByCRMSerial

Svarsdata

Anropet returnerar en XML-behållare för kontakter med bland annat contactID. Flera kontakter kan returneras. Se addRecipient.

PHP-kodexempel

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

Visa mottagaruppgifter med hjälp av det CRM-ID som skapas av tillgängliga Examinare-tillägg.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

crmserial

CRM-ID inklusive tilläggets struktur. Se mottagarvyn för detaljer.

listRecipientByEmail

Svarsdata

Anropet returnerar en XML-behållare för kontakter med bland annat contactID. Flera kontakter kan returneras. Se addRecipient.

PHP-kodexempel

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

Visa en mottagares uppgifter med hjälp av e-postadressen.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

Kontaktens e-postadress i din Examinare-databas.

listRecipients

Svarsdata

Anropet returnerar en XML-behållare för flera kontakter. Den innehåller bland annat contactID för senare anrop. Se addRecipient.

PHP-kodexempel

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

Hämta en fullständig lista över mottagarna i din Examinare-databas.

Information om POST-data:

Funktionen behöver inga ytterligare POST-parametrar.

listRecipientsByGroup

Svarsdata

Anropet returnerar en XML-behållare för en kontakt. Den innehåller bland annat contactID för senare anrop. Se addRecipient.

information inklusive contactID för senare anrop. Se addRecipient.

PHP-kodexempel

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

Visa mottagaruppgifter efter gruppnamn.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

group

Gruppnamn

listRecipientsExtraFields

information inklusive contactID för senare anrop. Se addRecipient.

PHP-kodexempel

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

Mottagarprofilen kan utökas med extrafält. Dessa skickas när mottagare skapas, hämtas eller uppdateras.

Information om POST-data:

Funktionen tar inga POST-parametrar.

Svarsdata

key	Nyckel som används i mottagaruppgifterna.
caption	Fältets etikett från Examinares inställningar.
type	Fälttyp: select, text eller checkbox.
options	Alternativ när fälttypen select används.

listRecipientsToSurvey

PHP-kodexempel

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

Exempel på utdata

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

Visa mottagarnas länkar och status för inbjudningar som skickas från Examinare.

Kommandot kan bara användas med privata och privata anonyma enkäter enligt API-referensen.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID

Enkätens ID i Examinare.

listSurveysByUser

Svarsdata

Anropet returnerar XML-behållare för flera enkäter. De innehåller bland annat surveyID, som används vid senare anrop.

PHP-kodexempel

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

Visa enkäter som är kopplade till en mottagare samt deras status.

Information om POST-data

(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

contactID

Kontaktens ID i din Examinare-databas.

markRecipientsToSurvey

Exempel på utdata

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

Markera mottagare som inbjudna till en viss enkät i Examinares statuslogg.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
user_*	contactID från kontaktuppgifterna. Ersätt * med ett nummer, till exempel user_1 eller user_2.

listSurveysByUser

Svarsdata

Anropet returnerar XML-behållare för flera enkäter. De innehåller bland annat surveyID, som används vid senare anrop.

PHP-kodexempel

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

Exempel på utdata

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

Visa enkäter som är kopplade till en mottagare samt deras status.

Information om POST-data

(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

contactID

Kontaktens ID i din Examinare-databas.

markRecipientsToSurvey

Ingen förhandsvisning

Markera mottagare som inbjudna till en viss enkät i Examinares statuslogg.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
user_*	contactID från kontaktuppgifterna. Ersätt * med ett nummer, till exempel user_1 eller user_2.

updateGenderRecipient

Svarsdata

Anropet returnerar ett XML-svar med status Success vid uppdatering eller error vid fel. XML-behållaren för kontakter innehåller bland annat contactID för senare anrop. Se addRecipient.

Exemplet nedan gäller addRecipient och behöver anpassas för uppdateringsfunktionen.

Exempel på utdata

XML-exempel

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

Uppdatera könsuppgiften för en mottagare.

Information om POST-data:

(Röda information är obligatorisk och svart är valfri. Parameternamn i POST-data är skiftlägeskänsliga.

contactID	Kontaktens ID i din Examinare-databas.
gender	Mottagarens kön. Ange male för man eller female för kvinna enligt API-värdena.

updateRecipient

Svarsdata

Anropet returnerar ett XML-svar med status Success vid uppdatering eller error vid fel. XML-behållaren för kontakter innehåller bland annat contactID för senare anrop. Se addRecipient)

Exemplet nedan gäller addRecipient och behöver anpassas för uppdateringsfunktionen.

Exempel på utdata

XML-exempel

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

Uppdatera mottagaruppgifter i Examinare-databasen.

Information om POST-data:

(Röda information är obligatorisk och svart är valfri. Parameternamn i POST-data är skiftlägeskänsliga.

contactID	Kontaktens ID i din Examinare-databas.
name	Mottagarens förnamn.
lastname	Mottagarens efternamn.
email	Mottagarens e-postadress.
mobile	Mobilnummer. Format: 00[landskod][riktnummer][telefonnummer]. Exempel: 00467031234567.
group	Gruppnamn.
title	Personlig titel.
company	Företagsnamn.
company-title	Mottagarens befattning.
department	Avdelning i företaget.
customer-group	Kundgrupp.
gender	Mottagarens kön. Ange male för man eller female för kvinna enligt API-värdena.
birth-year	Födelseår, YYYY. Endast siffror.
birth-month	Födelsemånad, MM. Endast siffror.
birth-day	Födelsedag, DD. Endast siffror.
phonenumber	Mottagarens telefonnummer.
attention	Mottagarens referens i adressen.
address	Mottagarens adress.
city	Ortsnamn.
state	Delstat eller region.
postal-code	Postnummer.
country	Landets namn.
extrafieldkey	Nyckel för extrafält.

Enkätrapportfiler

fetchReportFile

PHP-exempel

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

Exempel på utdata

Kodexempel

RAW FILE CONTENT

Hämta en rapport från kontot med uppgifter från fetchReportFileList.

Funktionen returnerar själva filen med HTTP-huvuden, inte en XML-struktur. Använd en uppdaterad version av PHP-biblioteket som stöder funktionen.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
reportID	Rapportens ID från fetchReportFileList.

fetchReportFileList

PHP-exempel

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

Exempel på utdata

XML-exempel

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

Hämta en lista över enkätens rapporter för användning med fetchReportFile.

Information om POST-data:
(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID

Enkätens ID i Examinare.

Magic Polls

fetchMagicPollSummary

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

Exempelsvar 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>
  <Twitter>
	<answer>
		<id>TWITTER;XXXXXXXX:388576542420267009.1381479489</id>
		<when>2013-10-11 10:18:09</when>
		<stamp>1381479489</stamp>
		<phrase>1</phrase>
		<from>XXXXXXXX</from>
	</answer>
  </Twitter>
  <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>

Information om POST-data:
Funktionen kan användas med den valfria POST-parametern magicID. När magicID anges innehåller XML-svaret mer detaljerade resultat.

Svarsdata

Utan magicID returnerar anropet en XML-behållare för flera Magic Polls. Se exempelsvar 1.

Med magicID returneras mer detaljerad information. Se exempelsvar 2.

Exempelsvar 1

Visa exempelsvar 1

Fältinformation 1

magicID	Omröstningens ID i Examinare.
magicName	Frågan som ställs.
completedAnswers	Antal slutförda svar i omröstningen.
Options	Svarsalternativ med omröstningsresultat. Fältet är tomt om inga alternativ har lagts till.
– Number	Svarsalternativets ID.
– Optiontext	Svarsalternativets text.
– Result	Svarsalternativets resultat.
– Percent	Svarsalternativets andel i procent av det totala antalet slutförda svar.

Exempelsvar 2

Visa exempelsvar 2

Fältinformation 2

För gemensamma fält, se Fältinformation 1. Avsnittet beskriver bara skillnaderna mellan de två svarstyperna.

SMS	Behållare för SMS-svar.
– Answer	Behållare för ett enskilt SMS-svar.
– – id	Svaret eller röstens ID i Examinare.
– – when	Datum och tid för svaret i formatet år-månad-dag och tid.
– – stamp	Svaret eller röstens Unix-tidsstämpel.
– – phrase	Frasen som skickades in.
– – from	Avsändarens telefonnummer.
Twitter – historiskt API-fält	Historisk behållare för Twitter-röster. Twitter-röstning erbjuds inte längre.
– Answer	Historisk behållare för ett enskilt Twitter-svar.
– – id	Svaret eller röstens ID i Examinare.
– – when	Datum och tid för svaret i formatet år-månad-dag och tid.
– – stamp	Svaret eller röstens Unix-tidsstämpel.
– – phrase	Frasen som skickades in.
– – from	Historiskt TwitterID för avsändaren.
Web	Behållare för webbsvar.
– Answer	Behållare för ett enskilt webbsvar.
– – id	Svaret eller röstens ID i Examinare.
– – when	Datum och tid för svaret i formatet år-månad-dag och tid.
– – stamp	Svaret eller röstens Unix-tidsstämpel.
– – phrase	Frasen som skickades in.
– – from	Webbadressen för omröstningsformuläret.
– – ip	IP-adress för enheten som skickade svaret.

voteMagicPoll

Ingen förhandsvisning

Information om POST-data:

magicID	Omröstningens ID i Examinare.
Option	Fältet heter Number i fetchMagicPollSummary. Valfritt men rekommenderat.
Text	Fritextsvar. Valfritt men rekommenderat.
GadgetID	Du kan ange GadgetID som fritext för att spåra varifrån svaret kommer. Valfritt.

Svarsdata

Funktionen returnerar Status = OK vid ett lyckat anrop och Status = Error vid fel.

Phone Surveys

listPhoneSurveys

Svarsdata

Anropet returnerar XML-behållare för flera enkäter. De innehåller bland annat surveyID, som används vid senare anrop.

Exempel på utdata

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

Visa enkäter som har publicerats som telefonenkäter och deras status.

Information om POST-data:
Funktionen behöver inga ytterligare POST-parametrar.

Fält i svarsdata

surveyID	Enkätens ID i Examinare.
surveyName	Telefonenkätens namn.
surveyTaggName	Tagg som används i Examinare.
status	– Inbound: inkommande – Outbound: utgående
callerIDs	Visas endast för Outbound. Detta callerID behöver skickas med sendPhoneSurvey. Kontakta e-postsupporten för godkännande av ytterligare callerID.
phoneNumbers	Visas endast för Inbound. Anger numret för telefonenkäten och vilket callerID som behövs för att den ska svara.
completedAnswers	Antal svar i hela enkäten.
stoppedAnswers	Antal blockerade svar i hela enkäten.
surveyLanguage	Språkkoden som används i telefonenkäten.

sendPhoneSurvey

Ingen förhandsvisning

Gör en uppringningsbegäran.

Funktionen fungerar bara när telefonenkäter är aktiverade på kontot.

Kontakta försäljning för aktivering.

Information om POST-data:

(Röda information är obligatorisk. Parameternamn i POST-data är skiftlägeskänsliga.

surveyID	Enkätens ID i Examinare.
user_*	contactID från kontaktuppgifterna. Ersätt * med ett nummer, till exempel user_1 eller user_2.
callerID	Det callerID som är aktiverat på kontot. Tillgängliga värden finns i listPhoneSurveys. Valfritt.