Hub API v1

Alertas

Descobre o que é um alerta de serviço de uma operação de transportes públicos.

Um Alerta de Serviço são mensagens que os operadores de transporte disponibilizam ao público para informar de alterações programadas, desvios inesperados, cancelamentos, atrasos, etc. São fundamentais para garantir que os utilizadores de transporte se possam organizar com antecedência ou encontrar alternativas em caso de imprevistos pontuais.

Os alertas referenciam objetos da rede de transporte, como paragens, linhas ou viagens, afetando-as com uma causa e um efeito. No GO Hub seguimos a especificação do GTFS-RT Service Alerts para tipificar um alerta. Adicionalmente, o GO Hub disponibiliza propriedades que podem ser úteis para tornar a informação mais intuitiva e legível.

Estrutura de um alerta

No Hub, um alerta é representado por um objeto JSON com as seguintes propriedades:

PropriedadeTipoDescrição
_idStringID único do alerta.
agency_idStringID único do operador associado ao alerta.
titleStringTítulo do alerta.
descriptionStringDescrição do alerta.
causeStringCausa do alerta de acordo com a especificação do GTFS-RT.
effectStringEfeito do alerta de acordo com a especificação do GTFS-RT.
coordinates[Latitude, Longitude] | nullCoordenadas do alerta.
active_period_start_dateUnixMilliseconds (Integer)Data de início do período de atividade do alerta (inclusive).
active_period_end_dateUnixMilliseconds (Integer)Data de fim do período de atividade do alerta (inclusive).
image_urlStringURL da imagem do alerta.
info_urlStringURL da informação do alerta.
municipality_idsStringIDs dos municípios associados ao alerta.
reference_typeStringTipo de referência do alerta.
referencesStringReferências do alerta.
export const HubV1ApiAlertSchema = z.object({
	_id: z.string(),
	agency_id: z.string(),
	title: z.string(),
	description: z.string(),
	cause: GtfsRtCauseSchema,
	effect: GtfsRtEffectSchema,
	coordinates: z.tuple([z.number(), z.number()]).nullable().default(null),
	active_period_start_date: UnixMillisecondsSchema,
	active_period_end_date: UnixMillisecondsSchema.nullable().default(null),
	image_url: z.string().nullable().default(null),
	info_url: z.union([z.string().url(), z.literal('')]).nullable().default(null),
	municipality_ids: z.array(z.string()).default([]),
	reference_type: AlertReferenceTypeSchema,
	references: z.array(AlertReferenceSchema).default([]),
});

Endpoints disponíveis

Com estes endpoints consegues ir buscar informação de desvios, supressões, alterações de oferta, novos horários, etc. que os vários operadores de transporte publicam ao público. Em muitos casos, são estes endpoints que são disponibilizados às aplicações de planeamento, como Google Maps, Transit, CityMapper, etc.

PathDescrição
/v1/alertsTodos os alertas de serviço publicados no GO, em JSON.
/v1/alerts.rssTodos os alertas de serviço publicados no GO, no formato RSS.
/v1/alerts/gtfsTodos os alertas de serviço publicados no GO, em JSON, mas no formato GTFS-RT Service Alerts.
/v1/alerts/gtfs.pbTodos os alertas de serviço publicados no GO, em Protobuf e no formato GTFS-RT Service Alerts.

On this page