GET api/GetWorkflowComments?workflowId={workflowId}&documentId={documentId}&ReferenceNo={ReferenceNo}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workflowId

integer

Default value is 0

documentId

integer

Default value is 0

ReferenceNo

string

Default value is

Body Parameters

None.

Response Information

Resource Description

ReturnObjectOfListOfUserComment
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Messages

Collection of string

None.

ErrorCode

integer

None.

Response

Collection of UserComment

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCode": 2,
  "Response": [
    {
      "DocumentName": "sample string 1",
      "DocumentId": "sample string 2",
      "Comments": [
        {
          "Comment": "sample string 1",
          "UserName": "sample string 2",
          "Emaild": "sample string 3",
          "SubscriberId": "sample string 4",
          "CommentTime": "sample string 5",
          "CommentId": "sample string 6",
          "IsReviewerComment": true
        },
        {
          "Comment": "sample string 1",
          "UserName": "sample string 2",
          "Emaild": "sample string 3",
          "SubscriberId": "sample string 4",
          "CommentTime": "sample string 5",
          "CommentId": "sample string 6",
          "IsReviewerComment": true
        }
      ]
    },
    {
      "DocumentName": "sample string 1",
      "DocumentId": "sample string 2",
      "Comments": [
        {
          "Comment": "sample string 1",
          "UserName": "sample string 2",
          "Emaild": "sample string 3",
          "SubscriberId": "sample string 4",
          "CommentTime": "sample string 5",
          "CommentId": "sample string 6",
          "IsReviewerComment": true
        },
        {
          "Comment": "sample string 1",
          "UserName": "sample string 2",
          "Emaild": "sample string 3",
          "SubscriberId": "sample string 4",
          "CommentTime": "sample string 5",
          "CommentId": "sample string 6",
          "IsReviewerComment": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<ReturnObjectOfListOfUserComment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccess>true</IsSuccess>
  <Messages>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Messages>
  <ErrorCode>2</ErrorCode>
  <Response>
    <UserComment>
      <DocumentName>sample string 1</DocumentName>
      <DocumentId>sample string 2</DocumentId>
      <Comments>
        <Comments>
          <Comment>sample string 1</Comment>
          <UserName>sample string 2</UserName>
          <Emaild>sample string 3</Emaild>
          <SubscriberId>sample string 4</SubscriberId>
          <CommentTime>sample string 5</CommentTime>
          <CommentId>sample string 6</CommentId>
          <IsReviewerComment>true</IsReviewerComment>
        </Comments>
        <Comments>
          <Comment>sample string 1</Comment>
          <UserName>sample string 2</UserName>
          <Emaild>sample string 3</Emaild>
          <SubscriberId>sample string 4</SubscriberId>
          <CommentTime>sample string 5</CommentTime>
          <CommentId>sample string 6</CommentId>
          <IsReviewerComment>true</IsReviewerComment>
        </Comments>
      </Comments>
    </UserComment>
    <UserComment>
      <DocumentName>sample string 1</DocumentName>
      <DocumentId>sample string 2</DocumentId>
      <Comments>
        <Comments>
          <Comment>sample string 1</Comment>
          <UserName>sample string 2</UserName>
          <Emaild>sample string 3</Emaild>
          <SubscriberId>sample string 4</SubscriberId>
          <CommentTime>sample string 5</CommentTime>
          <CommentId>sample string 6</CommentId>
          <IsReviewerComment>true</IsReviewerComment>
        </Comments>
        <Comments>
          <Comment>sample string 1</Comment>
          <UserName>sample string 2</UserName>
          <Emaild>sample string 3</Emaild>
          <SubscriberId>sample string 4</SubscriberId>
          <CommentTime>sample string 5</CommentTime>
          <CommentId>sample string 6</CommentId>
          <IsReviewerComment>true</IsReviewerComment>
        </Comments>
      </Comments>
    </UserComment>
  </Response>
</ReturnObjectOfListOfUserComment>