GET Reporting/Comments/{projectDefinedId}?language={language}&latestDateTime={latestDateTime}&pageNumber={pageNumber}&numberPerPage={numberPerPage}&searchText={searchText}

Get the Comments available since the Latest DateTime that is passed in. This should use the datetime returned from GetCommentsCount call in order to maintain consistent values when getting the paged results.

Request Information

URI Parameters

Name	Description	Type	Additional information
projectDefinedId		string	Required
language		string	Required
latestDateTime	Latest DateTime of comment to return within the pages.	date	Required
pageNumber	The page number.	integer	Default value is 1
numberPerPage	The number of items per page.	integer	Default value is 50
searchText		string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of SMG.Report.Contracts.Comments.Comment

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Type": "sample string 2",
    "DateTime": "2024-04-26T09:42:53.6640729-05:00",
    "FileName": "sample string 4",
    "FilePath": "sample string 5",
    "Display": "sample string 6",
    "Name": "sample string 7",
    "Number": "sample string 8",
    "QID": 9,
    "QText": "sample string 10",
    "ResponseId": 11,
    "Skey": 12,
    "Text": "sample string 13",
    "UId": "sample string 14",
    "CCs": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "CCsExcludedFromEmail": [
      "sample string 1",
      "sample string 2"
    ],
    "IsPartOfSpecialHierarchy": true
  },
  {
    "Id": 1,
    "Type": "sample string 2",
    "DateTime": "2024-04-26T09:42:53.6640729-05:00",
    "FileName": "sample string 4",
    "FilePath": "sample string 5",
    "Display": "sample string 6",
    "Name": "sample string 7",
    "Number": "sample string 8",
    "QID": 9,
    "QText": "sample string 10",
    "ResponseId": 11,
    "Skey": 12,
    "Text": "sample string 13",
    "UId": "sample string 14",
    "CCs": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "CCsExcludedFromEmail": [
      "sample string 1",
      "sample string 2"
    ],
    "IsPartOfSpecialHierarchy": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMG.Report.Contracts.Comments">
  <Comment>
    <CCs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </CCs>
    <CCsExcludedFromEmail xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CCsExcludedFromEmail>
    <DateTime>2024-04-26T09:42:53.6640729-05:00</DateTime>
    <Display>sample string 6</Display>
    <FileName>sample string 4</FileName>
    <FilePath>sample string 5</FilePath>
    <Id>1</Id>
    <IsPartOfSpecialHierarchy>true</IsPartOfSpecialHierarchy>
    <Name>sample string 7</Name>
    <Number>sample string 8</Number>
    <QID>9</QID>
    <QText>sample string 10</QText>
    <ResponseId>11</ResponseId>
    <Skey>12</Skey>
    <Text>sample string 13</Text>
    <Type>sample string 2</Type>
    <UId>sample string 14</UId>
  </Comment>
  <Comment>
    <CCs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </CCs>
    <CCsExcludedFromEmail xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CCsExcludedFromEmail>
    <DateTime>2024-04-26T09:42:53.6640729-05:00</DateTime>
    <Display>sample string 6</Display>
    <FileName>sample string 4</FileName>
    <FilePath>sample string 5</FilePath>
    <Id>1</Id>
    <IsPartOfSpecialHierarchy>true</IsPartOfSpecialHierarchy>
    <Name>sample string 7</Name>
    <Number>sample string 8</Number>
    <QID>9</QID>
    <QText>sample string 10</QText>
    <ResponseId>11</ResponseId>
    <Skey>12</Skey>
    <Text>sample string 13</Text>
    <Type>sample string 2</Type>
    <UId>sample string 14</UId>
  </Comment>
</ArrayOfComment>