PATCH v1/SurveyGroups/{surveyGroupId}

User roles allowed to make this request: DomainAdministrator PowerUser LocalDomainManager GlobalDomainManager

Permissions required to make this request: SurveyGroup.Write SurveyGroup.Read

Update a survey group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyGroupId

integer

Required

Body Parameters

UpdateSurveyGroupModel
NameDescriptionTypeAdditional information
Name

Change to the name

string

None.

Description

Change to the description

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:
<UpdateSurveyGroupModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Description>sample string 2</Description>
  <Name>sample string 1</Name>
</UpdateSurveyGroupModel>

application/x-www-form-urlencoded

Sample:
Name=sample&Description=sample

multipart/form-data

Sample:

Sample not available.

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-06-16T09:32:49.7502579+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-06-16T09:32:49.7502579+00:00</CreationDate>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <SurveyGroupId>1</SurveyGroupId>
</SurveyGroupModel>