POST api/v1/teamdata/datasets

This method creates a dataset that will be then sent to a group list or contact list. The dataset can be set to be repeated by setting the start date and end date, by having occurrences that will allow the dataset to be sent at the time and date set.

Request Information

URI Parameters

None.

Body Parameters

DataSet
NameDescriptionTypeAdditional information
DataSetID

This is the data set id where the dataset will be added.

globally unique identifier

Required

TeamDataSetID

This is the team data set id where the dataset will be added.

globally unique identifier

Required

Name

This is the name of the new team data.

string

Required

StartDate

The date of when the dataset created will start.The format is the following:[YYYY-MM-DDTHH:MM:SSZ]. (The system will not validate if the date it's in the past).

date

Required

EndDate

The date of when the dataset created will end.The format is the following:[YYYY-MM-DDTHH:MM:SSZ]. (The system will not validate if the date it's in the past).

date

Required

DateInsert

The date of when the dataset is inserted.The format is the following:[YYYY-MM-DDTHH:MM:SSZ]. (The system will not validate if the date it's in the past).

date

Required

DateModified

The date of when the dataset is modified.The format is the following:[YYYY-MM-DDTHH:MM:SSZ]. (The system will not validate if the date it's in the past).

date

Required

Repeat

Use Yes or No to set the repeats for the dataset.

boolean

Required

RepeatTime

Times that the dataset should be repeated.

string

Required

Occurrences

Occurences

string

Required

Days

string

Required

Hours

string

Required

Minutes

string

Required

ResendLinks

Use Yes or No to resend the existing links.

boolean

Required

Enabled

Use Yes or No to enable or disable the question set DateEnd.

boolean

Required

AllowChangeStartDate

boolean

Required

NotificationSettings

Notification settings for the dataset

TeamDataNotification

Required

Request Formats

application/json, text/json

Sample:
{
  "DataSetID": "8bd42368-9d75-4849-8954-6d63e3964aee",
  "TeamDataSetID": "a0d5d48a-feab-4235-87d2-5944faad6b80",
  "Name": "sample string 3",
  "StartDate": "2017-11-17T17:18:32.2358624Z",
  "EndDate": "2017-11-17T17:18:32.2358624Z",
  "DateInsert": "2017-11-17T17:18:32.2358624Z",
  "DateModified": "2017-11-17T17:18:32.2358624Z",
  "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:
<DataSet xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DataSetID>8bd42368-9d75-4849-8954-6d63e3964aee</DataSetID>
  <TeamDataSetID>a0d5d48a-feab-4235-87d2-5944faad6b80</TeamDataSetID>
  <Name>sample string 3</Name>
  <StartDate>2017-11-17T17:18:32.2358624Z</StartDate>
  <EndDate>2017-11-17T17:18:32.2358624Z</EndDate>
  <DateInsert>2017-11-17T17:18:32.2358624Z</DateInsert>
  <DateModified>2017-11-17T17:18:32.2358624Z</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>

Response Information

Resource Description

ResponseOfSmsTransaction
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfSmsTransaction

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": {
      "MessageID": "sample string 1",
      "NoOfContacts": "sample string 2",
      "NoOfQuickRecipients": "sample string 3",
      "NoOfSMS": "sample string 4",
      "NoOfEmails": "sample string 5",
      "PreTransaction": "sample string 6",
      "PostTransaction": "sample string 7",
      "CreditsUsed": "sample string 8",
      "MessageText": "sample string 9"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfSmsTransaction 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>
      <MessageID>sample string 1</MessageID>
      <NoOfContacts>sample string 2</NoOfContacts>
      <NoOfQuickRecipients>sample string 3</NoOfQuickRecipients>
      <NoOfSMS>sample string 4</NoOfSMS>
      <NoOfEmails>sample string 5</NoOfEmails>
      <PreTransaction>sample string 6</PreTransaction>
      <PostTransaction>sample string 7</PostTransaction>
      <CreditsUsed>sample string 8</CreditsUsed>
      <MessageText>sample string 9</MessageText>
    </Detail>
  </ResponseData>
</ResponseOfSmsTransaction>