GET v1/ResponseCodes

User roles allowed to make this request: DomainAdministrator PowerUser LocalDomainManager GlobalDomainManager DemoUser

Permissions required to make this request: DomainResponseCode.Read

Gets all domain response codes for the domain.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Response Message

Collection of DomainResponseCodeModel

Name	Description	Type	Additional information
Id	The response code id	integer	None.
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.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Description": "sample string 2",
    "Url": "sample string 3",
    "IsDefinite": true,
    "IsSelectable": true,
    "AllowAppointment": true,
    "ChannelCapi": true,
    "ChannelCati": true,
    "ChannelOnline": true
  },
  {
    "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

Sample:

<ArrayOfDomainResponseCodeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <DomainResponseCodeModel>
    <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>
  </DomainResponseCodeModel>
  <DomainResponseCodeModel>
    <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>
  </DomainResponseCodeModel>
</ArrayOfDomainResponseCodeModel>