...
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo | Tipo | Descrição | Obrigatório | Validações | Observações |
|---|
| IdRetaguardaLoja | string | Identificador da loja na retaguarda |
Opcional. Só é preenchido se for um compartilhamento de loja | 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 |
Obrigatório| Sim | - Tamanho máximo: 100 caracteres
|
| | IdProprietario | string | Identificador do proprietário do dado |
Obrigatório e no máximo | Sim | - Único por inquilino
- Tamanho máximo: 100 caracteres
| IMPORTANTE: Quando os dados são enviados é necessário passar esse dado pra identificar |
a qual compartilhamento pertence o dado.o compartilhamento | IdInquilino | string | Identificador do inquilino |
Obrigatório| Sim | - O inquilino deve estar cadastrado e ativo para que o compartilhamento seja cadastrado
|
| NomeCompartilhamento | string | Nome para identificação do compartilhamento |
Obrigatório e no máximo Sim | - Tamanho máximo: 100 caracteres
|
| Nivel | int | Nível do compartilhamento |
Obrigatório Nos compartilhamentos deve ter somente um compartilhamento com nível 0 | 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 |
acima desteOpcional Somente não é preenchido no Nível 0 | loteOrigem| 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 |
Obrigatório| Sim | - O lote deve existir e estar aberto para o cadastro do compartilhamento
|
|
|
| Expandir |
|---|
| title | Retorno da requisição |
|---|
|
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
...
Este método é responsável pela consulta de um compartilhamento
- Endpoint: /api/pdvsyncclientretaguarda/v2/compartilhamentos/{id}/{lote}/{qtdRegistros}/{idRetaguardaLoja}/{sequencial?}idInquilino}
- Método: Get
- Autenticação: Bearer token
- Permissão: PDVSyncClient Retaguarda
Este endpoint exibe uma lista de compartilhamentos dos filtros realizados no próprio endpoint
...
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo | Tipo | Descrição | Observações |
|---|
| id | string | Id do Inquilino | lote | string | Número do lote | qtdRegistros | int | Quantidade de registros que irá retornar na lista | IdRetaguardaLoja | string | Identificador da loja na retaguarda | | sequencial | int | Sequencial para paginação | Opcional |
|
|
| Expandir |
|---|
| title | Retorno da requisição |
|---|
|
{
"success": false,
"message": "Nenhum registro encontrado",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
Campo | Tipo | Descrição |
|---|
| Success | boolIndica | se a criação do compartilhamento foi feita com sucessoRetorna os compartilhamento existentes por inquilino | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campobusca de compartilhamentos | | Data | objeto | Objeto compartilhamento | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
...
