POST Notes/Note?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

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.

Request Formats

application/json, text/json

Sample:

{
  "noteID": 1,
  "noteDateUtc": "2024-12-04T07:47:09.996249+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:47:09.996249+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:47:09.996249+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
  },
  "entities": [
    {
      "entityID": 1,
      "entityType": 1,
      "noteID": 2,
      "noteTypeID": 3,
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      }
    },
    {
      "entityID": 1,
      "entityType": 1,
      "noteID": 2,
      "noteTypeID": 3,
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      }
    }
  ],
  "extensions": [
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2"
      }
    },
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:47:09.996249+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:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      }
    },
    {
      "noteID": 1,
      "noteTypeID": 2,
      "noteTypeName": "sample string 3",
      "recordState": 1,
      "createdByUserID": 4,
      "lastUpdatedByUserID": 5,
      "created": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:47:09.996249+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:47:09 AM"
      }
    }
  ],
  "followUpRequired": true
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��V�N�0��*W:�ee���*�I�a�'�Ch=h����jڗq���v��nHHC�Poq��>��N�_��
�=�Z�TC�c �����&xx��Ǿ? ��q�1r�*� ��h���(-�w����k�pz��T(��Բ�-�ٍ��h�/!2�����c�J�Ʃ�� ���2R m��.J��Q�l��+,
�(�M

s�5͠A�T��2*˦��鑮׵_p�W;gWh����	�f`d���F���ژ�9���zH�����7�k���夕e;���jq0ZLM�_̨SL�m2
I%�L��A�\2���&����r���q�ӯ������~��Z�m����ak�q�����)���9���T0iI�����(�

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.