GET Notes/Note

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
Match	MatchCriteriaStringType	None.
NoteIDs	Collection of integer	None.
NoteDateUtcMin	date	None.
NoteDateUtcMax	date	None.
Subject	string	None.
Contents	string	None.
CustomStatus	string	None.
NoteTypeIDs	ListCriteriaOfInt32	None.
Entities	Collection of integer	None.
MaxRows	integer	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 NoteDTO

Name	Type	Additional information
NoteID	integer	None.
NoteDateUtc	date	None.
Subject	string	None.
Contents	string	None.
IsDraft	boolean	None.
CustomStatus	string	None.
RecordState	ClinicalRecordState	None.
RecordStateReason	string	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Entities	Collection of EntityNoteDTO	None.
Extensions	Collection of FormDataExtensionDto	None.
NoteTypes	Collection of NoteNoteTypeDTO	None.
FollowUpRequired	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "noteID": 1,
    "noteDateUtc": "2024-12-04T07:50:56.7844295+00:00",
    "subject": "sample string 3",
    "contents": "sample string 4",
    "isDraft": true,
    "customStatus": "sample string 6",
    "recordState": 1,
    "recordStateReason": "sample string 7",
    "createdByUserID": 8,
    "lastUpdatedByUserID": 9,
    "created": {
      "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
    },
    "entities": [
      {
        "entityID": 1,
        "entityType": 1,
        "noteID": 2,
        "noteTypeID": 3,
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      },
      {
        "entityID": 1,
        "entityType": 1,
        "noteID": 2,
        "noteTypeID": 3,
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      }
    ],
    "extensions": [
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        }
      },
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        }
      }
    ],
    "noteTypes": [
      {
        "noteID": 1,
        "noteTypeID": 2,
        "noteTypeName": "sample string 3",
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      },
      {
        "noteID": 1,
        "noteTypeID": 2,
        "noteTypeName": "sample string 3",
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      }
    ],
    "followUpRequired": true
  },
  {
    "noteID": 1,
    "noteDateUtc": "2024-12-04T07:50:56.7844295+00:00",
    "subject": "sample string 3",
    "contents": "sample string 4",
    "isDraft": true,
    "customStatus": "sample string 6",
    "recordState": 1,
    "recordStateReason": "sample string 7",
    "createdByUserID": 8,
    "lastUpdatedByUserID": 9,
    "created": {
      "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
    },
    "entities": [
      {
        "entityID": 1,
        "entityType": 1,
        "noteID": 2,
        "noteTypeID": 3,
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      },
      {
        "entityID": 1,
        "entityType": 1,
        "noteID": 2,
        "noteTypeID": 3,
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      }
    ],
    "extensions": [
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        }
      },
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2"
        }
      }
    ],
    "noteTypes": [
      {
        "noteID": 1,
        "noteTypeID": 2,
        "noteTypeName": "sample string 3",
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      },
      {
        "noteID": 1,
        "noteTypeID": 2,
        "noteTypeName": "sample string 3",
        "recordState": 1,
        "createdByUserID": 4,
        "lastUpdatedByUserID": 5,
        "created": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T07:50:56.7844295+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 7:50:56 AM"
        }
      }
    ],
    "followUpRequired": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfNoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <NoteDTO>
    <Contents>sample string 4</Contents>
    <Created>
      <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>8</CreatedByUserID>
    <CustomStatus>sample string 6</CustomStatus>
    <Entities>
      <EntityNoteDTO>
        <Created>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <EntityID>1</EntityID>
        <EntityType>Organization</EntityType>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+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:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <EntityID>1</EntityID>
        <EntityType>Organization</EntityType>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>5</LastUpdatedByUserID>
        <NoteID>2</NoteID>
        <NoteTypeID>3</NoteTypeID>
        <RecordState>Active</RecordState>
      </EntityNoteDTO>
    </Entities>
    <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
    </Extensions>
    <FollowUpRequired>true</FollowUpRequired>
    <IsDraft>true</IsDraft>
    <LastUpdated>
      <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>9</LastUpdatedByUserID>
    <NoteDateUtc>2024-12-04T07:50:56.7844295+00:00</NoteDateUtc>
    <NoteID>1</NoteID>
    <NoteTypes>
      <NoteNoteTypeDTO>
        <Created>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>5</LastUpdatedByUserID>
        <NoteID>1</NoteID>
        <NoteTypeID>2</NoteTypeID>
        <NoteTypeName>sample string 3</NoteTypeName>
        <RecordState>Active</RecordState>
      </NoteNoteTypeDTO>
      <NoteNoteTypeDTO>
        <Created>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>5</LastUpdatedByUserID>
        <NoteID>1</NoteID>
        <NoteTypeID>2</NoteTypeID>
        <NoteTypeName>sample string 3</NoteTypeName>
        <RecordState>Active</RecordState>
      </NoteNoteTypeDTO>
    </NoteTypes>
    <RecordState>Active</RecordState>
    <RecordStateReason>sample string 7</RecordStateReason>
    <Subject>sample string 3</Subject>
  </NoteDTO>
  <NoteDTO>
    <Contents>sample string 4</Contents>
    <Created>
      <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>8</CreatedByUserID>
    <CustomStatus>sample string 6</CustomStatus>
    <Entities>
      <EntityNoteDTO>
        <Created>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <EntityID>1</EntityID>
        <EntityType>Organization</EntityType>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+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:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <EntityID>1</EntityID>
        <EntityType>Organization</EntityType>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>5</LastUpdatedByUserID>
        <NoteID>2</NoteID>
        <NoteTypeID>3</NoteTypeID>
        <RecordState>Active</RecordState>
      </EntityNoteDTO>
    </Entities>
    <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T07:50:56.7844295+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
    </Extensions>
    <FollowUpRequired>true</FollowUpRequired>
    <IsDraft>true</IsDraft>
    <LastUpdated>
      <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>9</LastUpdatedByUserID>
    <NoteDateUtc>2024-12-04T07:50:56.7844295+00:00</NoteDateUtc>
    <NoteID>1</NoteID>
    <NoteTypes>
      <NoteNoteTypeDTO>
        <Created>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>5</LastUpdatedByUserID>
        <NoteID>1</NoteID>
        <NoteTypeID>2</NoteTypeID>
        <NoteTypeName>sample string 3</NoteTypeName>
        <RecordState>Active</RecordState>
      </NoteNoteTypeDTO>
      <NoteNoteTypeDTO>
        <Created>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>4</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T07:50:56.7844295+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>5</LastUpdatedByUserID>
        <NoteID>1</NoteID>
        <NoteTypeID>2</NoteTypeID>
        <NoteTypeName>sample string 3</NoteTypeName>
        <RecordState>Active</RecordState>
      </NoteNoteTypeDTO>
    </NoteTypes>
    <RecordState>Active</RecordState>
    <RecordStateReason>sample string 7</RecordStateReason>
    <Subject>sample string 3</Subject>
  </NoteDTO>
</ArrayOfNoteDTO>

application/x-compressed-json

Sample:

���N� �_����1��w��d�z1�+�lѠ-T��fٓy�#�
B7�fW����@�΁�����0��$Aϭ�!Vd�b����fp�0��Ñ硱a!p�,n�I�t��Y�G*Aٝ�׾�3E��5���T���JD�R��JaU��:^�����*�-{J��6khRD$��\a69rA��������&���
��%�H-TP�aQ�}gNu�����^�9�˝ې��H%�.��(��2feN6�c<h54ߍٯ㫁���LS:K��h�Hx����5��$D�[.�3J�䜲��tk�xjM����}�֊�����zp�Z�=O����ܑI��D�.HS�4ϧ䱠�ded�XV��5��U�U�-c�h�hX5jը�>m�J�F[��Y�F�1�ʸ