GET api.ashx/v2/mentionables.{json|xml}
LIST mentionables.
Scopes
Mentions › Read Mentions mentions.mentions.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationId | Guid? | Host content's application identifier | Optional | |||
ApplicationId | Guid? | Mentionable content's application identifier | Optional | |||
ApplicationTypeId | Guid? | Host content's application type identifier | Optional | |||
ApplicationTypeId | Guid? | Mentionable content's application type identifier | Optional | |||
ContainerId | Guid? | Host content's container identifier | Optional | |||
ContainerId | Guid? | Mentionable content's container identifier | Optional | |||
ContainerTypeId | Guid? | Host content's container type identifier | Optional | |||
ContainerTypeId | Guid? | Mentionable content's container type identifier | Optional | |||
ContentId | Guid? | Host content's type identifier | Optional | |||
ContentTypeId | Guid? | Host content's type identifier | Optional | |||
ContentTypeId | Guid? | Mentionable content's type identifier | Optional | |||
PageSize | int? | Page size to retrieve | Optional | |||
PostTarget | string | Render target. Options: Unknown, Web, Syndication, Offline, Other, Print, Nntp, Email, WebQuote, WebServices. | Optional | |||
QueryText | string | Text used to find matching mentionables | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/mentionables.json' }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "Mentionables": [ { "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-01-04T00:00:00", "ReplyCount": 6, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "CreatedDate": "2012-05-02T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "6cdcf200-3bad-476d-af45-97b52545c337" }, "Id": 25 }, "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "CreatedDate": "2012-06-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ApplicationTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": { "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContainerTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" } } }, "Token": "token", "IsRecommended": true, "SupportsLabelHtml": true, "PreviewHtml": "previewhtml" }, { "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContentTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2011-05-28T00:00:00", "ReplyCount": 8, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "CreatedDate": "2011-12-09T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46" }, "Id": 4 }, "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContentTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "CreatedDate": "2012-03-29T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ApplicationTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": { "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContainerTypeId": "6cdcf200-3bad-476d-af45-97b52545c337", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" } } }, "Token": "token", "IsRecommended": true, "SupportsLabelHtml": true, "PreviewHtml": "previewhtml" } ], "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> <Mentionables PageSize="2"> <Mentionable> <ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId> <ContentTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentTypeId> <Content> <CreatedByUser> <Id>25</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>6cdcf200-3bad-476d-af45-97b52545c337</Id> <Author> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </Author> <Body>body</Body> <CreatedDate>2012-01-04T00:00:00</CreatedDate> <ReplyCount>6</ReplyCount> <Group> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated /> <Description>description</Description> <Key>key</Key> <Name>name</Name> <Url>url</Url> <TotalMembers /> <HasGroups>true</HasGroups> <GroupCount /> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId> <ContentTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentTypeId> <CreatedDate>2012-05-02T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Content> </CurrentStatus> </CreatedByUser> <ContentId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentId> <ContentTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentTypeId> <CreatedDate>2012-06-04T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationId> <ApplicationTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Container> <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId> <ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Application> </Content> <Token>token</Token> <IsRecommended>true</IsRecommended> <SupportsLabelHtml>true</SupportsLabelHtml> <PreviewHtml>previewhtml</PreviewHtml> </Mentionable> <Mentionable> <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId> <ContentTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentTypeId> <Content> <CreatedByUser> <Id>4</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id> <Author> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </Author> <Body>body</Body> <CreatedDate>2011-05-28T00:00:00</CreatedDate> <ReplyCount>8</ReplyCount> <Group> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated /> <Description>description</Description> <Key>key</Key> <Name>name</Name> <Url>url</Url> <TotalMembers /> <HasGroups>true</HasGroups> <GroupCount /> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId> </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> <ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId> <ContentTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentTypeId> <CreatedDate>2011-12-09T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Content> </CurrentStatus> </CreatedByUser> <ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId> <ContentTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentTypeId> <CreatedDate>2012-03-29T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationId> <ApplicationTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Container> <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId> <ContainerTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Application> </Content> <Token>token</Token> <IsRecommended>true</IsRecommended> <SupportsLabelHtml>true</SupportsLabelHtml> <PreviewHtml>previewhtml</PreviewHtml> </Mentionable> </Mentionables> </Response>