#Tabla de contenidos

• Introducción
• API
• Entidad CartItem
• Entidad CellPhone
• Entidad Client
• Entidad Product
• Entidad Provider

#API Rest ##Introducción La comunicación entre cliente y servidor se realiza intercambiando objetos JSON. Para cada entidad se hace un mapeo a JSON, donde cada uno de sus atributos se transforma en una propiedad de un objeto JSON. Todos los servicios se generan en la URL /mpcellphone.web/webresources/. Por defecto, todas las entidades tienen un atributo id, con el cual se identifica cada registro:

{
    id: '',
    attribute_1: '',
    attribute_2: '',
    ...
    attribute_n: ''
}

###CRUD Básico Para los servicios de CRUD Básico, Cuando se transmite información sobre un registro específico, se realiza enviando un objeto con la estructura mencionada en la sección anterior. La única excepción se presenta al solicitar al servidor una lista de los registros en la base de datos, que incluye información adicional para manejar paginación de lado del servidor.

La respuesta del servidor al solicitar una colección presenta el siguiente formato:

{
    totalRecords: 0, //cantidad de registros en la base de datos
    records: [] //collección con los datos solicitados. cada objeto tiene la estructura de la entidad.
}

##API de la aplicación mpcellphone ###Entidad CartItem ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad CartItem, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto CartItem

{
    quantity: '' /*Tipo Integer*/,
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    product: '' /*Objeto que representa instancia de Product*/
}

#####Servicios

Volver arriba

###Entidad CellPhone ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad CellPhone, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto CellPhone

{
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    description: '' /*Tipo String*/,
    model: '' /*Tipo String*/,
    imei: '' /*Tipo String*/,
    brand: '' /*Tipo String*/,
    image: '' /*Tipo String*/
}

#####Servicios

Volver arriba

###Entidad Client ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad Client, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto Client

{
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    userId: '' /*Tipo String*/
}

#####Servicios

####Maestros Detalle de Client #####Servicios A diferencia del API para CRUD Básico, el API de Maestro/Detalle no provee un servicio para listar los registros de la entidad maestra. Los servicios generados para el componente Maestro/Detalle de Client son los siguientes:

######Relaciones Composite

Volver arriba

###Entidad Product ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad Product, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto Product

{
    cellPhone: '' /*Objeto que representa instancia de CellPhone*/,
    name: '' /*Tipo String*/,
    id: '' /*Tipo Long*/,
    price: '' /*Tipo Integer*/
}

#####Servicios

Volver arriba

###Entidad Provider ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad Provider, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto Provider

{
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    userId: '' /*Tipo String*/
}

#####Servicios

####Maestros Detalle de Provider #####Servicios A diferencia del API para CRUD Básico, el API de Maestro/Detalle no provee un servicio para listar los registros de la entidad maestra. Los servicios generados para el componente Maestro/Detalle de Provider son los siguientes:

######Relaciones Composite

Volver arriba