PT
Español
English
Português
    Gerenciamento de usuários

    Esta seção descreve as operações relacionadas ao gerenciamento de usuários (criação, edição, listagem de usuários).

    Lista de usuários por projeto

    Listar os usuários de um determinado projeto que correspondem aos critérios de pesquisa

    Detalhes da petição

    • URI: api/v8.6/user/list
    • Tipo: POST

    • Títulos obrigatórios:

    • tipo de conteúdo: application/json
    • Autorização: TOKEN

    Parâmetros

    Nome Tipo de dado Obrigatório Descrição
    ID do projeto Número Sim ID do projeto. Este campo é obrigatório, pois os usuários que pertencem a um determinado projeto são listados.
    ComparisonOperatorId Número Sim
    ID do operador do comparador. Os valores são:
    1. >
    2. <
    3. >=
    4. <=
    5. =
    6. <>
    7. EXISTIR (NÃO É NULO)
    8. NÃO EXISTE (É NULO)
    9. > GETDATE()
    10. < GETDATE()
    11. VERDADEIRO (1)
    12. FALSO (0)
    13. GOSTO
    Nome do campo Texto Sim Campo pelo qual a pesquisa deve ser realizada
    Id_LogicOperatorId Número Sim ID do operador lógico. Os valores possíveis são: 1 (E) e 2 (OU).
    Valor Texto Sim Texto a ser pesquisado


    Nota: O tipo de dados do parâmetro FieldName deve ser considerado para usar o operador apropriado. Os campos de tipo de texto usam: 5, 6, 13.


    Corpo da petição

    Exemplo com uma única condição:

    {
    "ProjectId": 2,
    "Criteria": [
        {
            "ComparisonOperatorId": 13,
            "FieldName": "UserName",
            "LogicOperatorId": 1,
            "Value": "mbarrios"
        }
    ]
}

    Exemplo com mais de uma condição:

    Este exemplo executa a pesquisa do usuário com Documento = ‘1234567890’ OR Nome de usuário LIKE ‘%Usr2%’ AND Nome LIKE ‘%Usuário 1%’

    {
    "ProjectId": 1,
    "Criteria": [
        {
            "ComparisonOperatorId": 5,
            "FieldName": "Document",
            "LogicOperatorId": 2,
            "Value": "1234567890"
        },
        {
            "ComparisonOperatorId": 13,
            "FieldName": "UserName",
            "LogicOperatorId": 1,
            "Value": "Usr1"
        },
        {
            "ComparisonOperatorId": 13,
            "FieldName": "Name",
            "LogicOperatorId": 2,
            "Value": "Usuario 1"
        }
    ]
}

    Responder

    O serviço retornará um Json com as seguintes informações:

    Exemplo:

    {
    "Data": [
        {
            "Address": null,
            "CompanyId": null,
            "CompanyName": null,
            "Document": null,
            "Email": "test@arandasoft.com",
            "Id": 471,
            "Mobile": null,
            "Name": "Mayra Barrios",
            "Phone": null,
            "Picture": null,
            "ProfileId": 0,
            "UserActive": false,
            "UserName": "mbarrios"
        },
        {
            "Address": null,
            "CompanyId": null,
            "CompanyName": null,
            "Document": null,
            "Email": "mayra.barrios@arandasoft.com",
            "Id": 3913,
            "Mobile": null,
            "Name": "Mayra Barrios 1",
            "Phone": null,
            "Picture": null,
            "ProfileId": 0,
            "UserActive": false,
            "UserName": "mbarrios1"
        },…
    ],
    "Paging": {
        "Count": 2
    }
}


    Mensagens de erro

    Código Status HTTP Mensagem de erro
    400 Solicitação incorreta InvalidProjectId
    400 Solicitação BadRequest InvalidOperatorId
    400 Solicitação BadRequest InvalidLogicOperatorId
    400 Solicitação BadRequest Valor inválido
    500 Erro de servidor interno FailureGetUsers