GETADITUS/Survey/Surveys/Get survey

Get survey

GET{{API_BASE_URL}}/survey/v1/surveys/:survey

This endpoint retrieves details of a specific survey identified by its ID.

Request

  • survey (string): The survey ID

Response

  • id (string): The ID of the survey.

  • name (string): The name of the survey.

  • pages (array): An array of pages within the survey, each containing:

    • id (string): The ID of the page.

    • name (string): The name of the page.

    • sort (integer): The sorting order of the page.

    • lists (array): An array of lists within the page, each containing:

      • id (string): The ID of the list.

      • name (string): The name of the list.

      • description (string): The description of the list.

      • title (string): The title of the list.

      • sort (integer): The sorting order of the list.

      • questions (array): An array of questions within the list, each containing:

        • id (string): The ID of the question.

        • type (string): The type of the question.

        • name (string): The name of the question.

        • label (string): The label of the question.

        • isRequired (boolean): Indicates if the question is required.

        • isReadOnly (boolean): Indicates if the question is read-only.

        • defaultAnswer (string): The default answer for the question.

        • attributes (array): An array of attributes for the question.

        • condition (object): The condition for the question.

        • validators (array): An array of validators for the question.

        • modifiers (array): An array of modifiers for the question.

        • sort (integer): The sorting order of the question.

        • useLookupData (boolean): Indicates if the question uses lookup data.

        • lookupDataName (string): The name of the lookup data used by the question.

        • lookupDataUrl (string): The URL for the lookup data used by the question.

        • styles (array): An array of styles for the question.

        • bindingMember (string): The binding member for the question.

      • styles (array)

Authentication#auth

This endpoint does not require authentication.

Headers#headers

Accept-Language{{LANGUAGE}}

Responses#responses

200OKGet survey