GET 3/surveys/{surveyId}/questions/{questionId}?lang={lang}

Definition

GET - 3/surveys/{surveyId}/questions/{questionId}?lang={lang}

Retrieve a question from a survey by its datalabel.

This method will result in a 204 response if no question is found in this survey for the requested datalabel.

Request information

Uri parameters

Name	Description	Type	Additional information
surveyId The id of a survey. Type integer Additional info Required
surveyId	The id of a survey.	integer	Required
questionId The id or data label of a question. The datalabel can be customized and should be unique in the entire survey. The datalabel can be found in the SurveyQuestion - DataLabel property. Type string Additional info Required
questionId	The id or data label of a question. The datalabel can be customized and should be unique in the entire survey. The datalabel can be found in the SurveyQuestion - DataLabel property.	string	Required
lang The language in which you would like to retrieve the questions. If the requested language is not available we will use the default language from the survey. The available language code can be found for each survey in the Survey - Langs property. Type string Additional info Optional
lang	The language in which you would like to retrieve the questions. If the requested language is not available we will use the default language from the survey. The available language code can be found for each survey in the Survey - Langs property.	string	Optional

Response information

Response body fields

Payload containing the survey question for the requested dataLabel.

Name	Description	Type
Meta The metadata such as paging parameters, status code, timestamp,... which are related to this request. Type MetaData
Meta	The metadata such as paging parameters, status code, timestamp,... which are related to this request.	MetaData
Data The actual data returned by the request. Type SurveyQuestion
Data	The actual data returned by the request.	SurveyQuestion
Links HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic. Type Hateoas
Links	HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.	Hateoas

Sample:

{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-22T17:52:20.4621992Z",
    "IsFiltered": true
  },
  "Data": {
    "$id": "1",
    "Id": 1,
    "DataLabel": "sample string 2",
    "Language": "sample string 3",
    "QuestionTypeId": 4,
    "Caption": "sample string 5",
    "Required": true,
    "DataTypeId": 7,
    "ScaleTypeId": 64,
    "Hidden": true,
    "MinValue": 1,
    "MaxValue": 1,
    "PageNumber": 8,
    "OrderNumber": 9,
    "QuestionNumber": 10,
    "ParentQuestionId": 11,
    "UseSentimentScore": true,
    "SubQuestions": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ],
    "QuestionResponses": [
      {
        "ResponseId": 2,
        "Caption": "sample string 3",
        "Hidden": true,
        "Other": true,
        "NotApplicable": true,
        "Order": 1,
        "Value": 1.0,
        "ScaleValue": 1
      },
      {
        "ResponseId": 2,
        "Caption": "sample string 3",
        "Hidden": true,
        "Other": true,
        "NotApplicable": true,
        "Order": 1,
        "Value": 1.0,
        "ScaleValue": 1
      }
    ]
  }
}