При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить поля и настройки свойства заказа для определенного типа свойств sale…», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Получить поля и настройки свойства заказа для определенного типа свойств sale.property.getfieldsbytype

> Scope: sale
>
> Кто может выполнять метод: администратор

Метод получает доступные поля свойств заказа по типу свойств.

Параметры метода

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"type":"NUMBER"}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/sale.property.getfieldsbytype

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"type":"NUMBER","auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/sale.property.getfieldsbytype

• JS

    try
    {
    	const response = await $b24.callMethod(
    		"sale.property.getfieldsbytype", {
    			"type": "NUMBER",
    		}
    	);
    	
    	const result = response.getData().result;
    	console.info(result);
    }
    catch( error )
    {
    	console.error(error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'sale.property.getfieldsbytype',
                [
                    'type' => 'NUMBER',
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting fields by type: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        "sale.property.getfieldsbytype", {
            "type": "NUMBER",
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'sale.property.getfieldsbytype',
        [
            'type' => 'NUMBER'
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

Ответ в случае успеха

HTTP-статус: 200

{
   "result":{
      "property":{
         "active":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"char"
         },
         "code":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         },
         "defaultValue":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         },
         "description":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         },
         "id":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"integer"
         },
         "isFiltered":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"char"
         },
         "multiple":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"char"
         },
         "name":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":true,
            "type":"string"
         },
         "personTypeId":{
            "isImmutable":true,
            "isReadOnly":false,
            "isRequired":true,
            "type":"integer"
         },
         "propsGroupId":{
            "isImmutable":true,
            "isReadOnly":false,
            "isRequired":true,
            "type":"integer"
         },
         "required":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"char"
         },
         "settings":{
            "fields":{
               "max":{
                  "isImmutable":false,
                  "isReadOnly":false,
                  "isRequired":false,
                  "type":"integer"
               },
               "min":{
                  "isImmutable":false,
                  "isReadOnly":false,
                  "isRequired":false,
                  "type":"integer"
               },
               "step":{
                  "isImmutable":false,
                  "isReadOnly":false,
                  "isRequired":false,
                  "type":"integer"
               }
            },
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"datatype"
         },
         "sort":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"integer"
         },
         "type":{
            "isImmutable":true,
            "isReadOnly":false,
            "isRequired":true,
            "type":"string"
         },
         "userProps":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"char"
         },
         "util":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"char"
         },
         "xmlId":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         }
      }
   },
   "time":{
      "start":1712325081.703631,
      "finish":1712325082.067712,
      "duration":0.36408114433288574,
      "processing":0.023890972137451172,
      "date_start":"2024-04-05T16:51:21+03:00",
      "date_finish":"2024-04-05T16:51:22+03:00"
   }
}

Обработка ошибок

HTTP-статус: 400

{
   "error":0,
   "error_description":"error"
}

Возможные коды ошибок

• [](./index)
• [](./sale-property-add)
• [](./sale-property-update)
• [](./sale-property-get)
• [](./sale-property-list)
• [](./sale-property-delete)