Sistema Protocolo Integrado

• Arquivar Protocolo (Efetua o arquivamento 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
unidadeArmazenamento	string	-	Sim	Código(s) da(s) unidade(s) de armazenamento (separar por vírgulas, caso mais de um). Exemplo: 1234 ou 1234,1235,1236. Obs.: Código da unidade de armazenamento pode ser obtido pelo serviço Listar Unidades de Armazenamento do Órgão.
conclusao	string	5 (mín)	Sim	Conclusão/despacho final sobre o arquivamento do protocolo. Exemplo: Protocolo arquivado devido ao encerramento do projeto ABC.

Exemplo de Código

Exemplo de Retorno (application/json)

• Desarquivar Protocolo (Efetua o desarquivamento 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
justificativa	string	5 (mín)	Sim	Justificativa/motivo pelo qual o desarquivamento está sendo realizado. Exemplo: Protocolo desarquivado por determinação judicial.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Locais do Órgão para Arquivamento (Efetua a consulta da lista de Locais do Órgão para Arquivamento)

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 códigos dos locais. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Tipos de Unidade de Armazenamento (Efetua a consulta da lista de Tipos de Unidade de Armazenamento)

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)

• Listar Temporalidades (Efetua a consulta da lista de Temporalidades)

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
ativo	string	-	Não	Retorna somente as temporalidades ativas. Opções: true ou false.
resumido	string	-	Não	Retorna a lista somente com os códigos das temporalidades. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Listar Temporalidades do Órgão (Efetua a consulta da lista de Temporalidades 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 as temporalidades ativas. Opções: true ou false.
resumido	string	-	Não	Retorna a lista somente com os códigos das temporalidades. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

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

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
ano	string	4	Sim	Ano do arquivamento. Exemplo: 2023.
localorigem	string	50	Não	Código do local de origem. Exemplo: CELEP/COS-B3. Obs.: Código do local pode ser obtido pelo serviço Listar Locais.
localarquivamento	string	50	Não	Código do local de arquivamento. Exemplo: CELEP/ARQ. Obs.: Código do local de arquivamento pode ser obtido pelo serviço Listar Locais do Órgão para Arquivamento.
temporalidade	string	-	Não	Código de temporalidade. Exemplo: 0 2 1. Obs.: Código de temporalidade pode ser obtido pelo serviço Listar Temporalidades do Órgão.
tipounidade	string	1	Não	Código do tipo de unidade. Exemplo: 3. Obs.: Código do tipo de unidade pode ser obtido pelo serviço Listar Tipos de Unidade de Armazenamento.
cpf	string	11 ou 14	Não	CPF do funcionário (pasta funcional). 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.
resumido	string	-	Não	Retorna a lista somente com os códigos das unidades. Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Incluir Unidade de Armazenamento do Órgão (Efetua a inclusão da Unidade de Armazenamento)

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?

Body Parameters (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
ano	string	4	Sim	Ano do arquivamento. Exemplo: 2023.
codigoLocalOrigem	string	50	Sim	Código do local de origem. Exemplo: CELEP/COS-B3. Obs.: Código do local pode ser obtido pelo serviço Listar Locais
codigoLocalArquivamento	string	50	Sim	Código do local de arquivamento. Exemplo: CELEP/ARQ. Obs.: Código do local de arquivamento pode ser obtido pelo serviço Listar Locais do Órgão para Arquivamento.
codigoTipoUnidadeArmazenamento	string	1	Sim	Código do tipo de unidade. Exemplo: 3. Obs.: Código do tipo de unidade pode ser obtido pelo serviço Listar Tipos de Unidade de Armazenamento.
codigoTemporalidade	string	-	Sim	Código de temporalidade. Exemplo: 0 2 1. Obs.: Código de temporalidade pode ser obtido pelo serviço Listar Temporalidades do Órgão.
cpfFuncionario	string	11 ou 14	Não ¹	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.
dataAbertura	string	8	Não	Data de abertura da unidade de armazenamento (AAAAMMDD). Exemplo: 20230922.
observacoes	string	300 (máx)	Não	Observações. Exemplo: Unidade de armazenamento de protocolos físicos de 2023.
resumido	string	-	Não	Retorna a lista somente com os códigos das unidades. Opções: true ou false.
¹ Se codigoTipoUnidadeArmazenamento = 4 (Pasta Funcional), o campo cpfFuncionario é obrigatório.

Exemplo de Código

Exemplo de Retorno (application/json)

Voltar