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

Name	Description	Type	Additional information
id	The teamdata id.	string	Required
filter		string	Required

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.TeamData.DataSet

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.TeamData.DataSet	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": "d525c7a5-60ae-4259-98be-454658b14a21",
        "TeamDataSetID": "3176636a-8a25-4089-93f0-9e69e01ae883",
        "Name": "sample string 3",
        "StartDate": "2024-11-21T09:06:14.7921835+00:00",
        "EndDate": "2024-11-21T09:06:14.7921835+00:00",
        "DateInsert": "2024-11-21T09:06:14.7921835+00:00",
        "DateModified": "2024-11-21T09:06:14.7921835+00:00",
        "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": "d525c7a5-60ae-4259-98be-454658b14a21",
        "TeamDataSetID": "3176636a-8a25-4089-93f0-9e69e01ae883",
        "Name": "sample string 3",
        "StartDate": "2024-11-21T09:06:14.7921835+00:00",
        "EndDate": "2024-11-21T09:06:14.7921835+00:00",
        "DateInsert": "2024-11-21T09:06:14.7921835+00:00",
        "DateModified": "2024-11-21T09:06:14.7921835+00:00",
        "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>d525c7a5-60ae-4259-98be-454658b14a21</DataSetID>
        <TeamDataSetID>3176636a-8a25-4089-93f0-9e69e01ae883</TeamDataSetID>
        <Name>sample string 3</Name>
        <StartDate>2024-11-21T09:06:14.7921835+00:00</StartDate>
        <EndDate>2024-11-21T09:06:14.7921835+00:00</EndDate>
        <DateInsert>2024-11-21T09:06:14.7921835+00:00</DateInsert>
        <DateModified>2024-11-21T09:06:14.7921835+00:00</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>d525c7a5-60ae-4259-98be-454658b14a21</DataSetID>
        <TeamDataSetID>3176636a-8a25-4089-93f0-9e69e01ae883</TeamDataSetID>
        <Name>sample string 3</Name>
        <StartDate>2024-11-21T09:06:14.7921835+00:00</StartDate>
        <EndDate>2024-11-21T09:06:14.7921835+00:00</EndDate>
        <DateInsert>2024-11-21T09:06:14.7921835+00:00</DateInsert>
        <DateModified>2024-11-21T09:06:14.7921835+00:00</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>