GET v1/surveys/{surveyId}/DataRetentionSettings

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor Scripter LimitedUser QuotaManager LocalDomainManager GlobalDomainManager OperationsUser SampleManager RepositoryManager DemoUser All

Permissions required to make this request: Survey.Read

Has survey type usage restrictions online

Get the data retention settings for a survey

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

 string

Required

Body Parameters

None.

Response Information

Resource Description

The configured data retention settings for the survey

Response Message

GetDataRetentionSettingsModel
NameDescriptionTypeAdditional information
RetentionPeriod

The survey data retention period in days

 integer

None.
PossibleValues

The possible survey data retention setting values in days

 Collection of integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "RetentionPeriod": 1,
  "PossibleValues": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<GetDataRetentionSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <PossibleValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PossibleValues>
  <RetentionPeriod>1</RetentionPeriod>
</GetDataRetentionSettingsModel>