Diferencias

Muestra las diferencias entre dos versiones de la página.

Enlace a la vista de comparación

Ambos lados, revisión anteriorRevisión previa
Próxima revisión		Revisión previa
apiba360_105 [2025/05/16 21:26] – [Crear usuario] aolanoapiba360_105 [2025/07/10 21:35] (actual) – [Actualizar caso] scantor
Línea 1474: Línea 1474:
 ---- ----
  
 +==== Eliminar usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**DELETE**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/usuario/del/?id=<id_usuario>%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  id -> Id del usuario.
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +  
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v10_5/usuario/del?id=5
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Elimina un usuario en específico de la base de datos de Be Aware 360.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": null,
 +        "apellido": null,
 +        "pass": null,
 +        "email": null,
 +        "idrol": null,
 +        "language": null,
 +        "estado": null,
 +        "user": null,
 +        "timezone": null,
 +        "idhorario": null,
 +        "multisession": null,
 +        "gruposkills": [],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": null,
 +        "cf": {},
 +        "latitud": null,
 +        "longitud": null,
 +        "idgrupo": null,
 +        "segmentaciones": [],
 +        "idempresa": null,
 +        "grupousuariosplus": null,
 +        "conceptodefecto": null,
 +        "isopais": null,
 +        "idexternal": null,
 +        "notificacionactiva": null,
 +        "idsusuariossupervisados": null,
 +        "fechacreacion": null,
 +        "fechamodificacion": null,
 +        "gruposskillsdesc": null,
 +        "primeringreso": null,
 +        "fechaultimaasignacion": null,
 +        "fechaposicion": null,
 +        "avatar": null,
 +        "cantidadcasos": null,
 +        "portada": null,
 +        "idgrupodesc": null,
 +        "idpermisodesc": null,
 +        "idpermiso": null,
 +        "acceso": null,
 +        "idroldesc": null,
 +        "idempresadesc": null,
 +        "idhorariodesc": null,
 +        "id": 168,
 +        "eid": null,
 +        "uuid": null
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Consultar Perfil Usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/perfilusuario/getby?id=<id_usuario>%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  id -> Id del usuario (Debe ser el mismo usuario que se ha autenticado).
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +  
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v10_5/perfilusuario/getby?id=8
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Muestra los datos del usuario autenticado.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +  "data": {
 +    "idusuario": null,
 +    "identificador": null,
 +    "nombre": "Germán Andres",
 +    "apellido": "Olano ",
 +    "pass": null,
 +    "email": "e_golano@inmotion.cl",
 +    "idrol": 9,
 +    "language": "es",
 +    "estado": null,
 +    "user": "golano",
 +    "timezone": "America/Mexico_City",
 +    "idhorario": 1,
 +    "multisession": null,
 +    "gruposkills": [],
 +    "idsusuariossupervisadosin": null,
 +    "idsusuariossupervisadosout": null,
 +    "cf": {},
 +    "latitud": null,
 +    "longitud": null,
 +    "idgrupo": null,
 +    "segmentaciones": [],
 +    "idempresa": 1,
 +    "grupousuariosplus": null,
 +    "conceptodefecto": null,
 +    "isopais": null,
 +    "idexternal": null,
 +    "notificacionactiva": null,
 +    "idsusuariossupervisados": null,
 +    "fechacreacion": null,
 +    "fechamodificacion": null,
 +    "gruposskillsdesc": [
 +      "Atención mejoras",
 +      "AUDITOR LIQUIDADOR UIO GYE",
 +      "Grupo Rec ChatBot",
 +      "Grupo Rec Contact Center",
 +      "Grupo Atención",
 +      "Oficina Pasto Pymes",
 +      "Oficina Fusagasugá",
 +      "Grupo de prueba",
 +      "A1L - OTRAS CONSULTAS",
 +      "A2L - MEDICINA GENERAL",
 +      "A1L - OBSTETRICIA",
 +      "A1L - INFORMACIÓN CORONAVIRUS",
 +      "A1L - PSICOLOGÍA",
 +      "Prueba consola"
 +    ],
 +    "primeringreso": null,
 +    "fechaultimaasignacion": null,
 +    "fechaposicion": null,
 +    "avatar": null,
 +    "cantidadcasos": 168,
 +    "portada": null,
 +    "idgrupodesc": null,
 +    "idpermisodesc": null,
 +    "idpermiso": null,
 +    "acceso": null,
 +    "idroldesc": "Administrador",
 +    "idempresadesc": "Equipo de implementación de negocios",
 +    "idhorariodesc": "Lunes A Viernes",
 +    "id": 8,
 +    "eid": null,
 +    "uuid": null
 +  },
 +  "code": 200,
 +  "message": null,
 +  "pagination": null
 +}
 +</code>
 +
 +----
 +==== Actualizar Perfil Usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**PUT**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/perfilusuario/upd%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  No requiere parámetros
 +
 +**Campos:**
 +
 + ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| id | id del usuario | Int | Sí |  | 1 |
 +| nombre | Nombre del usuario | String | Sí |  | “Josefina” |
 +| apellido | Apellido del usuario | String | Sí |  | “Fernández” |
 +| email | Correo electrónico del usuario | String | Sí |  | "correo3@beaware.com” |
 +| language | Id del Idioma Asociado | String | No | "es" |
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "nombre": "Agente",
 +    "apellido": "Atención3",
 +    "email": "test@grupoinmotion.com",
 +    "language": "es",
 +    "id": 1000  
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema actualiza el usuario con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": "Agente",
 +        "apellido": "Atencion3",
 +        "pass": null,
 +        "email": "test@grupoinmotion.com",
 +        "idrol": 9,
 +        "language": "es",
 +        "estado": null,
 +        "user": "agente3",
 +        "timezone": "America/Mexico_City",
 +        "idhorario": 1,
 +        "multisession": null,
 +        "gruposkills": [],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": null,
 +        "cf": {},
 +        "latitud": null,
 +        "longitud": null,
 +        "idgrupo": null,
 +        "segmentaciones": [],
 +        "idempresa": 1,
 +        "grupousuariosplus": null,
 +        "conceptodefecto": null,
 +        "isopais": null,
 +        "idexternal": null,
 +        "notificacionactiva": null,
 +        "idsusuariossupervisados": null,
 +        "fechacreacion": null,
 +        "fechamodificacion": null,
 +        "gruposskillsdesc": [],
 +        "primeringreso": null,
 +        "fechaultimaasignacion": null,
 +        "fechaposicion": null,
 +        "avatar": null,
 +        "cantidadcasos": 168,
 +        "portada": null,
 +        "idgrupodesc": null,
 +        "idpermisodesc": null,
 +        "idpermiso": null,
 +        "acceso": null,
 +        "idroldesc": "Administrador",
 +        "idempresadesc": "Equipo de implementación de negocios",
 +        "idhorariodesc": "Lunes A Viernes",
 +        "id": 10000
 +        "eid": null,
 +        "uuid": null
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Cambiar Contraseña Perfil Usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**PUT**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/cambiopass%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  No requiere parámetros
 +
 +**Campos:**
 +
 + ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| pass1 | Clave actual usuario | Strint | Sí |  | "Pasa1" |
 +| pass2 | Nueva clave del usuario | String | Sí |  | “Pasa2” |
 +| pass3 | Confirmación nueva clave | String | Sí |  | “Pasa2” |
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +  "pass1": "Pasa.123",
 +  "pass2": "Pasa.1234",
 +  "pass3": "Pasa.1234"
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema actualiza el usuario con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": "Agente",
 +        "apellido": "Atencion3",
 +        "pass": "Pasa.1234",
 +        "email": "test@grupoinmotion.com",
 +        "idrol": 9,
 +        "language": "es",
 +        "estado": null,
 +        "user": "agente3",
 +        "timezone": "America/Mexico_City",
 +        "idhorario": 1,
 +        "multisession": null,
 +        "gruposkills": [],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": null,
 +        "cf": {},
 +        "latitud": null,
 +        "longitud": null,
 +        "idgrupo": null,
 +        "segmentaciones": [],
 +        "idempresa": 1,
 +        "grupousuariosplus": null,
 +        "conceptodefecto": null,
 +        "isopais": null,
 +        "idexternal": null,
 +        "notificacionactiva": null,
 +        "idsusuariossupervisados": null,
 +        "fechacreacion": null,
 +        "fechamodificacion": null,
 +        "gruposskillsdesc": [],
 +        "primeringreso": null,
 +        "fechaultimaasignacion": null,
 +        "fechaposicion": null,
 +        "avatar": null,
 +        "cantidadcasos": 168,
 +        "portada": null,
 +        "idgrupodesc": null,
 +        "idpermisodesc": null,
 +        "idpermiso": null,
 +        "acceso": null,
 +        "idroldesc": "Administrador",
 +        "idempresadesc": "Equipo de implementación de negocios",
 +        "idhorariodesc": "Lunes A Viernes",
 +        "id": 10000
 +        "eid": null,
 +        "uuid": null
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
  
 ===== Recursos para Cuentas ===== ===== Recursos para Cuentas =====
Línea 4880: Línea 5321:
 | idcuenta | Cuenta a la que pertenece el contacto que está asociada al caso | Integer | No |  | 45 | | idcuenta | Cuenta a la que pertenece el contacto que está asociada al caso | Integer | No |  | 45 |
 | idsla | Id del acuerdo asociado al caso | Integer | No |  | 1 | | idsla | Id del acuerdo asociado al caso | Integer | No |  | 1 |
-| idworkflow | Id del proceso asociado al caso | Integer | No | No es necesario enviar este campo dado que la combinación del producto, motivo y submotivo asigna automáticamente el caso al proceso | 2 |+| idworkflow | Id del proceso asociado al caso | Integer | No | Es necesario enviar este campo si es un caso que tiene un proceso asociado; de lo contrario, se limpiará el proceso del caso. | 2 | 
 +| idstageactual | Id del paso del proceso asociado al caso | Integer | No | Es necesario enviar este campo si es un caso que tiene un proceso asociado para indicar en qué paso se encuentra el caso; de lo contrario, generará error la API. | 55 |
 | idusuarioasignado | Id del usuario asignado al caso | Integer | No | Esta es la lógica que emplea Be Aware 360 cuando se actualiza el asignado de un caso: \\ \\  * Si se envía ID asignado válido, lo asigna al caso. \\  * Si se envía ID asignado inválido, deja Caso sin asignado. \\  * Si no se envía parámetro de asignado, deja Caso sin asignado. \\  * Si se envía ID asignado NULL, deja al Caso sin asignado. \\  * Si se envía un ID asignado de un usuario que está //Inactivo//, lo asigna al Caso. | 3 | | idusuarioasignado | Id del usuario asignado al caso | Integer | No | Esta es la lógica que emplea Be Aware 360 cuando se actualiza el asignado de un caso: \\ \\  * Si se envía ID asignado válido, lo asigna al caso. \\  * Si se envía ID asignado inválido, deja Caso sin asignado. \\  * Si no se envía parámetro de asignado, deja Caso sin asignado. \\  * Si se envía ID asignado NULL, deja al Caso sin asignado. \\  * Si se envía un ID asignado de un usuario que está //Inactivo//, lo asigna al Caso. | 3 |
 | cf | Campos personalizados del caso | Lista (depende del tipo de campo) | Depende de la configuración del campo personalizado si fue marcado como obligatorio. | Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. **Nota:** Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 | {"guia": "2345", "fecha guía": "2020-01-06T05:00:00.000Z"} | | cf | Campos personalizados del caso | Lista (depende del tipo de campo) | Depende de la configuración del campo personalizado si fue marcado como obligatorio. | Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. **Nota:** Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 | {"guia": "2345", "fecha guía": "2020-01-06T05:00:00.000Z"} |
 | id | Id del caso que se va a actualizar | Integer | Sí |  | 8 | | id | Id del caso que se va a actualizar | Integer | Sí |  | 8 |
 +| finalizado| Indica si el caso se encuentra finalizado o no | Integer | Sí |  | 1 |
  
 **Ejemplo:** **Ejemplo:**
Línea 4900: Línea 5343:
  "idworkflow": 11,  "idworkflow": 11,
  "idsla": 9,  "idsla": 9,
 +        "finalizado" : 0,
  "cf":   "cf": 
  {  {
Línea 6143: Línea 6587:
     "data": [     "data": [
         {         {
 +            "idusuario": 29,
 +            "nombre": "Domicilio.pdf",
             "idrol": 6,             "idrol": 6,
-            "nombre": "Archivo de prueba.pdf", +            "idobjeto": 1802, 
-            "idstage": 47,+            "tipoobjeto": "casos", 
 +            "seen": 0, 
 +            "fechacreacion": "2025-06-13 22:12:31", 
 +            "idstage": 110, 
 +            "tipodocumento": "Comprobante de domicilio",
             "metadatos": [             "metadatos": [
                 {                 {
-                    "clave": "GRUPO_DOCUMENTO", +                    "clave": "TipoArchivo", 
-                    "valor": "43"+                    "valor": "DOC"
                 },                 },
                 {                 {
-                    "clave": " TIPO_DOCUMENTO", +                    "clave": "IdArchivo", 
-                    "valor": "752"+                    "valor": "987654"
                 }                 }
             ],             ],
-            "idusuario": 29, +            "idtipodocumento": 5,
-            "idobjeto": 442, +
-            "tipoobjeto": "casos", +
-            "fechacreacion": "2025-03-17 21:38:07",+
             "file": null,             "file": null,
-            "idtipodocumento": 1, +            "idcontactodesc": "Pedro Gómez",
-            "seen": 0, +
-            "tipodocumento": "Acta de nacimiento",+
             "tag": "Archivo de prueba.pdf",             "tag": "Archivo de prueba.pdf",
             "filesize": 15895,             "filesize": 15895,
-            "clasificacion": null,+            "publico": 1,
             "idusuariodesc": "Juan Pérez",             "idusuariodesc": "Juan Pérez",
-            "idroldesc": "Ejecutivo de atención", +            "idroldesc": "Analista", 
-            "idstagedesc": "Registro información",+            "clasificacion": null, 
 +            "idstagedesc": "Análisis", 
 +            "id": 1732,
             "eid": null,             "eid": null,
-            "uuid": null, +            "uuid": null
-            "id": 255+
         },         },
         {         {
-            "idrol": 6,+            "idusuario": 29,
             "nombre": "Documento de reembolso.pdf",             "nombre": "Documento de reembolso.pdf",
-            "idstage": 47,+            "idrol": 6, 
 +            "idobjeto": 1802, 
 +            "tipoobjeto": "casos", 
 +            "seen": 0, 
 +            "fechacreacion": "2025-06-13 22:12:43", 
 +            "idstage": 110, 
 +            "tipodocumento": "Reembolso",
             "metadatos": [             "metadatos": [
                 {                 {
-                    "clave": "GRUPO_DOCUMENTO", +                    "clave": "TipoArchivo", 
-                    "valor": "5050010005"+                    "valor": "DOC"
                 },                 },
                 {                 {
-                    "clave": "TIPO_DOCUMENTO", +                    "clave": "IdArchivo", 
-                    "valor": "5050010005009"+                    "valor": "47382384"
                 }                 }
             ],             ],
-            "idusuario": 29, +            "idtipodocumento": 74,
-            "idobjeto": 442, +
-            "tipoobjeto": "casos", +
-            "fechacreacion": "2025-03-17 21:38:32",+
             "file": null,             "file": null,
-            "idtipodocumento": 5, +            "idcontactodesc": "Pedro Gómez",
-            "seen": 0, +
-            "tipodocumento": "Reembolso de pago",+
             "tag": "Documento de reembolso.pdf",             "tag": "Documento de reembolso.pdf",
             "filesize": 15804,             "filesize": 15804,
-            "clasificacion": null,+            "publico": 0,
             "idusuariodesc": "Juan Pérez",             "idusuariodesc": "Juan Pérez",
-            "idroldesc": "Ejecutivo de atención", +            "idroldesc": "Analista", 
-            "idstagedesc": "Análisis de Información",+            "clasificacion": null, 
 +            "idstagedesc": "Análisis", 
 +            "id": 1733,
             "eid": null,             "eid": null,
-            "uuid": null, +            "uuid": null
-            "id": 256+
         }         }
     ],     ],
Línea 6248: Línea 6696:
 ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 | COMPANYNAME | Instancia de Be Aware 360. | String | Sí |  | ba360review | | COMPANYNAME | Instancia de Be Aware 360. | String | Sí |  | ba360review |
-| IDOBJETO | Id del caso al que se le agregará el archivo. | Integer | Sí |  | 6542 |+| IDOBJETO | Id del caso al que se le agregará el archivo. | Integer | Sí |  | 203 |
 | TIPOOBJETO | Especifica el tipo de objeto de la nota. | String | Sí | Valor: "casos" | casos | | TIPOOBJETO | Especifica el tipo de objeto de la nota. | String | Sí | Valor: "casos" | casos |
 | TAGS | Especifica la etiqueta que llevará el archivo adjunto al caso. | String | Sí | Acepta valores vacíos, pero es obligatorio que se envíe en el request. | Prueba API | | TAGS | Especifica la etiqueta que llevará el archivo adjunto al caso. | String | Sí | Acepta valores vacíos, pero es obligatorio que se envíe en el request. | Prueba API |
 | FILE | Archivo adjunto del caso | Archivo (Formato binario). | Sí | De acuerdo con el lenguaje de programación que se esté empleando, se deben usar las funciones para cargar el archivo y generar dicho archivo en formato binario. |  | | FILE | Archivo adjunto del caso | Archivo (Formato binario). | Sí | De acuerdo con el lenguaje de programación que se esté empleando, se deben usar las funciones para cargar el archivo y generar dicho archivo en formato binario. |  |
-| IDUSUARIO | Identifica el ID de usuario que hace la carga del archivo al caso. | Integer | Sí |  | 44 | +| IDUSUARIO | Identifica el ID de usuario que hace la carga del archivo al caso. | Integer | Sí |  | 3 | 
-| IDTIPODOCUMENTO | Identifica el ID del Catálogo de documentos con el que se subirá el archivo al caso. | Integer | No |  | 1 |+| IDTIPODOCUMENTO | Identifica el ID del tipo de documento asociado al archivo que se está cargando en el caso. | Integer | No |  | 22 | 
 +| PUBLICO | Identifica si el archivo que se está cargando en el caso es de carácter público o privado. | Integer | Sí | El valor 1 corresponde a Público y el valor 0 corresponde a Privado. | 1 |
  
 **Ejemplo:** **Ejemplo:**
  
-{{:api.png?1200|}}+{{:archivosadjuntos:archivos_carga_adjuntos_caso_10_5.png|Ejemplo de carga de archivos adjuntos desde Postman}}
  
 ---- ----
apiba360_105.1747430816.txt.gz · Última modificación: por aolano
Excepto donde se indique lo contrario, el contenido de este wiki esta bajo la siguiente licencia: CC Attribution-Noncommercial-Share Alike 4.0 International


  • Ver página
  • Revisiones antiguas
  • Enlaces a esta página
  • Cambios recientes
  • Administrador de Ficheros
  • Índice