Examinare API - סקירה

התחל עם API של כלי הסקר Examinare

סרטון הדרכה על איך להפעיל את Examinare API

הפעל את API של כלי הסקר Examinare

אדום. שדות נדרשים ועליהם להיות בעלי ערך. נתוני XML נשלח באמצעות HTTPS כנתוני POST.
בתחילת המסמך הזה יש סיכום של הפונקציות הזמינות. אחרי זה מגיע חלק יותר מפורט.

הכתובת לכל הפונקציות היא
https://api.examinare.com/framework
כדי להתחבר אתה צריך להוסיף שלוש פקודות לנתוני POST:

apiKey – זה ניתן על ידי Examinare בחשבון שלך.
apiCompany – בסיס הנתונים של החברה שצריך להשתמש בה.
פקודה – הפקודה שאתה נותן לקריאה.
הערה: ייתכן שיידרשו יותר פקודות על ידי הפונקציה שאתה קורא לה.

API נייד ומפתחות API לא משותפים.

אם משום מה אתה רוצה לשמור את מפתח API שלך פרטי ולהשתמש בסגנון מסוג Login במקום במפתח API Examinare סטטי אז אתה יכול להשתמש בפקודת Mobile API setPhoneID, ניתן להשתמש בפקודה זו כדי לקבל תוסף API מוביל שניתן להשתמש בו במקום תוסף API סטטי. כל תוסף API מוביל ניתן למחוק בכל עת מהחשבון שלך Examinare בתוך ההגדרות -> הגדרות מתקדמות.

ספריית מעטפת PHP

דוגמה PHP

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

אין הורדות או קובצי readme ארוכים.

פשוט העתק והדבק במקום שבו אתה רוצה לשים את הקוד.

אם אתה בוחר את שם הקובץ "examinare-api.php" אז כל דוגמאות הקוד PHP באתר זה יעבוד עם הכתובות.

אחרת, אתה צריך לעדכן את הצהרת ה-include של הקוד שלך בחלק העליון. ה- PHP שלנו זמין ב- GitHub. https://github.com/examinare/examinare-php-wrapper

setPhoneID (השתמש ב- API נייד)

דוגמה XML

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

עם setPhoneID אתה יכול ליצור מפתחות API משל עצמך שיהיו מחוברים למשתמש מנהלי חי בחשבון Examinare שלך. אתה צריך להפעיל את הפונקציות של מפתחות ניידים בלשונית הגדרות בחשבון Examinare שלך.

מידע על נתוני POST:
(מידע אדום הוא חובה), כל כותרות הנתונים של POST רגישות לאותיות קטנות ולגדולות.

apiCompany	זיהוי החברה
user	שם המשתמש של המנהלים
pass	סיסמה של מנהל הצפנה MD5.
deviceInformation	טקסט אופציונלי לתאר את התקן החיבור של API. יופיע ברשימת סמלי API בחשבון שלך.

רוצה לבנות פתרונות המבוססים על Examinare?

אנו מציעים חשבון מפתח שניתן להשתמש בו כדי ליצור קופסת חול או להשתמש בו כדי לבנות יישומים חיצוניים עבור Examinare API שבו הלקוחות שלך יכולים אז להשתמש בפתרון שלך עם חשבון Examinare שלהם.

לחשבון המפתח יש את כל הפונקציות של חשבון רגיל, בגלל המחיר הנמוך שלו אתה לא יכול להשתמש בחשבונות אלה לשימוש מסחרי.

חשבון מפתח
99 דולר.

תשובות, סקרים ומקבלים בלתי מוגבלים
פרסם 1 סקר באותו זמן
ספריית תבניות מוכנות
תמיכה בדוא"ל בלבד
מנוי שנתי
Examinare גישה ל- API
לא לשימוש מסחרי

סדר

סקרים

clearVotes

אין תצוגה מקדימה

לנקות את ההצבעות מסקר. ימחק את כל ההצבעות בסקר, השתמש בזהירות!

מידע על נתוני POST:

(אדום. מידע הוא חובה, שחור הוא בחירה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID

הזיהוי של הסקר ב Examinare.

נתונים חזרה

קריאה זו של API תחזיר מידע על מצב יחיד אם היא מצליחה, אחרת תחזיר הודעה על שגיאה לפיה לא ניתן למצוא את הסקר.

copySurvey

אין תצוגה מקדימה

העתקת סקר והחזרת מידע של הסקר שנוצר לאחרונה.

מידע על נתוני POST:

(אדום. מידע הוא חובה, שחור הוא בחירה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
name	שם הסקר (יופיע רק בחשבון)

נתונים חזרה

קריאה זו של API תחזיר מיכל XML יחיד של סקר. מיכל הסקר XML יכיל את המידע כולל את surveyID שיהיה בשימוש בקריאות שלך למסגרת.

(ראו listSurveys לעזרה בפורמט.)

fetchResults

דוגמה PHP

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

דוגמה לפלט

דוגמה XML

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

קבל את התוצאות מהסקר ללא סינון נתונים ברקע.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
timestamp1	משמש בשילוב עם timestamp2 כדי לבחור קולות בין 2 תאריך. צריך להיות בצורת חותמת זמן של UNIX.
timestamp2	UNIX חותמת זמן.
allowcomments	הגדירו את הפרמטר הזה כדי להחזיר את ההערות שנרשמו על שאלות הסקר.

fetchResultsByInfoReg

דוגמה לפלט

דוגמה XML

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

קח את התוצאות מהסקר עם זיהוי העסקה.

מידע על נתוני POST:

(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
timestamp1	משמש בשילוב עם timestamp2 כדי לבחור קולות בין 2 תאריך. צריך להיות בצורת חותמת זמן של UNIX.
timestamp2	UNIX חותמת זמן.
infoReg	זיהוי העסקה, ניתן לאסוף כאשר משתמשים בחזרה אוטומטית עם קוד עקיבה ב- URL. צור קשר עם תמיכה טכנית לקבלת מידע נוסף.

אות שווא מופעלת => השתמש * כדי להשתמש באות שווא. דוגמה: Nisse יכול להיות "N* e"

fetchResultsByUser

דוגמה לפלט

דוגמה XML

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

קבל את התוצאות מהסקר עם סינון נתונים ברקע.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
timestamp1	משמש בשילוב עם timestamp2 כדי לבחור קולות בין 2 תאריך. צריך להיות בצורת חותמת זמן של UNIX.
timestamp2	UNIX חותמת זמן.
contactID	contactID מחובר למקבל.
email	דואר אלקטרוני שייך למקבל. (Wildcard מופעל)
group	שם קבוצה שייך למקבל. (הפעלת חריגות)
title	כותרת שמשתייכת למקבל.
company	שם החברה שמשתייכת למקבל.
company-title	כותרת החברה של המקבלים.
department	מחלקה בחברה.
customer-group	קבוצת לקוחות.
gender	ראו מידע על הלקוח.
address	כתובת (הפעלת חריגות)
state	מצב (הפעלת חריגות)
country	מדינה (אפשרות שימוש בחריץ)
city	עיר (הפעלת חריגות)
postal-code	קוד דואר (הפעלת חריגות)

אות שווא מופעלת => השתמש * כדי להשתמש באות שווא. דוגמה: Nisse יכול להיות N* e

getRecipientsBasedByResults

אין תצוגה מקדימה

פונקציה זו משתמשת באותו indata כמו fetchResultsByUser ומראה את המקבלים אשר ענו בהתבסס על in-data.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
timestamp1	משמש בשילוב עם timestamp2 כדי לבחור קולות בין 2 תאריך. צריך להיות בצורת חותמת זמן של UNIX.
timestamp2	UNIX חותמת זמן.
contactID	contactID מחובר למקבל.
email	דואר אלקטרוני שייך למקבל. (Wildcard מופעל)
group	שם קבוצה שייך למקבל. (הפעלת חריגות)
title	כותרת שמשתייכת למקבל.
company	שם החברה שמשתייכת למקבל.
company-title	כותרת החברה של המקבלים.
department	מחלקה בחברה.
customer-group	קבוצת לקוחות.
gender	ראו מידע על הלקוח.
address	כתובת (הפעלת חריגות)
state	מצב (הפעלת חריגות)
country	מדינה (אפשרות שימוש בחריץ)
city	עיר (הפעלת חריגות)
postal-code	קוד דואר (הפעלת חריגות)

אות שווא מופעלת => השתמש * כדי להשתמש באות שווא. דוגמה: Nisse יכול להיות N* e

importSurvey

אין תצוגה מקדימה

ייבוא קובץ Examinare לחשבון שלך.

מידע על נתוני POST:
(מידע אדום הוא חובה), כל כותרות הנתונים של POST רגישות לאותיות קטנות ולגדולות.

examinarexml

תוכן הקובץ Examinare מידע על הפרויקט (באנגלית)examinare)

הערה: אנו ממליצים לשלוח רק קובץ סקר של Examinare מאורגן מראש או מתורגם למערכת.

אם תשנה את מבנה הקובץ, זה עלול ליצור שגיאה בעת השימוש בסקר. אם תתרגם את הקובץ, וודאי שתשתמש בפונקציה לתרגום בתוך הכלי.

listSurveys

דוגמה לפלט

דוגמה XML

<?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:
פונקציה זו לא זקוקה לנתונים POST נוספים.

נתונים חזרה

קריאה זו של API תחזיר מיכל XML רב של סקר. מיכל XML של סקר יכיל את המידע כולל את surveyID שיהיה בשימוש בקריאות שלך למסגרת.

questionsInSurveys

דוגמה לפלט

דוגמה XML

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

קח את כל השאלות מהסקר.

מידע על נתוני POST:
(מידע אדום הוא חובה), כל כותרות הנתונים של POST רגישות לאותיות קטנות ולגדולות.

surveyID

הזיהוי של הסקר ב Examinare.

searchFreeText

אין תצוגה מקדימה של קוד

מידע על נתוני POST:
(מידע אדום הוא חובה), כל כותרות הנתונים של POST רגישות לאותיות קטנות ולגדולות.

surveyID	SurveyID של הסקר שאתה רוצה לחפש
Text	ביטוי שאתה רוצה לחפש. סימן שווא (*) מופעל.

sendMessageEmail

דוגמה לקוד PHP

דוגמה PHP

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

דוגמה לפלט

<?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:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

משתמש_ *	contactID ממידע הקשר. * צריך להחליף למספרים. לדוגמה user_1, user_2 וכו '.
delivery_message	הודעה שתישלח בדואר אלקטרוני. מקסימום 220 תווים.
delivery_subject	נושא ההודעה.
rtl	השתמש בקידוד RTL עבור ערבית ועברית. הגדירו 1 עבור כן או אל תגדירו עבור לא.
includelogo	השתמש בלוגו בדגל העליון. הגדירו 1 עבור כן או אל תגדירו עבור לא.

sendMessageSMS

דוגמה לקוד PHP

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

דוגמה לפלט

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

לשלוח הודעה SMS למקבלים.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

משתמש_ *	contactID ממידע הקשר. * צריך להחליף למספרים. לדוגמה user_1, user_2 וכו '.
delivery_message	הודעה שתישלח באמצעות SMS. מקסימום 220 תווים.
rtl	השתמש בקידוד RTL עבור ערבית ועברית. הגדירו 1 עבור כן או אל תגדירו עבור לא.

הערה: בהודעה זו לא יהיה קישור לסקר או סקר. אם אתה רוצה להוסיף קישור לסקר, השתמש בקריאת API בשם "sendSurvey (SMS)".

sendSurvey (דוא" ל)

דוגמה לקוד PHP

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

פלט הדגימה

<?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:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
משתמש_ *	contactID ממידע הקשר. * צריך להחליף למספרים. לדוגמה user_1, user_2 וכו '.
delivery_message	הודעה שתישלח בדואר אלקטרוני. מקסימום 220 תווים.
delivery_subject	נושא ההודעה.
includelogo	השתמש בלוגו בדגל העליון. הגדירו 1 עבור כן או אל תגדירו עבור לא.
schedule	תכנן את הדואר האלקטרוני הזה למשלוח מאוחר יותר. עליו להכיל חותמת זמן של UNIX

sendSurvey (SMS)

דוגמה לקוד PHP

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

פלט הדגימה

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

לשלוח הזמנות SMS למקבלים.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
משתמש_ *	contactID ממידע הקשר. * צריך להחליף למספרים. לדוגמה user_1, user_2 וכו '.
delivery_message	הודעה שתישלח באמצעות SMS.
delivery_by	חייב להיות קבוע לSMS.
schedule	תכנן את ההודעה המיידית הזו למשלוח מאוחר יותר. חייבת להיות בה חותמת זמן של UNIX

updateInstructionText

אין תצוגה מקדימה

חידוש טקסט ההוראה עם QuestionNumber בסקר.

מידע על נתוני POST:
(אדום. מידע הוא חובה, שחור הוא בחירה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	SurveyID, ראו listSurveys למידע נוסף
instructionText	כתב יד נוסף של הספר נמצא בספרייה הלאומית בירושלים.
questionNumber	מספר השאלות נמצא ב-listSurveys.

נתונים חזרה

קריאת API זו תחזיר תגובה XML עם מצבה הצלחה אם היא מעודכנת, שגיאה אם נקראת שגיאה. מבנה הרשימה יוחזר, ראו questionInSurveys עבור מידע נוסף על המבנה.

updateQuestionText

אין תצוגה מקדימה

עדכן את טקסט השאלות עם QuestionNumber בסקר.

מידע על נתוני POST:
(אדום. מידע הוא חובה, שחור הוא בחירה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	SurveyID, ראו listSurveys למידע נוסף
questionText	ראו כתבה זו באתר "הארץ" (בעברית) ראו כתבה זו באתר "הארץ" (בעברית)
questionNumber	מספר השאלות נמצא ב-listSurveys.

נתונים חזרה

מקבלים

addRecipient

נתונים חזרה

קריאה זו של API תחזיר תגובה XML עם מצבה הצלחה אם היא נוצרה, שגיאה אם נקראה שגיאה. מיכל אנשי הקשר XML יכלול את המידע כולל contactID שיהיה בשימוש בקריאות שלך למסגרת.

דוגמה לקוד PHP

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

פלט הדגימה

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

הוסף את המקבל למאגר הנתונים של החברה.

מידע על נתוני POST:

(אדום. מידע הוא חובה, שחור הוא בחירה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

name	השם הפרטי של המקבל.
lastname	שם המשפחה של המקבל.
email	דוא" ל של המקבל.
mobile	מספר טלפון סלולרי. (פורמט 00[ קוד מדינה][ קוד אזור][ מספר טלפון]) דוגמה: 00467031234567
group	שם הקבוצה.
title	תואר אישי.
company	שם החברה.
company-title	שם החברה של המקבל.
department	מחלקה בחברה.
customer-group	קבוצת לקוחות.
gender	מין המקבל. (זכר עבור זכר, נקבה עבור נקבה).
birth-year	שנת לידה (YYYY), ספרות בלבד.
birth-month	חודש לידה (MM), ספרות בלבד.
birth-day	יום לידה (DD), ספרות בלבד.
phonenumber	מספר הטלפון של המקבל.
attention	תשומת לב, כתובת המקבל.
address	כתובת המקבל.
city	שם העיר.
state	שם המדינה.
postal-code	קוד דואר.
country	שם המדינה.
crmserial	סדרה ממודול השילוב עבור לדוגמה זיהוי כרטיס Zendesk.
extrafieldkey	מפתח משדות נוספים בפורמט הבא.

delRecipient

דוגמה לקוד PHP

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

מחק את המקבל במאגר הנתונים של החברה.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

contactID

זיהוי קשר ממאגר הנתונים של Examinare שלך.

נתונים חזרה

קריאה זו של API תחזיר תגובה XML עם המצב הצלחה אם היא נמחקה, שגיאה אם נקראת שגיאה.

listRecipientByContactID

נתונים חזרה

קריאת API זו תחזיר מיכל XML יחיד של אנשי קשר. מיכל XML של אנשי קשר יכיל את המידע כולל contactID שיופעל בקריאות שלך למסגרת. addRecipient)

דוגמה לקוד PHP

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

רשימת מידע של מקבל יחיד בעזרת שם המקבל contactID.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

contactID

זיהוי קשר ממאגר הנתונים של Examinare שלך.

listRecipientByCRMSerial

נתונים חזרה

קריאת API זו תחזיר מיכל XML יחיד של אנשי קשר. מיכל XML של אנשי קשר יכיל את המידע כולל contactID שיופעל בקריאות שלך למסגרת. שימו לב, קריאה זו יכולה להחזיר מספר קשרים. (ראו addRecipient)

דוגמה לקוד PHP

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

רשימת מידע של מקבל יחיד עם עזרת CRM Serial שנוצר ב Examinare הרחבות זמינות.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

crmserial

סדרת CRM כוללת מבנה תוספת. בדוק את מסך המקבלים לפרטים.

listRecipientByEmail

נתונים חזרה

דוגמה לקוד PHP

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

רשימה מידע של מקבל יחיד באמצעות דואר אלקטרוני של המקבל.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

כתובת הדואר האלקטרוני של הקשר ממקור Examinare שלך.

listRecipients

נתונים חזרה

קריאה זו של API תחזיר מיכל XML של מספר אנשי קשר. מיכל XML של אנשי קשר יכיל את המידע כולל contactID שיופעל בקריאות שלך למסגרת. (ראו addRecipient)

דוגמה לקוד PHP

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

תביא רשימה מלאה של כל המקבלים בבסיס הנתונים של Examinare שלך.

מידע על נתוני POST:

פונקציה זו לא זקוקה לנתונים POST נוספים.

listRecipientsByGroup

נתונים חזרה

מידע כולל contactID שיופעל בקריאות שלך למסגרת. addRecipient)

דוגמה לקוד PHP

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

רשימת מידע על מקבלים לפי שם הקבוצה.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

group

שם הקבוצה

listRecipientsExtraFields

מידע כולל contactID שיופעל בקריאות שלך למסגרת. addRecipient)

דוגמה לקוד PHP

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

ניתן להרחיב את פרופיל המקבלים עם שדות נוספים, והם נשלחים כאשר מוסיפים, מטעינים, מעדכנים מקבלים.

מידע על נתוני POST:

פונקציה זו לא לוקחת פרמטרים POST.

נתונים חזרה

key	מפתח ששימש בנתונים של המקבל.
caption	כותרת השדה מההגדרות של Examinare.
type	סוג השדה, (בחירה, טקסט, רשימת בחירה)
options	אפשרויות כאשר משתמשים בסוג השדה "בחירה".

listRecipientsToSurvey

דוגמה לקוד PHP

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

דוגמה לפלט

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

רשימה של כל קישורי המקבלים ומעמד של הזמנות שנשלחו מ- Examinare.

הערה: רק סקרים אנונימיים ופרטיים ניתנים לשימוש עם הפקודה הזו.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID

הזיהוי של הסקר ב Examinare.

listSurveysByUser

נתונים חזרה

קריאה זו של API תחזיר מיכל XML רב של סקר. מיכל XML של סקר יכיל את המידע כולל את surveyID שיהיה בשימוש בקריאות שלך למסגרת.

דוגמה לקוד PHP

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

רשימה של כל הסקרים המחוברים למקבל ולמצב.

מידע על נתוני POST

(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

contactID

זיהוי קשר ממאגר הנתונים של Examinare שלך.

markRecipientsToSurvey

דוגמה לפלט

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

סימן את המקבלים כמוזמנים לסקר יחיד ביומן המצב של Examinare.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
משתמש_ *	contactID ממידע הקשר. * צריך להחליף למספרים. לדוגמה user_1, user_2 וכו '.

listSurveysByUser

נתונים חזרה

קריאה זו של API תחזיר מיכל XML רב של סקר. מיכל XML של סקר יכיל את המידע כולל את surveyID שיהיה בשימוש בקריאות שלך למסגרת.

דוגמה לקוד PHP

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

פלט הדגימה

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

רשימה של כל הסקרים המחוברים למקבל ולמצב.

מידע על נתוני POST

(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

contactID

זיהוי קשר ממאגר הנתונים של Examinare שלך.

markRecipientsToSurvey

אין תצוגה מקדימה

סימן את המקבלים כמוזמנים לסקר יחיד ביומן המצב של Examinare.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
משתמש_ *	contactID ממידע הקשר. * צריך להחליף למספרים. לדוגמה user_1, user_2 וכו '.

updateGenderRecipient

נתונים חזרה

קריאה זו של API תחזיר תגובה XML עם מצבה הצלחה אם היא מעודכנת, שגיאה אם נקראה שגיאה. מיכל אנשי הקשר XML יכיל את המידע כולל contactID שיופעל בקריאות שלך למסגרת. addRecipient)

אנא שימו לב שהדוגמה הבאה היא עבור addrecipient וצריך להוסיף אותה כדי להשתמש בפונקציה של עדכון.

פלט הדגימה

דוגמה XML

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

עדכן את המידע על המגדר עבור מקבל יחיד.

מידע על נתוני POST:

(אדום. מידע הוא חובה, שחור הוא בחירה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

contactID	זיהוי קשר ממאגר הנתונים של Examinare שלך.
gender	מין המקבל. (זכר עבור זכר, נקבה עבור נקבה).

updateRecipient

נתונים חזרה

אנא שימו לב שהדוגמה הבאה היא עבור addrecipient וצריך להוסיף אותה כדי להשתמש בפונקציה של עדכון.

פלט הדגימה

דוגמה XML

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

עדכן את המידע על המקבלים בבסיס הנתונים של Examinare.

מידע על נתוני POST:

(אדום. מידע הוא חובה, שחור הוא בחירה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

contactID	זיהוי קשר ממאגר הנתונים של Examinare שלך.
name	השם הפרטי של המקבל.
lastname	שם המשפחה של המקבל.
email	דוא" ל של המקבל.
mobile	מספר טלפון סלולרי. (פורמט 00[ קוד מדינה][ קוד אזור][ מספר טלפון]) דוגמה: 00467031234567
group	שם הקבוצה.
title	תואר אישי.
company	שם החברה.
company-title	שם החברה של המקבל.
department	מחלקה בחברה.
customer-group	קבוצת לקוחות.
gender	מין המקבל. (זכר עבור זכר, נקבה עבור נקבה).
birth-year	שנת לידה (YYYY), ספרות בלבד.
birth-month	חודש לידה (MM), ספרות בלבד.
birth-day	יום לידה (DD), ספרות בלבד.
phonenumber	מספר הטלפון של המקבל.
attention	תשומת לב, כתובת המקבל.
address	כתובת המקבל.
city	שם העיר.
state	שם המדינה.
postal-code	קוד דואר.
country	שם המדינה.
extrafieldkey	מפתח מהשדה החיצוני.

קובצי דו"ח סקר

fetchReportFile

דוגמה PHP

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

פלט הדגימה

דוגמה לקוד

RAW FILE CONTENT

קבל דו"ח מהחשבון שלך עם המידע מ- fetchReportFileList.

אנא שים לב: פונקציה זו מחזירה את הקובץ האמיתי עם כותרות ולא מבנה XML. וודאו שאתם מעדכנים את ה- wrapper שלכם לגרסה החדשה ביותר כדי להיות מסוגלים להשתמש ב- PHP Wrapper עבור פונקציה זו.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
reportID	ID של הדו"ח מהפונקציה fetchReportFileList.

fetchReportFileList

דוגמה PHP

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

פלט הדגימה

דוגמה XML

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

קבל רשימת דוחות מהסקר כדי להשתמש בהם עם הפונקציה fetchReportFile.

מידע על נתוני POST:
(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID

הזיהוי של הסקר ב Examinare.

Magic Polls

fetchMagicPollSummary

דגימה חוזרת 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>

דגימה חוזרת 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:
פונקציה זו יכולה להיות בשימוש עם מפתח POST אפשרי הנקרא magicID. כאשר magicID מוגדרת, תוצאות מפורטות יותר מווספות לחזרה XML.

נתונים חזרה

קריאה זו של API תחזיר מכשיר XML Magic Poll רב אם magicID לא מוגדר (דוגמה תחזיר 1).

אם magicID מוגדרת, היא תחזיר מידע מפורט יותר (דוגמה 2).

דגימה חוזרת 1

חזרה לדוגמה 1

מידע מפתח 1

magicID	הזיהוי של הסקר הקסום ב Examinare.
magicName	השאלה שנשאלת.
completedAnswers	התשובות הסופיות בסקר.
Options	אפשרויות עם תוצאות מהסקר. אם הוסיפו אפשרויות. אם אין אפשרויות השדה הזה ריק.
– Number	מספר זיהוי של אופציית הסקרים.
– Optiontext	טקסט של אפשרות הסקרים
– Result	התוצאה של אפשרות הסקר
– Percent	האחוז של אפשרות הסקר בהשוואה לסיכום של תשובות מושלמות.

דגימה חוזרת 2

חזרה לדוגמה 2

מידע מפתח 2

עבור שדות כלליים בחלק זה, בבקשה בדוק את מידע המפתח 1 מאחר והחלק הזה מתייחס רק להבדל בין מידע המפתח 1 ו- 2.

SMS	מיכל להצבעות SMS
– Answer	מיכל לתגובות SMS אישיות.
– – id	זיהוי ההצבעה ב-Examinare.
– – when	תאריך ההצבעה בפורמט Y- M- D זמן
– – stamp	Unix חותמת זמן של ההצבעה
– – phrase	הביטוי נשלח.
– – from	מספר הטלפון של מי ששלח את זה.
Web	מיכל להצבעות ברשת
– Answer	מיכל להצבעות אינטרנטיות פרטיות.
– – id	זיהוי ההצבעה ב-Examinare.
– – when	תאריך ההצבעה בפורמט Y- M- D זמן
– – stamp	Unix חותמת זמן של ההצבעה
– – phrase	הביטוי נשלח.
– – from	URL של טופס ההצבעה.
– – ip	כתובת ה-IP של המכשיר שנכנס להצבעה.

voteMagicPoll

אין תצוגה מקדימה

מידע על נתוני POST:

magicID	הזיהוי של הסקר הקסום ב Examinare.
Option	מספר הקריאה בתוך fetchMagicPollSummary (אפשרי אך מומלץ)
Text	תשובה בטקסט חופשי. (בחירה, אך מומלץ)
GadgetID	אתה יכול להגדיר את GadgetID (טקסט חופשי) כך שתוכל לעקוב אחר מקור ההצבעה. (אופציונלי)

נתונים חזרה

פונקציה זו תחזיר Status = OK על הצלחה ו- Status = Error כאשר התרחשה שגיאה.

Phone Surveys

listPhoneSurveys

נתונים חזרה

קריאה זו של API תחזיר מיכל XML רב של סקר. מיכל XML של סקר יכיל את המידע כולל את surveyID שיהיה בשימוש בקריאות שלך למסגרת.

פלט הדגימה

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

רשימה של כל הסקרים שפורסמו כסקר טלפוני ומצבם.

מידע על נתוני POST:
פונקציה זו לא זקוקה לנתונים POST נוספים.

מחזירה מידע על המפתח

surveyID	הזיהוי של הסקר ב Examinare.
surveyName	שם הטלפון של הסקר.
surveyTaggName	תג ששימש ב-Examinare.
status	-בתוך -חוץ
callerIDs	מראה רק כאשר יוצא וזה callerID צריך לשלוח עם הבקשה sendPhoneSurvey. אם אתה צריך להוסיף עוד CallerID צור קשר עם צוות התמיכה כדי לאשר אותו.
phoneNumbers	מראה רק כאשר נכנס ומראה באיזה מספר טלפון ניתן להגיע לסקר הטלפוני שלך ומה callerID אתה צריך שיהיה לך כדי שזה יענה.
completedAnswers	מספר התשובות בסקר (לכל הסקר כולו).
stoppedAnswers	כמות התשובות שנחסמו בסקר (לכל הסקר כולו).
surveyLanguage	הקוד הקצר של השפה שבה משתמשים בסקר הטלפוני.

sendPhoneSurvey

אין תצוגה מקדימה

תבצע את בקשת החיוג האמיתית.

פונקציונליות עובדת רק אם יש לך סקר טלפון מופעל בחשבון שלך!

התקשר למכירות כדי להפעיל.

מידע על נתוני POST:

(אדום. מידע זה חובה), כל כותרות הנתונים של POST רגישות לכותרות קטנות.

surveyID	הזיהוי של הסקר ב Examinare.
משתמש_ *	contactID ממידע הקשר. * צריך להחליף למספרים. לדוגמה user_1, user_2 וכו '.
callerID	ה- Callerids המופעלים בחשבון שלך, ניתן למצוא אותם ב- Calling listPhoneSurveys. (אופציונלי)