GET api/Forms/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Forms

Name	Type	Additional information
FormId	integer	None.
FormName	string	None.
FormCode	string	None.
Description	string	None.
SortOrder	integer	None.
IsActive	boolean	None.
FormActions	Collection of FormActions	None.
UserPermissions	Collection of UserPermissions	None.

Response Formats

application/json, text/json

Sample:

{
  "FormId": 1,
  "FormName": "sample string 2",
  "FormCode": "sample string 3",
  "Description": "sample string 4",
  "SortOrder": 1,
  "IsActive": true,
  "FormActions": [
    {
      "ActionId": 1,
      "FormId": 1,
      "ActionName": "sample string 2",
      "ActionCode": "sample string 3",
      "Description": "sample string 4",
      "SortOrder": 1,
      "UserPermissions": [
        {
          "PermissionId": 1,
          "UserId": 1,
          "FormId": 1,
          "ActionId": 1,
          "GrantedDate": "2026-11-13T07:31:56.3596262+03:30",
          "GrantedBy": 1
        },
        {
          "PermissionId": 1,
          "UserId": 1,
          "FormId": 1,
          "ActionId": 1,
          "GrantedDate": "2026-11-13T07:31:56.3596262+03:30",
          "GrantedBy": 1
        }
      ]
    },
    {
      "ActionId": 1,
      "FormId": 1,
      "ActionName": "sample string 2",
      "ActionCode": "sample string 3",
      "Description": "sample string 4",
      "SortOrder": 1,
      "UserPermissions": [
        {
          "PermissionId": 1,
          "UserId": 1,
          "FormId": 1,
          "ActionId": 1,
          "GrantedDate": "2026-11-13T07:31:56.3596262+03:30",
          "GrantedBy": 1
        },
        {
          "PermissionId": 1,
          "UserId": 1,
          "FormId": 1,
          "ActionId": 1,
          "GrantedDate": "2026-11-13T07:31:56.3596262+03:30",
          "GrantedBy": 1
        }
      ]
    }
  ],
  "UserPermissions": [
    {
      "PermissionId": 1,
      "UserId": 1,
      "FormId": 1,
      "ActionId": 1,
      "GrantedDate": "2026-11-13T07:31:56.3596262+03:30",
      "GrantedBy": 1,
      "FormActions": {
        "ActionId": 1,
        "FormId": 1,
        "ActionName": "sample string 2",
        "ActionCode": "sample string 3",
        "Description": "sample string 4",
        "SortOrder": 1,
        "UserPermissions": []
      }
    },
    {
      "PermissionId": 1,
      "UserId": 1,
      "FormId": 1,
      "ActionId": 1,
      "GrantedDate": "2026-11-13T07:31:56.3596262+03:30",
      "GrantedBy": 1,
      "FormActions": {
        "ActionId": 1,
        "FormId": 1,
        "ActionName": "sample string 2",
        "ActionCode": "sample string 3",
        "Description": "sample string 4",
        "SortOrder": 1,
        "UserPermissions": []
      }
    }
  ]
}

text/html

Sample:

{"FormId":1,"FormName":"sample string 2","FormCode":"sample string 3","Description":"sample string 4","SortOrder":1,"IsActive":true,"FormActions":[{"ActionId":1,"FormId":1,"ActionName":"sample string 2","ActionCode":"sample string 3","Description":"sample string 4","SortOrder":1,"UserPermissions":[{"PermissionId":1,"UserId":1,"FormId":1,"ActionId":1,"GrantedDate":"2026-11-13T07:31:56.3596262+03:30","GrantedBy":1},{"PermissionId":1,"UserId":1,"FormId":1,"ActionId":1,"GrantedDate":"2026-11-13T07:31:56.3596262+03:30","GrantedBy":1}]},{"ActionId":1,"FormId":1,"ActionName":"sample string 2","ActionCode":"sample string 3","Description":"sample string 4","SortOrder":1,"UserPermissions":[{"PermissionId":1,"UserId":1,"FormId":1,"ActionId":1,"GrantedDate":"2026-11-13T07:31:56.3596262+03:30","GrantedBy":1},{"PermissionId":1,"UserId":1,"FormId":1,"ActionId":1,"GrantedDate":"2026-11-13T07:31:56.3596262+03:30","GrantedBy":1}]}],"UserPermissions":[{"PermissionId":1,"UserId":1,"FormId":1,"ActionId":1,"GrantedDate":"2026-11-13T07:31:56.3596262+03:30","GrantedBy":1,"FormActions":{"ActionId":1,"FormId":1,"ActionName":"sample string 2","ActionCode":"sample string 3","Description":"sample string 4","SortOrder":1,"UserPermissions":[]}},{"PermissionId":1,"UserId":1,"FormId":1,"ActionId":1,"GrantedDate":"2026-11-13T07:31:56.3596262+03:30","GrantedBy":1,"FormActions":{"ActionId":1,"FormId":1,"ActionName":"sample string 2","ActionCode":"sample string 3","Description":"sample string 4","SortOrder":1,"UserPermissions":[]}}]}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.