HTTPS Service - Methods - GetSurveyResponsesWithReferences

GetSurveyResponsesWithReferences

This method is used to retrieve the responses to the questions on your TextSurvey.

You must supply a Start Date/Time and an End Date/Time - this will filter the report so that it contains the responses received for numbers that were enrolled between those dates and times.

You can optionally supply an Enrolment Reference. This will filter the report so that contains only responses from numbers that were enrolled using the same reference. This reference can be supplied when enrolling numbers through the TextSurvey section of our site, or through the EnrolIntoSurveyWithReference method.

» returnCSVString» Boolean
» externalLogin» String
» password» String
» surveyID » Integer
» ClientEnrolmentReference » String
» startDate » DateTime
» endDate » DateTime

On successful completion, this method will return transaction code 1.

If the survey cannot be found, this method will return transaction code 386 (Survey not found).

If the period between the startDate and endDate parameters is more than a year, this method will return transaction code 404 (Period too long).

Return Data

XML:


    <GetResponsesResponseWithReferences >
	    <Transaction >
		    <IP >123.123.123.123 </IP >
		    <Code >1 </Code >
		    <Description >Transaction OK </Description >
	    </Transaction >
	    <ResponseReport >"Batch Reference","Enrolment Reference","Number","Date of Enrolment","Answer1","Answer2","Answer3" "Batch 1","Reference 1","+44798123456","16/04/2014
        17:35:07","Response 1"," Response 2"," Response 3"
	    </ResponseReport >
    </GetResponsesResponseWithReferences >
        

CSV:


    #1# "Batch Reference","Enrolment Reference","Number","Date of Enrolment","Answer1","Answer2","Answer3" "Batch 1","Reference 1","+44798123456","16/04/2014 17:35:07","Response 1"," Response 2"," Response 3"