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

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.TeamData.DataSet
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.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": "28205634-64c2-4843-bcc5-f0bc222d59db",
      "TeamDataSetID": "3b66a211-6f1d-47b1-9c85-7d99761970d7",
      "Name": "sample string 3",
      "StartDate": "2018-12-17T03:42:00.6069206+00:00",
      "EndDate": "2018-12-17T03:42:00.6069206+00:00",
      "DateInsert": "2018-12-17T03:42:00.6069206+00:00",
      "DateModified": "2018-12-17T03:42:00.6069206+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:
<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>28205634-64c2-4843-bcc5-f0bc222d59db</DataSetID>
      <TeamDataSetID>3b66a211-6f1d-47b1-9c85-7d99761970d7</TeamDataSetID>
      <Name>sample string 3</Name>
      <StartDate>2018-12-17T03:42:00.6069206+00:00</StartDate>
      <EndDate>2018-12-17T03:42:00.6069206+00:00</EndDate>
      <DateInsert>2018-12-17T03:42:00.6069206+00:00</DateInsert>
      <DateModified>2018-12-17T03:42:00.6069206+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>
    </Detail>
  </ResponseData>
</ResponseOfDataSet>