Búsqueda de usuarios

    Detalles de la petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/user/searchAll?projectId={projectId}&serviceId={serviceId}&companyId={companyId}&itemType={itemType}&criteria={criteria}
    • Tipo: GET
    • Encabezados requeridos:
      • content-type: application/json
      • X-Authorization: Bearer {token}

    Descripción de la URL

    • {host}: Representa el dominio del ambiente en el que se encuentra la API.
    • ASMSAPI/: Prefijo fijo de la API.
    • Uri: Endpoint específico para la petición.


    EJEMPLO URL:

    https://{host}/ASMSAPI/api/v9/user/searchAll?projectId={projectId}&serviceId={serviceId}&companyId={companyId}&itemType={itemType}&criteria={criteria}
    


    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    itemType Enumerador Tipo de búsqueda:
    • Client = 37
    • Specialist = 53
    projectId Número No Identificador del proyecto
    serviceId Número No Identificador del servicio
    companyId Número No Identificador de la compañía
    criteria Texto No Texto de búsqueda de usuario

    Cuerpo de la petición

    N/A

    Ejemplos de URI

    • /api/v9/user/searchAll?itemType=specialist&projectId=2&criteria=abdy
    • /api/v9/user/searchAll?itemType=specialist&projectId=2&criteria=
    • /api/v9/user/searchAll?itemType=specialist&projectId=2

    Respuesta

    {
        "content": [
            {
                "email": "tri@pri.comx",
                "id": 150,
                "name": "Abdy Sanjur",
                "userName": "ASANJUR"
            }
        ],
        "totalItems": 1
    }
    

    Parámetros de respuesta

    Nombre Tipo de dato Descripción
    totalItems Número Número total de objetos encontrados
    content Lista Listado de objetos
    email Texto Correo electrónico del usuario
    id Número Identificador del usuario
    name Texto Nombre del usuario
    userName Texto Alias del usuario

    Mensajes de error

    Código Estado HTTP Mensaje de error
    500 InternalServerError FailureSearchUsers
    400 BadRequest InvalidTypeForSearch