PATCH v1/Surveys/{surveyId}

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 with the specified fields.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey that is updated.	string	Required

Body Parameters

Supply Survey object with only the properties and values you would like to update. Some properties might not be allowed. At least allowed: SurveyName, ClientName, Description, InterviewerInstruction

SurveyUpodateModel

Name	Description	Type	Additional information
ClientName	Gets or sets the name of the client, e.g. Coca Cola.	string	Max length: 50
Description	The description of the survey	string	Max length: 4096
InterviewerInstruction	The default interviewer instruction of a survey	string	Max length: 2147483647
SurveyName	The name of the survey	string	Max length: 50

Request Formats

application/json, text/json

Sample:

{
  "SurveyName": "SurveyName",
  "Description": "Description",
  "ClientName": "ClientName",
  "InterviewerInstruction": "InterviewerInstruction"
}

application/xml, text/xml

Sample:

<Survey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyName>SurveyName</SurveyName>
  <Description>new description</Description>
  <ClientName>ClientName</ClientName>
  <InterviewerInstruction>InterviewerInstruction</InterviewerInstruction>
</Survey>

application/x-www-form-urlencoded

Sample:

No sample available

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The updated details of the survey

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.