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

Name	Description	Type	Additional information
surveyGroupId		integer	Required

Body Parameters

DirectoryIdentityModel

Name	Description	Type	Additional 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": "94ab9ccd-f4a7-46d3-a0d2-aab9598e97e5",
  "ObjectId": "3799e746-833c-49bc-afa4-fbfe0472255d",
  "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>3799e746-833c-49bc-afa4-fbfe0472255d</ObjectId>
  <ObjectType>Unknown</ObjectType>
  <TenantId>94ab9ccd-f4a7-46d3-a0d2-aab9598e97e5</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

Name	Description	Type	Additional 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": "37577d08-c665-4a69-8834-3c4378ca6018",
  "ObjectId": "24b7ff31-1b21-47f3-959a-848904baac4d",
  "ObjectType": 0,
  "DateAdded": "2024-09-07T17:13:05.7639456+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-09-07T17:13:05.7639456+00:00</DateAdded>
  <ObjectId>24b7ff31-1b21-47f3-959a-848904baac4d</ObjectId>
  <ObjectType>Unknown</ObjectType>
  <SurveyGroupId>1</SurveyGroupId>
  <TenantId>37577d08-c665-4a69-8834-3c4378ca6018</TenantId>
</SurveyGroupDirectoryAssignmentModel>