# Survey

## Get Equipment Configuration Survey

> Retrieve the configuration survey for a specific equipment product.

```json
{"openapi":"3.0.1","info":{"title":"Equipment Configuration Survey API","version":"2.0"},"paths":{"/api/equipment/surveys/**":{"get":{"tags":["Survey"],"summary":"Get Equipment Configuration Survey","description":"Retrieve the configuration survey for a specific equipment product.","operationId":"getSurvey","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Survey"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"Survey not found for product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}}}}}},"components":{"schemas":{"Survey":{"required":["questionAnswerGroup"],"type":"object","properties":{"questionAnswerGroup":{"$ref":"#/components/schemas/QuestionAnswerGroup"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"description":"Equipment configuration survey containing questions and answers."},"QuestionAnswerGroup":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the configuration survey question group.","format":"int32"},"questionAreas":{"type":"array","description":"List of survey section that group the related equipment configuration questions.","items":{"type":"string","description":"List of survey section that group the related equipment configuration questions."}},"questionAnswerSets":{"type":"object","additionalProperties":{"type":"array","description":"Collection of question sets that contain equipment configuration questions and available answers.","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"description":"Collection of question sets that contain equipment configuration questions and available answers."}},"description":"Contains the equipment configuration survey structure, including grouped questions and answer options."},"QuestionAnswerSet":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the equipment configuration question.","format":"int32"},"type":{"type":"string","description":"Indicates the expected input type for the question."},"isHidden":{"type":"boolean","description":"Indicates whether the question is hidden from the survey."},"sendToMerchantApp":{"type":"boolean","description":"Indicates whether the question is displayed in the merchant-facing application."},"selectedAnswer":{"type":"integer","description":"Identifies the answer selected for the question.","format":"int32"},"answers":{"type":"array","description":"List of available answer options for the equipment configuration question.","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","description":"List of dependent questions that appear when a specific answer is selected.","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"required":{"type":"boolean","description":"Indicates whether the question must be answered."},"question":{"type":"string","description":"Equipment configuration question presented in the configuration survey."},"conditionalOnAnswer":{"type":"integer","description":"Identifier of the parent answer that determines whether the question is displayed.","format":"int32"},"tags":{"type":"array","description":"List of boarding tags associated with the equipment configuration question.","items":{"$ref":"#/components/schemas/BoardingTag"}}},"description":"Collection of question sets that contain equipment configuration questions and available answers."},"QuestionAnswer":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the answer option.","format":"int32"},"selected":{"type":"boolean","description":"Indicates whether the answer option is selected."},"answer":{"type":"string","description":"Text describing the answer option returned in the survey."}},"description":"Contains the answer options for the question."},"BoardingTag":{"type":"object","properties":{"group":{"type":"string","description":"Logical group that categorizes related boarding tags for equipment configuration attributes."},"name":{"type":"string","description":"Name of the boarding tag associated with the equipment configuration attribute."}},"description":"Tags related to this question set."},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Identifier used for tracking the configuration survey request and response."},"timestamp":{"type":"string","description":"Date and time when the response was generated."}},"description":"Contains metadata related to the API response."},"ErrorResult":{"type":"object","properties":{"errorResults":{"type":"array","description":"Contains one or more error objects returned.","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Describes the reason for the error."},"resultCode":{"type":"integer","description":"Numeric code that identifies the type of error returned by the request.","format":"int32"},"timeStamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"description":"Contains one or more error objects returned."}}}}
```