Create a new survey.
Name | Description | Type | Additional information |
---|---|---|---|
copyOfSurveyId
The id of the original survey if you would like to copy an existing survey.
Type
integer
Additional info
Optional
|
|||
copyOfSurveyId |
The id of the original survey if you would like to copy an existing survey. |
integer |
Optional |
The settings for the new survey.
Name | Description | Type | Additional information |
---|---|---|---|
SurveyTitles |
The survey titles. |
Collection of SurveyTitle |
Required |
MaintainNotificationState
Maintains the notifications status from the original survey.
Type
boolean
|
|||
MaintainNotificationState |
Maintains the notifications status from the original survey. |
boolean | |
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.
Type
string
Additional info
Required, Max length: 2
|
|||
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.
Type
string
Additional info
Max length: 80
|
|||
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.
Type
integer
|
|||
SurveyFolderId |
The id of the survey folder in which the survey is located. |
integer |
{ "SurveyTitles": [ { "Lang": "sample string 1", "Title": "sample string 2" }, { "Lang": "sample string 1", "Title": "sample string 2" } ], "MaintainNotificationState": true, "DefaultLang": "sample string 2", "ClientRef": "sample string 3", "SurveyFolderId": 1 }
<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 3</ClientRef> <DefaultLang>sample string 2</DefaultLang> <SurveyFolderId>1</SurveyFolderId> <MaintainNotificationState>true</MaintainNotificationState> <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>
Name | Description | Type | Additional information |
---|---|---|---|
Meta
The metadata such as paging parameters, status code, timestamp,... which are related to this request.
Type
MetaData
|
|||
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 |
{ "Meta": { "Status": 1, "TotalRowCount": 1, "Limit": 1, "Offset": 1, "TotalPageCount": 1, "StartRec": 1, "StopRec": 1, "Timestamp": "2024-10-14T09:05:35.5436615Z", "IsFiltered": true }, "Data": { "SurveyId": 1, "Succeeded": true, "FailureMessage": "sample string 11" } }
<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>2024-10-14T09:05:35.5436615+00:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>