SBIS API3 — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
(→‎ВИ3.СоздатьЭлементСправочника)
(→‎ВИ3.НайтиЭлементСправочника)
 
(не показано 30 промежуточных версий 2 участников)
Строка 1: Строка 1:
−
=Сотрудник=
+
=ВИ3.СоздатьЭлементСправочника=
−
==ВИ3.СоздатьЭлементСправочника==
 
  
−
Описание: Метод создает/обновляет информацию о принадлежности сотрудника к юридическому лицу или его подразделению (не обновляет данные физического лица)
+
Описание: Метод создает/обновляет информацию о [[:Категория:SBIS API3 Объект |объекте ИС]]
  
 
Параметры:
 
Параметры:
−
* Тип – строка, значение:  «Сотрудник»
+
* Тип – строка, тип объекта
−
* Парам – json объект с данными  
+
* Объект – json объект с данными объекта
−
** ИдИС * - идентификатор сотрудника в ИС
+
 
−
** ЧастноеЛицо_ИдИС * - идентификатор частного лица в ИС
+
Описание доступных типов и структуры данных объектов смотрите [[:Категория:SBIS API3 Объект|в справочнике объектов API3]].
−
** НашаОрганизация_ИдИС * - идентификатор нашей организации в ИС
 
−
** ПодразделениеОрганизации_ИдИС * - идентификатор подразделения организации в ИС
 
  
 
Результат:
 
Результат:
−
*
+
* ИдИС - Иднтификатор объекта ИС
−
*
+
* ИдСБИС - Идентификатор объекта СБИС
 +
* Название - Строка представления объекта
 +
* Ключ1_1 - Значение ключа 1_1 в СБИС
 +
* Ключ1_2 - Значение ключа 1_2 в СБИС
 +
* Ключ1_3 - Значение ключа 1_3 в СБИС
 +
* Ключ2 - Значение ключа 2 в СБИС
 +
* Ключ3 - Значение ключа 3 в СБИС
  
 
Пример объекта Парам:
 
Пример объекта Парам:
Строка 32: Строка 35:
 
{
 
{
 
   "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
 
   "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
 +
  "ИдСБИС": "75",
 
   "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
 
   "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
 
   "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
 
   "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
Строка 39: Строка 43:
 
</source>
 
</source>
  
−
Используемые методы БЛ:
+
=ВИ3.НайтиЭлементСправочника=
−
* Персонал.ПрочитатьПоСотруднику
 
−
* Персонал.ЗаписатьКарточку
 
−
* СтруктураПредприятия.КореньФилиалаКадровойСтруктуры
 
−
* Персонал.СоздатьСотрудника
 
  
−
==ВИ3.НайтиЭлементСправочника==
+
Описание: Метод поиска объекта, ищет объект по переданным ключам. Поиск осуществляется по всем ключам. Результат сортируется по весу ключа.  
  
−
Описание: Метод ищет сотрудника по естественным ключам
+
Вес ИдСБИС = 1, Вес ИдИС = 2 (чем меньше тем выше в результате). Вес естественных ключей смотрите в [[:Категория:SBIS API3 Объект|справочнике объектов]].
  
 
Параметры:
 
Параметры:
−
* Тип – строка, значение:  «Сотрудник»
+
*Парам
−
* Парам – json объект с данными
+
** Тип – тип объекта
−
** key1_1 * - идентификатор частного лица в ИС
+
** ИдИС - идентификатор ИС
−
** key1_2 * - идентификатор нашей организации в ИС
+
** ИдСБИС - идентификатор СБИС
−
** key1_3 * - идентификатор подразделения организации в ИС
+
** Ключ1_1 - естественный ключ 1_1
 +
** Ключ1_2 - естественный ключ 1_2
 +
** Ключ1_3 - естественный ключ 1_3
 +
** Ключ2 - естественный ключ 2
 +
** Ключ3 - естественный ключ 3
  
 
Результат:
 
Результат:
−
*
+
Метод возвращаем массив подходящих объектов, или пустой массив
−
*
 
−
 
 
−
Пример объекта Парам:
 
−
<source lang="json">
 
−
{ 
 
−
  "key1_1": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "key1_2": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "key1_3": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
 
−
}
 
−
</source>
 
−
 
 
−
Пример результата:
 
−
<source lang="json">
 
−
{
 
−
  "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
 
−
}
 
−
</source>
 
−
 
 
−
Используемые методы БЛ:
 
−
* Персонал.ПрочитатьПоСотруднику
 
−
* Контрагент.FindNearestHead
 
−
* ЧастноеЛицо.MainPositionOnDate
 
−
 
 
−
=ЧастноеЛицо=
 
−
==ВИ3.СоздатьЭлементСправочника==
 
−
 
 
−
Описание: Метод создает/обновляет информацию о частном лице
 
−
 
 
−
Параметры:
 
−
* Тип – строка, значение:  «ЧастноеЛицо»
 
−
* Парам – json объект с данными
 
−
** ИдИС * - идентификатор частного лица в ИС
 
−
** Фамилия * - фамилия частного лица
 
−
** Имя * - имя частного лица
 
−
** Отчество * - отчество частного лица
 
−
** ДатаРождения  - дата рождения частного лица
 
−
** Пол_ИдИС  - идентификатор пола частного лица в ИС
 
−
** ДокументВид_ИдИС  - идентификатор вида удостоверяющего документа частного лица в ИС
 
−
** ДокументСерия  - серия удостоверяющего документа частного лица
 
−
** ДокументНомер  - номер удостоверяющего документа частного лица
 
−
** ДокументДатаВыдачи  - дата выдачи удостоверяющего документа частного лица
 
−
** ИНН  - ИНН частного лица
 
−
** НомерСтраховогоСвидетельства - номер СНИЛС частного лица
 
−
** АдресПрописки - адрес места прописки частного лица
 
−
** АдресФакт - адрес фактического места жительства частного лица
 
−
 
 
−
 
 
−
Результат:
 
−
*
 
−
*
 
−
 
 
−
Пример объекта Парам:
 
−
<source lang="json">
 
−
 
 
−
{
 
−
  "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
 
−
}
 
−
</source>
 
  
−
Пример результата:
+
* result - массив подходящих объектов
−
<source lang="json">
+
** ИдИС - идентификатор ИС (Строка)
 +
** ИдСБИС - идентификатор СБИС (Строка)
 +
** Название * - Представление объекта(Строка)
 +
** Ключ1_1 - естественный ключ 1_1 (Строка)
 +
** Ключ1_2 - естественный ключ 1_2 (Строка)
 +
** Ключ1_3 - естественный ключ 1_3 (Строка)
 +
** Ключ2 - естественный ключ 2 (Строка)
 +
** Ключ3 - естественный ключ 3 (Строка)
  
−
{
 
−
  "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
 
−
  "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
 
−
}
 
−
 
−
</source>
 
−
 
−
Используемые методы БЛ:
 
−
* ЧастноеЛицо.Прочитать
 
−
* ЧастноеЛицо.Записать
 
−
* ВоинскийУчет.Записать
 
−
* ТрудоваяДеятельность.Создать
 
−
* ТрудоваяДеятельность.Записать
 
−
* ContactData.FindOrCreate
 
−
* ЧленСемьи.Записать
 
−
* Образование.Создать
 
−
* Образование.Записать
 
−
 
−
==ВИ3.НайтиЭлементСправочника==
 
−
 
−
Описание: Метод ищет частное лицо по естественным ключам
 
−
 
−
Параметры:
 
−
* Тип – строка, значение:  «ЧастноеЛицо»
 
−
* Парам – json объект с данными
 
−
** key1_1 * - идентификатор частного лица в ИС
 
−
** key1_2 * - идентификатор нашей организации в ИС
 
−
** key1_3 * - идентификатор подразделения организации в ИС
 
−
 
−
Результат:
 
−
*
 
−
*
 
  
 
Пример объекта Парам:
 
Пример объекта Парам:
 
<source lang="json">
 
<source lang="json">
 
{   
 
{   
−
   "key1_1": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
+
   "Тип": "Сотрудник",
−
   "key1_2": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
+
   "Ключ1_1": "5f9102f3-28c9-11e7-a6d9-3497f6323b8f",
−
   "key1_3": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
+
   "Ключ1_2": "5f9102f2-28c9-11e7-a6d9-3497f6374b3g",
 
}
 
}
 
</source>
 
</source>
Строка 173: Строка 86:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
−
   "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
+
   "result":
−
  "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
+
  {
−
  "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
+
      "ИдИC": "а12321а3422315",
−
  "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
+
      "ИдСБИС": "2315",
 +
      "Название": "Иванов Иван Иваныч",
 +
      "Ключ1_1": "21",
 +
      "Ключ1_2": "175",
 +
      "Ключ1_3": "2385"
 +
  }
 
}
 
}
 
</source>
 
</source>
−
 
−
Используемые методы БЛ:
 

Текущая версия на 09:37, 10 октября 2017

ВИ3.СоздатьЭлементСправочника

Описание: Метод создает/обновляет информацию о объекте ИС

Параметры:

  • Тип – строка, тип объекта
  • Объект – json объект с данными объекта

Описание доступных типов и структуры данных объектов смотрите в справочнике объектов API3.

Результат:

  • ИдИС - Иднтификатор объекта ИС
  • ИдСБИС - Идентификатор объекта СБИС
  • Название - Строка представления объекта
  • Ключ1_1 - Значение ключа 1_1 в СБИС
  • Ключ1_2 - Значение ключа 1_2 в СБИС
  • Ключ1_3 - Значение ключа 1_3 в СБИС
  • Ключ2 - Значение ключа 2 в СБИС
  • Ключ3 - Значение ключа 3 в СБИС

Пример объекта Парам: 

{
   "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
   "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
   "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
   "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
}

Пример результата: 

{
   "ИдИС": "5f9102f4-28c9-11e7-a6d9-3497f6377b7e",
   "ИдСБИС": "75",
   "ЧастноеЛицо_ИдИС": "5f9102f3-28c9-11e7-a6d9-3497f6377b7e",
   "НашаОрганизация_ИдИС": "5f9102f2-28c9-11e7-a6d9-3497f6377b7e",
   "ПодразделениеОрганизации_ИдИС": "6a185a64-2979-11e7-9bfa-3497f6377b7e"
}

ВИ3.НайтиЭлементСправочника

Описание: Метод поиска объекта, ищет объект по переданным ключам. Поиск осуществляется по всем ключам. Результат сортируется по весу ключа.

Вес ИдСБИС = 1, Вес ИдИС = 2 (чем меньше тем выше в результате). Вес естественных ключей смотрите в справочнике объектов.

Параметры:

  • Парам
    • Тип – тип объекта
    • ИдИС - идентификатор ИС
    • ИдСБИС - идентификатор СБИС
    • Ключ1_1 - естественный ключ 1_1
    • Ключ1_2 - естественный ключ 1_2
    • Ключ1_3 - естественный ключ 1_3
    • Ключ2 - естественный ключ 2
    • Ключ3 - естественный ключ 3

Результат: Метод возвращаем массив подходящих объектов, или пустой массив

  • result - массив подходящих объектов
    • ИдИС - идентификатор ИС (Строка)
    • ИдСБИС - идентификатор СБИС (Строка)
    • Название * - Представление объекта(Строка)
    • Ключ1_1 - естественный ключ 1_1 (Строка)
    • Ключ1_2 - естественный ключ 1_2 (Строка)
    • Ключ1_3 - естественный ключ 1_3 (Строка)
    • Ключ2 - естественный ключ 2 (Строка)
    • Ключ3 - естественный ключ 3 (Строка)


Пример объекта Парам: 

{   
   "Тип": "Сотрудник",
   "Ключ1_1": "5f9102f3-28c9-11e7-a6d9-3497f6323b8f",
   "Ключ1_2": "5f9102f2-28c9-11e7-a6d9-3497f6374b3g",
}

Пример результата: 

{
   "result":
   {
      "ИдИC": "а12321а3422315",
      "ИдСБИС": "2315",
      "Название": "Иванов Иван Иваныч",
      "Ключ1_1": "21",
      "Ключ1_2": "175",
      "Ключ1_3": "2385"
   }
}
Источник — «http://wiki.razgovorov.ru/index.php?title=SBIS_API3&oldid=2803»