Servicio Colegio

Estado

En Uso

Cuando un requisito de sistema software tenga el estado En Uso significa que está disponible para su uso.

Este servicio permite dar de alta colegios desde un sistema externo (ERP, CRM o manualmente) en la BDC de la plataforma

Situación actual

Descripción

Permite crear y modificar colegios

Referencia

/wiki/spaces/SSB/pages/51905947, WebServices

Entidad BDC

Nombre de la entidad o entidades involucradas

Backend

https://homol.uno-internacional.com/source/ws/uno_wsx_colegio_im.php

Tipo de Petición

POST

Parámetros

Campos en Payload	Descripción	Reglas de negocio
accion	i para indicar que se crea una entidad, m para modificar una entidad Obligatorio	Cuando se desea crear una entidad el valor de colegio_id debe ser 0. Cuando se desea modificar una entidad de colegio, el valor de colegio_id debe ser mayor que 0. En caso de ser colegio_id no válido el servicio entrega el siguiente mensaje: <code>400</code> <message>El parámetro 'colegio_id' es requerido.</message>
p	IP de la máquina desde la que se consume el servicio Obligatorio	Es un forward de los datos recibidos por el servicio de login Servicio Login: /source/ws/uno_ws_login.php
t	Token de sesión Obligatorio	El token de sesión se obtiene mediante el servicio de login Tiene una duración de 8 horas
servicio	Nombre del servicio, se deberá enviar censo Obligatorio	Nombre del servicio a utilizar de acuerdo a WSDL Import
colegio_id	Identificador único del colegio en BDC Obligatorio	El ID del colegio debe ser mayor a 0, en el caso de crear una entidad de Colegio el valor enviado deberá ser 0.
erp_id	Identificador único del colegio en ERP (EMS, SAP, ETC) Opcional
crm_id	Identificador único del colegio en CRM Opcional
pais_id	Identificador del país al que pertenece el colegio Obligatorio	Los identificadores están definidos en Maestros → pais_csv
colegio_clave	Identificador único del colegio o el equivalente al erp_id Obligatorio	La clave es utilizada para localizar de forma rápida al Colegio en búsquedas
colegio	Nombre del colegio Obligatorio	Los caracteres especiales deben ser escapados de acuerdo a XML Scape Characters
colegio_orden	Orden de listado en los filtros Opcional	Número > 0
alias	Alias del colegio Opcional	En algunos casos el colegio es mejor conocido por un nombre corto o un nombre diferente.
idioma_id	Identificador del idioma de acuerdo al país al que pertenece el colegio Obligatorio	Los valores admitidos son los especificados en Maestros → idioma.xlsx
zona_horaria_id	Identificador de la zona horaria de acuerdo al país al que pertenece el colegio Obligatorio	Los valores admitidos son los especificados en Maestros → zona_horaria.xlsx
demo	Indica si el colegio es de pruebas Opcional	Los colegios demo son utilizados para pruebas o formación Los valores admitidos son 0 y 1
baja	Indica si el colegio fue dado de baja dentro de la organización. Opcional	Los valores admitidos son 0 y 1
razon_baja_parametro	Cuando un colegio es dado de baja se debe indicar la razón Opcional
insertar_niveles	Indica si al crear la entidad de colegio se crearan los colegios nivel ciclo Opcional	Los valores admitidos son 0 y 1 Por defecto se crean todos los niveles asociados al país al que pertenece el colegio
empresa_id	ID de la empresa a la que pertenece el colegio Opcional	El parámetro es requerido cuando se indica que se insertan los niveles. Los valores admitidos son los especificados en Maestros → empresa_pre.csv
ciclo_escolar_clave	Específica el ciclo escolar en el que se crearan los niveles del colegio Opcional	El parámetro es requerido cuando se indica que se insertan los niveles. Los valores admitidos son los especificados en Maestros → ciclo_escolar.xlsx
Domicilios	Agrupados de grupo de domicilios
Domicilio	Agrupador de domicilio
domicilio_id	Identificador único de domicilio Obligatorio	Cuando se desea crear un domicilio el valor deberá ser 0 Cuando se modifica un domicilio el valor deberá ser > 0
erp_id	Identificador del domicilio en ERP opcional
crm_id	Identificador del domicilio en CRM Opcional
principal	Indica que es el domicilio principal del colegio Obligatorio	Los valores admitidos son 0 y 1
fiscal	Indica que es el domicilio fiscal del colegio Obligatorio	Los valores admitidos son 0 y 1
entrega	Indica que es el domicilio de entregas (paquetería) del colegio Obligatorio	Los valores admitidos son 0 y 1
calle	Nombre de la calle Obligatorio
numero_exterior	Número exterior del domicilio Opcional
numero_interior	Número interior del domicilio Opcional
colonia	Nombre de la colonia Opcional
ciudad	Nombre de la ciudad Opcional
codigo_postal	Código Postal Opcional
municipio_id	Identificador único del municipio Opcional	Los valores admitidos son los especificados en Maestros → municipios_localidades.xlsx
municipio_clave	Clave única del municipio Opcional	Los valores admitidos son los especificados en Maestros → municipios_localidades.xlsx
telefono_1	Teléfono de contacto Opcional
telefono_2	Teléfono de contacto Opcional
telefono_3	Teléfono de contacto Opcional
contacto	Nombre de la persona de contacto Opcional
cargo	Cargo de la persona de contacto Opcional
email	Correo electrónico de la persona de contacto Opcional
horario_atencion	Horario de contacto Opcional
idioma_id	Identificador del idioma de acuerdo al país al que pertenece el colegio Obligatorio	Los valores admitidos son los especificados en Maestros → idioma.xlsx
zona_horaria_id	Identificador de la zona horaria de acuerdo al país al que pertenece el colegio Obligatorio	Los valores admitidos son los especificados en Maestros → zona_horaria.xlsx
activo	Indica si el domicilio se encuentra activo Opcional

XSD del servicio

Payload

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified">
	<xs:annotation>
		<xs:appinfo></xs:appinfo>
		<xs:documentation>Ver documentación en Confluence</xs:documentation>
	</xs:annotation>
	<xs:element name="colegio_im">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="Accion">
					<xs:complexType>
						<xs:sequence>
							<xs:element type="xs:string" name="accion"/>
							<xs:element type="xs:string" name="p"/>
							<xs:element type="xs:string" name="t"/>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="Colegio">
					<xs:complexType>
						<xs:sequence>
							<xs:element type="xs:int" name="colegio_id"/>
							<xs:element type="xs:string" name="erp_id" minOccurs="0"/>
							<xs:element type="xs:string" name="crm_id" minOccurs="0"/>
							<xs:element type="xs:int" name="pais_id"/>
							<xs:element type="xs:string" name="colegio_clave"/>
							<xs:element type="xs:string" name="colegio"/>
							<xs:element type="xs:int" name="colegio_orden"/>
							<xs:element type="xs:string" name="alias" minOccurs="0"/>
							<xs:element type="xs:int" name="idioma_id"/>
							<xs:element type="xs:int" name="zona_horaria_id"/>
							<xs:element type="xs:int" name="demo" minOccurs="0"/>
							<xs:element type="xs:int" name="baja" minOccurs="0"/>
							<xs:element type="xs:string" name="razon_baja_parametro" minOccurs="0"/>
							<xs:element type="xs:int" name="insertar_niveles" minOccurs="0"/>
							<xs:element type="xs:int" name="activar_niveles" minOccurs="0"/>
							<xs:element type="xs:int" name="empresa_id" minOccurs="0"/>
							<xs:element type="xs:string" name="ciclo_escolar_clave" minOccurs="0"/>
							<xs:element name="Domicilios">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="Domicilio">
											<xs:complexType>
												<xs:sequence>
													<xs:element type="xs:int" name="domicilio_id"/>
													<xs:element type="xs:string" name="erp_id" minOccurs="0"/>
													<xs:element type="xs:string" name="crm_id" minOccurs="0"/>
													<xs:element type="xs:int" name="principal"/>
													<xs:element type="xs:int" name="fiscal"/>
													<xs:element type="xs:int" name="entrega"/>
													<xs:element type="xs:string" name="calle"/>
													<xs:element type="xs:string" name="numero_exterior" minOccurs="0"/>
													<xs:element type="xs:string" name="numero_interior" minOccurs="0"/>
													<xs:element type="xs:string" name="colonia" minOccurs="0"/>
													<xs:element type="xs:string" name="ciudad" minOccurs="0"/>
													<xs:element type="xs:string" name="codigo_postal" minOccurs="0"/>
													<xs:element type="xs:int" name="municipio_id" minOccurs="0"/>
													<xs:element type="xs:string" name="municipio_clave"/>
													<xs:element type="xs:string" name="telefono_1" minOccurs="0"/>
													<xs:element type="xs:string" name="telefono_2" minOccurs="0"/>
													<xs:element type="xs:string" name="contacto" minOccurs="0"/>
													<xs:element type="xs:string" name="cargo" minOccurs="0"/>
													<xs:element type="xs:string" name="email" minOccurs="0"/>
													<xs:element type="xs:string" name="horario_atencion" minOccurs="0"/>
													<xs:element type="xs:int" name="idioma_id"/>
													<xs:element type="xs:int" name="zona_horaria_id"/>
													<xs:element type="xs:int" name="activo"/>
												</xs:sequence>
											</xs:complexType>
										</xs:element>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

Respuesta

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="colegio_im_resultado "
	attributeFormDefault="unqualified"
	elementFormDefault="qualified"
	targetNamespace="http://www.sistemauno.com/source/xml"
	xmlns:xs="http://www.w3.org/2001/XMLSchema">
	
	<xs:element name="colegio_im_resultado ">
		<xs:complexType>
			<xs:sequence>

				<xs:element name="OK" minOccurs="0" >
					<xs:complexType>
						<xs:sequence>
							<xs:element name="colegio_id" type="xs:integer" minOccurs="0"/>
							<xs:element name="erp_id" type="xs:string" minOccurs="0" />
							<xs:element name="crm_id" type="xs:string" minOccurs="0" />
							<xs:element name="ok_text" type="xs:string" minOccurs="0" />
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				
				<xs:element name="error" minOccurs="0" >
					<xs:complexType>
						<xs:sequence>
							<xs:element name="error_code" type="xs:string" minOccurs="0" />
							<xs:element name="error_text" type="xs:string" minOccurs="0" />
						</xs:sequence>
					</xs:complexType>
				</xs:element>

			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

Ejemplo de llamada o de formulario

Servicio WSDL Import: /source/ws/uno_ws_import.wsdl

Payload

<?xml version="1.0" encoding="UTF-8"?>
<colegio_im xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Accion>
        <accion>i</accion>
        <t>{token}</t>
        <p>{ip}</p>
        <service>censo</service>
    </Accion>
    <Colegio>
        <colegio_id>0</colegio_id>
        <pais_id>44</pais_id>
        <colegio_clave>SSB-BR-1001</colegio_clave>
        <colegio>Colegio prueba SSB</colegio>
        <nombre_oficial>Colegio prueba SSB</nombre_oficial>
		<ciclo_escolar_clave>2016</ciclo_escolar_clave>
        <telefono_1>25262322</telefono_1>
        <email>tania@consucorp</email>
        <idioma_id>17</idioma_id>
        <zona_horaria_id>28</zona_horaria_id>
        <insertar_niveles>1</insertar_niveles>
        <empresa_id>10</empresa_id>
        <demo>1</demo>
        <Domicilios>
            <Domicilio>
                <domicilio_id>0</domicilio_id>
                <erp_id>126614-JAPAO</erp_id>
                <crm_id/>
                <principal>1</principal>
                <fiscal>1</fiscal>
                <entrega>1</entrega>
                <calle>RUA PADRE ADELINO, 758</calle>
                <numero_exterior/>
                <numero_interior/>
                <colonia>BELENZINHO</colonia>
                <ciudad>SAO PAULO</ciudad>
                <codigo_postal>03303-904</codigo_postal>
                <municipio_clave></municipio_clave>
                <municipio_id>16585</municipio_id>
                <contacto/>
                <telefono_1/>
                <telefono_2/>
                <cargo/>
                <horario_atencion/>
                <email/>
                <zona_horaria_id>28</zona_horaria_id>
                <idioma_id>17</idioma_id>
                <activo>0</activo>
            </Domicilio>
        </Domicilios>
    </Colegio>
</colegio_im>

Respuesta

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<colegio_im_resultado xmlns="http://www.sistemauno.com/source/xml">
	<OK>
		<colegio_id>7507</colegio_id>
		<erp_id></erp_id>
		<crm_id>551325</crm_id>
		<ok_text>Transacción exitosa: i</ok_text>
	</OK>
</colegio_im_resultado>

¿Quién lo utiliza y cómo?

El ERP de Brasil para gestionar los colegios con contratos