Get resource booking.v1.resource.get

Scope: booking

Who can execute the method: any user

The method booking.v1.resource.get returns information about a resource by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Resource identifier.
Can be obtained from the methods booking.v1.resource.add and booking.v1.resource.list

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/booking.v1.resource.get
        
try
        {
        	const response = await $b24.callMethod(
        		'booking.v1.resource.get',
        		{
        			id: 15
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'booking.v1.resource.get',
                    [
                        'id' => 15,
                    ]
                );
        
            $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 resource: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "booking.v1.resource.get",
            {
                id: 15
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'booking.v1.resource.get',
            [
                'id' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "resource": {
                    "confirmationCounterDelay": 10800,
                    "confirmationNotificationDelay": 86400,
                    "confirmationNotificationRepetitions": null,
                    "confirmationNotificationRepetitionsInterval": 10800,
                    "delayedCounterDelay": 300,
                    "delayedNotificationDelay": 300,
                    "description": null,
                    "id": 15,
                    "infoNotificationDelay": null,
                    "isConfirmationNotificationOn": "Y",
                    "isDelayedNotificationOn": "N",
                    "isFeedbackNotificationOn": "N",
                    "isInfoNotificationOn": "Y",
                    "isMain": "Y",
                    "isReminderNotificationOn": "Y",
                    "name": "Name",
                    "reminderNotificationDelay": -1,
                    "templateTypeConfirmation": "animate",
                    "templateTypeDelayed": "animate",
                    "templateTypeFeedback": "animate",
                    "templateTypeInfo": "inanimate",
                    "templateTypeReminder": "base",
                    "typeId": 1
                }
            },
            "time": {
                "start": 1746539524.292041,
                "finish": 1746539524.356627,
                "duration": 0.06458592414855957,
                "processing": 0.018703937530517578,
                "date_start": "2025-05-06T16:52:04+02:00",
                "date_finish": "2025-05-06T16:52:04+02:00",
                "operating_reset_at": 1746540124,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response. Contains information about the resource fields. The structure is described below

time
time

Information about the request execution time

Resource

confirmationCounterDelay
integer

Time until the record is made in seconds, after which the unconfirmed record counter lights up

confirmationDelay
integer

Time until the record in seconds when the client receives the first message to confirm the record

confirmationRepetitions
integer

Number of messages sent to the client for confirming the record, excluding the first one

confirmationRepetitionsInterval
integer

Interval between confirmation messages, in seconds

delayedCounterDelay
integer

Time in seconds after which to turn on the counter in the calendar

delayedDelay
integer

Time in seconds after which to send a message to the client about the delay

description
string

Description of the resource

id
integer

Resource identifier

infoDelay
integer

Delay in seconds after which the client receives a message about the record

isConfirmationNotificationOn
string

Automatic confirmation of the record. Possible values:

  • Y — enabled
  • N — disabled

isDelayedNotificationOn
string

Reminder when the client is late. Possible values:

  • Y — enabled
  • N — disabled

isFeedbackNotificationOn
string

Request for feedback. Possible values:

  • Y — enabled
  • N — disabled

isInfoNotificationOn
string

Message to the client about the record. Possible values:

  • Y — enabled
  • N — disabled

isMain
string

How to display the resource. Possible values:

  • Y — in the schedule columns
  • N — when resources intersect

isReminderNotificationOn
string

Reminder about the record. Possible values:

  • Y — enabled
  • N — disabled

name
string

Name of the resource

reminderDelay
integer

Time until the record in seconds, after which the client receives a reminder about the record.
Value -1 — in the morning on the day of the record

templateTypeConfirmation
string

Type of the confirmation message template. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for appointments with specialists

templateTypeDelayed
string

Type of the delay message template. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for appointments with specialists

templateTypeFeedback
string

Type of the feedback request message template. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for appointments with specialists

templateTypeInfo
string

Type of the record message template. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for appointments with specialists

templateTypeReminder
string

Type of the reminder message template. Possible values: base

typeId
integer

Resource type identifier.

Information about the type can be obtained using the method booking.v1.resourceType.get

Error Handling

HTTP status: 400

{
            "error": 1021,
            "error_description": "Resource not found"
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

Value

1009

Resource not found

Resource with such id not found

100

Could not find value for parameter {id}

Required parameter not provided

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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

Previous
Update resource
Next
Get list of resources