Api rest access control

GET    => Retorna un arreglo de items, en caso de que no existan en la base de datos retornará un arreglo vacio.
POST   => Crea un nuevo item con los parametro requeridos.
PUT    => Actualiza un item con base a los parametros enviados.
DELETE => Elimina de manera logica un item.

Houses

Endpoints

GET    /access-control/api/house
POST   /access-control/api/house
PUT    /access-control/api/house/:id/:params
DELETE /access-control/api/house/:id

Params

alias (string): Alias de la casa requerido
house_number (string): Número de casa requerido
image (string): Path de la imagen de la casa (s3, local etc) requerido
owner_name (string): Nombre del propietario requerido
owner_phone (string): Telefono del propietario requerido
section (string): Nombre de la sección ubicada de la casa requerido

Methods

GET    /access-control/api/house
GET    /access-control/api/house/:id

Response
[
    {
        "id_house": "1",
        "alias": "mr rob",
        "house_number": "25",
        "image": "img/path/path/path.jpg",
        "owner_name": "test lastname",
        "owner_phone": "6665874589",
        "section": "Torre 1",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

POST   /access-control/api/house

Response
[
    "Data is inserted successfully"
]

PUT    /access-control/api/house/:id/:params

Response
[
    "Data is updated successfully"
]

DELETE /access-control/api/house/:id

Response
[
    "Data is deleted successfully"
]

Tickets

Endpoints

GET    /access-control/api/ticket
POST   /access-control/api/ticket
PUT    /access-control/api/ticket/:id/:params
DELETE /access-control/api/ticket/:id

Params

id_ticket_type (int): Id del tipo de ticket creado requerido
id_ticket_info (int): Id del almacen de datos del ticket requerido
id_user (int): Id del usuario que crea el ticket requerido

Methods

GET    /access-control/api/ticket
GET    /access-control/api/ticket:id

Response
[
    {
        "id_ticket": "2",
        "id_ticket_type": "4",
        "id_ticket_info": "5",
        "id_user": "6",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

POST   /access-control/api/ticket

Response
[
    "Data is inserted successfully"
]

PUT    /access-control/api/ticket/:id/:params

Response
[
    "Data is updated successfully"
]

DELETE /access-control/api/ticket/:id

Response
[
    "Data is deleted successfully"
]

Ticket-Info

Endpoints

GET    /access-control/api/ticketInfo
POST   /access-control/api/ticketInfo
PUT    /access-control/api/ticketInfo/:id/:params
DELETE /access-control/api/ticketInfo/:id

Params

id_ticket (int): Id del ticket al que pertenece la información requerido
id_house (int): Id de la casa a la que pertenece el ticket requerido
fullname_contact (int): Nombre completo del contacto requerido
entry_time (string): Hora de entrada requerido
exit_time (string): Hora de salida requerido
total_persons (int): Número total de personas requerido
persons_info (string): Informacion de acompañantes (Esta debe de ir concatenada) requerido
fullname_visited (string): Nombre completo del visitado requerido
img_number_plate (string): Path de la imagen de las placas de la unidad (s3, local etc) requerido
car_register_type (string): Tipo de registro de la unidad (Onapafa, Estatal etc) requerido
car_model (string): Modelo de la unidad requerido
car_brand (string): Marca de la unidad requerido
img_identification_front (string): Path de la imagen de la identificacion parte frontal (s3, local etc) requerido
img_identification_back (string): Path de la imagen de la identificacion parte trasera (s3, local etc) requerido
status (string): Estatus del ticket (Inici, pendiente o finalizado) requerido

Methods

GET    /access-control/api/ticketInfo
GET    /access-control/api/ticketInfo/:id

Response
[
    {
        "id_ticket_info": "1",
        "id_ticket": "1",
        "id_house": "3",
        "fullname_contact": "CONTACT NAME",
        "entry_time": "12:53",
        "exit_time": "15:23",
        "total_persons": "2",
        "persons_info": "jose lopez:23:masculino;juan perez:23:masculino;",
        "fullname_visited": "FULLNAME VISITED",
        "img_number_plate": "path/path/path/path.png",
        "car_register_type": "Onapafa",
        "car_model": "1993",
        "car_brand": "Ford",
        "img_identification_front": "path/path/path/path.png",
        "img_identification_back": "path/path/path/path.png",
        "status": "Inicial",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

POST   /access-control/api/ticketInfo

Response
[
    "Data is inserted successfully"
]

PUT    /access-control/api/ticketInfo/:id/:params

Response
[
    "Data is updated successfully"
]

DELETE /access-control/api/ticketInfo/:id

Response
[
    "Data is deleted successfully"
]

Ticket Types

Endpoints

GET    /access-control/api/ticketType

Methods

GET    /access-control/api/ticketType
GET    /access-control/api/ticketType/:id

Response
[
    {
        "id_ticket_type": "1",
        "name": "Visitante",
        "description": "description ...",
        "active": "1",
        "create_at": "2019-04-03"
    },
    {
        "id_ticket_type": "2",
        "name": "Arrendaratio",
        "description": "description ...",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

Codes

Endpoints

GET    /access-control/api/code
POST   /access-control/api/code
PUT    /access-control/api/code/:id/:params
DELETE /access-control/api/code/:id

Params

id_ticket (int): Id del ticket al que pertenece la información requerido

Methods

GET    /access-control/api/code
GET    /access-control/api/code/:id

Response
[
    {
        "id_code": "1",
        "id_ticket": "12",
        "active": "1",
        "create_at": "2019-04-03"
    },
    {
        "id_code": "2",
        "id_ticket": "1222",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

POST   /access-control/api/code

Response
[
    "Data is inserted successfully"
]

PUT    /access-control/api/code/:id/:params

Response
[
    "Data is updated successfully"
]

DELETE /access-control/api/code/:id

Response
[
    "Data is deleted successfully"
]

Users

Endpoints

GET    /access-control/api/user
POST   /access-control/api/user
PUT    /access-control/api/user/:id/:params
DELETE /access-control/api/user/:id

Params

id_user_type (int): Id del del tipo de usuario requerido
fullname (string): Nombre completo requerido
company_name (string): Nombre de la compañia requerido
email (string): Correo electronico requerido
cellphone (string): Número celular requerido
company_number (string): Número de la compañia requerido
house_number (string): Número de casa requerido
username (string): nombre de usuario requerido
password (string): Contraseña requerido

Methods

GET    /access-control/api/user
GET    /access-control/api/user/:id

Response
[
    {
        "id_user": "1",
        "id_user_type": "2",
        "fullname": "TESTNAME",
        "company_name": "DHL",
        "email": "[email protected]",
        "cellphone": "6245896587",
        "company_number": "1255874",
        "house_number": "2544789",
        "username": "test21",
        "password": "test2122",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

POST   /access-control/api/user

Response
[
    "Data is inserted successfully"
]

PUT    /access-control/api/user/:id/:params

Response
[
    "Data is updated successfully"
]

DELETE /access-control/api/user/:id

Response
[
    "Data is deleted successfully"
]

Users-Houses

Endpoints

GET    /access-control/api/userHouse
POST   /access-control/api/userHouse
PUT    /access-control/api/userHouse/:id/:params
DELETE /access-control/api/userHouse/:id

Params

id_user (int): id del usuario requerido
id_house (int): id de la casa requerido

Methods

GET    /access-control/api/userHouse
GET    /access-control/api/userHouse/:id

Response
[
    {
        "id_user_house": "1",
        "id_user": "1",
        "id_house": "2",
        "active": "1",
        "create_at": "2019-04-03"
    },
    {
        "id_user_house": "2",
        "id_user": "1",
        "id_house": "3",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

POST   /access-control/api/userHouse

Response
[
    "Data is inserted successfully"
]

PUT    /access-control/api/userHouse/:id/:params

Response
[
    "Data is updated successfully"
]

DELETE /access-control/api/userHouse/:id

Response
[
    "Data is deleted successfully"
]

User Types

Endpoints

GET    /access-control/api/userType

Methods

GET    /access-control/api/userType
GET    /access-control/api/userType/:id

Response
[
    {
        "id_user_type": "1",
        "name": "Admin",
        "description": "descripcion...",
        "active": "1",
        "create_at": "2019-04-03"
    },
    {
        "id_user_type": "2",
        "name": "Seguridad",
        "description": "descripcion...",
        "active": "1",
        "create_at": "2019-04-03"
    },
    {
        "id_user_type": "3",
        "name": "Administrador de casas",
        "description": "descripcion...",
        "active": "1",
        "create_at": "2019-04-03"
    }
]

josegoyo/access-control-api.md

Api rest access control

Houses

Endpoints

Params

Methods

Tickets

Endpoints

Params

Methods

Ticket-Info

Endpoints

Params

Methods

Ticket Types

Endpoints

Methods

Codes

Endpoints

Params

Methods

Users

Endpoints

Params

Methods

Users-Houses

Endpoints

Params

Methods

User Types

Endpoints

Methods