app.info
Описание и пример
Displays application information. The method supports secure calling convention.
Example
Query
http://my.bitrix24.com/rest/app.info?auth=d161f25928c3184678924ec127edd29a
JSON response
{ "result": { "ID":"7", "CODE":"local.56017020f07e17.98523769", "VERSION":1, "STATUS":"L", "INSTALLED":true, "PAYMENT_EXPIRED":"N", "DAYS":null, "LICENSE":"en_project" } }
XML response
<response> <result> <ID>7</ID> <CODE>local.56017020f07e17.98523769</CODE> <VERSION>1</VERSION> <STATUS>L</STATUS> <INSTALLED>1</INSTALLED> <PAYMENT_EXPIRED>N</PAYMENT_EXPIRED> <DAYS></DAYS> <LICENSE>ru_project</LICENSE> </result> </response>
Response Fields
Field | Description |
---|---|
ID | local identifier for application at the account |
CODE | Specifies the application ID. |
VERSION | Specifies the application version. |
STATUS | The application status. It can be one of the
following values:
|
INSTALLED | [true|false] App install status. If application isn't installed, it will be available only to account administrators and must signal about completed installation with calling BX24.installFinish() |
PAYMENT_EXPIRED | [Y|N]: if Y, the application license or trial period has expired. |
DAYS | Specifies the number of days left until the application license or trial period expires. |
LICENSE | App plan designation with indicated region as a prefix. Consist of base account language and subscription plan ID. As in case with subscription plans, which contents changed when saving public names (such as legacy CRM+, Team and Company), you won't be able to determine the plan by this field. |
LICENSE_TYPE | Internal designation of plan without indicating the region. Required to distinguish specific plans which contents have been updated but saved public names (such as legacy CRM+, Team and Company). Examples of designations: |
LICENSE_FAMILY | Plan designation without specified region. |
After the license expires, the application may remain fully functional for a certain grace period to account for possible delay of payment. Finally, if the license has not been renewed, the application is reverted back to demo mode or cease functioning at all. In that case, the value of PAYMENT_EXPIRED is Y, and the value of DAYS is negative.
© «Bitrix24», 2001-2024