Sistema Protocolo Integrado

• Consultar Protocolo (Efetua a consulta de 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
interessado	string	-	Não	Retorna informações de interessados do protocolo. Opções: true ou false.
ultimaTP	string	-	Não	Retorna informações da última tramitação personalizada. Opções: true ou false.
tramitacao	string	-	Não	Retorna informações de tramitações do protocolo. Opções: true ou false.
apensado	string	-	Não	Retorna informações de protocolos apensados. Opções: true ou false.
arquivamento	string	-	Não	Retorna informações de arquivamento do protocolo. Opções: true ou false.
eliminacao	string	-	Não	Retorna informações de eliminação do protocolo. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Validar Protocolo (Efetua a validaçã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?

Exemplo de Código

Exemplo de Retorno (text/plain)

• Incluir Protocolo (Efetua a inclusão do Protocolo)

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?

Body Parameters (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
tipoProcesso	string	1	Sim	Tipo do processo (físico ou digital). Opções: N (processo físico) ou D (processo digital).
codOrgaoCadastro	string	50 (máx)	Sim	Código do órgão de cadastro do protocolo. Exemplo: CELEPAR. Obs.: Código do órgão pode ser obtido pelo serviço Listar Órgãos.
codEspecieDocumento	string	2 (máx)	Sim	Código da espécie do documento. Exemplo: 51. Obs.: Código da espécie pode ser obtido pelo serviço Listar Espécies.
numDocumento	string	10 (máx)	Não ¹	Número do documento. Enviar somente números. Exemplo: 12345.
anoDocumento	string	4	Não ^1,2	Ano do documento. Enviar somente números. Exemplo: 2023.
sigiloso	string	1	Não	Indicativo de protocolo sigiloso. Opções: S (sim) ou N (não).
justificativaSigilo	string	300 (máx)	Não ³	Justificativa/motivo pelo qual o protocolo é sigiloso. Exemplo: Protocolo sigiloso devido à presença de informações pessoais sensíveis conforme a Lei nº 13.709 (Lei Geral de Proteção de Dados - LGPD).
codAssunto	string	5 (máx)	Sim	Código do assunto. Exemplo: PCTO. Obs.: Código do assunto pode ser obtido pelo serviço Listar Assuntos.
codPalavraChave1	string	20 (máx)	Sim	Código da palavra-chave principal relacionada ao assunto. Exemplo: CONVENIO. Obs.: Código da palavra-chave pode ser obtido pelo serviço Listar Palavras-Chave.
codPalavraChave2	string	20 (máx)	Não	Código da palavra-chave secundária relacionada ao assunto. Exemplo: PACTO DE PARCERIA. Obs.: Código da palavra-chave pode ser obtido pelo serviço Listar Palavras-Chave.
codPais	string	35 (máx)	Sim	Código do país. Exemplo: BRASIL. Obs.: Código do país pode ser obtido pelo serviço Listar Países.
codEstado	string	2	Sim	Código do estado. Exemplo: PR. Obs.: Código do estado pode ser obtido pelo serviço Listar Estados.
codMunicipio	string	35 (máx)	Sim	Código do município. Exemplo: CURITIBA. Obs.: Código do município pode ser obtido pelo serviço Listar Municípios do Estado.
codLocalDe	string	50 (máx)	Sim	Código do local de origem. Exemplo: CELEP/PTG. Obs.: Código do local pode ser obtido pelo serviço Listar Locais.
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.
destinatario	string	11 ou 14	Não	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.
detalhamento	string	3900 (máx)	Sim	Detalhamento do processo. Exemplo: Protocolo relacionado ao contrato de prestação de serviços nº 12345/2023.
nomeRequerente	string	150 (máx)	Não	Nome do requerente. Exemplo: João da Silva.
emailRequerente	string	100 (máx)	Não	E-mail do requerente. Exemplo: email@celepar.pr.gov.br.
telefoneRequerente	string	10	Não	Telefone do requerente. Exemplo: (41) 3200-6611.
bloqueioTramitacao	string	1	Não	Bloqueia a tramitação de protocolos no eProtocolo. Opções: S (sim) ou N (não).
dataPrazoProcesso	string	8	Não	Data de prazo do processo (AAAAMMDD). Exemplo: 20230922.
justificativaPrazoProcesso	string	300 (máx)	Não ⁴	Justificativa/motivo pelo qual o processo necessita ter um prazo.
listaInteressado
autoridade	string	1	Sim	Interessado do Tipo Autoridade. Opções: S (sim) ou N (não).
nomeInteressado	string	150 (máx)	Sim	Nome do Interessado Exemplo: João da Silva.
numIdentificacao	string	18 (máx)	Sim	CPF ou CNPJ do interessado. Exemplo: CPF 98765432100 (sem máscara) ou CPF 987.654.321-00 (com máscara), ou ainda CNPJ 98765432000100 ou CNPJ 98.765.432/0001-00.
tipoInteressado	string	12 (máx)	Não ⁵	Tipo do Interessado. Exemplo: PES.FISICA. Obs.: Código do tipo de interessado pode ser obtido pelo serviço Listar Tipos de Interessado.
tipoIdentificacao	string	1	Não ⁵	Código do tipo de identificação. Opções: 2 (CPF) ou 3 (CNPJ).
codCargoAutoridade	string	-	Não ⁶	Código do cargo autoridade. Exemplo: 1234. Obs.: Código do cargo autoridade pode ser obtido pelo serviço Listar Autoridades (Interessados).
nomeParlamentar	string	40 (máx)	Não	Nome parlamentar da autoridade. Exemplo: João Parlamentar.
¹ Se codEspecieDocumento = 1 (OFICIO) ou codEspecieDocumento = 8 (MEMORANDO), os campos numDocumento e anoDocumento são obrigatórios. ² Se numDocumento for preenchido, o campo anoDocumento é obrigatório. ³ Se sigiloso = S, o campo justificativaSigilo é obrigatório. ⁴ Se dataPrazoProcesso for preenchido, o campo justificativaPrazoProcesso é obrigatório. ⁵ Se autoridade = N, os campos tipoInteressado e tipoIdentificacao são obrigatórios. ⁶ Se autoridade = S, o campo codCargoAutoridade é obrigatório.

Exemplo de Código

Exemplo de Retorno (application/json)

• Concluir Cadastro do Protocolo (Efetua a conclusão do cadastro 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.

Exemplo de Código

Exemplo de Retorno (application/json)

• Alterar Protocolo (Efetua a alteraçã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?

Body Parameters (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
codEspecieDocumento	string	2 (máx)	Sim	Código da espécie do documento. Exemplo: 51. Obs.: Código da espécie pode ser obtido pelo serviço Listar Espécies.
numDocumento	string	10 (máx)	Não ¹	Número do documento. Enviar somente números. Exemplo: 12345.
anoDocumento	string	4	Não ^1,2	Ano do documento. Enviar somente números. Exemplo: 2023.
sigiloso	string	1	Não	Indicativo de protocolo sigiloso. Opções: S (sim) ou N (não).
justificativaSigilo	string	300 (máx)	Não ³	Justificativa/motivo pelo qual o protocolo é sigiloso. Exemplo: Protocolo sigiloso devido à presença de informações pessoais sensíveis conforme a Lei nº 13.709 (Lei Geral de Proteção de Dados - LGPD).
codAssunto	string	5 (máx)	Sim	Código do assunto. Exemplo: PCTO. Obs.: Código do assunto pode ser obtido pelo serviço Listar Assuntos.
codPalavraChave1	string	20 (máx)	Sim	Código da palavra-chave principal relacionada ao assunto. Exemplo: CONVENIO. Obs.: Código da palavra-chave pode ser obtido pelo serviço Listar Palavras-Chave.
codPalavraChave2	string	20 (máx)	Não	Código da palavra-chave secundária relacionada ao assunto. Exemplo: PACTO DE PARCERIA. Obs.: Código da palavra-chave pode ser obtido pelo serviço Listar Palavras-Chave.
codPais	string	35 (máx)	Sim	Código do país. Exemplo: BRASIL. Obs.: Código do país pode ser obtido pelo serviço Listar Países.
codEstado	string	2	Sim	Código do estado. Exemplo: PR. Obs.: Código do estado pode ser obtido pelo serviço Listar Estados.
codMunicipio	string	35 (máx)	Sim	Código do município. Exemplo: CURITIBA. Obs.: Código do município pode ser obtido pelo serviço Listar Municípios do Estado.
destinatario	string	11 ou 14	Não	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.
detalhamento	string	3900 (máx)	Sim	Detalhamento do processo. Exemplo: Protocolo relacionado ao contrato de prestação de serviços nº 12345/2023.
nomeRequerente	string	150 (máx)	Não	Nome do requerente. Exemplo: João da Silva.
emailRequerente	string	100 (máx)	Não	E-mail do requerente. Exemplo: email@celepar.pr.gov.br.
telefoneRequerente	string	10	Não	Telefone do requerente. Exemplo: (41) 3200-6611.
bloqueioTramitacao	string	1	Não	Bloqueia a tramitação de protocolos no eProtocolo. Opções: S (sim) ou N (não).
dataPrazoProcesso	string	8	Não	Data de prazo do processo (AAAAMMDD). Exemplo: 20230922.
justificativaPrazoProcesso	string	300 (máx)	Não ⁴	Justificativa/motivo pelo qual o processo necessita ter um prazo.
listaInteressado
autoridade	string	1	Sim	Interessado do Tipo Autoridade. Opções: S (sim) ou N (não).
nomeInteressado	string	150 (máx)	Sim	Nome do Interessado Exemplo: João da Silva.
numIdentificacao	string	18 (máx)	Sim	CPF ou CNPJ do interessado. Exemplo: CPF 98765432100 (sem máscara) ou CPF 987.654.321-00 (com máscara), ou ainda CNPJ 98765432000100 ou CNPJ 98.765.432/0001-00.
tipoInteressado	string	12 (máx)	Não ⁵	Tipo do Interessado. Exemplo: PES.FISICA. Obs.: Código do tipo de interessado pode ser obtido pelo serviço Listar Tipos de Interessado.
tipoIdentificacao	string	1	Não ⁵	Código do tipo de identificação. Opções: 2 (CPF) ou 3 (CNPJ).
codCargoAutoridade	string	-	Não ⁶	Código do cargo autoridade. Exemplo: 1234. Obs.: Código do cargo autoridade pode ser obtido pelo serviço Listar Autoridades (Interessados).
nomeParlamentar	string	40 (máx)	Não	Nome parlamentar da autoridade. Exemplo: João Parlamentar.
¹ Se codEspecieDocumento = 1 (OFICIO) ou codEspecieDocumento = 8 (MEMORANDO), os campos numDocumento e anoDocumento são obrigatórios. ² Se numDocumento for preenchido, o campo anoDocumento é obrigatório. ³ Se sigiloso = S, o campo justificativaSigilo é obrigatório. ⁴ Se dataPrazoProcesso for preenchido, o campo justificativaPrazoProcesso é obrigatório. ⁵ Se autoridade = N, os campos tipoInteressado e tipoIdentificacao são obrigatórios. ⁶ Se autoridade = S, o campo codCargoAutoridade é obrigatório.

Exemplo de Código

Exemplo de Retorno (application/json)

• Sobrestar Protocolo (Efetua o sobrestamento 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?

Body Parameters (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
codigoIndicativoProcesso	string	1	Sim	Código do indicativo processo. Opções: S (Sobrestado) ou O (Arquivo Corrente).
justificativa	string	500 (máx)	Sim	Justificativa/motivo pelo sobrestamento do protocolo. Exemplo: Processo sobrestado aguardando conclusão de auditoria judicial.
dataPrazo	string	8	Não	Data de prazo de sobrestamento (AAAAMMDD). Exemplo: 20230922.
exibirPendencias	string	1	Não	Permanecer com o processo em "Minhas Pendências". Opções: S (Sim) ou N (Não).

Exemplo de Código

Exemplo de Retorno (application/json)

• Dessobrestar Protocolo (Efetua o dessobrestamento 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)

• Receber Protocolo Físico no Local (Efetua o recebimento do Protocolo físico no Local)

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)

• Receber Protocolo Físico no Órgão (Efetua o recebimento do Protocolo físico no Órgão)

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 Protocolos (Efetua a consulta da lista de Protocolos)

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
dataInicial	string	8	Sim	Data inicial (AAAAMMDD). Exemplo: 20230922.
horaInicial	string	4	Não	Hora inicial (HHMM). Exemplo: 1530.
dataFinal	string	8	Sim	Data final (AAAAMMDD). Exemplo: 20230923.
horaFinal	string	4	Não	Hora final (HHMM). Exemplo: 1530.
tipoAtualizacao	string	-	Não	Tipo de atualização (separar por vírgulas, caso mais de um). Opções: I (Inclusão), C (Cadastro), T (Tramitação), U (Última Tramitação), D (Documento), A (Anexo), P (Pendência), S (Assinatura) ou M (Movimentação).
indicativoProcesso	string	-	Não	Indicativo do processo (separar por vírgulas, caso mais de um). Opções: I (Pré-Cadastro Físico), D (Pré-Cadastro Digital), P (Pendente), C (Concluído), E (Eliminado), A (Cancelado), X (Emprestado), N (Normal), S (Sobrestado), O (Arquivo Corrente).
resumido	string	-	Não	Retorna lista somente com os números de protocolos. Opções: true ou false.
filtrado	string	-	Não	Retorna lista de tramitações de acordo com os filtros. Opções: true ou false.
sigiloso	string	-	Não	Retorna lista somente com os protocolos sigilosos. Opções: true ou false.
interessado	string	-	Não	Retorna informações de interessados do protocolo. Opções: true ou false.
ultimaTP	string	-	Não	Retorna informações da última tramitação personalizada. Opções: true ou false.
tramitacao	string	-	Não	Retorna informações de tramitações do protocolo. Opções: true ou false.
apensado	string	-	Não	Retorna informações de protocolos apensados. Opções: true ou false.
arquivamento	string	-	Não	Retorna informações de arquivamento do protocolo. Opções: true ou false.
eliminacao	string	-	Não	Retorna informações de eliminação do protocolo. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Protocolos por Assunto (Efetua a consulta da lista de Protocolos por Assunto)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	-	Sim	Código do assunto. Exemplo: PCTO. Obs.: Código do assunto pode ser obtido pelo serviço Listar Assuntos.

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
dataInicial	string	8	Sim	Data inicial (AAAAMMDD). Exemplo: 20230922.
horaInicial	string	4	Não	Hora inicial (HHMM). Exemplo: 1530.
dataFinal	string	8	Sim	Data final (AAAAMMDD). Exemplo: 20230923.
horaFinal	string	4	Não	Hora final (HHMM). Exemplo: 1530.
tipoAtualizacao	string	-	Não	Tipo de atualização (separar por vírgulas, caso mais de um). Opções: I (Inclusão), C (Cadastro), T (Tramitação), U (Última Tramitação), D (Documento), A (Anexo), P (Pendência), S (Assinatura) ou M (Movimentação).
indicativoProcesso	string	-	Não	Indicativo do processo (separar por vírgulas, caso mais de um). Opções: I (Pré-Cadastro Físico), D (Pré-Cadastro Digital), P (Pendente), C (Concluído), E (Eliminado), A (Cancelado), X (Emprestado), N (Normal), S (Sobrestado), O (Arquivo Corrente).
resumido	string	-	Não	Retorna lista somente com os números de protocolos. Opções: true ou false.
filtrado	string	-	Não	Retorna lista de tramitações de acordo com os filtros. Opções: true ou false.
sigiloso	string	-	Não	Retorna lista somente com os protocolos sigilosos. Opções: true ou false.
interessado	string	-	Não	Retorna informações de interessados do protocolo. Opções: true ou false.
ultimaTP	string	-	Não	Retorna informações da última tramitação personalizada. Opções: true ou false.
tramitacao	string	-	Não	Retorna informações de tramitações do protocolo. Opções: true ou false.
apensado	string	-	Não	Retorna informações de protocolos apensados. Opções: true ou false.
arquivamento	string	-	Não	Retorna informações de arquivamento do protocolo. Opções: true ou false.
eliminacao	string	-	Não	Retorna informações de eliminação do protocolo. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Protocolos do Local (Efetua a consulta da lista de Protocolos do Local)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	50	Sim	Código do local. Exemplo: CELEP/COS-B3. Obs.: Código do local pode ser obtido pelo serviço Listar Locais.

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
dataInicial	string	8	Sim	Data inicial (AAAAMMDD). Exemplo: 20230922.
horaInicial	string	4	Não	Hora inicial (HHMM). Exemplo: 1530.
dataFinal	string	8	Sim	Data final (AAAAMMDD). Exemplo: 20230923.
horaFinal	string	4	Não	Hora final (HHMM). Exemplo: 1530.
tipoAtualizacao	string	-	Não	Tipo de atualização (separar por vírgulas, caso mais de um). Opções: I (Inclusão), C (Cadastro), T (Tramitação), U (Última Tramitação), D (Documento), A (Anexo), P (Pendência), S (Assinatura) ou M (Movimentação).
indicativoProcesso	string	-	Não	Indicativo do processo (separar por vírgulas, caso mais de um). Opções: I (Pré-Cadastro Físico), D (Pré-Cadastro Digital), P (Pendente), C (Concluído), E (Eliminado), A (Cancelado), X (Emprestado), N (Normal), S (Sobrestado), O (Arquivo Corrente).
resumido	string	-	Não	Retorna lista somente com os números de protocolos. Opções: true ou false.
filtrado	string	-	Não	Retorna lista de tramitações de acordo com os filtros. Opções: true ou false.
sigiloso	string	-	Não	Retorna lista somente com os protocolos sigilosos. Opções: true ou false.
interessado	string	-	Não	Retorna informações de interessados do protocolo. Opções: true ou false.
ultimaTP	string	-	Não	Retorna informações da última tramitação personalizada. Opções: true ou false.
tramitacao	string	-	Não	Retorna informações de tramitações do protocolo. Opções: true ou false.
apensado	string	-	Não	Retorna informações de protocolos apensados. Opções: true ou false.
arquivamento	string	-	Não	Retorna informações de arquivamento do protocolo. Opções: true ou false.
eliminacao	string	-	Não	Retorna informações de eliminação do protocolo. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Protocolos do Órgão (Efetua a consulta da lista de Protocolos do Órgão)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	50	Sim	Código do órgão. Exemplo: CELEPAR. Obs.: Código do órgão pode ser obtido pelo serviço Listar Órgãos.

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
dataInicial	string	8	Sim	Data inicial (AAAAMMDD). Exemplo: 20230922.
horaInicial	string	4	Não	Hora inicial (HHMM). Exemplo: 1530.
dataFinal	string	8	Sim	Data final (AAAAMMDD). Exemplo: 20230923.
horaFinal	string	4	Não	Hora final (HHMM). Exemplo: 1530.
tipoAtualizacao	string	-	Não	Tipo de atualização (separar por vírgulas, caso mais de um). Opções: I (Inclusão), C (Cadastro), T (Tramitação), U (Última Tramitação), D (Documento), A (Anexo), P (Pendência), S (Assinatura) ou M (Movimentação).
indicativoProcesso	string	-	Não	Indicativo do processo (separar por vírgulas, caso mais de um). Opções: I (Pré-Cadastro Físico), D (Pré-Cadastro Digital), P (Pendente), C (Concluído), E (Eliminado), A (Cancelado), X (Emprestado), N (Normal), S (Sobrestado), O (Arquivo Corrente).
resumido	string	-	Não	Retorna lista somente com os números de protocolos. Opções: true ou false.
filtrado	string	-	Não	Retorna lista de tramitações de acordo com os filtros. Opções: true ou false.
sigiloso	string	-	Não	Retorna lista somente com os protocolos sigilosos. Opções: true ou false.
interessado	string	-	Não	Retorna informações de interessados do protocolo. Opções: true ou false.
ultimaTP	string	-	Não	Retorna informações da última tramitação personalizada. Opções: true ou false.
tramitacao	string	-	Não	Retorna informações de tramitações do protocolo. Opções: true ou false.
apensado	string	-	Não	Retorna informações de protocolos apensados. Opções: true ou false.
arquivamento	string	-	Não	Retorna informações de arquivamento do protocolo. Opções: true ou false.
eliminacao	string	-	Não	Retorna informações de eliminação do protocolo. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Protocolos por Motivo de Tramitação (Efetua a consulta da lista de Protocolos por Motivo de Tramitação)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	50	Sim	Código do órgão. Exemplo: CELEPAR. Obs.: Código do órgão pode ser obtido pelo serviço Listar Órgãos.

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
dataInicial	string	8	Sim	Data inicial (AAAAMMDD). Exemplo: 20230922.
horaInicial	string	4	Não	Hora inicial (HHMM). Exemplo: 1530.
dataFinal	string	8	Sim	Data final (AAAAMMDD). Exemplo: 20230923.
horaFinal	string	4	Não	Hora final (HHMM). Exemplo: 1530.
tipoAtualizacao	string	-	Não	Tipo de atualização (separar por vírgulas, caso mais de um). Opções: I (Inclusão), C (Cadastro), T (Tramitação), U (Última Tramitação), D (Documento), A (Anexo), P (Pendência), S (Assinatura) ou M (Movimentação).
indicativoProcesso	string	-	Não	Indicativo do processo (separar por vírgulas, caso mais de um). Opções: I (Pré-Cadastro Físico), D (Pré-Cadastro Digital), P (Pendente), C (Concluído), E (Eliminado), A (Cancelado), X (Emprestado), N (Normal), S (Sobrestado), O (Arquivo Corrente).
resumido	string	-	Não	Retorna lista somente com os números de protocolos. Opções: true ou false.
filtrado	string	-	Não	Retorna lista de tramitações de acordo com os filtros. Opções: true ou false.
sigiloso	string	-	Não	Retorna lista somente com os protocolos sigilosos. Opções: true ou false.
interessado	string	-	Não	Retorna informações de interessados do protocolo. Opções: true ou false.
ultimaTP	string	-	Não	Retorna informações da última tramitação personalizada. Opções: true ou false.
tramitacao	string	-	Não	Retorna informações de tramitações do protocolo. Opções: true ou false.
apensado	string	-	Não	Retorna informações de protocolos apensados. Opções: true ou false.
arquivamento	string	-	Não	Retorna informações de arquivamento do protocolo. Opções: true ou false.
eliminacao	string	-	Não	Retorna informações de eliminação do protocolo. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Protocolos Parados no Local (Efetua a consulta da lista de Protocolos Parados no Local)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	50	Sim	Código do local. Exemplo: CELEP/COS-B3. Obs.: Código do local pode ser obtido pelo serviço Listar Locais.

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
dataInicial	string	8	Sim	Data inicial (AAAAMMDD). Exemplo: 20230922.
horaInicial	string	4	Não	Hora inicial (HHMM). Exemplo: 1530.
dataFinal	string	8	Sim	Data final (AAAAMMDD). Exemplo: 20230923.
horaFinal	string	4	Não	Hora final (HHMM). Exemplo: 1530.

Exemplo de Código

Exemplo de Retorno (application/json)

• Apensar Protocolo (Efetua o apensamento do protocolo em um protocolo-cabeça)

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
numeroProtocoloCabeca	string	9 ou 12	Sim	Número do protocolo cabeça. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).
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)

Voltar