Help Page Home

ItemSummary

This class provides a view model for an item summary for the WebAPI. This class is specific to the WebAPI and so cannot be dependant on anything else: it needs to stay stable for this version of the API. Yes, it replicates other classes, but other classes are free to mutate. This one must stay locked.

NameDescriptionTypeAdditional information
Id

Gets or sets the Id of the Item.

string

None.

Title

Gets or sets the Title of the Item.

string

None.

Authors

Gets or sets the Name/Id pairs of the Item's authors.

Collection of NameIdPair

None.

Summary

Gets or sets the Item's Abstract.

string

None.

ContentType

Gets or sets the Item's Content Type Name/Id pair.

string

None.

DocType

Gets or sets the Item's Doc Type Name/Id pair.

NameIdPair

None.

Categories

Gets or sets the list of the Item's Category Name/Id pairs.

Collection of NameIdPair

None.

Tags

Gets or sets the list of the Item's Tag Name/Id pairs.

Collection of NameIdPair

None.

License

Gets or sets the Item's License Name/Id pair.

NameIdPair

None.

CreatedDate

Gets or sets the Item's Creation Date.

date

None.

ModifiedDate

Gets or sets the Item's Modification Date.

date

None.

ThreadEditor

Gets or sets the Name/Id pair for the member who last edited this Item's discussion thread, if applicable.

NameIdPair

None.

ThreadModifiedDate

Gets or sets the date this Item's discussion thread was edited, if applicable.

date

None.

Rating

Gets or sets this Item's Rating.

decimal number

None.

Votes

Gets or sets this Item's vote count.

integer

None.

Popularity

Gets or sets this Item's popularity score.

decimal number

None.

WebsiteLink

Gets or sets the url to the Item on the website.

string

None.

ApiLink

Gets or sets the link to the full item on the API.

string

None.

ParentId

Gets or sets the Id of the Parent Message or Article. Currently only valid for Messages.

integer

None.

ThreadId

Gets or sets the Id of the Original Message in the discussion thread. Currently only valid for Messages.

integer

None.

IndentLevel

Gets or sets the indent level of the message in the discussion. Currently only valid for Messages.

integer

None.