Diferencias

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

--- apiba360_105 [2024/03/05 15:41] – editor externo 127.0.0.1
+++ apiba360_105 [2024/10/12 02:19] (actual) – [Consultar submotivos] scantor
@@ Línea 73: / Línea 73: @@
 | [[apiba360_105#Avanzar el paso de un caso|Avanzar el paso de un caso]] | Avanza el caso al siguiente paso. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/workflow/next%% |
 | [[apiba360_105#Retroceder el paso de un caso|Retroceder el paso de un caso]] | Retrocede el caso al paso anterior. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/workflow/back%% |
+==== Actividades programadas ====
+^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
+| [[apiba360_105#Crear una actividad programada|Crear una actividad programada]] | Hace la creación de un caso en Be Aware 360. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/fsactividad/add%% |
 ===== Primeros pasos =====
@@ Línea 1457: / Línea 1462: @@
   * **[[apiba360_105#Consultar caso por Id contacto|Consultar caso por Id contacto:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/get/?icontacto=<id_contacto_ba360>%%.
   * **[[apiba360_105#Consultar casos abiertos creados por el usuario|Consultar casos abiertos creados por el usuario:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/get/?pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>&filtro=created%%.
+  * **[[apiba360_105#Consultar caso por búsqueda avanzada|Consultar caso por búsqueda avanzada:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/getBusquedaAvanzada%%.
 ----
@@ Línea 3469: / Línea 3475: @@
         "id": 5039
     },
+    "code": 200,
+    "message": null,
+    "pagination": null
+}
+</code>
+----
+==== Consultar caso por búsqueda avanzada ====
+----
+=== Método ===
+''**GET**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v10_5/caso/getBusquedaAvanzada%%**.
+----
+=== Request: ===
+**Parámetros:**
+Al ser una búsqueda avanzada se podrán usar como parámetros los campos estándar de un caso y/o también los campos personalizados (Custom Fields) definidos para los casos, en este último caso se debe **enviar como parámetro el valor del campo __label__**.
+La búsqueda corresponde a un operador AND, por lo tanto, el resultado retornará los casos que cumplen con todos los parámetros de búsqueda.
+A continuación, listamos los campos estándar del caso que pueden utilizar para este recurso:
+^ Campo ^ Descripción ^
+| id | Identificador único del caso asignado por Be Aware 360. |
+| idestado | Identificador del estado asignado al caso. |
+| idestadodesc | Descripción del estado asignado al caso. |
+| refnum | Número del caso. |
+| idcontacto | Identificador del contacto asignado al caso. |
+| idcontactodesc | Nombre del contacto asignado al caso. |
+| idcuenta | Identificador de la cuenta asignada al caso. |
+| razonsocial | Nombre de la cuenta asignada al caso. |
+| idusuarioasignado | Identificador del usuario asignado al caso. |
+| idusuarioasignadodesc | Nombre del usuario asignado al caso. |
+| idproducto | Identificador del producto asignado al caso. |
+| idproductodesc | Nombre del producto asignado al caso. |
+| idtipo | Identificador del motivo asignado al caso. |
+| idtipodesc | Nombre del motivo asignado al caso. |
+| idsubtipo | Identificador del submotivo asignado al caso. |
+| idsubtipodesc | Nombre del submotivo asignado al caso. |
+| origen | Nombre del canal por el cual se creó el caso. |
+| asunto | Asunto del caso. |
+| fechacreacion | Fecha de creación del caso. |
+| finalizado | Indica si el caso está finalizado. 0 indica que el caso no está finalizado y 1 indica que sí está finalizado el caso. |
+**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/caso/getBusquedaAvanzada?refnum=231128-001422&nombre y apellido=perez&medio de comunicacion=celular.
+</code>
+----
+=== Response ===
+Retorna la lista de todos los casos que cumplen con los criterios de búsqueda especificados en los parámetros.
+**Ejemplo:**
+<code java>
+{
+    "data": [
+        {
+            "checkList": null,
+            "idcontacto": 777,
+            "origen": "AgenteWeb",
+            "finalizado": 0,
+            "refnum": "231128-001422",
+            "asunto": "Prueba Masiva",
+            "fechacreacion": "2023-11-28",
+            "idcontactodesc": "Andrés Olano",
+            "idtipodesc": "Facturación y Pago",
+            "idestadodesc": "Completado",
+            "idusuarioasignadodesc": "MartaC",
+            "idcuentadesc": null,
+            "descripcion": null,
+            "idworkflow": 54,
+            "idtipo": 6,
+            "idcuenta": null,
+            "direccion": null,
+            "latitud": null,
+            "longitud": null,
+            "idsla": null,
+            "idproducto": 9,
+            "idsubtipo": 1,
+            "urlorigin": null,
+            "canal": null,
+            "idinteraccion": null,
+            "idconversacion": null,
+            "idusuarioasignado": 173,
+            "idstageactual": 116,
+            "idestado": 5,
+            "idusuariocreacion": 84,
+            "idworkflowdesc": "Prueba Olayo Rojas",
+            "color": "NEGRO",
+            "duedate": "2024-05-29 15:03:51.0",
+            "duedateslan": null,
+            "duedatesloutc": null,
+            "duedateslouser": "2024-05-29 19:03:51.0",
+            "duedateslorol": "2024-05-29 15:03:51.0",
+            "tmzcontacto": "America/Santiago",
+            "destacado": false,
+            "porcentaje": -230923,
+            "cf": {
+                "Orden": "Tipo B",
+                "tipo_caso": "Medio",
+                "tipo_enfermedad": "Ninguna",
+                "caracteristicas_caso": "[Escalado, Priorizado]",
+                "medio": "Celular",
+                "campo_ex": "2024-04-26T03:00:00.000Z",
+                "guia": "1234",
+                "nombre": "Juan Perez",
+                "TipoCliente": "A"
+            },
+            "idusuariomodificacion": 131,
+            "ccemails": null,
+            "textreopencase": null,
+            "idsubtipodesc": "Solicitud",
+            "idprioridaddesc": "Media",
+            "idproductodesc": "Crédito Inteligente",
+            "idprioridad": 2,
+            "colorusuario": "NEGRO",
+            "fingreso": "2024-05-29 18:33:51.0",
+            "flexible": null,
+            "primerpaso": 0,
+            "psolucionado": "0",
+            "pcreado": "0",
+            "ppendiente": "0",
+            "horastranscurridas2": null,
+            "totalnotas2": null,
+            "horastranscurridas": null,
+            "urgente": null,
+            "normal": null,
+            "totalnotas": null,
+            "solucionado": null,
+            "creado": null,
+            "pendiente": null,
+            "totalcasos": null,
+            "fechacreacionstr": "2023-11-28 00:00:00",
+            "fechamodificacionstr": "2024-05-29 00:00:00",
+            "timeactual": null,
+            "idprioridadcolor": "#27AE60",
+            "idstageactualdesc": "Completado",
+            "idusuariomodificaciondesc": "María Benedicto",
+            "idusuariocreaciondesc": "Germán Andrés Olano",
+            "idsladesc": null,
+            "logauditoria": null,
+            "fechafinalizacionhoralimit": null,
+            "fechamodificacionhora": "2024-05-29 14:33:51.0",
+            "fechamodificacionhoralimit": "2024-05-29 19:33:51",
+            "fechareapertura": null,
+            "porcentajeslan": null,
+            "tmzinstance": "America/Santiago",
+            "duedateslo": null,
+            "porcentajeslo": null,
+            "datafor": null,
+            "operationsistext": null,
+            "fechafinalizacion": null,
+            "slavalue": 30,
+            "sistemaexterno": null,
+            "fechamodificacion": "2024-05-29",
+            "fechahoracreacionutc": "2023-11-28 23:28:43.0",
+            "cantidadcasos": null,
+            "id": 5412,
+            "eid": null,
+            "uuid": null
+        }
+    ],
     "code": 200,
     "message": null,
@@ Línea 3994: / Línea 4190: @@
 Para más información sobre la parametrización de Tipificación caso en creación, haga clic [[parametrosdeconfiguracion#(parametros_de_casos)|aquí.]]
+**%%https://api.beaware360.com/ba360/apir/v10_5/producto/get?idcontacto=<id contacto>%%**.
+Este endpoint devuelve todos productos cargados en la instancia que puede visualizar un contacto en particular.
 ----
@@ Línea 4066: / Línea 4266: @@
 **%%https://api.beaware360.com/ba360/apir/v10_5/tipo/get%%**.
+Este endpoint retorna todos los motivos que existen en la plataforma.
+**%%https://api.beaware360.com/ba360/apir/v10_5/tipo/get?idproducto=<idproducto>&idcontacto=<idcontacto>%%**.
+Este endpoint retorna todos los motivos que pertenecen a un producto específico y que el contacto puede visualizar.
 ----
@@ Línea 4144: / Línea 4350: @@
 **%%https://api.beaware360.com/ba360/apir/v10_5/subtipo/get%%**.
+Este endpoint retorna todo el listado de submotivos registrados en la plataforma.
+**%%https://api.beaware360.com/ba360/apir/v10_5/subtipo/get?idtipo=<idmotivo>&idproducto=<idproducto>&idcontacto=<idcontacto>%%**.
+Este endpoint retorna todos los submotivos que pertenecen al producto y motivo y que solo el contacto puede visualizar.
 ----