GET Forms/Section

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
Match	FormMatchCriteriaStringType	None.
FormSectionIDs	Collection of integer	None.
FormID	integer	None.
SectionName	string	None.
Type	FormSectionType	None.
Caption	string	None.
Introduction	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of FormSectionDto

Name	Type	Additional information
FormSectionID	integer	None.
FormID	integer	None.
SectionName	string	None.
Type	FormSectionType	None.
Caption	string	None.
Introduction	string	None.
SortOrder	integer	None.
AnnotationType	FormAnnotationType	None.
NumberType	FormNumberType	None.
NumberText	string	None.
CalculatedNumber	string	None.
Tips	string	None.
RecordState	FormRecordState	None.
Created	FormAuditDataDto	None.
LastUpdated	FormAuditDataDto	None.
IsPartialData	boolean	None.
IsVisible	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "formSectionID": 1,
    "formID": 2,
    "sectionName": "sample string 3",
    "type": 1,
    "caption": "sample string 4",
    "introduction": "sample string 5",
    "sortOrder": 6,
    "annotationType": 1,
    "numberType": 1,
    "numberText": "sample string 7",
    "calculatedNumber": "sample string 8",
    "tips": "sample string 9",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:07:27.1042195+00:00",
      "userName": "sample string 2"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:07:27.1042195+00:00",
      "userName": "sample string 2"
    },
    "isPartialData": true,
    "isVisible": true
  },
  {
    "formSectionID": 1,
    "formID": 2,
    "sectionName": "sample string 3",
    "type": 1,
    "caption": "sample string 4",
    "introduction": "sample string 5",
    "sortOrder": 6,
    "annotationType": 1,
    "numberType": 1,
    "numberText": "sample string 7",
    "calculatedNumber": "sample string 8",
    "tips": "sample string 9",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:07:27.1042195+00:00",
      "userName": "sample string 2"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:07:27.1042195+00:00",
      "userName": "sample string 2"
    },
    "isPartialData": true,
    "isVisible": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFormSectionDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
  <FormSectionDto>
    <AnnotationType>None</AnnotationType>
    <CalculatedNumber>sample string 8</CalculatedNumber>
    <Caption>sample string 4</Caption>
    <Created>
      <DateUtc>2024-12-04T08:07:27.1042195+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-04T08:07:27.1042195+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <NumberText>sample string 7</NumberText>
    <NumberType>None</NumberType>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" i:nil="true" />
    <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-04T08:07:27.1042195+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-04T08:07:27.1042195+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <NumberText>sample string 7</NumberText>
    <NumberType>None</NumberType>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Common.Collections" i:nil="true" />
    <RecordState>Active</RecordState>
    <SectionName>sample string 3</SectionName>
    <SortOrder>6</SortOrder>
    <Tips>sample string 9</Tips>
    <Type>Page</Type>
  </FormSectionDto>
</ArrayOfFormSectionDto>

application/x-compressed-json

Sample:

�푱N1�_��J�r�J��]X
R[Đ&E��N�OU}2�W ���ue������������O-5���x�]��SJ% ���i4$�t'��������k���:C>2���g�YRK|K	�c˦��o��7{��O|��J�`�`�zGТ$�]	�,ږ�&'�ڌ�X�>��ŎmSR��JMe��-�Z�/+Y�j9��RK����t���x׹߰���{V�
h�K��'�xj������?A�@��