GET api/v1/teamdata/externalquestionsets/{teamdataId}/contacts/{contactId}/datasets/{datasetId}

This method retrieves the questions from the data set the recipient has been given access to. This method is called by the recipients only.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
teamdataId

globally unique identifier

Required

contactId

integer

Required

datasetId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.Models.TeamData.TeamDataQuestionSetModel
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.Models.TeamData.TeamDataQuestionSetModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "Disclaimer": "sample string 1",
      "LogoURL": "sample string 2",
      "TeamDataSetID": "606786b9-f90c-4ae2-a96e-e04fc2b6c483",
      "SenderName": "sample string 4",
      "DataSetID": "f000532b-c8c2-4245-b48b-63526643cad2",
      "PersonNumber": 6,
      "Name": "sample string 7",
      "YesNo": [
        {
          "Disabled": true,
          "Group": {
            "Disabled": true,
            "Name": "sample string 2"
          },
          "Selected": true,
          "Text": "sample string 3",
          "Value": "sample string 4"
        },
        {
          "Disabled": true,
          "Group": {
            "Disabled": true,
            "Name": "sample string 2"
          },
          "Selected": true,
          "Text": "sample string 3",
          "Value": "sample string 4"
        }
      ],
      "Questions": [
        {
          "Question": "sample string 1",
          "Answer": "sample string 2",
          "Type": 3,
          "QuestionID": "f9fbcd88-2ed9-4650-a608-ba8a0fe5c02f",
          "TeamDataAnswers": [
            {
              "Disabled": true,
              "Group": {
                "Disabled": true,
                "Name": "sample string 2"
              },
              "Selected": true,
              "Text": "sample string 3",
              "Value": "sample string 4"
            },
            {
              "Disabled": true,
              "Group": {
                "Disabled": true,
                "Name": "sample string 2"
              },
              "Selected": true,
              "Text": "sample string 3",
              "Value": "sample string 4"
            }
          ]
        },
        {
          "Question": "sample string 1",
          "Answer": "sample string 2",
          "Type": 3,
          "QuestionID": "f9fbcd88-2ed9-4650-a608-ba8a0fe5c02f",
          "TeamDataAnswers": [
            {
              "Disabled": true,
              "Group": {
                "Disabled": true,
                "Name": "sample string 2"
              },
              "Selected": true,
              "Text": "sample string 3",
              "Value": "sample string 4"
            },
            {
              "Disabled": true,
              "Group": {
                "Disabled": true,
                "Name": "sample string 2"
              },
              "Selected": true,
              "Text": "sample string 3",
              "Value": "sample string 4"
            }
          ]
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfTeamDataQuestionSetModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Disclaimer>sample string 1</Disclaimer>
      <LogoURL>sample string 2</LogoURL>
      <TeamDataSetID>606786b9-f90c-4ae2-a96e-e04fc2b6c483</TeamDataSetID>
      <SenderName>sample string 4</SenderName>
      <DataSetID>f000532b-c8c2-4245-b48b-63526643cad2</DataSetID>
      <PersonNumber>6</PersonNumber>
      <Name>sample string 7</Name>
      <YesNo>
        <SelectListItem>
          <Disabled>true</Disabled>
          <Group>
            <Disabled>true</Disabled>
            <Name>sample string 2</Name>
          </Group>
          <Selected>true</Selected>
          <Text>sample string 3</Text>
          <Value>sample string 4</Value>
        </SelectListItem>
        <SelectListItem>
          <Disabled>true</Disabled>
          <Group>
            <Disabled>true</Disabled>
            <Name>sample string 2</Name>
          </Group>
          <Selected>true</Selected>
          <Text>sample string 3</Text>
          <Value>sample string 4</Value>
        </SelectListItem>
      </YesNo>
      <Questions>
        <TeamDataQuestionSetAnswers>
          <Question>sample string 1</Question>
          <Answer>sample string 2</Answer>
          <Type>3</Type>
          <QuestionID>f9fbcd88-2ed9-4650-a608-ba8a0fe5c02f</QuestionID>
          <TeamDataAnswers>
            <SelectListItem>
              <Disabled>true</Disabled>
              <Group>
                <Disabled>true</Disabled>
                <Name>sample string 2</Name>
              </Group>
              <Selected>true</Selected>
              <Text>sample string 3</Text>
              <Value>sample string 4</Value>
            </SelectListItem>
            <SelectListItem>
              <Disabled>true</Disabled>
              <Group>
                <Disabled>true</Disabled>
                <Name>sample string 2</Name>
              </Group>
              <Selected>true</Selected>
              <Text>sample string 3</Text>
              <Value>sample string 4</Value>
            </SelectListItem>
          </TeamDataAnswers>
        </TeamDataQuestionSetAnswers>
        <TeamDataQuestionSetAnswers>
          <Question>sample string 1</Question>
          <Answer>sample string 2</Answer>
          <Type>3</Type>
          <QuestionID>f9fbcd88-2ed9-4650-a608-ba8a0fe5c02f</QuestionID>
          <TeamDataAnswers>
            <SelectListItem>
              <Disabled>true</Disabled>
              <Group>
                <Disabled>true</Disabled>
                <Name>sample string 2</Name>
              </Group>
              <Selected>true</Selected>
              <Text>sample string 3</Text>
              <Value>sample string 4</Value>
            </SelectListItem>
            <SelectListItem>
              <Disabled>true</Disabled>
              <Group>
                <Disabled>true</Disabled>
                <Name>sample string 2</Name>
              </Group>
              <Selected>true</Selected>
              <Text>sample string 3</Text>
              <Value>sample string 4</Value>
            </SelectListItem>
          </TeamDataAnswers>
        </TeamDataQuestionSetAnswers>
      </Questions>
    </Detail>
  </ResponseData>
</ResponseOfTeamDataQuestionSetModel>