Sistema Protocolo Integrado - Serviços

• Listar Tramitações do Protocolo (Efetua a consulta da lista de Tramitações do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Exemplo de Código

Exemplo de Retorno (application/json)

• Tramitar Protocolo (Efetua a tramitação do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Query Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
assincrono	string	-	Não	Ativa o modo assíncrono da requisição. Opções: true ou false.

Body Parameters (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
codLocalPara	string	50 (máx)	Sim	Código do local de destino. Exemplo: CELEP/SEGER. Obs.: Código do local pode ser obtido pelo serviço Listar Locais.
cpfDestinatario	string	11 ou 14	Sim	CPF do funcionário do local de destino. Exemplo: 98765432100 (sem máscara) ou 987.654.321-00 (com máscara). Obs.: CPF do funcionário pode ser obtido pelo serviço Listar Funcionários do Local.
codigoTramitacao	string	3	Sim	Código de motivo de tramitação. Exemplo: 6. Obs.: Código do motivo de tramitação pode ser obtido pelo serviço Listar Motivos de Tramitação.
parecer	string	-	Não	Parecer da tramitação. Exemplo: Protocolo tramitado para análise e tratativas.
dataPrazo	string	8	Não	Data de prazo da tramitação (AAAAMMDD). Exemplo: 20230922.
monitoraProtocolo	string	1	Não	Setar protocolo para ser monitorado. Opções: S (sim) ou N (não).
concluiPendencia	string	1	Não	Concluir pendência do tipo "Analisar". Opções: S (sim) ou N (não).

Exemplo de Código

Exemplo de Retorno (application/json)

• Bloquear Tramitação no eProtocolo (Efetua o bloqueio da tramitação no eProtocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Exemplo de Código

Exemplo de Retorno (application/json)

• Desbloquear Tramitação no eProtocolo (Efetua o desbloqueio da tramitação no eProtocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Exemplo de Código

Exemplo de Retorno (text/plain)

• Consultar Tramitação do Protocolo Físico em Trânsito (Efetua a consulta da Tramitação do Protocolo Físico em Trânsito)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Motivos de Tramitação (Efetua a consulta da lista de Motivos de Tramitação)

Voltar

Requisição

Escopo

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Query Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
ativo	string	-	Não	Retorna somente os motivos de tramitação ativos. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

Voltar