POST api/SocialDriver/DataViewerInvite
Create a data viewer invite or resend invite - For use by the Data Owner to invite people to view their data
Request Information
URI Parameters
None.
Body Parameters
A CreateDataViewerRequest
CreateDataViewerInviteRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DataViewerUsername |
The username (email) of the data viewer |
string |
None. |
| DataViewerFriendlyName |
The friendly name you want the data viewer to appear as |
string |
None. |
| DataViewerPermissions |
A bitmask of permissions to assign the data viewer |
DataViewerPermissions |
None. |
Request Formats
application/json, text/json
Sample:
{
"DataViewerUsername": "sample string 1",
"DataViewerFriendlyName": "sample string 2",
"DataViewerPermissions": 1
}
application/xml, text/xml
Sample:
<CreateDataViewerInviteRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <DataViewerUsername>sample string 1</DataViewerUsername> <DataViewerFriendlyName>sample string 2</DataViewerFriendlyName> <DataViewerPermissions>ViewTelemetry</DataViewerPermissions> </CreateDataViewerInviteRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
200 on success or 409 if an invite has already been accepted
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |