GET api.ashx/v2/rateditems.{json|xml}
LIST rated items.
Scopes
Ratings › Read Rated Items ratings.rateditems.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationId | Guid? | Content application identifier | Optional | |||
ContainerId | Guid? | Content container identifier | Optional | |||
ContentTypeId | Guid? | Content type identifier | Optional | |||
IncludeSubContainers | bool? | Include sub containers | Optional | |||
PageIndex | int? | Page index to retrieve | Optional | |||
PageSize | int? | Page size to retrieve | Optional | |||
PostTarget | string | Render target. Options: Unknown, Web, Syndication, Offline, Other, Print, Nntp, Email, WebQuote, WebServices. | Optional | |||
SortBy | string | Sort mechanism: Rating, Date | Optional | |||
SortOrder | string | Sort order: Ascending, Descending | Optional | |||
TypeId | Guid? | Categorization type | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/rateditems.json' }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "PageIndex": 0, "TotalCount": 2, "RatedItems": [ { "Url": "url", "TypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "AverageValue": 0.33, "Count": 6, "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": 25, "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": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContentTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "CreatedDate": "2012-05-02T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "e3715662-2528-4ba1-84a7-bfcd9d548f80" }, "Id": 8 }, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "CreatedDate": "2012-06-04T00: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": { "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" } } } }, { "Url": "url", "TypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "AverageValue": 0.25, "Count": 4, "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": 7, "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": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": 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": null }, "Id": "44df201a-07e6-42eb-96c7-8ce7ce35aab6" }, "Id": 27 }, "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContentTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "CreatedDate": "2012-03-29T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "fe65240b-044c-4292-9946-f10e0361ecff", "ApplicationTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": { "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" } } } } ], "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> <RatedItems PageSize="2" PageIndex="0" TotalCount="2"> <RestRatedItem> <Url>url</Url> <TypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</TypeId> <AverageValue>0.33</AverageValue> <Count>6</Count> <Content> <CreatedByUser> <Id>8</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>e3715662-2528-4ba1-84a7-bfcd9d548f80</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>25</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>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId> <ContentTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentTypeId> <CreatedDate>2012-05-02T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Content> </CurrentStatus> </CreatedByUser> <ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId> <ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId> <CreatedDate>2012-06-04T00: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> <Container> <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId> <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Application> </Content> </RestRatedItem> <RestRatedItem> <Url>url</Url> <TypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</TypeId> <AverageValue>0.25</AverageValue> <Count>4</Count> <Content> <CreatedByUser> <Id>27</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>44df201a-07e6-42eb-96c7-8ce7ce35aab6</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>7</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>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <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> </Content> </CurrentStatus> </CreatedByUser> <ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId> <ContentTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentTypeId> <CreatedDate>2012-03-29T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationId> <ApplicationTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Container> <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId> <ContainerTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Application> </Content> </RestRatedItem> </RatedItems> </Response>