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

This method gets the filtered data set list. The system will return the details of the filtered data set.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The teamdata id.

string

Required

filter

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfDataSet
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfListOfDataSet

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": "231b1e7f-d40b-4f83-b179-cd2999361fe5",
        "TeamDataSetID": "265b5a6d-3221-4da4-9f4f-18ab21d49ff6",
        "Name": "sample string 3",
        "StartDate": "2017-11-17T15:45:37.6279903Z",
        "EndDate": "2017-11-17T15:45:37.6279903Z",
        "DateInsert": "2017-11-17T15:45:37.6279903Z",
        "DateModified": "2017-11-17T15:45:37.6279903Z",
        "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
        }
      },
      {
        "DataSetID": "231b1e7f-d40b-4f83-b179-cd2999361fe5",
        "TeamDataSetID": "265b5a6d-3221-4da4-9f4f-18ab21d49ff6",
        "Name": "sample string 3",
        "StartDate": "2017-11-17T15:45:37.6279903Z",
        "EndDate": "2017-11-17T15:45:37.6279903Z",
        "DateInsert": "2017-11-17T15:45:37.6279903Z",
        "DateModified": "2017-11-17T15:45:37.6279903Z",
        "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:
<ResponseOfListOfDataSet 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>
      <DataSet>
        <DataSetID>231b1e7f-d40b-4f83-b179-cd2999361fe5</DataSetID>
        <TeamDataSetID>265b5a6d-3221-4da4-9f4f-18ab21d49ff6</TeamDataSetID>
        <Name>sample string 3</Name>
        <StartDate>2017-11-17T15:45:37.6279903Z</StartDate>
        <EndDate>2017-11-17T15:45:37.6279903Z</EndDate>
        <DateInsert>2017-11-17T15:45:37.6279903Z</DateInsert>
        <DateModified>2017-11-17T15:45:37.6279903Z</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>
      </DataSet>
      <DataSet>
        <DataSetID>231b1e7f-d40b-4f83-b179-cd2999361fe5</DataSetID>
        <TeamDataSetID>265b5a6d-3221-4da4-9f4f-18ab21d49ff6</TeamDataSetID>
        <Name>sample string 3</Name>
        <StartDate>2017-11-17T15:45:37.6279903Z</StartDate>
        <EndDate>2017-11-17T15:45:37.6279903Z</EndDate>
        <DateInsert>2017-11-17T15:45:37.6279903Z</DateInsert>
        <DateModified>2017-11-17T15:45:37.6279903Z</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>
      </DataSet>
    </Detail>
  </ResponseData>
</ResponseOfListOfDataSet>