History

You may need to display your full conversation history so that your user can review how they have responded.

URL https://www.socratesinsights.com/api/conversation/history
HTTP Method(s) POST

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<conversation>
    <token>XYZ123456</token>
</conversation>
Parameters
token required. Supplied during conversation/start and relevant to the survey you are about to take.

Example Response (valid request)

<?xml version="1.0" encoding="UTF-8"?>
<conversation>
        <token>XYZ123456</token>
        <history>
            <question>
            <participant>Socrates</participant>
            <text>What is your name?</text>
        </question>
        <reply>
            <participant>Respondent</participant>
            <text>Jereme</text>
        </reply>
        <question>
            <participant>Socrates</participant>
            <text>Hey Jereme, how many philosophers can you name?</text>
        </question>
        <reply>
            <participant>Jereme</participant>
            <text>Not many, I've heard of Socrates and Aristotle</text>
        </reply>
    </history>
</conversation>

Example Response (invalid request)

<?xml version="1.0" encoding="UTF-8"?>
<conversation>
    <error>
        <message>Invalid token.</message>
    </error>
</conversation>
Parameters
token Supplied during conversation/start and relevant to the survey you are about to take.
history The full historical conversation of questions and replies.
question Conversation questions prompted by Socrates.
reply Conversation replies given by respondent.
participant Name of the participant for either Socrates or the respondent.
text The actual text that was either questioned or answered.
error > message This appears should you supply an invalid token or invalid variable name and/or variable value.