POST Forms/FormEntry/InitializeNote
Request Information
URI Parameters
None.
Body Parameters
FormEntryDtoName | Description | Type | Additional information |
---|---|---|---|
Context | FormContext |
None. |
|
FormEntryID | integer |
None. |
|
PreviousFormEntryID | integer |
None. |
|
FormID | integer |
None. |
|
IsDraft | boolean |
None. |
|
Status | FormEntryStatus |
None. |
|
StatusReason | string |
None. |
|
StatusLastUpdatedByUserID | integer |
None. |
|
ReviewStatus | FormEntryReviewStatus |
None. |
|
ReviewStatusReason | string |
None. |
|
ReviewStatusLastUpdatedByUserID | integer |
None. |
|
StartDateUtc | date |
None. |
|
StopDateUtc | date |
None. |
|
DateSummary | string |
None. |
|
LockDateUtc | date |
None. |
|
CustomStatus | string |
None. |
|
CustomStatusReason | string |
None. |
|
ParentFormEntryID | integer |
None. |
|
ParentFieldID | integer |
None. |
|
RecordState | ClinicalFormRecordState |
None. |
|
CreatedByUserID | integer |
None. |
|
LastUpdatedByUserID | integer |
None. |
|
StatusLastUpdated | FormAuditDataOptionalDto |
None. |
|
ReviewStatusLastUpdated | FormAuditDataOptionalDto |
None. |
|
Entities | Collection of EntityFormDto |
None. |
|
Notes | Collection of FormEntryNoteDto |
None. |
|
ValidationResults | Collection of FormEntryValidationResultDto |
None. |
|
EventRecurrences | Collection of FormEntryEventRecurrenceDto |
None. |
|
Events | Collection of FormEntryEventDto |
None. |
|
Form | FormDto |
None. |
|
Parameters | Collection of FormFieldParameterDto |
None. |
|
Created | FormAuditDataDto |
None. |
|
LastUpdated | FormAuditDataDto |
None. |
|
RecalculateIndex | integer |
None. |
|
Permissions | FormEntryPermissionsDto |
None. |
|
FormEntryType | FormEntryType |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<FormEntryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms"> <Context> <UserShortDatePattern>sample string 2</UserShortDatePattern> <UserShortTimePattern>sample string 3</UserShortTimePattern> <UserTzid>sample string 1</UserTzid> </Context> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>10</CreatedByUserID> <CustomStatus>sample string 8</CustomStatus> <CustomStatusReason>sample string 9</CustomStatusReason> <DateSummary>52a57ple 52ArinA.D. 2 52a57ple 52ArinA.D. 3 - 52a57ple 52ArinA.D. 2 52a57ple 52ArinA.D. 3</DateSummary> <Entities> <EntityFormDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>5</CreatedByUserID> <Entity /> <EntityFolderID>1</EntityFolderID> <EntityID>1</EntityID> <EntityType>2</EntityType> <FormEntryID>3</FormEntryID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>6</LastUpdatedByUserID> <RecordState>Active</RecordState> </EntityFormDto> <EntityFormDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>5</CreatedByUserID> <Entity /> <EntityFolderID>1</EntityFolderID> <EntityID>1</EntityID> <EntityType>2</EntityType> <FormEntryID>3</FormEntryID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>6</LastUpdatedByUserID> <RecordState>Active</RecordState> </EntityFormDto> </Entities> <EventRecurrences> <FormEntryEventRecurrenceDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <EventRecurrence /> <EventRecurrenceID>3</EventRecurrenceID> <FormEntryEventRecurrenceID>1</FormEntryEventRecurrenceID> <FormEntryID>2</FormEntryID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" i:nil="true" /> <RecordState>Active</RecordState> </FormEntryEventRecurrenceDto> <FormEntryEventRecurrenceDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <EventRecurrence /> <EventRecurrenceID>3</EventRecurrenceID> <FormEntryEventRecurrenceID>1</FormEntryEventRecurrenceID> <FormEntryID>2</FormEntryID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" i:nil="true" /> <RecordState>Active</RecordState> </FormEntryEventRecurrenceDto> </EventRecurrences> <Events> <FormEntryEventDto> <ClientID>1</ClientID> <ClientOrderID>1</ClientOrderID> <EventFormID>1</EventFormID> <EventID>2</EventID> <EventStatus>Incomplete</EventStatus> <IsRequiredForCompletion>true</IsRequiredForCompletion> <IsRequiredForVerification>true</IsRequiredForVerification> <RoleID>1</RoleID> <ServiceID>1</ServiceID> </FormEntryEventDto> <FormEntryEventDto> <ClientID>1</ClientID> <ClientOrderID>1</ClientOrderID> <EventFormID>1</EventFormID> <EventID>2</EventID> <EventStatus>Incomplete</EventStatus> <IsRequiredForCompletion>true</IsRequiredForCompletion> <IsRequiredForVerification>true</IsRequiredForVerification> <RoleID>1</RoleID> <ServiceID>1</ServiceID> </FormEntryEventDto> </Events> <Form> <AdditionalSourceForms xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AdditionalSourceForms> <AuthGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <AutoNoteType>NoNote</AutoNoteType> <AutoNoteTypeContents i:nil="true" /> <AutoNoteTypeID i:nil="true" /> <AutoNoteTypeSubject i:nil="true" /> <BusinessUnits xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </BusinessUnits> <CarePlanEnforceSaveMode i:nil="true" /> <CarePlanMode>Legacy</CarePlanMode> <CarePlanScript>sample string 27</CarePlanScript> <CarePlanType>NoCarePlan</CarePlanType> <ComplexityIndex>23</ComplexityIndex> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <DateType>StartDateTimeAndStopDateTime</DateType> <DefaultDocument>false</DefaultDocument> <Dependencies> <FormFieldLinkDependencyDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <FormFieldLinkFieldName>sample string 3</FormFieldLinkFieldName> <FormFieldLinkID>2</FormFieldLinkID> <FormID>1</FormID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentFormFieldLinkFieldName>sample string 5</ParentFormFieldLinkFieldName> <ParentFormFieldLinkID>4</ParentFormFieldLinkID> <RecordState>Active</RecordState> </FormFieldLinkDependencyDto> <FormFieldLinkDependencyDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <FormFieldLinkFieldName>sample string 3</FormFieldLinkFieldName> <FormFieldLinkID>2</FormFieldLinkID> <FormID>1</FormID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentFormFieldLinkFieldName>sample string 5</ParentFormFieldLinkFieldName> <ParentFormFieldLinkID>4</ParentFormFieldLinkID> <RecordState>Active</RecordState> </FormFieldLinkDependencyDto> </Dependencies> <EntryReviewStatusType>Auto</EntryReviewStatusType> <EntryStatusType>Simple</EntryStatusType> <ExpandInformationSelection>false</ExpandInformationSelection> <Fields i:nil="true" /> <FormAccessType>System</FormAccessType> <FormCategoryID>1</FormCategoryID> <FormCategoryName>sample string 2</FormCategoryName> <FormClass>Client</FormClass> <FormID>1</FormID> <FormName>sample string 3</FormName> <FormStatus>Build</FormStatus> <FormSubClass>Client</FormSubClass> <FormSubType>6</FormSubType> <FormType>Extensions</FormType> <Funders xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </Funders> <GlobalScript>sample string 26</GlobalScript> <HasSubforms>true</HasSubforms> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <RecurrenceType>NoRecurrence</RecurrenceType> <RequireVisit>false</RequireVisit> <Scores> <FormScoreDto> <CalculateScript>sample string 9</CalculateScript> <CalculationSortOrder>7</CalculationSortOrder> <Caption>sample string 4</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <DataType>Numeric</DataType> <FormEntryScore> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>3</CreatedByUserID> <FormEntryID>1</FormEntryID> <FormScoreID>2</FormScoreID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>4</LastUpdatedByUserID> <RecordState>Active</RecordState> <Result> <Description>sample string 2</Description> <Value /> </Result> <ResultData xmlns:d6p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> </FormEntryScore> <FormID>2</FormID> <FormScoreID>1</FormScoreID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <Ranges> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d7p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d7p1:Property> <d7p1:Name>Min</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> <d7p1:Property> <d7p1:Name>Max</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> </Props> <RecordState>Active</RecordState> </FormScoreRangeDto> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d7p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d7p1:Property> <d7p1:Name>Min</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> <d7p1:Property> <d7p1:Name>Max</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> </Props> <RecordState>Active</RecordState> </FormScoreRangeDto> </Ranges> <RecordState>Active</RecordState> <ScoreGroup>sample string 5</ScoreGroup> <ScoreName>sample string 3</ScoreName> <SortOrder>6</SortOrder> <Tips>sample string 8</Tips> </FormScoreDto> <FormScoreDto> <CalculateScript>sample string 9</CalculateScript> <CalculationSortOrder>7</CalculationSortOrder> <Caption>sample string 4</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <DataType>Numeric</DataType> <FormEntryScore> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>3</CreatedByUserID> <FormEntryID>1</FormEntryID> <FormScoreID>2</FormScoreID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>4</LastUpdatedByUserID> <RecordState>Active</RecordState> <Result> <Description>sample string 2</Description> <Value /> </Result> <ResultData xmlns:d6p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> </FormEntryScore> <FormID>2</FormID> <FormScoreID>1</FormScoreID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <Ranges> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d7p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d7p1:Property> <d7p1:Name>Min</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> <d7p1:Property> <d7p1:Name>Max</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> </Props> <RecordState>Active</RecordState> </FormScoreRangeDto> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d7p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d7p1:Property> <d7p1:Name>Min</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> <d7p1:Property> <d7p1:Name>Max</d7p1:Name> <d7p1:Value /> <d7p1:ValueForXML>System.Object</d7p1:ValueForXML> </d7p1:Property> </Props> <RecordState>Active</RecordState> </FormScoreRangeDto> </Ranges> <RecordState>Active</RecordState> <ScoreGroup>sample string 5</ScoreGroup> <ScoreName>sample string 3</ScoreName> <SortOrder>6</SortOrder> <Tips>sample string 8</Tips> </FormScoreDto> </Scores> <Scripts> <FormScriptDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormID>1</FormID> <FormScriptID>1</FormScriptID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentType>Form</ParentType> <ParentTypeID>2</ParentTypeID> <ParentTypeName>sample string 3</ParentTypeName> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <ScriptCode>sample string 4</ScriptCode> <ScriptType>Visible</ScriptType> </FormScriptDto> <FormScriptDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormID>1</FormID> <FormScriptID>1</FormScriptID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentType>Form</ParentType> <ParentTypeID>2</ParentTypeID> <ParentTypeName>sample string 3</ParentTypeName> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <ScriptCode>sample string 4</ScriptCode> <ScriptType>Visible</ScriptType> </FormScriptDto> <FormScriptDto> <Created> <DateUtc>0001-01-01T00:00:00</DateUtc> <UserName i:nil="true" /> </Created> <FormID>0</FormID> <FormScriptID>0</FormScriptID> <IsPartialData>false</IsPartialData> <LastUpdated> <DateUtc>0001-01-01T00:00:00</DateUtc> <UserName i:nil="true" /> </LastUpdated> <ParentType>Form</ParentType> <ParentTypeID>1</ParentTypeID> <ParentTypeName i:nil="true" /> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <ScriptCode>sample string 25</ScriptCode> <ScriptType>Validation</ScriptType> </FormScriptDto> <FormScriptDto> <Created> <DateUtc>0001-01-01T00:00:00</DateUtc> <UserName i:nil="true" /> </Created> <FormID>0</FormID> <FormScriptID>0</FormScriptID> <IsPartialData>false</IsPartialData> <LastUpdated> <DateUtc>0001-01-01T00:00:00</DateUtc> <UserName i:nil="true" /> </LastUpdated> <ParentType>Form</ParentType> <ParentTypeID>1</ParentTypeID> <ParentTypeName i:nil="true" /> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <ScriptCode>sample string 26</ScriptCode> <ScriptType>Global</ScriptType> </FormScriptDto> <FormScriptDto> <Created> <DateUtc>0001-01-01T00:00:00</DateUtc> <UserName i:nil="true" /> </Created> <FormID>0</FormID> <FormScriptID>0</FormScriptID> <IsPartialData>false</IsPartialData> <LastUpdated> <DateUtc>0001-01-01T00:00:00</DateUtc> <UserName i:nil="true" /> </LastUpdated> <ParentType>Form</ParentType> <ParentTypeID>1</ParentTypeID> <ParentTypeName i:nil="true" /> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <ScriptCode>sample string 27</ScriptCode> <ScriptType>CarePlan</ScriptType> </FormScriptDto> </Scripts> <Sections> <FormSectionDto> <AnnotationType>None</AnnotationType> <CalculatedNumber>sample string 8</CalculatedNumber> <Caption>sample string 4</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormID>2</FormID> <FormSectionID>1</FormSectionID> <Introduction>sample string 5</Introduction> <IsPartialData>true</IsPartialData> <IsVisible>true</IsVisible> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <NumberText>sample string 7</NumberText> <NumberType>None</NumberType> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <SectionName>sample string 3</SectionName> <SortOrder>6</SortOrder> <Tips>sample string 9</Tips> <Type>Page</Type> </FormSectionDto> <FormSectionDto> <AnnotationType>None</AnnotationType> <CalculatedNumber>sample string 8</CalculatedNumber> <Caption>sample string 4</Caption> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormID>2</FormID> <FormSectionID>1</FormSectionID> <Introduction>sample string 5</Introduction> <IsPartialData>true</IsPartialData> <IsVisible>true</IsVisible> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <NumberText>sample string 7</NumberText> <NumberType>None</NumberType> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <RecordState>Active</RecordState> <SectionName>sample string 3</SectionName> <SortOrder>6</SortOrder> <Tips>sample string 9</Tips> <Type>Page</Type> </FormSectionDto> </Sections> <ShowChanges>true</ShowChanges> <ShowClientMedication>false</ShowClientMedication> <ShowClinicalParameterRanges>false</ShowClinicalParameterRanges> <ShowNavigation>true</ShowNavigation> <ShowNotes>true</ShowNotes> <ShowProgressBar>true</ShowProgressBar> <ShowScores>true</ShowScores> <SortOrder>22</SortOrder> <StartDateCaption>Start</StartDateCaption> <StopDateCaption>Stop</StopDateCaption> <Tips>sample string 24</Tips> <Title>sample string 7</Title> <ValidationScript>sample string 25</ValidationScript> <VersionMajor>64</VersionMajor> <VersionMinor>64</VersionMinor> </Form> <FormEntryID>1</FormEntryID> <FormEntryType>Client</FormEntryType> <FormID>2</FormID> <IsDraft>true</IsDraft> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>11</LastUpdatedByUserID> <LockDateUtc>2024-12-04T07:57:52.8867159+00:00</LockDateUtc> <Notes> <FormEntryNoteDto> <Contents>sample string 5</Contents> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>6</CreatedByUserID> <FormEntryID>2</FormEntryID> <FormEntryNoteID>1</FormEntryNoteID> <IsFollowupRequired>true</IsFollowupRequired> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>7</LastUpdatedByUserID> <ParentKey>sample string 3</ParentKey> <ParentType>Entry</ParentType> <RecordState>Active</RecordState> </FormEntryNoteDto> <FormEntryNoteDto> <Contents>sample string 5</Contents> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>6</CreatedByUserID> <FormEntryID>2</FormEntryID> <FormEntryNoteID>1</FormEntryNoteID> <IsFollowupRequired>true</IsFollowupRequired> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>7</LastUpdatedByUserID> <ParentKey>sample string 3</ParentKey> <ParentType>Entry</ParentType> <RecordState>Active</RecordState> </FormEntryNoteDto> </Notes> <Parameters i:nil="true" /> <ParentFieldID>1</ParentFieldID> <ParentFormEntryID>1</ParentFormEntryID> <Permissions> <CanArchive>true</CanArchive> <CanComplete>true</CanComplete> <CanDelete>true</CanDelete> <CanEditComplete>true</CanEditComplete> <CanMarkInError>true</CanMarkInError> <CanRead>true</CanRead> <CanWrite>true</CanWrite> </Permissions> <PreviousFormEntryID>1</PreviousFormEntryID> <RecalculateIndex>1</RecalculateIndex> <RecordState>Active</RecordState> <ReviewStatus>NotReviewed</ReviewStatus> <ReviewStatusLastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 1</UserName> </ReviewStatusLastUpdated> <ReviewStatusLastUpdatedByUserID>1</ReviewStatusLastUpdatedByUserID> <ReviewStatusReason>sample string 5</ReviewStatusReason> <StartDateUtc>2024-12-04T07:57:52.8867159+00:00</StartDateUtc> <Status>Incomplete</Status> <StatusLastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 1</UserName> </StatusLastUpdated> <StatusLastUpdatedByUserID>1</StatusLastUpdatedByUserID> <StatusReason>sample string 4</StatusReason> <StopDateUtc>2024-12-04T07:57:52.8867159+00:00</StopDateUtc> <ValidationResults> <FormEntryValidationResultDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>6</CreatedByUserID> <Details>sample string 5</Details> <FormEntryID>2</FormEntryID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>7</LastUpdatedByUserID> <Message>sample string 4</Message> <ParentKey>sample string 3</ParentKey> <ParentType>Entry</ParentType> <RecordState>Active</RecordState> <Severity>Debug</Severity> <ValidationResultID>1</ValidationResultID> </FormEntryValidationResultDto> <FormEntryValidationResultDto> <Created> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>6</CreatedByUserID> <Details>sample string 5</Details> <FormEntryID>2</FormEntryID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.8867159+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>7</LastUpdatedByUserID> <Message>sample string 4</Message> <ParentKey>sample string 3</ParentKey> <ParentType>Entry</ParentType> <RecordState>Active</RecordState> <Severity>Debug</Severity> <ValidationResultID>1</ValidationResultID> </FormEntryValidationResultDto> </ValidationResults> <WasDraft>true</WasDraft> </FormEntryDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/x-compressed-json
Sample:
Sample not available.
Response Information
Resource Description
NoteDTOName | Description | 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:57:52.9923238+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:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" }, "entities": [ { "entityID": 1, "entityType": 1, "noteID": 2, "noteTypeID": 3, "recordState": 1, "createdByUserID": 4, "lastUpdatedByUserID": 5, "created": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" } }, { "entityID": 1, "entityType": 1, "noteID": 2, "noteTypeID": 3, "recordState": 1, "createdByUserID": 4, "lastUpdatedByUserID": 5, "created": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" } } ], "extensions": [ { "entityID": 1, "entityID2": 2, "formFieldLinkID": 3, "recordState": 1, "created": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2" }, "lastUpdated": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2" } }, { "entityID": 1, "entityID2": 2, "formFieldLinkID": 3, "recordState": 1, "created": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2" }, "lastUpdated": { "dateUtc": "2024-12-04T07:57:52.9923238+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:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" } }, { "noteID": 1, "noteTypeID": 2, "noteTypeName": "sample string 3", "recordState": 1, "createdByUserID": 4, "lastUpdatedByUserID": 5, "created": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:57:52.9923238+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:57:52 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:57:52.9923238+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>8</CreatedByUserID> <CustomStatus>sample string 6</CustomStatus> <Entities> <EntityNoteDTO> <Created> <DateUtc>2024-12-04T07:57:52.9923238+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>4</CreatedByUserID> <EntityID>1</EntityID> <EntityType>Organization</EntityType> <LastUpdated> <DateUtc>2024-12-04T07:57:52.9923238+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:57:52.9923238+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>4</CreatedByUserID> <EntityID>1</EntityID> <EntityType>Organization</EntityType> <LastUpdated> <DateUtc>2024-12-04T07:57:52.9923238+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:57:52.9923238+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:57:52.9923238+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:57:52.9923238+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:57:52.9923238+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:57:52.9923238+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <LastUpdatedByUserID>9</LastUpdatedByUserID> <NoteDateUtc>2024-12-04T07:57:52.9923238+00:00</NoteDateUtc> <NoteID>1</NoteID> <NoteTypes> <NoteNoteTypeDTO> <Created> <DateUtc>2024-12-04T07:57:52.9923238+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>4</CreatedByUserID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.9923238+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:57:52.9923238+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>4</CreatedByUserID> <LastUpdated> <DateUtc>2024-12-04T07:57:52.9923238+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-compressed-json
Sample:
� ��N�0�_��V�Xan�NCL��s\�]T83Uh�-Q��ɼ�|[��&��d&�!ᢧ���������@�+���e3 B!a{��8���}�������8��8�F2��Hi�$i��%����ru.�LS���t��@��~Q��6��������?�z�@iu+� ����� �(B �Lrh��Hf�n�h�E�ſZ�\�qCR�9���)E=gqf�p��OX����k�ܱxv4D�(h0w�*(V� �E��c2�j�~�u|50^�~����ni���<I9k,�q�K s.�K I|E���T:�?\������<�������t]t[5�w,w��V�a���q!��� I�K�M�9�¸2���OP���