escudo
API docs by Redocly

Escudo Vecinal REST API (1.0.0)

Download OpenAPI specification:Download

Eficaz Digital: eficazdigital@google.com License: Apache 2.0

Documento Web API destinado a definir el funcionamiento de sistema Escudo Vecinal el cual permite la alerta de situaciones problemáticas en diferentes puntos de la ciudad mediante grupos personas

Crear usuarios

Operaciones para crear todos los tipos de usuarios

Utilidad

Verifica el estado del Webservice

Comprueba si el WebService está disponible y si es capas de procesar solicitudes

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "message": "No existe ningún recurso con el id especificado",
  • "status": 404,
  • "code": 0
}

Intercambia información importante entre cliente y Escudo Webservice

Permite el intercambio de información sensible o necesaria para el funcionamiento óptimo de los clientes

Authorizations:
(passportLocalServerpassportStaggingServer)
Request Body schema: application/json
required
operatingSystem
required
string

Nombre del sistema Operativo

platform
required
string

Nombre del la plataforma

osVersion
required
string

Version del sistema operativo

isVirtual
required
boolean

Define si la aplicacion se esta ejecutando en un entorno virtual

version
required
string

Version actual de la aplicacion

enviroment
required
string

Entorno de compilacion del webservice

model
required
string

Modelo del dispositivo

user
integer or null

Identificador del usuario logeado

Responses

Request samples

Content type
application/json
{
  • "operatingSystem": "string",
  • "platform": "android",
  • "osVersion": "string",
  • "isVirtual": true,
  • "version": "1.0.1",
  • "enviroment": "dev",
  • "model": "Xiami740",
  • "user": 0
}

Response samples

Content type
application/json
{
  • "update": {
    }
}

Comprobar contraseña

Comprueba la contraseña enviada contra el usuario autenticado con el OAuth token, usado cuando se quiere realizar una acción importante en el sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
Request Body schema: application/json
required
password
required
string

Contraseña a verificar

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "message": "Contraseña incorrecta",
  • "status": "409",
  • "code": "3753"
}

Endpoint de prueba

Este endpoint puede ser usado para cualquier tipo de objetivo

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "message": "No existe ningún recurso con el id especificado",
  • "status": 404,
  • "code": 0
}

Cuentas

Obtener los datos del usuario logeado

Recupera la informacion personal del usuario perteneciente al token que se esta enviado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtiene los roles del usuario logeado

Recupera un listado de roles de usuario que perteneciente al token que se esta enviado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Obtiene las notificaciones del usuario logeado

Recupera una lista de notificaciones que han sido enviadas por el sistema al usuario autenticado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Obtiene las noticias del usuario logeado

Recupera un listado de noticias que han sido enviadas por el sistema al usuario autenticado

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Usuarios

Obtiene todos los usuarios del sistema

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Obtiene un usuario

Recupera el usuario enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar informacion del usuario

Permite actualizar la contraseña o el username

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Request Body schema: application/json
optional
password
string <password> >= 6

Nueva contraseña

password_confirmation
string <password> >= 6

Repetir nueva contraseña

password_old
string <password> >= 6

Contraseña anterior

cellphone
string <= 11

Cambiar el usuario

close_all_sessions
number
Default: 1

Revoca todos los tokens

Responses

Request samples

Content type
application/json
{
  • "password": "pa$$word",
  • "password_confirmation": "pa$$word",
  • "password_old": "pa$$word",
  • "cellphone": "string",
  • "close_all_sessions": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deshabilitar un usuario

Deshabilita el usuario enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtiene una lista de noticias

Recupera el listado de noticias que el sistema a enviado al usuario identificado en ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Obtener una lista de notificaciones

Recuperar el listado de notificaciones que el sistema a enviado al usuario identificado en ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Recuperar todos los incidentes creados por un usuario

Obtener todos los incidente creado por un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Recuperar todos los incidnetes de todos los grupos a los que pertenece el usuario

Obtener todos los incidente de los grupos a los que pertenece el usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Obtiene las noticias de avisos

Recupera las noticias creadas por el usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Obtiener los roles de un usuario

Muestra las roles pertenecientes a un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Obtener los grupos de un usuario

Recupera los grupos a los que pertenece un usuario

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna la ciudad de nacimiento

Retorna la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Retorna la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna la ciudad de nacimiento

Retorna la ciudad donde nacio del usuario identificado en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crea un incidente

Crea un incidente

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
userId
required
integer

Identificador del usuario

groupId
required
integer

Identificador del grupo

Request Body schema: multipart/form-data
required
latitude
required
integer

Latitud de la ubicacion

longitude
required
integer

Longitud de la ubicacion

catalog_incident_id
integer

Identificador del catalogo del incidente

description
string

Descripción del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Escudos

Autocreacion de un usuario de tipo escudo

Creacion de usaurios de tipos escudo

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Recuperar todos los usuarios de tipo escudo

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Super escudo

Recuperar todos los usuarios de tipo super escudo

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Creacion de un usuario de tipo super escudo

Creacion de usaurios de tipos escudo

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Membrecias

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
membershipId
required
integer

Identificador del rol

Responses

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
membershipId
required
integer

Identificador del rol

Responses

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
membershipId
required
integer

Identificador del rol

Responses

Grupos

Obtener todos los grupos

Recupera el listado de todos los grupos a los que puede pertenecer un grupo

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Obtener los datos de un grupo

Recupera los datos del grupo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Recuperar todas las membrecias de un grupo

Recupera el listado de membrecias que puede pertenecen al grupo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Recuperar todos los usuarios de un grupo

Recupera el listado de usuarios que pertenecen al grupo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Recuperar todos los incidentes de un grupo

Recupera el listado incidentes del grupo enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
groupId
required
integer

Identificador del grupo

Responses

Notificaciones

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Retorna una notificacion

Muestra los datos de la notificacion enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar una notificacion

Modificar los valores de una notificacion

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el aviso de una notificacion

Muestra a que aviso pertenecee

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuario del una notificacion

Muestra que usuario pertenece la notificacion

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
notificationId
required
integer

Identificador de la notificacion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Avisos

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Retorna un aviso

Muestra los datos del aviso enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un aviso

Modificar los valores de un aviso

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna toda notificaciones de un aviso

Muestra un listado de notificaciones

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna el usuarios de un aviso

Muestra el usuario que emitio en aviso enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el usuarios de un aviso

Muestra el usuario que emitio en aviso enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
noticeId
required
integer

Identificador del aviso

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Incidentes

Retorna todos los incidentes

Muestra todos los incidentes

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Reegtorna un incidente

Muestra todos los incidentes

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
incidentId
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un incidente

Actualiza los datos de un incidentes

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
incidentId
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna un incidente

Muestra todos los incidentes

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
incidentId
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna un incidente

Muestra todos los incidentes

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
incidentId
required
integer

Identificador del incidente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Catalogo incidentes

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogincidentId
required
integer

Identificador del incidente

Responses

Recuperar todos los roles de grupos

Recupera el listado de datos los usuarios del sistema

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
catalogincidentId
required
integer

Identificador del incidente

Responses

Configuraciones del servicio

Retorna todas las configuraciones

Retorna la lista de configuraciones que pueden alterar el funcionamiento general de eficaz

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna una configuración

Retorna la configuración especificada en la ruta

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
configurationId
required
integer

Identificador de la configuracion

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Ciudades

Retorna todas las ciudades

Retorna una lista de ciudades

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un ciudad

Retorna la informacion de la ciudad enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el municipio de una ciudad

Retorna el municipio al que pertenecen la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los usuarios de una ciudad

Retorna el listado de usuarios que viven la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna los alumnos de una ciudad

Retorna el listado de alumnos que viven la ciudad enviada por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
cityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Estados

Retorna todos los estados

Retorna una lista de estados

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un estado

Retorna la informacion del estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el pais de un estado

Retorna el pais al que pertenece el estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Retorna los municipios de un estado

Retorna el listado de municipios que pertenecen al estado enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
stateId
required
integer

Identificador del estado

Responses

Paises

Retorna todos los paises

Retorna una lista de paises

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retorna un pais

Retorna la informacion del pais enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna los estados de un pais

Retorna una lista de estados que pertenecen al pais enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
countryId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Municipios

Retorna todos las municipios

Retorna una lista de municipios

Authorizations:
(passportLocalServerpassportStaggingServer)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Muestra un municipio

Retorna la informacion del municipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna el estado del municipio

Retorna el estado al que pertenece el minicipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna todas las ciudades de un municipio

Retorna la lista de ciudades que pertenecen al minicipio enviado por parametro

Authorizations:
(passportLocalServerpassportStaggingServer)
path Parameters
municipalityId
required
integer

Identificador del pais

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}