GET v1/Surveys/{surveyId}/ResponseCodes

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor LimitedUser QuotaManager OperationsUser SampleManager DemoUser

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

Supports survey simulations

This method retrieves a list of response codes based on a survey. This list can be filtered and sorted using standard OData syntax.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of responses for the survey

Response Message

Collection of SurveyResponseCodeModel

Name	Description	Type	Additional information
ResponseCode	User defined response code for the survey	integer	None.
Description	User defined description of the response code given	string	Max length: 200
IsDefinite	Determines if the Response code is a definitive or not (IsFinal - true or false). if it is definitive, AllowAppointment should be 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). If it is an appointment, IsDefinite should be false.	boolean	None.
RelocationUrl	Relocation url of the response code	string	Max length: 1024

Response Formats

application/json, text/json

Sample:

[
  {
    "ResponseCode": 1,
    "Description": "sample string 2",
    "IsDefinite": true,
    "IsSelectable": true,
    "AllowAppointment": true,
    "RelocationUrl": "sample string 3"
  },
  {
    "ResponseCode": 1,
    "Description": "sample string 2",
    "IsDefinite": true,
    "IsSelectable": true,
    "AllowAppointment": true,
    "RelocationUrl": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSurveyResponseCodeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyResponseCodeModel>
    <AllowAppointment>true</AllowAppointment>
    <Description>sample string 2</Description>
    <IsDefinite>true</IsDefinite>
    <IsSelectable>true</IsSelectable>
    <RelocationUrl>sample string 3</RelocationUrl>
    <ResponseCode>1</ResponseCode>
  </SurveyResponseCodeModel>
  <SurveyResponseCodeModel>
    <AllowAppointment>true</AllowAppointment>
    <Description>sample string 2</Description>
    <IsDefinite>true</IsDefinite>
    <IsSelectable>true</IsSelectable>
    <RelocationUrl>sample string 3</RelocationUrl>
    <ResponseCode>1</ResponseCode>
  </SurveyResponseCodeModel>
</ArrayOfSurveyResponseCodeModel>