GET Notes/Entity

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
Match	MatchCriteriaStringType	None.
EntityIDs	Collection of integer	None.
NoteIDs	Collection of integer	None.
NoteTypeIDs	ListCriteriaOfInt32	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of EntityNoteDTO

Name	Type	Additional information
EntityID	integer	None.
EntityType	EntityType	None.
NoteID	integer	None.
NoteTypeID	integer	None.
RecordState	ClinicalRecordState	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "entityID": 1,
    "entityType": 1,
    "noteID": 2,
    "noteTypeID": 3,
    "recordState": 1,
    "createdByUserID": 4,
    "lastUpdatedByUserID": 5,
    "created": {
      "dateUtc": "2024-12-04T07:54:16.2964273+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:16 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:54:16.2964273+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:16 AM"
    }
  },
  {
    "entityID": 1,
    "entityType": 1,
    "noteID": 2,
    "noteTypeID": 3,
    "recordState": 1,
    "createdByUserID": 4,
    "lastUpdatedByUserID": 5,
    "created": {
      "dateUtc": "2024-12-04T07:54:16.2964273+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:16 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:54:16.2964273+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:54:16 AM"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfEntityNoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <EntityNoteDTO>
    <Created>
      <DateUtc>2024-12-04T07:54:16.2964273+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>4</CreatedByUserID>
    <EntityID>1</EntityID>
    <EntityType>Organization</EntityType>
    <LastUpdated>
      <DateUtc>2024-12-04T07:54:16.2964273+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>5</LastUpdatedByUserID>
    <NoteID>2</NoteID>
    <NoteTypeID>3</NoteTypeID>
    <RecordState>Active</RecordState>
  </EntityNoteDTO>
  <EntityNoteDTO>
    <Created>
      <DateUtc>2024-12-04T07:54:16.2964273+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>4</CreatedByUserID>
    <EntityID>1</EntityID>
    <EntityType>Organization</EntityType>
    <LastUpdated>
      <DateUtc>2024-12-04T07:54:16.2964273+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>5</LastUpdatedByUserID>
    <NoteID>2</NoteID>
    <NoteTypeID>3</NoteTypeID>
    <RecordState>Active</RecordState>
  </EntityNoteDTO>
</ArrayOfEntityNoteDTO>

application/x-compressed-json

Sample:

�푽�0�_���EK)�i\t&��@cH�K[Bx2�W�
1!>�n����ޓ���~�@�&3�~�œ��Z�dYi	G���àdR��d����Øn�XKe=C.���t���^�X�8PB��R�����g�
�t0zB8!��nE1|-�:�H��WD�����d�*�KWle_��6���E�~�����6.ONj�y