Textlocal Logo

API Documentation

Get Survey Details

This command will get a number of details about a given survey.

Resource URL

https://api.textlocal.in/get_survey_details/

Sample Request

Select Language
PHP 
  1. <?php
  2. 	// Account details
  3. 	$apiKey = urlencode('Your apiKey');
  4.  
  5. 	// Survey details
  6. 	$survey_id = 123456;
  7.  
  8. 	// Prepare data for POST request
  9. 	$data = array('apikey' => $apiKey, 'survey_id' => $survey_id);
  10.  
  11. 	// Send the POST request with cURL
  12. 	$ch = curl_init('https://api.textlocal.in/get_survey_details/');
  13. 	curl_setopt($ch, CURLOPT_POST, true);
  14. 	curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
  15. 	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  16. 	$response = curl_exec($ch);
  17. 	curl_close($ch);
  18. 	
  19. 	// Process your response here
  20. 	echo $response;
  21. ?>
  1. <?php
  2. 	// Account details
  3. 	$apiKey = urlencode('Your apiKey');
  4. 	
  5. 	// Survey details
  6. 	$survey_id = '123456';
  7.  
  8. 	// Prepare data for POST request
  9. 	$data = 'apikey=' . $apiKey . '&survey_id=' . $survey_id;
  10.  
  11. 	// Send the GET request with cURL
  12. 	$ch = curl_init('https://api.textlocal.in/get_survey_details/?' . $data);
  13. 	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  14. 	$response = curl_exec($ch);
  15. 	curl_close($ch);
  16. 	
  17. 	// Process your response here
  18. 	echo $response;
  19. ?>
  1. <?php
  2. 	require('Textlocal.class.php');
  3.  
  4. 	$Textlocal = new Textlocal(false, false, 'your apiKey');
  5. 	
  6. 	$survey_id = 18;
  7. 	$start_date = '2013-08-03 00:00:00';
  8. 	$end_date = '2013-08-04 00:00:00';
  9. 	
  10. 	$response = $Textlocal->getSurveyDetails($survey_id);
  11. 	print_r($response);
  12. ?>

Parameters

survey_id The ID of the survey found in get_surveys.
Login Parameters (Additional Information)
apiKey You can create these in your Messenger Control Panel (click here) for each application, and limit the usage of them by host IP Address.

Sample Response

  1. {
  2. 	"survey_details":[{
  3. 		"id":"1234",
  4. 		"title":"My Survey",
  5. 		"description":"An amazing customer survey",
  6. 		"published":"y",
  7. 		"hex":"ABC123",
  8. 		"startDatetime":"1970-01-01 00:00:00",
  9. 		"endDatetime":"2100-01-01 00:00:00"
  10. 	}],
  11. 	"status":"success"
  12. }
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <response>
  3. 	<survey_details>
  4. 		<survey_detail>
  5. 			<id>1234</id>
  6. 			<title>My Survey</title>
  7. 			<description>An amazing customer survey</description>
  8. 			<published>y</published>
  9. 			<hex>ABC123</hex>
  10. 			<startDatetime>1970-01-01 00:00:00</startDatetime>
  11. 			<endDatetime>2100-01-01 00:00:00</endDatetime>
  12. 		</survey_detail>
  13. 	</survey_details>
  14. 	<status>success</status>
  15. </response>

Errors

Error Codes
49 Invalid survey ID.
58 No survey ID specified.