Bootstrap PD Book

Публичное API

Цель публичного API - предоставить информацию о структуре документов.

Информация предоставляется в виде набора документов, и для интеграции важно понимать какие типы документов можно запросить, а также каков полный набор полей, который может вернуть система Персональные данные.

Все запросы должны быть направлены к https://api.pdbook.ru/api/public

Endpoints

Список доступных запросов.

GET /types

Вернет список типов документов, с которым знакома система.

GET /schema/{type}

Вернет список полей документа указанного типа. В качестве типа нужно использовать один из известных типов документов, из списка /types

Пример ответа

GET https://api.pdbook.ru/api/public/schema/HospitalRecord

{
  "endpoint":"public\/schema",
  "type":"HospitalRecord",
  "ok":true,
  "schema":[
    {"weight":1,"apiTitle":"name","type":"text","isTransferable":true,"isDeletable":false,"isMulty":false,"isReady":true},
    {"weight":2,"apiTitle":"phone","type":"reference:phoneRecord","isTransferable":true,"isDeletable":false,"isMulty":true,"isReady":true},
    {"weight":3,"apiTitle":"address","type":"reference:addressRecord","isTransferable":true,"isDeletable":false,"isMulty":false,"isReady":true},
    {"weight":4,"apiTitle":"working-hours","type":"schedule","isTransferable":true,"isDeletable":false,"isMulty":false,"isReady":true},
    {"weight":5,"apiTitle":"comment","type":"textarea","isTransferable":false,"isDeletable":true,"isMulty":true,"isReady":false}
  ]
}

Как видно из примера, вложенные документы маркируются составным значением поля type, который начинается с префикса reference