...
| Proceso | Servicio | Tipo de llamado | Campos de búsqueda | Campos de datos únicos |
|---|---|---|---|---|
| Creación de Nivel de Colegio | collegeLevelCycle | POST | colegio_nivel_ciclo_id, clave | colegio_nivel_ciclo_id, clave, crm_id, erp_id |
| Descripción de campos | ||||
| Campo | Tipo | Longitud | Valor por defecto | Observaciones |
| colegio_nivel_ciclo_id | int | 11 | 0 | En el llamado POST, siempre debe ir en cero. |
| colegio_id | int | 11 | ID del colegio | Campo requerido en el llamado POST, se debe indicar el id del colegio al que se le crea el nivel escolar |
| erp_id | varchar | 35 | Definido por negocio | Clave o código identificador del colegio en el ERP |
| crm_id | varchar | 100 | Valor del CRM | Es el indicador único del nivel del colegio en el CRM |
| empresa_id | int | 11 | ID de la empresa | Identificador de la empresa en la que se crea el nivel |
| nivel_id | int | 11 | ID del nivel | Los niveles se crean por país y aplican a todos los colegios |
| ciclo_escolar_id | int | 11 | ID del ciclo escolar | Identificador único del ciclo escolar; los ciclos escolares pueden variar en las empresas de cada país |
| clave | varchar | 50 | Definido por negocio | Clave otorgada por negocio al nivel del colegio |
| clave_oficial | varchar | 100 | Definida por negocio | Es la clave otorgada por los ministerios de educación a cada nivel escolar de los colegios. |
...
- erp_id (sap_id): Actualiza sólo si viene información en el tag, de venir en blanco deja el campo tal y como está.
- crm_id : Actualiza sólo si viene algo en el tag, de venir en blanco deja el campo tal y como está.
- clave_oficial: Identificador Oficial del nivel
- fecha_adopcion: Fecha en la que se agrega el nivel al colegio.
- observaciones: Este campo puede ser utilizado para información adicional del nivel.
- activo: Estatus del nivel.
- idioma y zona_horaria.
- baja: La baja del colegio sólo se dará al contener una razon_baja.
Para poder llevar acabo crear el contrato de un colegio, primero se deberá realizar previo el alta de artículos en BDC.
El servicio articuloGradoPeriodoPrecio permite dar de alta y clasificar Artículos, de acuerdo a la necesidad del negocio este servicio cuenta con llamado POST Y PUT.. Este servicio puede ser llamado por el método POST y PUT. Un artículo es considerado único en BBDD por los siguientes campos: articulo_id, articulo_clave_clave y erp_id (sap_id); tanto en la creación cómo como en la modificación, estos datos son considerados para una la búsqueda del artículo.
- articulo_id: En un llamado POST el dato deberá ir en 0, cómo respuesta tendremos su ID correspondiente en BDC el cual deberá sustituir al 0 en un llamado PUT.
- articulo_clave: Identificador único el cual deberá tener una longitud de 50 caracteres como máximo, este será definido por el negocio.
- erp_id: Este campo no es obligatorio, sin embargo si se cuenta con la información del id del sistema que se integra ya sea ERP, SAP es posible utilizar este tag para almacenamiento y tener el id único del nivel de su base de datos.
...
- existe integración hacia alguno de los ERP's del grupo (SAP, NAVISION, EMS), este dato es el que identifica al artículo en el ERP unívocamente.
Los artículos que funcionan como agrupadores de paquetes por grado, deberán de enviar como parametro y tipo_articulo_parametro SUBP-G; aunque no es un elemento obligatorio este dato debe ser informado para ser utilizado como un agrupador.En caso de ser necesario para el negocio este servicio realiza configuración de
| Proceso | Servicio | Tipo de Llamado | Campos de Búsqueda | Campos de Datos Únicos |
|---|---|---|---|---|
| Creación de artículo | articuloGradoPeriodoPrecio | POST | articulo_id, articulo_clave, erp_id | |
| Descripción de campos | ||||
| Campo | Tipo | Longitud | Valor por Defecto | Observaciones |
| articulo_id | ||||
| empresa_id | ||||
| articulo_clave | ||||
| articulo | ||||
| erp_id | ||||
Con este servicio se realiza la configuración de la lista de precios y la configuración del articulo por grado y periodo esto para una configuración base tomada en cuenta para . Esta configuración se toma como base para la selección de artículos por Nivel y Grado en los contratos.
Una vez cargado el catálogo de artículos y su clasificación será posible llevar acabo realizar la creación del contrato por colegio en el servicio contract el cual cuenta con llamado POST Y del colegio, a través del servicio contract. Al igual que los demás servicios, éste cuenta con llamados POST y PUT. El contrato es considerado único en BBDD por los siguientes campos: contrato_id, colegio_id, empresa_id y ciclo_escolar_id tanto en la creación cómo en la modificación estos datos son considerados para una búsqueda de un contrato que aún no esté liberado o validado; si el contrato ya cuenta con este estatus ya no podrá ser modificado y no podrá insertar un registro nuevo con los mismos datos.
...