Sistema Protocolo Integrado - Serviços

• Listar De-Paras (Efetua a consulta da lista de De-Paras)

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 da solicitação (AAAAMMDD). Exemplo: 20230922.
dataFinal	string	8	Sim	Data final da solicitação (AAAAMMDD). Exemplo: 20230923.
situacao	string	1	Não	Situação do de-para. Opções: L (Liberado), A (Aguardando execução) e R (Revogado).

Exemplo de Código

Exemplo de Retorno (application/json)

• Consultar De-Para (Efetua a consulta de De-Para)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	-	Sim	Código do de-para. Exemplo: 1234. Obs.: Código do de-para pode ser obtido pelo serviço Listar De-Paras.

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 De-Para (Efetua a inclusão de De-Para)

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
codigoTabela	string	1	Sim	Código da tabela a ser modificada. Opções: 1 (Local), 2 (Espécie), 3 (Motivo de Tramitação), 4 (Assunto), 5 (Palavra-Chave), 6 (Tipo de Interessado), 7 (Órgão), 8 (Interessado) e 9 (Temporalidade).
codigoDe	string	-	Sim	Código atual. Exemplo: CELEP/DIBES.
codigoPara	string	-	Sim	Novo código. Exemplo: CELEP/COBES.
codigoSituacao	string	5 (mín)	Sim	Situação do de-para. Opções: L (Liberado), A (Aguardando execução) e R (Revogado).

Exemplo de Código

Exemplo de Retorno (application/json)

• Alterar De-Para (Efetua a alteração de De-Para)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
codigo	string	-	Sim	Código do de-para. Exemplo: 1234. Obs.: Código do de-para pode ser obtido pelo serviço Listar De-Paras.

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
codigoPara	string	-	Sim	Novo código. Exemplo: CELEP/COBES.
codigoSituacao	string	5 (mín)	Sim	Situação do de-para. Opções: L (Liberado), A (Aguardando execução) e R (Revogado).

Exemplo de Código

Exemplo de Retorno (application/json)

Voltar