Ronda sénior X - Manual de usuario> Integraciones> Integraciones con otros sistemas> Integrar ocurrencias

Integración de ocurrencias usando la API

Documentación sobre cómo integrar incidentes usando la API Ronda senior X.

Requisitos previos generales

Estar autenticado en Ronda X senior;
Tener un tipo de ocurrencia registrada en Ronda senior X;
Tener ubicaciones físicas registradas en Ronda senior X;
Pase el token en el encabezado.

Consultar ocurrencia

llame al servicioOBTENER /incidente/búsqueda paginada/todos consultar una lista paginada con todas las apariciones de los usuarios;

En Postman, la página y el total de páginas deben pasarse como parámetro (consulta): https://sam-api.senior.com.br/api/v1/incident/pagedsearch/all?página=1&tamaño de página = 10

Registrar ocurrencia

Para registrar una nueva ocurrencia, es necesario el tipo de ocurrencia y la ubicación física seleccionada. Realice los siguientes procedimientos:

llame al servicioOBTENER /tipo de incidente seleccionar el tipo de ocurrencia;
En cartero, es necesario pasar el token e ingresar la URL: https://sam-api.senior.com.br/api/v1/incidenttype;
llame al servicioOBTENER /ubicación física/búsqueda para búsqueda automática de ubicaciones físicas;
En cartero, se debe pasar como parámetro el término y la situación de ubicación: https://sam-api.senior.com.br/api/v1/physicallocation/search?término=empresa&situación=1

Para guardar el incidente:

llame al servicioENVÍO /incidente;
Pase el JSON en el Cuerpo;
Reúna el JSON con los datos del incidente, el ID y la descripción de la ubicación física, el ID y la descripción del tipo de incidente, la fecha actual, el estado, la prioridad, la descripción del incidente y el ID del dispositivo o de la cámara, según el origen del incidente. Si la fuente es un dispositivo, el JSON tendrá el objeto "dispositivo" y no tendrá la "cámara", y viceversa;
Si hay personas asociadas con el suceso, se debe informar al conjunto de personas.

Observación

Los datos de Data deben tener el siguiente formato: "2017-03-24T10:09:00-03:00".

Servicio de información

OBTENER /incidente/búsqueda paginada/todos

Notas de implementación

Devuelve una matriz paginada de todos los incidentes del usuario.

Clase de respuesta (estado 200)

Devuelve una matriz paginada de todos los incidentes del usuario.

[
{
"identificación": 0,
"localizacion fisica": {
"identificación": 0,
"nombre": "cadena"
},
"tipo de incidente": {
"identificación": 0,
"nombre": "cadena"
},
"fecha": "cadena",
"Estado: Pendiente",
"prioridad": "DESCONOCIDA"
}
]

Parámetros

Parámetro	Descripción	Tipo de parámetro	Tipo de datos
simbólico	token de autenticación	encabezamiento	cadena
página	página	consulta	entero
tamaño de página	tamaño de página	consulta	entero

Mensajes de respuesta

Código de estado HTTP	Razón	Modelo de respuesta
401	El token no es válido o ha caducado
500	Error del Servidor	{ "código": 0, "mensaje": "cadena" }

OBTENER /tipo de incidente

Notas de implementación

Devolver una matriz de tipo de incidente

Clase de respuesta (estado 200)

Una variedad de tipos de incidentes

[
{
"identificación": 0,
"nombre": "cadena",
"descripción": "cadena",
"isWatched": verdadero
}
]

Parámetros

Parámetro	Descripción	Tipo de parámetro	Tipo de datos
simbólico	token de autenticación	encabezamiento	cadena

Mensajes de respuesta

Código de estado HTTP	Razón	Modelo de respuesta
401	El token no es válido o ha caducado
500	Error del Servidor	{ "código": 0, "mensaje": "cadena" }

OBTENER /ubicación física/búsqueda

Notas de implementación

Búsqueda automática completa hasta la ubicación física

Clase de respuesta (estado 200)

Una variedad de información básica desde la ubicación física limitada a 10 resultados.

[
{
"identificación": 0,
"nombreWithPath": "cadena"
}
]

Parámetros

Parámetro	Descripción	Tipo de parámetro	Tipo de datos
simbólico	token de autenticación	encabezamiento	cadena
término	Término del nombre de la ubicación física	consulta	cadena
situación	Filtro de situación de ubicación física (0=TODOS, 1=ACTIVO)	consulta	entero

Mensajes de respuesta

Código de estado HTTP	Razón	Modelo de respuesta
401	El token no es válido o ha caducado
500	Error del Servidor	{ "código": 0, "mensaje": "cadena" }

ENVÍO /incidente

Notas de implementación

Cree un nuevo incidente, el campo Id. se ignorará

Clase de respuesta (estado 200)

Incidente creado

{
"identificación": 0,
"localizacion fisica": {
"identificación": 0,
"nombre": "cadena"
},
"tipo de incidente": {
"nombre": "cadena",
"nombre": "cadena",
"isWarningSound": verdadero
},
"fecha": "cadena",
"fechacreación": "cadena",
"Estado: Pendiente",
"descripción": "cadena",
"dispositivo": {
"identificación": 0,
"nombre": "cadena",
"nombre": "cadena",
"tipo de dispositivo": 0,
"Tecnología lectora": 0
},
"identificación": 0,
"nombre": "cadena"
"name": "string"
"gente": [
"people": [
"identificación": 0,
"nombre": "cadena",
"Documentos obligatorios": [
"mandatoryDocuments": [
"identificación": 0,
"Tipo de Documento": {
"identificación": 0,
"nombre": "cadena",
"etiqueta": "cadena",
"máscara": "cadena",
"máscara": "cadena",
"requerido": verdadero
"documento": "cadena"
"document": "string"
}
],
"identificación": 0,
"identificación": 0,
"preferencial": verdadero,
"dirección de correo electrónico": "cadena"
},
"identificación": 0,
"identificación": 0,
"preferencial": verdadero,
"ddi": 0,
"número de teléfono": "cadena",
"extensionLine": "cadena",
"tipo": "INDEFINIDO"
},
"lastFeedbackPollDate": "cadena",
"useSelfServiceTerminal": verdadero
}
"usuario": {
"identificación": 0,
"nombre": "cadena"
"name": "string"
"procedimientos": [
"cadena"
"string"
],
"incidentOrigin": "USUARIO"
}

Parámetros

Parámetro	Descripción	Tipo de parámetro	Tipo de datos
simbólico	token de autenticación	encabezamiento	cadena
Incidente	Incidente	cuerpo	{ "identificación": 0, "localizacion fisica": { "identificación": 0, "nombre": "cadena" }, "tipo de incidente": { "nombre": "cadena", "nombre": "cadena", "isWarningSound": verdadero }, "fecha": "cadena", "fechacreación": "cadena", "Estado: Pendiente", "descripción": "cadena", "dispositivo": { "identificación": 0, "nombre": "cadena", "nombre": "cadena", "tipo de dispositivo": 0, "Tecnología lectora": 0 }, "identificación": 0, "nombre": "cadena" "name": "string" "gente": [ "people": [ "identificación": 0, "nombre": "cadena", "Documentos obligatorios": [ "mandatoryDocuments": [ "identificación": 0, "Tipo de Documento": { "identificación": 0, "nombre": "cadena", "etiqueta": "cadena", "máscara": "cadena", "máscara": "cadena", "requerido": verdadero "documento": "cadena" "document": "string" } ], "identificación": 0, "identificación": 0, "preferencial": verdadero, "dirección de correo electrónico": "cadena" }, "identificación": 0, "identificación": 0, "preferencial": verdadero, "ddi": 0, "número de teléfono": "cadena", "extensionLine": "cadena", "tipo": "INDEFINIDO" }, "lastFeedbackPollDate": "cadena", "useSelfServiceTerminal": verdadero } "usuario": { "identificación": 0, "nombre": "cadena" "name": "string" "procedimientos": [ "cadena" "string" ], "incidentOrigin": "USUARIO" }

Mensajes de respuesta

Código de estado HTTP	Razón	Modelo de respuesta
401	El token no es válido o ha caducado
403	Operación denegada
500	Error del Servidor	{ "código": 0, "mensaje": "cadena" }

Nota

Para obtener más información sobre las API de Ronda senior X en general, consulte ladocumentación detallada de estas API.