PUT v1/Surveys/{surveyId}/InterviewQuality

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

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

Update the quality state of an existing interview.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The survey Id of the interview is defined for

string

Required

Body Parameters

The updated quality state

QualityNewStateChangeModel
NameDescriptionTypeAdditional information
InterviewId

ID of the interview (corresponds to InterviewNumber, not InterviewId in the sample table)

string

Required

NewState

The new state to be set

InterviewQuality

None.

Request Formats

application/json, text/json

Sample:
{
  "InterviewId": "sample string 1",
  "NewState": 0
}

application/xml, text/xml

Sample:
<QualityNewStateChangeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InterviewId>sample string 1</InterviewId>
  <NewState>NotChecked</NewState>
</QualityNewStateChangeModel>

application/x-www-form-urlencoded

Sample:
InterviewId=sample&NewState=NotChecked

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

An indication of the result of the action

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.