1. v3
  2. Surveys
  3. POST - 3/surveys/{surveyid}/launch

Definition

POST - 3/surveys/{surveyId}/launch

Early access feature - Launch a survey.

Required roles: Survey (write)

Request information

surveyId

The id of a survey.


Type integer
Additional info
Required

Survey launch object to launch the survey.

StartDate

Date the survey will start/has started.


Type date
Additional info

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

Sample: 
{
  "StartDate": "2024-11-21T12:07:00.4321219Z",
  "EndDate": "2024-11-21T12:07:00.4321219Z"
}
Sample: 
<LaunchSurvey xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <StartDate>2024-11-21T12:07:00.4321219+00:00</StartDate>
  <EndDate>2024-11-21T12:07:00.4321219+00:00</EndDate>
</LaunchSurvey>

Response information

Returns status message if the launch was successful or not.


Meta

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


Type MetaData
Data

The actual data returned by the request.


Type 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.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-11-21T12:07:00.4321219Z",
    "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"
      }
    ]
  }
}
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 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-11-21T12:07:00.4321219+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>