#Tabla de contenidos

• Introducción
• API
• Entidad Album
• Entidad CartItem
• Entidad Client
• Entidad LongPlay
• 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 /MusicStore.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 MusicStore ###Entidad Album ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad Album, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto Album

{
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    cover: '' /*Tipo String*/,
    release: '' /*Tipo Date*/,
    single: '' /*Tipo Boolean*/,
    artist: '' /*Tipo String*/
}

#####Servicios

Volver arriba

###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

{
    id: '' /*Tipo Long*/,
    quantity: '' /*Tipo Integer*/,
    longPlay: '' /*Objeto que representa instancia de LongPlay*/,
    name: '' /*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 LongPlay ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad LongPlay, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto LongPlay

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

#####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