ПланФикс API handbook.getRecord: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) (Новая страница: «Получение записи справочника. Формат запроса: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="h…») |
Seva (обсуждение | вклад) Нет описания правки |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 2: | Строка 2: | ||
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<request method="handbook. | <request method="handbook.getRecord"> | ||
<account></account> | <account></account> | ||
<sid></sid> | <sid></sid> | ||
| Строка 19: | Строка 19: | ||
|handbook.id|| int || идентификатор справочника || | |handbook.id|| int || идентификатор справочника || | ||
|- | |- | ||
| | |key|| int || идентификатор записи || | ||
|- | |- | ||
|} | |} | ||
| Строка 32: | Строка 32: | ||
<key></key> | <key></key> | ||
<name></name> | <name></name> | ||
<archived></archived> | |||
<customData> | <customData> | ||
<customValue> | <customValue> | ||
| Строка 55: | Строка 56: | ||
|- | |- | ||
|name||string ||название, если запись является группой || | |name||string ||название, если запись является группой || | ||
|- | |||
|archived||bool ||является ли запись архивной || | |||
|- | |- | ||
|customData || ||данные записи || | |customData || ||данные записи || | ||
Текущая версия от 11:12, 6 июля 2021
Получение записи справочника. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="handbook.getRecord">
<account></account>
<sid></sid>
<handbook>
<id></id>
</handbook>
<key></key>
<signature></signature>
</request>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| sid | string(32) | ключ сесии | выдается в результате прохождения аутентификации |
| handbook.id | int | идентификатор справочника | |
| key | int | идентификатор записи |
Ответ при успешном выполнении запроса:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<record>
<parentKey></parentKey>
<isGroup></isGroup>
<key></key>
<name></name>
<archived></archived>
<customData>
<customValue>
<field>
<id></id>
</field>
<value></value>
<text></text>
</customValue>
<!-- -->
</customData>
</record>
</response>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| parentKey | int | идентификатор группы записей | |
| isGroup | bool | является ли запись группой | |
| key | int | идентификатор записи | |
| name | string | название, если запись является группой | |
| archived | bool | является ли запись архивной | |
| customData | данные записи | ||
| customData.customValue.field.id | идентификатор поля | ||
| customData.customValue.value | значение поля | ||
| customData.customValue.text | текстовое значение поля |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>