Contributors:
Module Layouts API
Create, Retrieve, Update or Delete Module Layouts via the public API endpoint using "where" filtering.
GET Module Layouts List
Retrieves a list of Module Layouts as a JSON response based on your provided query parameters.
/api/v2/admin/module-layouts/{id}/layouts
Parameters
Parameter
Values
Required
Where
{<where query>}Order_By
<propertyAlias>Offset
<integer>Limit
<integer>Data / Response:
N/A{
"Items": [
{
"Id": 0,
"FtpPath": "string",
"Name": "string",
"Type": "Detail",
"Template": "string"
}
],
"TotalItemsCount": 0
}
POST Module Layout Create
Creates a new Module Layout based on the provided data.
/api/v2/admin/module-layouts/{moduleId}
Data / Response:
{
"Name": "string",
"Type": "Detail",
"Template": "string"
}
{
"Id": 0,
"FtpPath": "string",
"Name": "string",
"Type": "Detail",
"Template": "string"
}
GET Module Layout Item
Retrieves a single Module Layout based on the ID passed in the endpoint URL.
/api/v2/admin/module-layouts/{id}
Data / Response:
N/A
{
"Id": 0,
"FtpPath": "string",
"Name": "string",
"Type": "Detail",
"Template": "string"
}
PUT Module Layout Update
Updates a single Module Layout based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/module-layouts/{id}
Data / Response:
{
"Name": "string",
"Type": "Detail",
"Template": "string"
}
{
"Id": 0,
"FtpPath": "string",
"Name": "string",
"Type": "Detail",
"Template": "string"
}
DELETE Module Layout Delete
Deletes a single Module Layout based on the ID passed in the endpoint URL.
/api/v2/admin/module-layouts/{id}
Data / Response:
N/A
Status 204