Sistema Protocolo Integrado - Serviços

• Listar Funcionários do Local (Efetua a consulta da lista de Funcionários 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 do Órgão.

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
responsavel	string	-	Não	Retorna lista somente com os responsáveis pelo local. Opções: true ou false.
destinatario	string	-	Não	Retorna lista somente com os destinatários do local. Opções: true ou false.
resumido	string	-	Não	Retorna lista somente com os CPFs dos funcionários. Opções: true ou false.
confiabilidade	string	-	Não	Retorna nível de confiabilidade do cadastro da Central de Segurança. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Funcionários do Órgão (Efetua a consulta da lista de Funcionários 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
resumido	string	-	Não	Retorna lista somente com os CPFs dos funcionários. Opções: true ou false.
confiabilidade	string	-	Não	Retorna nível de confiabilidade do cadastro da Central de Segurança. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Consultar Funcionário (Efetua a consulta do Funcionário)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
cpf	string	11 ou 14	Sim	CPF do funcionário. 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.

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
confiabilidade	string	-	Não	Retorna nível de confiabilidade do cadastro da Central de Segurança. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Incluir Funcionário (Efetua a inclusão do Funcionário)

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
cpf	string	11 ou 14	Sim	CPF do funcionário. Exemplo: 98765432100 (sem máscara) ou 987.654.321-00 (com máscara).
rgFuncionario	string	12 (máx)	Não	RG do funcionário. Exemplo: 12345679.
rgUfFuncionario	string	2)	Não	Código do estado. Exemplo: PR. Obs.: Código do estado pode ser obtido pelo serviço Listar Estados.
nomeFuncionario	string	150 (máx)	Sim	Nome do funcionário. Exemplo: João da Silva.
emailFuncionario	string	100 (máx)	Sim	E-mail do funcionário. Exemplo: email@email.com.
listaFuncionarioLocal
codigoLocal	string	50 (máx)	Não	Código do local. Exemplo: CELEP/SEGER. Obs.: Código do local pode ser obtido pelo serviço Listar Locais.
cadastrarProtocolo	string	1	Não	Permitir funcionário a criação de protocolos no local. Opções: S (Sim) ou N (Não).
destinatario	string	1	Não	Permitir funcionário como destinatário de tramitação do local. Opções: S (Sim) ou N (Não).
andamentoOrgao	string	1	Não	Permitir funcionário a tramitação para outro órgão. Opções: S (Sim) ou N (Não).
andamentoLocal	string	1	Não	Permitir funcionário a tramitação para outro local. Opções: S (Sim) ou N (Não).
responsavel	string	1	Não	Tornar funcionário responsável pelo local. Opções: S (Sim) ou N (Não).
privadoSigiloso	string	1	Não	Permitir funcionário o acesso à documentos sigilosos. Opções: S (Sim) ou N (Não).
agenteControleOrgao	string	1	Não	Permitir funcionário a visualização de protocolos que já passaram pelo órgão. Opções: S (Sim) ou N (Não).
capturarProtocolo	string	1	Não	Permitir funcionário capturar protocolos no local. Opções: S (Sim) ou N (Não).
listaGrupoSentinela
nomeGrupo	string	-	Não	Nome do grupo Sentinela. Exemplo: SPIWEB - Protocolo.

Exemplo de Código

Exemplo de Retorno (application/json)

• Alterar Funcionário (Efetua a alteração do Funcionário)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
cpf	string	11 ou 14	Sim	CPF do funcionário. 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.

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
rgFuncionario	string	12 (máx)	Não	RG do funcionário. Exemplo: 12345679.
rgUfFuncionario	string	2)	Não	Código do estado. Exemplo: PR. Obs.: Código do estado pode ser obtido pelo serviço Listar Estados.
nomeFuncionario	string	150 (máx)	Sim	Nome do funcionário. Exemplo: João da Silva.
emailFuncionario	string	100 (máx)	Sim	E-mail do funcionário. Exemplo: email@email.com.
listaFuncionarioLocal
codigoLocal	string	50 (máx)	Não	Código do local. Exemplo: CELEP/SEGER. Obs.: Código do local pode ser obtido pelo serviço Listar Locais.
cadastrarProtocolo	string	1	Não	Permitir funcionário a criação de protocolos no local. Opções: S (Sim) ou N (Não).
destinatario	string	1	Não	Permitir funcionário como destinatário de tramitação do local. Opções: S (Sim) ou N (Não).
andamentoOrgao	string	1	Não	Permitir funcionário a tramitação para outro órgão. Opções: S (Sim) ou N (Não).
andamentoLocal	string	1	Não	Permitir funcionário a tramitação para outro local. Opções: S (Sim) ou N (Não).
responsavel	string	1	Não	Tornar funcionário responsável pelo local. Opções: S (Sim) ou N (Não).
privadoSigiloso	string	1	Não	Permitir funcionário o acesso à documentos sigilosos. Opções: S (Sim) ou N (Não).
agenteControleOrgao	string	1	Não	Permitir funcionário a visualização de protocolos que já passaram pelo órgão. Opções: S (Sim) ou N (Não).
capturarProtocolo	string	1	Não	Permitir funcionário capturar protocolos no local. Opções: S (Sim) ou N (Não).
listaGrupoSentinela
nomeGrupo	string	-	Não	Nome do grupo Sentinela. Exemplo: SPIWEB - Protocolo.

Exemplo de Código

Exemplo de Retorno (application/json)

Voltar