POST Forms/Form?validateOnly={validateOnly}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
validateOnly | boolean |
Default value is False |
Body Parameters
FormDtoName | Description | Type | Additional information |
---|---|---|---|
FormID | integer |
None. |
|
BusinessUnits | Collection of integer |
None. |
|
Funders | Collection of integer |
None. |
|
AuthGroups | Collection of IAccessLevelAuthorization |
None. |
|
FormCategoryID | integer |
None. |
|
FormCategoryName | string |
None. |
|
FormName | string |
None. |
|
Version | string |
None. |
|
VersionMajor | byte |
None. |
|
VersionMinor | byte |
None. |
|
FormAccessType | FormAccessType |
None. |
|
FormClass | FormClass |
None. |
|
FormSubClass | FormSubClass |
None. |
|
FormType | FormType |
None. |
|
FormSubType | integer |
None. |
|
Type | string |
None. |
|
FormStatus | FormStatus |
None. |
|
EntryStatusType | FormEntryStatusType |
None. |
|
EntryReviewStatusType | FormEntryReviewStatusType |
None. |
|
Title | string |
None. |
|
DateType | FormDateType |
None. |
|
AutoNoteType | FormAutoNoteType |
None. |
|
AutoNoteTypeSubject | string |
None. |
|
AutoNoteTypeContents | string |
None. |
|
AutoNoteTypeID | integer |
None. |
|
CarePlanType | FormCarePlanType |
None. |
|
CarePlanMode | FormCarePlanMode |
None. |
|
CarePlanEnforceSaveMode | FormCarePlanEnforceSaveMode |
None. |
|
RecurrenceType | FormRecurrenceType |
None. |
|
DefaultDocument | boolean |
None. |
|
StartDateCaption | string |
None. |
|
StopDateCaption | string |
None. |
|
ExpandInformationSelection | boolean |
None. |
|
ShowNavigation | boolean |
None. |
|
ShowProgressBar | boolean |
None. |
|
ShowScores | boolean |
None. |
|
ShowNotes | boolean |
None. |
|
ShowClinicalParameterRanges | boolean |
None. |
|
ShowChanges | boolean |
None. |
|
ShowClientMedication | boolean |
None. |
|
RequireVisit | boolean |
None. |
|
SortOrder | integer |
None. |
|
ComplexityIndex | integer |
None. |
|
Tips | string |
None. |
|
Scores | Collection of FormScoreDto |
None. |
|
Dependencies | Collection of FormFieldLinkDependencyDto |
None. |
|
ValidationScript | string |
None. |
|
GlobalScript | string |
None. |
|
CarePlanScript | string |
None. |
|
AdditionalSourceForms | Collection of string |
None. |
|
RecordState | FormRecordState |
None. |
|
Created | FormAuditDataDto |
None. |
|
LastUpdated | FormAuditDataDto |
None. |
|
Sections | Collection of FormSectionDto |
None. |
|
Fields | Collection of FormFieldDto |
None. |
|
IsPartialData | boolean |
None. |
|
HasSubforms | boolean |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<FormDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms"> <AdditionalSourceForms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </AdditionalSourceForms> <AuthGroups xmlns:d2p1="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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1: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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <DateType>StartDateTimeAndStopDateTime</DateType> <DefaultDocument>false</DefaultDocument> <Dependencies> <FormFieldLinkDependencyDto> <Created> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d4p1="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:45:03.6062619+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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <ExpressionType>Answered</ExpressionType> <ExpressionValue xmlns:d4p1="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:45:03.6062619+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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Funders> <GlobalScript>sample string 26</GlobalScript> <HasSubforms>true</HasSubforms> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d2p1="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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <DataType>Numeric</DataType> <FormEntryScore> <Created> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>3</CreatedByUserID> <FormEntryID>1</FormEntryID> <FormScoreID>2</FormScoreID> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+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:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" i:nil="true" /> </FormEntryScore> <FormID>2</FormID> <FormScoreID>1</FormScoreID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <Ranges> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d6p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d6p1:Property> <d6p1:Name>Min</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1:Property> <d6p1:Property> <d6p1:Name>Max</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1:Property> </Props> <RecordState>Active</RecordState> </FormScoreRangeDto> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d6p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d6p1:Property> <d6p1:Name>Min</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1:Property> <d6p1:Property> <d6p1:Name>Max</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1: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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <DataType>Numeric</DataType> <FormEntryScore> <Created> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <CreatedByUserID>3</CreatedByUserID> <FormEntryID>1</FormEntryID> <FormScoreID>2</FormScoreID> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+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:d5p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" i:nil="true" /> </FormEntryScore> <FormID>2</FormID> <FormScoreID>1</FormScoreID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" /> <Ranges> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d6p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d6p1:Property> <d6p1:Name>Min</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1:Property> <d6p1:Property> <d6p1:Name>Max</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1:Property> </Props> <RecordState>Active</RecordState> </FormScoreRangeDto> <FormScoreRangeDto> <Caption>sample string 3</Caption> <Created> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormScoreID>2</FormScoreID> <FormScoreRangeID>1</FormScoreRangeID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Max /> <Min /> <Priority>sample string 6</Priority> <Props xmlns:d6p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections"> <d6p1:Property> <d6p1:Name>Min</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1:Property> <d6p1:Property> <d6p1:Name>Max</d6p1:Name> <d6p1:Value /> <d6p1:ValueForXML>System.Object</d6p1:ValueForXML> </d6p1: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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormID>1</FormID> <FormScriptID>1</FormScriptID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentType>Form</ParentType> <ParentTypeID>2</ParentTypeID> <ParentTypeName>sample string 3</ParentTypeName> <Props xmlns:d4p1="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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <FormID>1</FormID> <FormScriptID>1</FormScriptID> <IsPartialData>true</IsPartialData> <LastUpdated> <DateUtc>2024-12-04T07:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentType>Form</ParentType> <ParentTypeID>2</ParentTypeID> <ParentTypeName>sample string 3</ParentTypeName> <Props xmlns:d4p1="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:d4p1="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:d4p1="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:d4p1="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:45:03.6062619+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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <NumberText>sample string 7</NumberText> <NumberType>None</NumberType> <Props xmlns:d4p1="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:45:03.6062619+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:45:03.6062619+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <NumberText>sample string 7</NumberText> <NumberType>None</NumberType> <Props xmlns:d4p1="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> </FormDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/x-compressed-json
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | 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. |