Help Page Home

GetMessages

GET v1/Forum/{forumId}/{mode}?page={page}

Gets the latest Messages for a Forum.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
forumId

The ID of the Forum.

integer

Required

mode

The mode (Threads or Messages) for the list. Default to Threads.

ForumDisplayMode

Required

page

The page to display. Default 1.

integer

Default value is 1

Body Parameters

None.

Request Formats

Sample:
GET /v1/Forum/1159/Messages?page=1
Accept: application/json
Authorization: Bearer VSo3gOu-X7nimE0xcav8ftN_Cb0aAOKeNIdR88K ...
Host: testapi.codeproject.com
Pragma: no-cache
Sample:
GET /v1/Forum/1159/Messages?page=1
Accept: application/xml
Authorization: Bearer VSo3gOu-X7nimE0xcav8ftN_Cb0aAOKeNIdR88K ...
Host: testapi.codeproject.com
Pragma: no-cache

Response Information

Resource Description

An ItemSummaryListViewModel.

ItemSummaryListViewModel
NameDescriptionTypeAdditional information
Pagination

Gets or sets the pagination information for this page of Items.

PaginationInfo

None.

Items

Gets the array of Item Summaries in the current page.

Collection of ItemSummary

None.

Response Formats

Sample:
{
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "totalPages": 1,
    "totalItems": 2
  },
  "items": [
    {
      "id": "2_781740",
      "title": "Sample Article about source code control systems.",
      "authors": [
        {
          "name": "Bob the Alien",
          "id": 1
        },
        {
          "name": "Martian Manhunter",
          "id": 2
        }
      ],
      "summary": "This is the first sample item.",
      "contentType": "The content type such as 'article', 'forum message', ...",
      "docType": {
        "name": "Article",
        "id": 1
      },
      "categories": [
        {
          "name": "First Category",
          "id": 1
        },
        {
          "name": "Category 27",
          "id": 27
        }
      ],
      "tags": [
        {
          "name": "git",
          "id": 1001
        },
        {
          "name": "svn",
          "id": 1346
        }
      ],
      "license": {
        "name": "CPOL",
        "id": 0
      },
      "createdDate": "2013-12-28T01:23:45",
      "modifiedDate": "2014-03-14T14:22:00",
      "threadEditor": {
        "name": "Martian Manhunter",
        "id": 2
      },
      "threadModifiedDate": "2014-03-14T14:22:00",
      "rating": 4.85,
      "votes": 15,
      "popularity": 4.543,
      "websiteLink": "Url to the item on the CodeProject Site.",
      "apiLink": "This would be a URL to get the full item from the API.",
      "parentId": 42,
      "threadId": 13,
      "indentLevel": 2
    },
    {
      "id": "2_123456",
      "title": "Sample Article about super heros and crime.",
      "authors": [
        {
          "name": "Bruce Wayne",
          "id": 11
        },
        {
          "name": "Clark Kent",
          "id": 12
        }
      ],
      "summary": "This is the second sample item.",
      "contentType": "The content type such as 'article', 'forum message', ...",
      "docType": {
        "name": "Article",
        "id": 1
      },
      "categories": [
        {
          "name": "2nd Category",
          "id": 2
        },
        {
          "name": "Category 42",
          "id": 42
        }
      ],
      "tags": [
        {
          "name": "csi",
          "id": 1001
        },
        {
          "name": "heros",
          "id": 1346
        }
      ],
      "license": {
        "name": "CPOL",
        "id": 0
      },
      "createdDate": "2013-12-28T01:23:45",
      "modifiedDate": "2014-03-14T14:22:00",
      "threadEditor": {
        "name": "Clark Kent",
        "id": 12
      },
      "threadModifiedDate": "2014-03-14T14:22:00",
      "rating": 4.85,
      "votes": 42,
      "popularity": 4.543,
      "websiteLink": "Url to the item on the CodeProject Site.",
      "apiLink": "This would be a URL to get the full item from the API.",
      "parentId": 42,
      "threadId": 13,
      "indentLevel": 2
    }
  ]
}
Sample:
<ItemSummaryListViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodeProject.WebApi.Models">
  <Items>
    <ItemSummary>
      <ApiLink>This would be a URL to get the full item from the API.</ApiLink>
      <Authors>
        <NameIdPair>
          <Id>1</Id>
          <Name>Bob the Alien</Name>
        </NameIdPair>
        <NameIdPair>
          <Id>2</Id>
          <Name>Martian Manhunter</Name>
        </NameIdPair>
      </Authors>
      <Categories>
        <NameIdPair>
          <Id>1</Id>
          <Name>First Category</Name>
        </NameIdPair>
        <NameIdPair>
          <Id>27</Id>
          <Name>Category 27</Name>
        </NameIdPair>
      </Categories>
      <ContentType>The content type such as 'article', 'forum message', ...</ContentType>
      <CreatedDate>2013-12-28T01:23:45</CreatedDate>
      <DocType>
        <Id>1</Id>
        <Name>Article</Name>
      </DocType>
      <Id>2_781740</Id>
      <IndentLevel>2</IndentLevel>
      <License>
        <Id>0</Id>
        <Name>CPOL</Name>
      </License>
      <ModifiedDate>2014-03-14T14:22:00</ModifiedDate>
      <ParentId>42</ParentId>
      <Popularity>4.543</Popularity>
      <Rating>4.85</Rating>
      <Summary>This is the first sample item.</Summary>
      <Tags>
        <NameIdPair>
          <Id>1001</Id>
          <Name>git</Name>
        </NameIdPair>
        <NameIdPair>
          <Id>1346</Id>
          <Name>svn</Name>
        </NameIdPair>
      </Tags>
      <ThreadEditor>
        <Id>2</Id>
        <Name>Martian Manhunter</Name>
      </ThreadEditor>
      <ThreadId>13</ThreadId>
      <ThreadModifiedDate>2014-03-14T14:22:00</ThreadModifiedDate>
      <Title>Sample Article about source code control systems.</Title>
      <Votes>15</Votes>
      <WebsiteLink>Url to the item on the CodeProject Site.</WebsiteLink>
    </ItemSummary>
    <ItemSummary>
      <ApiLink>This would be a URL to get the full item from the API.</ApiLink>
      <Authors>
        <NameIdPair>
          <Id>11</Id>
          <Name>Bruce Wayne</Name>
        </NameIdPair>
        <NameIdPair>
          <Id>12</Id>
          <Name>Clark Kent</Name>
        </NameIdPair>
      </Authors>
      <Categories>
        <NameIdPair>
          <Id>2</Id>
          <Name>2nd Category</Name>
        </NameIdPair>
        <NameIdPair>
          <Id>42</Id>
          <Name>Category 42</Name>
        </NameIdPair>
      </Categories>
      <ContentType>The content type such as 'article', 'forum message', ...</ContentType>
      <CreatedDate>2013-12-28T01:23:45</CreatedDate>
      <DocType>
        <Id>1</Id>
        <Name>Article</Name>
      </DocType>
      <Id>2_123456</Id>
      <IndentLevel>2</IndentLevel>
      <License>
        <Id>0</Id>
        <Name>CPOL</Name>
      </License>
      <ModifiedDate>2014-03-14T14:22:00</ModifiedDate>
      <ParentId>42</ParentId>
      <Popularity>4.543</Popularity>
      <Rating>4.85</Rating>
      <Summary>This is the second sample item.</Summary>
      <Tags>
        <NameIdPair>
          <Id>1001</Id>
          <Name>csi</Name>
        </NameIdPair>
        <NameIdPair>
          <Id>1346</Id>
          <Name>heros</Name>
        </NameIdPair>
      </Tags>
      <ThreadEditor>
        <Id>12</Id>
        <Name>Clark Kent</Name>
      </ThreadEditor>
      <ThreadId>13</ThreadId>
      <ThreadModifiedDate>2014-03-14T14:22:00</ThreadModifiedDate>
      <Title>Sample Article about super heros and crime.</Title>
      <Votes>42</Votes>
      <WebsiteLink>Url to the item on the CodeProject Site.</WebsiteLink>
    </ItemSummary>
  </Items>
  <Pagination>
    <Page>1</Page>
    <PageSize>25</PageSize>
    <TotalItems>2</TotalItems>
    <TotalPages>1</TotalPages>
  </Pagination>
</ItemSummaryListViewModel>