REST API

A API de acesso aos dados pode ser acessada pelos endereços web iniciados em http://rest.riob.us

Endereços

API v3

/v3/itinerary/:line

Retorna os dados do itinerário referente à linha descrita em line.

Itinerário
Chave	Tipo	Conteúdo
line	String	Código da linha do ônibus. Pode conter letras e números
description	String	Descrição do itinerário da linha.
agency	String	Nome da agência responsável pela linha.
spots	PontoItinerário[]	Lista de pontos localizados ao longo do trajeto do itinerário.

PontoItinerário
Chave	Tipo	Conteúdo
latitude	Double	Valor decimal da latitude onde se encontra o dado.
longitude	Double	Valor decimal da longitude onde se encontra o dado.
returning	Boolean	Identifica se o ponto faz parte do trajeto de ida ou volta.

Entrada	Código da linha
Saída	Itinerário

/v3/itinerary

Retorna uma lista com todos as linhas e as descrições de seus itinerários.

Linha
Chave	Tipo	Conteúdo
line	String	Código da linha do ônibus. Pode conter letras e números
description	String	Descrição do itinerário da linha.

Saída

Linha[]

/v3/search/:data

Realiza a busca filtrada pelo dados contido no trecho representado por data na URI.

Onibus
Chave	Tipo	Conteúdo
line	String	Código da linha do ônibus. Pode conter letras e números
order	String	Código identificador do ônibus. Pode conter letras e números
speed	Integer	Velocidade instantânea do ônibus no momento da coleta
direction	Integer	Direção, medida em graus, para a qual o ônibus estava apontado no momento da coleta
latitude	Double	Dado decimal da latitude (até 6 casas decimais) onde se encontrava o carro no momento da coleta
longitude	Double	Dado decimal da longitude (até 6 casas decimais) onde se encontrava o carro no momento da coleta
sense	String	Descrição do sentido do itinerário no qual o ônibus está se deslocando
timeStamp	String	Data e horário, com precisão de segundos, do momento da coleta do dado no padrão ISODATE

Entrada	Lista de linhas ou códigos de carros separados por vírgula
Saída	Onibus[]

/v3/bus/stop/:line

Realiza a busca pelos pontos de parada dos ônibus filtrada pela linha contida no trecho representado por line na URI.

PontoOnibus
Chave	Tipo	Conteúdo
line	String	Código da linha do ônibus. Pode conter letras e números
description	String	Descrição do itinerário da linha.
agency	String	Nome da agência responsável pela linha.
spots	PontoParada[]	Lista de pontos localizados ao longo do trajeto do itinerário.

PontoParada
Chave	Tipo	Conteúdo
latitude	Double	Valor decimal da latitude onde se encontra o dado.
longitude	Double	Valor decimal da longitude onde se encontra o dado.
sequential	Integer	Número identificador de sequência ordenada de modo ascendente.

Entrada	Código da linha
Saída	PontoOnibus

API v2 (depreciado)

/v2/search (depreciado)

Retorna uma lista com todos os ônibus acompanhados pelo serviço e fornecidos na última coleta de dados.

Onibus
Chave	Tipo	Conteúdo
line	String	Código da linha do ônibus. Pode conter letras e números
order	String	Código identificador do ônibus. Pode conter letras e números
speed	Integer	Velocidade instantânea do ônibus no momento da coleta
direction	Integer	Direção, medida em graus, para a qual o ônibus estava apontado no momento da coleta
latitude	Double	Dado decimal da latitude (até 6 casas decimais) onde se encontrava o carro no momento da coleta
longitude	Double	Dado decimal da longitude (até 6 casas decimais) onde se encontrava o carro no momento da coleta
sense	String	Descrição do sentido do itinerário no qual o ônibus está se deslocando
timeStamp	String	Data e horário, com precisão de segundos, do momento da coleta do dado no padrão ISODATE

Saída

Onibus[]

/v2/itinerary/:line (depreciado)

Retorna uma lista de dados do itinerário referente à linha descrita em line.

Itinerário
Chave	Tipo	Conteúdo
sequential	Integer	Número identificador de sequência ordenada de modo ascendente.
line	String	Código da linha do ônibus. Pode conter letras e números
description	String	Descrição do itinerário da linha.
agency	String	Nome da agência responsável pela linha.
shape	Integer	Identificador do shape.
latitude	Double	Valor decimal da latitude onde se encontra o dado.
longitude	Double	Valor decimal da longitude onde se encontra o dado.

Entrada	Código da linha
Saída	Itinerário[]

/v2/search/:platformId/:data (depreciado)

Realiza a busca filtrada pelo dados contido no trecho representado por data na URI. O campo platformId é um identificador de plataforma.

Onibus
Chave	Tipo	Conteúdo
line	String	Código da linha do ônibus. Pode conter letras e números
order	String	Código identificador do ônibus. Pode conter letras e números
speed	Integer	Velocidade instantânea do ônibus no momento da coleta
direction	Integer	Direção, medida em graus, para a qual o ônibus estava apontado no momento da coleta
latitude	Double	Dado decimal da latitude (até 6 casas decimais) onde se encontrava o carro no momento da coleta
longitude	Double	Dado decimal da longitude (até 6 casas decimais) onde se encontrava o carro no momento da coleta
sense	String	Descrição do sentido do itinerário no qual o ônibus está se deslocando
timeStamp	String	Data e horário, com precisão de segundos, do momento da coleta do dado no padrão ISODATE

platformId
Valor	Descrição
1	cliente web
2	cliente mobile
3	cliente legado
>3	outros clientes

Entrada	platformId: identificador de cliente data: Código da linha
Saída	Onibus[]

/v2/log/dataprovider/:lines

Retorna um trecho do log de execução do serviço que coleta os dados no servidor externo, limitado pelo número de linhas definido em lines.

Entrada	Número de linhas de log a carregar do log
Saída	String

/v2/log/runtime/:lines

Retorna um trecho do log de tempo de execução das operações do servidor, limitado pelo número de linhas definido em lines.

Entrada	Número de linhas de log a carregar do log
Saída	String

/v2/log/server/:lines

Retorna um trecho do log de execução das operações do servidor, limitado pelo número de linhas definido em lines.

Entrada	Número de linhas de log a carregar do log
Saída	String