GET v1/Surveys/Search?value={value}

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

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

Search respondent across surveys

Request Information

URI Parameters

Name	Description	Type	Additional information
value	Search value	string	Required

Body Parameters

None.

Response Information

Resource Description

Response Message

Collection of SurveyBaseModel

Name	Description	Type	Additional information
SurveyId	The unique id of the survey	string	Max length: 36
SurveyName	The name of the survey	string	Required Max length: 50

Name

Description

Type

Additional information

SurveyId

The unique id of the survey

string

Max length: 36

SurveyName

The name of the survey

string

Required

Max length: 50

Response Formats

application/json, text/json

Sample:

[
  {
    "SurveyId": "sample string 1",
    "SurveyName": "sample string 2"
  },
  {
    "SurveyId": "sample string 1",
    "SurveyName": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSurveyBaseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyBaseModel>
    <SurveyId>sample string 1</SurveyId>
    <SurveyName>sample string 2</SurveyName>
  </SurveyBaseModel>
  <SurveyBaseModel>
    <SurveyId>sample string 1</SurveyId>
    <SurveyName>sample string 2</SurveyName>
  </SurveyBaseModel>
</ArrayOfSurveyBaseModel>