GET v1/Contacts/{contactID}/Notes?pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&orderDirection={orderDirection}

Get a paged list of notes for a contact

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactID

Id of the contact

integer

Required

pageNumber

Page Number

integer

Default value is 1

pageSize

Page Size

integer

Default value is 25

orderBy

Oreder By

string

None.

orderDirection

Order Direction

string

None.

Body Parameters

None.

Response Information

Resource Description

Paged list of notes

PageOfOfNoteDTO
NameDescriptionTypeAdditional 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": "7ecc31a2-e90d-42c2-9cb1-13e830cd36e3",
          "BulkInsertSessionId": "dad6fea9-f081-40ce-8fc5-f19e37b9e4b6"
        },
        {
          "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": "7ecc31a2-e90d-42c2-9cb1-13e830cd36e3",
          "BulkInsertSessionId": "dad6fea9-f081-40ce-8fc5-f19e37b9e4b6"
        }
      ],
      "BulkInsertId": "a423749b-9366-48e0-84d8-8e98a4b8e8b8",
      "BulkInsertSessionId": "85c39199-fdae-4e23-8932-c6db8122a1d5"
    },
    {
      "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": "7ecc31a2-e90d-42c2-9cb1-13e830cd36e3",
          "BulkInsertSessionId": "dad6fea9-f081-40ce-8fc5-f19e37b9e4b6"
        },
        {
          "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": "7ecc31a2-e90d-42c2-9cb1-13e830cd36e3",
          "BulkInsertSessionId": "dad6fea9-f081-40ce-8fc5-f19e37b9e4b6"
        }
      ],
      "BulkInsertId": "a423749b-9366-48e0-84d8-8e98a4b8e8b8",
      "BulkInsertSessionId": "85c39199-fdae-4e23-8932-c6db8122a1d5"
    }
  ],
  "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>a423749b-9366-48e0-84d8-8e98a4b8e8b8</d2p1:BulkInsertId>
      <d2p1:BulkInsertSessionId>85c39199-fdae-4e23-8932-c6db8122a1d5</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>7ecc31a2-e90d-42c2-9cb1-13e830cd36e3</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>dad6fea9-f081-40ce-8fc5-f19e37b9e4b6</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>7ecc31a2-e90d-42c2-9cb1-13e830cd36e3</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>dad6fea9-f081-40ce-8fc5-f19e37b9e4b6</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>a423749b-9366-48e0-84d8-8e98a4b8e8b8</d2p1:BulkInsertId>
      <d2p1:BulkInsertSessionId>85c39199-fdae-4e23-8932-c6db8122a1d5</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>7ecc31a2-e90d-42c2-9cb1-13e830cd36e3</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>dad6fea9-f081-40ce-8fc5-f19e37b9e4b6</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>7ecc31a2-e90d-42c2-9cb1-13e830cd36e3</d2p1:BulkInsertId>
          <d2p1:BulkInsertSessionId>dad6fea9-f081-40ce-8fc5-f19e37b9e4b6</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>