GET v1/Surveys/{surveyId}/Versions

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Scripter LimitedUser OperationsUser DemoUser

Permissions required to make this request: SurveyVersion.Read Survey.Read

This method retrieves a list of survey versions (etags).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

string

Required

Body Parameters

None.

Response Information

Resource Description

A list of the survey versions.

Response Message

Collection of SurveyVersionModel
NameDescriptionTypeAdditional information
ETag

The ETag

string

None.

PublishDateUtc

The date when the survey package was published

date

None.

NrOfSuccessfuls

Number of successful interviews

integer

None.

NrOfDroppedOuts

Number of dropped outs

integer

None.

NrOfScreenedOuts

Number of screened outs

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ETag": "sample string 1",
    "PublishDateUtc": "2024-05-23T09:56:46.559858+00:00",
    "NrOfSuccessfuls": 3,
    "NrOfDroppedOuts": 4,
    "NrOfScreenedOuts": 5
  },
  {
    "ETag": "sample string 1",
    "PublishDateUtc": "2024-05-23T09:56:46.559858+00:00",
    "NrOfSuccessfuls": 3,
    "NrOfDroppedOuts": 4,
    "NrOfScreenedOuts": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfSurveyVersionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyVersionModel>
    <ETag>sample string 1</ETag>
    <NrOfDroppedOuts>4</NrOfDroppedOuts>
    <NrOfScreenedOuts>5</NrOfScreenedOuts>
    <NrOfSuccessfuls>3</NrOfSuccessfuls>
    <PublishDateUtc>2024-05-23T09:56:46.559858+00:00</PublishDateUtc>
  </SurveyVersionModel>
  <SurveyVersionModel>
    <ETag>sample string 1</ETag>
    <NrOfDroppedOuts>4</NrOfDroppedOuts>
    <NrOfScreenedOuts>5</NrOfScreenedOuts>
    <NrOfSuccessfuls>3</NrOfSuccessfuls>
    <PublishDateUtc>2024-05-23T09:56:46.559858+00:00</PublishDateUtc>
  </SurveyVersionModel>
</ArrayOfSurveyVersionModel>