Este método é responsável pela criação de um novo compartilhamentoperfil
- Endpoint: /api/retaguarda/v2/perfis
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de perfis para que possam ser enviados vários na mesma requisição
Aviso |
---|
Para que a baixa do Perfil criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 3 = perfil |
Expandir |
---|
title | Exemplo de body da requisição |
---|
|
[ { "nome": "string", "tipoPerfil": "string", "idInquilino": "string", "idRetaguarda": "string", "idProprietario": "string", "loteOrigem": "string", "lote": "string", "situacao": 1 } ] |
Expandir |
---|
title | Definição dos campos de requisição |
---|
|
Campo | Tipo | Descrição | Observações |
---|
nome | string | Nome dado ao perfil | Obrigatório Tamanho máximo: 50 caracteres | tipoPerfil | int | Tipo do perfil (Definição abaixo) | Obrigatório | idInquilino | string | Identificador do inquilino | Obrigatório | idRetaguarda | string | Identificador do perfil na retaguarda | Obrigatório | idProprietario | string | Idendtificador do proprietário | Obrigatório | loteOrigem | string | Lote vinculado ao dado | Obrigatório para a integração | lote | string | Lote vinculado ao dado | Obrigatório para a integração | situacao | int | Situação do perfil (0 - Inativo, 1 - Ativo) | Opcional - Caso não enviado será cadastrado com 0 |
|
Expandir |
---|
|
Código | Tipo |
---|
1 | Administrador | 2 | Operador | 3 | Vendedor |
|
Expandir |
---|
title | Retorno da requisição |
---|
|
Expandir |
---|
| { "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Expandir |
---|
| { "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
|
Expandir |
---|
title | Definição dos campos de retorno |
---|
|
Expandir |
---|
| 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 |
|
|
Dica |
---|
Expandir |
---|
| Campo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
| Para saber mais sobre compartilhamento clique aqui
|