Get Fields of the Catalog Section catalog.section.getFields
Scope:
catalogWho can execute the method: any user
The method catalog.section.getFields returns the available fields of the catalog section.
Without parameters.
Code Examples
How to Use Examples in Documentation
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.getFields
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/catalog.section.getFields
try
{
const response = await $b24.callMethod(
'catalog.section.getFields',
{}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.section.getFields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting catalog section fields: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.section.getFields',
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.section.getFields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"section": {
"active": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"code": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"description": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"descriptionType": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"iblockId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": true,
"type": "integer"
},
"iblockSectionId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"id": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "integer"
},
"name": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": true,
"type": "string"
},
"sort": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"xmlId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
}
}
},
"time": {
"start": 1716552521.40908,
"finish": 1716552521.69852,
"duration": 0.289434909820557,
"processing": 0.011207103729248,
"date_start": "2024-05-24T14:08:41+02:00",
"date_finish": "2024-05-24T14:08:41+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
section |
Object in the format |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":0,
"error_description":"error"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add a Section to the Catalog catalog.section.add
- Update the catalog section catalog.section.update
- Get Field Values of the Trade Catalog Section catalog.section.get
- Get a List of Sections in the Trade Catalog catalog.section.list
- Delete Catalog Section catalog.section.delete