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": "79be6c78-b2c4-4c9f-9cdf-04f66a6d0f5e", "ObjectId": "6b8d8dbc-0081-4a2f-8653-fbf2a9df41c6", "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>6b8d8dbc-0081-4a2f-8653-fbf2a9df41c6</ObjectId> <ObjectType>Unknown</ObjectType> <TenantId>79be6c78-b2c4-4c9f-9cdf-04f66a6d0f5e</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": "4f64b0c8-05b0-4a53-8cf5-8f6237320f24", "ObjectId": "d9e9e095-a680-4ff9-93cf-5381eabd3a3b", "ObjectType": 0, "DateAdded": "2024-07-24T22:57:44.5720403+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-24T22:57:44.5720403+00:00</DateAdded> <ObjectId>d9e9e095-a680-4ff9-93cf-5381eabd3a3b</ObjectId> <ObjectType>Unknown</ObjectType> <SurveyGroupId>1</SurveyGroupId> <TenantId>4f64b0c8-05b0-4a53-8cf5-8f6237320f24</TenantId> </SurveyGroupDirectoryAssignmentModel>