Sistema Protocolo Integrado - Serviços

• Listar Locais do Órgão (Efetua a consulta da lista de Locais 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
ativo	string	-	Não	Retorna somente os locais ativos. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Consultar Local (Efetua a consulta de 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?

Exemplo de Código

Exemplo de Retorno (application/json)

• Incluir Local (Efetua a inclusão de Local)

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
codigo	string	50	Sim	Código do local. Exemplo: CELEP/ABC.
codigoOrgao	string	50	Sim	Código do órgão ao qual o local pertence. Exemplo: CELEPAR. Obs.: Código do órgão pode ser obtido pelo serviço Listar Órgãos
nomeLocal	string	60	Sim	Nome do local. Exemplo: Coord. de Sistemas de Informação B3.
descricaoLocal	string	100	Sim	Descrição do local. Exemplo: Coordenação de Sistemas de Informação B3.
nomeResponsavel	string	70	Não	Nome do responsável pelo local. Exemplo: João da Silva.
dddLocal	string	2	Não	DDD do local. Exemplo: 41.
telefoneLocal	string	10	Não	Telefone do local. Exemplo: 3200-6611.
ramalLocal	string	4	Não	Ramal do local. Exemplo: 6611.
identificacaoLocal	string	1	Sim	Identificação do local. Opções: S (Setor), G (Geral), P (Permanente), L (Protocolo Geral).
habilitaDestinatario	string	1	Sim	Habilitar destinatário na tela de inclusão/encaminhamento. Opções: S (Sim) ou N (Não).
permiteCapturar	string	1	Sim	Parâmetro descontinuado, utilizar configuração capturarProtocolo no perfil do usuário.
encaminhaSemRevisao	string	1	Sim	Permitir encaminhar sem revisão do responsável. Opções: S (Sim) ou N (Não).
permiteReceberDigital	string	1	Sim	Permitir receber protocolo digital externo ao órgão. Opções: S (Sim) ou N (Não).
permiteReceberFisico	string	1	Sim	Permitir receber protocolo físico externo ao órgão. Opções: S (Sim) ou N (Não).

Exemplo de Código

Exemplo de Retorno (application/json)

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

Body Parameters (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
nomeLocal	string	60	Sim	Nome do local. Exemplo: Coord. de Sistemas de Informação B3.
descricaoLocal	string	100	Sim	Descrição do local. Exemplo: Coordenação de Sistemas de Informação B3.
nomeResponsavel	string	70	Não	Nome do responsável pelo local. Exemplo: João da Silva.
dddLocal	string	2	Não	DDD do local. Exemplo: 41.
telefoneLocal	string	10	Não	Telefone do local. Exemplo: 3200-6611.
ramalLocal	string	4	Não	Ramal do local. Exemplo: 6611.
identificacaoLocal	string	1	Sim	Identificação do local. Opções: S (Setor), G (Geral), P (Permanente), L (Protocolo Geral).
habilitaDestinatario	string	1	Sim	Habilitar destinatário na tela de inclusão/encaminhamento. Opções: S (Sim) ou N (Não).
permiteCapturar	string	1	Sim	Parâmetro descontinuado, utilizar configuração capturarProtocolo no perfil do usuário.
encaminhaSemRevisao	string	1	Sim	Permitir encaminhar sem revisão do responsável. Opções: S (Sim) ou N (Não).
permiteReceberDigital	string	1	Sim	Permitir receber protocolo digital externo ao órgão. Opções: S (Sim) ou N (Não).
permiteReceberFisico	string	1	Sim	Permitir receber protocolo físico externo ao órgão. Opções: S (Sim) ou N (Não).
ativo	string	1	Não	Ativa/desativa o local. Opções: S (Sim) ou N (Não).

Exemplo de Código

Exemplo de Retorno (application/json)

Voltar