# Survey Welcome to the Survey API documentation for Annex Cloud! This comprehensive guide provides all the essential information and resources needed to integrate and interact with our survey platform programmatically. Our Survey API allows you to seamlessly integrate our powerful survey capabilities into your applications, websites, or systems. With this API, you can create, manage, and retrieve surveys, questions, responses, and more, empowering you to tailor survey experiences that align with your unique requirements. This documentation is designed to assist you in understanding how to leverage our API effectively, enabling you to: Create Surveys: Dynamically generate surveys with specific questions and formats to suit your needs. Retrieve Survey Data: Access survey responses and other relevant data for analysis or display. Manage Surveys and Questions: Edit, delete, or modify existing surveys and questions to maintain an up-to-date and relevant survey structure. Integrate Seamlessly: Integrate the survey capabilities seamlessly into your existing applications or platforms to collect valuable insights. The subsequent sections will guide you through the necessary steps, providing examples and explanations to facilitate a smooth integration process. ## This method is used to submit a response to questions in the survey - [POST /survey](https://annexcloud.redocly.app/loyalty/loyalty/survey/postsurvey.md): This method can be used in three different ways to submit a response to questions in the survey. Please see the information listed below to identify your use case. Note1 - Question Type - checkbox, radio button, dropdown or scale. Use the request body as listed in the example below. Question Type - textbox, text area, or image upload. The request body will include the parameters listed in the example below, with the addition of the parameter, 'answerValue', that should be included in the request following the 'answerId'. The 'answerValue' parameter will then replace the 'answerOption' parameter in the response body. Note2 - Skip Question - When the Skip option is selected as the question's response, an additional parameter called 'isSkip' with the value entered as true, will be added to the request body's question object following the 'questionId' parameter. There will be no answer object in the request. In the response body, the 'questionAnsweredDate' parameter will be removed from the question object, and the answer object will only have two parameters - 'answerId' and 'answerOption'. The 'answerStat' object will also be removed. ## Get details of all the surveys - [GET /survey/all](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveyall.md): By using this method, all surveys configured against a site ID can be retrieved. ## Get survey details by survey ID - [GET /survey/{{surveyId}}](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysueveyid.md): This method is used to get the survey information for a specific survey by passing the survey ID. ## Get survey details by user ID - [GET /survey/all/user/{{memberId}}](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveyalluseremailid.md): By passing the user ID, you can retrieve information for all surveys configured for the site and the specific member’s eligibility and completion status for each survey. ## Get survey details by survey ID and user ID - [GET /survey/{{surveyId}}/user/{{memberId}}](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysurveyiduseremailid.md): By passing the survey ID and user ID, information can be retrieved for a specific survey as well as a specific member’s eligibility and completion status for that survey. ## Get section details by section all - [GET /survey/{{surveyId}}/user/{{memberId}}/section/all](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionall.md): This method is used to fetch section information for a specific survey along with a specific member’s completion and eligibility status for the survey by passing the survey ID and user ID. ## Get section details by section ID - [GET /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionid.md): By passing the section ID along with the survey and user ID, this method is used to fetch information for a specific section of a survey along with a specific member’s completion and eligibility status for the survey. ## Get question details - Question All - [GET /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/question/all](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidquestionall.md): This method is used to fetch the question details for a specific section of a survey along with a member’s completion and eligibility status for the survey. ## Get question details by question ID - [GET /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/question/{{questionId}}](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidquestionquestionid.md): This method is used to fetch the question details for a specific question within a section of a survey along with a member’s completion and eligibility status for the survey. ## Get survey status by survey and user ID’s - [GET /survey/{{surveyId}}/user/{{memberId}}/status](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysurveyiduseremailidstatus.md): This method is used to fetch information related to a specific member’s completion of a specific survey. ## Get section's completion status - [GET /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/status](https://annexcloud.redocly.app/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidstatus.md): This method is used to fetch information related to a specific member’s completion of a section within a survey.