Definition

POST - 3/Surveys?copyOfSurveyId={copyOfSurveyId}

Create a new trial survey. Upgrading the survey to a paid survey can be done in our Tool.

Request information

NameDescriptionTypeAdditional information
copyOfSurveyId

The id of the original survey if you would like to copy an existing survey.

integer

Optional

The settings for the new survey.

NameDescriptionTypeAdditional information
SurveyTitles

The survey titles.

Collection of SurveyTitle

Required

DefaultLang

Default 2-letter ISO 639-1 language code. The default language for the survey will be used when retrieving questions without passing the lang parameter.

string

Required, Max length: 2

ClientRef

Your internal reference. The reference will also appear on the invoice next to the project name of your survey.

string

Max length: 80

SurveyFolderId

The id of the survey folder in which the survey is located.

integer

Sample:
{
  "SurveyTitles": [
    {
      "Lang": "sample string 1",
      "Title": "sample string 2"
    },
    {
      "Lang": "sample string 1",
      "Title": "sample string 2"
    }
  ],
  "DefaultLang": "sample string 1",
  "ClientRef": "sample string 2",
  "SurveyFolderId": 1
}
Sample:
<NewSurvey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <ClientRef>sample string 2</ClientRef>
  <DefaultLang>sample string 1</DefaultLang>
  <SurveyFolderId>1</SurveyFolderId>
  <SurveyTitles>
    <SurveyTitle>
      <Lang>sample string 1</Lang>
      <Title>sample string 2</Title>
    </SurveyTitle>
    <SurveyTitle>
      <Lang>sample string 1</Lang>
      <Title>sample string 2</Title>
    </SurveyTitle>
  </SurveyTitles>
</NewSurvey>

Response information


NameDescriptionTypeAdditional information
Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.

MetaData

Data

The actual data returned by the request.

SurveyCreateResult

Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.

Hateoas

Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-03-19T02:59:03.4965594Z",
    "IsFiltered": true
  },
  "Data": {
    "SurveyId": 1,
    "Succeeded": true,
    "FailureMessage": "sample string 11"
  }
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <FailureMessage>sample string 11</FailureMessage>
    <Succeeded>true</Succeeded>
    <SurveyId>1</SurveyId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-03-19T02:59:03.4965594+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>