PUT api/CustomForm
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": "472fba9d-ce54-4666-838f-c36143faf79f", "PatientId": "484ad073-db76-4fae-9df5-72b711468f5f", "EncounterId": "08d79681-7ccb-43f6-af7c-5835c3f31c7b", "Id": "d9d033ba-3aae-40b1-9654-364a33f8b67a", "CustomFormInputDetails": [ { "CustomFormFieldsId": "b5a525c4-c2fd-410e-955f-84e35a1252d0", "Value": "sample string 2", "Ismultientry": true }, { "CustomFormFieldsId": "b5a525c4-c2fd-410e-955f-84e35a1252d0", "Value": "sample string 2", "Ismultientry": true } ], "Note": "sample string 3", "StatusId": 1, "ModifiedBy": "a501d34e-a8d7-4508-a096-d03a57da6ab7", "ModifiedOn": "2024-07-05T16:23:42.6064625-05:00", "EncounterTypeId": "4b5e1f89-ba1d-423e-8224-255a877739e6", "ModuleId": 4, "ModuleName": "sample string 5", "RecordId": "bed35738-2119-4eb6-a01a-19989df73619", "RecordTypeId": 7, "areaid": 8, "AccountId": "d5024827-cb48-475e-a752-8bd0c446472b" }
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": "b5a72bec-d1f8-48fd-8ad7-ba6a1fc08387", "ModuleName": "sample string 1", "ModuleOrder": 2, "ModuleParentId": 1, "ModuleId": 3, "CustomFormId": "955069fe-7332-4ff3-9a5e-0f8fe045a8f8", "CustomFormName": "sample string 5", "Description": "sample string 6", "IsAllowMultiple": true, "ParentId": "443e115d-71f5-4205-8b27-ba8896f12f13", "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": "c73204fe-ffeb-4a92-abb8-f26454f202f9", "CustomFormParentId": "7368d58a-9b37-411f-aaad-f1bf4e97ec80", "CustomFormFieldsId": "bbc9631b-18da-48dd-ac82-2c2ce1376d08", "CustomFormDisplayOrder": 34, "IsRead": true, "IsWrite": true, "ShowOnce": true, "ResultHtml": "sample string 35", "Code": "sample string 36", "FormClientTitle": "sample string 37" }, { "Id": "b5a72bec-d1f8-48fd-8ad7-ba6a1fc08387", "ModuleName": "sample string 1", "ModuleOrder": 2, "ModuleParentId": 1, "ModuleId": 3, "CustomFormId": "955069fe-7332-4ff3-9a5e-0f8fe045a8f8", "CustomFormName": "sample string 5", "Description": "sample string 6", "IsAllowMultiple": true, "ParentId": "443e115d-71f5-4205-8b27-ba8896f12f13", "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": "c73204fe-ffeb-4a92-abb8-f26454f202f9", "CustomFormParentId": "7368d58a-9b37-411f-aaad-f1bf4e97ec80", "CustomFormFieldsId": "bbc9631b-18da-48dd-ac82-2c2ce1376d08", "CustomFormDisplayOrder": 34, "IsRead": true, "IsWrite": true, "ShowOnce": true, "ResultHtml": "sample string 35", "Code": "sample string 36", "FormClientTitle": "sample string 37" } ]