Прочие методы

Здесь перечислены методы для выполнения действий пользователей, не входящие ни в одну из других групп.

Сводка по методам

Метод	Назначение
attached_info_values	Возвращает значения заполнения дополнительного сведения
authenticate	Получить код абонента от имени пользователя приложения
apptype/transition_options/list	Список вариантов переходов видов приложений
faq/list	Список часто задаваемых вопросов
timezones/list	Список часовых поясов

attached_info_values

Возвращает значения заполнения дополнительного сведения

Параметр	Тип	Описание	Пример
Запрос
key	Строка переменная (100)	Имя сведения	Город
Ответ
key	Строка переменная (100)	Имя сведения	Город
name *	Строка переменная (75)	Заголовок сведения	Город
type	Строка (перечисление)	Тип значения сведения: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Булево) date (Дата) decimal (Число) service (Услуга) service_provider_tariff (Тариф поставщика услуг) string (Строка) subscriber (Абонент) subscription (Подписка) tariff (Тариф) tariff_period (Период действия) undefined (Не определено) user (Пользователь)	additional_value
values	Список (0..*)	Значения заполнения дополнительного сведения
- name *	Строка переменная (100)	Наименование	Москва
- weight *	Число (10.2)	Весовой коэффициент	1

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/attached_info_values
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "key": "Город"
}

Пример ответа Развернуть

{
  "key": "Город",
  "name": "Город",
  "type": "additional_value",
  "values": [
    {
      "name": "Москва",
      "weight": 1
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

authenticate

Получить код абонента от имени пользователя приложения

Параметр	Тип	Описание	Пример
Запрос
Ответ: owner (1)
Нет параметров

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/authenticate
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "tenant": 2000,
    "key": "abf7c2a7-1df7-4646-9327-2866804b6ce2"
  }
}

Пример ответа Развернуть

{
  "owner": 1010,
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

apptype/transition_options/list

Список вариантов переходов видов приложений

Параметр	Тип	Описание	Пример
Запрос
conf_id *	Строка переменная (22)	Код конфигурации для поиска. Обязательно, если не указан код вида приложения	mt
conf_version *	Строка переменная (18)	Номер версии конфигурации для поиска. Обязательно, если не указан код вида приложения.	1.1.3.10
apptype_id *	Строка переменная (22)	Код вида приложения для поиска. Обязательно, если не указан код и номер версии конфигурации.	mt
Ответ: transition_options (0..*)
conf_version	Строка переменная (18)	Номер версии конфигурации	1.1.3.10
apptype_original_id	Строка переменная (22)	Код предыдущего вида приложения	mt
apptype_id	Строка переменная (22)	Код вида приложения	mt
apptype_name	Строка переменная (255)	Имя вида приложения	РаботаВМоделиСервиса
apptype_presentation	Строка переменная (150)	Наименование вида приложения	Работа в модели сервиса

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/apptype/transition_options/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "transition_options": [
    {
      "conf_version": "1.1.3.10",
      "apptype_original_id": "mt",
      "apptype_id": "mt",
      "apptype_name": "РаботаВМоделиСервиса",
      "apptype_presentation": "Работа в модели сервиса"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

faq/list

Список часто задаваемых вопросов

Параметр	Тип	Описание	Пример
Запрос
Нет параметров
Ответ: faq (0..*)
description	Строка переменная (100)	Наименование	Как пользоваться сервисом?
link	Строка неограниченной длины	Ссылка на ответ на вопрос	http://about.com

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/faq/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

Пример ответа Развернуть

{
  "faq": [
    {
      "description": "Как пользоваться сервисом?",
      "link": "http://about.com"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

timezones/list

Список часовых поясов

Параметр	Тип	Описание	Пример
Запрос
Нет параметров
Ответ: timezones (1..*)
id	Строка неограниченной длины	Идентификатор	Europe/Moscow
description	Строка неограниченной длины	Представление	(GMT+03:00) Москва, Санкт-Петербург, Волгоград
offset	Число (6.0)	Смещение в секундах относительного универсального времени	10800
primary	Булево	Основной	true

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/timezones/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

Пример ответа Развернуть

{
  "timezones": [
    {
      "id": "Europe/Moscow",
      "description": "(GMT+03:00) Москва, Санкт-Петербург, Волгоград",
      "offset": 10800,
      "primary": true
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 31,
    "sm_version": "1.1.39.17",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх