Open API v2 / Custom Modules / Module Layouts

Module Layouts

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/module-layouts/{id}#

Retrieves a single module layout

Parameters

idinteger · pathrequired

Resource identifier.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

FtpPathstring · nullable

Physical path to the template file on the server. Used for file synchronization. Read-only.

Namestring

Name of the module layout.

Typeenum

The type of module that determines its functional purpose. Possible values: Detail, List.Possible values: DetailList

Templatestring · nullable

Defines the visual structure and display logic of the module content.

curl "https://your-site.webinone.com/api/v2/admin/module-layouts/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/module-layouts/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/module-layouts/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-layouts/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/module-layouts/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "FtpPath": "string",
  "Name": "Example",
  "Type": "Detail",
  "Template": "string"
}

PUT/api/v2/admin/module-layouts/{id}#

Updates an existing module layout

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

Namestringrequired

Name of the request module layout.

Typeenumrequired

The type of module that determines its functional purpose. List: by default. Nullable: false.Possible values: DetailList

Templatestring · nullable

Defines the visual structure and display logic of the module content.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

FtpPathstring · nullable

Physical path to the template file on the server. Used for file synchronization. Read-only.

Namestring

Name of the module layout.

Typeenum

The type of module that determines its functional purpose. Possible values: Detail, List.Possible values: DetailList

Templatestring · nullable

Defines the visual structure and display logic of the module content.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/module-layouts/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","Type":"Detail","Template":"string"}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-layouts/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Name": "Example",
    "Type": "Detail",
    "Template": "string"
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/module-layouts/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Name": "Example",
        "Type": "Detail",
        "Template": "string"
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/module-layouts/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Name' => 'Example',
        'Type' => 'Detail',
        'Template' => 'string'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/module-layouts/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Name\":\"Example\",\"Type\":\"Detail\",\"Template\":\"string\"}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "FtpPath": "string",
  "Name": "Example",
  "Type": "Detail",
  "Template": "string"
}

DELETE/api/v2/admin/module-layouts/{id}#

Deletes an existing module layout

Parameters

idinteger · pathrequired

Resource identifier.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/module-layouts/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/module-layouts/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/module-layouts/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/module-layouts/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/module-layouts/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

POST/api/v2/admin/module-layouts/{moduleId}#

Creates a new module layout

Parameters

moduleIdinteger · pathrequired

Resource identifier.

Body parameters

Namestringrequired

Name of the request module layout.

Typeenumrequired

The type of module that determines its functional purpose. List: by default. Nullable: false.Possible values: DetailList

Templatestring · nullable

Defines the visual structure and display logic of the module content.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

FtpPathstring · nullable

Physical path to the template file on the server. Used for file synchronization. Read-only.

Namestring

Name of the module layout.

Typeenum

The type of module that determines its functional purpose. Possible values: Detail, List.Possible values: DetailList

Templatestring · nullable

Defines the visual structure and display logic of the module content.

curl -X POST "https://your-site.webinone.com/api/v2/admin/module-layouts/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","Type":"Detail","Template":"string"}'

await fetch("https://your-site.webinone.com/api/v2/admin/module-layouts/1", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Name": "Example",
    "Type": "Detail",
    "Template": "string"
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/module-layouts/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Name": "Example",
        "Type": "Detail",
        "Template": "string"
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/module-layouts/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Name' => 'Example',
        'Type' => 'Detail',
        'Template' => 'string'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/module-layouts/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Name\":\"Example\",\"Type\":\"Detail\",\"Template\":\"string\"}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "FtpPath": "string",
  "Name": "Example",
  "Type": "Detail",
  "Template": "string"
}

GET/api/v2/admin/module-layouts/{moduleId}/list#

Retrieves a list of module layouts by using a "where" filtering

Parameters

Wherestring · query

JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.

Order_Bystring · query

Sort field. Prefix with - for descending; comma-separate for tie-breakers.

Semantic_Querystring · query

Natural-language search, ranked by relevance.

Min_Scorenumber · query

Lowest relevance score to include when using Semantic_Query.

Offsetinteger · query

Number of items to skip before returning results. Defaults to 0.

Limitinteger · query

Maximum number of items to return. Defaults to 100.

moduleIdinteger · pathrequired

Resource identifier.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

FtpPathstring · nullable

Physical path to the template file on the server. Used for file synchronization. Read-only.

Namestring

Name of the module layout.

Typeenum

The type of module that determines its functional purpose. Possible values: Detail, List.Possible values: DetailList

Templatestring · nullable

Defines the visual structure and display logic of the module content.

curl "https://your-site.webinone.com/api/v2/admin/module-layouts/1/list" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/module-layouts/1/list", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/module-layouts/1/list",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/module-layouts/1/list', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/module-layouts/1/list");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "FtpPath": "string",
      "Name": "Example",
      "Type": "Detail",
      "Template": "string"
    }
  ],
  "TotalItemsCount": 0
}