Sistema Protocolo Integrado - Serviços

• Listar Pendências do Protocolo (Efetua a consulta da lista de Pendências 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)

• Incluir Pendência no Protocolo (Efetua a inclusão de Pendência 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 (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
codigoLocalPara	string	50	Sim	Código do local da pendência. Exemplo: CELEP/COS-B3. Obs.: Código do local pode ser obtido pelo serviço Listar Locais do Órgão.
cpfDestinatario	string	11 ou 14	Sim	CPF do destinatário da pendência. Exemplo: CPF 98765432100 (sem máscara) ou CPF 987.654.321-00 (com máscara). Obs.: CPF do funcionário pode ser obtido pelo serviço Listar Funcionários do Local.
codigoTipoPendencia	string	2	Sim	Código do tipo de pendência. Exemplo: 12. Obs.: Código do tipo de pendência pode ser obtido pelo serviço Listar Tipos de Pendência.
diasPrazo	string	4	Não ¹	Quantidade de dias de prazo. Exemplo: 10.
codigoTipoPrazo	string	1	Não ¹	Código do tipo de prazo. Opções: 1 (Dias úteis), 2 (Dias corridos).
codigoDocumento	string	-	Não ²	Código do documento. Exemplo: 1234. Obs.: Código do documento pode ser obtido pelo serviço Listar Documentos do Volume do Processo.
observacoes	string	2400 (máx)	Não	Observações. Exemplo: Solicito assinatura no documento relatorio_compras.pdf.
¹ Se codigoTipoPendencia = 12 (Citar/Intimar), os campos diasPrazo e codigoTipoPrazo são obrigatórios. ² Se codigoTipoPendencia = 1 (Assinatura), o campo codigoDocumento é obrigatório.

Exemplo de Código

Exemplo de Retorno (application/json)

• Cancelar Pendência do Protocolo (Efetua o cancelamento de Pendência 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 da pendência. Exemplo: 1234. Obs.: Código da pendência pode ser obtido pelo serviço Listar Pendências 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 (application/json)

• Listar Tipos de Pendência (Efetua a consulta da lista de Tipos de Pendência)

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?

Exemplo de Código

Exemplo de Retorno (application/json)

• Consultar Tipo de Pendência (Efetua a consulta de Tipo de Pendência)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	-	Sim	Código da pendência. Exemplo: 1234. Obs.: Código da pendência pode ser obtido pelo serviço Listar Pendências 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 (application/json)

Voltar