PUT api/CustomForm

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomFormId	globally unique identifier	Required
PatientId	globally unique identifier	Required
EncounterId	globally unique identifier	None.
Id	globally unique identifier	None.
CustomFormInputDetails	Collection of CustomFormInputDetail	None.
Note	string	String length: inclusive between 0 and 500
StatusId	integer	None.
ModifiedBy	globally unique identifier	None.
ModifiedOn	date	None.
EncounterTypeId	globally unique identifier	None.
ModuleId	integer	Required
ModuleName	string	None.
RecordId	globally unique identifier	Required
RecordTypeId	integer	Required
areaid	integer	None.
AccountId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomFormId": "27f1f58c-4ec4-4e41-b0c3-3924065a9226",
  "PatientId": "40989c5d-e692-4190-983e-bdfcb2ba0560",
  "EncounterId": "0e122dba-f3fc-4309-bcc4-fa2c44a322c3",
  "Id": "f7a1285e-a66a-475d-b5a8-9a2189ac2fb2",
  "CustomFormInputDetails": [
    {
      "CustomFormFieldsId": "f2d24647-f47a-4c57-9be6-bec464d4b35f",
      "Value": "sample string 2",
      "Ismultientry": true
    },
    {
      "CustomFormFieldsId": "f2d24647-f47a-4c57-9be6-bec464d4b35f",
      "Value": "sample string 2",
      "Ismultientry": true
    }
  ],
  "Note": "sample string 3",
  "StatusId": 1,
  "ModifiedBy": "97348c02-e5cf-4cfb-869d-2923f7e2ac3f",
  "ModifiedOn": "2026-02-03T22:29:18.6691463-06:00",
  "EncounterTypeId": "d6be8cdc-edb6-44a4-a522-2b956a908cd5",
  "ModuleId": 4,
  "ModuleName": "sample string 5",
  "RecordId": "ca151eaa-5680-4516-8cbc-72968b7efa61",
  "RecordTypeId": 7,
  "areaid": 8,
  "AccountId": "53590261-b1d9-4421-ac14-4c8cffd6106a"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CustomFormViewModel

Name	Type	Additional information
Id	globally unique identifier	None.
ModuleName	string	None.
ModuleOrder	integer	None.
ModuleParentId	integer	None.
ModuleId	integer	None.
CustomFormId	globally unique identifier	None.
CustomFormName	string	None.
Description	string	None.
IsAllowMultiple	boolean	None.
ParentId	globally unique identifier	None.
CustomFormRule	string	None.
Title	string	None.
SubTitle	string	None.
IsRequired	boolean	None.
Rule	string	None.
StyleId	integer	None.
Name	string	None.
ClientTitle	string	None.
ClientSubTitle	string	None.
ProviderTitle	string	None.
ProviderSubTitle	string	None.
Option1	string	None.
Option2	string	None.
DefaultValue	string	None.
ErrorMessage	string	None.
ControlId	integer	None.
DataTypeId	integer	None.
Order	integer	None.
DataMask	string	None.
MinLength	string	None.
MaxLength	string	None.
Controls	string	None.
DataType	string	None.
Style	string	None.
FormType	string	None.
Value	string	None.
CustomFormInputDetailId	globally unique identifier	None.
CustomFormParentId	globally unique identifier	None.
CustomFormFieldsId	globally unique identifier	None.
CustomFormDisplayOrder	integer	None.
IsRead	boolean	None.
IsWrite	boolean	None.
ShowOnce	boolean	None.
ResultHtml	string	None.
Code	string	None.
FormClientTitle	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "ba1f3d87-9f41-4e5f-bd1e-305f8a5d8396",
    "ModuleName": "sample string 1",
    "ModuleOrder": 2,
    "ModuleParentId": 1,
    "ModuleId": 3,
    "CustomFormId": "6064d73a-0cf7-410b-a3d0-c81bc3c4dbdf",
    "CustomFormName": "sample string 5",
    "Description": "sample string 6",
    "IsAllowMultiple": true,
    "ParentId": "38d95b6c-0774-4ebd-9fad-a4635ae288c3",
    "CustomFormRule": "sample string 8",
    "Title": "sample string 9",
    "SubTitle": "sample string 10",
    "IsRequired": true,
    "Rule": "sample string 12",
    "StyleId": 13,
    "Name": "sample string 14",
    "ClientTitle": "sample string 15",
    "ClientSubTitle": "sample string 16",
    "ProviderTitle": "sample string 17",
    "ProviderSubTitle": "sample string 18",
    "Option1": "sample string 19",
    "Option2": "sample string 20",
    "DefaultValue": "sample string 21",
    "ErrorMessage": "sample string 22",
    "ControlId": 23,
    "DataTypeId": 24,
    "Order": 25,
    "DataMask": "sample string 26",
    "MinLength": "sample string 27",
    "MaxLength": "sample string 28",
    "Controls": "sample string 29",
    "DataType": "sample string 30",
    "Style": "sample string 31",
    "FormType": "sample string 32",
    "Value": "sample string 33",
    "CustomFormInputDetailId": "8999e275-e692-4527-824a-e81ea06e33a3",
    "CustomFormParentId": "785c5ae0-ccfa-4e20-bd4c-e324afc7f1e5",
    "CustomFormFieldsId": "2af01665-94d1-44d6-ba8b-247539b5ad42",
    "CustomFormDisplayOrder": 34,
    "IsRead": true,
    "IsWrite": true,
    "ShowOnce": true,
    "ResultHtml": "sample string 35",
    "Code": "sample string 36",
    "FormClientTitle": "sample string 37"
  },
  {
    "Id": "ba1f3d87-9f41-4e5f-bd1e-305f8a5d8396",
    "ModuleName": "sample string 1",
    "ModuleOrder": 2,
    "ModuleParentId": 1,
    "ModuleId": 3,
    "CustomFormId": "6064d73a-0cf7-410b-a3d0-c81bc3c4dbdf",
    "CustomFormName": "sample string 5",
    "Description": "sample string 6",
    "IsAllowMultiple": true,
    "ParentId": "38d95b6c-0774-4ebd-9fad-a4635ae288c3",
    "CustomFormRule": "sample string 8",
    "Title": "sample string 9",
    "SubTitle": "sample string 10",
    "IsRequired": true,
    "Rule": "sample string 12",
    "StyleId": 13,
    "Name": "sample string 14",
    "ClientTitle": "sample string 15",
    "ClientSubTitle": "sample string 16",
    "ProviderTitle": "sample string 17",
    "ProviderSubTitle": "sample string 18",
    "Option1": "sample string 19",
    "Option2": "sample string 20",
    "DefaultValue": "sample string 21",
    "ErrorMessage": "sample string 22",
    "ControlId": 23,
    "DataTypeId": 24,
    "Order": 25,
    "DataMask": "sample string 26",
    "MinLength": "sample string 27",
    "MaxLength": "sample string 28",
    "Controls": "sample string 29",
    "DataType": "sample string 30",
    "Style": "sample string 31",
    "FormType": "sample string 32",
    "Value": "sample string 33",
    "CustomFormInputDetailId": "8999e275-e692-4527-824a-e81ea06e33a3",
    "CustomFormParentId": "785c5ae0-ccfa-4e20-bd4c-e324afc7f1e5",
    "CustomFormFieldsId": "2af01665-94d1-44d6-ba8b-247539b5ad42",
    "CustomFormDisplayOrder": 34,
    "IsRead": true,
    "IsWrite": true,
    "ShowOnce": true,
    "ResultHtml": "sample string 35",
    "Code": "sample string 36",
    "FormClientTitle": "sample string 37"
  }
]