Servicios para aplicaciones del Departamento de Educación (servicio para aplicaciones del departamento de Educación.WebHome)

1.1

1

\\

2

= SERVICIO DE USUARIOS =

== Objetivos ==

Proporcionar acceso a los datos de usuario a otras aplicaciones internas del Departamento de Educación.

11

12

//URL WSDL: [[https:~~/~~/educages.navarra.es/Educa/services/usr/USRWS?wsdl>>https://educages.navarra.es/Educa/services/usr/USRWS?wsdl]]//

13

14

== Bloqueos de acceso por orden judicial ==

15

16

En determinadas ocasiones, y por orden judicial, se bloquea el acceso de padres, madres o tutores a los datos de sus hijos e hijas.

17

Para poder comprobar esto, se define el método "getUsuariosBloqueados" al que se le pasa como parámetro el nombre del usuario del que queremos comprobar si puede acceder a datos de otros usuarios.

18

Devuelve un listado de usuarios y sede a las que no puede acceder.

19

20

**Parámetros de entrada**

21

22

23

getUsuariosBloqueados(String usuario)

**Datos de salida**

List<DataSingleDTO>

Donde:

id es el id de la sede

34

valor es el nombre del usuario al que no puede acceder

35

36

**Parámetros de entrada**

37

38

39

<usr:getUsuariosBloqueados>

40

<usuario>userName</usuario>

41

</usr:getUsuariosBloqueados>

**Ejemplo de uso**

{{code language="xml"}} <ns2:getDatosPersonalesResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

46

47

48

<valor>userName2</valor>

49

</return>

50

</ns2:getDatosPersonalesResponse>{{/code}}

51

52

== Datos personales ==

53

54

=== A partir de un número de documento (DNI, Pasaporte...) ===

55

56

Devuelve los datos personales de un usuario a partir de un tipo de documento y su número.

57

58

Los tipos de documento válidos son:

* 1.- DNI

* 2.- Pasaporte

* 3.- NIE

* 6.- DNI sin letra

**Parámetros de entrada**

66

67

68

getDatosPersonales(int iDocumentoTipo, String txDocumentoNumero)

**Datos de salida**

GNRDatosPersonalesDTO

**Definición SOAP**

<usr:getDatosPersonales>

81

82

83

</usr:getDatosPersonales>

**Ejemplo de uso**

<ns2:getDatosPersonalesResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

90

91

<apellido1>Martínez</apellido1>

92

<apellido2>Etxeberria</apellido2>

</datosContacto>

<valor>sucorreo@proveedor.com</valor>

</datosContacto>

<valor>otrocorreo@educacion.navarra.es</valor>

</datosContacto>

<nombre>Mariano</nombre>

110

111

112

<calleEs>Calle Rue del Percebe</calleEs>

113

<calleEu>Rue del Percebe Kalea</calleEu>

<localidadEs>Pamplona</localidadEs>

121

<localidadEu>Iruña</localidadEu>

122

123

124

</ubicacionDomicilio>

125

<usuario>mmartin32</usuario>

126

</return>

127

</ns2:getDatosPersonalesResponse>

=== A partir del identificador único de persona ===

132

133

Devuelve los datos personales de un usuario

134

135

**Parámetros de entrada**

136

137

138

getDatosPersonales(int iDocumentoTipo, String txDocumentoNumero)

**Datos de salida**

GNRDatosPersonalesDTO

**Definición SOAP**

<usr:getDatosPersonalesPorLocalizador>

151

152

</usr:getDatosPersonalesPorLocalizador>

**Ejemplo de uso**

<ns2:getDatosPersonalesResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

159

160

<apellido1>Martínez</apellido1>

161

<apellido2>Etxeberria</apellido2>

</datosContacto>

<valor>sucorreo@proveedor.com</valor>

</datosContacto>

<valor>otrocorreo@educacion.navarra.es</valor>

</datosContacto>

<nombre>Mariano</nombre>

179

180

181

<calleEs>Calle Rue del Percebe</calleEs>

182

<calleEu>Rue del Percebe Kalea</calleEu>

<localidadEs>Pamplona</localidadEs>

190

<localidadEu>Iruña</localidadEu>

191

192

193

</ubicacionDomicilio>

194

<usuario>mmartin32</usuario>

195

</return>

196

</ns2:getDatosPersonalesResponse>

== Datos profesionales ==

201

202

Devuelve los datos profesionales

203

La entrada es por número de documento, no tiene sentido para menores que no tienen documento de identidad.

204

205

206

**Parámetros de entrada**

207

208

209

getDatosProfesionales(int iDocumentoTipo, String txDocumentoNumero)

**Datos de salida**

USRDatosProfesionalesDTO

**Definición SOAP**

<usr:getDatosProfesionales>

</usr:getDatosProfesionales>

**Ejemplo de uso**

<ns2:getDatosProfesionalesResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

<nombre>Inglés</nombre>

</especialidad>

<etapa>

<valor>Educación Básica (U.C.E.)</valor>

</etapa>

<etapa>

<valor>Educación Secundaria Obligatoria</valor>

</etapa>

<nombre>Coordinador EOIDNA</nombre>

</puesto>

<sede>

<valor>Pedro de Ursua</valor>

258

</sede>

259

</return>

260

</ns2:getDatosProfesionalesResponse>

== Contexto del usuario ==

265

266

Para los profesores: Devuelve los datos asociados a los puestos de trabajo en las distintas sedes

267

Alumnos: Datos a sociados a las matrículas en las distintas sedes.

268

Otos datos de otros puestos de trabajo.

269

270

271

**Parámetros de entrada**

272

273

{{code language="java"}}getContextoUsuario(String usuario, String idioma){{/code}}

274

usuario es el nombre de usuario de educa (nombreUsuarioUnico)

**Datos de salida**

USRContextoUsuarioDTO

**Definición SOAP**

{{code language="xml"}} <usr:getContextoUsuario>

284

<usuario>pmartine238</usuario>

285

286

</usr:getContextoUsuario>{{/code}}

**Ejemplo de uso**

Un profesor normal

{{code language="xml"}} <ns2:getContextoUsuarioResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

<cargo>

<nombre>Coordinador EOIDNA</nombre>

</cargo>

<nombre>Profesor/a</nombre>

302

</profesor>

303

</return>

304

</ns2:getContextoUsuarioResponse>{{/code}}

305

306

Un director que además es jefe de estudios

307

{{code language="xml"}} <ns2:getContextoUsuarioResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

<cargo>

<nombre>Jefe de Estudios</nombre>

</cargo>

<cargo>

<nombre>Director</nombre>

</cargo>

<nombre>Profesor/a</nombre>

324

</profesor>

325

</return>

326

</ns2:getContextoUsuarioResponse>{{/code}}

327

328

Un alumno con varias matrículas

329

{{code languaje="xml"}} <ns2:getContextoUsuarioResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

<modalidad>Única 4ESO</modalidad>

</matricula>

<curso>Nivel Intermedio</curso>

<modalidad>Inglés</modalidad>

</matricula>

<curso>2º Nivel avanzado</curso>

<modalidad>Euskera</modalidad>

</matricula>

</return>

</ns2:getContextoUsuarioResponse>{{/code}}

368

369

== Contexto del usuario para la mensajería interna ==

370

371

Extiende los datos mostrados por el método 'getContextoUsuario' para su uso delsde el cliente de mensajería 'RoundCube'.

372

Proporciona el DTO 'USRContextoUsuarioMSGDTO' que añade los campos al USRContextoUsuarioDTO:

373

protected boolean puedeCambiarCE; //True si puede cambiar el curso escolar en la generación de las libretas

374

protected int idCursoEscolar; //Curso escolar actual

375

protected List<String> libretas; //Nombres de las libretas que puede cambiar//

376

377

**Parámetros de entrada**

378

379

{{code language="java"}}getContextoUsuarioMSG(String usuario, String idioma){{/code}}

380

usuario es el nombre de usuario de educa (nombreUsuarioUnico)

**Datos de salida**

USRContextoUsuarioMSGDTO

**Definición SOAP**

{{code language="xml"}} <usr:getContextoUsuarioMSG>

390

<usuario>pmartine238</usuario>

391

392

</usr:getContextoUsuario>{{/code}}

**Ejemplo de uso**

Un profesor normal

{{code language="xml"}} <ns2:getContextoUsuarioMSGResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

<cargo>

<nombre>Coordinador EOIDNA</nombre>

</cargo>

<nombre>Profesor/a</nombre>

408

</profesor>

409

410

<libretas>libretaAlumnado</libretas>

411

<libretas>libretaCargosOrientacion</libretas>

412

<libretas>libretaPAS</libretas>

413

<libretas>libretaProfesorado</libretas>

414

<libretas>libretaRepresentantesLegales</libretas>

415

<libretas>libreta.sede.para-pas.1</libretas>

416

<libretas>libreta.sede.para-pas.1</libretas>

417

<libretas>libreta.sede.equipodirectivo.para-todos.1254</libretas>

418

<puedeCambiarCE>false</puedeCambiarCE>

419

</return>

420

</ns2:getContextoUsuarioMSGResponse>{{/code}}

421

422

== Usuarios bloqueados ==

423

424

Devuelve un listado con aquellos usuarios a cuyos datos el usuario pasado como argumento no uede acceder.

425

Puede haber sido bloqueado el acceso por orden judicial.

426

El id devuelto es el id de la sede a la que afecta el bloqueo.

427

El valor es el nombre de usuario a cuyos datos no se puede acceder.

428

429

430

**Parámetros de entrada**

431

432

{{code language="java"}}getUsuariosBloqueados(String usuarioQueQuiereAcceder){{/code}}

433

usuarioQueQuiereAccederes el nombre de usuario de educa (nombreUsuarioUnico)

**Datos de salida**

DataSingleDTO

**Definición SOAP**

{{code language="xml"}} <usr:getUsuariosBloqueados>

443

<usuario>nombreUsuario</usuario>

444

</usr:getUsuariosBloqueados>{{/code}}

445

**Ejemplo de uso**

446

{{code languaje="xml"}}<ns2:getUsuariosBloqueadosResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

447

448

449

<valor>otroNombreUsuario</valor>

450

</return>

451

</ns2:getUsuariosBloqueadosResponse>{{/code}}

== Listados de datos auxiliares ==

456

457

=== Tipos de puesto en la sede. Cargos. (CTRPuestoTipo) ===

458

459

**Parámetros de entrada**

460

461

462

getCTRPuestoTipos(boolean activo,String idioma)

**Datos de salida**

List<DataSingleDTO>

**Definición SOAP**

{{code language="xml"}} <usr:getCTRPuestoTipos>

474

475

476

</usr:getCTRPuestoTipos>{{/code}}

477

**Ejemplo de uso**

478

{{code languaje="xml"}} <ns2:getCTRPuestoTiposResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

</return>

<valor>General</valor>

</return>

<valor>Orientación</valor>

</return>

<valor>PAS - Administrativo</valor>

</return>

<valor>Jefe/Encargado de Calidad</valor>

</return>

<valor>APYMA</valor>

</return>

<valor>Director</valor>

</return>

<valor>Director Adjunto</valor>

</return>

<valor>Jefe de Estudios</valor>

</return>

<valor>Jefe de Estudios de Euskera</valor>

</return>

<valor>Jefe de Estudios Adjunto</valor>

</return>

<valor>Secretario</valor>

</return>

<valor>Administrador</valor>

</return>

<valor>Vicedirector</valor>

</return>

<valor>Coordinador de ciclo</valor>

</return>

<valor>Jefe de Departamento</valor>

</return>

<valor>Jefe de Departamento de Familia Profesional</valor>

</return>

<valor>Jefe de Estudios Nocturno</valor>

</return>

<valor>Jefe de Departamento de Actividades Profesionales Externas</valor>

</return>

<valor>Coordinador de ciclos formativos</valor>

</return>

<valor>Responsable Módulo Formación Centro de Trabajo</valor>

</return>

<valor>Coordinador de la Unidad de Apoyo Educativo</valor>

</return>

<valor>Encargado de comedor</valor>

</return>

<valor>Responsable de Nuevas Tecnologías</valor>

</return>

<valor>Encargado de actividades artístico-culturales</valor>

</return>

<valor>Encargado de actividades específicas</valor>

</return>

<valor>Coordinador de actividades deportivas</valor>

</return>

<valor>Coordinador de Biblioteca</valor>

</return>

<valor>Gestor Educa</valor>

</return>

<valor>Secretario adjunto</valor>

</return>

<valor>Coordinador EOIDNA</valor>

</return>

<valor>Coordinador EDUCA</valor>

606

</return>

607

</ns2:getCTRPuestoTiposResponse>{{/code}}

608

609

== Tipos de puesto de trabajo. (PRSPuestoSubTipo) ==

610

611

**Parámetros de entrada**

612

613

614

getPRSPuestoSubTipos(boolean activo,String idioma)

**Datos de salida**

List<DataSingleDTO>

**Definición SOAP**

{{code language="xml"}} <usr:getPRSPuestoSubtipos>

626

627

628

</usr:getPRSPuestoSubtipos>{{/code}}

629

**Ejemplo de uso**

630

631

<ns2:getPRSPuestoSubtiposResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

632

633

634

<valor>Profesor/a</valor>

</return>

<valor>Orientador/a</valor>

</return>

<valor>Subalterno/a</valor>

</return>

<valor>Servicios Generales</valor>

</return>

<valor>Mantenimiento</valor>

</return>

<valor>Limpiador/a</valor>

</return>

<valor>Jardinero/a</valor>

</return>

<valor>Oficial de Administración</valor>

</return>

<valor>Auxiliar Administración</valor>

</return>

<valor>Conserje</valor>

</return>

<valor>Cuidador/a</valor>

</return>

<valor>Comisión de Escolarización</valor>

</return>

<valor>Administrador</valor>

</return>

<valor>Inspector</valor>

</return>

<valor>Inspector Administrador</valor>

</return>

<valor>Gestor Evaluación Diagnóstica</valor>

</return>

<valor>Administrador sólo lectura</valor>

</return>

<valor>Censo 1</valor>

</return>

<valor>Censo 2</valor>

</return>

<valor>Gestor Libros de texto</valor>

</return>

<valor>Gestor FCT</valor>

</return>

<valor>Director Servicio</valor>

</return>

<valor>Auxiliar de inspección</valor>

</return>

<valor>Gestor Salud</valor>

</return>

<valor>Gestor Títulos</valor>

</return>

<valor>Estadísticas</valor>

</return>

<valor>Gestor PNTE</valor>

</return>

<valor>Incidencias GDP</valor>

</return>

<valor>Gestor validaciones</valor>

747

</return>

748

</ns2:getPRSPuestoSubtiposResponse>{{/code}}

== Cuerpos ==

Devuelve el listado de cuerpos a los que pueden pertenecer los profesores con su código

753

754

**Parámetros de entrada**

755

756

757

getCuerpos(String idioma)

**Datos de salida**

List<DataSingleDTO>

**Definición SOAP**

<usr:getCuerpos>

</usr:getCuerpos>{{/code}}

773

**Ejemplo de uso**

774

{{code languaje="xml"}} <ns2:getCuerposResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

775

776

777

<valor>Profesores de Artes Plásticas y Diseño</valor>

</return>

<valor>Profesores de Música y Artes Escénicas</valor>

</return>

<valor>Maestros</valor>

</return>

<valor>Inspectores de Educación</valor>

</return>

<valor>Maestros de Taller de Artes Plásticas y Diseño</valor>

</return>

<valor>NA-Profesores de Iniciación Musical</valor>

</return>

<valor>NA-Profesores de Religión</valor>

</return>

<valor>Profesores de Enseñanza Secundaria</valor>

</return>

<valor>Profesores Especialidades de I.T.E.M.</valor>

</return>

<valor>Profesores Técnicos de Formación Profesional</valor>

</return>

<valor>Profesores de Escuelas Oficiales de Idiomas</valor>

</return>

<valor>Catedráticos de Música y Artes Escénicas</valor>

822

</return>

823

</ns2:getCuerposResponse>{{/code}}

824

825

== Datos de contacto. tipos ==

826

827

Devuelve el listado de tipos de datos de contacto con su código

828

829

**Parámetros de entrada**

830

831

832

getDatosContactoTipos(String idioma)

**Datos de salida**

List<DataSingleDTO>

**Definición SOAP**

<usr:getDatosContactoTipos>

845

846

847

</usr:getDatosContactoTipos>{{/code}}

848

**Ejemplo de uso**

849

{{code languaje="xml"}} <ns2:getDatosContactoTiposResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

850

851

852

<valor>Teléfono particular 3</valor>

</return>

<valor>Teléfono particular 2</valor>

</return>

<valor>Teléfono particular</valor>

</return>

<valor>Email</valor>

</return>

<valor>Móvil 2</valor>

</return>

<valor>Móvil</valor>

</return>

</return>

<valor>Email Google (PNTEApps)</valor>

881

</return>

882

</ns2:getDatosContactoTiposResponse>{{/code}}

== Idiomas ==

Devuelve el listado de idiomas con su código que se utiliza en las respuestas.

887

Son idiomas correspondientes a las enseñanzas.

888

En la llamada a los métodos se utilizan los códigos "es" (Español) y "eu" (Euskera)

889

890

**Parámetros de entrada**

891

892

893

getIdiomas(String idioma)

**Datos de salida**

List<DataSingleDTO>

**Definición SOAP**

<usr:getIdiomas>

</usr:getIdiomas>{{/code}}

908

**Ejemplo de uso**

909

{{code languaje="xml"}} <ns2:getIdiomasResponse xmlns:ns2="http://usr.ws.educa.educacion.navarra.es/">

910

911

912

<valor>Inglés</valor>

</return>

<valor>Euskera</valor>

</return>

<valor>Castellano</valor>

</return>

<valor>Aleman</valor>

</return>

<valor>Francés</valor>

929

</return>

930

</ns2:getIdiomasResponse>{{/code}}

931

932

933

== Descripción de los objetos de transferencia de datos DTO empleados ==

934

935

=== GNRDatosPersonalesDTO ===

int idLocalizador;

String nombre;

String apellido1;

String apellido2;

String usuario;

int documentoTipo;

String documentoNumero;

945

Date fechaNacimiento;

String descripcion;

String sexo;

=== USRDatosProfesionalesDTO ===

951

952

953

int idLocalizador; // iIdGNRPersona

954

int perfil;

955

List<DataSingleDTO> sede; // Sedes en las que da clase

956

List<CTRDatoSedeIdiomaDTO> especialidad;

957

List<CTRDatoSedeDTO> puesto;

958

List<DataSingleDTO> etapa;

959

960

961

=== USRContextoUsuarioDTO ===

962

963

964

List<MatriculaContextoDTO> matricula;

965

List<CTRDatoSedeDTO> pas;

966

List<CTRDatoSedeDTO> profesor;

967

List<CTRDatoSedeDTO> cargo;

int idLocalizador;

=== USRContextoUsuarioMSGDTO ===

972

973

974

List<MatriculaContextoDTO> matricula;

975

List<CTRDatoSedeDTO> pas;

976

List<CTRDatoSedeDTO> profesor;

977

List<CTRDatoSedeDTO> cargo;

978

int idLocalizador;

979

boolean puedeCambiarCE;

980

int idCursoEscolar;

981

List<String> libretas;

982

983

984

=== DataSingleDTO ===

int id;

String valor;

=== CTRDatoSedeDTO ===

int id;

int idSede;

String nombre;

=== CTRDatoSedeIdiomaDTO ===

int id;

int idSede;

String nombre;

int idioma;

=== MatriculaContextoDTO ===

int idSede;

int idCurso;

String curso;

int idModeloLinguistico;

1015

String modeloLinguistico;

int idModalidad;

String modalidad;

Date fechaInicio;

Date fechaFin;

int idGrupo;

String grupo;

= EJEMPLOS DE CLIENTES SOAP =

== PHP ==

=== Ciente sin autentificar ===

<?php

$wsdl = "http://educa.navarra.es/Educa/services/ConsultaCentros?wsdl";

$params = array(

'sede' => '9',

'cursoEscolar' => 125,

'idioma' => 'es'

);

$client = new SoapClient($wsdl);

1041

1042

$response = $client->detalleCentro($params);

print_r($response);

?>

=== Ciente autentificado ===

1049

1050

En este caso necesitgamos pasar una cabecera con los datos de autentificación y el tipo.

1051

Para ello extenderemos la clase SoapHeader

1052

1053

{{code language="php"}}<?php

1054

/**

1055

* Extendemos la clase SoapHeader para crear una autenticación acorde con Wsse

1056

*/

1057

class WsseAuthHeader extends SoapHeader {

1058

1059

private $wss_ns = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd';

1060

1061

/**

1062

* Constructor de la cabecera

1063

* @param $user Nombre de usuario

1064

* @param $pass Contraseña del usuario

1065

* @param $ns Esquema alternativo para la definición de la seguridad. Por defecto (null), contraseña sin encruptar

1066

*/

1067

function __construct($user, $pass, $ns = null) {

if ($ns) {

$this->wss_ns = $ns;

}

$auth = new stdClass();

1073

$auth->Username = new SoapVar($user, XSD_STRING, NULL, $this->wss_ns, NULL, $this->wss_ns);

1074

//$auth->Password = new SoapVar($pass, XSD_STRING, "PasswordText", $this->wss_ns, NULL, $this->wss_ns);

1075

1076

$p = '<ns2:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">'.htmlspecialchars($pass)."</ns2:Password>";

1077

1078

$auth->Password = new SoapVar($p, XSD_ANYXML);

1079

1080

1081

$username_token = new stdClass();

1082

$username_token->UsernameToken = new SoapVar($auth, SOAP_ENC_OBJECT, NULL, $this->wss_ns, 'UsernameToken', $this->wss_ns);

1083

1084

$security_sv = new SoapVar(

1085

new SoapVar($username_token, SOAP_ENC_OBJECT, NULL, $this->wss_ns, 'UsernameToken', $this->wss_ns),

1086

SOAP_ENC_OBJECT, NULL, $this->wss_ns, 'Security', $this->wss_ns);

1087

parent::__construct($this->wss_ns, 'Security', $security_sv, true);

}

}

?>{{/code}}

Y el ejemplo de conexión quedaría así

1092

{{code language="php"}}<?php

1093

/* Ejemplo de uso de un cliente autentificado con contraseña plana*/

1094

1095

include "WsseAuthHeader.php";

1096

1097

//Definimos el nombre de usuario, contraseña y wsdl del servicio

1098

$username = 'el_nombre_de_usuario';

1099

$password = 'la_contraseña';

1100

$wsdl = "http://educa.navarra.es/Educa/services/usr/USRWS?wsdl"; //url a la definición del servicio (wsdl)

1101

1102

//Definimos la cabecera

1103

$wsse_header = new WsseAuthHeader($username, $password);

1104

$client = new SoapClient($wsdl, array("trace" => 1, "exception" => 0));

1105

$client->__setSoapHeaders(array($wsse_header));

1106

1107

//Parámetros del método llamado

1108

$params = array(

1109

'usuario' => 'usuario_buscado',

'idioma' => 'es'

);

//Llamada al método

$response = $client->getContextoUsuario($params);

print_r($response);

//Llamada alternativa

1118

$response = $client->__soapCall("getContextoUsuario",$params);

print_r($response);

?>{{/code}}

= SERVICIO DE PREVISIÓN DATOS DE ALUMNADO Y NÚMERO DE GRUPOS =

1124

1125

En este espacio se incluye la definición de los servicios web necesarios para resolver las necesidades de previsión de datos de alumnado y número de grupos.

== FASES ==

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)1.- Previsión inicial(%%)

1130

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)2.- Previsión Preinscripción(%%)

1131

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)3.- Previsión Matrícula Junio(%%)

1132

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)4.- Previsión Matrícula Septiembre(%%)

1133

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)5.- Matriculación Actual

1134

1135

== Método previsión número de alumnos ==

1136

1137

Se define el método "previsiónAlumnos" al que se le pasa como parámetro un lista de códigos MEC de centros y el curso escolar. Devuelve un objeto con la previsión del curso escolar.

1138

1139

**Parámetros de entrada**

1140

1141

1142

previsionAlumnos(List<Integer> codMEC, int cursoAcademico)

**Datos de salida**

MTRPrevisionCE

== Método previsión número de grupos de alumnos ==

1152

1153

Se define el método "previsiónGrupos" al que se le pasa como parámetro un lista de códigos MEC de centros y el curso escolar. Devuelve un objeto con la previsión del curso escolar.

1154

1155

**Parámetros de entrada**

1156

1157

1158

previsionGrupos(List<Integer> codMEC, int cursoAcademico)

**Datos de salida**

MTRPrevisionCE

== Más información: ==

1168

1169

* [[WSDL>>https://educages.navarra.es/Educa/services/mtr/PrevisionWS?wsdl]]

1170

* [[Documentación detallada>>http://educadev.educacion.navarra.es/api/MTRPrevision/]]

1171

1172

(((

1173

(% style="font-family: sans-serif; font-style: normal; text-align: start;" %)

1174

= (% style="font-size: 24.78px;" %)SERVICIO DE ENVÍO DE NOTIFICACIONES(%%) =

1175

1176

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1177

En este espacio se incluye la definición del servicio web necesario para la creación y envío de notificaciones de aplicaciones externas (servicios) a través de la plataforma Educa.

1178

1179

(% style="font-family: sans-serif; font-style: normal; text-align: start;" %)

1180

== Método de generación de SMS ==

1181

1182

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1183

Se define el método "enviarSMS" al que se le pasa como parámetro un lista de notificaciones a generar. Las notificaciones son objetos que contienen uno o más destinatarios de la notificación, el mensaje que se desea entregar, una referencia externa y el nombre del servicio que solicita la notificación. Devuelve una lista de objetos con la información de cada SMS generado (destinatario, identificador del mensaje en Educa, referencia externa y servicio solicitante).

1184

1185

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1186

(% style="font-size: 14px; font-weight: 700;" %)Parámetros de entrada

1187

1188

1189

enviarSMS(List<GNRMSGMensajeDTO> notificaciones)

1190

1191

1192

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1193

(% style="font-size: 14px; font-weight: 700;" %)Datos de salida

1194

1195

1196

List<GNRMSGMensajeCreadoDTO>

1197

1198

1199

(% style="font-family: sans-serif; font-style: normal; text-align: start;" %)

1200

== (% style="font-size: 22.54px;" %)Método de consulta del estado los SMS generados (%%) ==

1201

1202

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1203

Se define el método "consultarEstadoSMS" que consulta el estado de envío y entrega de los SMS generados. Para realizar la consulta hay que indicar el servicio que ha generado las notificaciones y se pueden pasar como parámetros una lista de destinatarios, una lista de referencias externas, una fecha de creación a partir de la cuál se quiere consultar y una fecha de creación máxima hasta la que se quiere consultar. Devuelve una lista de objetos con el detalle, incluyendo la información de envío y entrega, de cada SMS filtrado por los parámetros de entrada.

1204

1205

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1206

(% style="font-size: 14px; font-weight: 700;" %)Parámetros de entrada

1207

1208

1209

consultarEstadoSMS(List<String> destino, List<String> refExternas, Date fechaInicial, Date fechaFinal, String servicio)

1210

1211

1212

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1213

(% style="font-size: 14px; font-weight: 700;" %)Datos de salida

1214

1215

1216

List<GNRMSGNotificacionDetalleDTO>

1217

1218

1219

(% style="font-family: sans-serif; font-style: normal; text-align: start;" %)

1220

== (% style="font-size: 22.54px;" %)Método de búsqueda de un SMS generado(%%) ==

1221

1222

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1223

Se define el método "buscarSMS" al que se le pasa como parámetro el identificador del SMS generado por Educa y devuelve (% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)el detalle del SMS, incluyendo la información de envío y entrega(%%).

1224

1225

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1226

(% style="font-size: 14px; font-weight: 700;" %)Parámetros de entrada

1227

1228

1229

buscarSMS(String idMensaje)

1230

1231

1232

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1233

(% style="font-size: 14px; font-weight: 700;" %)Datos de salida

1234

1235

1236

GNRMSGNotificacionDetalleDTO

1237

1238

1239

(% style="font-family: sans-serif; font-style: normal; text-align: start;" %)

1240

== (% style="font-size: 22.54px;" %)Más información(%%) ==

1241

1242

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1243

* [[WSDL>>https://educages.navarra.es/Educa/services/gnr/msg/EnvioNotificacionesWS?wsdl||style="font-size: 14px;"]]

1244

* [[Documentación detallada>>http://educadev.educacion.navarra.es/api/MSGEnvioNotificaciones/||style="font-size: 14px;"]]

1245

1246

= SERVICIO DE CONSULTA DE PROVEEDORES (Censo genérico) =

== Objetivo ==

Servicio de consulta que proporciona información de proveedores utilizados por el Gobierno de Navarra. Imita la funcionalidad del servicio equivalente de la Junta de Andalucía para dar soporte a //Ecoeduca//.

1251

1252

== Fuente de los datos ==

1253

1254

Los datos de obtienen de un servicio al efecto proporcionado por el SAP además de entradas manuales introducidas por el Servicio de Gestión Económica del Departamento de Educación.

1255

1256

Almacena las entradas para poder funcionar aunque el servicio del SAP no esté en línea.

1257

1258

== Autentificación ==

Anónima.

== Métodos ==

=== obtieneDatosCliente ===

1265

1266

Devuelve los datos de un proveedor cuyo NIF se pasa como parámetro.

1267

1268

**Parámetros de entrada**

1269

1270

1271

obtieneDatosCliente(String nombreAplicacion,String nifSolicitante,String nombreSolicitante, String nifAconsultar)

1272

1273

1274

De todos los parámetros pasados, sólo se utiliza nifAconsultar, el resto se mantiene por compatibilidad con el formato de Andalucía.

**Datos de salida**

DatosCliente

**Ejemplo de uso**

{{code language="xml"}}<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cen="http://es/juntadeandalucia/economiayhacienda/serviciosWeb/censoGenerico">

1285

<soapenv:Header/>

1286

<soapenv:Body>

1287

<cen:obtieneDatosCliente>

</cen:obtieneDatosCliente>

1293

</soapenv:Body>

1294

</soapenv:Envelope>{{/code}}

1295

1296

**Respuesta**

1297

{{code language="xml"}}<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

1298

<soap:Body>

1299

<ns1:obtieneDatosClienteResponse xmlns:ns1="http://es/juntadeandalucia/economiayhacienda/serviciosWeb/censoGenerico">

<item>

<localidad>ANDOAIN</localidad>

1304

1305

<nombreCliente>PAPELERA DEL LEIZARAN SA</nombreCliente>

</item>

</obtieneDatosClienteReturn>

1310

</ns1:obtieneDatosClienteResponse>

1311

</soap:Body>

1312

</soap:Envelope>{{/code}}

1313

1314

=== obtieneTodosLosClientes ===

1315

1316

Devuelve los datos de varios proveedores cuyos NIFs se pasan como parámetro (Lista).

1317

1318

**Parámetros de entrada**

1319

1320

1321

obtieneDatosCliente(String nombreAplicacion,String nifSolicitante,String nombreSolicitante, List<item> nifs)

1322

1323

1324

De todos los parámetros pasados, sólo se utiliza nifAconsultar, el resto se mantiene por compatibilidad con el formato de Andalucía.

**Datos de salida**

List<DatosCliente>

**Ejemplo de uso**

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cen="http://es/juntadeandalucia/economiayhacienda/serviciosWeb/censoGenerico">

1337

<soapenv:Header/>

1338

<soapenv:Body>

1339

<cen:obtieneTodosLosClientes>

<nifs>

</nifs>

</cen:obtieneTodosLosClientes>

</soapenv:Body>

</soapenv:Envelope>

**Respuesta**

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

1357

<soap:Body>

1358

<ns1:obtieneTodosLosClientesResponse xmlns:ns1="http://es/juntadeandalucia/economiayhacienda/serviciosWeb/censoGenerico">

<item>

<localidad>VITORIA</localidad>

1363

1364

<nombreCliente>AUTOBUSES HERMANOS ARRIAGA SA</nombreCliente>

</item>

<item>

<localidad>SANT CUGAT DEL VALLES</localidad>

1372

1373

<nombreCliente>ROCHE DIAGNOSTICS SL</nombreCliente>

</item>

</obtieneTodosLosClientesReturn>

1379

</ns1:obtieneTodosLosClientesResponse>

</soap:Body>

</soap:Envelope>

== Estructura del DTO de respuesta "DatosCliente" ==

1385

1386

1387

@XmlAccessorType(XmlAccessType.FIELD)

1388

@XmlType(name = "DatosCliente", propOrder = {

1389

"calificadorNumeroVia",

"codIneMunicipio",

"codigoPostal",

"complentoVia",

"descMunicipio",

"direccionEmail",

"escalera",

"fax",

"letraVia",

"localidad",

"municipio",

"nifCliente",

"nombreCliente",

"nombreVia",

"numeroVia",

"pais",

"piso",

"portal",

"provincia",

"puerta",

"telefono",

"tipoNumeracionVia",

"tipoVia" })

(% style="font-family: sans-serif; font-size: 14px; font-style: normal; font-weight: normal; text-align: start;" %)

1416

* [[WSDL>>https://educages.navarra.es/Educa/services/eco/ProveedoresWS?wsdl||style="font-size: 14px;"]]

1417

)))

1418

1419

= SERVICIO DE PLAN DE ESTUDIOS =

== Objetivos ==

Proporcionar la organización del plan de estudios en Educa.

1424

1425

== WSDL e información de tallada de los métodos y DTOs ==

1426

1427

//URL WSDL: [[https:~~/~~/educages.navarra.es/Educa/services/pe/PEPlanEstudiosWS?wsdl>>https://educages.navarra.es/Educa/services/pe/PEPlanEstudiosWS?wsdl]]//

1428

//URL Información detallada: [[http://educadev.educacion.navarra.es/api/PEPlanEstudios/service_ns0_PEPlanEstudiosWSService.html]]//

Código fuente wiki de Servicios para aplicaciones del Departamento de Educación