Cadastro de Compartilhamento

O cadastro de compartilhamento é responsável por estabelecer o modelo de distribuição de dados para as lojas

Para saber mais sobre Compartilhamentos clique aqui.

1 - Cadastrar compartilhamento

Este método é responsável pela criação de um novo compartilhamento

Endpoint:
- /api/retaguarda/v2/compartilhamentos
- /api/retaguarda/v3/compartilhamentos
- /api/retaguarda/v3/dadosdinamicos/down/6/1
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda
MicroServiço: DadosBasicos

Este endpoint recebe uma lista de compartilhamentos para que possam ser enviados vários na mesma requisição

Para que a baixa do compartilhamento criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 6 = compartilhamento

Exemplo de body da requisição

[
{
"IdRetaguardaLoja": "string",
"IdRetaguarda": "string",
"IdProprietario": "string",
"IdInquilino": "string",
"NomeCompartilhamento": "string",
"Nivel": int,
"IdRetaguardaPai":"string",
"loteOrigem": "string"
}

]

Definição dos campos de requisição

Campo	Tipo	Descrição	Obrigatório	Validações	Observações
IdRetaguardaLoja	string	Identificador da loja na retaguarda	Não	Tamanho máximo: 100 caracteres A inclusão deste dados só é permitida se este compartilhamento não tiver filhos vinculados a ele	Necessário informar caso o compartilhamento seja de loja. IMPORTANTE: O Loja lote somente é gerado quando este campo é preenchido com a identificação da loja
IdRetaguarda	string	Identificador do compartilhamento na retaguarda	Sim	Tamanho máximo: 100 caracteres
IdProprietario	string	Identificador do proprietário do dado	Sim	Único por inquilino Tamanho máximo: 100 caracteres	IMPORTANTE: Quando os dados são enviados é necessário passar esse dado pra identificar o compartilhamento
IdInquilino	string	Identificador do inquilino	Sim	O inquilino deve estar cadastrado e ativo para que o compartilhamento seja cadastrado
NomeCompartilhamento	string	Nome para identificação do compartilhamento	Sim	Tamanho máximo: 100 caracteres
Nivel	int	Nível do compartilhamento	Sim	O primeiro compartilhamento do inquilino tem que ser do nível 0 (master) Só é permitido o cadastro de um nível 0 (master) por inquilino. O nível necessariamente precisa ser um acima do compartilhamento pai, caso isso não ocorra o compartilhamento não será inserido.	Será cadastrado 0 caso seja enviado null.
IdRetaguardaPai	string	IdRetaguarda do compartilhamento pai	Não	Obrigatório para níveis maiores que 0 O compartilhamento deve existir e estar ativo para o cadastro do novo compartilhamento	IMPORTANTE: Não é permitido autorreferência para o compartilhamento pai
LoteOrigem	string	Código do lote	Sim	O lote deve existir e estar aberto para o cadastro do compartilhamento

Retorno da requisição

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Definição dos campos de retorno

Campo	Tipo	Descrição
Success	bool	Indica se a criação do compartilhamento foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
Data	objeto	Objeto compartilhamento criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

2 - Consultar compartilhamento

Este método é responsável pela consulta de um compartilhamento

Endpoint: /api/retaguarda/v2/compartilhamentos/{idInquilino}
Método: Get
Autenticação: Bearer token
Permissão: Retaguarda

Este endpoint exibe uma lista de compartilhamentos dos filtros realizados no próprio endpoint