GET Forms/Category

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
Match	MatchCriteriaStringType	None.
FormCategoryIDs	Collection of integer	None.
FormClass	byte	None.
CategoryName	string	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
FormBusinessUnits	Collection of integer	None.
Form	FindFormCriteria	None.
MaxRows	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of FormCategoryDto

Name	Type	Additional information
FormCategoryID	integer	None.
FormClass	FormClass	None.
CategoryName	string	None.
SortOrder	integer	None.
RecordState	FormRecordState	None.
Created	FormAuditDataDto	None.
LastUpdated	FormAuditDataDto	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "formCategoryID": 1,
    "formClass": 1,
    "categoryName": "sample string 2",
    "sortOrder": 3,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:53:28.7280648+00:00",
      "userName": "sample string 2"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:53:28.7280648+00:00",
      "userName": "sample string 2"
    }
  },
  {
    "formCategoryID": 1,
    "formClass": 1,
    "categoryName": "sample string 2",
    "sortOrder": 3,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:53:28.7280648+00:00",
      "userName": "sample string 2"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:53:28.7280648+00:00",
      "userName": "sample string 2"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfFormCategoryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
  <FormCategoryDto>
    <CategoryName>sample string 2</CategoryName>
    <Created>
      <DateUtc>2024-12-04T07:53:28.7280648+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <FormCategoryID>1</FormCategoryID>
    <FormClass>Client</FormClass>
    <LastUpdated>
      <DateUtc>2024-12-04T07:53:28.7280648+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <SortOrder>3</SortOrder>
  </FormCategoryDto>
  <FormCategoryDto>
    <CategoryName>sample string 2</CategoryName>
    <Created>
      <DateUtc>2024-12-04T07:53:28.7280648+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <FormCategoryID>1</FormCategoryID>
    <FormClass>Client</FormClass>
    <LastUpdated>
      <DateUtc>2024-12-04T07:53:28.7280648+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <SortOrder>3</SortOrder>
  </FormCategoryDto>
</ArrayOfFormCategoryDto>

application/x-compressed-json

Sample:

�{�{t�RZ~Q�sbIjz~Q������D('���K�J�%�*Y)'��*�e�+)�(�����)Y�(�&���uA���)JV�J)@FhI2�##]C#]�s+Sc+#=s#3m+���ũE8��Q:�$� ��F�ꌆ	F���1@,