PATCH v1/Surveys/{surveyId}/ResponseCodes/{responseCode}

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

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

Update a response code with the specified fields.

Request Information

URI Parameters

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

Body Parameters

Supply SurveyResponseCode object with only the properties and values you would like to update. Only the Description and RelocationUrl properties can be supplied for system response codes (codes below 200).

SurveyResponseCodeModelForPatch

Name	Description	Type	Additional information
Description	Description of ResponseCode	string	None.
IsDefinite	Determines if the Response code is a definitive or not (IsFinal - true or false)	boolean	None.
IsSelectable	Determines if response code is visible on dropdown list for Capi Client	boolean	None.
AllowAppointment	Determines if the Response code is meant for an appointment or not (IsIntermediate - true or false)	boolean	None.
RelocationUrl	Relocation url of the response code	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Description": "new description",
  "IsDefinite": false,
  "IsSelectable": false,
  "AllowAppointment": false
}

application/xml, text/xml

Sample:

<SurveyResponseCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Description>new description</Description>
  <IsDefinite>false</IsDefinite>
  <IsSelectable>false</IsSelectable>
  <AllowAppointment>false</AllowAppointment>
</SurveyResponseCode>

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 response codes

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.