XFRM_ResourceRating
Resource object
Conditionally included based on request context
usernamestring
descriptionstring
description_parsedstring
HTML parsed version of the description
description_attach_countinteger
DescriptionAttachments object[]
Attachments to the description, if any
Array [
filenamestring
file_sizeinteger
heightinteger
widthinteger
thumbnail_urlstring
retina_thumbnail_urlstring
direct_urlstring
is_videoboolean
is_audioboolean
attachment_idinteger
content_typestring
content_idinteger
attach_dateinteger
view_countinteger
]
reaction_scoreinteger
update_countinteger
review_countinteger
current_download_urlstring
For downloadable resources with an external download URL
current_filesobject[]
For downloadable resources with local files
external_purchase_urlstring
For externally purchasable resources
is_watchingboolean
If visitor is logged in
icon_urlstring
If resource icons are enabled
versionstring
Current version string, if the resource is versioned
custom_fieldsobject
Key-value pairs of custom field values
tagsstring[]
prefixstring
Rendered prefix title, if a prefix is set
can_editboolean
can_edit_tagsboolean
can_edit_iconboolean
can_soft_deleteboolean
can_hard_deleteboolean
can_downloadboolean
can_view_description_attachmentsboolean
view_urlstring
resource_idinteger
titlestring
tag_linestring
user_idinteger
resource_statestring
resource_typestring
resource_dateinteger
resource_category_idinteger
external_urlstring
pricenumber
currencystring
view_countinteger
download_countinteger
rating_countinteger
rating_avgnumber
rating_weightednumber
last_updateinteger
alt_support_urlstring
prefix_idinteger
featuredboolean
Category object
prefixes object[]
Array [
prefix_idinteger
titlestring
descriptionstring
usage_helpstring
is_usableboolean
True if the acting user can use (select) this prefix.
prefix_group_idinteger
display_orderinteger
materialized_orderinteger
Effective order, taking group ordering into account.
]
custom_fieldsobject[]
can_addboolean
can_upload_imagesboolean
view_urlstring
resource_category_idinteger
titlestring
descriptionstring
resource_countinteger
last_updateinteger
last_resource_titlestring
last_resource_idinteger
allow_localboolean
allow_externalboolean
allow_commercial_externalboolean
allow_filelessboolean
min_tagsinteger
enable_versioningboolean
enable_support_urlboolean
parent_category_idinteger
display_orderinteger
User object
Information about the user. Different information will be included based on permissions and verbosity.
aboutstring
activity_visibleboolean
ageinteger
The user's current age. Only included if available.
alert_optoutundefined[]
allow_post_profilestring
allow_receive_news_feedstring
allow_send_personal_conversationstring
allow_view_identitiesstring
allow_view_profilestring
avatar_urlsobject
Maps from size types to URL.
profile_banner_urlsobject
Maps from size types to URL.
can_banboolean
can_converseboolean
can_editboolean
can_followboolean
can_ignoreboolean
can_post_profileboolean
can_view_profileboolean
can_view_profile_postsboolean
can_warnboolean
content_show_signatureboolean
creation_watch_statestring
custom_fieldsobject
Map of custom field keys and values.
custom_titlestring
Will have a value if a custom title has been specifically set; prefer user_title instead.
dobobject
Date of birth with year, month and day keys.
emailstring
email_on_conversationboolean
gravatarstring
interaction_watch_stateboolean
is_adminboolean
is_bannedboolean
is_discouragedboolean
is_followedboolean
True if the visitor is following this user. Only included if visitor is not a guest.
is_ignoredboolean
True if the visitor is ignoring this user. Only included if visitor is not a guest.
is_moderatorboolean
is_super_adminboolean
last_activityinteger
Unix timestamp of user's last activity, if available.
locationstring
push_on_conversationboolean
push_optoutundefined[]
receive_admin_emailboolean
secondary_group_idsundefined[]
show_dob_dateboolean
show_dob_yearboolean
signaturestring
timezonestring
use_tfaboolean
user_group_idinteger
user_statestring
user_titlestring
visibleboolean
warning_pointsinteger
Current warning points.
websitestring
view_urlstring
user_idinteger
usernamestring
message_countinteger
question_solution_countinteger
register_dateinteger
trophy_pointsinteger
is_staffboolean
reaction_scoreinteger
vote_scoreinteger
custom_fieldsobject
Key-value pairs of review custom field values
can_soft_deleteboolean
can_hard_deleteboolean
can_author_replyboolean
AnonymousUser object
Information about the user. Different information will be included based on permissions and verbosity.
aboutstring
activity_visibleboolean
ageinteger
The user's current age. Only included if available.
alert_optoutundefined[]
allow_post_profilestring
allow_receive_news_feedstring
allow_send_personal_conversationstring
allow_view_identitiesstring
allow_view_profilestring
avatar_urlsobject
Maps from size types to URL.
profile_banner_urlsobject
Maps from size types to URL.
can_banboolean
can_converseboolean
can_editboolean
can_followboolean
can_ignoreboolean
can_post_profileboolean
can_view_profileboolean
can_view_profile_postsboolean
can_warnboolean
content_show_signatureboolean
creation_watch_statestring
custom_fieldsobject
Map of custom field keys and values.
custom_titlestring
Will have a value if a custom title has been specifically set; prefer user_title instead.
dobobject
Date of birth with year, month and day keys.
emailstring
email_on_conversationboolean
gravatarstring
interaction_watch_stateboolean
is_adminboolean
is_bannedboolean
is_discouragedboolean
is_followedboolean
True if the visitor is following this user. Only included if visitor is not a guest.
is_ignoredboolean
True if the visitor is ignoring this user. Only included if visitor is not a guest.
is_moderatorboolean
is_super_adminboolean
last_activityinteger
Unix timestamp of user's last activity, if available.
locationstring
push_on_conversationboolean
push_optoutundefined[]
receive_admin_emailboolean
secondary_group_idsundefined[]
show_dob_dateboolean
show_dob_yearboolean
signaturestring
timezonestring
use_tfaboolean
user_group_idinteger
user_statestring
user_titlestring
visibleboolean
warning_pointsinteger
Current warning points.
websitestring
view_urlstring
user_idinteger
usernamestring
message_countinteger
question_solution_countinteger
register_dateinteger
trophy_pointsinteger
is_staffboolean
reaction_scoreinteger
vote_scoreinteger
anonymous_user_idinteger
If anonymous and viewer has permission to see the author
User object
Information about the user. Different information will be included based on permissions and verbosity.
aboutstring
activity_visibleboolean
ageinteger
The user's current age. Only included if available.
alert_optoutundefined[]
allow_post_profilestring
allow_receive_news_feedstring
allow_send_personal_conversationstring
allow_view_identitiesstring
allow_view_profilestring
avatar_urlsobject
Maps from size types to URL.
profile_banner_urlsobject
Maps from size types to URL.
can_banboolean
can_converseboolean
can_editboolean
can_followboolean
can_ignoreboolean
can_post_profileboolean
can_view_profileboolean
can_view_profile_postsboolean
can_warnboolean
content_show_signatureboolean
creation_watch_statestring
custom_fieldsobject
Map of custom field keys and values.
custom_titlestring
Will have a value if a custom title has been specifically set; prefer user_title instead.
dobobject
Date of birth with year, month and day keys.
emailstring
email_on_conversationboolean
gravatarstring
interaction_watch_stateboolean
is_adminboolean
is_bannedboolean
is_discouragedboolean
is_followedboolean
True if the visitor is following this user. Only included if visitor is not a guest.
is_ignoredboolean
True if the visitor is ignoring this user. Only included if visitor is not a guest.
is_moderatorboolean
is_super_adminboolean
last_activityinteger
Unix timestamp of user's last activity, if available.
locationstring
push_on_conversationboolean
push_optoutundefined[]
receive_admin_emailboolean
secondary_group_idsundefined[]
show_dob_dateboolean
show_dob_yearboolean
signaturestring
timezonestring
use_tfaboolean
user_group_idinteger
user_statestring
user_titlestring
visibleboolean
warning_pointsinteger
Current warning points.
websitestring
view_urlstring
user_idinteger
usernamestring
message_countinteger
question_solution_countinteger
register_dateinteger
trophy_pointsinteger
is_staffboolean
reaction_scoreinteger
vote_scoreinteger
view_urlstring
Only included for reviews (not ratings)
resource_rating_idinteger
resource_idinteger
resource_version_idinteger
ratinginteger
rating_dateinteger
messagestring
version_stringstring
author_responsestring
rating_statestring
is_anonymousboolean
XFRM_ResourceRating
{
"Resource": {
"username": "string",
"description": "string",
"description_parsed": "string",
"description_attach_count": 0,
"DescriptionAttachments": [
{
"filename": "string",
"file_size": 0,
"height": 0,
"width": 0,
"thumbnail_url": "string",
"retina_thumbnail_url": "string",
"direct_url": "string",
"is_video": true,
"is_audio": true,
"attachment_id": 0,
"content_type": "string",
"content_id": 0,
"attach_date": 0,
"view_count": 0
}
],
"reaction_score": 0,
"update_count": 0,
"review_count": 0,
"current_download_url": "string",
"current_files": [
{}
],
"external_purchase_url": "string",
"is_watching": true,
"icon_url": "string",
"version": "string",
"custom_fields": {},
"tags": [
"string"
],
"prefix": "string",
"can_edit": true,
"can_edit_tags": true,
"can_edit_icon": true,
"can_soft_delete": true,
"can_hard_delete": true,
"can_download": true,
"can_view_description_attachments": true,
"view_url": "string",
"resource_id": 0,
"title": "string",
"tag_line": "string",
"user_id": 0,
"resource_state": "string",
"resource_type": "string",
"resource_date": 0,
"resource_category_id": 0,
"external_url": "string",
"price": 0,
"currency": "string",
"view_count": 0,
"download_count": 0,
"rating_count": 0,
"rating_avg": 0,
"rating_weighted": 0,
"last_update": 0,
"alt_support_url": "string",
"prefix_id": 0,
"featured": true,
"Category": {
"prefixes": [
{
"prefix_id": 0,
"title": "string",
"description": "string",
"usage_help": "string",
"is_usable": true,
"prefix_group_id": 0,
"display_order": 0,
"materialized_order": 0
}
],
"custom_fields": [
{}
],
"can_add": true,
"can_upload_images": true,
"view_url": "string",
"resource_category_id": 0,
"title": "string",
"description": "string",
"resource_count": 0,
"last_update": 0,
"last_resource_title": "string",
"last_resource_id": 0,
"allow_local": true,
"allow_external": true,
"allow_commercial_external": true,
"allow_fileless": true,
"min_tags": 0,
"enable_versioning": true,
"enable_support_url": true,
"parent_category_id": 0,
"display_order": 0
},
"User": {
"about": "string",
"activity_visible": true,
"age": 0,
"alert_optout": [
null
],
"allow_post_profile": "string",
"allow_receive_news_feed": "string",
"allow_send_personal_conversation": "string",
"allow_view_identities": "string",
"allow_view_profile": "string",
"avatar_urls": {},
"profile_banner_urls": {},
"can_ban": true,
"can_converse": true,
"can_edit": true,
"can_follow": true,
"can_ignore": true,
"can_post_profile": true,
"can_view_profile": true,
"can_view_profile_posts": true,
"can_warn": true,
"content_show_signature": true,
"creation_watch_state": "string",
"custom_fields": {},
"custom_title": "string",
"dob": {},
"email": "string",
"email_on_conversation": true,
"gravatar": "string",
"interaction_watch_state": true,
"is_admin": true,
"is_banned": true,
"is_discouraged": true,
"is_followed": true,
"is_ignored": true,
"is_moderator": true,
"is_super_admin": true,
"last_activity": 0,
"location": "string",
"push_on_conversation": true,
"push_optout": [
null
],
"receive_admin_email": true,
"secondary_group_ids": [
null
],
"show_dob_date": true,
"show_dob_year": true,
"signature": "string",
"timezone": "string",
"use_tfa": true,
"user_group_id": 0,
"user_state": "string",
"user_title": "string",
"visible": true,
"warning_points": 0,
"website": "string",
"view_url": "string",
"user_id": 0,
"username": "string",
"message_count": 0,
"question_solution_count": 0,
"register_date": 0,
"trophy_points": 0,
"is_staff": true,
"reaction_score": 0,
"vote_score": 0
}
},
"custom_fields": {},
"can_soft_delete": true,
"can_hard_delete": true,
"can_author_reply": true,
"AnonymousUser": {
"about": "string",
"activity_visible": true,
"age": 0,
"alert_optout": [
null
],
"allow_post_profile": "string",
"allow_receive_news_feed": "string",
"allow_send_personal_conversation": "string",
"allow_view_identities": "string",
"allow_view_profile": "string",
"avatar_urls": {},
"profile_banner_urls": {},
"can_ban": true,
"can_converse": true,
"can_edit": true,
"can_follow": true,
"can_ignore": true,
"can_post_profile": true,
"can_view_profile": true,
"can_view_profile_posts": true,
"can_warn": true,
"content_show_signature": true,
"creation_watch_state": "string",
"custom_fields": {},
"custom_title": "string",
"dob": {},
"email": "string",
"email_on_conversation": true,
"gravatar": "string",
"interaction_watch_state": true,
"is_admin": true,
"is_banned": true,
"is_discouraged": true,
"is_followed": true,
"is_ignored": true,
"is_moderator": true,
"is_super_admin": true,
"last_activity": 0,
"location": "string",
"push_on_conversation": true,
"push_optout": [
null
],
"receive_admin_email": true,
"secondary_group_ids": [
null
],
"show_dob_date": true,
"show_dob_year": true,
"signature": "string",
"timezone": "string",
"use_tfa": true,
"user_group_id": 0,
"user_state": "string",
"user_title": "string",
"visible": true,
"warning_points": 0,
"website": "string",
"view_url": "string",
"user_id": 0,
"username": "string",
"message_count": 0,
"question_solution_count": 0,
"register_date": 0,
"trophy_points": 0,
"is_staff": true,
"reaction_score": 0,
"vote_score": 0
},
"anonymous_user_id": 0,
"User": {
"about": "string",
"activity_visible": true,
"age": 0,
"alert_optout": [
null
],
"allow_post_profile": "string",
"allow_receive_news_feed": "string",
"allow_send_personal_conversation": "string",
"allow_view_identities": "string",
"allow_view_profile": "string",
"avatar_urls": {},
"profile_banner_urls": {},
"can_ban": true,
"can_converse": true,
"can_edit": true,
"can_follow": true,
"can_ignore": true,
"can_post_profile": true,
"can_view_profile": true,
"can_view_profile_posts": true,
"can_warn": true,
"content_show_signature": true,
"creation_watch_state": "string",
"custom_fields": {},
"custom_title": "string",
"dob": {},
"email": "string",
"email_on_conversation": true,
"gravatar": "string",
"interaction_watch_state": true,
"is_admin": true,
"is_banned": true,
"is_discouraged": true,
"is_followed": true,
"is_ignored": true,
"is_moderator": true,
"is_super_admin": true,
"last_activity": 0,
"location": "string",
"push_on_conversation": true,
"push_optout": [
null
],
"receive_admin_email": true,
"secondary_group_ids": [
null
],
"show_dob_date": true,
"show_dob_year": true,
"signature": "string",
"timezone": "string",
"use_tfa": true,
"user_group_id": 0,
"user_state": "string",
"user_title": "string",
"visible": true,
"warning_points": 0,
"website": "string",
"view_url": "string",
"user_id": 0,
"username": "string",
"message_count": 0,
"question_solution_count": 0,
"register_date": 0,
"trophy_points": 0,
"is_staff": true,
"reaction_score": 0,
"vote_score": 0
},
"view_url": "string",
"resource_rating_id": 0,
"resource_id": 0,
"resource_version_id": 0,
"rating": 0,
"rating_date": 0,
"message": "string",
"version_string": "string",
"author_response": "string",
"rating_state": "string",
"is_anonymous": true
}