GET api/notes?referenceId={referenceId}&type={type}

GET: api/notes/ Get the notes related to specific object

Request Information

URI Parameters

Name	Description	Type	Additional information
referenceId		integer	Required
type		NoteReferenceTypeEnum	Required

Body Parameters

None.

Response Information

Resource Description

List of GenericNoteViewModel

Collection of GenericNoteViewModel

Name	Description	Type	Additional information
ReferenceObjectId		integer	None.
ReferenceObjectType		NoteReferenceTypeEnum	None.
Path		string	None.
CreatedBy	CreatedBy	string	None.
Id	Id	integer	None.
Note	Note	string	None.
IsSystemGenerated	IsSystemGenerated	boolean	None.
CreatedOn	CreatedOn	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "referenceObjectId": 1,
    "referenceObjectType": 1,
    "path": "sample string 2",
    "createdBy": "sample string 3",
    "id": 4,
    "note": "sample string 5",
    "isSystemGenerated": true,
    "createdOn": "2024-10-14T08:24:31.2000352-04:00"
  },
  {
    "referenceObjectId": 1,
    "referenceObjectType": 1,
    "path": "sample string 2",
    "createdBy": "sample string 3",
    "id": 4,
    "note": "sample string 5",
    "isSystemGenerated": true,
    "createdOn": "2024-10-14T08:24:31.2000352-04:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGenericNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Notes">
  <GenericNoteViewModel>
    <CreatedOn>2024-10-14T08:24:31.2000352-04:00</CreatedOn>
    <Id>4</Id>
    <IsSystemGenerated>true</IsSystemGenerated>
    <Note>sample string 5</Note>
    <CreatedBy>sample string 3</CreatedBy>
    <Path>sample string 2</Path>
    <ReferenceObjectId>1</ReferenceObjectId>
    <ReferenceObjectType>Policy</ReferenceObjectType>
  </GenericNoteViewModel>
  <GenericNoteViewModel>
    <CreatedOn>2024-10-14T08:24:31.2000352-04:00</CreatedOn>
    <Id>4</Id>
    <IsSystemGenerated>true</IsSystemGenerated>
    <Note>sample string 5</Note>
    <CreatedBy>sample string 3</CreatedBy>
    <Path>sample string 2</Path>
    <ReferenceObjectId>1</ReferenceObjectId>
    <ReferenceObjectType>Policy</ReferenceObjectType>
  </GenericNoteViewModel>
</ArrayOfGenericNoteViewModel>