Examinare АПИ - преглед
Почети са Examinare анкетним алатом API
Видео упутство о томе како активирати Examinare АПИ
АПИ алат за истраживање Examinare
Црвена Поља су обавезна и морају имати вредност. XML-подаци се шаљу користећи HTTPS као POST-подаци.
На почетку овог документа налази се сажетак доступних функција. Након тога следи још један детаљнији део.
URL за све функције је
https://api.examinare.com/framework
Да бисте се повезали, морате да додате три команде у ПОСТ податке:
apiKey – Ово је обезбедио Examinare на твом рачуну.
apiCompany – База података компаније која ће се користити.
Команда – Команда коју дајете за позив.
Напомена: Више команди може бити потребно за функцију коју позивате.
Мобилни АПИ и не-дељени АПИ кључеви.
Ако из било ког разлога желите да задржите свој АПИ кључ приватним и користите тип стила Пријава уместо статичког Examinare АПИ кључа, онда можете користити Мобилен АПИ команду setPhoneID, ова команда се може користити за добијање мобилног АПИ токена који се може користити уместо статичког АПИ токена. Сви мобилни АПИ токени могу бити избрисани у сваком тренутку из вашег Examinare рачуна унутар Поставке -> Напредне поставке.
ПХП библиотека
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 омотача.
Није било никакве штампе или штампаних књига.
Само копирајте и залепите на место где желите да код буде стављен.
Ако изаберете име датотеке „examinare-api.php“ онда ће сви PHP примери кода на овом сајту радити са URL-овима.
У супротном, морате да ажурирате свој код укључујући изјаву на врху. Наша PHP облога је доступна на GitHub-у. https://github.com/examinare/examinare-php-wrapper
setPhoneID (користи мобилни АПИ)
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 подаци су осетљиви на велика и мала слова.
| apiCompany | Идентификација компаније |
| user | Корисничко име администратора |
| pass | Лозинка администратора MD5 шифровање. |
| deviceInformation | Опционални текст за описивање АПИ конектора уређаја. Појављује се на листи АПИ токена у вашем налогу. |
Да ли желите да изградите решења заснована на Examinare?
Понуђујемо развојни налог који се може користити за креирање песковника или се користи за изградњу спољних апликација за Examinare API где ваши купци могу онда користити ваше решење са својим Examinare налогом.
Развојни рачун има све функције нормалног рачуна, због своје ниске цене не можете користити ове рачуне за комерцијалну употребу.
99 долара.
- Неограничени одговори, анкете и примаоци
- Објављи 1 анкету истовремено
- Библиотека готових шаблона
- Подршка само за е- пошту
- Годишња претплата
- Examinare АПИ приступ
- Не за комерцијалну употребу
Анкета
clearVotes
Без прегледа
Очишћавање гласова из анкете. Обрисати све гласове у анкети, користи са пажњом!
Информације о подацима:
(Црвена Информација је обавезна, црна је опционална), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
Враћање података
Овај АПИ позив ће вратити једну статусну информацију ако је успешан, у супротном порука о грешки да анкета не може бити пронађена.
copySurvey
Без прегледа
Копирање анкете и враћање информација о новооснованом истраживању.
Информације о подацима:
(Црвена Информација је обавезна, црна је опционална), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| name | Име анкете (појављује се само у налогу) |
Враћање података
Овај АПИ позив ће вратити један 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 су осетљиви на велика и мала слова.
| 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 су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| timestamp1 | Користи се у комбинацији са timestamp2 за одабир гласова између 2 датума. Треба бити у облику UNIX временске ознаке. |
| timestamp2 | UNIX временски печат. |
| infoReg | Идентификација трансакције, може се прикупити када се користи аутоматски повратак са tracecode у 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 су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| timestamp1 | Користи се у комбинацији са timestamp2 за одабир гласова између 2 датума. Треба бити у облику UNIX временске ознаке. |
| timestamp2 | UNIX временски печат. |
| contactID | contactID повезивање са примаоцом. (Дијалогови омогућени) |
| Е- пошта примаоца. (Дијалекти омогућени) | |
| group | Име групе која припада примаоцу. (Дијалекти омогућени) |
| title | Назив који припада примаоцу. (Омогућени су подразумевани знаци) |
| company | Име компаније која припада примаоцу. (Дијалекти омогућени) |
| company-title | Назив компаније примаоца. (Дијалекти омогућени) |
| department | Одјељење у компанији. |
| customer-group | Група клијента. (Дијалекти омогућени) |
| gender | Погледајте информације о клијентима. |
| address | Адреса (омогућени подаци) |
| state | Статус (Дијалогови омогућени) |
| country | Држава (двокраки знаци омогућени) |
| city | Град (двокраки знаци омогућени) |
| postal-code | Поштански број (двокрака ознака омогућена) |
Омогућен џокер-знак => Користите * као џокер-знак. Пример: Nisse може бити N*e
getRecipientsBasedByResults
Без прегледа
Ова функција користи исте податке као и fetchResultsByUser и показује примаоце који су одговорили на основу података.
Информације о подацима:
(Црвена Информација је обавезна), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| timestamp1 | Користи се у комбинацији са timestamp2 за одабир гласова између 2 датума. Треба бити у облику UNIX временске ознаке. |
| timestamp2 | UNIX временски печат. |
| contactID | contactID повезивање са примаоцом. (Дијалогови омогућени) |
| Е- пошта примаоца. (Дијалекти омогућени) | |
| group | Име групе која припада примаоцу. (Дијалекти омогућени) |
| title | Назив који припада примаоцу. (Омогућени су подразумевани знаци) |
| company | Име компаније која припада примаоцу. (Дијалекти омогућени) |
| company-title | Назив компаније примаоца. (Дијалекти омогућени) |
| department | Одјељење у компанији. |
| customer-group | Група клијента. (Дијалекти омогућени) |
| gender | Погледајте информације о клијентима. |
| address | Адреса (омогућени подаци) |
| state | Статус (Дијалогови омогућени) |
| country | Држава (двокраки знаци омогућени) |
| city | Град (двокраки знаци омогућени) |
| postal-code | Поштански број (двокрака ознака омогућена) |
Омогућен џокер-знак => Користите * као џокер-знак. Пример: Nisse може бити N*e
importSurvey
Без прегледа
Увези Examinare фајл у свој налог.
Информације о подацима:
(Црвена информација је обавезна), сви 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>
Информације о подацима:
Ова функција не захтева никакве додатне ПОСТ податке.
Враћање података
Овај АПИ позив ће вратити вишеструки 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 подаци су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
searchFreeText
Без прегледа кода
Информације о подацима:
(Црвена информација је обавезна), сви 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 су осетљиви на велика и мала слова.
| корисник_ * | 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 су осетљиви на велика и мала слова.
| корисник_ * | contactID од информација о контакту. * мора бити промењен у бројеве. На пример user_1, user_2 итд. |
| delivery_message | Порука ће бити послата SMS-ом. Максимално 220 карактера. |
| rtl | Користи RTL кодирање за арапски и хебрејски. Поставити 1 за да или не поставити за не. |
Памтите: Ова порука неће имати линк на анкету или анкету. Ако желите да додате линк на анкету, користите АПИ позив под називом „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 су осетљиви на велика и мала слова.
| 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>
Пошаљи СМС позиве примаоцима.
Информације о подацима:
(Црвена Информација је обавезна), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| корисник_ * | contactID од информација о контакту. * мора бити промењен у бројеве. На пример user_1, user_2 итд. |
| delivery_message | Порука ће бити послата SMS-ом. |
| delivery_by | Мора бити постављен на SMS. |
| schedule | Закажите овај СМС за каснију испоруку. Мора да садржи UNIX временску ознаку |
updateInstructionText
Без прегледа
Ажурирај текст инструкција са QuestionNumber У истраживању.
Информације о подацима:
(Црвена Информација је обавезна, црна је опционална), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | SurveyID, види listSurveys за више информација |
| instructionText | Нови инструктивни текст за ово питање. (Применити ||!linebreak!|| уместо linebreaks) |
| questionNumber | Број питања пронађен у listSurveys. |
Враћање података
Овај АПИ позив ће вратити XML одговор са статусом Успех ако је ажуриран, грешка ако је грешка позвана. Структура листе ће бити враћена, погледајте questionInSurveys за више информација о структури.
updateQuestionText
Без прегледа
Ажурирање текста питања са QuestionNumber У истраживању.
Информације о подацима:
(Црвена Информација је обавезна, црна је опционална), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | SurveyID, види listSurveys за више информација |
| questionText | Нова питања овог истраживања. (применити ||!linebreak!|| уместо linebreaks) |
| questionNumber | Број питања пронађен у listSurveys. |
Враћање података
Овај АПИ позив ће вратити XML одговор са статусом Успех ако је ажуриран, грешка ако је грешка позвана. Структура листе ће бити враћена, погледајте questionInSurveys за више информација о структури.
Примаоци
addRecipient
Враћање података
Овај АПИ позив ће вратити 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 су осетљиви на велика и мала слова.
| name | Прво име примаоца. |
| lastname | Презиме примаоца. |
| Име примаоца. | |
| 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 | Серија из интеграционог модула за ex. 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 су осетљиви на велика и мала слова.
| contactID | Контакт ИД из базе података Examinare. |
Враћање података
Овај АПИ позив ће вратити XML одговор са статусом Успех ако је избрисано, грешка ако је грешка позвана.
listRecipientByContactID
Враћање података
Овај АПИ позив ће вратити један 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 су осетљиви на велика и мала слова.
| contactID | Контакт ИД из базе података Examinare. |
listRecipientByCRMSerial
Враћање података
Овај АПИ позив ће вратити један 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 Серијал који је креиран у Examinare екстензијама доступним.
Информације о подацима:
(Црвена Информација је обавезна), сви натписи података POST су осетљиви на велика и мала слова.
| crmserial | Crm Serial укључујући и структуру плагина. Проверите екран примаоца за детаље. |
listRecipientByEmail
Враћање података
Овај АПИ позив ће вратити један 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("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 су осетљиви на велика и мала слова.
| Адреса електронске поште за контакт из базе података Examinare. |
listRecipients
Враћање података
Овај АПИ позив ће вратити вишеструки 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 бази података.
Информације о подацима:
Ова функција не захтева никакве додатне ПОСТ податке.
listRecipientsByGroup
Враћање података
Овај АПИ позив ће вратити један XML контакт контејнер. XML контејнер за контакте ће садржати информације укључујући contactID који ће се користити у вашим позивима на оквир. (Види addRecipient)
Информације укључујући 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 су осетљиви на велика и мала слова.
| 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 параметре.
Враћање података
| 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 су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
listSurveysByUser
Враћање података
Овај АПИ позив ће вратити вишеструки 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 су осетљиви на велика и мала слова.
| 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 су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| корисник_ * | contactID од информација о контакту. * мора бити промењен у бројеве. На пример user_1, user_2 итд. |
listSurveysByUser
Враћање података
Овај АПИ позив ће вратити вишеструки 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 су осетљиви на велика и мала слова.
| contactID | Контакт ИД из базе података Examinare. |
markRecipientsToSurvey
Без прегледа
Обележавање прималаца као позваних на једно истраживање у Examinare статусном дневнику.
Информације о подацима:
(Црвена Информација је обавезна), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| корисник_ * | contactID од информација о контакту. * мора бити промењен у бројеве. На пример user_1, user_2 итд. |
updateGenderRecipient
Враћање података
Овај АПИ позив ће вратити 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 су осетљиви на велика и мала слова.
| contactID | Контакт ИД из базе података Examinare. |
| gender | Женски род је женски род, а мушки је мушки род. |
updateRecipient
Враћање података
Овај АПИ позив ће вратити 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>
Ажурирање информација о примаоцима у Examinare бази података.
Информације о подацима:
(Црвена Информација је обавезна, црна је опционална), сви натписи података POST су осетљиви на велика и мала слова.
| contactID | Контакт ИД из базе података Examinare. |
| name | Прво име примаоца. |
| lastname | Презиме примаоца. |
| Име примаоца. | |
| 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 пример
<?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 структуру. Побрините се да надоградите свој обруч на најновију верзију да бисте омогућили коришћење PHP обруч за ову функцију.
Информације о подацима:
(Црвена Информација је обавезна), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| reportID | Ид извештаја из функције fetchReportFileList. |
fetchReportFileList
PHP пример
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 су осетљиви на велика и мала слова.
| 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 кључем названим magicID. Када је magicID дефинисан, детаљнији резултати се додају у XML повратак.
Враћање података
Овај АПИ позив ће вратити вишеструки XML Magic Poll контејнер ако magicID није дефинисан (Sample return 1).
Ако је magicID дефинисан, враћаће детаљније информације (Узорак враћања 2).
Пример повратка 1
Кључне информације 1
| magicID | Ид магичне анкете у Examinare. |
| magicName | Питање је постављено. |
| completedAnswers | Одговоре је дао у виду анкете. |
| Options | Опције са резултатима из анкете. Ако су додате опције. Ако нема опција, ово поље је празно. |
| – Number | Број појединачних гласова одређује број посланичких мандата. |
| – Optiontext | Текст опције анкете |
| – Result | Резултат опције анкете |
| – Percent | Проценат опције анкете у поређењу са резимеом завршених одговора. |
Пример повратка 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 | ИП адреса уређаја који улази у гласање. |
voteMagicPoll
Без прегледа
Информације о подацима:
| magicID | Ид магичне анкете у Examinare. |
| Option | Позвани број унутар fetchMagicPollSummary (опционално али препоручљиво) |
| Text | Одговор слободног текста. (не обавезно, али препоручљиво) |
| GadgetID | Можете дефинисати GadgetID (Freetext) тако да можете пратити одакле глас долази. (не обавезно) |
Враћање података
Ова функција ће вратити статус = ОК на успеху и статус = грешка када се деси грешка.
Phone Surveys
listPhoneSurveys
Враћање података
Овај АПИ позив ће вратити вишеструки 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>
Сви ови подаци су објављени у виду извештаја о стању на терену, као и у облику извештаја о активностима.
Информације о подацима:
Ова функција не захтева никакве додатне ПОСТ податке.
Повратак информација о кључу
| surveyID | Идентификација анкете у Examinare. |
| surveyName | Име је добила по телефонском броју. |
| surveyTaggName | ознака коришћена у Examinare. |
| status | Долазак – Одлазак |
| callerIDs | Приказује само када је Одлазак и овај callerID мора бити послат са захтевом sendPhoneSurvey. Ако је потребно додати још један CallerID, контактирајте тим за подршку да га ауторизује. |
| phoneNumbers | Показује само када је улаз и показује на који телефонски број је Ваше телефонско истраживање доступно и који callerID треба да има да би одговорило. |
| completedAnswers | Број одговора на анкету (за целу анкету). |
| stoppedAnswers | Број одговора блокираних у анкети (за целу анкету). |
| surveyLanguage | Кратки код језика који се користи у телефонском истраживању. |
sendPhoneSurvey
Без прегледа
Направите стварни захтев за бирање.
Функција ради само ако имате Телефонско истраживање омогућено на свом рачуну!
Помоћу њих се врши продаја.
Информације о подацима:
(Црвена Информација је обавезна), сви натписи података POST су осетљиви на велика и мала слова.
| surveyID | Идентификација анкете у Examinare. |
| корисник_ * | contactID од информација о контакту. * мора бити промењен у бројеве. На пример user_1, user_2 итд. |
| callerID | Позивач је активиран на вашем рачуну. Ови се могу наћи у позивању listPhoneSurveys. (не обавезно) |