Мы призываем разработчиков прописывать ссылки на наш сайт. Это можно сделать, скопировав из адресной строки или написав свой собственный API/URL (см. ниже). Мы в обязательном порядке требуем, чтобы ссылки на наш сайт были прямыми, использование на вашем сайте баннеров для перехода на страницу Банка недопустимо.
Мы разработали новый, усовершенствованный механизм организации ссылок на профили документов и результаты. См. документацию и примеры ниже.
Инвариант API - Документы и доклады
Сайт "Документы и доклады" (D&R) поддерживает упрощенные URL для страниц двух типов: страницы результатов и страницы профилей документов. Мы гарантируем поддержку инварианта API, даже если наш сайт в будущем перейдет на новую платформу, и пользователям не придется изменять URL-ссылки на наши документы.
URL для указанных страниц состоят из трех частей. Эти части вместе определяют (1) какое приложение обрабатывает запрос, (2) тип отображаемой страницы и (3) документ или пакет документов, который будет представлен на этой странице.
Три указанные выше части вместе имеют следующую форму.
http:///?
Имя хост-узла
В техническом смысле первая часть URL обозначает имя хост-узла. В нашем случае это "documents.vsemirnyjbank.org".
Тип запроса
То, какая страница будет отображаться, определяется типом запроса по второй части URL. Тип запроса может быть либо "record" (информационная запись), либо "query" (поисковый вопрос). Запрос типа "record" отображает профиль (или информационную запись), принадлежащую конкретному документу. Запрос типа "record" отобразит набор документов, соответствующих заданному вопросу.
| Тип запроса | Отображаемая страница |
|---|---|
| информационная запись | Полный профиль отдельного документа с одной или более ссылок на документ. |
| поисковый вопрос | Вопрос, объединяющий набор документов, представленных в виде перечня или таблицы. |
Список параметров
Третья и последняя часть URL состоит из одного или более параметров и их значений. Такие параметры и значения точно устанавливают, какой документ или набор документов будет представлен на странице. Список параметров и их значений отделяется от предшествующего ему типа запроса знаком "?".
Запросы типа "record" ограничиваются единственным заданным параметром – "docid" - значение которого сводится к идентификатору ImageBank или D&R для искомого аннотированного документа, который будет отображаться на странице. Имя параметра "docid" отделяется от его значения знаком "=".
Кроме параметра "docid" запрос типа "record" также поддерживает дополнительный параметр – "pageLanguage" (язык страницы). Этот параметр определяет язык страницы, отображающей запись, и он может использоваться сайтами, написанными на других языках (помимо английского), для отображения документов ImageBank на языке сайта. В настоящее время поддерживаются запросы для французского и испанского языков.
| Наименование параметра | Использование |
|---|---|
| docid | Идентификатор D&R к документу, профиль которого требуется отобразить |
| pageLanguage | Язык страницы, отображающей запись. Пока недоступно. |
Пример:
documents.vsemirnyjbank.org/record?docid=000160016_20040929135419
Запросы типа "query" - это запросы на отображение на странице набора документов в виде перечня. Запросы типа "query" могут иметь один или более параметров. Каждый дополнительный параметр более четко определяет или ограничивает содержание отображаемых данных. Такие параметры привязаны к записи или профилю документа. Наименование каждого параметра отделяется от его значения знаком "=". В случае, если используется несколько параметров/значений, каждая новая пара отделяется от предыдущей символом "&". Перед первой парой символ "&" не ставится. Чтобы сделать запрос по нескольким значениям определяющего признака информационной записи или профиля документа, следует либо включить дополнительные пары параметр/значение (каждая пара имеет свое единичное значение), либо однократно использовать наименование параметра и составить перечень значений, разделяя их пробелами. Запрос по множеству значений для одного определяющего признака информационной записи или профиля документа увеличивает количество отображаемых документов, так как в результаты могут быть включены документы, соответствующие каждому отдельному значению.
Аналогично запросам типа "record", запросы типа "query" могут также указывать язык страницы отображения результатов. В настоящее время поддерживаются французский и испанский языки.
| Наименование параметра | Значение | Использование |
|---|---|---|
| text | text | одно или несколько слов |
| title | text | название документа |
| collection | text | название сборника, в который входит документ |
| sourceCitation | Text | указание на источник |
| author | text | автор документа |
| region | text or ID | регион, к которому относится документ |
| country | text or ID | страна, к которой относится документ |
| sector | text or ID | сектор, к которому относится документ |
| subsector | text or ID | подсектор, к которому относится документ |
| topic | text or ID | тема документа |
| majorDocType | text or ID | основной тип документа, к которому относится документ |
| docType | text or ID | документ |
| language | text or ID | язык, на котором написан или на который переведен документ |
| date | yyyy/mm/dd | дата представления или публикации документа |
| startDate | yyyy/mm/dd | начальная дата временного периода. Отображаемые документы должны быть представлены или опубликованы, начиная с указанной даты. Можно использовать c указанием и без указания Конечной даты (endDate). Если Конечная дата не используется, временной период ограничивается настоящим моментом. |
| endDate | yyyy/mm/dd | конечная дата временного периода. Отображаемые документы должны быть представлены или опубликованы до или в указанную дату. Можно использовать с указанием и без указания Начальной даты (startDate). Если Начальная дата не используется, временной период включает в себя все даты до настоящего момента. |
| report | ID | номер доклада, присвоенный этому документу. |
| loan | ID | номер займа, к которому относится документ |
| credit | ID | номер кредита, относящийся к этому документу |
| project | text or ID | название или идентификационный номер проекта, к которому относится документ |
| trustFund | ID | трастовый фонд, к которому относится этот документ |
| pageSize | number | количество отображаемых результатов на одной странице (до 50) |
| pageLanguage | ID | язык страницы, отображающей запись. В настоящее время поддерживаются французский и испанский языки. |
| sortBy | определяющий признак ("дата", "название", "доклад" или "тип документа") для сортировки результатов. Сортировка осуществляется по восходящей за исключением сортировки по дате (в нисходящем порядке). |
Вот несколько примеров.
Для отображения списка документов по одной теме...
documents.vsemirnyjbank.org/query?topic=Education
Для отображения документов по одной теме и стране…
documents.vsemirnyjbank.org/query?country=China&topic=Education
Для отображения документов, опубликованных или выпущенных в определенную дату…
documents.vsemirnyjbank.org/query?date=2004/2/4
Для отображения документов, опубликованных или выпущенных по теме в период между двумя
датами….
documents.vsemirnyjbank.org/query?startDate=2004/1/1&endDate=2004/2/1&topic=Agriculture
Для отображения всех документов на арабском языке...
documents.vsemirnyjbank.org/query?language=Arabic