Bitrix API

Client

Table of Contents

Constants

ERROR_NOTHING_FOUND  = 4
ERROR_SERVICE_UNAVAILABLE  = 3
ERROR_WRONG_INPUT  = 1
ERROR_WRONG_LICENSE  = 2
METHOD_COMMON_GET_BY_BIC  = 'ps.bic.getByBic'
METHOD_COMMON_GET_BY_INN  = 'ps.common.getByInn'
METHOD_COMMON_GET_BY_OGRN  = 'ps.common.getByOgrn'
METHOD_IP_SEARCH_BY_NAME  = 'ps.ip.searchByName'
METHOD_IS_SERVICE_ONLINE  = 'ps.common.isOnline'
METHOD_ORGANIZATION_SEARCH_BY_NAME  = 'ps.organization.searchByName'
METHOD_UA_GET_BY_EDRPOU  = 'ps.ua.getByEdrpou'
METHOD_UA_GET_FO_BY_ID  = 'ps.ua.getFoById'
METHOD_UA_GET_UO_BY_ID  = 'ps.ua.getUoById'
METHOD_UA_SEARCH_BY_NAME  = 'ps.ua.searchByName'
METHOD_UA_SEARCH_FO_BY_NAME  = 'ps.ua.searchFoByName'
METHOD_UA_SEARCH_UO_BY_NAME  = 'ps.ua.searchUoByName'
REGISTER_URI  = '/oauth/register/'
REST_URI  = '/rest/'
SCOPE  = 'ps'
SERVICE_ACCESS_OPTION  = 'properties_service_access'
SERVICE_HOST  = 'https://properties.bitrix.info'

Methods

__construct()  : mixed
Constructor of the client of the properties service.
clearAccessSettings()  : void
Drops current stored access credentials.
getByBic()  : mixed
getByInn()  : array<string|int, mixed>|false
Returns properties of the organization or individual businessman by its INN code.
getByOgrn()  : array<string|int, mixed>|false
Returns properties of the organization or individual businessman by its OGRN code.
getErrors()  : array<string|int, Error>
Returns array of errors.
isServiceOnline()  : bool
Checks service's availability.
searchIpByName()  : array<string|int, mixed>|false
Performs search of individual businessmen by name and returns array of found businessmen.
searchOrganizationByName()  : array<string|int, mixed>|false
Performs search of organizations by name and returns array of found organizations.
uaGetByEdrpou()  : array<string|int, mixed>|false
Returns properties of the ukrainian organization by its EDRPOU code.
uaGetFoById()  : array<string|int, mixed>|false
Performs search of ukrainian individual businessmen by identifier and returns its properties.
uaGetUoById()  : array<string|int, mixed>|false
Performs search of ukrainian organization by identifier and returns its properties.
uaSearchByName()  : array<string|int, mixed>|false
Performs search of ukrainian organizations and individuals by name and returns array of found organizations and individuals.
uaSearchFoByName()  : array<string|int, mixed>|false
Performs search of ukrainian individual businessmen by name and returns array of found individuals.
uaSearchUoByName()  : array<string|int, mixed>|false
Performs search of ukrainian organizations by name and returns array of found organizations.

Constants

ERROR_NOTHING_FOUND

public mixed ERROR_NOTHING_FOUND = 4

ERROR_SERVICE_UNAVAILABLE

public mixed ERROR_SERVICE_UNAVAILABLE = 3

ERROR_WRONG_INPUT

public mixed ERROR_WRONG_INPUT = 1

ERROR_WRONG_LICENSE

public mixed ERROR_WRONG_LICENSE = 2

METHOD_COMMON_GET_BY_BIC

public mixed METHOD_COMMON_GET_BY_BIC = 'ps.bic.getByBic'

METHOD_COMMON_GET_BY_INN

public mixed METHOD_COMMON_GET_BY_INN = 'ps.common.getByInn'

METHOD_COMMON_GET_BY_OGRN

public mixed METHOD_COMMON_GET_BY_OGRN = 'ps.common.getByOgrn'

METHOD_IP_SEARCH_BY_NAME

public mixed METHOD_IP_SEARCH_BY_NAME = 'ps.ip.searchByName'

METHOD_IS_SERVICE_ONLINE

public mixed METHOD_IS_SERVICE_ONLINE = 'ps.common.isOnline'

METHOD_ORGANIZATION_SEARCH_BY_NAME

public mixed METHOD_ORGANIZATION_SEARCH_BY_NAME = 'ps.organization.searchByName'

METHOD_UA_GET_BY_EDRPOU

public mixed METHOD_UA_GET_BY_EDRPOU = 'ps.ua.getByEdrpou'

METHOD_UA_GET_FO_BY_ID

public mixed METHOD_UA_GET_FO_BY_ID = 'ps.ua.getFoById'

METHOD_UA_GET_UO_BY_ID

public mixed METHOD_UA_GET_UO_BY_ID = 'ps.ua.getUoById'

METHOD_UA_SEARCH_BY_NAME

public mixed METHOD_UA_SEARCH_BY_NAME = 'ps.ua.searchByName'

METHOD_UA_SEARCH_FO_BY_NAME

public mixed METHOD_UA_SEARCH_FO_BY_NAME = 'ps.ua.searchFoByName'

METHOD_UA_SEARCH_UO_BY_NAME

public mixed METHOD_UA_SEARCH_UO_BY_NAME = 'ps.ua.searchUoByName'

REGISTER_URI

public mixed REGISTER_URI = '/oauth/register/'

REST_URI

public mixed REST_URI = '/rest/'

SERVICE_ACCESS_OPTION

public mixed SERVICE_ACCESS_OPTION = 'properties_service_access'

SERVICE_HOST

public mixed SERVICE_HOST = 'https://properties.bitrix.info'

Methods

__construct()

Constructor of the client of the properties service.

public __construct() : mixed

clearAccessSettings()

Drops current stored access credentials.

public clearAccessSettings() : void

getByBic()

public getByBic(mixed $bic) : mixed
Parameters
$bic : mixed

getByInn()

Returns properties of the organization or individual businessman by its INN code.

public getByInn(string $inn[, mixed $showTerminated = false ]) : array<string|int, mixed>|false
Parameters
$inn : string

INN code of the organization or individual businessman.

$showTerminated : mixed = false
Return values
array<string|int, mixed>|false

getByOgrn()

Returns properties of the organization or individual businessman by its OGRN code.

public getByOgrn(string $ogrn[, mixed $showTerminated = false ]) : array<string|int, mixed>|false
Parameters
$ogrn : string

OGRN code of the organization or individual businessman.

$showTerminated : mixed = false
Return values
array<string|int, mixed>|false

getErrors()

Returns array of errors.

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error> —

Errors.

isServiceOnline()

Checks service's availability.

public isServiceOnline() : bool
Return values
bool —

Returns true if service is ready and false otherwise.

searchIpByName()

Performs search of individual businessmen by name and returns array of found businessmen.

public searchIpByName(string $name, string $secondName, string $lastName, int $limit[, int $offset = 0 ]) : array<string|int, mixed>|false
Parameters
$name : string

First name (full or partial).

$secondName : string

Second name (full or partial).

$lastName : string

Last name (full or partial).

$limit : int

Maximum size of returning array.

$offset : int = 0

Offset of the returning array.

Return values
array<string|int, mixed>|false —

Array of found businessmen or false in case of error.

searchOrganizationByName()

Performs search of organizations by name and returns array of found organizations.

public searchOrganizationByName(string $name, int $limit[, int $offset = 0 ]) : array<string|int, mixed>|false
Parameters
$name : string

Part of the organization's name.

$limit : int

Maximum size of returning array.

$offset : int = 0

Offset of the returning array.

Return values
array<string|int, mixed>|false —

Array of found organizations or false in case of error.

uaGetByEdrpou()

Returns properties of the ukrainian organization by its EDRPOU code.

public uaGetByEdrpou(string $edrpou) : array<string|int, mixed>|false
Parameters
$edrpou : string

EDRPOU code of the organization.

Return values
array<string|int, mixed>|false

uaGetFoById()

Performs search of ukrainian individual businessmen by identifier and returns its properties.

public uaGetFoById(int $id) : array<string|int, mixed>|false
Parameters
$id : int

idenrifier of the individual.

Return values
array<string|int, mixed>|false —

Properties of found individual or false in case of error.

uaGetUoById()

Performs search of ukrainian organization by identifier and returns its properties.

public uaGetUoById(int $id) : array<string|int, mixed>|false
Parameters
$id : int

idenrifier of the organization.

Return values
array<string|int, mixed>|false —

Properties of found organization or false in case of error.

uaSearchByName()

Performs search of ukrainian organizations and individuals by name and returns array of found organizations and individuals.

public uaSearchByName(string $name, int $limit[, int $offset = 0 ]) : array<string|int, mixed>|false
Parameters
$name : string

Part of the name.

$limit : int

Maximum size of returning array.

$offset : int = 0

Offset of the returning array.

Return values
array<string|int, mixed>|false —

Array of found organizations and individuals or false in case of error.

uaSearchFoByName()

Performs search of ukrainian individual businessmen by name and returns array of found individuals.

public uaSearchFoByName(string $name, int $limit[, int $offset = 0 ]) : array<string|int, mixed>|false
Parameters
$name : string

Part of the individual's name.

$limit : int

Maximum size of returning array.

$offset : int = 0

Offset of the returning array.

Return values
array<string|int, mixed>|false —

Array of found individuals or false in case of error.

uaSearchUoByName()

Performs search of ukrainian organizations by name and returns array of found organizations.

public uaSearchUoByName(string $name, int $limit[, int $offset = 0 ]) : array<string|int, mixed>|false
Parameters
$name : string

Part of the organization's name.

$limit : int

Maximum size of returning array.

$offset : int = 0

Offset of the returning array.

Return values
array<string|int, mixed>|false —

Array of found organizations or false in case of error.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results