PUT v1/SurveyGroups/{surveyGroupId}/AssignDirectory

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

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

Assign directory user to survey group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyGroupId

integer

Required

Body Parameters

DirectoryIdentityModel
NameDescriptionTypeAdditional information
TenantId

Tenant id

globally unique identifier

None.

ObjectId

Object id

globally unique identifier

None.

ObjectType

Object type

AadObjectType

None.

Request Formats

application/json, text/json

Sample:
{
  "TenantId": "521c7310-100c-49b1-bb1b-9c8b0399be92",
  "ObjectId": "51ce12eb-cddc-4526-8f15-9cc69034a0dc",
  "ObjectType": 0
}

application/xml, text/xml

Sample:
<DirectoryIdentityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ObjectId>51ce12eb-cddc-4526-8f15-9cc69034a0dc</ObjectId>
  <ObjectType>Unknown</ObjectType>
  <TenantId>521c7310-100c-49b1-bb1b-9c8b0399be92</TenantId>
</DirectoryIdentityModel>

application/x-www-form-urlencoded

Sample:
TenantId=Guid&ObjectId=Guid&ObjectType=Unknown

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

SurveyGroupDirectoryAssignmentModel
NameDescriptionTypeAdditional information
SurveyGroupId

Survey group id

integer

None.

TenantId

Tenant id

globally unique identifier

None.

ObjectId

Object id

globally unique identifier

None.

ObjectType

Object type

AadObjectType

None.

DateAdded

Creation date

date

None.

Response Formats

application/json, text/json

Sample:
{
  "SurveyGroupId": 1,
  "TenantId": "bc653c72-d8e4-40ad-9994-ea050d87059d",
  "ObjectId": "c6400faf-e617-46bf-8b88-840be22a46f0",
  "ObjectType": 0,
  "DateAdded": "2024-05-26T06:29:05.2497081+00:00"
}

application/xml, text/xml

Sample:
<SurveyGroupDirectoryAssignmentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <DateAdded>2024-05-26T06:29:05.2497081+00:00</DateAdded>
  <ObjectId>c6400faf-e617-46bf-8b88-840be22a46f0</ObjectId>
  <ObjectType>Unknown</ObjectType>
  <SurveyGroupId>1</SurveyGroupId>
  <TenantId>bc653c72-d8e4-40ad-9994-ea050d87059d</TenantId>
</SurveyGroupDirectoryAssignmentModel>