POST api/v1/teamdata/teamdatas

This method posts a new team data, it creates a new question list that can then be sent to your already existing team data contacts, groups or new contacts.

Request Information

URI Parameters

None.

Body Parameters

TeamdataApi
NameDescriptionTypeAdditional information
Id

The account id.

globally unique identifier

Required

CreatedBy

The id of the person

globally unique identifier

Required

DateInsert

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

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

Name

The Name for the team data.

string

Required

Comment

The Comment for the team data.

string

Required

DateToSend

The date to send the team data. The format is the following:[YYYY-MM-DDTHH:MM:SS]. (The system will not validate if the date it's in the past).

date

Required

EndDate

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

date

Required

DateToEnd

The date to end the team data. The format is the following:[YYYY-MM-DDTHH:MM:SS]. (The system will not validate if the date it's in the past).

date

Required

Repeat

Use Yes or No to repeat the team data.

boolean

Required

RepeatTime

How many times ro repeat the team data.

string

Required

SenderName

The name of the sender.

string

Required

Occurrences

Occurences

string

Required

QuestionsList

List of the questions.

Collection of TupleOfStringAndInt32AndInt32

Required

TeamDataContacts

The contacts of the team data.

TeamDataContact

Required

TeamDataNotifications

The team data notifications.

TeamDataNotification

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "623a554e-394d-4f63-a2ef-00458f981ffa",
  "CreatedBy": "05aedb24-bf55-40e1-acaa-3f30c71b16c2",
  "DateInsert": "2024-03-28T10:05:40.4203249+00:00",
  "DateModified": "2024-03-28T10:05:40.4203249+00:00",
  "Name": "sample string 4",
  "Comment": "sample string 5",
  "DateToSend": "2024-03-28T10:05:40.4203249+00:00",
  "EndDate": "2024-03-28T10:05:40.4203249+00:00",
  "DateToEnd": "2024-03-28T10:05:40.4203249+00:00",
  "Repeat": true,
  "RepeatTime": "sample string 7",
  "SenderName": "sample string 8",
  "Occurrences": "sample string 9",
  "QuestionsList": [
    {
      "Item1": "sample string 1",
      "Item2": 2,
      "Item3": 3
    },
    {
      "Item1": "sample string 1",
      "Item2": 2,
      "Item3": 3
    }
  ],
  "TeamDataContacts": {
    "Contacts": {
      "1": {
        "NONE": 0
      },
      "2": {
        "NONE": 0
      }
    },
    "NewContacts": {
      "1": {
        "NONE": 0
      },
      "2": {
        "NONE": 0
      }
    },
    "Groups": {
      "sample string 1": {
        "NONE": 0
      },
      "sample string 2": {
        "NONE": 0
      }
    }
  },
  "TeamDataNotifications": {
    "Notification": true,
    "Sms": true,
    "Email": true,
    "ExpireSMS": true,
    "ExpireEmail": true,
    "NonRespondentsSMS": true,
    "NonRespondentsEmail": true
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

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>