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

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

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

Supports survey simulations

Returns survey fieldwork counts.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required

Body Parameters

None.

Response Information

Resource Description

Survey fieldwork counts

Response Message

SurveyFieldworkCountsResponseModel

Name	Description	Type	Additional information
SurveyId	Survey Identifier	string	None.
Successful	Number of successful interviews	integer	None.
SuccessfulLast24Hours	Number of successful interviews in last 24 hours	integer	None.
ScreenedOut	Number of screened out interviews	integer	None.
DroppedOut	Number of dropped out interviews	integer	None.
Rejected	Number of rejected interviews	integer	None.
SuccessfulDeleted	Number of successful deleted interviews	integer	None.
ScreenedOutDeleted	Number of screened out deleted interviews	integer	None.
DroppedOutDeleted	Number of dropped out deleted interviews	integer	None.
RejectedDeleted	Number of rejected deleted interviews	integer	None.
ActiveInterviews	Number of active interviews	integer	None.
ScreenedOutOverview	Overview of screen out interviews. Returns counts for each response code.	Collection of ResponseCodeCount	None.

Response Formats

application/json, text/json

Sample:

{
  "SurveyId": "sample string 1",
  "Successful": 2,
  "SuccessfulLast24Hours": 3,
  "ScreenedOut": 4,
  "DroppedOut": 5,
  "Rejected": 6,
  "SuccessfulDeleted": 7,
  "ScreenedOutDeleted": 8,
  "DroppedOutDeleted": 9,
  "RejectedDeleted": 10,
  "ActiveInterviews": 11,
  "ScreenedOutOverview": [
    {
      "ResponseCode": 1,
      "Count": 2
    },
    {
      "ResponseCode": 1,
      "Count": 2
    }
  ]
}

application/xml, text/xml

Sample:

<SurveyFieldworkCountsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyFieldwork">
  <ActiveInterviews>11</ActiveInterviews>
  <DroppedOut>5</DroppedOut>
  <DroppedOutDeleted>9</DroppedOutDeleted>
  <Rejected>6</Rejected>
  <RejectedDeleted>10</RejectedDeleted>
  <ScreenedOut>4</ScreenedOut>
  <ScreenedOutDeleted>8</ScreenedOutDeleted>
  <ScreenedOutOverview>
    <SurveyFieldworkCountsResponseModel.ResponseCodeCount>
      <Count>2</Count>
      <ResponseCode>1</ResponseCode>
    </SurveyFieldworkCountsResponseModel.ResponseCodeCount>
    <SurveyFieldworkCountsResponseModel.ResponseCodeCount>
      <Count>2</Count>
      <ResponseCode>1</ResponseCode>
    </SurveyFieldworkCountsResponseModel.ResponseCodeCount>
  </ScreenedOutOverview>
  <Successful>2</Successful>
  <SuccessfulDeleted>7</SuccessfulDeleted>
  <SuccessfulLast24Hours>3</SuccessfulLast24Hours>
  <SurveyId>sample string 1</SurveyId>
</SurveyFieldworkCountsResponseModel>