Skip to content

lvvanegas10/201720-s1_puntosfidelidad

 
 

Repository files navigation

s1_puntosfidelidad

Repositorio del proyecto de puntos de fidelidad del grupo 5 de la sección 1 UNIT NAME = puntosfidelidadPU

Integrantes

Nombre Correo Rol
Camilo Sánchez Salamanca ca.sanchez38 Líder
Julían Alberto Manrique Puerto ja.manrique Líder de Desarrollo/Líder de Proceso y la Calidad
Alvaro Alfonso Yepes Bonilla aa.yepes Líder de Soporte
Sebástian Cespedes Otalora s.cespedes10 Líder de Diseño Web
Laura Valeria Vanegas García lv.vanegas10 Líder de Planeación

Tabla de contenidos

Recurso Compra

El objeto Compra tiene 2 representaciones JSON:

Representación Minimum

{
    id: '' /*Tipo Long*/,
    pagoConPuntos: '' /*Tipo Boolean*/
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    [
    producto: {
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    valorDinero: '' /*Tipo Integer*/, 
    valorPuntos: '' /*Tipo Integer*/}
    ],
    
    tarjetaPuntos: {
    id: '' /*Tipo Long*/,
    montoBasico: '' /*Tipo Integer*/,
    montoActual: '' /*Tipo Integer*/,
    numPuntos: '' /*Tipo Integer*/}
    
}

GET /compra

Retorna una colección de objetos Compra en representación Detail. Cada Compra en la colección tiene embebidos los siguientes objetos: Producto, TarjetaPuntos.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

GET /compra/{id}

Retorna una colección de objetos Compra en representación Detail. Cada Book en la colección tiene los siguientes objetos: Producto, TarjetaPuntos.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Compra a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Compra en representaciones Detail
404 No existe un objeto Compra con el ID solicitado Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

POST /compras

Es el encargado de crear objetos Compra.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
body body Objeto Compra que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Compra ha sido creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo crear el objeto Book Mensaje de error

PUT /compra/{id}

Es el encargado de actualizar objetos Compra.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Compra a actualizar Integer
body body Objeto Compra nuevo Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Compra actualizado Representación Detail
412 business exception, no se cumple con las reglas de negocio Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo actualizar el objeto Compra Mensaje de error

DELETE /compra/{id}

Elimina un objeto Compra.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Compra a eliminar Integer

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET compra/{comprasid}/productos

Retorna una colección de objetos Producto asociados a un objeto Compra en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Compra a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Producto en representación Detail
500 Error consultando authors Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET compra/{compraid}/producto/{productoid}

Retorna un objeto Producto asociados a un objeto Compra en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
booksid Path ID del objeto Compra a consultar Integer
authorsid Path ID del objeto Producto a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Producto en representación Detail
404 No existe un objeto Producto con el ID solicitado asociado al objeto Book indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST compra/{compraid}/producto/{productoid}

Asocia un objeto Producto a un objeto Compra.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
booksid PathParam ID del objeto Compra al cual se asociará el objeto Author Integer
authorsid PathParam ID del objeto Producto a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Producto asociado Representación Detail de Producto
500 No se pudo asociar el objeto Producto Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT compra/{compraid}/producto

Es el encargado de remplazar la colección de objetos Producto asociada a un objeto Compra.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
booksid Path ID del objeto Compra cuya colección será remplazada Integer
body body Colección de objetos Producto Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Author en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE compra/{compraid}/producto/{productoid}

Remueve un objeto Producto de la colección en un objeto Compra.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
booksid Path ID del objeto Compra asociado al objeto Producto Integer
authorsid Path ID del objeto Producto a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

Recurso Administrador

El objeto Administrador tiene 2 representaciones JSON:

Representación Minimum

{
    usuario: '' /*Tipo String*/,
    contrasena: '' /*Tipo String*/,
    
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    Restaurante:    [
        {  /* Restaurante  en su representación Minimum*/}
] 
    
}

GET /administradores

Retorna una colección de objetos Administrador en representación Detail. Cada Administrador en la colección tiene embebidos los siguientes objetos: Restaurante.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

GET /administradores/{administradoresid}

Retorna una colección de objetos Administrador en representación Detail. Cada Administrador en la colección tiene los siguientes objetos: recargas, restaurante, tarjetasDePuntos, compras, comentarios.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Administrador a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Administrador en representaciones Detail
404 No existe un objeto Administrador con el ID solicitado Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

POST /administradores

Es el encargado de crear objetos Administrador.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
body body Objeto Administrador que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Administrador ha sido creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo crear el objeto Administrador Mensaje de error

PUT /administradores/{administradoresid}

Es el encargado de actualizar objetos Administrador.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Administrador a actualizar Integer
body body Objeto Administrador nuevo Representación Minimum

Respuesta

Código Descripción Cuerpo
201 El objeto Administrador actualizado Representación Minimum
412 business exception, no se cumple con las reglas de negocio Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo actualizar el objeto Administrador Mensaje de error

DELETE /administradores/{administradoresid}

Elimina un objeto Administrador.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Administrador a eliminar Integer

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET administradores/{administradoresid}/restaurante

Retorna una colección de objetos Restaurante asociados a un objeto Administrador en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Administrador a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Restaurante en representación Detail
500 Error consultando restaurante Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET administradores/{administradoresid}/restaurante/{restauranteid}

Retorna un objeto Restaurante asociados a un objeto Administrador en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
administradoresid Path ID del objeto Administradora consultar Integer
restauranteid Path ID del objeto Restaurante a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Restaurante en representación Detail
404 No existe un objeto Restaurante con el ID solicitado asociado al objeto Administrador indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST administradores/{administradoresid}/restaurante /{restauranteid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
administradoresid PathParam ID del objeto Administrador al cual se asociará el objeto Category Integer
restauranteid PathParam ID del objeto Restaurante a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Restaurante asociado Representación Detail de Restaurante
500 No se pudo asociar el objeto Restaurante Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT administradores/{administradoresid}/restaurante

Es el encargado de remplazar la colección de objetos Restaurante asociada a un objeto Administrador.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
administradoresid Path ID del objeto Administrador cuya colección será remplazada Integer
body body Colección de objetos Restaurante Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Restaurante en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE administradores/{administradoresid}/restaurante /{restauranteid }

Remueve un objeto Restaurante de la colección en un objeto Administrador .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
administradoresid Path ID del objeto Administrador asociado al objeto Category Integer
restauranteid Path ID del objeto Restaurante a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET administradores/{administradoresid}/tarjetasDePuntos

Retorna una colección de objetos TarjetaDePuntos asociados a un objeto Administrador en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Administrador a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos TarjetaDePuntos en representación Detail
500 Error consultando tarjetasDePuntos Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE administradores/{administradoresid}/compras /{comprasid }

Remueve un objeto Compra de la colección en un objeto Administrador .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
administradoresid Path ID del objeto Administrador asociado al objeto Category Integer
comprasid Path ID del objeto Compra a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

Recurso Restaurante

El objeto Restaurante tiene 2 representaciones JSON:

Representación Minimum

{
    nit: '' /*Tipo String*/,
    nombre: '' /*Tipo String*/,
    tipoComida: '' /*Tipo String*/,
    
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    sucursales:    [
        {  /* Sucursal 1 en su representación Minimum*/}
         ...
        {  /* Sucursal n en su representación Minimum*/}
    ] 
productosCanjeables:     [
        {  /* Producto 1 en su representación Minimum*/}
         ...
        {  /* Producto n en su representación Minimum*/}
    ]
    
    eventos:     [
        {  /* Evento 1 en su representación Minimum*/}
         ...
        {  /* Evento n en su representación Minimum*/}
    ]
}

GET /restaurantes

Retorna una colección de objetos Restaurante en representación Detail. Cada Restaurante en la colección tiene embebidos los siguientes objetos: Editorial.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

GET /restaurantes/{restaurantesid}

Retorna una colección de objetos Restaurante en representación Detail. Cada Restaurante en la colección tiene los siguientes objetos: productosCanjeables, sucursales, tarjetasDePuntos, eventos, comentarios.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Restaurante a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Restaurante en representaciones Detail
404 No existe un objeto Restaurante con el ID solicitado Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

POST /restaurantes

Es el encargado de crear objetos Restaurante.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
body body Objeto Restaurante que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Restaurante ha sido creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo crear el objeto Restaurante Mensaje de error

PUT /restaurantes/{restaurantesid}

Es el encargado de actualizar objetos Restaurante.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Restaurante a actualizar Integer
body body Objeto Restaurante nuevo Representación Minimum

Respuesta

Código Descripción Cuerpo
201 El objeto Restaurante actualizado Representación Minimum
412 business exception, no se cumple con las reglas de negocio Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo actualizar el objeto Restaurante Mensaje de error

DELETE /restaurantes/{restaurantesid}

Elimina un objeto Restaurante.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Restaurante a eliminar Integer

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET restaurantes/{restaurantesid}/sucursales

Retorna una colección de objetos Sucursal asociados a un objeto Restaurante en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Restaurante a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Sucursal en representación Detail
500 Error consultando sucursales Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET restaurantes/{restaurantesid}/sucursales/{sucursalesid}

Retorna un objeto Sucursal asociados a un objeto Restaurante en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurantea consultar Integer
sucursalesid Path ID del objeto Sucursal a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Sucursal en representación Detail
404 No existe un objeto Sucursal con el ID solicitado asociado al objeto Restaurante indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST restaurantes/{restaurantesid}/sucursales /{sucursalesid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid PathParam ID del objeto Restaurante al cual se asociará el objeto Category Integer
sucursalesid PathParam ID del objeto Sucursal a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Sucursal asociado Representación Detail de Sucursal
500 No se pudo asociar el objeto Sucursal Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT restaurantes/{restaurantesid}/sucursales

Es el encargado de remplazar la colección de objetos Sucursal asociada a un objeto Restaurante.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurante cuya colección será remplazada Integer
body body Colección de objetos Sucursal Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Sucursal en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE restaurantes/{restaurantesid}/sucursales /{sucursalesid }

Remueve un objeto Sucursal de la colección en un objeto Restaurante .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurante asociado al objeto Category Integer
sucursalesid Path ID del objeto Sucursal a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET restaurantes/{restaurantesid}/productosCanjeables

Retorna una colección de objetos Recarga asociados a un objeto Restaurante en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Restaurante a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Recarga en representación Detail
500 Error consultando productosCanjeables Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET restaurantes/{restaurantesid}/productosCanjeables/{productosCanjeablesid}

Retorna un objeto Recarga asociados a un objeto Restaurante en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurantea consultar Integer
productosCanjeablesid Path ID del objeto Recarga a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Recarga en representación Detail
404 No existe un objeto Recarga con el ID solicitado asociado al objeto Restaurante indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST restaurantes/{restaurantesid}/productosCanjeables /{productosCanjeablesid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid PathParam ID del objeto Restaurante al cual se asociará el objeto Category Integer
productosCanjeablesid PathParam ID del objeto Recarga a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Recarga asociado Representación Detail de Recarga
500 No se pudo asociar el objeto Recarga Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT restaurantes/{restaurantesid}/productosCanjeables

Es el encargado de remplazar la colección de objetos Recarga asociada a un objeto Restaurante.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurante cuya colección será remplazada Integer
body body Colección de objetos Recarga Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Recarga en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE restaurantes/{restaurantesid}/productosCanjeables /{productosCanjeablesid }

Remueve un objeto Recarga de la colección en un objeto Restaurante .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurante asociado al objeto Category Integer
productosCanjeablesid Path ID del objeto Recarga a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET restaurantes/{restaurantesid}/eventos

Retorna una colección de objetos Compra asociados a un objeto Restaurante en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Restaurante a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Compra en representación Detail
500 Error consultando eventos Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET restaurantes/{restaurantesid}/eventos/{eventosid}

Retorna un objeto Compra asociados a un objeto Restaurante en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurantea consultar Integer
eventosid Path ID del objeto Compra a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Compra en representación Detail
404 No existe un objeto Compra con el ID solicitado asociado al objeto Restaurante indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST restaurantes/{restaurantesid}/eventos /{eventosid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid PathParam ID del objeto Restaurante al cual se asociará el objeto Category Integer
eventosid PathParam ID del objeto Compra a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Compra asociado Representación Detail de Compra
500 No se pudo asociar el objeto Compra Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT restaurantes/{restaurantesid}/eventos

Es el encargado de remplazar la colección de objetos Compra asociada a un objeto Restaurante.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurante cuya colección será remplazada Integer
body body Colección de objetos Compra Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Compra en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE restaurantes/{restaurantesid}/eventos /{eventosid }

Remueve un objeto Compra de la colección en un objeto Restaurante .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
restaurantesid Path ID del objeto Restaurante asociado al objeto Category Integer
eventosid Path ID del objeto Compra a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

Recurso Sucursal

El objeto Sucursal tiene 2 representaciones JSON:

Representación Minimum

{
    nombre: '' /*Tipo String*/,
    descripcion: '' /*Tipo String*/,
    horaApertura: " /*Tipo LocalTime*/,
    horaCierre: " /*Tipo LocalTime*/,
    idRestaurante: '' /*Tipo Long*/,
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    nombre: '' /*Tipo String*/,
    descripcion: '' /*Tipo String*/,
    horaApertura: " /*Tipo LocalTime*/,
    horaCierre: " /*Tipo LocalTime*/,
    idRestaurante: '' /*Tipo Long*/,
}

GET /sucursales

Retorna una colección de objetos Sucursal en representación Detail.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no existe ninguna sucursal Mensaje de error
500 Error interno Mensaje de error

GET /sucursales/{id}

Retorna una colección de objetos Sucursal pertenecientes al restaurante con el id dado

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del Objeto Sucursal buscado Long

Respuesta

Código Descripción Cuerpo
200 OK Coleccion de objetos Sucursal en representaciones Detail
404 No existe ninguna sucursal con el id dado Mensaje de error
500 Error interno Mensaje de error

POST /sucursales

Es el encargado de crear objetos Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
body body Objeto Sucursal que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Sucursal ha sido creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
500 No se pudo crear el objeto Sucursal Mensaje de error

PUT /sucursal{id}

Es el encargado de actualizar objetos Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Sucursal a actualizar Integer
body body Objeto Sucursal nuevo Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Sucursal actualizado Representación Detail
412 business exception, no se cumple con las reglas de negocio Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo actualizar el objeto Sucursal Mensaje de error

DELETE /sucursales/{id}

Elimina un objeto Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID de la sucursal a eliminar Long

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error
404 No existe la sucursal especificada Mensaje de error

GET Sucursals/{id}/comentarios

Retorna una colección de objetos Comentario asociados a un objeto Sucursal en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Sucursal a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Comentarioen representación Detail
500 Error consultando categories Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET Sucursals/{id}/comentarios/{categoriesid}

Retorna un objeto Category asociados a un objeto Sucursal en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
Sucursalsid Path ID del objeto Sucursal a consultar Integer
categoriesid Path ID del objeto Category a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Category en representación Detail
404 No existe un objeto Category con el ID solicitado asociado al objeto Sucursal indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST Sucursals/{Sucursalsid}/categories/{categoriesid}

Asocia un objeto Category a un objeto Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
Sucursalsid PathParam ID del objeto Sucursal al cual se asociará el objeto Category Integer
categoriesid PathParam ID del objeto Category a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Category asociado Representación Detail de Category
500 No se pudo asociar el objeto Category Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT Sucursals/{Sucursalsid}/categories

Es el encargado de remplazar la colección de objetos Category asociada a un objeto Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
Sucursalsid Path ID del objeto Sucursal cuya colección será remplazada Integer
body body Colección de objetos Category Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Category en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE sucursales/{id}/comentarios/{}

Remueve un objeto Category de la colección en un objeto Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Sucursal asociado al objeto Category Long
Path ID del objeto Comentario a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error

GET sucursales/{id}/compras

Retorna una colección de objetos Compra asociados a un objeto Sucursal en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Sucursal a consultar Long

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Compra en representación Detail
500 Error consultando Compras Mensaje de error

GET sucursales/{id}/compras/{idCompra}

Retorna un objeto Compra asociados a un objeto Sucursal en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Sucursal a consultar Long
idCompra Path ID del objeto Compra a consultar Long

Respuesta

Código Descripción Cuerpo
200 OK Objeto Compra en representación Detail
404 No existe un objeto Compra con el ID solicitado asociado al objeto Sucursal indicado Mensaje de error
500 Error interno Mensaje de error

POST sucursales/{id}/Compras/{Comprasid}

Asocia un objeto Compra a un objeto Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
Sucursalsid PathParam ID del objeto Sucursal al cual se asociará el objeto Compra Integer
Comprasid PathParam ID del objeto Compra a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Compra asociado Representación Detail de Compra
500 No se pudo asociar el objeto Compra Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT sucursales/{id}/Compras

Es el encargado de remplazar la colección de objetos Compra asociada a un objeto Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Sucursal cuya colección será remplazada Long
body body Colección de objetos Compra Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Compra en Representación Detail
500 No se pudo remplazar la colección Mensaje de error

DELETE sucursales/{id}/compras/{idCompra}

Remueve un objeto Compra de la colección en un objeto Sucursal.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Sucursal asociado al objeto Compra Long
idCompra Path ID del objeto Compra a remover Long

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error

Recurso Producto

El objeto Producto tiene 2 representaciones JSON:

Representación Minimum

{
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    valorDinero: '' /*Tipo Integer*/, 
    valorPuntos: '' /*Tipo Integer*/
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    restaurante: {
    id: '' /*Tipo Long*/,
    nit: '' /*Tipo String*/,
    nombre: '' /*Tipo String*/, 
    tipoComida: '' /*Tipo String*/}

}

GET /Producto

Retorna una colección de objetos Producto en representación Detail.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

GET /producto/{id}

Retorna una colección de objetos Producto en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Producto a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Producto en representaciones Detail
404 No existe un objeto Author con el ID solicitado Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

POST /producto

Es el encargado de crear objetos Producto.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
body body Objeto Producto que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Producto ha sido creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo crear el objeto Author Mensaje de error

PUT /producto/{id}

Es el encargado de actualizar objetos Producto.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Producto a actualizar Integer
body body Objeto Producto nuevo Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Producto actualizado Representación Detail
412 business exception, no se cumple con las reglas de negocio Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo actualizar el objeto Producto Mensaje de error

DELETE /producto/{id}

Elimina un objeto Producto.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Producto a eliminar Integer

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

Recurso Cliente

El objeto Cliente tiene 2 representaciones JSON:

Representación Minimum

{
    usurario: '' /*Tipo String*/,
    nombre: '' /*Tipo String*/,
    contrasena: '' /*Tipo String*/,
    imagen: '' /*Tipo String*/,
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    tarjetasDeCredito:    [
        {  /* TarjetaDeCredito 1 en su representación Minimum*/}
         ...
        {  /* TarjetaDeCredito n en su representación Minimum*/}
    ] 
    tarjetasDePuntos:    [
        {  /* TarjetaDePunto 1 en su representación Minimum*/}
         ...
        {  /* TarjetaDePunto n en su representación Minimum*/}
    ] 
    recargas:     [
        {  /* Recarga 1 en su representación Minimum*/}
         ...
        {  /* Recarga n en su representación Minimum*/}
    ]
    comentarios:     [
        {  /* Comentario 1 en su representación Minimum*/}
         ...
        {  /* Comentario n en su representación Minimum*/}
    ]
    compras:     [
        {  /* Compra 1 en su representación Minimum*/}
         ...
        {  /* Compra n en su representación Minimum*/}
    ]
}

GET /clientes

Retorna una colección de objetos Cliente en representación Detail. Cada Cliente en la colección tiene embebidos los siguientes objetos: Editorial.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

GET /clientes/{clientesid}

Retorna una colección de objetos Cliente en representación Detail. Cada Cliente en la colección tiene los siguientes objetos: recargas, tarjetasDeCredito, tarjetasDePuntos, compras, comentarios.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Cliente en representaciones Detail
404 No existe un objeto Cliente con el ID solicitado Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 Error interno Mensaje de error

POST /clientes

Es el encargado de crear objetos Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
body body Objeto Cliente que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Cliente ha sido creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo crear el objeto Cliente Mensaje de error

PUT /clientes/{clientesid}

Es el encargado de actualizar objetos Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a actualizar Integer
body body Objeto Cliente nuevo Representación Minimum

Respuesta

Código Descripción Cuerpo
201 El objeto Cliente actualizado Representación Minimum
412 business exception, no se cumple con las reglas de negocio Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error
500 No se pudo actualizar el objeto Cliente Mensaje de error

DELETE /clientes/{clientesid}

Elimina un objeto Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a eliminar Integer

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/tarjetasDeCredito

Retorna una colección de objetos TarjetaDeCredito asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos TarjetaDeCredito en representación Detail
500 Error consultando tarjetasDeCredito Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/tarjetasDeCredito/{tarjetasDeCreditoid}

Retorna un objeto TarjetaDeCredito asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Clientea consultar Integer
tarjetasDeCreditoid Path ID del objeto TarjetaDeCredito a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto TarjetaDeCredito en representación Detail
404 No existe un objeto TarjetaDeCredito con el ID solicitado asociado al objeto Cliente indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST clientes/{clientesid}/tarjetasDeCredito /{tarjetasDeCreditoid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid PathParam ID del objeto Cliente al cual se asociará el objeto Category Integer
tarjetasDeCreditoid PathParam ID del objeto TarjetaDeCredito a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto TarjetaDeCredito asociado Representación Detail de TarjetaDeCredito
500 No se pudo asociar el objeto TarjetaDeCredito Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT clientes/{clientesid}/tarjetasDeCredito

Es el encargado de remplazar la colección de objetos TarjetaDeCredito asociada a un objeto Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente cuya colección será remplazada Integer
body body Colección de objetos TarjetaDeCredito Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos TarjetaDeCredito en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE clientes/{clientesid}/tarjetasDeCredito /{tarjetasDeCreditoid }

Remueve un objeto TarjetaDeCredito de la colección en un objeto Cliente .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente asociado al objeto Category Integer
tarjetasDeCreditoid Path ID del objeto TarjetaDeCredito a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/tarjetasDePuntos

Retorna una colección de objetos TarjetaDePuntos asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos TarjetaDePuntos en representación Detail
500 Error consultando tarjetasDePuntos Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/tarjetasDePuntos/{tarjetasDePuntosid}

Retorna un objeto TarjetaDePuntos asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Clientea consultar Integer
tarjetasDePuntosid Path ID del objeto TarjetaDePuntos a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto TarjetaDePuntos en representación Detail
404 No existe un objeto TarjetaDePuntos con el ID solicitado asociado al objeto Cliente indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST clientes/{clientesid}/tarjetasDePuntos /{tarjetasDePuntosid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid PathParam ID del objeto Cliente al cual se asociará el objeto Category Integer
tarjetasDePuntosid PathParam ID del objeto TarjetaDePuntos a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto TarjetaDePuntos asociado Representación Detail de TarjetaDePuntos
500 No se pudo asociar el objeto TarjetaDePuntos Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT clientes/{clientesid}/tarjetasDePuntos

Es el encargado de remplazar la colección de objetos TarjetaDePuntos asociada a un objeto Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente cuya colección será remplazada Integer
body body Colección de objetos TarjetaDePuntos Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos TarjetaDePuntos en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE clientes/{clientesid}/tarjetasDePuntos /{tarjetasDePuntosid }

Remueve un objeto TarjetaDePuntos de la colección en un objeto Cliente .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente asociado al objeto Category Integer
tarjetasDePuntosid Path ID del objeto TarjetaDePuntos a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/comentarios

Retorna una colección de objetos Comentario asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Comentario en representación Detail
500 Error consultando comentarios Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/comentarios/{comentariosid}

Retorna un objeto Comentario asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Clientea consultar Integer
comentariosid Path ID del objeto Comentario a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Comentario en representación Detail
404 No existe un objeto Comentario con el ID solicitado asociado al objeto Cliente indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST clientes/{clientesid}/comentarios /{comentariosid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid PathParam ID del objeto Cliente al cual se asociará el objeto Category Integer
comentariosid PathParam ID del objeto Comentario a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Comentario asociado Representación Detail de Comentario
500 No se pudo asociar el objeto Comentario Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT clientes/{clientesid}/comentarios

Es el encargado de remplazar la colección de objetos Comentario asociada a un objeto Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente cuya colección será remplazada Integer
body body Colección de objetos Comentario Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Comentario en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE clientes/{clientesid}/comentarios /{comentariosid }

Remueve un objeto Comentario de la colección en un objeto Cliente .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente asociado al objeto Category Integer
comentariosid Path ID del objeto Comentario a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/recargas

Retorna una colección de objetos Recarga asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Recarga en representación Detail
500 Error consultando recargas Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/recargas/{recargasid}

Retorna un objeto Recarga asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Clientea consultar Integer
recargasid Path ID del objeto Recarga a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Recarga en representación Detail
404 No existe un objeto Recarga con el ID solicitado asociado al objeto Cliente indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST clientes/{clientesid}/recargas /{recargasid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid PathParam ID del objeto Cliente al cual se asociará el objeto Category Integer
recargasid PathParam ID del objeto Recarga a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Recarga asociado Representación Detail de Recarga
500 No se pudo asociar el objeto Recarga Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT clientes/{clientesid}/recargas

Es el encargado de remplazar la colección de objetos Recarga asociada a un objeto Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente cuya colección será remplazada Integer
body body Colección de objetos Recarga Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Recarga en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE clientes/{clientesid}/recargas /{recargasid }

Remueve un objeto Recarga de la colección en un objeto Cliente .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente asociado al objeto Category Integer
recargasid Path ID del objeto Recarga a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/compras

Retorna una colección de objetos Compra asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
id Path ID del objeto Cliente a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Compra en representación Detail
500 Error consultando compras Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

GET clientes/{clientesid}/compras/{comprasid}

Retorna un objeto Compra asociados a un objeto Cliente en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Clientea consultar Integer
comprasid Path ID del objeto Compra a consultar Integer

Respuesta

Código Descripción Cuerpo
200 OK Objeto Compra en representación Detail
404 No existe un objeto Compra con el ID solicitado asociado al objeto Cliente indicado Mensaje de error
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

POST clientes/{clientesid}/compras /{comprasid }

Asocia un objeto Category a un objeto Book.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid PathParam ID del objeto Cliente al cual se asociará el objeto Category Integer
comprasid PathParam ID del objeto Compra a asociar Integer

Respuesta

Código Descripción Cuerpo
200 Objeto Compra asociado Representación Detail de Compra
500 No se pudo asociar el objeto Compra Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT clientes/{clientesid}/compras

Es el encargado de remplazar la colección de objetos Compra asociada a un objeto Cliente.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente cuya colección será remplazada Integer
body body Colección de objetos Compra Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos Compra en Representación Detail
500 No se pudo remplazar la colección Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

DELETE clientes/{clientesid}/compras /{comprasid }

Remueve un objeto Compra de la colección en un objeto Cliente .

Parámetros

Nombre Ubicación Descripción Requerido Esquema
clientesid Path ID del objeto Cliente asociado al objeto Category Integer
comprasid Path ID del objeto Compra a remover Integer

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

Recurso Evento

El objeto Evento tiene 2 representaciones JSON:

Representación Minimum

{
    nombre: '' /*Tipo String*/,
    fechaInicio: "/*Tipo Calendar*/,
    fechaFin: "/*Tipo Calendar*/,
    descripcion: '' /*Tipo String*/,
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    nombre: '' /*Tipo String*/,
    fechaInicio: "/*Tipo Calendar*/,
    fechaFin: "/*Tipo Calendar*/,
    descripcion: '' /*Tipo String*/,
   
}

GET /eventos

Retorna una colección de objetos Evento en representación Detail. Cada Evento en la colección tiene embebidos los siguientes objetos: Editorial.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
500 Error interno Mensaje de error

GET /eventos/{nombre}

Retorna una colección de objetos Evento en representación Detail. Cada Evento en la colección tiene los siguientes objetos: Editorial.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String

Respuesta

Código Descripción Cuerpo
200 OK Objeto Evento en representaciones Detail
404 No existe un objeto Evento con el ID solicitado Mensaje de error
500 Error interno Mensaje de error

POST /eventos

Es el encargado de crear objetos Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
body body Objeto Evento que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Evento ha sido creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecida Mensaje de error
500 No se pudo crear el objeto Evento Mensaje de error

PUT /eventos/{nombre}

Es el encargado de actualizar objetos Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path nombre del Evento a actualizar String
body body Objeto Evento nuevo Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Evento actualizado Representación Detail
412 business exception, no se cumple con las reglas de negocio Mensaje de error
500 No se pudo actualizar el objeto Evento Mensaje de error

DELETE /eventos/{nombre}

Elimina un objeto Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
Nobre Path Nombre del Evento a eliminar String

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error

GET eventos/{nombre}/ubicaciones

Retorna una colección de objetos Ubicacion asociados a un objeto Evento en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Category en representación Detail
500 Error consultando categories Mensaje de error

GET eventos/{nombre}/ubicaciones/{direccion}

Retorna un objeto Ubicacion asociados a un objeto Evento en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String
direccion Path Direccion del objeto Ubicacion a consultar String

Respuesta

Código Descripción Cuerpo
200 OK Objeto Category en representación Detail
404 No existe un objeto Category con el ID solicitado asociado al objeto Evento indicado Mensaje de error
500 Error interno Mensaje de error

POST eventos/{nombre}/ubicaciones/{direccion}

Asocia un objeto Ubicacion a un objeto Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String
direccion Path Direccion del objeto Ubicacion a consultar String

Respuesta

Código Descripción Cuerpo
200 Objeto Ubicacion asociado Representación Detail de Ubicacion
500 No se pudo asociar el objeto Ubicacion Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT eventos/{nombre}/ubicaciones

Es el encargado de remplazar la colección de objetos Ubicacion asociada a un objeto Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del objeto Evento cuya colección será remplazada String
body body Colección de objetos Ubicacion Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objeto Ubicacion en Representación Detail
500 No se pudo remplazar la colección Mensaje de error

DELETE eventos/{nombre}/ubicaciones/{direccion}

Remueve un objeto Ubicacion de la colección en un objeto Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String
direccion Path Direccion del objeto Ubicacion a consultar String

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error

GET eventos/{nombre}/restaurantes

Retorna una colección de objetos Restaurante asociados a un objeto Evento en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String

Respuesta

Código Descripción Cuerpo
200 OK Colección de objetos Category en representación Detail
500 Error consultando categories Mensaje de error

GET eventos/{nombre}/restaurantes/{id}

Retorna un objeto Restaurante asociados a un objeto Evento en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String
direccion Path Direccion del objeto Ubicacion a consultar String

Respuesta

Código Descripción Cuerpo
200 OK ObjetoRestaurante en representación Detail
404 No existe un objeto Restaurante con el ID solicitado asociado al objeto Evento indicado Mensaje de error
500 Error interno Mensaje de error

POST eventos/{nombre}/restaurantes/{id}

Asocia un objeto Restaurante a un objeto Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String
id Path Id del objeto Restaurante a consultar String

Respuesta

Código Descripción Cuerpo
200 Objeto Restaurante asociado Representación Detail de Restaurante
500 No se pudo asociar el objeto Restaurante Mensaje de error
405 method not allowed, no existe permiso para el recurso Mensaje de error

PUT eventos/{nombre}/restaurantes

Es el encargado de remplazar la colección de objetos Ubicacion asociada a un objeto Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del objeto Evento cuya colección será remplazada String
body body Colección de objetos Ubicacion Representación Detail

Respuesta

Código Descripción Cuerpo
200 Se remplazó la colección Colección de objetos restaurante en Representación Detail
500 No se pudo remplazar la colección Mensaje de error

DELETE eventos/{nombre}/restaurante/{id}

Remueve un objeto Restaurante de la colección en un objeto Evento.

Parámetros

Nombre Ubicación Descripción Requerido Esquema
nombre Path Nombre del Evento a consultar String
id Path Id del objeto Restaurante a consultar String

Respuesta

Código Descripción Cuerpo
204 Objeto removido N/A
500 Error interno Mensaje de error

Recurso Ubicacion

El objeto Ubicación tiene 2 representaciones JSON:

Representación Minimum

{
    direccion: '' /*Tipo String*/,
    latitud: '' /*Tipo String*/,
    longitud: '' /*Tipo String*/,
}

Representación Detail

{
    // todo lo de la representación Minimum más los objetos Minimum con relación simple.
    direccion: '' /*Tipo String*/,
    latitud: '' /*Tipo String*/,
    longitud: '' /*Tipo String*/,
}

GET /ubicaciones

Retorna una colección de objetos Ubicacion en representación Detail.

Parámetros

N/A

Respuesta

Código Descripción Cuerpo
200 OK Colección de representaciones Detail
412 precondition failed, no existe ninguna ubicacion Mensaje de error
500 Error interno Mensaje de error

GET /ubicacion/{direccion}

Retorna una colección de objetos Ubicacion en representación Detail.

Parámetros

Nombre Ubicación Descripción Requerdirecciono Esquema
direccion Path direccion del objeto ubicacion a consultar String

Respuesta

Código Descripción Cuerpo
200 OK Objeto ubicacion en representaciones Detail
404 No existe un objeto Ubicacion con el direccion solicitado Mensaje de error
500 Error interno Mensaje de error

POST /Ubicacion

Es el encargado de crear objetos Ubicacion.

Parámetros

Nombre Ubicación Descripción Requerdirecciono Esquema
body body Objeto Ubicacion que será creado Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Ubicacion ha sdirecciono creado Representación Detail
412 precondition failed, no se cumple la regla de negocio establecdirecciona Mensaje de error
500 No se pudo crear el objeto Ubicacion Mensaje de error

PUT /Ubicacion/{direccion}

Es el encargado de actualizar objetos Ubicacion.

Parámetros

Nombre Ubicación Descripción Requerdirecciono Esquema
direccion Path direccion del objeto Ubicacion a actualizar String
body body Objeto Ubicacion nuevo Representación Detail

Respuesta

Código Descripción Cuerpo
201 El objeto Ubicacion actualizado Representación Detail
412 business exception, no existe una Ubicacion con la direccion especificada Mensaje de error
500 No se pudo actualizar el objeto Ubicacion Mensaje de error

DELETE /Ubicacions/{direccion}

Elimina un objeto Ubicacion.

Parámetros

Nombre Ubicación Descripción Requerdirecciono Esquema
direccion Path direccion del objeto Ubicacion a eliminar String

Respuesta

Código Descripción Cuerpo
204 Objeto eliminado N/A
500 Error interno Mensaje de error
404 El objeto a eliminar no existe Mensaje de error

About

Repositorio del proyecto de puntos de fidelidad del grupo 5 de la sección 1

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 64.9%
  • HTML 16.4%
  • JavaScript 15.7%
  • CSS 3.0%