Geohub API
A superfície HTTP do Geohub: autenticação, os plugins de jornada e de ocorrência (gerados do manifesto, RDT-027), o webhook e as consultas de veículo.
Esta página é gerada a partir dos mesmos schemas que validam as requisições em runtime — o que está documentado aqui é o que o endpoint aceita. A spec crua está em /openapi.json.
Consultas são contabilizadas
As consultas de placa são cobradas/limitadas pelas fontes externas — o SSP-AL devolve consultasRestantes em cada resposta. Esta documentação não tem console de execução de propósito. Para experimentar sem gastar cota, use os simuladores dos provedores.
Autenticação
Todas as chamadas, exceto /auth/*, exigem um usuário autenticado. Envie o access_token devolvido por POST /auth/login como Bearer:
Authorization: Bearer <access_token>O cookie de sessão do painel também é aceito. Sem usuário autenticado a resposta é 403 FORBIDDEN.
Erros
Erros usam o envelope padrão do Geohub:
{
"errors": [
{
"extensions": { "code": "INVALID_PAYLOAD" },
"message": "Formato de placa inválido"
}
]
}| Status | Código | Quando |
|---|---|---|
| 400 | INVALID_PAYLOAD | Parâmetro ausente ou fora do formato. |
| 403 | FORBIDDEN | Sem usuário autenticado. |
| 503 | SERVICE_UNAVAILABLE | Falha ao consultar as fontes. A mensagem é genérica de propósito, para não expor detalhe interno. |
Cuidados de leitura
Três campos costumam ser interpretados errado:
omitir_alertatem três estados, não dois:true(omitir),false(não omitir — furto/roubo recente confirmado) enull(nenhuma fonte soube responder). Umif (!omitir_alerta)trata "não sei" como "não omitir" — é o lado seguro, mas apaga a distinção.registrado_emnão éatualizado_em. O primeiro é a data do fato, que a própria fonte informa, e é o que tem significado de negócio. O segundo é quando o dado foi confirmado. Ordenar poratualizado_empara achar "o furto mais recente" dá a resposta errada.interessesé best-effort. Uma lista vazia pode significar "nenhum interesse" ou "a busca falhou" — hoje não há campo que distinga os dois.
Em /consulta-placa, ramifique por provider antes de tocar em data: o payload preserva o formato nativo da fonte que respondeu, e Detran-ES e SSP-AL têm formatos bem diferentes. A ordem das fontes é configurada por ambiente, então a fonte que responde pode variar.
Operações
Superfície HTTP que o @geocontrol/geohub-sdk consome: autenticação e as consultas de veículo do Geohub.
Esta spec é gerada a partir dos schemas que validam as requisições em runtime — o que está documentado aqui é o que o endpoint aceita.
Consultas de placa são contabilizadas pelas fontes externas (o SSP-AL devolve consultasRestantes). Não use esta documentação como console de testes contra um ambiente real.
Servers
Autenticação
Endpoints de autenticação do Geohub. Documentados aqui no mínimo necessário para autenticar.
Autentica e devolve os tokens
Endpoint de autenticação do Geohub. Devolve access_token e refresh_token; use o primeiro como Bearer nas demais chamadas.
Request Body
"email"Código TOTP, quando a conta tem 2FA habilitado.
Responses
Autenticado.
Samples
Renova o access_token
Encerra a sessão
Dados do usuário autenticado
Endpoint de autenticação do Geohub.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Responses
Usuário atual.
Samples
Jornada — plugin exposto
Jornada, guarnição e disponibilidade: pôr o policial em serviço, constituir a guarnição numa viatura e declarar a prontidão. É daqui que sai o pool de despacho que a ocorrência consome.
Operations
UC-06 — o policial compareceu. A jornada nasce `apresentada`: ainda não trabalha (RS-02).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
1Responses
O verbo executou.
Samples
UC-14 — entra em serviço no posto ocupado (T-127).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de iniciarJornada. Sem os campos que a rota lê do caminho: id.
A modalidade de serviço (T-130) é id do catálogo do deployment: rádio patrulhamento é vocabulário da PM, o núcleo não lista nenhuma.
Responses
O verbo executou.
Samples
UC-40 — sai de serviço, com as pendências formalizadas (RS-10).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de encerrarJornada. Sem os campos que a rota lê do caminho: id.
Responses
O verbo executou.
Samples
UC-41 — fim do escopo do sistema (UFE-04).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
UC-26 — pausa do indivíduo; a guarnição não para.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de iniciarPausa. Sem os campos que a rota lê do caminho: jornadaId.
Tipo da pausa (UC-26).
"refeicao_principal""lanche""descanso_regulamentar""pessoal""medica""tecnica""administrativa""abastecimento""manutencao_emergencial"Responses
O verbo executou.
Samples
UC-30 — quem estava em pausa volta ao estado anterior.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
UC-29 — interrompida ≠ concluída: o motivo é dado de gestão de pessoal.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de interromperPausa. Sem os campos que a rota lê do caminho: id.
1Responses
O verbo executou.
Samples
O pool de despacho: só as `disponivel`.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Responses
O verbo executou.
Samples
UC-08 — monta a guarnição numa viatura e devolve o id dela. `viatura-ja-tem-guarnicao` se já há uma não terminal.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Request Body
A guarnição que se constitui numa viatura (UC-08, T-122).
O prefixo operacional da viatura (RP-1207). Texto, e não uuid: é esse o identificador que o despachante conhece.
1Responses
O verbo executou.
Samples
T-128 — troca no turno; a composição anterior fica (D-12).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de substituirIntegrante. Sem os campos que a rota lê do caminho: guarnicaoId.
O policial: o id dele no Geohub, ou, na sessão de integrador, o id do integrador (a matrícula), que a exposição traduz nas duas direções.
1Responses
O verbo executou.
Samples
Desfaz guarnição que nunca operou.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de dissolverGuarnicao. Sem os campos que a rota lê do caminho: guarnicaoId.
1Responses
O verbo executou.
Samples
T-124 — o comandante assume, com a própria jornada já iniciada.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de assumirComando. Sem os campos que a rota lê do caminho: guarnicaoId.
Id da jornada no Geohub.
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
UC-15 — a guarnição entra no pool de despacho. `comando-nao-assumido` antes de `assumirComando`.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Sai do pool sem pausa.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de retirarDeProntidao. Sem os campos que a rota lê do caminho: guarnicaoId.
1Responses
O verbo executou.
Samples
UC-28 no escopo guarnição — a equipe para junto.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de iniciarPausaDaGuarnicao. Sem os campos que a rota lê do caminho: guarnicaoId.
Tipo da pausa (UC-26).
"refeicao_principal""lanche""descanso_regulamentar""pessoal""medica""tecnica""administrativa""abastecimento""manutencao_emergencial"Responses
O verbo executou.
Samples
UC-32 — encerrar o turno da equipe.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Fecha o que o comando solicitou. Terminal.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
O agregado da jornada.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
A jornada não terminal do policial.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
1Responses
O verbo executou.
Samples
O agregado da pausa.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
O agregado da guarnição.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
A guarnição não terminal da viatura, em qualquer status.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
1Responses
O verbo executou.
Samples
A guarnição não terminal que o policial integra.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
1Responses
O verbo executou.
Samples
A porta do registro em campo: a guarnição `disponivel` de quem pergunta, já na forma que vira recurso despachável.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
1Responses
O verbo executou.
Samples
A porta do despacho pela central: a guarnição `disponivel` da viatura. Ausente = viatura sem guarnição disponível.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
1Responses
O verbo executou.
Samples
Ocorrência — plugin exposto
Ocorrência e despacho: registrar, designar recurso e acompanhar o atendimento. Uma ocorrência pode ter vários despachos, cada um com status próprio — uma viatura no local não é a ocorrência no local.
Operations
As não terminais, da mais antiga à mais recente.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Responses
O verbo executou.
Samples
Registra uma ocorrência e devolve o id dela.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Request Body
O que se informa ao registrar. Sem registradaEm vale o relógio do Geohub (T-010). referenciaExterna é o protocolo no sistema de origem — é por ela que o originador reconhece a própria ocorrência. Obrigatória para o integrador e imutável; identifica uma só ocorrência por originador (repetida: 409 referencia-externa-ja-registrada, com o id em erro.contexto).
Natureza, subnatureza, prioridade e gravidade (T-021..T-028). Prioridade e gravidade são dimensões diferentes (D-06).
Coordenada, endereço e referência convivem porque raramente vêm juntos: a central pode ter só o endereço, o app só a coordenada.
Quem pediu o atendimento (T-011). Mínimo necessário (RS-11): registra-se o efeito operacional, não a vida da pessoa.
1"date-time""^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"Responses
O verbo executou.
Samples
O agregado da ocorrência.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Complementa os dados de negócio; status muda por verbo próprio.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de atualizarOcorrencia. Sem os campos que a rota lê do caminho: id.
Responses
O verbo executou.
Samples
Risco imediato estabilizado (T-078).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Encerra a ocorrência e os despachos abertos em cascata (RS-08).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Interrompe sem atendimento completo (T-080).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de cancelarOcorrencia. Sem os campos que a rota lê do caminho: id.
1Responses
O verbo executou.
Samples
Os despachos de uma ocorrência, em qualquer status.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Designa um recurso já resolvido e devolve o id do despacho.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de despachar. Sem os campos que a rota lê do caminho: ocorrenciaId.
Recurso operacional que pode receber despacho. Conceito do domínio de ocorrência: não referencia tabela do SIGA (D5).
Responses
O verbo executou.
Samples
Interrompe a designação (T-070).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de cancelarDespacho. Sem os campos que a rota lê do caminho: id.
1Responses
O verbo executou.
Samples
Aceito por um integrante, aceito pela guarnição (UC-18).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Declara impossibilidade de atender (T-065).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de recusarDespacho. Sem os campos que a rota lê do caminho: id.
1Responses
O verbo executou.
Samples
A caminho (UC-19).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
No local (UC-20). A primeira chegada leva a ocorrência a em_atendimento.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Uma ação da narrativa (UC-23).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de registrarAcao. Sem os campos que a rota lê do caminho: despachoId.
Uma ação operacional (T-081); a sequência é a narrativa.
Responses
O verbo executou.
Samples
A situação observada; só no local (UC-21).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de atualizarSituacao. Sem os campos que a rota lê do caminho: despachoId.
Responses
O verbo executou.
Samples
Pede reforço ou outro apoio (UC-22).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de solicitarApoio. Sem os campos que a rota lê do caminho: despachoId.
Responses
O verbo executou.
Samples
Encerra a participação DESTE recurso, não a ocorrência (UC-24).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Request Body
O argumento de encerrarDespacho. Sem os campos que a rota lê do caminho: id.
O resultado da participação da equipe (T-084). Encerra o DESPACHO; não encerra a ocorrência (RS-08).
Responses
O verbo executou.
Samples
A ocorrência nasce já com a própria guarnição despachada e aceita.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Header Parameters
Chave de idempotência, UUIDv7 gerado pelo CLIENTE, uma por comando: repetir o MESMO comando com a mesma chave devolve o mesmo desfecho sem executar de novo. A sessão de integrador é obrigada a mandá-la.
"uuid"Request Body
Um verbo só, e não a sequência dos de cima, porque quem chama está no celular: pela rede, cinco chamadas deixam o despacho pela metade quando o sinal cai entre elas.
O que se informa ao registrar. Sem registradaEm vale o relógio do Geohub (T-010). referenciaExterna é o protocolo no sistema de origem — é por ela que o originador reconhece a própria ocorrência. Obrigatória para o integrador e imutável; identifica uma só ocorrência por originador (repetida: 409 referencia-externa-ja-registrada, com o id em erro.contexto).
Recurso operacional que pode receber despacho. Conceito do domínio de ocorrência: não referencia tabela do SIGA (D5).
"no_local""a_caminho"Responses
O verbo executou.
Samples
O agregado do despacho.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
O que o policial lista (UC-17).
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
A narrativa do atendimento (T-094), em ordem cronológica.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Path Parameters
"uuid""^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"Responses
O verbo executou.
Samples
Diz se o alerta da placa deve ser omitido
Agrega Geohub, Detran-ES e SSP-AL. Devolve também os interesses (ocorrências de furto/roubo) encontrados.
Atenção ao tri-state de omitir_alerta: null significa que nenhuma fonte soube responder, e é diferente de false.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Query Parameters
Placa do veículo, no padrão brasileiro ou Mercosul.
"ABC1234""ABC1D23"Responses
Resultado da verificação.
Samples
Dados cadastrais do veículo pela placa
Ao menos um de placa, placa_original ou placa_corrigida é obrigatório.
Consulta Detran-ES e SSP-AL Videomonitoramento. A ordem das fontes e a estratégia são configuradas por ambiente, então a fonte que responde pode variar — ramifique por provider.
Com formato=html a resposta é text/html (uma página pronta para exibir), não JSON.
Authorizations
O access_token devolvido por POST /auth/login. Também é aceito o cookie de sessão do painel.
Parameters
Query Parameters
Placa do veículo, no padrão brasileiro ou Mercosul.
"ABC1234""ABC1D23"Placa como o LPR leu.
"ABC1234""ABC1D23"Correção manual do operador. TEM PRECEDÊNCIA: é ela que a consulta usa. A ordem é placa_corrigida → placa_original → placa.
"ABC1234""ABC1D23"Texto livre. Registrado na auditoria e ecoado no JSON.
"json""html"Só com formato=html. Em true, serve o template pré-renderizado (sem JS, tema fixo, sem aviso de placa corrigida).
"true"Cor primária do tema da página HTML, hex #RGB ou #RRGGBB. Só no HTML com Vue. Valor fora do padrão é DESCARTADO em silêncio, caindo no tema padrão — não gera erro.
"#1B517F"Forma um degradê com cor. Ignorada se cor não for informada.
"#F58220"Responses
Dados do veículo. Union discriminada por provider.