POST api/CustomForm
Custom Form Save
Request Information
URI Parameters
None.
Body Parameters
CustomFormBindingModelName | Description | 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": "d158a39f-e2ea-4884-9824-1767e0e351ee", "PatientId": "32117345-7738-4d3c-a400-c959370a5fa9", "EncounterId": "684385d0-4df1-4455-ad98-e9ac12377339", "Id": "caf354ae-a431-4c1b-92e1-e8fa8b669295", "CustomFormInputDetails": [ { "CustomFormFieldsId": "821dc71b-3a8e-485a-9cf2-0d9f940c3fca", "Value": "sample string 2", "Ismultientry": true }, { "CustomFormFieldsId": "821dc71b-3a8e-485a-9cf2-0d9f940c3fca", "Value": "sample string 2", "Ismultientry": true } ], "Note": "sample string 3", "StatusId": 1, "ModifiedBy": "2f5acec7-8c5f-484d-996f-00c95e76e30a", "ModifiedOn": "2024-07-05T16:34:51.3381576-05:00", "EncounterTypeId": "7297ce9c-0b27-4eb1-bbe9-8ae762c0ef2b", "ModuleId": 4, "ModuleName": "sample string 5", "RecordId": "07c69017-0db8-4d65-9ed9-d0068bb72c46", "RecordTypeId": 7, "areaid": 8, "AccountId": "16882fd2-940b-4059-92d4-e7ba69b5ad2e" }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of CustomFormViewModelName | Description | 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": "3339b9fa-b513-48ff-9a99-54b8ef6f3093", "ModuleName": "sample string 1", "ModuleOrder": 2, "ModuleParentId": 1, "ModuleId": 3, "CustomFormId": "0aa2177d-1f10-47da-97e7-5bddb549fbd9", "CustomFormName": "sample string 5", "Description": "sample string 6", "IsAllowMultiple": true, "ParentId": "7c105854-9ab7-4a25-b61c-a6dd01e84598", "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": "64d5041b-68fe-4159-b7f2-99744530226f", "CustomFormParentId": "200e77a3-40cc-4ff5-8510-fc1ad4bb54a1", "CustomFormFieldsId": "0a6be217-3ca5-479c-8855-c777860f5981", "CustomFormDisplayOrder": 34, "IsRead": true, "IsWrite": true, "ShowOnce": true, "ResultHtml": "sample string 35", "Code": "sample string 36", "FormClientTitle": "sample string 37" }, { "Id": "3339b9fa-b513-48ff-9a99-54b8ef6f3093", "ModuleName": "sample string 1", "ModuleOrder": 2, "ModuleParentId": 1, "ModuleId": 3, "CustomFormId": "0aa2177d-1f10-47da-97e7-5bddb549fbd9", "CustomFormName": "sample string 5", "Description": "sample string 6", "IsAllowMultiple": true, "ParentId": "7c105854-9ab7-4a25-b61c-a6dd01e84598", "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": "64d5041b-68fe-4159-b7f2-99744530226f", "CustomFormParentId": "200e77a3-40cc-4ff5-8510-fc1ad4bb54a1", "CustomFormFieldsId": "0a6be217-3ca5-479c-8855-c777860f5981", "CustomFormDisplayOrder": 34, "IsRead": true, "IsWrite": true, "ShowOnce": true, "ResultHtml": "sample string 35", "Code": "sample string 36", "FormClientTitle": "sample string 37" } ]