PUT v1/Surveys/{surveyId}/Fieldwork/Stop
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Supervisor
LimitedUser
LocalDomainManager
OperationsUser
Permissions required to make this request:
SurveyFieldwork.Stop
Survey.Read
This method stops the fieldwork of the survey.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
The id of the survey |
string |
Required |
Body Parameters
The settings for the stopping of the fieldwork
StopFieldworkModelName | Description | Type | Additional information |
---|---|---|---|
TerminateRunningInterviews |
Indication to terminate running interviews |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "TerminateRunningInterviews": true }
application/xml, text/xml
Sample:
<StopFieldworkModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <TerminateRunningInterviews>true</TerminateRunningInterviews> </StopFieldworkModel>
application/x-www-form-urlencoded
Sample:
TerminateRunningInterviews=true
multipart/form-data
Sample:
Sample not available.
Response Information
Resource Description
Message indicating the result of the fieldwork stop
Response Message
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |