examinare
Innlogging
Velg et språk
Start Examinare-konto

Examinare API - Oversikt

Kom i gang med Examinares spørreundersøkelsesverktøy API

Videoveiledning om hvordan du aktiverer Examinare API

Aktiver Examinares spørreundersøkelsesverktøy API

Rød XML-data sendes via HTTPS som POST-data, og sendes til serveren via HTTPS.
I begynnelsen av dette dokumentet er det et sammendrag av de tilgjengelige funksjonene, etterfulgt av en mer detaljert del.

URL-adressen for alle funksjoner er
https://api.examinare.com/framework
For å koble til må du legge til tre kommandoer i POST-dataene:

apiKey – Dette er gitt av Examinare i kontoen din.
apiCompany – Selskapsdatabasen som skal brukes.
Kommando – Kommandoen du oppgir for anropet.
Vennligst merk: Flere kommandoer kan være nødvendig av funksjonen du kaller.

Mobil API og ikke-delte API-nøkler.

Hvis du av en eller annen grunn ønsker å holde API-nøkkelen privat og bruke en innloggingstype av stil i stedet for den statiske Examinare API-nøkkelen, kan du bruke Mobile API-kommandoen setPhoneID, denne kommandoen kan brukes til å få en Mobile API token som kan brukes i stedet for den statiske API token.  Alle mobile API tokens kan slettes når som helst fra din Examinare konto i Innstillinger -> Avanserte innstillinger.

PHP- innpakningsbibliotek

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

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


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

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

        return $array;
    }
}
?>

PHP Wrapper bibliotek kode.

Ingen nedlastinger ELLER lange readme-filer.

Bare kopier og lim inn der du vil ha koden satt.

Hvis du velger filnavnet “examinare-api.php” så vil alle PHP kode eksempler på dette nettstedet vil fungere med nettadressene.

Ellers må du oppdatere kodens inkluderingsuttalelse øverst.Vår PHP-wrapper er tilgjengelig på GitHub. https://github.com/examinare/examinare-php-wrapper

setPhoneID (Bruk mobil API)

XML- eksempel 
<?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 opprette dine egne API-nøkler som vil bli koblet til en levende administrativ bruker i din Examinare-konto.Du må aktivere funksjonene for mobile nøkler i Konfigurasjon-fanen i din Examinare-konto.

POST- datainformasjon:
(Rød informasjon er obligatorisk), alle POST data bildetekster er store og små bokstaver.

apiCompany Firma- ID
user Brukernavn for administratorer
pass Administratorer Passord innlogget MD5- kryptering.
deviceInformation Valgfri tekst for å beskrive API-koblingsenheten.Vises i listen over API-tokens i kontoen din.

Ønsker du å bygge løsninger basert på Examinare?

Vi tilbyr en utviklerkonto som kan brukes til å lage en sandkasse eller brukes til å bygge eksterne applikasjoner for Examinare API der kundene dine kan bruke løsningen din med sin Examinare-konto.

Utviklerkontoen har alle funksjonene til en vanlig konto, på grunn av den lave prisen kan du ikke bruke disse kontoene til kommersiell bruk.

Utviklerkonto
99 dollar
  • Ubegrenset antall svar, avstemninger og mottakere
  • Publiser 1 Undersøkelse samtidig
  • Ferdiglaget malbibliotek
  • Kun e-poststøtte
  • Årlig abonnement
  • Examinare API- tilgang
  • Ikke for kommersiell bruk

Rekkefølge

Undersøkelser

clearVotes

Ingen forhåndsvisning

Tøm stemmene fra en undersøkelse. Vil slette alle stemmer i en undersøkelse, bruk med forsiktighet!

POST- datainformasjon:

(Rød Informasjon er obligatorisk, svart er valgfritt), alle POST data bildetekster er store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.

Returner data

Dette API-kall vil returnere en enkelt statusinformasjon hvis vellykket ellers en feilmelding om at undersøkelsen ikke kan bli funnet.

copySurvey

Ingen forhåndsvisning

Kopier en undersøkelse og returner informasjon om den nylig opprettede undersøkelsen.

POST- datainformasjon:

(Rød Informasjon er obligatorisk, svart er valgfritt), alle POST data bildetekster er store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
name Navn på undersøkelsen (vil bare bli vist i kontoen)

Returner data

Dette API- kallet vil returnere en enkelt XML- undersøkelsesbeholder. XML- undersøkelsesbeholderen vil inneholde informasjonen, inkludert surveyID, som vil bli brukt i dine kall til rammeverket.

(Se listSurveys for hjelp med formatering.)

fetchResults

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

Eksempel på utdata

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


Hent resultatene fra undersøkelsen uten filtrering av bakgrunnsdata.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
timestamp1 Brukes i kombinasjon med timestamp2 for å velge stemmer mellom 2 Må være i form av et UNIX- tidsstempel.
timestamp2 UNIX- tidsstempel.
allowcomments Sett denne parameteren til noe som returnerer kommentarene som er skrevet inn på undersøkelsesspørsmål.

fetchResultsByInfoReg

Eksempel på utdata

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


Hent resultatene fra undersøkelsen med transaksjons-ID.

POST- datainformasjon:

(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
timestamp1 Brukes i kombinasjon med timestamp2 for å velge stemmer mellom 2 Må være i form av et UNIX- tidsstempel.
timestamp2 UNIX- tidsstempel.
infoReg Transaksjons-ID, kan samles inn når du bruker automatisk retur med sporingskode i URL Kontakt teknisk støtte for mer informasjon.

Jokertegn slått på => Bruk * for å bruke jokertegn. Eksempel: Nisse kan være « N* e »

fetchResultsByUser

Eksempel på utdata

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


Hent resultatene fra undersøkelsen med filtrering av bakgrunnsdata.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
timestamp1 Brukes i kombinasjon med timestamp2 for å velge stemmer mellom 2 Må være i form av et UNIX- tidsstempel.
timestamp2 UNIX- tidsstempel.
contactID contactID koblet til mottakeren. (Joker aktivert)
email E- postadressen til mottakeren. (Joker er tillatt)
group Gruppenavn som tilhører mottakeren. (Joker er aktivert)
title Tittel som tilhører mottakeren. (Joker aktivert)
company Firmanavn som tilhører mottakeren. (Joker aktivert)
company-title Mottakers firmatittel. (Joker aktivert)
department Avdeling i selskapet. (Joker aktivert)
customer-group Kundegruppe. (Joker aktivert)
gender Se kundeinformasjon.
address Adresse (jokertegn tillatt)
state Tilstand (jokertegn slått på)
country Land (jokertegn tillatt)
city By (jokertegn tillatt)
postal-code Postnummer (jokertegn aktivert)

Jokertegn slått på => Bruk * for å bruke jokertegn. Eksempel: Nisse kan være N* e

getRecipientsBasedByResults

Ingen forhåndsvisning

Denne funksjonen bruker samme inndata som fetchResultsByUser og viser mottakerne som har svart basert på inndata.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
timestamp1 Brukes i kombinasjon med timestamp2 for å velge stemmer mellom 2 Må være i form av et UNIX- tidsstempel.
timestamp2 UNIX- tidsstempel.
contactID contactID koblet til mottakeren. (Joker aktivert)
email E- postadressen til mottakeren. (Joker er tillatt)
group Gruppenavn som tilhører mottakeren. (Joker er aktivert)
title Tittel som tilhører mottakeren. (Joker aktivert)
company Firmanavn som tilhører mottakeren. (Joker aktivert)
company-title Mottakers firmatittel. (Joker aktivert)
department Avdeling i selskapet. (Joker aktivert)
customer-group Kundegruppe. (Joker aktivert)
gender Se kundeinformasjon.
address Adresse (jokertegn tillatt)
state Tilstand (jokertegn slått på)
country Land (jokertegn tillatt)
city By (jokertegn tillatt)
postal-code Postnummer (jokertegn aktivert)

Jokertegn slått på => Bruk * for å bruke jokertegn. Eksempel: Nisse kan være N* e

importSurvey

Ingen forhåndsvisning

Importer Examinare-filen til kontoen din.

POST- datainformasjon:
(Rød informasjon er obligatorisk), alle POST data bildetekster er store og små bokstaver.

examinarexml Filinnholdet i Examinare Survey File (.examinare)

Vennligst merk: Vi anbefaler kun å sende en forhåndsformatert eller oversatt Examinare spørreundersøkelsesfil til systemet. 

Hvis du endrer strukturen på filen, kan det føre til feil når du bruker spørreundersøkelsen.Hvis du oversetter filen, må du sørge for å bruke oversettelsesfunksjonen i verktøyet.

listSurveys

Eksempel på utdata

XML- eksempel 
<?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- datainformasjon:
Denne funksjonen trenger ikke noen ekstra POST data.

Returner data

Dette API-kallet vil returnere en XML-beholder med flere spørreundersøkelser, som vil inneholde informasjonen, inkludert surveyID som vil bli brukt i dine anrop til rammeverket.

questionsInSurveys

Eksempel på utdata

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

Hent alle spørsmål fra en undersøkelse.

POST- datainformasjon:
(Rød informasjon er obligatorisk), alle POST data bildetekster er store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.

searchFreeText

Ingen kodeforhåndsvisning

POST- datainformasjon:
(Rød informasjon er obligatorisk), alle POST data bildetekster er store og små bokstaver.

surveyID SurveyID for undersøkelsen du vil søke i
Text Frase du vil søke etter. Jokertegn (*) er aktivert.

sendMessageEmail

PHP- eksempelkode

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

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

bruker_ * contactID fra kontaktinformasjonen. * må erstattes med tall. For eksempel user_1, user_2 osv.
delivery_message Melding som skal sendes via e-post. Maksimalt 220 tegn.
delivery_subject Emne for meldingen.
rtl Bruk RTL- koding for arabisk og hebraisk. Sett 1 for ja eller ikke sett for nei.
includelogo Bruk logo i toppbanner. Sett 1 for ja eller ikke sett for nei.

sendMessageSMS

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

Send SMS-melding til mottakere.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

bruker_ * contactID fra kontaktinformasjonen. * må erstattes med tall. For eksempel user_1, user_2 osv.
delivery_message Melding som skal sendes via SMS. Maksimalt 220 tegn.
rtl Bruk RTL- koding for arabisk og hebraisk. Sett 1 for ja eller ikke sett for nei.

Merk: Denne meldingen vil ikke ha en lenke til en undersøkelse eller avstemning.Hvis du vil legge til en lenke til en undersøkelse, bruker du API-kallet som heter «sendSurvey (SMS)».

sendSurvey (E- post)

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

Send e-postinvitasjoner til mottakere.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
bruker_ * contactID fra kontaktinformasjonen. * må erstattes med tall. For eksempel user_1, user_2 osv.
delivery_message Melding som skal sendes via e-post. Maksimalt 220 tegn.
delivery_subject Emne for meldingen.
includelogo Bruk logo i toppbanner. Sett 1 for ja eller ikke sett for nei.
schedule Planlegg denne e- posten for senere levering. Må inneholde et UNIX- tidsstempel

sendSurvey (SMS)

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

Send SMS invitasjoner til mottakere.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
bruker_ * contactID fra kontaktinformasjonen. * må erstattes med tall. For eksempel user_1, user_2 osv.
delivery_message Melding som skal sendes via SMS.
delivery_by Må være satt til SMS.
schedule Planlegg denne SMS- en for senere levering. Må inneholde et UNIX- tidsstempel

updateInstructionText

Ingen forhåndsvisning

Oppdater instruksjonsteksten med QuestionNumber i Survey.

POST- datainformasjon:
(Rød Informasjon er obligatorisk, svart er valgfritt), alle POST data bildetekster er store og små bokstaver.

surveyID SurveyID, se listSurveys for mer info
instructionText Ny instruksjonstekst for dette spørsmålet. (Bruk ||! linjeskift!|| i stedet for linjeskift)
questionNumber Spørsmålsnummer funnet i listSurveys.

Returner data

Dette API- kallet vil returnere et XML- svar med status Suksess hvis det er oppdatert, feil hvis en feil har blitt kalt. Listestruktur vil bli returnert, se questionInSurveys for mer informasjon om struktur.

updateQuestionText

Ingen forhåndsvisning

Oppdater Spørsmål Tekst med QuestionNumber i Survey.

POST- datainformasjon:
(Rød Informasjon er obligatorisk, svart er valgfritt), alle POST data bildetekster er store og små bokstaver.

surveyID SurveyID, se listSurveys for mer info
questionText Nytt spørsmål i denne undersøkelsen. (Bruk ||! linjeskift!|| i stedet for linjeskift)
questionNumber Spørsmålsnummer funnet i listSurveys.

Returner data

Dette API- kallet vil returnere et XML- svar med status Suksess hvis det er oppdatert, feil hvis en feil har blitt kalt. Listestruktur vil bli returnert, se questionInSurveys for mer informasjon om struktur.

Mottakere

addRecipient

Returner data

Dette API-kallet vil returnere et XML-svar med status Suksess hvis det er opprettet, feil hvis en feil har blitt kalt.XML-kontaktbeholderen vil inneholde informasjonen, inkludert contactID som vil bli brukt i dine anrop til rammeverket.

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

Legg til mottaker i firmadatabasen.

POST- datainformasjon:

(Rød Informasjon er obligatorisk, svart er valgfritt), alle POST data bildetekster er store og små bokstaver.

name Fornavn på mottakeren.
lastname Etternavn på mottakeren.
email E- postadressen til mottakeren.
mobile Mobiltelefonnummer. (Format 00[ Landkode][ Områdekode][ Telefonnummer]) Eksempel: 00467031234567
group Gruppenavn.
title Personlig tittel.
company Firmanavn.
company-title Firmatittel til mottakeren.
department Avdeling i selskapet.
customer-group Kundegruppe.
gender Kjønn på mottakeren. (mannlig for Mann, kvinnelig for Kvinne).
birth-year Fødselsår (YYYY), kun sifre.
birth-month Fødselsmåned (MM), bare sifre.
birth-day Fødselsdato (DD), kun sifre.
phonenumber Telefonnummer til mottakeren.
attention Adressen til mottakeren.
address Adresse til mottakeren.
city Bynavn.
state Statsnavn.
postal-code Postnummer.
country Country name
crmserial Serienummer fra integrasjonsmodul for f.eks. Zendesk billett-ID.
extrafieldkey Nøkkel fra ekstrafelt i formatet nedenfor.

delRecipient

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

Sletter en mottaker i firmadatabasen.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

contactID Kontakt-ID fra din Examinare database.

Returner data

Dette API-kall vil returnere et XML-svar med status Suksess hvis det er slettet, feil hvis en feil har blitt kalt.

listRecipientByContactID

Returner data

Dette API- kallet vil returnere en enkelt XML- kontaktbeholder. XML- kontaktbeholderen vil inneholde informasjonen inkludert contactID som vil bli brukt i dine kall til rammeverket. (Se addRecipient)

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

Liste informasjon om en enkelt mottaker ved hjelp av mottakerens contactID.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

contactID Kontakt-ID fra din Examinare database.

listRecipientByCRMSerial

Returner data

Dette API- kallet vil returnere en enkelt XML- kontaktbeholder. XML- kontaktbeholderen vil inneholde informasjonen, inkludert contactID, som vil bli brukt i dine kall til rammeverket. Merk, dette kallet kan returnere flere kontakter. (Se addRecipient)

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

Liste informasjon om en enkelt mottaker ved hjelp av CRM Serial som er opprettet i Examinare utvidelser tilgjengelig.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

crmserial Crm Serial inkludert plugin struktur. Sjekk mottaker skjermen for detaljer.

listRecipientByEmail

Returner data

Dette API- kallet vil returnere en enkelt XML- kontaktbeholder. XML- kontaktbeholderen vil inneholde informasjonen, inkludert contactID, som vil bli brukt i dine kall til rammeverket. Merk, dette kallet kan returnere flere kontakter. (Se addRecipient)

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

Vis informasjon om en enkelt mottaker ved hjelp av mottakerens e-postadresse.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

email Kontakt e-postadresse fra din Examinare database.

listRecipients

Returner data

Dette API-kallet vil returnere en XML-kontaktbeholder med flere kontakter, som inneholder informasjonen, inkludert contactID som vil bli brukt i dine anrop til rammeverket. (Se addRecipient)

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

Hent en komplett liste over alle mottakere i din Examinare database.

POST- datainformasjon:

Denne funksjonen trenger ikke noen ekstra POST data.

listRecipientsByGroup

Returner data

Dette API- kallet vil returnere en enkelt XML- kontaktbeholder. XML- kontaktbeholderen vil inneholde informasjonen inkludert contactID som vil bli brukt i dine kall til rammeverket. (Se addRecipient)

Informasjon inkludert contactID som vil bli brukt i dine anrop til rammeverket. (Se addRecipient)

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

Vis informasjon om mottakere etter gruppenavn.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

group Gruppenavn

listRecipientsExtraFields

Informasjon inkludert contactID som vil bli brukt i dine anrop til rammeverket. (Se addRecipient)

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

Mottakerprofilen kan utvides med ekstra felt, og disse sendes når du legger til, laster inn, oppdaterer mottakere.

POST- datainformasjon:

Denne funksjonen tar ikke noen POST- parametere.

Returner data

key Nøkkel brukt i mottakerdata.
caption Bildetekst av feltet fra Examinare Innstillinger.
type Type felt, (velg, tekst, avmerkingsboks)
options Alternativer når du bruker velge type felt.

listRecipientsToSurvey

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

Liste over alle mottakere lenker og status for invitasjonene som sendes fra Examinare.

Merk: Bare anonyme og private undersøkelser kan brukes med denne kommandoen.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.

listSurveysByUser

Returner data

Dette API-kallet vil returnere en XML-beholder med flere spørreundersøkelser, som vil inneholde informasjonen, inkludert surveyID som vil bli brukt i dine anrop til rammeverket.

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

Vis alle undersøkelser som er koblet til en mottaker og status.

POST- datainformasjon

(Rød Alle POST-databilder er sensitive for store og små bokstaver.

contactID Kontakt-ID fra din Examinare database.

markRecipientsToSurvey

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

Marker mottakere som invitert til en enkelt undersøkelse i Examinare statuslogg.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
bruker_ * contactID fra kontaktinformasjonen. * må erstattes med tall. For eksempel user_1, user_2 osv.

listSurveysByUser

Returner data

Dette API-kallet vil returnere en XML-beholder med flere spørreundersøkelser, som vil inneholde informasjonen, inkludert surveyID som vil bli brukt i dine anrop til rammeverket.

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

Vis alle undersøkelser som er koblet til en mottaker og status.

POST- datainformasjon

(Rød Alle POST-databilder er sensitive for store og små bokstaver.

contactID Kontakt-ID fra din Examinare database.

markRecipientsToSurvey

Ingen forhåndsvisning

Marker mottakere som invitert til en enkelt undersøkelse i Examinare statuslogg.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
bruker_ * contactID fra kontaktinformasjonen. * må erstattes med tall. For eksempel user_1, user_2 osv.

updateGenderRecipient

Returner data

Dette API- kallet vil returnere et XML- svar med statusen Suksess hvis det er oppdatert, feil hvis en feil har blitt kalt. XML- kontaktbeholderen vil inneholde informasjonen inkludert contactID som vil bli brukt i dine kall til rammeverket. (Se addRecipient)

Vær oppmerksom på at eksemplet nedenfor er for addrecipient og må justeres for å bruke oppdateringsfunksjonen.

Samplingsutdata

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

Oppdatere kjønnsinformasjonen for en enkelt mottaker.

POST- datainformasjon:

(Rød Informasjon er obligatorisk, svart er valgfritt), alle POST data bildetekster er store og små bokstaver.

contactID Kontakt-ID fra din Examinare database.
gender Kjønn på mottakeren. (mannlig for Mann, kvinnelig for Kvinne).

updateRecipient

Returner data

Dette API- kallet vil returnere et XML- svar med statusen Suksess hvis det er oppdatert, feil hvis en feil har blitt kalt. XML- kontaktbeholderen vil inneholde informasjonen, inkludert contactID, som vil bli brukt i dine kall til rammeverket. (Se addRecipient)

Vær oppmerksom på at eksemplet nedenfor er for addrecipient og må justeres for å bruke oppdateringsfunksjonen.

Samplingsutdata

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

Oppdater mottakerinformasjonen i Examinare databasen.

POST- datainformasjon:

(Rød Informasjon er obligatorisk, svart er valgfritt), alle POST data bildetekster er store og små bokstaver.

contactID Kontakt-ID fra din Examinare database.
name Fornavn på mottakeren.
lastname Etternavn på mottakeren.
email E- postadressen til mottakeren.
mobile Mobiltelefonnummer. (Format 00[ Landkode][ Områdekode][ Telefonnummer]) Eksempel: 00467031234567
group Gruppenavn.
title Personlig tittel.
company Firmanavn.
company-title Firmatittel til mottakeren.
department Avdeling i selskapet.
customer-group Kundegruppe.
gender Kjønn på mottakeren. (mannlig for Mann, kvinnelig for Kvinne).
birth-year Fødselsår (YYYY), kun sifre.
birth-month Fødselsmåned (MM), bare sifre.
birth-day Fødselsdato (DD), kun sifre.
phonenumber Telefonnummer til mottakeren.
attention Adressen til mottakeren.
address Adresse til mottakeren.
city Bynavn.
state Statsnavn.
postal-code Postnummer.
country Country name
extrafieldkey Nøkkel fra ekstrafelt.

Undersøkelsesrapportfiler

fetchReportFile

PHP- eksempel

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

Samplingsutdata

Kodeksempel 
RAW FILE CONTENT

Hent en rapport fra kontoen din med informasjonen fra fetchReportFileList.

MERK: Denne funksjonen returnerer den faktiske fila med overskrifter og IKKE en XML- struktur. Pass på at du oppgraderer din wrapper til den nyeste versjonen for å kunne bruke PHP Wrapper for denne funksjonen.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
reportID Id for rapporten fra funksjonen fetchReportFileList.

fetchReportFileList

PHP- eksempel

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

Samplingsutdata

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

Hent liste over rapporter fra undersøkelsen for å bruke med fetchReportFile funksjonen.

POST- datainformasjon:
(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.

Magic Polls

fetchMagicPollSummary

Prøveretur 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>
Eksempel retur 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- datainformasjon:
Denne funksjonen kan brukes med en valgfri POST- nøkkel kalt magicID. Når magicID er definert blir mer detaljerte resultater lagt til XML- retur.

Returner data

Dette API-anropet vil returnere en flere XML Magic Poll container hvis magicID ikke er definert (Sample return 1).

Hvis magicID er definert vil det returnere mer detaljert informasjon (Eksempel return 2).

Prøveretur 1

Eksempel på retur 1

Nøkkelinformasjon 1

 magicID Id av Magic Poll i Examinare.
magicName Spørsmålet stilt.
completedAnswers Fullførte svar i avstemningen.
Options Alternativer med resultater fra avstemningen. Hvis lagt til Alternativer. Hvis ingen alternativer dette feltet er tomt.
–       Number Identifikasjonsnummeret til Polls Option.
–       Optiontext Teksten i valgene for avstemninger
–       Result Resultatet av avstemningen Alternativet
–       Percent Prosentdelen av avstemningsalternativet sammenlignet med Sammendrag av fullførte svar.

Eksempel retur 2

Eksempel på retur 2

Nøkkelinformasjon 2

For generiske felt i denne delen, sjekk Nøkkelinformasjon 1 siden denne delen bare håndterer forskjellen mellom Nøkkelinformasjon 1 og 2.

 SMS Beholder for SMS- stemmer
–       Answer Container for individuelle SMS-svar.
–       – id Id av denne stemmen i Examinare.
–       – when Dato for avstemningen i Y-M-D tidsformat
–       – stamp Unix Tidsstempel for avstemningen
–       – phrase Frase sendt inn.
–       – from Telefonnummeret til den som sendte den inn.
 Web Beholder for webstemmer
–       Answer Beholder for individuelle webstemmer.
–       – id Id av denne stemmen i Examinare.
–       – when Dato for avstemningen i Y-M-D tidsformat
–       – stamp Unix Tidsstempel for avstemningen
–       – phrase Frase sendt inn.
–       – from URL til stemmeskjemaet.
–       – ip IP-adressen til enheten som går inn i avstemningen.

voteMagicPoll

Ingen forhåndsvisning

POST- datainformasjon:

magicID Id av Magic Poll i Examinare.
Option Kalt tall i fetchMagicPollSummary (Valgfritt, men anbefalt)
Text Gratis tekst svar. (Valgfritt, men anbefalt)
GadgetID Du kan definere GadgetID (fritekst) slik at du kan spore hvor stemmen kommer fra. (Valgfritt)

Returner data

Denne funksjonen vil returnere Status = OK på suksess og Status = Feil når en feil har oppstått.

Phone Surveys

listPhoneSurveys

Returner data

Dette API-kallet vil returnere en XML-beholder med flere spørreundersøkelser, som vil inneholde informasjonen, inkludert surveyID som vil bli brukt i dine anrop til rammeverket.

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

Liste alle undersøkelser som har blitt publisert som en telefon undersøkelse og status for dem.

POST- datainformasjon:
Denne funksjonen trenger ikke noen ekstra POST data.

Nøkkelinformasjon

surveyID Id for undersøkelsen i Examinare.
surveyName Navn på telefonundersøkelsen.
surveyTaggName Tagg som brukes i Examinare.
status – Innkommende – utgående
callerIDs Viser bare når Utgående og dette callerID må sendes med forespørselen sendPhoneSurvey. Hvis du må legge til en annen CallerID Kontakt kundestøtte for å autorisere det.
phoneNumbers Viser bare når Inbound og viser hvilket telefonnummer din telefonundersøkelse er tilgjengelig på og hva callerID du trenger å ha for det å svare.
completedAnswers Antall svar på undersøkelsen (For hele undersøkelsen).
stoppedAnswers Antall svar blokkert i undersøkelsen (For hele undersøkelsen).
surveyLanguage Kortkoden for språket som brukes i telefonundersøkelsen.

sendPhoneSurvey

Ingen forhåndsvisning

Foreta den faktiske oppringingsforespørselen.

Funksjonaliteten fungerer bare hvis du har Telefonundersøkelse aktivert på kontoen din!

Kontakt salgsavdelingen for å aktivere.

POST- datainformasjon:

(Rød Alle POST-databilder er sensitive for store og små bokstaver.

surveyID Id for undersøkelsen i Examinare.
bruker_ * contactID fra kontaktinformasjonen. * må erstattes med tall. For eksempel user_1, user_2 osv.
callerID Calleridene som er aktivert i kontoen din. Disse finner du under Callerider. listPhoneSurveys. (VALGFRI)
Dette området er registrert på wpml.org som et utviklingsområde. Bytt til en produksjonsnøkkel for remove this banner.