Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

nomestringNome dado ao perfil

Obrigatório

Tamanho máximo: 50 caracteres

tipoPerfilintTipo do perfil (Definição abaixo)Obrigatório
idInquilinostringIdentificador do inquilinoObrigatório
idRetaguardastringIdentificador do perfil na retaguarda Obrigatório
idProprietariostringIdendtificador do proprietárioObrigatório
loteOrigemstringLote vinculado ao dado
lotestringLote vinculado ao dado
situacaointSituação do perfil (0 - Inativo, 1 - Ativo)Opcional - Caso não enviado será cadastrado com 0 
Expandir
titleTipo Perfil
CódigoTipo
1Administrador
2Operador
3Vendedor
Expandir
titleRetorno da requisição
Expandir
title200 - Ok

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

Expandir
title400 - Bad Request

{
    "code": "",
    "message": "",
    "detailedMessage": "",
    "helpUrl": "",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Dica
Expandir
title400 - Bad Request

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro
Para saber mais sobre compartilhamento clique aqui