#Tabla de contenidos

• Introducción
• API
• Entidad Category
• Entidad Education
• Entidad Freelancer
• Entidad Project
• Entidad ProjectSponsor
• Entidad Skill
• Entidad Status

#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 /MPFreelancer.api/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 MPFreelancer ###Entidad Category ####CRUD Básico En la siguiente tabla se detalla los servicios REST generados para la entidad Category, la estructura del objeto que intercambian y sus respectivas funciones.

#####Estructura de objeto Category

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

#####Servicios

####Maestros Detalle de Category #####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 Category son los siguientes:

######Relaciones Shared

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

#####Estructura de objeto Education

{
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    startDate: '' /*Tipo Date*/,
    endDate: '' /*Tipo Date*/,
    institution: '' /*Tipo String*/,
    title: '' /*Tipo String*/,
    description: '' /*Tipo String*/
}

#####Servicios

Volver arriba

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

#####Estructura de objeto Freelancer

{
    id: '' /*Tipo Long*/,
    name: '' /*Tipo String*/,
    rate: '' /*Tipo Integer*/,
    bithday: '' /*Tipo Date*/,
    picture: '' /*Tipo String*/
}

#####Servicios

####Maestros Detalle de Freelancer #####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 Freelancer son los siguientes:

######Relaciones Composite

######Relaciones Shared

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

#####Estructura de objeto Project

{
    id: '' /*Tipo Long*/,
    price: '' /*Tipo Integer*/,
    deadLine: '' /*Tipo Date*/,
    status: '' /*Objeto que representa instancia de Status*/,
    name: '' /*Tipo String*/,
    category: '' /*Objeto que representa instancia de Category*/,
    sponsor: '' /*Objeto que representa instancia de ProjectSponsor*/,
    description: '' /*Tipo String*/,
    publicationDate: '' /*Tipo Date*/,
    startDate: '' /*Tipo Date*/
}

#####Servicios

####Maestros Detalle de Project #####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 Project son los siguientes:

######Relaciones Shared

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

#####Estructura de objeto ProjectSponsor

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

#####Servicios

####Maestros Detalle de ProjectSponsor #####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 ProjectSponsor son los siguientes:

######Relaciones Shared

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

#####Estructura de objeto Skill

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

#####Servicios

####Maestros Detalle de Skill #####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 Skill son los siguientes:

######Relaciones Shared

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

#####Estructura de objeto Status

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

#####Servicios

####Maestros Detalle de Status #####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 Status son los siguientes:

######Relaciones Shared