GET v1/Policies/{policyID}/Notes?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}

Get notes for a Policy ID

Request Information

URI Parameters

Name	Description	Type	Additional information
policyID	Id of the policy	string	Required
pageNumber	Page number	string	Required
pageSize	Page size	string	Required
orderBy	Order by	string	Required
orderDirection	Order direction	string	Required

Body Parameters

None.

Response Information

Resource Description

List of notes for a policy id

PageOfOfNoteDTO

Name	Type	Additional information
Data	Collection of NoteDTO	None.
PageNumber	integer	None.
PagesTotal	integer	None.
TotalItems	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
DisplayMessage	string	None.
Links	Collection of PageLink	None.
Href	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "Id": 1,
      "Comment": "sample string 2",
      "CreatedBy": "sample string 3",
      "EmployeeId": 1,
      "CreatedOn": "sample string 4",
      "ParentId": 1,
      "AssignedPolicyId": 1,
      "AssignedContactId": 5,
      "Important": true,
      "RelatedNotes": [
        {
          "Id": 1,
          "Comment": "sample string 2",
          "CreatedBy": "sample string 3",
          "EmployeeId": 1,
          "CreatedOn": "sample string 4",
          "ParentId": 1,
          "AssignedPolicyId": 1,
          "AssignedContactId": 5,
          "Important": true,
          "BulkInsertId": "0b728a11-6036-4388-8689-9a55236e4f91",
          "BulkInsertSessionId": "fb3f7819-4a15-4501-8308-7e0ab521e45c"
        },
        {
          "Id": 1,
          "Comment": "sample string 2",
          "CreatedBy": "sample string 3",
          "EmployeeId": 1,
          "CreatedOn": "sample string 4",
          "ParentId": 1,
          "AssignedPolicyId": 1,
          "AssignedContactId": 5,
          "Important": true,
          "BulkInsertId": "0b728a11-6036-4388-8689-9a55236e4f91",
          "BulkInsertSessionId": "fb3f7819-4a15-4501-8308-7e0ab521e45c"
        }
      ],
      "BulkInsertId": "7393ebb1-bb2d-4bad-af0e-e23976138d88",
      "BulkInsertSessionId": "3790ee6a-3134-48b0-ba95-6a05bca49512"
    },
    {
      "Id": 1,
      "Comment": "sample string 2",
      "CreatedBy": "sample string 3",
      "EmployeeId": 1,
      "CreatedOn": "sample string 4",
      "ParentId": 1,
      "AssignedPolicyId": 1,
      "AssignedContactId": 5,
      "Important": true,
      "RelatedNotes": [
        {
          "Id": 1,
          "Comment": "sample string 2",
          "CreatedBy": "sample string 3",
          "EmployeeId": 1,
          "CreatedOn": "sample string 4",
          "ParentId": 1,
          "AssignedPolicyId": 1,
          "AssignedContactId": 5,
          "Important": true,
          "BulkInsertId": "0b728a11-6036-4388-8689-9a55236e4f91",
          "BulkInsertSessionId": "fb3f7819-4a15-4501-8308-7e0ab521e45c"
        },
        {
          "Id": 1,
          "Comment": "sample string 2",
          "CreatedBy": "sample string 3",
          "EmployeeId": 1,
          "CreatedOn": "sample string 4",
          "ParentId": 1,
          "AssignedPolicyId": 1,
          "AssignedContactId": 5,
          "Important": true,
          "BulkInsertId": "0b728a11-6036-4388-8689-9a55236e4f91",
          "BulkInsertSessionId": "fb3f7819-4a15-4501-8308-7e0ab521e45c"
        }
      ],
      "BulkInsertId": "7393ebb1-bb2d-4bad-af0e-e23976138d88",
      "BulkInsertSessionId": "3790ee6a-3134-48b0-ba95-6a05bca49512"
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:

<PageOfNoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
    <d2p1:NoteDTO>
      <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
      <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
      <d2p1:BulkInsertId>7393ebb1-bb2d-4bad-af0e-e23976138d88</d2p1:BulkInsertId>
      <d2p1:BulkInsertSessionId>3790ee6a-3134-48b0-ba95-6a05bca49512</d2p1:BulkInsertSessionId>
      <d2p1:Comment>sample string 2</d2p1:Comment>
      <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
      <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
      <d2p1:EmployeeId>1</d2p1:EmployeeId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Important>true</d2p1:Important>
      <d2p1:ParentId>1</d2p1:ParentId>
      <d2p1:RelatedNotes>
        <d2p1:RelatedNoteDTO>
          <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
          <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
          <d2p1:BulkInsertId>0b728a11-6036-4388-8689-9a55236e4f91</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>fb3f7819-4a15-4501-8308-7e0ab521e45c</d2p1:BulkInsertSessionId>
          <d2p1:Comment>sample string 2</d2p1:Comment>
          <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
          <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
          <d2p1:EmployeeId>1</d2p1:EmployeeId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Important>true</d2p1:Important>
          <d2p1:ParentId>1</d2p1:ParentId>
        </d2p1:RelatedNoteDTO>
        <d2p1:RelatedNoteDTO>
          <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
          <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
          <d2p1:BulkInsertId>0b728a11-6036-4388-8689-9a55236e4f91</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>fb3f7819-4a15-4501-8308-7e0ab521e45c</d2p1:BulkInsertSessionId>
          <d2p1:Comment>sample string 2</d2p1:Comment>
          <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
          <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
          <d2p1:EmployeeId>1</d2p1:EmployeeId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Important>true</d2p1:Important>
          <d2p1:ParentId>1</d2p1:ParentId>
        </d2p1:RelatedNoteDTO>
      </d2p1:RelatedNotes>
    </d2p1:NoteDTO>
    <d2p1:NoteDTO>
      <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
      <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
      <d2p1:BulkInsertId>7393ebb1-bb2d-4bad-af0e-e23976138d88</d2p1:BulkInsertId>
      <d2p1:BulkInsertSessionId>3790ee6a-3134-48b0-ba95-6a05bca49512</d2p1:BulkInsertSessionId>
      <d2p1:Comment>sample string 2</d2p1:Comment>
      <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
      <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
      <d2p1:EmployeeId>1</d2p1:EmployeeId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Important>true</d2p1:Important>
      <d2p1:ParentId>1</d2p1:ParentId>
      <d2p1:RelatedNotes>
        <d2p1:RelatedNoteDTO>
          <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
          <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
          <d2p1:BulkInsertId>0b728a11-6036-4388-8689-9a55236e4f91</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>fb3f7819-4a15-4501-8308-7e0ab521e45c</d2p1:BulkInsertSessionId>
          <d2p1:Comment>sample string 2</d2p1:Comment>
          <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
          <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
          <d2p1:EmployeeId>1</d2p1:EmployeeId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Important>true</d2p1:Important>
          <d2p1:ParentId>1</d2p1:ParentId>
        </d2p1:RelatedNoteDTO>
        <d2p1:RelatedNoteDTO>
          <d2p1:AssignedContactId>5</d2p1:AssignedContactId>
          <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
          <d2p1:BulkInsertId>0b728a11-6036-4388-8689-9a55236e4f91</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>fb3f7819-4a15-4501-8308-7e0ab521e45c</d2p1:BulkInsertSessionId>
          <d2p1:Comment>sample string 2</d2p1:Comment>
          <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
          <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
          <d2p1:EmployeeId>1</d2p1:EmployeeId>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Important>true</d2p1:Important>
          <d2p1:ParentId>1</d2p1:ParentId>
        </d2p1:RelatedNoteDTO>
      </d2p1:RelatedNotes>
    </d2p1:NoteDTO>
  </Data>
  <DisplayMessage>sample string 7</DisplayMessage>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Href>sample string 8</Href>
  <IsSuccess>true</IsSuccess>
  <Links>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
  </Links>
  <PageNumber>1</PageNumber>
  <PagesTotal>2</PagesTotal>
  <TotalItems>3</TotalItems>
</PageOfNoteDTO>