POST
api/v1/getformdetails?formGUID={formGUID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formGUID | globally unique identifier |
Required |
Body Parameters
QueryParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNumber | integer |
None. |
|
| Limit | integer |
None. |
|
| SearchText | string |
None. |
|
| SortField | string |
None. |
|
| SortDirection | string |
None. |
|
| IsB2C | boolean |
None. |
|
| SellerId | integer |
None. |
|
| AdminMemberId | integer |
None. |
|
| ClientId | integer |
None. |
|
| Sortorder | integer |
None. |
Request Formats
application/json, text/json
{
"PageNumber": 1,
"Limit": 2,
"SearchText": "sample string 3",
"SortField": "sample string 4",
"SortDirection": "sample string 5",
"IsB2C": true,
"SellerId": 7,
"AdminMemberId": 8,
"ClientId": 9,
"Sortorder": 10
}
text/html
{"PageNumber":1,"Limit":2,"SearchText":"sample string 3","SortField":"sample string 4","SortDirection":"sample string 5","IsB2C":true,"SellerId":7,"AdminMemberId":8,"ClientId":9,"Sortorder":10}
application/xml, text/xml
<QueryParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models"> <AdminMemberId>8</AdminMemberId> <ClientId>9</ClientId> <IsB2C>true</IsB2C> <Limit>2</Limit> <PageNumber>1</PageNumber> <SearchText>sample string 3</SearchText> <SellerId>7</SellerId> <SortDirection>sample string 5</SortDirection> <SortField>sample string 4</SortField> <Sortorder>10</Sortorder> </QueryParameters>
application/x-www-form-urlencoded
Sample not available.
Response Information
Description:
Return type: FormFieldListingModel
Response Formats
application/json, text/json
{
"TotalRecord": 1,
"TotalPages": 2,
"FormFields": [
{
"Id": 1,
"FormGUID": "bf5acc59-7732-45e4-be7c-cfe44fb24ff0",
"GroupName": "sample string 3",
"FieldType": "sample string 4",
"Code": "sample string 5",
"FieldName": "sample string 6",
"Caption": "sample string 7",
"Placeholder": "sample string 8",
"IsRequired": true,
"RequiredMessage": "sample string 10",
"MinLength": 1,
"MaxLength": 1,
"Min": 1,
"Max": 1,
"SortOrder": 1,
"CSS": "sample string 11",
"HideCondition": "sample string 12",
"ListId": 1,
"IsFilter": true,
"IsActive": true,
"IsLogicalDeleted": true,
"CreatedOn": "2025-06-18T11:08:23.7122777+00:00",
"CreatedBy": 17,
"ModifiedOn": "2025-06-18T11:08:23.7122777+00:00",
"ModifiedBy": 1,
"IsPriceAttribute": true,
"IsVariantBased": true,
"IsInteger": true,
"Tooltip": "sample string 21"
},
{
"Id": 1,
"FormGUID": "bf5acc59-7732-45e4-be7c-cfe44fb24ff0",
"GroupName": "sample string 3",
"FieldType": "sample string 4",
"Code": "sample string 5",
"FieldName": "sample string 6",
"Caption": "sample string 7",
"Placeholder": "sample string 8",
"IsRequired": true,
"RequiredMessage": "sample string 10",
"MinLength": 1,
"MaxLength": 1,
"Min": 1,
"Max": 1,
"SortOrder": 1,
"CSS": "sample string 11",
"HideCondition": "sample string 12",
"ListId": 1,
"IsFilter": true,
"IsActive": true,
"IsLogicalDeleted": true,
"CreatedOn": "2025-06-18T11:08:23.7122777+00:00",
"CreatedBy": 17,
"ModifiedOn": "2025-06-18T11:08:23.7122777+00:00",
"ModifiedBy": 1,
"IsPriceAttribute": true,
"IsVariantBased": true,
"IsInteger": true,
"Tooltip": "sample string 21"
}
]
}
text/html
{"TotalRecord":1,"TotalPages":2,"FormFields":[{"Id":1,"FormGUID":"bf5acc59-7732-45e4-be7c-cfe44fb24ff0","GroupName":"sample string 3","FieldType":"sample string 4","Code":"sample string 5","FieldName":"sample string 6","Caption":"sample string 7","Placeholder":"sample string 8","IsRequired":true,"RequiredMessage":"sample string 10","MinLength":1,"MaxLength":1,"Min":1,"Max":1,"SortOrder":1,"CSS":"sample string 11","HideCondition":"sample string 12","ListId":1,"IsFilter":true,"IsActive":true,"IsLogicalDeleted":true,"CreatedOn":"2025-06-18T11:08:23.7122777+00:00","CreatedBy":17,"ModifiedOn":"2025-06-18T11:08:23.7122777+00:00","ModifiedBy":1,"IsPriceAttribute":true,"IsVariantBased":true,"IsInteger":true,"Tooltip":"sample string 21"},{"Id":1,"FormGUID":"bf5acc59-7732-45e4-be7c-cfe44fb24ff0","GroupName":"sample string 3","FieldType":"sample string 4","Code":"sample string 5","FieldName":"sample string 6","Caption":"sample string 7","Placeholder":"sample string 8","IsRequired":true,"RequiredMessage":"sample string 10","MinLength":1,"MaxLength":1,"Min":1,"Max":1,"SortOrder":1,"CSS":"sample string 11","HideCondition":"sample string 12","ListId":1,"IsFilter":true,"IsActive":true,"IsLogicalDeleted":true,"CreatedOn":"2025-06-18T11:08:23.7122777+00:00","CreatedBy":17,"ModifiedOn":"2025-06-18T11:08:23.7122777+00:00","ModifiedBy":1,"IsPriceAttribute":true,"IsVariantBased":true,"IsInteger":true,"Tooltip":"sample string 21"}]}
application/xml, text/xml
<FormFieldListingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.CatalogDesign">
<FormFields>
<FormField>
<CSS>sample string 11</CSS>
<Caption>sample string 7</Caption>
<Code>sample string 5</Code>
<CreatedBy>17</CreatedBy>
<CreatedOn>2025-06-18T11:08:23.7122777+00:00</CreatedOn>
<FieldName>sample string 6</FieldName>
<FieldType>sample string 4</FieldType>
<FormGUID>bf5acc59-7732-45e4-be7c-cfe44fb24ff0</FormGUID>
<GroupName>sample string 3</GroupName>
<HideCondition>sample string 12</HideCondition>
<Id>1</Id>
<IsActive>true</IsActive>
<IsFilter>true</IsFilter>
<IsInteger>true</IsInteger>
<IsLogicalDeleted>true</IsLogicalDeleted>
<IsPriceAttribute>true</IsPriceAttribute>
<IsRequired>true</IsRequired>
<IsVariantBased>true</IsVariantBased>
<ListId>1</ListId>
<Max>1</Max>
<MaxLength>1</MaxLength>
<Min>1</Min>
<MinLength>1</MinLength>
<ModifiedBy>1</ModifiedBy>
<ModifiedOn>2025-06-18T11:08:23.7122777+00:00</ModifiedOn>
<Placeholder>sample string 8</Placeholder>
<RequiredMessage>sample string 10</RequiredMessage>
<SortOrder>1</SortOrder>
<Tooltip>sample string 21</Tooltip>
</FormField>
<FormField>
<CSS>sample string 11</CSS>
<Caption>sample string 7</Caption>
<Code>sample string 5</Code>
<CreatedBy>17</CreatedBy>
<CreatedOn>2025-06-18T11:08:23.7122777+00:00</CreatedOn>
<FieldName>sample string 6</FieldName>
<FieldType>sample string 4</FieldType>
<FormGUID>bf5acc59-7732-45e4-be7c-cfe44fb24ff0</FormGUID>
<GroupName>sample string 3</GroupName>
<HideCondition>sample string 12</HideCondition>
<Id>1</Id>
<IsActive>true</IsActive>
<IsFilter>true</IsFilter>
<IsInteger>true</IsInteger>
<IsLogicalDeleted>true</IsLogicalDeleted>
<IsPriceAttribute>true</IsPriceAttribute>
<IsRequired>true</IsRequired>
<IsVariantBased>true</IsVariantBased>
<ListId>1</ListId>
<Max>1</Max>
<MaxLength>1</MaxLength>
<Min>1</Min>
<MinLength>1</MinLength>
<ModifiedBy>1</ModifiedBy>
<ModifiedOn>2025-06-18T11:08:23.7122777+00:00</ModifiedOn>
<Placeholder>sample string 8</Placeholder>
<RequiredMessage>sample string 10</RequiredMessage>
<SortOrder>1</SortOrder>
<Tooltip>sample string 21</Tooltip>
</FormField>
</FormFields>
<TotalPages>2</TotalPages>
<TotalRecord>1</TotalRecord>
</FormFieldListingModel>