PATCH v1/Surveys/{surveyId}/GeneralSettings

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

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

Supports blueprint surveys

Update a survey general settings.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey general settings to update	string	Required

Body Parameters

Client, Description, Name and Owner of the survey general setting

SurveyGeneralSettingsRequestModel

Name	Description	Type	Additional information
Description	The Description of the survey	string	None.
Client	The Client of the survey	string	None.
Name	The Name of the survey	string	None.
ExcludeFromAutomaticCleanup	Indicates whether the survey will be excluded from automatic deletion and stoppage	boolean	None.
OwnerId	The user id of the new owner of the survey. It can be set empty to remove the active owner	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Description": "sample string 1",
  "Client": "sample string 2",
  "Name": "sample string 3",
  "ExcludeFromAutomaticCleanup": true,
  "OwnerId": "sample string 4"
}

application/xml, text/xml

Sample:

<SurveyGeneralSettingsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyGeneralSettings">
  <Client>sample string 2</Client>
  <Description>sample string 1</Description>
  <ExcludeFromAutomaticCleanup>true</ExcludeFromAutomaticCleanup>
  <Name>sample string 3</Name>
  <OwnerId>sample string 4</OwnerId>
</SurveyGeneralSettingsRequestModel>

application/x-www-form-urlencoded

Sample:

Description=sample&Client=sample&Name=sample&ExcludeFromAutomaticCleanup=true&OwnerId=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The updated survey general setting

Response Message

SurveyGeneralSettingsResponseModel

Name	Description	Type	Additional information
Description	The Description of the survey	string	None.
Client	The Client of the survey	string	None.
Name	The Name of the survey	string	None.
ExcludeFromAutomaticCleanup	Indicates whether the survey will be excluded from automatic deletion and stoppage	boolean	None.
Owner	The user id of the new owner of the survey	User	None.

Response Formats

application/json, text/json

Sample:

{
  "Description": "sample string 1",
  "Client": "sample string 2",
  "Name": "sample string 3",
  "ExcludeFromAutomaticCleanup": true,
  "Owner": {
    "Id": "sample string 1",
    "UserName": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<SurveyGeneralSettingsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyGeneralSettings">
  <Client>sample string 2</Client>
  <Description>sample string 1</Description>
  <ExcludeFromAutomaticCleanup>true</ExcludeFromAutomaticCleanup>
  <Name>sample string 3</Name>
  <Owner>
    <Id>sample string 1</Id>
    <UserName>sample string 2</UserName>
  </Owner>
</SurveyGeneralSettingsResponseModel>