Adobe PDF

Descargar PDF
    Manejo de Usuarios

    En esta sección se describen las operaciones relacionadas con el manejo de usuarios (creación, edición, Listado de usuarios).

    Listado de usuarios por proyecto

    Lista los usuarios de determinado proyecto que coincidan con los criterios de búsqueda

    Detalles de la petición

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

    • Tipo: POST

    • Encabezados requeridos:

      • content-type: application/json
      • Authorization: TOKEN

    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    ProjectId Número Si Id del proyecto. Este campo es requerido, ya que, se listan los usuarios que pertenecen a determinado proyecto.
    ComparisonOperatorId Número Si
    Id del operador de comparador. Los valores son:
    1. >
    2. <
    3. >=
    4. <=
    5. =
    6. <>
    7. EXIST (IS NOT NULL)
    8. NOT EXIST (IS NULL)
    9. > GETDATE()
    10. < GETDATE()
    11. TRUE (1)
    12. FALSE (0)
    13. LIKE
    FieldName Texto Si Campo por el que se va a realizar la búsqueda
    LogicOperatorId Número Si Id del operador lógico. Los valores posibles son: 1 (AND) y 2 (OR).
    Value Texto Si Texto que se va a buscar


    Nota: Se debe tener en cuenta el tipo de dato del parámetro FieldName para utilizar el operador adecuado. Los campos tipo texto utilizan: 5, 6, 13.


    Cuerpo de la petición

    Ejemplo con una sola condición:

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

    Ejemplo con más de una condición:

    En este ejemplo se realiza la búsqueda de usuarios con Document = ‘1234567890’ OR UserName LIKE ‘%Usr2%’ AND Name LIKE ‘%Usuario 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"
        }
    ]
}

    Respuesta

    El servicio retornará un Json con la siguiente información:

    Ejemplo:

    {
    "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
    }
}


    Mensajes de error

    Código Estado HTTP Mensaje de error
    400 Badrequest InvalidProjectId
    400 BadRequest InvalidOperatorId
    400 BadRequest InvalidLogicOperatorId
    400 BadRequest InvalidValue
    500 InternalServerError FailureGetUsers