Nothing Found

Get Form Details

Get form details based on given criteria.

Securityoauth2
Request
path Parameters
offerId
required
integer <int32>

Unique identifier of an offer.

Example: <<Incomplete_example>>
lobName
required
string

Name of the line of business.

Example: <<Incomplete_example>>
state
required
string

<>

Example: <<Incomplete_example>>
userId
required
integer <int32>

Unique identifier of a user.

Example: <<Incomplete_example>>
template
required
string

<>

Example: <<Incomplete_example>>
Request Body schema:
Array
id
integer or null <int32>

Unique Identifier of form data.

uId
string or null

GUID of form data.

code
string or null

Code of form data.

isAttached
boolean

Set as true if form is attached to any entity.

mode
integer <int32> (VAM.DealFoundry.WebAPI.Entities.Models.Action)
Enum: 0 1 2
object (VAM.DealFoundry.WebAPI.Entities.Models.EntityType)
riskCode
string or null

Risk code of form.

riskName
string or null

Risk name of form.

name
string or null

Name of the form.

formName
string or null

Name of the form.

Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.Section)
forms
Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.FormData)
Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.Field)
Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.Coverage)
correlationId
string or null

Correlation ID of forms.

formId
string or null

Id of Forms.

helpText
string or null

Helptext for forms.

Responses
200

Success

401

Unauthorized

403

Forbidden

post/api/v1/forms/getFormDetails/{offerId}/{lobName}/{state}/{userId}/{template}
Request samples
[
  • {
    }
]
Response samples
No sample