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": "ccf0e791-4ca5-4502-b31b-3c9de45b3a6e", "ObjectId": "7d3f2936-0c37-444f-a0c5-4239ca2163f7", "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>7d3f2936-0c37-444f-a0c5-4239ca2163f7</ObjectId> <ObjectType>Unknown</ObjectType> <TenantId>ccf0e791-4ca5-4502-b31b-3c9de45b3a6e</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": "d0e1348d-0a1e-4d28-946f-b8dd881b6c71", "ObjectId": "3a164f9e-d04e-4591-9fca-5aabba661325", "ObjectType": 0, "DateAdded": "2024-09-08T00:59:52.6893678+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-08T00:59:52.6893678+00:00</DateAdded> <ObjectId>3a164f9e-d04e-4591-9fca-5aabba661325</ObjectId> <ObjectType>Unknown</ObjectType> <SurveyGroupId>1</SurveyGroupId> <TenantId>d0e1348d-0a1e-4d28-946f-b8dd881b6c71</TenantId> </SurveyGroupDirectoryAssignmentModel>