Examinare API 概要

Examinare 調査ツール API を使い始める

Examinare API のアクティベーション方法についてのビデオチュートリアル

Examinare 調査ツール API を有効にします

レッド XMLデータは HTTPS を使って POST データとして送信されます。
この文書の始めには、利用可能な機能の概要があります。その後に、より詳細な部分があります。

すべての関数のURLは
https://api.examinare.com/framework
接続するには、POSTデータに3つのコマンドを追加する必要があります。

apiKey – Examinare があなたのアカウントに提供します。
apiCompany – 使用する会社データベース。
コマンド – コールのために提供するコマンド。
注意: 呼び出す関数によっては、より多くのコマンドが必要になるかもしれません。

モバイルAPIと非共有APIキー。

何らかの理由で API キーをプライベートに保持し、静的なスタイルの代わりにログインタイプのスタイルを使用したい場合は、 Examinare API キーを入力すると、Mobile API コマンドを使用できます。 setPhoneIDすべてのモバイル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コード例は、urlを使って動作します。

これらのコマンドを実行するには、次のコマンドを実行する必要があります。 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 を使うと、Examinare アカウントの管理ユーザに接続される API キーを作成できます。Examinare アカウントの設定タブで Mobile Keys 機能を有効にする必要があります。

POST データ情報:
すべてのPOSTデータキャプションは大文字と小文字を区別する。

apiCompany	会社ID
user	ユーザ名
pass	管理者パスワード MD5暗号.
deviceInformation	API コネクタデバイスを説明するオプションのテキストです。あなたのアカウントの API トークンリストに表示されます。

Examinare に基づいたソリューションを作成しますか？

開発者アカウントは，サンドボックスを作成したり，Examinare APIのための外部アプリケーションを作成したり，お客様がそのExaminareアカウントでソリューションを使用できるようにするのに使用できる。

開発者アカウントは通常のアカウントのすべての機能を持つが、価格が安いため、商業的な利用には利用できない。

開発者アカウント
99 米ドル

無制限の回答、投票、受信者
1 つの調査を同時に公開
テンプレートライブラリ
メールサポートのみ
年間購読
Examinare APIアクセス
商用利用不可

順序

調査

clearVotes

プレビューなし

調査から投票を削除する。調査の全投票を削除します。注意して使用してください。

POST データ情報:

(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID

Examinare のアンケート ID。

返信データ

この API 呼び出しは、成功した場合、単一の状態情報を返します。それ以外の場合、調査が見つかりません。

copySurvey

プレビューなし

調査をコピーし、新しく作成した調査の情報を返します。

POST データ情報:

(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	Examinare のアンケート ID。
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 のアンケート ID。
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>

サーベイの結果をトランザクション ID で取得します。

POST データ情報:

(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	Examinare のアンケート ID。
timestamp1	timestamp2 と組み合わせて、2 つの日付の間の投票を選択します。UNIX タイムスタンプの形式でなければなりません。
timestamp2	UNIX タイムスタンプ
infoReg	URL にトレースコードを含む自動返信を使用するときに収集されるトランザクション ID です。詳細については技術サポートに問い合わせてください。

ワイルドカードを有効にする => ワイルドカードを使用するには * を適用します。例: 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 のアンケート ID。
timestamp1	timestamp2 と組み合わせて、2 つの日付の間の投票を選択します。UNIX タイムスタンプの形式でなければなりません。
timestamp2	UNIX タイムスタンプ
contactID	contactID 受信者に接続しました (ワイルドカード有効)
email	受信者のメールアドレス (ワイルドカードを有効に)
group	受信者に属するグループ名 (ワイルドカードを有効にします)
title	受信者に属するタイトル (ワイルドカード有効)
company	受信者に属する会社名 (ワイルドカード有効)
company-title	受信者の会社名 (ワイルドカード有効)
department	会社の部門 (ワイルドカードを有効に)
customer-group	顧客グループ (ワイルドカード有効)
gender	顧客情報を参照してください。
address	アドレス (ワイルドカード有効)
state	状態 (ワイルドカード有効)
country	国 (ワイルドカード有効)
city	都市 (ワイルドカード有効)
postal-code	郵便番号 (ワイルドカード有効)

ワイルドカードを有効にするには * を適用します。例: Nisse は N*e になります。

getRecipientsBasedByResults

プレビューなし

この関数は fetchResultsByUser と同じ入力データを使用し、入力データに基づいて回答した受信者を表示します。

POST データ情報:
(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	Examinare のアンケート ID。
timestamp1	timestamp2 と組み合わせて、2 つの日付の間の投票を選択します。UNIX タイムスタンプの形式でなければなりません。
timestamp2	UNIX タイムスタンプ
contactID	contactID 受信者に接続しました (ワイルドカード有効)
email	受信者のメールアドレス (ワイルドカードを有効に)
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 のアンケート ID。

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 を、ノーの場合は設定しないでください。

このメッセージには調査や投票へのリンクはありません。調査へのリンクを追加するには、 sendSurvey (SMS) という API コールを使用してください。

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 のアンケート ID。
ユーザ_*	連絡先情報から 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 のアンケート ID。
ユーザ_*	連絡先情報から contactID を取得します。 * は数字に変更する必要があります。例えば user_1, user_2 など。
delivery_message	SMS で送信するメッセージ。
delivery_by	SMS に設定してください。
schedule	この SMS を後で送信するようにスケジュールします。UNIX タイムスタンプを含む必要があります。

updateInstructionText

プレビューなし

指示テキストを更新 QuestionNumber サーベイで

POST データ情報:
(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	SurveyID。詳しくは listSurveys を参照してください。
instructionText	この問題の新しい指示テキスト (行切りの代わりに \|\|!linebreak!\|\|を適用)
questionNumber	listSurveys で見つかった質問番号

返信データ

このAPIコールは、更新された場合は成功、エラーが呼び出された場合はエラーの状態で XML 応答を返します。リスト構造が返されます。構造の詳細については questionInSurveys を参照してください。

updateQuestionText

プレビューなし

質問テキストを更新 QuestionNumber サーベイで

POST データ情報:
(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	SurveyID。詳しくは listSurveys を参照してください。
questionText	この調査の新しい質問です。 (線引きの代わりに \|\|!linebreak!\|\|を適用)
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 チケット ID の統合モジュールからのシリアル
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 データベースからの連絡先IDです。

返信データ

この 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 データベースからの連絡先IDです。

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

単一の受信者の情報を，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 のアンケート ID。

listSurveysByUser

返信データ

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 データベースからの連絡先IDです。

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 のアンケート ID。
ユーザ_*	連絡先情報から contactID を取得します。 * は数字に変更する必要があります。例えば user_1, user_2 など。

listSurveysByUser

返信データ

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 データベースからの連絡先IDです。

markRecipientsToSurvey

プレビューなし

Examinare のステータスログで受信者を単一の調査に招待された者としてマークします。

POST データ情報:
(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	Examinare のアンケート ID。
ユーザ_*	連絡先情報から contactID を取得します。 * は数字に変更する必要があります。例えば user_1, user_2 など。

updateGenderRecipient

返信データ

この API 呼び出しは、更新された場合は成功、エラーが呼び出された場合はエラーの状態で XML 応答を返します。XML 連絡先コンテナは、フレームワークへの呼び出しで使用される contactID を含む情報を含みます。(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 データベースからの連絡先IDです。
gender	受信者の性別（男性は男性、女性は女性）。

updateRecipient

返信データ

このAPIコールは、更新された場合は成功、エラーが呼び出された場合はエラーの状態で XML 応答を返します。XML 連絡先コンテナは、フレームワークへの呼び出しに使用される contactID を含む情報を含みます。 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 データベースからの連絡先IDです。
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 の情報を使って、あなたのアカウントからレポートを取得します。

PHP Wrapper は XML 構造ではなく、ヘッダを含む実際のファイルを返します。この関数に PHP Wrapper を使用するには、wrapper を最新のバージョンにアップグレードしてください。

POST データ情報:
(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	Examinare のアンケート ID。
reportID	関数 fetchReportFileList からのレポートの id です。

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 関数で使用する Survey からのレポートのリストを取得します。

POST データ情報:
(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID

Examinare のアンケート ID。

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 データ情報:
この関数は magicID と呼ばれるオプションの POST キーで使用できます。 magicID を定義すると、より詳細な結果が XML 返信に追加されます。

返信データ

magicID が定義されていない場合、この API コールは複数の XML Magic Poll コンテナを返します。 1).

magicID を定義すると、より詳細な情報を返します。 2).

サンプル返し 1

例の返し 1

キー情報 1

magicID	マジックポールの ID Examinare.
magicName	質問をした。
completedAnswers	投票で完了した回答。
Options	投票の結果を表示するオプションです。オプションが追加されている場合、このフィールドは空です。
– Number	ポーリングオプションの識別番号。
– Optiontext	投票オプションのテキスト
– Result	ポールオプションの結果
– Percent	投票オプションの割合を表示します。

サンプル返し 2

サンプル返し 2

キー情報 2

このセクションの一般フィールドについては、キー情報を確認してください。 1 このパートはキー情報とキー情報との違いだけを扱うので 1 そして 2.

SMS	SMS 投票用コンテナ
– Answer	個々の SMS 応答のためのコンテナ。
– – id	Examinare におけるこの投票の ID
– – when	投票日時 Y-M-D 時間形式
– – stamp	Unix 投票のタイムスタンプ
– – phrase	フレーズを送信しました。
– – from	送信者の電話番号
Web	Web投票用コンテナ
– Answer	個々のウェブ投票のためのコンテナ。
– – id	Examinare におけるこの投票の ID
– – when	投票日時 Y-M-D 時間形式
– – stamp	Unix 投票のタイムスタンプ
– – phrase	フレーズを送信しました。
– – from	投票フォームの URL。
– – ip	投票に参加するデバイスの ip アドレス。

voteMagicPoll

プレビューなし

POST データ情報:

magicID	マジックポールの ID Examinare.
Option	fetchMagicPollSummary 内の呼び出し番号 (オプションですが推奨)
Text	自由テキスト応答 (オプションですが推奨)
GadgetID	GadgetID (自由なテキスト) を定義することで、投票がどこから来ているのかを追跡できます。 (オプション)

返信データ

この関数は、成功時に Status = OK、エラーが発生した場合に Status = Error を返します。

Phone Surveys

listPhoneSurveys

返信データ

サンプル出力

<?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 のアンケート ID。
surveyName	電話調査の名称。
surveyTaggName	Examinare で使用されたタグ。
status	インバウンド・アウトバウンド
callerIDs	Outbound と this のときのみ表示 callerID 請求書と一緒に送らなければなりません sendPhoneSurvey. もう一つ追加する必要があれば CallerID サポートチームに連絡して許可を取ってください
phoneNumbers	電話調査が入力されたときのみ表示し、電話調査の電話番号を表示します。 callerID 答えるために必要なものです
completedAnswers	調査の回答数（調査全体）
stoppedAnswers	調査でブロックされた回答の数（調査全体に対して）。
surveyLanguage	電話調査で使用される言語の短いコード。

sendPhoneSurvey

プレビューなし

実際のダイヤル要求を行います。

この機能は、あなたのアカウントで電話調査を有効にした場合にのみ機能します。

営業部門に連絡して有効にします。

POST データ情報:

(レッドすべてのPOSTデータキャプションは大文字と小文字を区別します

surveyID	Examinare のアンケート ID。
ユーザ_*	連絡先情報から contactID を取得します。 * は数字に変更する必要があります。例えば user_1, user_2 など。
callerID	アカウントで有効になっている callerid。listPhoneSurveys を呼び出すと確認できます。（任意）