Sistema Protocolo Integrado

• Listar Documentos do Protocolo (Efetua a consulta da lista de Documentos 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
download	string	-	Não	Obtém URL para download do arquivo (documento). Opções: true ou false.
nome	string	50	Não	Parte do nome do arquivo (documento). Exemplo: relatorio_financeiro.pdf

Exemplo de Código

Exemplo de Retorno (application/json)

• Consultar Documento do Protocolo (Efetua a consulta de Documento 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).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Protocolo.

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
download	string	-	Não	Obtém URL para download do arquivo (documento). Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Incluir Documento no Protocolo (Efetua a inclusão de Documento no 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?

Body Parameters (multipart/form-data)

Campo	Formato	Tamanho	Obrigatório	Descrição
nomeArquivo	string	255 (máx)	Sim	Nome do arquivo (documento) sem acentuação e caracteres especiais. Exemplo: relatorio_financeiro.pdf
md5Arquivo	string	32	Sim	Hash MD5 do arquivo (documento). Exemplo: fa58b407de3639c721a73d51fce4270d
binarioArquivo	array (file)	30MB	Sim	Binário do arquivo (documento).

Exemplo de Código

Exemplo de Retorno (application/json)

• Excluir Documento do Protocolo (Efetua a exclusão de Documento 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).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Protocolo.

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)

• Listar Documentos do Volume do Processo (Efetua a consulta da lista de Documentos do Volume do Processo)

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
download	string	-	Não	Obtém URL para download do arquivo (documento). Opções: true ou false.
original	string	-	Não	Obtém arquivo original (sem carimbo e rodapé). Opções: true ou false.
nome	string	50	Não	Parte do nome do arquivo (documento). Exemplo: relatorio_financeiro.pdf

Exemplo de Código

Exemplo de Retorno (application/json)

• Consultar Documento do Volume do Processo (Efetua a consulta de Documento do Volume do Processo)

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).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Volume do Processo.

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
download	string	-	Não	Obtém URL para download do arquivo (documento). Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Atualizar Documentos no Volume do Processo (Efetua a atualização de Documentos no Volume do Processo)

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.

Exemplo de Código

Exemplo de Retorno (application/json)

• Cancelar Documento do Volume do Processo (Efetua o cancelamento de Documento do Volume do Processo)

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).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Volume do Processo.

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
justificativa	string	50 (mín) e 300 (máx)	Sim	Justificativa/motivo pelo qual o cancelamento está sendo realizado. Exemplo: Documento cancelado por duplicidade. Cancelamento autorizado pelo responsável pelo protocolo 12.345.678-9.

Exemplo de Código

Exemplo de Retorno (application/json)

• Descancelar Documento do Volume do Processo (Efetua o descancelamento de Documento do Volume do Processo)

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).
codigo	string	-	Sim	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Volume do Processo.

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
justificativa	string	50 (mín) e 300 (máx)	Sim	Justificativa/motivo pelo qual o descancelamento está sendo realizado. Exemplo: Cancelamento realizado equivocadamente. Desfazendo o cancelamento.

Exemplo de Código

Exemplo de Retorno (application/json)

Voltar