clearVotes



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


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


[CodeSample]

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


[CodeSample file="fetchresults"]

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


[CodeSample file="fetchresults"]

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


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


[CodeSample]

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


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


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


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


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


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)


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)


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


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


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.