Early access feature
- Launch a survey.
Name | Description | Type | Additional information |
---|---|---|---|
surveyId
The id of a survey.
Type
integer
Additional info
Required
|
|||
surveyId |
The id of a survey. |
integer |
Required |
Survey launch object to launch the survey.
Name | Description | Type | Additional information |
---|---|---|---|
StartDate
Date the survey will start/has started.
Type
date
Additional info
Date should be UTC datetime ISO 8601 format |
|||
StartDate |
Date the survey will start/has started. |
date |
Date should be UTC datetime ISO 8601 format |
EndDate
Date the survey will end/has ended.
Type
date
Additional info
Date should be UTC datetime ISO 8601 format |
|||
EndDate |
Date the survey will end/has ended. |
date |
Date should be UTC datetime ISO 8601 format |
{ "StartDate": "2024-09-07T23:48:04.7156439Z", "EndDate": "2024-09-07T23:48:04.7156439Z" }
<LaunchSurvey xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <StartDate>2024-09-07T23:48:04.7156439+00:00</StartDate> <EndDate>2024-09-07T23:48:04.7156439+00:00</EndDate> </LaunchSurvey>
Returns status message if the launch was successful or not.
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. |
SurveyLaunchValidationResult | |
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-09-07T23:48:04.7313821Z", "IsFiltered": true }, "Data": { "Succeeded": true, "FailureMessage": "sample string 2", "ValidationErrors": [ { "PropertyName": "sample string 1", "PropertyValue": "sample string 2", "ValidationMessage": "sample string 3" }, { "PropertyName": "sample string 1", "PropertyValue": "sample string 2", "ValidationMessage": "sample string 3" } ] } }
<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 2</FailureMessage> <Succeeded>true</Succeeded> <ValidationErrors> <ValidationErrors> <PropertyName>sample string 1</PropertyName> <PropertyValue>sample string 2</PropertyValue> <ValidationMessage>sample string 3</ValidationMessage> </ValidationErrors> <ValidationErrors> <PropertyName>sample string 1</PropertyName> <PropertyValue>sample string 2</PropertyValue> <ValidationMessage>sample string 3</ValidationMessage> </ValidationErrors> </ValidationErrors> </Data> <Meta> <IsFiltered>true</IsFiltered> <Limit>1</Limit> <Offset>1</Offset> <StartRec>1</StartRec> <Status>1</Status> <StopRec>1</StopRec> <Timestamp>2024-09-07T23:48:04.7313821+00:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>