GET api.ashx/v2/users/{requestorid}/friends.{json|xml}
LIST confirmed friends for a user by user id. Comments go here.
Scopes
Users › Read Friends users.friends.readonly
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| FriendshipState | string | Defaults to Approved. Other options are Pending and NotSpecified. | Optional | |||
| PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. | Optional | |||
| PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. | Optional | |||
| Presence | string | Options are NotSpecified, Offline, Online. | Optional | |||
| RecipientId | int? | Allows filtering by RecipientId. | Optional | |||
| RequestorId | int? | Either the RequestorId or the RequestorName is required. | Optional | |||
| RequestorName | string | Either the RequestorId or the RequestorName is required. | Optional | |||
| SortBy | string | Defaults to CreatedDate. Other options are LastModifiedDate, LastConversationDate, and User. | Optional | |||
| SortOrder | string | Defaults to Ascending. Other option is Descending. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{requestorid}/friends.json',
data: {
'requestorid': '6'
}
}).then(function(response) {
// use response
});Example Responses
JSON
{
"PageSize": 2,
"PageIndex": 0,
"TotalCount": 2,
"Friendships": [
{
"CreatedDate": "2012-01-04T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-05-02T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 6,
"RequesteeId": 25,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 8,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
},
"Id": 4
},
"Body": "body",
"CreatedDate": "2012-06-04T00:00:00",
"ReplyCount": 7,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2011-05-28T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 27,
"Url": "url",
"TotalMembers": 32,
"HasGroups": true,
"GroupCount": 52,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContainerTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 19
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "6cdcf200-3bad-476d-af45-97b52545c337",
"ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
"CreatedDate": "2011-12-09T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ApplicationTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
},
"Id": 112
},
"Id": 61
},
{
"CreatedDate": "2012-03-29T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-04-19T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 18,
"RequesteeId": 76,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 6,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "fe65240b-044c-4292-9946-f10e0361ecff"
},
"Id": 25
},
"Body": "body",
"CreatedDate": "2012-01-16T00:00:00",
"ReplyCount": 8,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 4,
"Url": "url",
"TotalMembers": 7,
"HasGroups": true,
"GroupCount": 27,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
"ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 32
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"CreatedDate": "2012-05-02T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ApplicationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e"
},
"Id": 52
},
"Id": 19
}
],
"Info": [
"string",
"string"
],
"Warnings": [
"string",
"string"
],
"Errors": [
"string",
"string"
]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Info>
<Message>string</Message>
<Message>string</Message>
</Info>
<Warnings>
<Message>string</Message>
<Message>string</Message>
</Warnings>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
<Friendships PageSize="2" PageIndex="0" TotalCount="2">
<Friendship>
<Id>61</Id>
<CreatedDate>2012-01-04T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-05-02T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>6</RequestorId>
<RequesteeId>25</RequesteeId>
<User>
<Id>112</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
<Author>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>8</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-06-04T00:00:00</CreatedDate>
<ReplyCount>7</ReplyCount>
<Group>
<Id>19</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2011-05-28T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>27</ParentGroupId>
<Url>url</Url>
<TotalMembers>32</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>52</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
<Container>
<ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
<ContainerTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId>
<ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId>
<CreatedDate>2011-12-09T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationId>
<ApplicationTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
<Friendship>
<Id>19</Id>
<CreatedDate>2012-03-29T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-04-19T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>18</RequestorId>
<RequesteeId>76</RequesteeId>
<User>
<Id>52</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id>
<Author>
<Id>25</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>6</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-01-16T00:00:00</CreatedDate>
<ReplyCount>8</ReplyCount>
<Group>
<Id>32</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>4</ParentGroupId>
<Url>url</Url>
<TotalMembers>7</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>27</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
<Container>
<ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
<ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId>
<ContentTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentTypeId>
<CreatedDate>2012-05-02T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationId>
<ApplicationTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
</Friendships>
</Response>GET api.ashx/v2/users/{requestorid}/friends/pending.{json|xml}
LIST pending friends for a user by user id.
Scopes
Users › Read Friends users.friends.readonly
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| FriendshipState | string | Defaults to Approved. Other options are Pending and NotSpecified. | Optional | |||
| PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. | Optional | |||
| PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. | Optional | |||
| Presence | string | Options are NotSpecified, Offline, Online. | Optional | |||
| RecipientId | int? | Allows filtering by RecipientId. | Optional | |||
| RequestorId | int? | Either the RequestorId or the RequestorName is required. | Optional | |||
| RequestorName | string | Either the RequestorId or the RequestorName is required. | Optional | |||
| SortBy | string | Defaults to CreatedDate. Other options are LastModifiedDate, LastConversationDate, and User. | Optional | |||
| SortOrder | string | Defaults to Ascending. Other option is Descending. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{requestorid}/friends/pending.json',
data: {
'requestorid': '6'
}
}).then(function(response) {
// use response
});Example Responses
JSON
{
"PageSize": 2,
"PageIndex": 0,
"TotalCount": 2,
"Friendships": [
{
"CreatedDate": "2012-01-04T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-05-02T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 6,
"RequesteeId": 25,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 8,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
},
"Id": 4
},
"Body": "body",
"CreatedDate": "2012-06-04T00:00:00",
"ReplyCount": 7,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2011-05-28T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 27,
"Url": "url",
"TotalMembers": 32,
"HasGroups": true,
"GroupCount": 52,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContainerTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 19
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "6cdcf200-3bad-476d-af45-97b52545c337",
"ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
"CreatedDate": "2011-12-09T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ApplicationTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
},
"Id": 112
},
"Id": 61
},
{
"CreatedDate": "2012-03-29T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-04-19T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 18,
"RequesteeId": 76,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 6,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "fe65240b-044c-4292-9946-f10e0361ecff"
},
"Id": 25
},
"Body": "body",
"CreatedDate": "2012-01-16T00:00:00",
"ReplyCount": 8,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 4,
"Url": "url",
"TotalMembers": 7,
"HasGroups": true,
"GroupCount": 27,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
"ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 32
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"CreatedDate": "2012-05-02T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ApplicationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e"
},
"Id": 52
},
"Id": 19
}
],
"Info": [
"string",
"string"
],
"Warnings": [
"string",
"string"
],
"Errors": [
"string",
"string"
]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Info>
<Message>string</Message>
<Message>string</Message>
</Info>
<Warnings>
<Message>string</Message>
<Message>string</Message>
</Warnings>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
<Friendships PageSize="2" PageIndex="0" TotalCount="2">
<Friendship>
<Id>61</Id>
<CreatedDate>2012-01-04T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-05-02T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>6</RequestorId>
<RequesteeId>25</RequesteeId>
<User>
<Id>112</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
<Author>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>8</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-06-04T00:00:00</CreatedDate>
<ReplyCount>7</ReplyCount>
<Group>
<Id>19</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2011-05-28T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>27</ParentGroupId>
<Url>url</Url>
<TotalMembers>32</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>52</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
<Container>
<ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
<ContainerTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId>
<ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId>
<CreatedDate>2011-12-09T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationId>
<ApplicationTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
<Friendship>
<Id>19</Id>
<CreatedDate>2012-03-29T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-04-19T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>18</RequestorId>
<RequesteeId>76</RequesteeId>
<User>
<Id>52</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id>
<Author>
<Id>25</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>6</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-01-16T00:00:00</CreatedDate>
<ReplyCount>8</ReplyCount>
<Group>
<Id>32</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>4</ParentGroupId>
<Url>url</Url>
<TotalMembers>7</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>27</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
<Container>
<ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
<ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId>
<ContentTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentTypeId>
<CreatedDate>2012-05-02T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationId>
<ApplicationTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
</Friendships>
</Response>GET api.ashx/v2/users/{requestorname}/friends.{json|xml}
LIST confirmed friends for a user by username.
Scopes
Users › Read Friends users.friends.readonly
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| FriendshipState | string | Defaults to Approved. Other options are Pending and NotSpecified. | Optional | |||
| PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. | Optional | |||
| PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. | Optional | |||
| Presence | string | Options are NotSpecified, Offline, Online. | Optional | |||
| RecipientId | int? | Allows filtering by RecipientId. | Optional | |||
| RequestorId | int? | Either the RequestorId or the RequestorName is required. | Optional | |||
| RequestorName | string | Either the RequestorId or the RequestorName is required. | Optional | |||
| SortBy | string | Defaults to CreatedDate. Other options are LastModifiedDate, LastConversationDate, and User. | Optional | |||
| SortOrder | string | Defaults to Ascending. Other option is Descending. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{requestorname}/friends.json',
data: {
'requestorname': 'requestorname'
}
}).then(function(response) {
// use response
});Example Responses
JSON
{
"PageSize": 2,
"PageIndex": 0,
"TotalCount": 2,
"Friendships": [
{
"CreatedDate": "2012-01-04T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-05-02T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 6,
"RequesteeId": 25,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 8,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
},
"Id": 4
},
"Body": "body",
"CreatedDate": "2012-06-04T00:00:00",
"ReplyCount": 7,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2011-05-28T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 27,
"Url": "url",
"TotalMembers": 32,
"HasGroups": true,
"GroupCount": 52,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContainerTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 19
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "6cdcf200-3bad-476d-af45-97b52545c337",
"ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
"CreatedDate": "2011-12-09T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ApplicationTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
},
"Id": 112
},
"Id": 61
},
{
"CreatedDate": "2012-03-29T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-04-19T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 18,
"RequesteeId": 76,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 6,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "fe65240b-044c-4292-9946-f10e0361ecff"
},
"Id": 25
},
"Body": "body",
"CreatedDate": "2012-01-16T00:00:00",
"ReplyCount": 8,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 4,
"Url": "url",
"TotalMembers": 7,
"HasGroups": true,
"GroupCount": 27,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
"ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 32
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"CreatedDate": "2012-05-02T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ApplicationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e"
},
"Id": 52
},
"Id": 19
}
],
"Info": [
"string",
"string"
],
"Warnings": [
"string",
"string"
],
"Errors": [
"string",
"string"
]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Info>
<Message>string</Message>
<Message>string</Message>
</Info>
<Warnings>
<Message>string</Message>
<Message>string</Message>
</Warnings>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
<Friendships PageSize="2" PageIndex="0" TotalCount="2">
<Friendship>
<Id>61</Id>
<CreatedDate>2012-01-04T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-05-02T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>6</RequestorId>
<RequesteeId>25</RequesteeId>
<User>
<Id>112</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
<Author>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>8</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-06-04T00:00:00</CreatedDate>
<ReplyCount>7</ReplyCount>
<Group>
<Id>19</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2011-05-28T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>27</ParentGroupId>
<Url>url</Url>
<TotalMembers>32</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>52</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
<Container>
<ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
<ContainerTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId>
<ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId>
<CreatedDate>2011-12-09T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationId>
<ApplicationTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
<Friendship>
<Id>19</Id>
<CreatedDate>2012-03-29T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-04-19T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>18</RequestorId>
<RequesteeId>76</RequesteeId>
<User>
<Id>52</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id>
<Author>
<Id>25</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>6</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-01-16T00:00:00</CreatedDate>
<ReplyCount>8</ReplyCount>
<Group>
<Id>32</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>4</ParentGroupId>
<Url>url</Url>
<TotalMembers>7</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>27</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
<Container>
<ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
<ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId>
<ContentTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentTypeId>
<CreatedDate>2012-05-02T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationId>
<ApplicationTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
</Friendships>
</Response>GET api.ashx/v2/users/{requestorname}/friends/pending.{json|xml}
LIST pending friends for a user by username.
Scopes
Users › Read Friends users.friends.readonly
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| FriendshipState | string | Defaults to Approved. Other options are Pending and NotSpecified. | Optional | |||
| PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. | Optional | |||
| PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. | Optional | |||
| Presence | string | Options are NotSpecified, Offline, Online. | Optional | |||
| RecipientId | int? | Allows filtering by RecipientId. | Optional | |||
| RequestorId | int? | Either the RequestorId or the RequestorName is required. | Optional | |||
| RequestorName | string | Either the RequestorId or the RequestorName is required. | Optional | |||
| SortBy | string | Defaults to CreatedDate. Other options are LastModifiedDate, LastConversationDate, and User. | Optional | |||
| SortOrder | string | Defaults to Ascending. Other option is Descending. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{requestorname}/friends/pending.json',
data: {
'requestorname': 'requestorname'
}
}).then(function(response) {
// use response
});Example Responses
JSON
{
"PageSize": 2,
"PageIndex": 0,
"TotalCount": 2,
"Friendships": [
{
"CreatedDate": "2012-01-04T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-05-02T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 6,
"RequesteeId": 25,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 8,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
},
"Id": 4
},
"Body": "body",
"CreatedDate": "2012-06-04T00:00:00",
"ReplyCount": 7,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2011-05-28T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 27,
"Url": "url",
"TotalMembers": 32,
"HasGroups": true,
"GroupCount": 52,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContainerTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 19
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "6cdcf200-3bad-476d-af45-97b52545c337",
"ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
"CreatedDate": "2011-12-09T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ApplicationTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
},
"Id": 112
},
"Id": 61
},
{
"CreatedDate": "2012-03-29T00:00:00",
"FriendshipState": "friendshipstate",
"LastModifiedDate": "2012-04-19T00:00:00",
"RequestMessage": "requestmessage",
"RequestorId": 18,
"RequesteeId": 76,
"User": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": {
"Author": null,
"Body": "body",
"CreatedDate": null,
"ReplyCount": 6,
"Group": null,
"AttachedUrl": "attachedurl",
"HasReplies": null,
"ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": null,
"Id": "fe65240b-044c-4292-9946-f10e0361ecff"
},
"Id": 25
},
"Body": "body",
"CreatedDate": "2012-01-16T00:00:00",
"ReplyCount": 8,
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 4,
"Url": "url",
"TotalMembers": 7,
"HasGroups": true,
"GroupCount": 27,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [],
"ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
"ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
"Container": {
"ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
"ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
"HtmlName": "htmlname",
"Url": "url",
"AvatarUrl": "avatarurl"
},
"Id": 32
},
"AttachedUrl": "attachedurl",
"HasReplies": true,
"ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
"ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
"Url": "url",
"IsPublished": true,
"Content": {
"CreatedByUser": {
"AvatarUrl": "avatarurl",
"DisplayName": "displayname",
"ProfileUrl": "profileurl",
"Username": "username",
"CurrentStatus": null,
"Id": null
},
"ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
"ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
"CreatedDate": "2012-05-02T00:00:00",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Application": {
"ApplicationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
"ApplicationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
"HtmlName": "htmlname",
"HtmlDescription": "htmldescription",
"Url": "url",
"AvatarUrl": "avatarurl",
"Container": null
}
},
"Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e"
},
"Id": 52
},
"Id": 19
}
],
"Info": [
"string",
"string"
],
"Warnings": [
"string",
"string"
],
"Errors": [
"string",
"string"
]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Info>
<Message>string</Message>
<Message>string</Message>
</Info>
<Warnings>
<Message>string</Message>
<Message>string</Message>
</Warnings>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
<Friendships PageSize="2" PageIndex="0" TotalCount="2">
<Friendship>
<Id>61</Id>
<CreatedDate>2012-01-04T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-05-02T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>6</RequestorId>
<RequesteeId>25</RequesteeId>
<User>
<Id>112</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
<Author>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>8</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-06-04T00:00:00</CreatedDate>
<ReplyCount>7</ReplyCount>
<Group>
<Id>19</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2011-05-28T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>27</ParentGroupId>
<Url>url</Url>
<TotalMembers>32</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>52</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
<Container>
<ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
<ContainerTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId>
<ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId>
<CreatedDate>2011-12-09T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationId>
<ApplicationTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
<Friendship>
<Id>19</Id>
<CreatedDate>2012-03-29T00:00:00</CreatedDate>
<FriendshipState>friendshipstate</FriendshipState>
<LastModifiedDate>2012-04-19T00:00:00</LastModifiedDate>
<RequestMessage>requestmessage</RequestMessage>
<RequestorId>18</RequestorId>
<RequesteeId>76</RequesteeId>
<User>
<Id>52</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id>
<Author>
<Id>25</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
<CurrentStatus>
<Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
<Body>body</Body>
<CreatedDate />
<ReplyCount>6</ReplyCount>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
</CurrentStatus>
</Author>
<Body>body</Body>
<CreatedDate>2012-01-16T00:00:00</CreatedDate>
<ReplyCount>8</ReplyCount>
<Group>
<Id>32</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>
<ParentGroupId>4</ParentGroupId>
<Url>url</Url>
<TotalMembers>7</TotalMembers>
<HasGroups>true</HasGroups>
<GroupCount>27</GroupCount>
<GroupType>grouptype</GroupType>
<EnableGroupMessages>true</EnableGroupMessages>
<EnableContact>true</EnableContact>
<SearchUniqueId>searchuniqueid</SearchUniqueId>
<ExtendedAttributes />
<ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
<Container>
<ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
<ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Group>
<AttachedUrl>attachedurl</AttachedUrl>
<ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
<ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
<Url>url</Url>
<IsPublished>true</IsPublished>
<Content>
<CreatedByUser>
<Id />
<AvatarUrl>avatarurl</AvatarUrl>
<DisplayName>displayname</DisplayName>
<ProfileUrl>profileurl</ProfileUrl>
<Username>username</Username>
</CreatedByUser>
<ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId>
<ContentTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentTypeId>
<CreatedDate>2012-05-02T00:00:00</CreatedDate>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Application>
<ApplicationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationId>
<ApplicationTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Application>
</Content>
</CurrentStatus>
</User>
</Friendship>
</Friendships>
</Response>