Documentos e Relatórios

Para desenvolvedores

Incentivamos os desenvolvedores a acessarem o nosso site. Isso pode ser feito copiando o URL (Uniform Resource Locator  Localizador de Recursos Uniforme) de nossa Barra de Endereços ou construindo a própria API/URL (ver abaixo). Pedimos que você crie links diretamente para nosso site e não enquadre a página do Banco Mundial no banner de seu site.

Dispomos agora de uma forma nova e melhorada de fazer o link para os perfis e resultados dos documentos. Ver documentação e exemplos abaixo.

API constante de Documentos e Relatórios (D&R)

Documentos e Relatórios (D&R) apoiarão URLs simplificados para dois tipos de páginas da Web: páginas de resultados e páginas de perfis de documentos. Envidaremos esforços no sentido de apoiar a API (Application Programming Interface  Interface de Programação do Aplicativo) constante, mesmo se os D&R passarem a uma nova plataforma. Portanto, os usuários não precisarão mudar o link de seus URLs para nossos documentos. 

Os URLs dessas páginas da Web têm três partes. Essas partes em conjunto determinam o seguinte: 1. que aplicação atenderá ao pedido; 2. o tipo de página da Web a ser exibida; e 3. o documento ou conjunto de documentos a serem apresentados nessa página.

Estas três partes juntas utilizam o seguinte formato:

http:///?

Nome do anfitrião

Em termos técnicos a primeira parte do URL indica o nome do anfitrião. Em nosso caso, o nome do anfitrião será documents.worldbank.org. 

Tipo de pedido

A página a ser exibida  a segunda parte do URL  é determinada pelo tipo de pedido. O tipo de pedido será record (registro) ou query (pesquisa). Um pedido de record exibirá o perfil (ou registro de dados) pertencente a um determinado documento. Um pedido de query exibirá um conjunto de documentos correspondentes à query. 

Tipo de pedido

Página exibida

record

Perfil completo de determinado documento com um ou mais links para o próprio documento.

query

Uma query (pesquisa) define um conjunto de documentos apresentados como lista ou tabela.

 

Lista de parâmetros

A terceira e última parte do URL compõe-se de um ou mais parâmetros e de seus valores. Esses parâmetros e valores especificam o documento ou conjunto de documentos apresentados na página. A lista de parâmetros e dos respectivos valores é separada do tipo de pedido que o precede pelo caractere ?. 

O record (registro) pede um parâmetro único e requerido  docid  cujo valor é o identificador ImageBank ou D&R para o documento do perfil a ser exibido na página. O nome do parâmetro  docid  é separado de seu valor pelo sinal =.

Além do parâmetro docid, o record requer também o apoio de um parâmetro adicional: pageLanguage (idioma da página). Este parâmetro determina o idioma da página que exibe o record e pode ser usado por sites que não utilizam o idioma inglês para apresentar documentos do ImageBank no idioma do site. Atualmente há suporte para os seguintes idiomas: francês, espanhol, chinês, árabe e russo.

Nome do parâmetro

Uso

docid

D&R ID do documento cujo perfil será exibido.

pageLanguage

O record é exibido no idioma da página. Favor usar os seguintes códigos de duas letras: ar (árabe), zh (chinês), ru (russo), es (espanhol), fr (francês).

Por exemplo:

documents.worldbank.org/record?docid=000160016_20040929135419

Os pedidos de query solicitam um conjunto de documentos apresentados como uma lista na página exibida. Os pedidos de query podem ter um ou mais parâmetros. Cada parâmetro adicional especifica ou restringe de maneira mais rígida o que será exibido. Esses parâmetros correspondem a um atributo no record ou perfil do documento. Todo nome do parâmetro é separado de seu valor pelo sinal =. Quando se usa mais de um parâmetro / par de valor, cada novo par é separado do anterior pelo caractere &. Nenhum caractere & é colocado antes do primeiro par. Para pesquisar mais de um valor para um atributo, o usuário deverá incluir um parâmetro adicional / pares de valor para esse atributo (cada qual com um único valor) ou usar o nome do parâmetro uma vez e listar os valores, separando-os por um espaço. Pesquisar valores múltiplos para um atributo aumenta o número de documentos exibidos, uma vez que os documentos de cada valor passado podem estar incluídos nos resultados.

Tal como os pedidos de record, os pedidos de query também podem ser especificados no idioma dos resultados exibidos na página Web. Atualmente são usados os idiomas francês, chinês, árabe e russo.

Nome do parâmetro

Valor

Uso

texto

texto

uma ou mais palavras

título

texto

o título do documento

coleção

texto

o título da coleção à qual pertence o documento

sourceCitation

Texto

a citação da fonte

autor

texto

o autor do documento

região

texto ou ID

a região à qual pertence o documento

país

texto ou ID

o país ao qual pertence o documento

setor

texto ou ID

o setor ao qual pertence o documento

subsetor

texto ou ID

o subsetor ao qual pertence o documento

tópico

texto ou ID

um tópico tratado no documento

majorDocType

texto ou ID

o tipo de documento principal ao qual pertence o documento

docType

texto ou ID

o documento

idioma

texto ou ID

o idioma no qual o documento é escrito ou no qual é traduzido

data

aaaa/mm/dd)

a data em que o documento foi apresentado ou publicado

startDate

aaaa/mm/dd)

o início do período. Os documentos exibidos devem ser apresentados ou publicados nessa data ou após a mesma. Pode ser usado com ou sem endDate.  Quando não se usa endDate, o período termina com o atual.

endDate

aaaa/mm/dd)

o fim do período. Os documentos exibidos devem ser apresentados ou publicados nessa data ou antes da mesma. Pode ser usado com ou sem startDate. Quando não se usa startDate, o período inclui todas as datas anteriores ao atual.

relatório

ID

o número do relatório designado a esse documento

empréstimo

ID

o número do empréstimo ao qual pertence o documento

crédito

ID

o número do crédito associado ao documento

projeto

texto ou ID

o nome ou ID do projeto ao qual pertence o documento

trustFund

ID

o fundo fiduciário ao qual está associado o documento

pageSize

número

Número de resultados a serem exibidos por página (no máximo 50)

pageLanguage

ID

o idioma da página exibida no record. Atualmente são usados os idiomas francês e espanhol. 

sortBy

O atributo (data, título, relatório ou docType) segundo o qual os resultados serão classificados.  A classificação é feita em ordem ascendente, exceto no caso da data, a qual é exibida em ordem descendente.

Figuram, a seguir, alguns exemplos:

Listar documentos sob um único tópico...

documents.worldbank.org/query?topic=Education

Listar documentos relacionados a um único tópico e país...

documents.worldbank.org/query?country=China&topic=Education

Exibir todos os documentos publicados ou liberados em data determinada...

documents.worldbank.org/query?date=2004/2/4

Exibir todos os documentos publicados ou liberados segundo um tópico publicado ou liberado entre duas datas.

documents.worldbank.org/query?startDate=2004/1/1&endDate=2004/2/1&topic=Education

Exibir todos os documentos em árabe...

documents.worldbank.org/query?language=Arabic

Exibir todos os documentos com base na Unidade proprietária...

documents.worldbank.org/query?owner_exact=Development+Committee+(DCS)