Hub API v1
Operadores
Identifica os operadores de uma organização e os seus serviços de dados abertos.
O GO define um ID único para cada operador de transporte, utilizado nas restantes estruturas de dados. O código code identifica o operador noutros sistemas, como o sistema de bilhética APEX.
Estrutura de dados
O tipo HubV1ApiAgency contém as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
_id | String | ID único do operador. |
code | String | Código do operador noutros sistemas, com até 20 caracteres. |
primary_language | LanguageTag (String) | Idioma principal do operador. |
timezone | TimezoneIdentified (String) | Fuso horário da operação. |
open_data | Object | Informação pública e serviços do operador. |
open_data.details | Object | Dados públicos de contacto. |
open_data.details.name | String | Nome público do operador. |
open_data.details.website_url | String | URL do website. |
open_data.details.fare_url | String | URL de informação sobre tarifas. |
open_data.details.email | String | Email de contacto público. |
open_data.details.phone | String | Contacto telefónico. |
open_data.services | Object | Serviços de dados abertos do operador. |
open_data.services.eta_enabled | Boolean | Geração de estimativas de chegada. |
open_data.services.positions_enabled | Boolean | Publicação de posições de veículos. |
open_data.services.service_alerts_enabled | Boolean | Publicação de alertas de serviço. |
export const HubV1ApiAgencySchema = z.object({
_id: z.string(),
code: z.string().max(20),
open_data: z.object({
details: z.object({
email: z.string().email(),
fare_url: z.string().url(),
name: z.string(),
phone: z.string(),
website_url: z.string().url(),
}),
services: z.object({
eta_enabled: z.boolean().default(false),
positions_enabled: z.boolean().default(false),
service_alerts_enabled: z.boolean().default(false),
}),
}),
primary_language: LanguageTagSchema, // Exemplo: 'pt'
timezone: TimezoneIdentifiedSchema, // Exemplo: 'Europe/Lisbon'
});Os detalhes e os serviços estão dentro de open_data; name, contactos e services não são propriedades de topo. O tipo público atual não contém gtfs_enabled.
Endpoint disponível
| Método | Path | Tipo de data | Descrição |
|---|---|---|---|
| GET | /v1/:organizationId/agencies | HubV1ApiAgency[] | Operadores associados à organização. |
Nota: Obtém o :organizationId na lista de organizações.