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
DirectoryIdentityModelName | 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": "1e58e596-b6e5-4b65-871e-ff9957924b26", "ObjectId": "858366a0-84a0-4b49-8e9c-91e6351621c4", "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>858366a0-84a0-4b49-8e9c-91e6351621c4</ObjectId> <ObjectType>Unknown</ObjectType> <TenantId>1e58e596-b6e5-4b65-871e-ff9957924b26</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
SurveyGroupDirectoryAssignmentModelName | 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": "80a024b2-67c6-4acb-bbed-fad9626add20", "ObjectId": "b12e9f9f-9113-41d2-91be-d26204bb25b7", "ObjectType": 0, "DateAdded": "2024-07-27T04:14:54.1660891+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-07-27T04:14:54.1660891+00:00</DateAdded> <ObjectId>b12e9f9f-9113-41d2-91be-d26204bb25b7</ObjectId> <ObjectType>Unknown</ObjectType> <SurveyGroupId>1</SurveyGroupId> <TenantId>80a024b2-67c6-4acb-bbed-fad9626add20</TenantId> </SurveyGroupDirectoryAssignmentModel>