1. Introducció
A continuació és descriu el funcionament i les diferents modalitats de consum de la versió de missatgeria 3.2 d’eNotum.
1.1. Integració PCI
Tal i com es reflecteix a la següent figura, el Backend d’eNotum s’integra dins de l’arquitectura de la Plataforma de Col·laboració Interadministrativa (en endavant PCI) a mode d’un nou servei accessible a través de la MTI.
Per tant els integradors que vulguin accedir a l’eNotum ho hauran de fer a través de la missatgeria de la PCI utilitzant l’element <DatosEspecificos>
d’aquesta, per a més informació podeu consultar el document d’integració de la PCI aqui
1.2. Cicle de vida de les notificacions
Per tal de comprendre com utilitzar les operacions que estan publicades per a la integració amb eNotum és recomanable entendre el cicle de vida de les notificacions. Això ens permetrà saber en quins estats pot estar la notificació i l’efecte que tindrà l’execució de les operacions sobre l’estat d’aquesta.
1.2.1. Diagrama de cicle de vida
En el següent diagrama d’estats es mostra els diferents estats possibles de la notificació i les transicions que es poden donar.
1.2.2. Descripció dels estats de les notificacions
1.2.2.1. Pendent de processar
L’estat Pendent de processar és l’estat inicial de la notificació. La notificació està en aquest estat just en el moment en que l’integrador ha llançat la operació ProcessarTramesa i el missatge de resposta de l’operació ha indicat un codi de notificació, o sigui, que no hi ha hagut cap error. En el cas que la petició de processar tramesa hagi produït algun error la notificació no es crea i, per tant, no està en aquest estat.
Si en el missatge de ProcessarTramesa s’indica un número de registre i una data de registre la notificació passa directament a l’estat Registrada sense passar per l’estat Pendent de processar.
Un cop en aquest estat el motor de eNotum s’encarrega de registrar la notificació. Si el registre es fa correctament es passa a l’estat Registrada. Si el registre falla el motor de eNotum programa un nou intent de registre de la notificació al cap d’un cert temps. L’execució pot reintentar-se un nombre determinat de cops. Quan s’exhaureixen els reintents la notificació passa a l’estat Error.
El temps d’espera entre intents d’execució així com el nombre de reintents és configurable mitjançant l’aplicació eNotum al portal EACATPL. Aquests camps es poden definir per fase del motor d’eNotum i per organisme/departament al que pertany la notificació.
1.2.2.2. Registrada
La notificació està en aquest estat quan ja està registrada. S’arriba a aquest estat quan el motor registra una notificació en estat Pendent de processar o quan s’envia un missatge a eNotum indicant que la tramesa ja està registrada. O sigui, informant la data de registre i el número de registre dins el node /Notificacio/DadesRegistre
de la <Tramesa>
.
Quan estem en aquest estat el motor d’eNotum dipositarà la notificació i crearà la evidència de dipòsit. Si aquest procés s’executa sense problemes es passarà a l’estat Dipositada. Com en l’estat anterior, si falla el procés es reintentarà un nombre definit de cops i, si finalment cap acaba correctament, la notificació passa a l’estat Error.
Igual que en el cas anterior el temps d’espera entre intents d’execució així com el nombre de reintents és configurable mitjançant l’aplicació eNotum al portal EACATPL. Aquests camps es poden definir per fase del motor d’eNotum i per organisme/departament al que pertany la notificació.
1.2.2.3. Dipositada
La notificació passa a aquest estat quan s’ha efectuat el dipòsit de la notificació. Només s’arriba a aquest estat a partir de l’estat Registrada.
En aquest estat s’avisa als destinataris de la notificació que han rebut una notificació i que poden accedir a l’aplicació per tal de poder consultar les seves notificacions. Aquesta informació s’envia per correu electrònic i/o via un SMS al telèfon del destinatari. Ambdós camps s’agafaran dels nodes /BustiesCorreu/BustiaCorreu
i /Telefons/Telefon
respectivament del node <PersonaFisica>
o <PersonaJuridica>
que ve informat dins el node /Notificacio/Destinatari
de la <Tramesa>
. En aquest estat també s’enviaran els correus electrònics i missatges de text a les persones d’avís associades a cada destinatari. Les persones d’avís es diferencien dels destinataris de la notificació en el fet que no poden accedir a la notificació i només s’assabenten a través d’aquest avís de que el destinatari al que estan associades ha rebut una notificació.
L’integrador pot permetre que el ciutadà consulti les notificacions que ha rebut mitjançant l’operació de PeticióCerca. Les notificacions retornades per aquesta consulta passaran automàticament a l’estat Visualitzada.
Per altra banda, l’integrador pot permetre que els empleats encarregats de crear/gestionar les notificacions puguin consultar l’estat en que es troben les notificacions i diversa informació addicional amb les operacions PeticióCerca i PeticióConsulta. Aquestes al ser executades per a un perfil d’empleat públic no canvien l’estat de la notificació a Visualitzada ja que no és el ciutadà qui ha visualitzat la notificació.
Si el ciutadà no visualitza la notificació aquesta es manté en aquest estat durant el temps de vigència de la notificació indicat al camp <DiesExpiracio>
. Al expirar aquest període el sistema rebutja automàticament la notificació creant una evidència de rebuig i la notificació passa a l’estat Rebutjada sense accés. Com en els casos anteriors, si aquest procés falla es reintenta en funció dels paràmetres de configuració del gestor d’errors i si s’exhaureixen els reintents la notificació passa a l’estat Error.
1.2.2.4. Visualitzada
Quan la notificació està en aquest estat el ciutadà pot decidir acceptar o rebutjar la notificació. Per tal que aquesta decisió tingui una validesa legal el ciutadà ha de realitzar una acció diferent en funció del tipus d’accés requerit per a la notificació.
La practica de la notificació es pot realitzar:
- Amb signatura del ciutadà:
- Per a notificacions creades amb
<TipusAcces>
CERT, s’ha de signar l’acceptació o rebuig amb el certificat digital vinculat a l’identitat de l’usuari. - Per a notificacions creades amb
<TipusAcces>
PPAS, es poden acceptar o rebutjar de dues formes:
- Amb una paraula de pas específica demanada per a realitzar la practica d’una notificació.
- O si es delega l’autenticació del usuari a Valid tant sols indicant el
/Usuari/IdAutenticacio
per identificar aquest procés d’autorització.
- Per a notificacions creades amb
En el cas d’accés amb certificat digital Les dades a signar seran proporcionades per eNotum mitjançant la operació Practicar notificació indicant que la modalitat de l’operació a realitzar es OBTENIR_DADES.
La signatura del ciutadà ha de ser realitzada amb una eina de signatura que generi signatures digitals avançades en format XML (XAdES) com per exemple el servei del signador del Consorci AOC. Per tal que la signatura sigui acceptada ha de tenir un format XAdES-T o més elevat ja que és a partir d’aquest nivell que es garanteix l’autenticació del signatari, integritat de les dades i validesa de la signatura a llarg termini.
Un cop realitzada la signatura aquesta s’envia a eNotum amb l’operació Practicar notificació indicant que la modalitat de l’operació a realitzar es SIGNAR. Llavors, el sistema comprova la validesa de la signatura i, si aquesta és valida, l’estat de la notificació passa a ser Acceptada o Rebutjada en funció del que s’hagi especificat en l’element <Decisio>
de l’operació de practicar.
- Sense signatura per part del ciutadà
Utilitzant l’operació Practicar notificació indicant que la modalitat de l’operació a realitzar es SIGNAR. L’estat de la notificació passa a ser Acceptada o Rebutjada en funció del que s’hagi especificat en l’element
Es pot donar el cas que el ciutadà tot i que visualitzi la notificació no l’accepti ni la rebutgi amb cap dels dos mecanismes. En aquest cas la notificació es manté en l’estat Visualitzada fins la finalització del temps de vigència. Exhaurit aquest període el sistema rebutja la notificació i aquesta passa a l’estat Rebutjada sense acció. Com en els casos anteriors, si aquest procés falla es reintenta en funció dels paràmetres de configuració del gestor d’errors i si s’exhaureixen els reintents la notificació passa a l’estat Error.
Comentar també que la modalitat 1 és manté per compatibilitat amb clients ja integrats però que és susceptible de desapareixer en un futur, per tant totes les noves integracions que vulguin realitzar l’acceptació ho hauran de fer amb el segon mecanisme
1.2.2.5. Acceptada / Rebutjada / Rebutjada sense acció / Rebutjada sense accés
Un cop la notificació està en qualsevol d’aquests quatre estats - que es consideren tots estats finals ja que un cop la notificaciño asoleix un d’aquests estats el mateix ja no es modificarà - el ciutadà pot consultar les dades de la notificació. L’integrador pot recuperar aquestes dades amb la operació PeticióConsulta. Aquesta operació només pot ser consultada amb el <Rol>
CIUTADA quan la notificació està en els estats Acceptada, Rebutjada, Rebutjada sense acció o Rebutjada sense accés.
Un cop es pot fer la consulta per ciutada perquè la notificació es troba en un d’aquests estats, la informació retornada serà la mateixa, és a dir, la informació sobre la notificació retornada no serà més o menys restrictiva en funció de l’estat. Remarquem aquest fet ja que en versions anteriors d’eNotum les dades recuperades per la consulta en cas de que l’estat de la notificació fos Acceptada eren més que per qualsevol dels altres tres estats de Rebutjada.
1.2.2.9. Error
Arriben a aquest estat les notificacions que han estat involucrades en l’execució d’algun procés del sistema que ha produït repetidament errors.
En aquest estat les notificacions no poden ser acceptades ni rebutjades ni pel ciutadà ni pel sistema.
Per l’operació PeticioCerca de ciutadà no es mostren les notificacions en aquest estat. En canvi per aquesta mateixa operació amb <Rol>
EMPLEAT sí es mostren aquestes notificacions per tal que l’empleat sigui conscient de que la notificació està en error.
Quan una notificació està en aquest estat l’administrador del sistema pot rellançar manualment el procés on s’ha produït l’error.
1.2.2.10. Anul·lada
Un cop en aquest estat la notificació no pot ser canviada d’estat a un estat anterior.
La notificació arriba a aquest estat quan l’ens que ha generat la notificació demana que aquesta s’anul·li. Hi ha diversos motius que poden motivar l’anul·lació d’una notificació: que aquesta contingui dades errònies, que l’expedient que la motiva ha estat declarat nul, etc.
L’anul·lació d’una notificació s’ha de realitzar a través de l’aplicació eNOTUM del portal EACAT. Al portal de suport podeu trobar la guia sobre com anul·lar una notificació des de les pantalles d’EACAT.
1.3. Cicle de vida de les comunicacions
En el cas de les comunicacions el cicle de vida és molt similar al de les notificacions excepte en el fet de que no es necessita validesa legal de que el destinatari ha practicat la notificació, i que a més a més les comunicacions no tenen un temps determinat de vigència i per tant no expiren, així doncs el cicle de vida es simplifica i queda de la següent manera:
1.3.1. Descripció dels estats de les comunicacions
Com es pot observar en el diagrama anterior hi ha poques diferències en els estats de les comunicacions respecte els de les notificacions. Aquestes comparteixen els estats inicials fins que el ciutadà visualitza la notificació. Un cop en aquest estat, la diferencia radica en l’absència de l’estat Rebutjada i en la manera de fer la transició cap a l’estat Acceptada des de l’estat Visualitzada. També es pot observar que no hi ha l’estat d’expiració al final de la vida de la comunicació donat que no tenen data de caducitat.
1.3.1.1. Visualitzada
Quan la comunicació està en aquest estat el ciutadà pot directament consultar el contingut de la comunicació. A diferència de la notificació, no es necessita validesa legal de l’acceptació o rebuig d’aquesta i per tant no cal que el ciutadà signi digitalment la seva decisió. Un cop consultada la comunicació amb l’operació Consultar una notificació aquesta realitzarà automàticament la transició a l’estat Acceptada.
1.3.1.2. Altes estats
La resta d’estats són els mateixos respecte les notificacions i s’han de fer servir les mateixes operacions que amb aquestes.
Per crear-les s’ha d’informar el camp TipusObjecte en el node <Notificacio>
de l’operació ProcessarTramesa amb el valor COMUNICACIO.
1.4. Codificació dels estats de les notificacions a eNOTUM
La codificació dels estats de les notificacions a eNotum es fa mitjançant una paraula d’estats que permet tenir constància de l’estat actual així com traça dels diferents estats pels que ha passat una notificació.
2. Missatgeria
Com es comenta en el punt 1 d’aquest document eNotum funciona com a servei dins de la PCI, serà per tant necessari treballar amb la missatgeria de la PCI, encapsulant la missatgeria específica de eNotum dins d’aquesta.
Específicament per a fer ús del servei d’eNotum dins de la missatgeria de la PCI és necessari informar els següents elements del missatge XML:
-
//Peticion/Atributos/CodigoProducto
el string ENOTUM -
//Peticion/Atributos/CodigoCertificado
el string ENOTUM -
//Peticion/Solicitudes/SolicitudTransmision/DatosGenericos/Transmision/CodigoCertificado
el string ENOTUM -
//Peticion/Solicitudes/SolicitudTransmision/DatosEspecíficos
Petició XML específica d’eNotum
Pel que fa a la resta del missatge PCI, cal que aquest compleixi amb els requisits definits al document d’integració de la PCI aqui
3. Missatgeria específica eNotum versió 3.2
A continuació es detallaran els elements comuns a totes les modalitats de consum:
Petició
Totes les modalitats de consum WS que ofereix eNotum extenen el següent esquema de petició:
<xs:complexType name="PeticioType" abstract="true">
<xs:sequence>
<xs:element name="Usuari" type="UsuariType"/>
<xs:element name="Emissor" type="EmissorType"/>
</xs:sequence>
</xs:complexType>
Per tant com és pot veure totes les peticions, a banda dels elements específics de cada modalitat de consum, tenen els següents elements:
-
//PeticioType/Usuari
Dades de l’usuari, es descriuen a continuació. -
//PeticioType/Emissor
Dades de l’emissor, es descriuen a continuació.
Aquí podeu veure la definició completa del esquema Peticio.xsd
Usuari
La definició de l’element UsuariType, la podeu trobar a Usuari.xsd
El tipus usuari està format pels següents elements:
Rol
<xs:element name="Rol">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="EMPLEAT"/>
<xs:enumeration value="CIUTADA"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
Aquest camp és obligatori i contindrà la etiqueta del rol autoritzat de l’usuari que realitza la operació. Hi ha dos rols definits que es descriuen a continuació:
- EMPLEAT : L’empleat públic és el rol d’usuari autoritzat per a la creació de notificacions. A banda permet fer les operacions de modalitats de consum de Cerca, Consulta etc. A excepció de les operacions de Practicar i demanar Paraula de pas.
- CIUTADA : El ciutadà és el rol d’usuari autoritzat a cercar i acceptar notificacions vinculades al propi usuari.
Perfil
<xs:element name="Perfil" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="PERSONA_JURIDICA"/>
<xs:enumeration value="EMPRESA"/>
<xs:enumeration value="PERSONA_FISICA"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
Opcionalment en cas de <Rol>
CIUTADA i de que l’usuari presenti el NIF de persona física i el d’empresa, ja sigui al generar la paraula de pas, en el certificat, o amb VALId, es podrà indicar un perfil que afectarà directament a les cerques de notificacions. Els possibles valors que pot pendre aquest camp:
- PERSONA_FISICA : Cerca les notificacions per a la persona física.
- EMPRESA : Cerca les notificacions per a l’empresa.
- PERSONA_JURIDICA : Cerca les notificacions com a persona jurídica.
Autenticació usuari
En cas de <Rol>
amb valor CIUTADA, s’haurà d’informar només un dels següents blocs en funció del mecanisme d’autenticació emprat per l’usuari.
Certificat
<xs:element name="CertificatCiutada" type="xs:base64Binary"/>
En cas d’autenticació amb certificat aquest camp contindrà el certificat del ciutadà que realitza l’operació.
Paraula de pas
<xs:sequence>
<xs:element name="IdParaulaPas" type="xs:string"/>
<xs:element name="ParaulaPas" type="xs:string"/>
</xs:sequence>
Identificador i paraula de pas respectivament, emprades com a mecanisme d’autenticació del ciutadà que realitza l’operació.
VALId
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element name="NIF" type="NIF"/>
<xs:element name="PASSAPORT" type="NoEmptyString"/>
</xs:choice>
<xs:element name="CIF" type="CIF" minOccurs="0"/>
<xs:element name="IdAutenticacio" type="xs:string"/>
<xs:element name="NivellAutenticacio">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="ALT"/>
<xs:enumeration value="SUBSTANCIAL"/>
<xs:enumeration value="BAIX"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
En cas d’autenticació amb VALId s’ha d’informar el camp IdAutenticacio amb el access token del login del ciutadà que realitza l’operació.
La resta de camps han estat deprecats i no es té en compte el valor informat.
Emissor
La definició de l’element EmissorType, la podeu trobar a Emissor.xsd
Els elements que conté el tipus Emissor són els següents:
CodiOrganisme
<xs:element name="CodiOrganisme" type="xs:string"/>
Codi ENS de l’organisme emissor de la notificació
CodiDepartament
<xs:element name="CodiDepartament" type="xs:string"/>
Codi ENS del departament emissor de la notificació.
CodiBO
<xs:element name="CodiBO" type="xs:string" minOccurs="0"/>
Codi del Back Office de l’emissor
Modalitats de consum del WS
A continuació és detallaran els elements específics per a les diferents peticions de les modalitats de consum que ofereix el WS d’eNotum.
Petició - PeticioProcessarTramesa
Aquí podeu veure la definició completa del esquema ProcessarTramesa.xsd
Aquesta petició permet la creació de notificacions dins del sistema. La definició d’aquesta petició exten la peticioType afegint l’element <Tramesa>
que es descriu a continuació.
Tramesa
<xs:element name="Tramesa">
<xs:complexType>
<xs:sequence>
<xs:element name="DadesAvisos" minOccurs="0"/>
<xs:element name="DadesOfici"/>
<xs:element name="Documents" type="DocumentsType"/>
<xs:element name="Notificacio" type="NotificacioType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
La tramesa és l’estructura que permet la creació de notificacions i/o comunicacions i permet agrupar-les. Està formada per els elements que es descriuen a continuació:
DadesAvisos
<xs:element name="DadesAvisos" minOccurs="0">
<xs:complexType>
<xs:all>
<xs:element name="Plantilla" type="xs:string" minOccurs="0"/>
<xs:element name="Email" minOccurs="0"/>
<xs:element name="SMS" minOccurs="0"/>
<xs:element name="DiesAvisos" type="DiesAvisosType" minOccurs="0"/>
<xs:element name="URLs" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
L’element <DadesAvisos>
és opcional ja que eNotum disposa d’un comportament per defecte per als valors especificats en aquest element, en cas de que vinguin informats al missatge, aquests tindran prioritat per a ser utilitzats en comptes dels que hi hagi establers per defecte. <DadesAvisos>
està format pels següents elements:
-
/DadesAvisos/Plantilla
Deprecat -
/DadesAvisos/Email
Deprecat -
/DadesAvisos/SMS
Deprecat -
/DadesAvisos/URLs
Deprecat
DiesAvisos
<xs:element name="DiesAvisos" minOccurs="0"/>
<xs:complexType>
<xs:sequence>
<xs:element name="DiaAvis" type="xs:positiveInteger" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</element>
-
/DiesAvisos/DiaAvis
Llista d’elements d’aquest tipus amb els número de dies a comptar a partir del enviament per el qual s’enviaran recordatoris al/s destinatari/s de la notificació mentre aquesta no es trobi en un estat final.
DadesOfici
<xs:element name="DadesOfici">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="CosNotificacio">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="4000"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="IdCosNotificacio" type="xs:integer"/>
</xs:choice>
<xs:choice>
<xs:element name="PeuRecurs">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="4000"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="IdPeuRecurs" type="xs:integer"/>
</xs:choice>
<xs:element name="OficinaRegistre" type="xs:string" minOccurs="0"/>
<xs:element name="UnitatOrganitzativa" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Aquest element permet específicar les dades d’ofici vinculades a la notificació:
-
/DadesOfici/CosNotificacio
Cos de la notificació -
/DadesOfici/IdCosNotificacio
Deprecat -
/DadesOfici/PeuRecurs
Peu de recurs. -
/DadesOfici/IdPeuRecurs
Deprecat -
/DadesOfici/OficinaRegistre
Codi d’oficina de registre a usar per registrar les notificacions. Aquest paràmetre no és obligatori ja que per defecte el sistema usarà la oficina de registre parametritzada per a l’entitat emissora de les notificacions (organisme\departament). Així, només cal informar aquest paràmetre en el cas que s’hagués de realitzar el registre contra una oficina diferent de la habitual. -
/DadesOfici/UnitatOrganitzativa
Codi d’unitat organitzativa a usar per registrar les notificacions. Aquest paràmetre no és obligatori ja que per defecte el sistema usarà la unitat organitzativa (codi organisme) parametritzada per a l’entitat emissora de les notificacions (organisme\departament). Així, només cal informar aquest paràmetre en el cas que s’hagués de realitzar el registre contra una oficina diferent de la habitual.
Documents
<Documents>
és una seqüencia de entre 1 i 5 elements de tipus DocumentType
. Només un document de <Tipus>Resolució</Tipus>
és obligatori, i opcionalment pot anar acompanyat de fins a 4 documents de <Tipus>Annex</Tipus>
. La definició de DocumentType
es pot veure a continuació:
<xs:complexType name="DocumentsType">
<xs:sequence>
<xs:element name="Document" maxOccurs="5">
<xs:complexType>
<xs:sequence>
<xs:element name="Nom" type="xs:string"/>
<xs:element name="SHA1Digest" type="xs:base64Binary" minOccurs="0"/>
<xs:choice>
<xs:element name="Dades" type="xs:base64Binary"/>
<xs:element name="URLDescarrega" type="xs:anyURI"/>
<xs:element name="Ruta" type="xs:string"/>
<xs:element name="IdFicheroPCI" type="xs:string"/>
</xs:choice>
<xs:element name="Tipus">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Resolució"/>
<xs:enumeration value="Annex"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
-
/Documents/Document/Nom
Nom del fitxer del document, amb extensió. E.g: holaRepublica.pdf -
/Documents/Document/SHA1Digest
Resum críptografic en SHA1 del contingut del document com a string codificat en base64. -
/Documents/Document/URLDescarrega
»ENCARA NO DISPONIBLE Permet informar una URL on l’ens té penjada la resolució. Aquesta URL no hauria de ser pública i tenir accés securitzat per IP (TODO: parlar amb el CAOC per generar connectivitats per a la descàrrega + text formal per l’organisme en cas d’error)
-
/Documents/Document/Dades
En cas que és vulgui incrustar el document dins del missatge en base64. S’ha de tenir en compte que per a documents on la mida superi 1MB, no recomanem aquest mecanisme, donat que la PCI té una restricció on el missatge XML de la petició complet no pot superar els 2MB. -
/Documents/Document/Ruta
Ruta del document pujat al FTP. Aquesta ruta és la relativa dins el directori arrel de l’usuari que es connecta al FTP. Només disponible per als ens que s’han donat d’alta amb la integració per aquesta via. -
/Documents/Document/IdFicheroPCI
Permet adjuntar un document mitjançant MTOM. Aquest identificador s’ha de correspondre amb el<Id>
del<Fichero>
de les<DatosGenericos>
de la missatgeria de la PCI per a que eNotum pugui recuperar correctament el document. En aquest cas el document s’adjunta en la petició XML i s’ha d’específicar mitjançant el tag<Contendio>
del<Fichero>
en fromat MTOM dins de la missatgeria de la PCI. Per a més informació podeu consultar la guia d’integració de la PCI -
/Documents/Document/Tipus
Indica el tipus de documents adjuntat. Els possibles valors són:- Resolució : És obligatori adjuntar un document d’aquest tipus per tramesa.
- Annex : Opcionalment és poden adjuntar fins a quatre documents d’aquest tipus.
Notificació
<xs:complexType name="NotificacioType">
<xs:all>
<xs:element name="Titol">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="100"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Referencia">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="DadesRegistre" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="NumeroRegistre" type="NoEmptyString"/>
<xs:element name="DataRegistre" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SenseRegistre" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="TipusObjecte" type="TipusObjecteType"/>
<xs:element name="TipusAcces" type="TipusAccesType" minOccurs="0"/>
<xs:element name="NivellCertificat" type="xs:string" minOccurs="0"/>
<xs:element name="DiesExpiracio" type="xs:positiveInteger" minOccurs="0"/>
<xs:element name="Destinataris" type="DestinatarisType"/>
<xs:element name="Etiquetes" type="EtiquetesType" minOccurs="0"/>
<xs:element name="AmbitObjecte" type="xs:string" minOccurs="0"/>
<xs:element name="Idioma" type="Idioma" minOccurs="0"/>
<xs:element name="IdNotificacioEmissor" type="xs:string" minOccurs="0"/>
<xs:element name="Canal" type="CanalType" minOccurs="0"/>
<xs:element name="Expedient" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Tramit" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="NumeroCas" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:all>
</xs:complexType>
-
/Notificacio/Titol
Títol de la notificació. Màxim 100 caràcters i mínim 3 caràcters. -
/Notificacio/Referencia
Cadena d’identificació de la notificació. Tot i que no cal que aquesta sigui única respecte a les demés notificacions existents al sistema, es recomanable utilitzar seqüències úniques de caràcters per facilitar la localització posterior a les cerques. Màxim 250 caràcters i mínim 3 caràcters. -
/Notificacio/DadesRegistre/NumeroRegistre
Número de registre (opcional) pel cas de notificacions que vinguin pre-registrades. Si el paràmetre ve informat, eNOTUM no realitzarà el registre de la notificació corresponent i la dipositarà usant com a dades d’assentament les proporcionades a la petició. -
/Notificacio/DadesRegistre/DataRegistre
Data de l’assentament (opcional) pel cas de notificacions que vinguin pre-registrades. Si el paràmetre ve informat, junt amb el de número de registre, eNOTUM no realitzarà el registre de la notificació corresponent i la dipositarà usant com a dades d’assentament les proporcionades a la petició. Es validarà que la data informada no sigui posterior a la data actual i que no sigui anterior a 30 dies. -
/Notificacio/SenseRegistre
De forma també opcional, només en el cas d’estar creant una COMUNICACIO, mitjançant aquest element es pot indicar que no es vol crear registre de sortida per a aquest enviament concret. -
/Notificacio/TipusObjecte
Indica si es tracta d’una notificació o d’una comunicació. Els valors possibles per aquest paràmetre son:- NOTIFICACIO : Indica que l’enviament serà de tipus notificació.
- COMUNICACIO : Indica que l’enviament serà de tipus comunicació.
-
/Notificacio/TipusAcces
Indica el nivell d’autenticació requerit al ciutadà per tal de poder accedir a la notificació. Els possibles valors són:- BAIX
- SUBSTANCIAL
- ALT
- PPAS: Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
- CERT: Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
-
/Notificacio/NivellCertificat
En cas d’accés requerit amb certificat, és pot ajustar el nivell d’aquest per l’accés a la notificació. -
/Notificacio/DiesExpiracio
Dies a partir dels quals la notificació exiprarà, a contar a partir de la data de dipòsit. El màxim valor establert per a aquest camp és de 180 dies. -
/Notificacio/Destinataris
Dades dels destinataris de la notificació. -
/Notificacio/Etiquetes
Etiquetes per a agrupar la notificació. -
/Notificacio/AmbitObjecte
Deprecat -
/Notificacio/Idioma
Idioma de la notificació. Els possibles valors són:- ca : Indica que l’idioma de la notificació és català.
- es : Indica que l’idioma de la notificació és castellà.
- oc : Indica que l’idioma de la notificació és aranés.
- en : Indica que l’idioma de la notificació és anglés.
-
/Notificacio/IdNotificacioEmissor
Identificador de la notificació propi del emissor. Serveix en les peticions de lots asíncrones per a que el emissor pugui associar el seu identificador intern amb l’identificador de notificació retornat per eNotum. -
/Notificacio/Canal
Canal d’enviament per al que s’envia originalment la notificació. Els possibles valors són:- DIGITAL : La notificació s’envia únicament per via telemàtica.
- PAPER : La notificació s’envia per via telemàtica i pot ser enviada en format paper en cas de que no sigui accedida per via telemàtica.
-
/Notificacio/Expedient
Opcionalment es pot indicar l’expedient al que està relacionada la notificació. S’aplicarà un límit màxim en la mida del camp en funció de l’emissor de la notificació: 50 caràcters màxim per la majoria d’ens i 34 caràcters per als ens que registrin a S@RCAT (S@RCAT no permet números d’expedient superiors a 34 caràcters). -
/Notificacio/Tramit
Opcionalment es pot indicar el tràmit amb el que està relacionada la notificació. 50 caràcters màxim i 3 mínim. -
/Notificacio/NumeroCas
Opcionalment es pot indicar el numero de cas amb el que està relacionada la notificació. 50 caràcters màxim.
Destinataris
<xs:complexType name="DestinatarisType">
<xs:sequence>
<xs:element name="Destinatari" maxOccurs="100">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="PersonaFisica" type="PersonaFisicaType"/>
<xs:element name="PersonaJuridica" type="PersonaJuridicaType"/>
</xs:choice>
<xs:element name="Idioma" type="Idioma" minOccurs="0"/>
<xs:element name="Obligat" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
Aquest element defineix els destinataris de les notificacions de la tramesa.
-
/Destinatari/PersonaFisica
Dades del destinatari en cas de que es tracti d’una persona física. -
/Destinatari/PersonaJuridica
Dades del destinatari en cas de que es tracti d’una persona jurídica. -
/Destinatari/Idioma
Opcionalment permet indicar l’idioma específic de l’usuari entre del següents valors:- ca : Indica que l’idioma de la notificació és català.
- es : Indica que l’idioma de la notificació és castellà.
- oc : Indica que l’idioma de la notificació és aranés.
- en : Indica que l’idioma de la notificació és anglés.
-
/Destinatari/Obligat
Camp opcional, que permet indicar si el destinatari està obligat a relacionar-se amb l’administració per via electrònica. Per defecte aquest camp pren el valor ‘true’ en el cas de persones jurídiques i ‘false’ en el cas de persones físiques.
PersonaFisica
<xs:complexType name="PersonaType" abstract="true">
<xs:sequence>
<xs:element name="BustiesCorreu" type="BustiesCorreuType" minOccurs="0"/>
<xs:element name="Telefons" type="TelefonsType" minOccurs="0"/>
<xs:element name="PersonesAvis" type="PersonesAvis" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PersonaFisicaType">
<xs:complexContent>
<xs:extension base="PersonaType">
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaFisicaType"/>
<xs:element name="Nom" type="NoEmptyString"/>
<xs:element name="PrimerCognom" type="NoEmptyString"/>
<xs:element name="SegonCognom" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Per a l’element PersonaFisica
serà obligatori informar una bústia de correu o un telèfon. Excepte en el cas en que la persona física és subjecte obligat (el /Destinatari/Obligat
tindrá el valor true) o el /Notificacio/Canal
és PAPER, llavors no es realitzarà aquesta comprovació i aquests camps seran opcionals.
-
/PersonaFisica/BustiesCorreu/BustiaCorreu
Adreça de correu electrònic del destinatari. -
/PersonaFisica/Telefons/Telefon
Telèfon mòbil del destinatari. A nivell de missatgeria no existeix restricció al respecte del camp, però al servidor es comprova i normalitza el format del telèfon. -
/PersonaFisica/PersonesAvis
Dades de les persones que rebran l’avís de la notificació però que no podràn accedir a la mateixa. -
/PersonaFisica/DocumentIdentificatiu
Document d’identitat de la persona física destinataria de la notificació. El tipusDocumentPersonaFisicaType
es descriu amb més detall aquí. -
/PersonaFisica/DocumentIdentificatiu/NIF
NIF o NIE del destinatari de la notificació. -
/PersonaFisica/DocumentIdentificatiu/PASSPORT
Si la notificació és per a un destinatari estranger en comptes del NIF o NIE es pot informar el passaport. -
/PersonaFisica/Nom
Nom del destinatari. -
/PersonaFisica/PrimerCognom
Primer cognom del destinatri. -
/PersonaFisica/SegonCognom
Segon cognom del destinatari.
PersonaJuridica
<xs:complexType name="PersonaType" abstract="true">
<xs:sequence>
<xs:element name="BustiesCorreu" type="BustiesCorreuType" minOccurs="0"/>
<xs:element name="Telefons" type="TelefonsType" minOccurs="0"/>
<xs:element name="PersonesAvis" type="PersonesAvis" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PersonaJuridicaType">
<xs:complexContent>
<xs:extension base="PersonaType">
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaJuridicaType"/>
<xs:element name="RaoSocial" type="NoEmptyString" nillable="false" />
<xs:element name="PersonaVinculada" type="PersonaVinculadaType" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Per a l’element PersonaJuridica
informar la bústia de correu o el telèfon serà opcional.
-
/PersonaJuridica/BustiesCorreu/BustiaCorreu
Aquests camp, té la mateixa definició que l’equivalent dePersonaFisica
-
/PersonaJuridica/Telefons/Telefon
Aquests camp, té la mateixa definició que l’equivalent dePersonaFisica
-
/PersonaJuridica/PersonesAvis
Aquests camp, té la mateixa definició que l’equivalent dePersonaFisica
-
/PersonaJuridica/DocumentIdentificatiu
Document d’identitat de la persona jurídica destinataria de la notificació. El tipusDocumentPersonaJuridicaType
es descriu amb més detall aquí. -
/PersonaJuridica/DocumentIdentificatiu/CIF
NIF de l’empresa destinataria de la notificació. -
/PersonaJuridica/DocumentIdentificatiu/VAT
VAT de l’empresa estrangera destinataria de la notificació. -
/PersonaJuridica/DocumentIdentificatiu/RaoSocial
Raó social de l’empresa. -
/PersonaJuridica/DocumentIdentificatiu/PersonaVinculada
Persona vinculada de l’empresa destinataria
PersonaVinculada
<xs:complexType name="PersonaVinculadaType">
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaFisicaType"/>
<xs:element name="Nom" type="xs:string"/>
<xs:element name="PrimerCognom" type="xs:string"/>
<xs:element name="SegonCognom" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
Persona vinculada amb l’empresa, que podrà accedir a la notificació.
-
/PersonaVinculada/DocumentIdentificatiu/NIF
NIF o NIE de la persona vinculada amb l’empresa receptora de la notificació. -
/PersonaVinculada/DocumentIdentificatiu/PASSPORT
PASSAPORT de la persona vinculada amb l’empresa receptora de la notificació en cas d’empresa estrangera. -
/PersonaVinculada/Nom
Nom de la persona vinculada de l’empresa. -
/PersonaVinculada/PrimerCognom
Primer cognom de la persona vinculada de l’empresa. -
/PersonaVinculada/SegonCognom
Segon cognom de la persona vinculada de l’empresa.
PersonesAvis
<xs:complexType name="PersonesAvis">
<xs:sequence>
<xs:element name="PersonaAvis" type="PersonaAvisType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PersonaAvisType">
<xs:sequence>
<xs:element name="NomComplet" type="xs:string"/>
<xs:element name="BustiaCorreu" type="xs:string"/>
<xs:element name="Telefon" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
-
/PersonesAvis/PersonaAvis/NomComplet
Nom complet de les persones que rebran l’avís. -
/PersonesAvis/PersonaAvis/BustiaCorreu
Bústia de correu de les persones que rebran l’avís. -
/PersonesAvis/PersonaAvis/Telefon
Telèfon de les persones que rebran l’avís.
Etiquetes
<xs:complexType name="EtiquetesType">
<xs:sequence>
<xs:element name="Etiqueta" type="EtiquetaType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="EtiquetaType">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="Idioma" type="Idioma"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
Les etiquetes son un concepte opcional que poden afegir els ens per classificar les notificacions. Els ciutadans poden filtrar per aquest concepte en el portal de la ciutadania. Les etiquetes estan definides prèviament i son les mateixes per tots els ens usuaris del servei. Si addicionalment és necessari crear-ne alguna es pot demanar al Portal de Suport.
-
/Etiquetes/Etiqueta
Nom de l’etiqueta. -
/Etiquetes/Etiqueta@Idioma
Idioma de la etiqueta, els possibles valors són:- ca : Indica que l’idioma de la notificació és català.
- es : Indica que l’idioma de la notificació és castellà.
- oc : Indica que l’idioma de la notificació és aranés.
Petició - PeticioResum
Aquí podeu veure la definició completa del esquema PeticioResum.xsd
Aquesta petició permet recuperar el resum de totes les notificacions de l’usuari té per a ens diferents a l’actual. La definició d’aquesta petició exten la peticioType afegint la sequéncia amb els elements que es descriuen a continuació:
<xs:sequence>
<xs:element name="TipusAcces" type="TipusAccesType" minOccurs="0"/>
<xs:element name="TipusObjecte" type="TipusObjecteType" minOccurs="0"/>
<xs:element name="MostrarTotesNotificacions" type="xs:boolean" default="false" minOccurs="0"/>
</xs:sequence>
-
/PeticioResum/TipusAcces
Indica el nivell d’autenticació requerit al ciutadà per les notificacions que es volen recuperar:- BAIX
- SUBSTANCIAL
- ALT
- PPAS: Paraula de pas. Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
- CERT: Certificat. Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
-
/PeticioResum/TipusObjecte
Indica si es volen recuperar notificacions o comunicacions en la petició de resum:- NOTIFICACIO
- COMUNICACIO
-
/PeticioResum/MostrarTotesNotificacions
Indica si s’han de mostrar o no totes les notificacions per a un usuari concret tenint en compte la combinació del seu NIF amb totes les seves possibles credencials (diferents tlfs/emails). Només aplica amb autenticació amb paraula de pas.
Petició - PeticioEvidencia
Aquí podeu veure la definició completa del esquema PeticioEvidencia.xsd
Aquesta petició permet recuperar les evidencies de diposit i pràctica en format XML així com el justificant en format PDF d’una notificació. La definició d’aquesta petició exten la peticioType afegint la sequéncia amb els elements que es descriuen a continuació:
<xs:sequence>
<xs:element name="IdNotificacio" type="xs:integer"/>
<xs:element name="TipusEvidencia" type="TipusEvidenciaType"/>
<xs:element name="IdiomaEvidenciaPDF" type="Idioma" minOccurs="0" />
</xs:sequence>
-
/PeticioEvidencia/IdNotificacio
Identificador de la notificació per la que es vol recuperar l’evidència. -
/PeticioEvidencia/TipusEvidencia
Indica el tipus d’evidència a recuperar:- XML : Retornarà l’evidència de dipòsit i l’evidència d’acceptació o rebuig de la notificació en format XML
- PDF : Retornarà la URL d’on descarregar el justificant electrònic de validesa en format PDF
-
/PeticioEvidencia/IdiomaEvidenciaPDF
Idioma en el que es retornarà el document d’evidències, només aplica per a peticions amb<Rol>
CIUTADA i quan el camp<TipusEvidencia>
agafa el valor PDF. En caso de no venir informat o de peticions amb<Rol>
EMPLEAT, el PDF es retornarà en català.
Petició - PeticioPracticar
Aquí podeu veure la definició completa del esquema PeticioPracticar.xsd
Aquesta petició permet practicar una notificació per part del destinatari de la mateixa amb els diferents mètodes d’autenticació: paraula de pas, certificat o mitjançant autenticació amb valid. En cas de peticions amb <Rol>
EMPLEAT, permet indicar dades sobre l’acceptació en cas de notificacions acceptades en format paper. La definició d’aquesta petició exten la peticioType afegint la sequéncia amb els elements que es descriuen a continuació:
<xs:sequence>
<xs:element name="IdNotificacio" type="xs:integer"/>
<xs:element name="Operacio" type="OperacioPracticarType"/>
<xs:element name="Decisio" type="DecisioPracticarType"/>
<xs:choice minOccurs="0">
<xs:element name="Signatura">
<xs:annotation>
<xs:documentation>XML de la signatura.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="ds:Signature"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="DadesPracticarCanalPaper" type="DadesPracticarCanalPaperType"/>
</xs:choice>
<xs:element name="CanviCanal" type="DadesCanviCanalType" minOccurs="0">
<xs:annotation>
<xs:documentation>Només aplica per a notificacions en canal "paper", per els quals es vol fer un canvi de canal. En cas de no aplicar, s'ignorarà l'element.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
-
/PeticioPracticar/IdNotificacio
Id de la notificació que es vol practicar. -
/PeticioPracticar/Operacio
Hi ha dues operacions possibles:- OBTENIR_DADES : Serveix per obtenir el resum criptogràfic que haurà de signar el ciutadà, només aplica a operacions autenticades amb certificat.
- SIGNAR : Confirma l’operació d’acceptació o rebuig per part del ciutada.
-
/PeticioPracticar/Decisio
Marca la decisió del ciutadà sobre la notificació, els possibles valors són:- ACCEPTAR
- REBUTJAR
-
/PeticioPracticar/Signatura
Signatura en format XAdES T detached sobre el resum critpogràfic obtingut amb la<Operacio>
OBTENIR_DADES. Només aplica en cas d’autenticació amb certificat. -
/PeticioPracticar/DadesPracticarCanalPaper
En cas de notificacions complementaries, si aquestes s’han practicat en paper però és vol informar de dades relacionades amb aquesta acció, el funcionari amb<Rol>
EMPLEAT ho pot fer mitjançant aquest camp que es descriu en més detall en el següent punt. -
/PeticioPracticar/CanviCanal
En cas de notificacions complementaries, que l’usuari practica de forma activa en digital, pot donar el seu consentiment a ser notificat digitalment les pròperes notificacions així com la bústia i/o correu electrònic on fer les notificacions.
DadesPracticarCanalPaper
<xs:complexType name="DadesPracticarCanalPaperType">
<xs:sequence>
<xs:element name="NIF" type="NIF"/>
<xs:element name="Data" type="xs:dateTime"/>
<xs:element name="Referencia" type="xs:string"/>
</xs:sequence>
</xs:complexType>
-
/DadesPracticarCanalPaper/NIF
NIF del funcionari que informa que la notificació s’ha practicat en format paper. -
/DadesPracticarCanalPaper/Data
Data en la qual el ciutadà va practicar la notificació en format paper. -
/DadesPracticarCanalPaper/Referencia
Camp de text amb la referència de la practica en paper.
CanviCanal
<xs:complexType name="DadesCanviCanalType">
<xs:sequence>
<xs:element name="Canal" type="CanalType"/>
<xs:element name="BustiaCorreu" type="xs:string" minOccurs="0"/>
<xs:element name="Telefon" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
En cas de practicar una notificació complementaria per part del ciutadà, permet indicar a l’usuari de forma opcional si desitja o no rebre les futures notificacions en paper.
-
/CanviCanal/Canal
Indica com vol rebre les futures notificacions:- PAPER : En format paper.
- DIGITAL : En format digital.
Petició - PeticioRecuperarReport
Aquí podeu veure la definició completa del esquema PeticioRecuperarReport.xsd
Aquesta petició permet recuperar el report amb el resum de dades d’una notificació concreta, o el report de totes les notificacions que han canviat d’estat per un departament en una data concreta. La definició d’aquesta petició exten la peticioType afegint la sequéncia amb els elements que es descriuen a continuació:
<xs:sequence>
<xs:choice>
<xs:element name="IdNotificacio" type="xs:integer">
<xs:annotation>
<xs:documentation>Identificador de la notificació a consultar.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DataReport" type="xs:date">
<xs:annotation>
<xs:documentation>Data del dia del qual es vol obtenir el report.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
-
/PeticioRecuperarReport/IdNotificacio
Identificador de la notificació de la que es vol recuperar el report. -
/PeticioRecuperarReport/DataReport
Data del dia del qual es vol obtenir el report. El format de la data ha de ser:yyyy '-' mm '-' dd zzzzzz?
. De manera que unes dates vàlides serien: 2002-10-10+05:00 o 2002-10-09Z o 2002-10-09.
Petició - PeticioConsulta
Aquí podeu veure la definició completa del esquema PeticioConsulta.xsd
Aquesta petició permet consultar les dades d’una notificació concreta. La definició d’aquesta petició exten la peticioType afegint la sequéncia amb els elements que es descriuen a continuació:
<xs:sequence>
<xs:element name="IdNotificacio" type="xs:integer"/>
</xs:sequence>
-
/PeticioConsulta/IdNotificacio
Id de la notificació que es desitja consultar.
Petició - PeticioParaulaPas
Aquí podeu veure la definició completa del esquema PeticioParaulaPas.xsd
Aquesta petició permet obtenir paraules de pas per a que el ciutadà pugui realitzar operacions de consulta/cerca etc., i paraula de pas per a practicar una notificació en concret. La definició d’aquesta petició exten la peticioType afegint la sequéncia amb els elements que es descriuen a continuació:
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element name="IdNotificacio" type="xs:integer"/>
<xs:element name="NumeroRegistre" type="xs:string"/>
</xs:choice>
<xs:element name="DocumentIdentificatiuPersonaFisica" type="DocumentPersonaFisicaType" minOccurs="0"/>
<xs:element name="DocumentIdentificatiuPersonaJuridica" type="DocumentPersonaJuridicaType" minOccurs="0"/>
<xs:element name="DadesEnviament">
<xs:complexType>
<xs:choice>
<xs:element name="BustiaCorreu" type="xs:string"/>
<xs:element name="Telefon" type="xs:string"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:sequence>
-
/PeticioParaulaPas/IdNotificacio
Camp opcional, en cas de voler practicar una notificació en concret, s’ha d’informar el id de la notificació mitjançant aquest camp. -
/PeticioParaulaPas/NumeroRegistre
Igual que en el cas de id notificació, però identificant la notificació mitjançant el seu número de registre. -
/PeticioParaulaPas/DocumentIdentificatiuPersonaFisica
Identificador de la persona física que vol fer l’operació. El tipusDocumentPersonaFisicaType
es descriu amb més detall aquí. -
/PeticioParaulaPas/DocumentIdentificatiuPersonaJuridica
Identificador de la persona jurídica, que vol fer l’operació. El tipusDocumentPersonaJuridicaType
es descriu amb més detall aquí. -
/PeticioParaulaPas/DadesEnviament/BustiaCorreu
Adreça correu electrònic vinculada al destinatari. -
/PeticioParaulaPas/DadesEnviament/Telefon
Número de telèfon mòbil vinculat al destinatari.
Petició - PeticioCerca
Aquí podeu veure la definició completa del esquema PeticioCerca.xsd
Aquesta petició permet realitzar cerques sobre les notificacions aplicant diferents criteris de cerca. A grans trets La definició d’aquesta petició exten la peticioType afegint la sequéncia amb els elements que es descriuen a continuació:
<xs:sequence>
<xs:element name="DadesCerca">
<xs:complexType>
<xs:all>
<xs:element name="CriterisEntitat" minOccurs="0"/>
<xs:element name="CriterisDestinatari" minOccurs="0"/>
<xs:element name="CriterisNotificacio" minOccurs="0"/>
<xs:element name="CriterisData" minOccurs="0">
<xs:element name="Paginacio"/>
</xs:complexType>
</xs:element>
</xs:sequence>
-
/DadesCerca/CriterisEntitat
Criteris de cerca relacionats amb l’entitat que ha emés les notificacions. -
/DadesCerca/CriterisDestinatari
Criteris de cerca relacionats amb els destinataris receptors de les notificacions. -
/DadesCerca/CriterisNotificacio
Criteris de cerca sobre les propietats de les notificacions creades. -
/DadesCerca/CriterisData
Criteris de dates de les diferents etapes del procés de notificació. -
/DadesCerca/Paginacio
Permet específicar la pàginació de la cerca.
CriterisEntitat
<xs:element name="CriterisEntitat" minOccurs="0">
<xs:complexType>
<xs:all>
<xs:element name="CodiOrganisme" type="xs:string" minOccurs="0"/>
<xs:element name="CodiDepartament" type="xs:string" minOccurs="0"/>
<xs:element name="CodiBO" type="xs:string" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
Aquest element permet filtrar les notificacions en funció de les següents elements vinculats a les entitats de les mateixes:
-
/CriterisEntitat/CodiOrganime
Codi ENS de l’organisme emissor de les notificacions. -
/CriterisEntitat/CodiDepartament
Codi ENS del departament emissor de les notificacions. -
/CriterisEntitat/CodiBO
Codi del backoffice emissor de les notificacions.
CriterisDestinatari
<xs:element name="CriterisDestinatari" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element name="Persona" type="FiltrePersonaType"/>
<xs:element name="PersonaFisica" type="FiltrePersonaFisicaType"/>
<xs:element name="PersonaJuridica" type="FiltrePersonaJuridicaType"/>
</xs:choice>
<xs:element name="Idioma" type="Idioma" minOccurs="0"/>
<xs:element name="CanviCanal" type="xs:boolean" minOccurs="0" default="false"/>
</xs:sequence>
</xs:complexType>
</xs:element>
-
/CriterisDestinatari/Persona
Aquest element permet filtrar bàsicament per les bústies de correu i/o telefons dels destinataris de les notificacions, es descriu amb més detall a continuació -
/CriterisDestinatari/PersonaFisica
Aquest element permet cercar per els mateixos camps que el camp anterior/Persona
, i a més a més permet afegir criteris vinculats a la identificació de la persona física destinataria de la notificació. Aquest camp es descriu amb més detall a continuació -
/CriterisDestinatari/PersonaJuridica
Aquest element permet cercar per els mateixos camps que el camp anterior/Persona
, i a més a més permet afegir criteris vinculats a la identificació de la persona jurídica destinataria de la notificació. Aquest camp es descriu amb més detall a continuació -
/CriterisDestinatari/Idioma
Permet cerca les notificacions creades en un idioma concret. Els possibles valors d’aquest camp són:- ca : Indica que l’idioma de les notificacions a cercar és català.
- es : Indica que l’idioma de les notificacions a cercar és castellà.
- oc : Indica que l’idioma de les notificacions a cercar és aranés.
- en : Indica que l’idioma de les notificacions a cercar és anglés.
-
/CriterisDestinatari/CanviCanal
És un booleà que permet indicar si s’han de cercar notificacions que hagin canviat de canal, el camp és opcional i en cas de no venir informat no s’aplicarà cap criteri, es a dir no informar el camp és diferent que informar-lo amb el valorfalse
. Els possibles valors són:- true : Indica explicitament que s’han de cercar notificacions per les quals l’usuari hagi decidit fer un canvi de canal a digital i hagi donat les dades de contacte electrònic.
- false : Indica explicitament que s’han de cercar notificacions per les quals l’usuari no hagi demanat un canvi de canal.
Persona
<xs:complexType name="FiltrePersonaType">
<xs:sequence>
<xs:element name="BustiesCorreu" type="BustiesCorreuType" minOccurs="0"/>
<xs:element name="Telefons" type="TelefonsType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
-
/Persona/BustiesCorreu/BustiaCorreu
Adreça de correu electrònic del destinatari que es vol cercar. Cercarà tots els destinataris llur adreça de correu contingui la cadena passada com a valor per aquest criteri de cerca. -
/Persona/Telefons/Telefon
Número de telèfon del destinatari que es vol cercar. Cercarà tots els destinataris llur número de telèfon contingui la cadena numèrica passada com a valor per aquest criteri de cerca.
PersonaFisica
<xs:complexType name="FiltrePersonaFisicaType">
<xs:complexContent>
<xs:extension base="FiltrePersonaType">
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaFisicaType" minOccurs="0"/>
<xs:element name="Nom" type="xs:string" minOccurs="0"/>
<xs:element name="PrimerCognom" type="xs:string" minOccurs="0"/>
<xs:element name="SegonCognom" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Aquest element extent de FiltrePersonaType
per tant permet cercar per els mateixos camps que l’element FiltrePersonaType
però addicionalment cerca pels següents camps:
-
/PersonaFisica/DocumentIdentificatiu/NIF
NIF/NIE del destinatari de les notificacions a cercar. -
/PersonaFisica/DocumentIdentificatiu/PASSPORT
Passaport del destinatari de les notificacions a cercar. -
/PersonaFisica/Nom
Nom de pila del destinatari de les notificacions a cercar. Cercarà tots els destinataris llur nom contingui la cadena passada com a valor per aquest criteri de cerca. -
/PersonaFisica/PrimerCognom
Primer cognom del destinatari de les notificacions a cercar. Cercarà tots els destinataris llur primer cognom contingui la cadena passada com a valor per quest criteri de cerca. -
/PersonaFisica/SegonCognom
Primer cognom del destinatari de les notificacions a cercar. Cercarà tots els destinataris llur primer cognom contingui la cadena passada com a valor per quest criteri de cerca.
PersonaJuridica
<xs:complexType name="FiltrePersonaJuridicaType">
<xs:complexContent>
<xs:extension base="FiltrePersonaType">
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaJuridicaType" minOccurs="0"/>
<xs:element name="RaoSocial" type="xs:string" minOccurs="0"/>
<xs:element name="PersonaVinculada" type="FiltrePersonaVinculadaType" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Aquest element extent de FiltrePersonaType
per tant permet cercar per els mateixos camps que l’element FiltrePersonaType
però addicionalment cerca pels següents camps:
-
/PersonaJuridica/DocumentIdentificatiu/CIF
NIF d’empresa del destinatari de les notificacions a cercar. -
/PersonaJuridica/DocumentIdentificatiu/VAT
VAT number de l’empresa extrangera del destinatari de les notificacions a cercar. -
/PersonaJuridica/RaoSocial
Raó social, en el cas de perfils de persona jurídica, del destinatari que es vol cercar. Cercarà tots els destinataris que disposin de raó social informada que contingui la cadena passada com a valor per aquest criteri de cerca. -
/PersonaJuridica/PersonaVinculada
Permet filtrar per els mateixos camps queFiltrePersonaFisicaType
(NIF/NIE,passaport,nom i cognoms) però en aquest cas de persona vinculada a la persona jurídica destinataria de la notificació.
CriterisNotificacio
<xs:element name="CriterisNotificacio" minOccurs="0">
<xs:complexType>
<xs:all>
<xs:element name="Titol" type="xs:string" minOccurs="0"/>
<xs:element name="IdNotificacio" type="IntervalValorsEnters" minOccurs="0"/>
<xs:element name="Referencia" type="IntervalValors" minOccurs="0"/>
<xs:element name="NumeroRegistre" type="IntervalValors" minOccurs="0"/>
<xs:element name="Estat" type="xs:string" minOccurs="0"/>
<xs:element name="TipusAcces" type="TipusAccesType" minOccurs="0"/>
<xs:element name="Etiquetes" type="EtiquetesType" minOccurs="0"/>
<xs:element name="AmbitObjecte" type="xs:string" minOccurs="0"/>
<xs:element name="TipusObjecte" type="TipusObjecteType" minOccurs="0"/>
<xs:element name="Canal" type="CanalType" minOccurs="0"/>
<xs:element name="Expedient" type="xs:string" minOccurs="0"/>
<xs:element name="Tramit" type="xs:string" minOccurs="0"/>
<xs:element name="NumeroCas" type="xs:string" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
Aquest element permet filtrar les notificacions en funció d’alguns dels valors informats a les mateixes:
-
/CriterisNotificacio/Titol
Títol de la notificació que es vol cercar. Cercarà totes les notificacions llur títol contingui la cadena passada com a valor per aquest criteri de cerca. -
/CriterisNotificacio/IdNotificacio
Permet indicar un rang de cerca de identificadors de notificacions.-
/CriterisNotificacio/IdNotificacio/ValorSuperior
Valor de tall superior pel interval de cerca. -
/CriterisNotificacio/IdNotificacio/ValorInferior
Valor de tall inferior pel interval de cerca. - En cas de voler buscar per un identificador de notificació en concret, s’ha d’indicar el mateix identificador per el valor inferior i el superior.
-
-
/CriterisNotificacio/Referencia
Permet indicar un rang de cerca dels valors de la referencia, així com un valor absolut del mateix.-
/CriterisNotificacio/Referencia/ValorSuperior
Valor de tall superior pel interval de cerca. -
/CriterisNotificacio/Referencia/ValorInferior
Valor de tall inferior pel interval de cerca. -
/CriterisNotificacio/Referencia/ValorAbsolut
Cadena de text sobre la que es farà la cerca. Aquesta cadena es buscarà com a prefix de qualsevol referència existent, en mode case insensitive. Per example el valor “Ref” retornarà “referència”,”Referència”,”referendum”,”Reflexió” o “referència dia 27/10/2017”.
-
-
/CriterisNotificacio/NumeroRegistre
Número de registre de la notificació a cerca, igual que en els casos anteriors permet indicar un rang de cerca de valors així com un valor absolut del mateix.-
/CriterisNotificacio/NumeroRegistre/ValorSuperior
Valor de tall superior pel interval de cerca. -
/CriterisNotificacio/NumeroRegistre/ValorInferior
Valor de tall inferior pel interval de cerca. -
/CriterisNotificacio/NumeroRegistre/ValorAbsolut
Valor absolut del número de registre.
-
-
/CriterisNotificacio/Estat
Cerca per l’estat en el que es troben les notificacions. Els estats en el que es poden trobar i pels quals es pot cercar són els següents:- Pendent de registrar : La notificació ha entrat al sistema i està pendent de començar a processar-se.
- Registrada: La notificació ha estat registrada. El registre el pot haver fet eNOTUM o bé es pot tractar d’una notificació registrada abans d’haver estat introduïda al sistema.
- Dipositada: La notificació ha estat dipositada i per tant ja és accessible als ciutadans.
- Visualitzada: El ciutadà ha visualitzat la notificació.
- Rebutjada: El ciutadà ha rebutjat la notificació.
- Acceptada: El ciutadà ha acceptat la notificació.
- Rebutjada sense accés: El sistema ha rebutjat la notificació sense que l’usuari l’hagi visualitzat.
- Rebutjada sense acció: El sistema ha rebutjat la notificació però l’usuari havia visualitzat la notificació.
- Error: S’ha produït un error irrecuperable en el tractament de la notificació i el seu processament ha quedat aturat.
Ha més d’aquests estats, existeixen un seguits de meta estats de cerca no directament relacionats amb un estat de la notificació, però que permet cercar per aquest valor:
- Transit: La notificació és troba pendent de la fase de registre.
- Oberta: Es troba en un estat no final, és a dir encara no està practicada per el ciutadà i no ha expirat.
- Rebutjada jurídicament: La notificació ha estat rebutjada, ja sigui per el ciutadà o per el sistema al haver expirat.
- Tancada: Es troba en un estat final, ja sigui per que el ciutadà l’ha practicat o perquè la notifiació ha expirat.
-
/CriterisNotificacio/TipusAcces
Permet cercar per el tipus d’accés configurat a la notificació, els possibles valors són:- BAIX
- SUBSTANCIAL
- ALT
- PPASSuportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
- CERTSuportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
-
/CriterisNotificacio/Etiquetes
Aquest element permet filtrar per una etiqueta arbitrària que s’ha informat a l’hora de crear la notificació, es descriu amb més detall a continuació -
/CriterisNotificacio/AmbitObjecte
Deprecat -
/CriterisNotificacio/TipusObjecte
Tipus de les notificacions a cercar:- NOTIFICACIO
- COMUNICACIO
-
/CriterisNotificacio/Canal
Canal en el que s’ha generat la notificació:- PAPER Retorna només les notificacions complementaries generades en paper.
- DIGITAL Retorna només les notificacions generades unicament en format digital.
-
/CriterisNotificacio/Expedient
Cerca per camp expèdient informat en la creació de la notificació. -
/CriterisNotificacio/Tramit
Cerca per camp tràmit informat en la creació de la notificació. -
/CriterisNotificacio/NumeroCas
Cerca per camp numero de cas informat en la creació de la notificació.
Etiquetes
<xs:complexType name="EtiquetesType">
<xs:sequence>
<xs:element name="Etiqueta" type="EtiquetaType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="EtiquetaType">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="Idioma" type="Idioma"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
Permet cercar les notificacions amb un o varis camps de tipus text amb l’idioma vinculat, amb el mateix contingut que s’ha informat durant la creació de la notificació.
-
/Etiquetes/Etiqueta
Nom de la etiqueta. -
/Etiquestes/Etiqueta@Idioma
Possibles idiomes de l’etiqueta:- ca Català
- es Castellà
- oc Occità
CriterisData
<xs:element name="CriterisData" minOccurs="0">
<xs:complexType>
<xs:all>
<xs:element name="DataRegistre" type="PeriodeDataTemps" minOccurs="0"/>
<xs:element name="DataPublicacio" type="PeriodeDataTemps" minOccurs="0"/>
<xs:element name="DataAcceptacioRebuig" type="PeriodeDataTemps" minOccurs="0"/>
<xs:element name="DataExpiracio" type="PeriodeData" minOccurs="0"/>
<xs:element name="DiesPublicada" type="xs:integer" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
Aquest element permet filtrar per les diferents dates dels estats per els quals passa la notificació.
Tots els elements de cerca per data permeten fer-ho per un interval de temps, indicant una data inferior i una data superior per als diferents criteris tal i com es pot veure pel tipus de l’element:
<xs:complexType name="PeriodeDataTemps">
<xs:all>
<xs:element name="DataInferior" type="xs:dateTime"/>
<xs:element name="DataSuperior" type="xs:dateTime"/>
</xs:all>
</xs:complexType>
<xs:complexType name="PeriodeData">
<xs:all>
<xs:element name="DataInferior" type="xs:date"/>
<xs:element name="DataSuperior" type="xs:date"/>
</xs:all>
</xs:complexType>
-
/CriterisData/DataRegistre
Permet cercar per els intervals de la data de registre. -
/CriterisData/DataPublicacio
Permet cercar per els intervals de la data de publicació. -
/CriterisData/DataAcceptacioRebuig
Permet cercar per els intervals per la data de practicar. -
/CriterisData/DataExpiracio
Permet cercar per els intervals per la data d’expiració. -
/CriterisData/DiesPublicada
Aquest camp a diferència dels altres no funciona per intervals de dates, sinó que mitjançant un número sencer és busquen les notificacions/comunicacions que porten aquell número de dies indicat publicades.
Paginacio
<xs:element name="Paginacio">
<xs:complexType>
<xs:all>
<xs:element name="NumeroPagina">
<xs:simpleType>
<xs:restriction base="xs:integer">
<xs:minExclusive value="0"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="ResultatsPerPagina">
<xs:simpleType>
<xs:restriction base="xs:integer">
<xs:minExclusive value="0"/>
<xs:maxExclusive value="51"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="CampOrdenacio" type="xs:string" minOccurs="0"/>
<xs:element name="SentitOrdenacio" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Ascendent"/>
<xs:enumeration value="Descendent"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
Aquest element permet definir la pàginació de les cerques realitzades.
-
/Paginacio/NumeroPagina
Camp obligatori que indica el número de pagina que retorna la cerca -
/Paginacio/ResultatsPerPagina
Camp obligatori entre 1 i 50 que permet indicar el número de registres que es tornen per cada pàgina. -
/Paginacio/CampOrdenacio
Permet indicar el camp d’ordenació per el qual es retornaran els resultats de la cerca, els valors permesos per a l’ordenació són els següent:- CodiNotificacio
- NumeroRegistre
- DataCreacio
- DataRegistre
- DataPublicacio
- DataVisualitzacio
- DataAcceptarRebutjar
- DataReintent
- Estat
- Titol
-
/Paginacio/SentitOrdenacio
Indica el sentit de l’ordenació dels camps retornats en cas que s’hagi indicat un camp d’ordenació:- Ascendent Sentit d’ordenació ascendent.
- Descendent Sentit d’ordenació descendent.
Resposta
Totes les respostes a les modalitats de consum WS que ofereix eNotum extenen el següent esquema de petició:
<xs:include schemaLocation="Errors.xsd"/>
<xs:complexType name="RespostaType" abstract="true">
</xs:complexType>
Per defecte en aquest cas, RespostaType no incorpora cap element a la petició, però inclou els elements definits a Errors.xsd per tal de que per defecte, totes les respostes puguin incloure l’estructura definida en aquest esquema.
Aquí podeu veure la definició completa del esquema Resposta.xsd
Errors
Aquí podeu veure la definició completa del esquema Errors.xsd
Tot i que l’estructura definida dins de l’esquema Errors.xsd és més complexe, ja que s’utilitza internament per a altres operacions, l’esquema simplificat que s’usarà per afegir a qualsevol resposta en cas de detectar un error serà la següent. Totes les respostes de les modalitats de consum, seran un choice
entre un element amb la seqüencia dels possibles errors o en cas de funcionar correctament els elements propis de la missatgeria d’aquella modalitat de consum:
<xs:complexContent>
<xs:extension base="RespostaType">
<xs:choice>
<xs:element name="Errors" type="ErrorsType" />
<xs:sequence>
<!-- Seqüencia pròpia de la resposta de la modalitat de consum -->
</xs:sequence>
</xs:choice>
</xs:extension>
</xs:complexContent>
L’element <Errors>
serà una seqüencia amb els possibles errors de la petició retornats:
<xs:complexType name="ErrorsType">
<xs:sequence>
<xs:element name="Error" maxOccurs="unbounded">
<xs:complexType>
<xs:all>
<xs:element name="CodiError" type="xs:integer"/>
<xs:element name="MissatgeError" type="xs:string"/>
<xs:element name="DadesNotificacio" type="DadesNotificacioErrorType" minOccurs="0"/>
<xs:element name="FaseError" type="xs:string" minOccurs="0"/>
<xs:element name="TipusError" type="xs:string" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
Com comentavem, a la practica, les respostes de les modalitats de consum amb elements <Error>
, només tindran informat els elements obligatoris: <CodiError>
i <MissatgeError>
. Els tres elements opcionals restants mai vindran informat en aquests casos. Podeu veure els possibles codis i missatges d’error en aquest apartat.
Resposta - RespostaProcessarTramesa
Aquí podeu veure la definició completa del esquema RespostaProcessarTramesa.xsd
Aquest esquema de petició és la resposta a la creació de les notificacions que ens retorna els identificadors per a les notificacions creades, exten el tipus RespostaType i fa un <choice>
que permet triar entre retoranar una llista d’errors produïts durant l’execució de la petició o el següent element amb la resposta de l’operació:
<xs:sequence>
<xs:element name="NotificacionsCreades">
<xs:complexType>
<xs:sequence>
<xs:element name="IdNotificacio" type="xs:integer" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
-
/RespostaProcessarTramesa/NotificacionsCreades/IdNotificacio
Identificador/s de les notificacions creades.
Resposta - RespostaResum
Aquí podeu veure la definició completa del esquema RespostaResum.xsd
Aquesta modalitat de consum permet obtenir un resum de les notificacions pendents (actives i no practicades per un usuari) agrupades per l’ens emissor de la notificació.
<xs:sequence>
<xs:element name="NotificacionsEntitat" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="TotalNotificacionsPendents" type="xs:integer"/>
<xs:element name="NotificacionsPendentsAmbCertificat" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
-
/RespostaResum/NotificacionsEntitat
Resum de notificacions pendents per aquest usuari agrupat per ens, aquest element es descriu amb més detall a continuació. -
/RespostaResum/TotalNotificacionsPendents
Número total de notificacions pendents de l’usuari per a tots els ens. -
/RespostaResum/NotificacionsPendentsAmbCertificat
Indica si hi ha notificacions pendents per ser practicades amb certificat digital per part de l’usuari. Aquest camp només s’informa si la petició de resum de notificacions es fa amb tipus d’accés corresponent a paraula de pas.
NotificacionsEntitat
<xs:element name="NotificacionsEntitat" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:all>
<xs:element name="NomOrganisme" type="xs:string"/>
<xs:element name="CodiOrganisme" type="xs:string"/>
<xs:element name="NomDepartament" type="xs:string"/>
<xs:element name="CodiDepartament" type="xs:string"/>
<xs:element name="UrlAcces" type="xs:anyURI"/>
<xs:element name="NotificacionsPendents" type="xs:integer"/>
</xs:all>
</xs:complexType>
</xs:element>
-
/NotificacionsEntitat/NomOrganisme
Nom de l’organisme al que pertanyen les notificacions pendents. -
/NotificacionsEntitat/CodiOrganisme
Codi de l’organisme al que pertanyen les notificacions pendents. -
/NotificacionsEntitat/NomDepartament
Nom del departament al que pertanyen les notificacions pendents. -
/NotificacionsEntitat/CodiDepartament
Codi del departament al que pertanyen les notificacions pendents. -
/NotificacionsEntitat/UrlAcces
URL d’accés a la web de l’organisme de les notificacions pendents. -
/NotificacionsEntitat/NotificacionsPendents
Numero de notificacions pendents per part de l’usuari en aquesta entitat.
Resposta - RespostaEvidencia
Aquí podeu veure la definició completa del esquema RespostaEvidencia.xsd
Retorna les evidències relacionades amb el procés de la notificació, tant els XML amb l’evidència de dipósit i de practicar, com el PDF amb el justificant del procés de la notificació generat pel sistema.
<xs:sequence>
<xs:element name="IdNotificacio" type="xs:integer" />
<xs:element name="TipusEvidencia" type="TipusEvidenciaType" />
<xs:element name="Diposit" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Evidència del dipòsit de la notificació.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcceptacioRebuig" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Evidència de l'acceptació o rebuig de la notificació.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EvidenciaPDF" type="xs:anyURI" minOccurs="0">
<xs:annotation>
<xs:documentation>URL de descàrrega de l'evidència de la notificacio</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
-
/RespostaEvidenciaType/IdNotificacio
Identificador de la notificació per la qual es retorna l’evidència. -
/RespostaEvidenciaType/TipusEvidencia
Tipus d’evidència retornada:- XML : Per a les evidències de dipósit i practica.
- PDF : Per al justificant en format PDF.
-
/RespostaEvidenciaType/Diposit
Evidència del dipòsit de la notificació. -
/RespostaEvidenciaType/AcceptacioRebuig
Evidència de l’acceptació o rebuig de la notificació. -
/RespostaEvidenciaType/EvidenciaPDF
URL de descàrrega de l’evidència de la notificació en format PDF.
Resposta - RespostaPracticar
Aquí podeu veure la definició completa del esquema RespostaPracticar.xsd
Resposta a les peticions explícites de l’usuari vinculades amb la pràctica de les notificacions.
<xs:sequence>
<xs:element name="IdNotificacio" type="xs:integer"/>
<xs:element name="Operacio" type="OperacioPracticarType"/>
<xs:element name="Decisio" type="DecisioPracticarType"/>
<xs:element name="DadesNotificacio" type="xs:anyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Dades de la notificació per ser mostrades.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DigestDades" type="xs:base64Binary" minOccurs="0">
<xs:annotation>
<xs:documentation>Digest SHA-1 de l'element DadesNotificacio que ha de ser utilitzat per realitzar una signatura XAdES-T Detached.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
-
/RespostaPracticar/IdNotificacio
Identificador de la notificació sobre la que s’està operant. -
/RespostaPracticar/Operacio
Identificador de la operació a realitzar:- OBTENIR_DADES : En el cas de notificacions que s’han de practicar amb certificat és la resposta a la primera crida on es retorna el hash a signar.
- SIGNAR : Indica que l’operació ja era definitiva d’acceptació o rebuig.
-
/RespostaPracticar/Decisio
Indica la decisió que ha prés l’usuari sobre la notificació:- Acceptar : L’usuari a acceptat la notificació.
- Rebutjar : L’usuari a rebutjat la notificació.
-
/RespostaPracticar/DadesNotificacio
Dades de la notificació per ser mostrades. -
/RespostaPracticar/DigestDades
Digest SHA-1 de l’element<DadesNotificacio>
que ha de ser utilitzat per realitzar una signatura XAdES-T Detached, en cas de que la petició<Operacio>OBTENIR_DADES</Operacio>
per a practicar amb certificat.
Resposta - RespostaRecuperarReport
Aquí podeu veure la definició completa del esquema RespostaRecuperarReport.xsd
Retorna el report amb el resum de dades d’una notificació concreta, o el report de totes les notificacions que han canviat d’estat per un departament en una data concreta.
<xs:sequence>
<xs:element name="Report" type="ReportType" minOccurs="0"/>
</xs:sequence>
El detall del ReportType explicitament es troba en el següent esquema
<xs:complexType name="ReportType">
<xs:sequence>
<xs:element name="Capcalera" type="ReportCapcaleraType"/>
<xs:element name="Dades" type="ReportDadesType" maxOccurs="unbounded" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
-
/Report/Capcalera
Capçalera amb el resum de les dades del report. És descriu amb més detall a continuació. -
/Report/Dades
Llistat de dades del report. És descriu amb més detall a continuació.
Capcalera
<xs:complexType name="ReportCapcaleraType">
<xs:sequence>
<xs:element name="CodiOrganisme" type="xs:string"/>
<xs:element name="CodiDepartament" type="xs:string"/>
<xs:element name="NomOrganisme" type="xs:string"/>
<xs:element name="NomDepartament" type="xs:string"/>
<xs:element name="DataInforme" type="xs:date"/>
<xs:element name="TipusInforme" type="TipusInformeType"/>
</xs:sequence>
</xs:complexType>
-
/Capcalera/CodiOrganisme
Codi de l’organisme al que pertanyen les notificacions pendents. -
/Capcalera/CodiDepartament
Codi del departament al que pertanyen les notificacions pendents. -
/Capcalera/NomOrganisme
Nom de l’organisme al que pertanyen les notificacions pendents. -
/Capcalera/NomDepartament
Nom del departament al que pertanyen les notificacions pendents. -
/Capcalera/DataInforme
Data de l’informe. -
/Capcalera/TipusInforme
Tipus d’informe.- Diari
- Online
Dades
Cadascuna de les notificacions retornades per el report retorna un element del tipus ReportDadesType
:
<xs:complexType name="ReportDadesType">
<xs:sequence>
<xs:element name="DadesEstat">
<xs:complexType>
<xs:sequence>
<xs:element name="Estat" type="xs:integer"/>
<xs:element name="DescripcioEstat" type="xs:string"/>
<xs:element name="DataActualitzacio" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="DadesNotificacio">
<xs:complexType>
<xs:sequence>
<xs:element name="Referencia" type="xs:string"/>
<xs:element name="IdNotificacio" type="xs:integer"/>
<xs:element name="TipusObjecte" type="TipusObjecteType"/>
<xs:element name="AmbitObjecte" type="xs:string" minOccurs="0"/>
<xs:element name="DiesExpiracio" type="xs:integer" minOccurs="0"/>
<xs:element name="IdNotificacioEmissor" type="xs:string" minOccurs="0"/>
<xs:element name="Canal" type="CanalType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="DadesRegistre">
<xs:complexType>
<xs:sequence>
<xs:element name="DataRegistre" type="xs:dateTime" nillable="true"/>
<xs:element name="NumeroRegistreSortida" type="xs:string" nillable="true"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="DadesActor">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="PracticadaPaper" type="DadesPracticarCanalPaperType"/>
<xs:element name="PersonaFisica">
<xs:complexType>
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaFisicaType"/>
<xs:element name="NomComplet" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="PersonaJuridica">
<xs:complexType>
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaJuridicaType"/>
<xs:element name="RaoSocial" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
<xs:element name="CanviCanal" type="DadesCanviCanalType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="CodiBackOffice" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
-
/DadesEstat/Estat
Identificador de l’estat de la notificació. -
/DadesEstat/DescripcioEstat
Descripció de l’estat de la notificació. -
/DadesEstat/DataActualitzacio
Data de l’últim canvi d’estat de la notificació -
/DadesNotificacio/Referencia
Referència de la notificació. És el valor que s’ha introduït al crear la notificació. -
/DadesNotificacio/IdNotificacio
Identificador de la notificació. -
/DadesNotificacio/TipusObjecte
Indica si és una notificació o és una comunicació. Els valors que pot retornar són:- NOTIFICACIO
- COMUNICACIO
-
/DadesNotificacio/AmbitObjecte
Deprecat -
/DadesNotificacio/DiesExpiracio
Dies per l’expiració a partir de la data de dipòsit. -
/DadesNotificacio/IdNotificacioEmissor
Codi de la notificació informat per l’emissor de la notificació -
/DadesNotificacio/Canal
Canal per al que s’ha generat la notificació:- PAPER
- DIGITAL
-
/DadesRegistre/DataRegistre
Data en que s’ha registrat la notificació. -
/DadesActor/PracticadaPaper
Retorna la informació vinculada amb la practica de les notificacions en paper en cas que aquestes s’hagin omplert en la petició de practicar, per a més detall es pot veure la definició aqui. -
/DadesActor/PersonaFisica
Dades de la persona que ha causat el canvi d’estat de la notificació. -
/DadesActor/PersonaJuridica
Dades de la persona jurídica que ha causat el canvi d’estat de la notificació. -
/DadesActor/CanviCanal
Retorna la informació vinculada durant la practica de la notificació en cas que s’hagin omplert en la petició de practicar, per a més detall es pot veure la definició aqui. -
/DadesActor/CodiBackOffice
L’identificador del backoffice que ha creat la notificació.
Resposta - RespostaConsulta
Aquí podeu veure la definició completa del esquema RespostaConsulta.xsd
Aquesta modalitat retorna una resposta detallada de totes les dades vinculades amb una notificació concreta.
<xs:sequence>
<xs:element name="IdNotificacio" type="xs:integer"/>
<xs:element name="Emissor" type="EmissorType"/>
<xs:element name="DadesOfici" minOccurs="0"/>
<xs:element name="Documents" type="DocumentsType" minOccurs="0"/>
<xs:element name="DadesNotificacio"/>
<xs:element name="DadesRegistre"/>
<xs:element name="DadesSignador" minOccurs="0"/>
<xs:element name="DadesAvisos" minOccurs="0"/>
<xs:element name="Destinataris" minOccurs="0"/>
</xs:sequence>
-
/RespostaConsulta/IdNotificacio
Identificador de la notificació consultada. -
/RespostaConsulta/Emissor
Dades de l’emissor de la notificació consultada, podeu consultar els detalls d’aquest element aqui -
/RespostaConsulta/DadesOfici
Dades d’ofici de la notficiació consulta, es descriu amb més detall a continuació -
/RespostaConsulta/Documents
Documents vinculats amb la notificació consultada, aquest tipus d’element es descriu amb més detall aqui -
/RespostaConsulta/DadesNotificacio
Dades de la notificació consultada, es descriuen amb més detall a continuació -
/RespostaConsulta/DadesRegistre
Dades de registre de la notificació consultada, es descriuen amb més detall a continuació -
/RespostaConsulta/DadesSignador
Dades del practicant de la notificació consultada, es descriuen amb més detall a continuació -
/RespostaConsulta/DadesAvisos
Dades dels avisos de la notificació consultada, es descriuen amb més detall a continuació -
/RespostaConsulta/Destinataris
Dades dels destinataris de la notificació consultada, es descriuen amb més detall a continuació
DadesOfici
<xs:element name="DadesOfici" minOccurs="0">
<xs:complexType>
<xs:all>
<xs:element name="CosNotificacio" type="xs:string"/>
<xs:element name="PeuRecurs" type="xs:string"/>
<xs:element name="CertificatDigital" type="xs:string" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
-
/DadesOfici/CosNotificacio
Cos de la notificació. -
/DadesOfici/PeuRecurs
Peu de recurs de la notificació. -
/DadesOfici/CertificatDigital
Certificat digital de clau pública amb les que s’han signat les evidències de la notificació.
DadesNotificacio
<xs:element name="DadesNotificacio">
<xs:complexType>
<xs:all>
<xs:element name="Titol" type="xs:string"/>
<xs:element name="Referencia" type="xs:string" minOccurs="0"/>
<xs:element name="DataPublicacio" type="xs:dateTime" nillable="true"/>
<xs:element name="DataAcceptacioRebuig" type="xs:dateTime" nillable="true"/>
<xs:element name="Estat" type="xs:string"/>
<xs:element name="IdEstat" type="xs:integer" nillable="true"/>
<xs:element name="TipusAcces" type="TipusAccesType"/>
<xs:element name="TipusObjecte" type="TipusObjecteType"/>
<xs:element name="AmbitObjecte" type="xs:string" minOccurs="0"/>
<xs:element name="NivellCertificat" type="xs:string" minOccurs="0"/>
<xs:element name="DiesExpiracio" type="xs:integer" minOccurs="0"/>
<xs:element name="Etiquetes" type="EtiquetesType" minOccurs="0"/>
<xs:element name="Canal" type="CanalType" minOccurs="0"/>
<xs:element name="Expedient" type="xs:string" minOccurs="0"/>
<xs:element name="Tramit" type="xs:string" minOccurs="0"/>
<xs:element name="NumeroCas" type="xs:string" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
Dades genèriques retornades en la consulta de la notificació:
-
/DadesNotificacio/Titol
Títol de la notificació. -
/DadesNotificacio/Referencia
Referència de la notificació. Recordem que la referència ha estat donada pel emissor de la notificació en el moment de la seva creació. -
/DadesNotificacio/DataPublicacio
Data en la que la notificació ha estat dipositada. Aquesta data es correspon amb la data de segell de temps de la signatura d’evidència de dipòsit. -
/DadesNotificacio/DataAcceptacioRebuig
Data en que la notificació ha estat acceptada o rebutjada. -
/DadesNotificacio/Estat
Descripció de l’estat en el que es troba la notificació en el moment de la consulta. -
/DadesNotificacio/IdEstat
Identificador de l’estat en el que es troba la notificació en el moment de la consulta. -
/DadesNotificacio/TipusAcces
Nivell d’autenticació requerit al ciutadà a la notificació:- BAIX
- SUBSTANCIAL
- ALT
- PPAS Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
- CERT Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
-
/DadesNotificacio/TipusObjecte
Indica si és una notificació o és una comunicació. Els valors que pot retornar són:- NOTIFICACIO : Notificació.
- COMUNICACIO : Comunicació.
-
/DadesNotificacio/AmbitObjecte
Deprecat -
/DadesNotificacio/NivellCertificat
Indica el nivell de certificat mínim per practicar la notificació. -
/DadesNotificacio/DiesExpiracio
Número de dies fins que expiri la notificació des del moment de la consulta. -
/DadesNotificacio/Etiquetes
Etiqueta de la notificació. Una notificació pot tenir múltiples etiquetes, la definició d’aquest element la trobareu aqui -
/DadesNotificacio/Canal
Canal en el que s’ha generat la notificació:- PAPER : Retorna només les notificacions complementaries generades en paper.
- DIGITAL : Retorna només les notificacions generades unicament en format digital.
-
/DadesNotificacio/Expedient
Expedient amb el que està relacionada la notificació. -
/DadesNotificacio/Tramit
Tràmit amb el que està relacionada la notificació. -
/DadesNotificacio/NumeroCas
Número de cas amb el que està relacionada la notificació.
DadesRegistre
<xs:element name="DadesRegistre">
<xs:complexType>
<xs:all>
<xs:element name="OficinaRegistre" type="xs:string" minOccurs="0"/>
<xs:element name="UnitatOrganitzativa" type="xs:string" minOccurs="0"/>
<xs:element name="NumeroRegistre" type="xs:string" nillable="true"/>
<xs:element name="DataRegistre" type="xs:dateTime" nillable="true"/>
</xs:all>
</xs:complexType>
</xs:element>
-
/DadesRegistre/OficinaRegistre
Oficina on s’ha registrat la notificació. -
/DadesRegistre/UnitatOrganitzativa
Unitat organitzativa de l’oficina de registre. -
/DadesRegistre/NumeroRegistre
Número de registre de la notificació. -
/DadesRegistre/DataRegistre
Data en que s’ha registrat la notificació.
DadesSignador
<xs:element name="DadesSignador" minOccurs="0">
<xs:complexType>
<xs:choice>
<xs:element name="Fisic">
<xs:complexType>
<xs:sequence>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaFisicaType"/>
<xs:element name="NomComplet" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Juridic">
<xs:complexType>
<xs:all>
<xs:element name="DocumentIdentificatiu" type="DocumentPersonaJuridicaType"/>
<xs:element name="RaoSocial" type="xs:string"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
-
/DadesSignador/Fisic/DocumentIdentificatiu
Document identificatiu de la persona física que ha practicat la notificació. El tipusDocumentPersonaFisicaType
es descriu amb més detall aquí. -
/DadesSignador/Fisic/NomComplert
Nom complert de la persona física que ha practicat la notificació. -
/DadesSignador/Juridic/DocumentIdentificatiu
Document identificatiu de la persona jurídica que ha practicat la notificació. El tipusDocumentPersonaJuridicaType
es descriu amb més detall aquí. -
/DadesSignador/Juridic/RaoSocial
Raó social de la persona jurídica que ha practicat la notificació.
DadesAvisos
<xs:element name="DadesAvisos" minOccurs="0">
<xs:complexType>
<xs:all>
<xs:element name="Email">
<xs:complexType>
<xs:all>
<xs:element name="Emissor" type="xs:string"/>
<xs:element name="Assumpte" type="xs:string"/>
<xs:element name="Missatge" type="xs:string"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="SMS">
<xs:complexType>
<xs:all>
<xs:element name="Missatge" type="xs:string" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="DiesAvisos" type="DiesAvisosType"/>
<xs:element name="Idioma" type="Idioma"/>
</xs:all>
</xs:complexType>
</xs:element>
Aquest element conte les dades relacionades amb els avisos que s’han enviat per a aquesta notificació.
-
/DadesAvisos/Email/Emissor
Aquest camp conté l’adreça de correu electrònic que eNotum ha usat com a remitent pels avisos als destinataris de les notificacions. En el moment del enviament eNotum concatenael prefix NORESPONEU_ a aquesta per indicar al destinatari que no s’espera resposta de la seva part. -
/DadesAvisos/Email/Assumpte
Assumpte de l’avís enviat per correu electrònic. -
/DadesAvisos/Email/Missatge
Cos del missatge del correu electrònic enviat. Aquest missatge redactat en text pla, s’ha incrustat en la plantilla html definida al sistema. -
/DadesAvisos/SMS/Missatge
Missatge breu de text enviat al mòbil del destinatari. -
/DadesAvisos/DiesAvisos
Numero de dies a partir del dipòsit en el qual s’envien recordatoris als destinataris i persones d’avis. Hi ha un límit establert a nivell de plataforma, per al qual es pot enviar un màxim del 40% d’avisos durant el temps de vida de la notificació. És a dir, si per exemple la notificació te una vida de 20 díes, com a màxim es podran indicar 8 dies d’avisos (8 avisos/20 dies=0,4
). -
/DadesAvisos/Idioma
Identificador de l’idioma en que el destinatari ha rebut els avisos.
Destinataris
<xs:element name="Destinataris" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="Destinatari" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name="PersonaFisica" type="PersonaFisicaType"/>
<xs:element name="PersonaJuridica" type="PersonaJuridicaType"/>
</xs:choice>
<xs:element name="Idioma" type="Idioma" minOccurs="0"/>
<xs:element name="HaSignat" type="xs:boolean"/>
<xs:element name="CanviCanal" type="DadesCanviCanalType" minOccurs="0"/>
<xs:element name="Obligat" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Aquest element descriu la seqüència de destinataris d’aquesta notificació.
-
/Destinataris/Destinatari/PersonaFisica
Dades de la persona física destinataria de la notificació. El tipusPersonaFisicaType
està descrit amb més detall aqui. -
/Destinataris/Destinatari/PersonaJuridica
Dades de la persona jurídica destinataria de la notificació. El tipusPersonaJuridicaType
està descrit amb més detall aqui. -
/Destinataris/Destinatari/Idioma
Idioma en que el destinatari ha rebut l’avís de la notificació. -
/Destinataris/Destinatari/HaSignat
Atribut booleà que indica si el destinatari ha realitzat l’acció d’acceptació o rebuig de la notificació. -
/Destinataris/Destinatari/CanviCanal
Dades relacionades amb el canvi de canal, en cas que la notificació fos en format paper i el destinatari hagués aportat informació al respecte de canviar el format de recepció de les notificacions (només aplica a persones físiques ja que les persones jurídiques només poden rebre notificacions en format digital). El tipusDadesCanviCanalType
està descrit amb més detall aquí -
/Destinataris/Destinatari/Obligat
Retorna opcionalment el valor d’aquest camp només en el cas que hagi estat informat a la petició. És a dir, independentment del valor “real” només és retornaràtrue
|false
en cas que s’hagi informat a la petició de ProcessarTramesa.
Resposta - RespostaParaulaPas
Aquí podeu veure la definició completa del esquema RespostaParaulaPas.xsd
<xs:sequence>
<xs:element name="IdParaulaPas" type="xs:string"/>
<xs:element name="IdNotificacio" type="xs:integer" minOccurs="0"/>
</xs:sequence>
-
/RespostaParaulaPas/IdParaulaPas
Identificador de la paraula de pas. -
/RespostaParaulaPas/IdNotificacio
Identificador de la notificació.
Resposta - RespostaCerca
Aquí podeu veure la definició completa del esquema RespostaCerca.xsd
Retorna un seguit de notificacions que acompleixen els criteris de cerca fets en la petició.
<xs:sequence>
<xs:element name="Resultats" type="ResultatsType" />
<xs:element name="DadesPaginacio" type="DadesPaginacioType" />
</xs:sequence>
-
/RespostaCerca/Resultats
Conté la seqüència de notificacions que compleixen el criteri de cerca. L’element es descriu amb més detall aquí -
/RespostaCerca/DadesPaginacio
Conté les dades de paginació dels resultats de cerca. L’element es descriu amb més detall aquí
Resultats
<xs:complexType name="ResultatsType">
<xs:sequence>
<xs:element name="Notificacio" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="TipusObjecte" type="TipusObjecteType" />
<xs:element name="IdNotificacio" type="xs:integer" />
<xs:element name="Referencia" type="xs:string" />
<xs:element name="Titol" type="xs:string" />
<xs:element name="DataCreacio" type="xs:dateTime" nillable="true" />
<xs:element name="DadesRegistre">
<xs:complexType>
<xs:all>
<xs:element name="DataRegistre" type="xs:dateTime" nillable="true" />
<xs:element name="NumeroRegistre" type="xs:string" nillable="true" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="DataPublicacio" type="xs:dateTime" nillable="true" />
<xs:element name="DataVisualitzacio" type="xs:dateTime" nillable="true" />
<xs:element name="DataAcceptarRebutjar" type="xs:dateTime" nillable="true" />
<xs:element name="Estat" type="xs:string" />
<xs:element name="IdEstat" type="xs:integer" />
<xs:element name="DiesExpiracio" type="xs:integer" nillable="true" minOccurs="0"/>
<xs:element name="DiesResten" type="xs:integer" nillable="true" minOccurs="0" />
<xs:element name="DataLimit" type="xs:dateTime" nillable="true" minOccurs="0" />
<xs:element name="TipusAcces" type="TipusAccesType" />
<xs:element name="AmbitObjecte" type="xs:string" minOccurs="0" />
<xs:element name="Idioma" type="Idioma" />
<xs:element name="CodiDepartament" type="xs:string" nillable="true" />
<xs:element name="NomDepartament" type="xs:string" nillable="true" />
<xs:element name="CodiBO" type="xs:string" nillable="true" minOccurs="0" />
<xs:element name="NumeroReintents" type="xs:integer" nillable="true" />
<xs:element name="DataReintent" type="xs:dateTime" nillable="true" />
<xs:element name="BustiesCorreu" type="BustiesCorreuType" nillable="true" minOccurs="0" />
<xs:element name="Telefons" type="TelefonsType" nillable="true" minOccurs="0" />
<xs:element name="Consultada" type="ConsultadaType" minOccurs="0"/>
<xs:element name="Canal" type="CanalType" minOccurs="0"/>
<xs:element name="Expedient" type="xs:string" minOccurs="0"/>
<xs:element name="Tramit" type="xs:string" minOccurs="0"/>
<xs:element name="NumeroCas" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
-
/Resultats/Notificacio/TipusObjecte
Indica si és una notificació o és una comunicació. Els valors que pot retornar són- NOTIFICACIO
- COMUNICACIO
-
/Resultats/Notificacio/IdNotificacio
Identificador de BD de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/Referencia
Referència de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/Titol
Títol de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DataCreacio
Data d’entrada de la notificació al sistema dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DadesRegistre/NumeroRegistre
Número d’assentament de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DadesRegistre/DataRegistre
Data d’assentament de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DataPublicacio
Data de dipòsit de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DataVisualitzacio
Data en que la notificació ha estat visualitzada pel ciutadà dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DataAcceptarRebutjar
Data d’acceptació o rebuig de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/Estat
Descripció de l’estat de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/IdEstat
Identificador de l’estat de la notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DiesExpiracio
Dies que falten fins que expiri la notificació. -
/Resultats/Notificacio/DiesResten
Número de dies que resten fins que la notificació expiri. Aquest valor no vindrà informat en el cas que la notificació encara no estigui dipositada. -
/Resultats/Notificacio/DataLimit
Data en que expirarà la notificació. Pot ser que aquest camp no vingui informat si la notificació no ha estat dipositada. -
/Resultats/Notificacio/TipusAcces
Modalitat d’accés a la notificació per part del ciutadà. Els possibles valors són:- BAIX
- SUBSTANCIAL
- ALT
- PPAS: Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
- CERT: Suportat temporalment per compatibilitat amb versions anteriors. S’eliminarà en properes versions.
-
/Resultats/Notificacio/AmbitObjecte
Deprecat -
/Resultats/Notificacio/Idioma
Idioma del contingut de la notificació. -
/Resultats/Notificacio/CodiDepartament
Identificador del departament que ha creat la notificació. -
/Resultats/Notificacio/NomDepartament
Nom del departament que ha creat la notificació. -
/Resultats/Notificacio/CodiBO
Identificador del BackOffice que ha creat la notificació. -
/Resultats/Notificacio/NumeroReintents
Número de cops que s’ha intentat executar la fase del motor per aquesta notificació dins de la llista de resultats obtinguts de la cerca. -
/Resultats/Notificacio/DataReintent
Data en que es reintentarà executar la fase del motor per aquesta notificació o la data de la última execució de la fase del motor pel cas en que la notificació estigui en estat error. -
/Resultats/Notificacio/Busties
Element que encapsula fins a 5 elements<Bustia>
que contenen les adreces dels correus electrònics on s’han enviat els avisos de notificació al seu destinatari. -
/Resultats/Notificacio/Telefons
Element que encapsula fins a 5 elements<Telefon>
que contenen els números de telèfon mòbil als que s’ha enviat els avisos de notificació. -
/Resultats/Notificacio/Consultada
Indica si la notificació ha estat consultada. -
/Resultats/Notificacio/Canal
Indica el tipus de canal per al qual s’ha enviat la notificació. Els possibles valors són:- DIGITAL
- PAPER
-
/Resultats/Notificacio/Expedient
Identificador de l’expedient informat a la notificació durant la seva creació. -
/Resultats/Notificacio/Tramit
Identificador del tràmit informat a la notificació durant la seva creació. -
/Resultats/Notificacio/NumeroCas
Identificador del número de cas informat a la notificació durant la seva creació.
DadesPaginacio
<xs:complexType name="DadesPaginacioType">
<xs:sequence>
<xs:element name="NumeroPagina" type="xs:integer" />
<xs:element name="ResultatsPerPagina" type="xs:integer" />
<xs:element name="TotalResultats" type="xs:integer" />
<xs:element name="TotalPagines" type="xs:integer" />
</xs:sequence>
</xs:complexType>
-
/DadesPaginacio/NumeroPagina
Número de pàgina actual del llistat de resultats de la cerca. -
/DadesPaginacio/ResultatsPerPagina
Número de registres retornats per pàgina. -
/DadesPaginacio/TotalResultats
Número total de resultats de la cerca. -
/DadesPaginacio/TotalPagines
Número total de pàgines de la cerca.
Tipus comuns
Hi ha una serie d’elements comuns entre les diferents operacions. A continuació se’n detalla la definició:
DocumentPersonaFisicaType
El tipus DocumentPersonaFisicaType identifica una persona física mitjançant el seu NIF/NIE o el seu passaport
<xs:complexType name="DocumentPersonaFisicaType">
<xs:choice>
<xs:element name="NIF" type="NIF"/>
<xs:element name="PASSAPORT" type="Passaport"/>
</xs:choice>
</xs:complexType>
<xs:simpleType name="NIF">
<xs:restriction base="xs:string">
<xs:pattern value="[XYZKLM]?[0-9]{7,8}[A-Z]"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="Passaport">
<xs:simpleContent>
<xs:extension base="PassaportType">
<xs:attribute name="Pais" type="ISO3166Code2Digits"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:simpleType name="PassaportType">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Z0-9]{1,9}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ISO3166Code2Digits">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Z][A-Z]"/>
</xs:restriction>
</xs:simpleType>
-
NIF
NIF o NIE de la persona física. A nivell de missatgeria es valida la següent expressió regular[XYZKLM]?[0-9]{7,8}[A-Z]
. A nivell de servidor també es comprova el codi de control del mateix. -
PASSAPORT
Passaport de la persona física. A nivell de missatgeria es valida la següent expressió regular[A-Z0-9]{1,9}
. No confondre amb l’identificador nacional que apareix en els passaports i que pot ser de diferent longitud. -
PASSAPORT/Pais
País d’emissió del passaport en format ISO 3166-1 alfa-2. Inicialment és opcional però un futur serà obligatori.
DocumentPersonaJuridicaType
El tipus DocumentPersonaJuridicaType identificar una persona jurídica mitjançant el seu NIF d’empresa o el seu VAT number en cas d’empreses extrangeres.
<xs:complexType name="DocumentPersonaJuridicaType">
<xs:choice>
<xs:element name="CIF" type="CIF"/>
<xs:element name="VAT" type="VAT"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="VAT">
<xs:simpleContent>
<xs:extension base="VATType">
<xs:attribute name="Pais" type="ISO3166Code2Digits"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:simpleType name="VATType">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Z0-9]{1,50}"/>
</xs:restriction>
</xs:simpleType>
-
CIF
NIF d’empresa de la persona jurídica. A nivell de missatgeria es valida la següent expressió regular[A-Z][0-9]{7}[A-J,0-9]
. A nivell de servidor també es comprova el digit de control. -
VAT
VAT number de l’empresa extrangera de la persona jurídica. A nivell de missatgeria es valida la següent expressió regular[A-Z0-9]{1,50]
. De manera que s’han d’informar sense espais, guions, punts, etc. En cas d’informar l’atributPais
es validarà el format del contingut del camp en funció del país indicat. -
VAT/Pais
País de l’empresa extrangera en format ISO 3166-1 alfa-2. Inicialment és opcional però un futur serà obligatori.
4. Codis d’error d’eNotum
Codi d’error | Descripció |
---|---|
101 | El xml no compleix l’esquema |
102 | Paràmetre deprecat |
103 | Error executant l’operació |
104 | L’organisme autoritzat per la PCI no té permisos sobre l’organisme especificat en la petició d’eNotum |
501 | Operació desconeguda/no implementada |
502 | Aquest rol no té privilegis suficients per realitzar aquesta operació |
503 | El tipus d’accés no està autoritzat per aquest tipus de petició |
504 | La entitat especificada no existeix |
505 | La entitat especificada no està autoritzada per informar documents a través de URL |
613 | El format de l’adreça de la bústia de correu especificada no és correcte |
614 | El CIF especificat no és correcte |
615 | El NIF especificat no és correcte |
616 | El Passaport especificat no és correcte |
617 | El país del Passaport especificat és obligatori |
618 | El país del Passaport especificat no és vàlid |
619 | El VAT especificat no és correcte |
620 | El país del VAT especificat és obligatori |
621 | El país del VAT especificat no és vàlid |
627 | El paràmetre CodiDepartament és obligatori |
629 | L’identificador de la notificació de l’emissor és obligatori |
630 | El format del número de telèfon especificat no és correcte |
701 | És obligatori com a mínim un mètode de contacte per al destinatari: e-mail o telèfon. |
702 | El nom del destinatari és obligatori |
703 | El primer cognom del destinatari és obligatori |
705 | La raó social del destinatari és obligatori |
706 | Les persones jurídiques no poden tenir el camp obligat a false |
707 | És obligatori com a mínim un mètode de contacte per a la persona d’avís: e-mail o telèfon. |
708 | Només pot haver-hi un destinatari titular per notificació |
713 | És obligatori omplir un dels camps CIF o NIF |
716 | La data de registre no pot ser anterior a 60 dies ni posterior al moment actual |
717 | El número de registre de la notificació és obligatori |
718 | La referència de la notificació és obligatòria |
719 | El destinatari de la notificació no es correspon amb el perfil especificat |
720 | No es permet enviar una notificació electrònica a l’ens especificat a través de la plataforma eNOTUM degut a la naturalesa del mateix. Cal que la redirigiu a través de la plataforma corresponent en funció de la seva naturalesa |
721 | La referència de la notificació ha de tenir entre 3 i 250 caràcters |
723 | Les comunicacions no poden ser amb Canal PAPER |
725 | El nom del destinatari no pot excedir els 50 caràcters |
726 | El primer cognom del destinatari no pot excedir els 50 caràcters |
727 | El segon cognom del destinatari no pot excedir els 50 caràcters |
728 | El codi d’expedient de la notificació ha de tenir entre 3 i 50 caràcters |
729 | El codi d’expedient de la notificació ha de tenir entre 3 i 34 caràcters |
730 | El tramit de la notificació ha de tenir entre 3 i 50 caràcters |
911 | El tipus de document enviat no està permès |
912 | El document especificat no existeix |
913 | El paràmetre codi de pujada del document es obligatori |
914 | El document supera la mida màxima establerta |
918 | El paràmetre hash del document és obligatori |
920 | El paràmetre URLDescarrega del document té un format erroni |
921 | No s’ha pogut descarregar el fitxer indicat al paràmetre URLDescarrega |
922 | Ha d’haver un únic document amb el tipus ‘Resolució’ |
923 | El paràmetre hash del document no coincideix amb el hash del document proporcionat |
924 | El document supera la mida màxima establerta per a estar dins del missatge, provi d’adjuntar el document per una altre via |
925 | El nom del document no pot excedir els 100 caràcters |
926 | El document PDF d’evidència no es pot generar per a l’idioma especificat |
1003 | El cos de la notificació en cas de estar informat no pot ser buït |
1005 | El paràmetre títol ha de tenir entre 3 i 100 caràcters |
1006 | El paràmetre títol es obligatori |
1007 | S’ha excedit el màxim de dies d’expiració |
1008 | S’ha excedit el màxim de recordatoris |
1010 | La notificació indicada no existeix |
1011 | No es poden indicar simultàniament els paràmetres SenseRegistre i DadesRegistre |
1012 | El paràmetre SenseRegistre només s’admet per a comunicacions |
1015 | La notificació indicada no és visible des de l’entitat consultadora |
1016 | El paràmetre de tipus de perfil de consulta del resum de notificacions és obligatori si s’especifiquen el NIF i el CIF |
1018 | El paràmetre bústia de correu o telèfon mòbil és obligatori |
1019 | El paràmetre identificador de paraula de pas és obligatori |
1020 | El paràmetre paraula de pas és obligatori |
1022 | Error generant paraula de pas |
1023 | Error validant paraula de pas |
1024 | Paraula de pas no registrada |
1025 | Paraula de pas incorrecta |
1026 | Paraula de pas caducada |
1027 | Paraula de pas no associada a eNOTUM |
1028 | Element DadesParaulaPas es obligatori per aquesta operació |
1030 | La paraula de pas no s’ha d’informar en aquesta operació |
1031 | L’identificador de la paraula de pas no s’ha d’informar en aquesta operació |
1032 | La notificació no és accessible amb nivell d’accés baix |
1033 | El ciutadà no té notificacions |
1034 | El certificat del ciutadà no és vàlid |
1035 | Error validant el certificat digital |
1036 | El paràmetre NivellCertificat no té un valor vàlid |
1037 | El certificat no té les dades necessàries per aquest perfil |
1038 | La tramesa conté notificacions i comunicacions. Només en pot contenir d’un tipus |
1039 | La tramesa conté documents amb accents al nom |
1040 | El ciutadà no té notificacions accessibles amb paraula de pas |
1041 | El canvi de mitja només és aplicable a les notificacions generades en paper |
1042 | Si es vol realitzar un canvi de mitja a via digital és obligatori informar un email i/o telefon |
1043 | Les persones jurídiques no poden realitzar un canvi de mitja |
1044 | El destinatari està obligat a rebre notificacions en canal PAPER |
1045 | La signatura realitzada amb valid no és de segon factor |
1046 | La signatura no és valida |
1047 | L’usuari no està autoritzat per a practicar la notificació |
1048 | És obligatori informar l’element IdAutenticacio |
1049 | La notificació no és accessible amb nivell d’accés substancial |
1050 | L’L’Access Token de VALId informat no és vàlid |
1051 | S’ha produit un error recuperant informació de VALId |
1060 | El certificat del ciutadà no és d’un tipus vàlid |
1100 | L’etiqueta indicada no existeix |
1200 | L’àmbit de la notificació no existeix |
1201 | L’àmbit de la notificació no està actiu |
1202 | El tipus de la notificació no és notificació |
1401 | Error validant la signatura electrònica |
1403 | El nivell del certificat és insuficient per practicar la notificació |
3001 | Element Tramesa és obligatori per aquesta operació |
3002 | El paràmetre CodiNotificacio és obligatori per aquesta operació |
3003 | La notificació ja ha estat acceptada o rebutjada amb anterioritat |
3004 | La notificació està en estat d’error |
3005 | La notificació ha d’estar en estat publicada |
3006 | El paràmetre dades signatura és obligatori |
3007 | El paràmetre dades signades és obligatori |
3008 | Element DadesSignatura és obligatori per aquesta operació |
3009 | Element DadesCerca és obligatori per aquesta operació |
3010 | La notificació no pertany al destinatari |
3011 | Error signant la notificació |
3014 | Element PersonaFisica i PersonaJuridica de CriterisDestinatari no ha de venir informat per al Rol ciutadà per aquesta operació |
3015 | El paràmetre data del report és obligatori |
3016 | El paràmetre CampOrdenacio no té un valor vàlid |
3020 | L’estat de la notificació no permet generar les evidències |
3021 | El Backoffice informat no existeix |
3035 | La notificació no ha estat practicada |
3036 | En peticions de resum on no s’informa el codi d’organisme i departament el backoffice s’ha d’informar correctament |
3037 | La notificació ha estat rebutjada automaticament pel sistema amb anterioritat |
3038 | La notificació ha estat anul·lada amb anterioritat |
3101 | Element DadesConsulta és obligatori per aquesta operació |
3102 | Element ResumNotificacions és obligatori per aquesta operació |
3103 | El paràmetre de cerca Estat no té un valor vàlid |
3104 | L’evidència en format PDF encara no ha estat generada |
3105 | El paràmetre MostraTotes no es pot utilitzar en les cerques amb Rol EMPLEAT |
3106 | El paràmetre MostraTotes no es compatible amb el filtrat per criteris de destinatari |
3107 | No existeixen credencials per les dades especificades |
3108 | El codi d’organisme no es correspón amb l’indicat |
3200 | El tipus de document identificatiu a retornar no està suportat per la versió de missatgeria utilitzada |
3201 | Les dades del report a retornar no són compatibles amb la versió de missatgeria utilitzada. Faci la petició amb la versió de la missatgeria >= 3.2 |