Resumo do tipo solicitação

atenção

Em desenvolvimento - ainda não disponível em produção

Retorna as informações necessárias para orientar a abertura de uma solicitação: orientação ao operador, prazo, se o tipo aceita novas solicitações, se aceita endereço e qual formulário dinâmico utiliza.

dica

Para obter o ID do tipo solicitação, utilize Pesquisar Tipos Solicitação. Quando idFormulario vier preenchido, os campos do formulário podem ser consultados em Consultar modelo de registro.

Endpoints

Método	URL
GET	https://{{url}}/cube/api/v3/tipos-solicitacao/{{idTipoSolicitacao}}/resumo

Respostas

Exemplo de corpo da resposta

{
    "id": 738,
    "titulo": "Lâmpada apagada",
    "orientacao": "<p>Informe o endereço completo e um ponto de referência.</p>",
    "status": "ATIVO",
    "disponivel": true,
    "prazo": {
        "tempo": 7,
        "unidade": "DIA"
    },
    "prazoConclusao": "2026-11-10T14:00:00.000Z",
    "permiteEndereco": true,
    "anonimo": false,
    "idFormulario": 123
}

Chave	Descrição
id	ID do tipo solicitação
titulo	Nome do tipo solicitação
orientacao	Orientação ao operador, em HTML. Pode conter marcação de editor (estilos, links); remova o HTML antes de ler ou falar o texto
status	Status do cadastro: ATIVO, INATIVO, INVISIVEL, RASCUNHO etc.
dataInicioVigencia / dataFinalVigencia	Período de vigência. Só aparecem quando configurados
disponivel	true quando o tipo está ATIVO e dentro da vigência, ou seja, aceita novas solicitações
prazo.tempo / prazo.unidade	Prazo de atendimento configurado no SLA. Unidades: HORA, DIA, SEMANA ou MES. Não aparece quando o tipo não tem SLA
prazoConclusao	Data prevista de conclusão para uma solicitação aberta agora
permiteEndereco	Indica se o tipo aceita endereço na abertura
anonimo	Indica se o tipo aceita abertura anônima
idFormulario	ID do formulário dinâmico do tipo. Não aparece quando o tipo não tem formulário

cuidado

Verifique disponivel antes de oferecer o serviço ao munícipe: a abertura de solicitação em um tipo indisponível é recusada (tipo.solicitacao.indisponivel). Em desenvolvimento - ainda não disponível em produção.

Status da resposta

Status	Descrição
200	OK - Retorna o resumo.
401	API Key, Secret ou Client ID inválidos.
404	Tipo solicitação não encontrado.
429	Limite de requisições excedido.