GET api.ashx/v2/hashtags.{json|xml}
LIST hash tags.
Scopes
Tags › Read Hashtags tags.hashtags.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationId | Guid? | Content application identifier | Optional | |||
ApplicationTypeId | Guid? | Content application type identifier | Optional | |||
ContainerId | Guid? | Content container identifier | Optional | |||
ContentTypeId | Guid? | Content type identifier | Optional | |||
IncludeSubContainers | bool? | Include sub containers. ContainerId must be set if this is set. | Optional | |||
PageSize | int? | Page size to retrieve | Optional | |||
QueryText | string | Text used to find hash tags | Required |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/hashtags.json?QueryText=querytext', data: { 'QueryText': 'querytext' } }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "HashTags": [ { "Name": "name", "Token": "token", "PreviewHtml": "previewhtml" }, { "Name": "name", "Token": "token", "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> <HashTags PageSize="2"> <HashTag> <Name>name</Name> <Token>token</Token> <PreviewHtml>previewhtml</PreviewHtml> </HashTag> <HashTag> <Name>name</Name> <Token>token</Token> <PreviewHtml>previewhtml</PreviewHtml> </HashTag> </HashTags> </Response>