GET api/v1/teamdata/datasets/{id}

This method retrieves all the details of a dataset, the dataset id is required.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The dataset Id.

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfDataSet
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfDataSet

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": {
      "DataSetID": "33b048ee-845b-45bb-88a8-49b348e493cd",
      "TeamDataSetID": "ca940e00-0ad4-4c54-a9c1-af9ebf4ff51e",
      "Name": "sample string 3",
      "StartDate": "2017-11-17T17:20:02.9738712Z",
      "EndDate": "2017-11-17T17:20:02.9738712Z",
      "DateInsert": "2017-11-17T17:20:02.9738712Z",
      "DateModified": "2017-11-17T17:20:02.9738712Z",
      "Repeat": true,
      "RepeatTime": "sample string 6",
      "Occurrences": "sample string 7",
      "Days": "sample string 8",
      "Hours": "sample string 9",
      "Minutes": "sample string 10",
      "ResendLinks": true,
      "Enabled": true,
      "AllowChangeStartDate": true,
      "NotificationSettings": {
        "Notification": true,
        "Sms": true,
        "Email": true,
        "ExpireSMS": true,
        "ExpireEmail": true,
        "NonRespondentsSMS": true,
        "NonRespondentsEmail": true
      }
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfDataSet 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>
      <DataSetID>33b048ee-845b-45bb-88a8-49b348e493cd</DataSetID>
      <TeamDataSetID>ca940e00-0ad4-4c54-a9c1-af9ebf4ff51e</TeamDataSetID>
      <Name>sample string 3</Name>
      <StartDate>2017-11-17T17:20:02.9738712Z</StartDate>
      <EndDate>2017-11-17T17:20:02.9738712Z</EndDate>
      <DateInsert>2017-11-17T17:20:02.9738712Z</DateInsert>
      <DateModified>2017-11-17T17:20:02.9738712Z</DateModified>
      <Repeat>true</Repeat>
      <RepeatTime>sample string 6</RepeatTime>
      <Occurrences>sample string 7</Occurrences>
      <Days>sample string 8</Days>
      <Hours>sample string 9</Hours>
      <Minutes>sample string 10</Minutes>
      <ResendLinks>true</ResendLinks>
      <Enabled>true</Enabled>
      <AllowChangeStartDate>true</AllowChangeStartDate>
      <NotificationSettings>
        <Notification>true</Notification>
        <Sms>true</Sms>
        <Email>true</Email>
        <ExpireSMS>true</ExpireSMS>
        <ExpireEmail>true</ExpireEmail>
        <NonRespondentsSMS>true</NonRespondentsSMS>
        <NonRespondentsEmail>true</NonRespondentsEmail>
      </NotificationSettings>
    </Detail>
  </ResponseData>
</ResponseOfDataSet>