addRecipient


Return data

This API call will return a XML response with status Success if it is created, error if an error has been called. The XML contacts container will contain the information including the contactID that will be used in your calls to the framework.

 [CodeSample file="addrecipient"]

Add recipient to the company database.


POST data information:

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

name First name of the recipient.
lastname Last name of the recipient.
email Email of the recipient.
mobile Cell-phone number. (Format 00[Countrycode][Area code][Phone number])Example : +467031234567
group Group name.
title Personal title.
company Company name.
company-title Company title of the recipient.
department Department in Company.
customer-group Customer group.
gender Gender of the recipient. (male for Male, female for Female).
birth-year Year of birth (YYYY), digits only.
birth-month Month of birth (MM), digits only.
birth-day Day of birth (DD), digits only.
phonenumber Phone number of the recipient.
attention Attention address of the recipient.
address Address of the recipient.
city City name.
state State name.
postal-code Postal code.
country Country name.
crmserial Serial from integration module for ex. Zendesk ticket ID.
extrafieldkey Key from extrafields in the format below.

delRecipient


 [CodeSample file="delrecipient"]

Deletes a recipient in the company database.


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

contactID Contact ID from your Examinare database.

Return data

This API call will return a XML response with status Success if it is deleted, error if an error has been called.

listRecipientByContactID


Return data

This API call will return a single XML contacts container. XML contacts container will contain the information including the contactID that will be used in your calls to the framework. (See addRecipient)

 [CodeSample]

List information of a single recipient with help of the recipients contactID.


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

contactID Contact ID from your Examinare database.

listRecipientByCRMSerial


Return data

This API call will return a single XML contacts container. XML contacts container will contain the information including the contactID that will be used in your calls to the framework. Observe, this call can return multiple contacts. (See addRecipient)

[CodeSample]

List information of a single recipient with help of the CRM Serial that is created in the Examinare extensions available.


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

crmserial Crm Serial including plugin structure. Check the Recipient Screen for details.

listRecipientByEmail


Return data

This API call will return a single XML contacts container. XML contacts container will contain the information including the contactID that will be used in your calls to the framework. Observe, this call can return multiple contacts. (See addRecipient)

[CodeSample]

List information of a single recipient with help of the recipients Email.


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

email Contact E-mail Address from your Examinare database.

listRecipients


Return data

This API call will return a multiple XML contacts container. XML contacts container will contain the information including the contactID that will be used in your calls to the framework. (See addRecipient)

[CodeSample]

Fetch a complete list of all the Recipients in your Examinare database.


POST data information:

This function do not need any extra POST data.

listRecipientsByGroup


Return data

This API call will return a single XML contacts container. XML contacts container will contain the information including the contactID that will be used in your calls to the framework. (See addRecipient)

[CodeSample]

List information of recipients by Groupname.


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

group Group Name

listRecipientsExtraFields


[CodeSample]

Recipients profile can be extended with Extra Fields and these are sent when adding, loading, updating Recipients.


POST data information:

This function do not take any POST parameters.

Return data

key Key used in recipient data.
caption Caption of the field from Examinare Settings.
type Type of field, (select, text, checkbox)
options Options when using the select type of field.

listRecipientsToSurvey


[CodeSample]

List all recipients links and status of the invitations being sent from Examinare.


Please note: Only anonymous and private surveys can be used with this command.

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

surveyID Id of the Survey in Examinare.

listSurveysByUser


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.

[CodeSample]

List all Surveys connected to a recipient and status.


POST data information

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

contactID Contact ID from your Examinare database.

markRecipientsToSurvey


[CodeSample]

Mark recipients as invited to a single Survey in Examinare status log.

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.

listSurveysByUser


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.

[CodeSample]

List all Surveys connected to a recipient and status.


POST data information

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

contactID Contact ID from your Examinare database.

markRecipientsToSurvey


[CodeSample]

Mark recipients as invited to a single Survey in Examinare status log.


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.

updateGenderRecipient


Return data

This API call will return a XML response with status Success if it is updated, error if an error has been called. The XML contacts container will contain the information including the contactID that will be used in your calls to the framework. (See addRecipient)

Please note that example below is for addrecipient and needs to be adjusted to use the update function.

[CodeSample file="addrecipient"]

Update the gender information for a single recipient.


POST data information:

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

contactID Contact ID from your Examinare database.
gender Gender of the recipient. (male for Male, female for Female).

updateRecipient


Return data

This API call will return a XML response with status Success if it is updated, error if an error has been called. The XML contacts container will contain the information including the contactID that will be used in your calls to the framework. (See addRecipient)

Please note that example below is for addrecipient and needs to be adjusted to use the update function.

[CodeSample file="addrecipient"]

Update the recipients information in Examinare database.


POST data information:

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

contactID Contact ID from your Examinare database.
name First name of the recipient.
lastname Last name of the recipient.
email Email of the recipient.
mobile Cell-phone number. (Format 00[Countrycode][Area code][Phone number])Example : +467031234567
group Group name.
title Personal title.
company Company name.
company-title Company title of the recipient.
department Department in Company.
customer-group Customer group.
gender Gender of the recipient. (male for Male, female for Female).
birth-year Year of birth (YYYY), digits only.
birth-month Month of birth (MM), digits only.
birth-day Day of birth (DD), digits only.
phonenumber Phone number of the recipient.
attention Attention address of the recipient.
address Address of the recipient.
city City name.
state State name.
postal-code Postal code.
country Country name.
extrafieldkey Key from extrafields in the format explained here.