GET v1/Surveys/{surveyId}/InviteRespondents/InvitationStatus/{batchName}

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

Permissions required to make this request: EmailBatch.Read SampleRecord.Read Survey.Read

Has survey type usage restrictions online

Retrieves the invitation status for the wanted batch of the specified survey.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	Id of the survey	string	Required
batchName	The name of the batch to get the status of	string	Required

Body Parameters

None.

Response Information

Resource Description

A collection of invitation batch status objects

Response Message

Collection of InvitationBatchStatus

Name	Description	Type	Additional information
RespondentKey	Respondent key	string	None.
Status	Status of the invitation	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RespondentKey": "sample string 1",
    "Status": "sample string 2"
  },
  {
    "RespondentKey": "sample string 1",
    "Status": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInvitationBatchStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InvitationBatchStatus>
    <RespondentKey>sample string 1</RespondentKey>
    <Status>sample string 2</Status>
  </InvitationBatchStatus>
  <InvitationBatchStatus>
    <RespondentKey>sample string 1</RespondentKey>
    <Status>sample string 2</Status>
  </InvitationBatchStatus>
</ArrayOfInvitationBatchStatus>