GET v1/SurveyGroups/{surveyGroupId}

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: SurveyGroup.Read

Retrieve a specific survey group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyGroupId

id of the survey group

integer

Required

Body Parameters

None.

Response Information

Resource Description

Response Message

SurveyGroupModel
NameDescriptionTypeAdditional information
SurveyGroupId

Unique Id of survey group

integer

None.

Name

Name of survey group

string

None.

Description

Description of survey group

string

None.

CreationDate

The creation date of the survey

date

None.

Response Formats

application/json, text/json

Sample:
{
  "SurveyGroupId": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CreationDate": "2024-05-14T11:13:37.7130047+00:00"
}

application/xml, text/xml

Sample:
<SurveyGroupModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <CreationDate>2024-05-14T11:13:37.7130047+00:00</CreationDate>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <SurveyGroupId>1</SurveyGroupId>
</SurveyGroupModel>