GET v1/Surveys/{surveyId}/InterviewQuality

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

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

This method retrieves the interview details list defined for the survey with the specified surveyId surveyId. This list can be filtered and sorted using standard OData syntax.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey id	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of interview details

Response Message

Collection of InterviewDetailsModel

Name	Description	Type	Additional information
Id	ID of the interview (corresponds to InterviewNumber, not InterviewId in the sample table)	string	None.
InterviewQuality	Quality Control state of an interview	InterviewQuality	None.
InterviewerId	Id of the interviewer	string	None.
SamplingPointId	Id of the sampling point, null for surveys without sampling points	string	None.
OfficeId	Id of the Fieldwork Office	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "InterviewQuality": 0,
    "InterviewerId": "sample string 2",
    "SamplingPointId": "sample string 3",
    "OfficeId": "sample string 4"
  },
  {
    "Id": "sample string 1",
    "InterviewQuality": 0,
    "InterviewerId": "sample string 2",
    "SamplingPointId": "sample string 3",
    "OfficeId": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInterviewDetailsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InterviewDetailsModel>
    <Id>sample string 1</Id>
    <InterviewQuality>NotChecked</InterviewQuality>
    <InterviewerId>sample string 2</InterviewerId>
    <OfficeId>sample string 4</OfficeId>
    <SamplingPointId>sample string 3</SamplingPointId>
  </InterviewDetailsModel>
  <InterviewDetailsModel>
    <Id>sample string 1</Id>
    <InterviewQuality>NotChecked</InterviewQuality>
    <InterviewerId>sample string 2</InterviewerId>
    <OfficeId>sample string 4</OfficeId>
    <SamplingPointId>sample string 3</SamplingPointId>
  </InterviewDetailsModel>
</ArrayOfInterviewDetailsModel>