clearVotes

No Preview

Clear the votes from a survey. Will delete all votes in a survey, use with caution!

POST data information:

(Red information is mandatory, black is optional), all POST data captions are case-sensitive.

surveyID

Id of the Survey in Examinare.

Return data

This API call will return a single status information if successful otherwise an error message that the survey can not be found.

copySurvey

No Preview

Copy a Survey and return information of the newly created Survey.

POST data information:

(Red information is mandatory, black is optional), all POST data captions are case-sensitive.

surveyID	Id of the Survey in Examinare.
name	Name of the Survey (Will only be shown in Account)

Return data

This API call will return a single XML survey container. XML survey container will contain the information including the surveyID that will be used in your calls to the framework.

(See listSurveys for formating help.)

fetchResults

PHP Example

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

Example Output

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

Fetch the results from the Survey without background data filtering.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

surveyID	Id of the Survey in Examinare.
timestamp1	Used in combination with timestamp2 to select votes between 2 dates. Needs to be in form of UNIX timestamp.
timestamp2	UNIX timestamp.
allowcomments	Set this parameter to anything return the comments entered on surveys questions.

fetchResultsByInfoReg

Example Output

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

Fetch the results from the Survey with transaction ID.

POST data information:

(Red information is mandatory), all POST data captions are case-sensitive.

surveyID	Id of the Survey in Examinare.
timestamp1	Used in combination with timestamp2 to select votes between 2 dates. Needs to be in form of UNIX timestamp.
timestamp2	UNIX timestamp.
infoReg	Transaction ID, can be collected when using automatical return with tracecode in URL. Contact tech support for more information.

Wildcard enabled => Apply * to use Wildcard. Example : Nisse can be “N*e”

fetchResultsByUser

Example Output

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

Fetch the results from the Survey with background data filtering.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

surveyID	Id of the Survey in Examinare.
timestamp1	Used in combination with timestamp2 to select votes between 2 dates. Needs to be in form of UNIX timestamp.
timestamp2	UNIX timestamp.
contactID	contactID connected to the recipient. (Wildcard enabled)
email	Email belonging to the recipient. (Wildcard enabled)
group	Group name belonging to the recipient. (Wildcard enabled)
title	Title belonging to the recipient. (Wildcard enabled)
company	Company name belonging to the recipient. (Wildcard enabled)
company-title	Recipients company title. (Wildcard enabled)
department	Department in the company. (Wildcard enabled)
customer-group	Customer group. (Wildcard enabled)
gender	Se customer information.
address	Address (Wildcard enabled)
state	State (Wildcard enabled)
country	Country (Wildcard enabled)
city	City (Wildcard enabled)
postal-code	Postal code (Wildcard enabled)

Wildcard enabled => Apply * to use Wildcard. Example : Nisse can be N*e

getRecipientsBasedByResults

No Preview

This function uses the same indata as the fetchResultsByUser and shows the recipients that has answered based on in-data.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

surveyID	Id of the Survey in Examinare.
timestamp1	Used in combination with timestamp2 to select votes between 2 dates. Needs to be in form of UNIX timestamp.
timestamp2	UNIX timestamp.
contactID	contactID connected to the recipient. (Wildcard enabled)
email	Email belonging to the recipient. (Wildcard enabled)
group	Group name belonging to the recipient. (Wildcard enabled)
title	Title belonging to the recipient. (Wildcard enabled)
company	Company name belonging to the recipient. (Wildcard enabled)
company-title	Recipients company title. (Wildcard enabled)
department	Department in the company. (Wildcard enabled)
customer-group	Customer group. (Wildcard enabled)
gender	Se customer information.
address	Address (Wildcard enabled)
state	State (Wildcard enabled)
country	Country (Wildcard enabled)
city	City (Wildcard enabled)
postal-code	Postal code (Wildcard enabled)

Wildcard enabled => Apply * to use Wildcard. Example : Nisse can be N*e

importSurvey

No Preview

Import Examinare file into your account.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

examinarexml

Filecontent of the Examinare Survey File (.examinare)

Please note: We only recommend sending a preformatted or translated Examinare Survey File to the system.

If you change the structure of the file it can create an error while using the survey. If you translate the file, make sure to use the translation function inside the tool.

listSurveys

Example Output

<?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 data information:
This function do not need any extra POST data.

Return data

This API call will return a multiple XML survey container. XML survey container will contain the information including the surveyID that will be used in your calls to the framework.

questionsInSurveys

Example Output

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

Fetch all questions from a Survey.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

surveyID

Id of the Survey in Examinare.

searchFreeText

No Code Preview

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

surveyID	SurveyID of the Survey you want to search
Text	Phrase you want to search for. Wildcard (*) enabled.

sendMessageEmail

PHP Example Code

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

Example Output

<?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 data information:
(Red information is mandatory), all POST data captions are case-sensitive.

user_*	contactID from the contact information. * needs to be changed into numbers. For example user_1, user_2 etc.
delivery_message	Message to be sent by Email. Maximum 220 characters.
delivery_subject	Subject of the message.
rtl	Use RTL encoding for Arabic and Hebrew. Set 1 for yes or do not set for no.
includelogo	Use logo in the top banner. Set 1 for yes or do not set for no.

sendMessageSMS

PHP Example Code

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

Example Output

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

Send SMS message to recipients.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

user_*	contactID from the contact information. * needs to be changed into numbers. For example user_1, user_2 etc.
delivery_message	Message to be sent by SMS. Maximum 220 characters.
rtl	Use RTL encoding for Arabic and Hebrew. Set 1 for yes or do not set for no.

Observe: This message will not have a link to a Survey or Poll. If you want to add a link to a Survey the use the API Call named "sendSurvey (SMS)".

sendSurvey (Email)

PHP Code Example

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

Sample Output

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

Send email invitations to recipients.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

surveyID	Id of the Survey in Examinare.
user_*	contactID from the contact information. * needs to be changed into numbers. For example user_1, user_2 etc.
delivery_message	Message to be sent by Email. Maximum 220 characters.
delivery_subject	Subject of the message.
includelogo	Use logo in the top banner. Set 1 for yes or do not set for no.
schedule	Scheduale this E-mail to later. Must contain a UNIX Timestamp

sendSurvey (SMS)

PHP Code Example

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

Sample Output

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

Send SMS invitations to recipients.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.

surveyID	Id of the Survey in Examinare.
user_*	contactID from the contact information. * needs to be changed into numbers. For example user_1, user_2 etc.
delivery_message	Message to be sent by SMS.
delivery_by	Must be set to SMS.
schedule	Schedule this SMS to later. Must contain a UNIX Timestamp

updateInstructionText

No Preview

Update the Instructional Text with QuestionNumber in Survey.

POST data information:
(Red information is mandatory, black is optional), all POST data captions are case-sensitive.

surveyID	SurveyID, see listSurveys for more info
instructionText	New Instructional Text for this Question. (Apply \|\|!linebreak!\|\| instead of linebreaks)
questionNumber	Question Number found in listSurveys.

Return data

This API call will return a XML response with status Success if it is updated, error if an error has been called. List structure of will be returned, see questionInSurveys for more information of structure.

updateQuestionText

No Preview

Update the Questions Text with QuestionNumber in Survey.

POST data information:
(Red information is mandatory, black is optional), all POST data captions are case-sensitive.

surveyID	SurveyID, see listSurveys for more info
questionText	New Question of this Survey. (Apply \|\|!linebreak!\|\| instead of linebreaks)
questionNumber	Question Number found in listSurveys.

Return data

This API call will return a XML response with status Success if it is updated, error if an error has been called. List structure of will be returned, see questionInSurveys for more information of structure.