GET api/SocialDriver/InvitedDataViewer
Get all invited data viewer invites - Used by a Viewer to see which data has been shared with them
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
A list of GetInvitedDataViewerResponses
Collection of GetInvitedDataViewerResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| DataViewerFriendlyName |
The data viewers friendly name for the viewer |
string |
None. |
| DataViewerPermissions |
A bitmask of permissions the data viewer has |
DataViewerPermissions |
None. |
| DataViewerGuid |
The guid of the data viewer used to identify them |
string |
None. |
| DataViewerStatus |
The current status of the data viewer |
DataViewerStatus |
None. |
| DataViewerServiceId |
The service id of the data Owners vehicle |
integer |
None. |
| OwnerProfileImageURL |
The Data Owners profile image url, the image will expire after 10 days. This will be null if the owner hasn't set up a profile picture |
string |
None. |
| OwnerEmailAddress |
The data owners email address |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"DataViewerFriendlyName": "sample string 1",
"DataViewerPermissions": 1,
"DataViewerGuid": "sample string 2",
"DataViewerStatus": 0,
"DataViewerServiceId": 3,
"OwnerProfileImageURL": "sample string 4",
"OwnerEmailAddress": "sample string 5"
},
{
"DataViewerFriendlyName": "sample string 1",
"DataViewerPermissions": 1,
"DataViewerGuid": "sample string 2",
"DataViewerStatus": 0,
"DataViewerServiceId": 3,
"OwnerProfileImageURL": "sample string 4",
"OwnerEmailAddress": "sample string 5"
}
]
application/xml, text/xml
Sample:
<ArrayOfGetInvitedDataViewerResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<GetInvitedDataViewerResponse>
<DataViewerFriendlyName>sample string 1</DataViewerFriendlyName>
<DataViewerPermissions>ViewTelemetry</DataViewerPermissions>
<DataViewerGuid>sample string 2</DataViewerGuid>
<DataViewerStatus>InvitedToDownloadApp</DataViewerStatus>
<DataViewerServiceId>3</DataViewerServiceId>
<OwnerProfileImageURL>sample string 4</OwnerProfileImageURL>
<OwnerEmailAddress>sample string 5</OwnerEmailAddress>
</GetInvitedDataViewerResponse>
<GetInvitedDataViewerResponse>
<DataViewerFriendlyName>sample string 1</DataViewerFriendlyName>
<DataViewerPermissions>ViewTelemetry</DataViewerPermissions>
<DataViewerGuid>sample string 2</DataViewerGuid>
<DataViewerStatus>InvitedToDownloadApp</DataViewerStatus>
<DataViewerServiceId>3</DataViewerServiceId>
<OwnerProfileImageURL>sample string 4</OwnerProfileImageURL>
<OwnerEmailAddress>sample string 5</OwnerEmailAddress>
</GetInvitedDataViewerResponse>
</ArrayOfGetInvitedDataViewerResponse>