GET v1/Surveys/{surveyId}/Fieldwork/Status

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor Scripter LimitedUser QuotaManager LocalDomainManager GlobalDomainManager OperationsUser SampleManager RepositoryManager DemoUser All

Permissions required to make this request: Survey.Read

Supports survey simulations

This method returns fieldwork status.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

 string

Required

Body Parameters

None.

Response Information

Resource Description

The fieldwork status. The values are: 0 - UnderConstruction 1 - Started 3 - Closed

Response Message

integer

None.

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>