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
| Name | Description | Type | Additional 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| Name | Description | Type | Additional 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": "fe816bfc-5efc-4916-a2b2-d6d225ab67aa",
"SenderName": "sample string 4",
"DataSetID": "c4a0f134-35e2-4d5f-bae8-efc938e49a3c",
"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": "4a94ff68-4f30-403c-ba53-6aa4d0370409",
"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": "4a94ff68-4f30-403c-ba53-6aa4d0370409",
"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>fe816bfc-5efc-4916-a2b2-d6d225ab67aa</TeamDataSetID>
<SenderName>sample string 4</SenderName>
<DataSetID>c4a0f134-35e2-4d5f-bae8-efc938e49a3c</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>4a94ff68-4f30-403c-ba53-6aa4d0370409</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>4a94ff68-4f30-403c-ba53-6aa4d0370409</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>