PATCH v2/ResponseCodes/{responsecodeId}
User roles allowed to make this request:
DomainAdministrator
PowerUser
LocalDomainManager
GlobalDomainManager
Permissions required to make this request:
DomainResponseCode.Write
DomainResponseCode.Read
Patch the domain's response codes.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
responsecodeId |
The id of the response code to update |
integer |
Required |
Body Parameters
Url and description
DomainResponseCodeUpdateModelName | Description | Type | Additional information |
---|---|---|---|
Description |
Description of response code |
string |
None. |
Url |
Url to be redirected when the interview finishes |
string |
None. |
IsDefinite |
The response code ends the interview |
boolean |
None. |
IsSelectable |
(Only for Capi channel) The interviewer can manually assign a response code to the interview |
boolean |
None. |
AllowAppointment |
(Only for Capi channel) When true, redirects to the appointment creation page |
boolean |
None. |
ChannelCapi |
If true, the response code will be available for Capi surveys |
boolean |
None. |
ChannelCati |
If true, the response code will be available for Cati surveys |
boolean |
None. |
ChannelOnline |
If true, the response code will be available for Online surveys |
boolean |
None. |
Request Formats
application/json, text/json
{ "Description": "sample string 1", "Url": "sample string 2", "IsDefinite": true, "IsSelectable": true, "AllowAppointment": true, "ChannelCapi": true, "ChannelCati": true, "ChannelOnline": true }
application/xml, text/xml
<DomainResponseCodeUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <AllowAppointment>true</AllowAppointment> <ChannelCapi>true</ChannelCapi> <ChannelCati>true</ChannelCati> <ChannelOnline>true</ChannelOnline> <Description>sample string 1</Description> <IsDefinite>true</IsDefinite> <IsSelectable>true</IsSelectable> <Url>sample string 2</Url> </DomainResponseCodeUpdateModel>
application/x-www-form-urlencoded
Description=sample&Url=sample&IsDefinite=true&IsSelectable=true&AllowAppointment=true&ChannelCapi=true&ChannelCati=true&ChannelOnline=true
multipart/form-data
Sample not available.
Response Information
Resource Description
Response Message
HttpResponseMessageName | Description | 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. |
Response Formats
application/json, text/json
{ "Id": 1, "Description": "sample string 2", "Url": "sample string 3", "IsDefinite": true, "IsSelectable": true, "AllowAppointment": true, "ChannelCapi": true, "ChannelCati": true, "ChannelOnline": true }
application/xml, text/xml
<DomainResponseCodeResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <AllowAppointment>true</AllowAppointment> <ChannelCapi>true</ChannelCapi> <ChannelCati>true</ChannelCati> <ChannelOnline>true</ChannelOnline> <Description>sample string 2</Description> <IsDefinite>true</IsDefinite> <IsSelectable>true</IsSelectable> <Url>sample string 3</Url> <Id>1</Id> </DomainResponseCodeResponseModel>