EventSurvey Node
EventSurvey Node
This node contains event/presentation survey definitions. These nodes are contained within an EventSurveys container node. Event Surveys also contain child nodes for EventSurveyQuestions, with the EventSurveyQuestions node containing child nodes for EventSurveyAnswers.
Example:
<EventSurvey EventKey="2351" EventDescription="Surfing Tips" ExternalID="E1G1" EventSurveyKey="6994" EventSurveyTitle="Presentation Feedback" Active="1" DisplayOrder="10" ShowSurveyResults="1" DateAdded="2007-01-05 14:12:45" >
<EventSurveyQuestions>
<EventSurveyQuestion EventSurveyQuestionKey="17686" DisplayOrder="10" QuestionText="Do you like to surf?" Active="1" AllowCommentEntry="1" DateAdded="2007-01-05 14:12:45" QuestionLayout="0" AnswerFormat="0" >
<EventSurveyAnswers>
<EventSurveyAnswer EventSurveyAnswerKey="65819" Description="Yes" AnswerIndex="1" />
<EventSurveyAnswer EventSurveyAnswerKey="65820" Description="No" AnswerIndex="2" />
</EventSurveyAnswers>
</EventSurveyQuestion>
</EventSurvey>
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the call :https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50565&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&ShowKey={ShowKey}&InfoTypeFilter={filter code list, in |OPTION|OPTION| format…}
Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50565. All other parameters may appear in any sequence order.
Attribute |
Type |
Comment |
---|---|---|
EventKey |
Integer |
The Notified event key for this event survey entry. |
EventDescription |
String |
The title of the event/presentation. |
ExternalID |
String |
Event Code for this Event. |
EventSurveyKey |
Integer |
The Notified event survey key for this entry. |
EventSurveyTitle |
String |
The name of this survey. |
Active |
Flag (0/1) |
Flag indicating whether this survey is active. |
DisplayOrder |
Integer |
The value indicates the sorting preference for this survey. |
ShowSurveyResults |
Integer |
Controls the result display upon submission. 0 = Do not display results 1 = Display full results grid 2 = Display results grid with only percentages, not counts |
DateAdded |
Date |
Date and time that this survey was created. |
EventSurveyQuestions |
NODE |
Container for event survey questions entries described below. |
EventSurveyAnswer nodes:
Attribute |
Type |
Comment |
---|---|---|
EventSurveyAnswerKey |
Integer |
The Notified event survey answer key for this survey answer. |
Description |
String |
Text of the answer. |
AnswerIndex |
Integer |
Controls display sort of this answer relative to the other answers. |