ERES 2.0: Document d’integració · 2020. 9. 28. · ERES 2.0 – Document d’integració 2 de...

ERES 2.0 – Document d’integració 1 de 169

ERES 2.0: Document d’integració


Control documental

Estat formal Elaborat per:

Aprovat per:

Data de creació 16/07/2020

Control de versions Data: 06/08/2020

Descripció: Incorporació de nous requisits previs

Nivell accés informació

pública

Títol ERES 2.0: Document d’integració

Fitxer ERES2.0_DI_06082020.docx

Control de còpies Només les còpies disponibles al web del Consorci AOC (www.aoc.cat) garanteixen l’actualització dels documents. Tota còpia impresa o desada en ubicacions diferents es consideraran còpies no controlades.

Drets d’autor

Aquesta obra està subjecta a una llicència Reconeixement-No comercial-Sense obres derivades 3.0 Espanya de Creative Commons. Per veure'n una còpia, visiteu http://creativecommons.org/licenses/by-nc-sa/3.0/deed.ca o envieu una carta a Creative Commons, 171 Second Street, Suite 300, San Francisco, California 94105, USA.

http://www.aoc.cat/

http://creativecommons.org/licenses/by-nc-sa/3.0/deed.ca




1 Índex

CONTROL DOCUMENTAL .................................................................................................................... 2

1 ÍNDEX .......................................................................................................................................... 3

2 METADADES ................................................................................................................................ 7

2.1 TAULA DE CONTROL............................................................................................................................... 7

2.2 REVISIONS ........................................................................................................................................... 7

3 INTRODUCCIÓ ............................................................................................................................. 8

3.1 OBJECTIUS ........................................................................................................................................... 8

3.2 AUDIÈNCIA .......................................................................................................................................... 8

4 CONSIDERACIONS GENERALS ....................................................................................................... 8

4.1 SWAGGER ............................................................................................................................................ 8

4.2 DADES GENERALS .................................................................................................................................. 9

5 RECURSOS DE LA API.................................................................................................................. 10

5.1 CARRERS ........................................................................................................................................... 11

5.1.1 Operacions .............................................................................................................................. 11

5.1.2 Alta o modificació ................................................................................................................... 11

5.1.3 Recuperar un Carrer ................................................................................................................ 14

5.1.4 Cercar Carrers ......................................................................................................................... 16

5.1.5 Modificar Partícules dels Carrers. PARAMETRES .................................................................... 18

5.1.6 Recuperar Partícules dels Carrers ........................................................................................... 19

5.1.7 Modificar Sigles dels Carrers ................................................................................................... 20

5.1.8 Recuperar Sigles dels Carrers .................................................................................................. 22

5.2 DOMICILIS ......................................................................................................................................... 24

5.2.1 Operacions .............................................................................................................................. 24

5.2.2 Alta. PARAMETRES EXEMPLE .................................................................................................. 24

5.2.3 Recuperar un Domicili ............................................................................................................. 28

5.2.4 Cercar Domicilis ....................................................................................................................... 30

5.2.5 Recuperar les Persones d’un Domicili ..................................................................................... 34

5.2.6 Recuperar Domicilis d’un Territori .......................................................................................... 37

5.2.7 Recuperar Tipus de Domicilis .................................................................................................. 38

5.2.8 Recuperar Tipus de Locals ....................................................................................................... 39

5.3 PERSONES ......................................................................................................................................... 42

5.3.1 Operacions .............................................................................................................................. 42

5.3.2 Modificar ................................................................................................................................. 43


5.3.3 Creacio simple ......................................................................................................................... 49

5.3.4 Recuperar una Persones.......................................................................................................... 50

5.3.5 Cercar Persones ....................................................................................................................... 53

5.3.6 Recuperar les últimes Persones modificades .......................................................................... 57

5.3.7 Indicador de Persona Física ..................................................................................................... 58

5.3.8 Crear Partícules de cognoms ................................................................................................... 59

5.3.9 Recuperar Partícules de cognoms ........................................................................................... 61

5.3.10 Recuperar tots els Domicilis .................................................................................................... 62

5.3.11 Recuperar un Domicili ............................................................................................................. 65

5.3.12 Recuperar el Domicili per defecte ........................................................................................... 67

5.3.13 Recuperar els Domicilis Bancaris............................................................................................. 70

5.3.14 Recuperar les Notícies ............................................................................................................. 71

5.3.15 Recuperar els Representants .................................................................................................. 72

5.3.16 Recuperar Tipus de Persones .................................................................................................. 74

5.4 REGISTRE ........................................................................................................................................... 77

5.4.1 Operacions .............................................................................................................................. 77

5.4.2 Duplicar ................................................................................................................................... 77

5.4.3 Reservar .................................................................................................................................. 79

5.4.4 Recuperar Àrees ...................................................................................................................... 81

5.4.5 Recuperara Departaments ...................................................................................................... 82

5.4.6 Recuperar un Assumpte .......................................................................................................... 84

5.4.7 Recuperar Assumptes per Departament ................................................................................. 85

5.4.8 Recuperar Extractes ................................................................................................................ 87

5.4.9 Recuperar Idiomes .................................................................................................................. 88

5.4.10 Recuperar Tipus Transport ...................................................................................................... 89

5.5 REGISTRE D’ENTRADA .......................................................................................................................... 91

5.5.1 Operacions .............................................................................................................................. 91

5.5.2 Crear o modificar .................................................................................................................... 91

5.5.3 Creació simple. ........................................................................................................................ 98

5.5.4 Modificació simple ................................................................................................................ 101

5.5.5 Recuperar un Registre ........................................................................................................... 105

5.5.6 Cercar Registres. TODO ......................................................................................................... 109

5.5.7 Relacionar Expedient. TODO ................................................................................................. 110

5.5.8 Recuperar Expedient relacionat. TODO ................................................................................ 110

5.5.9 Assignar Interessat. TODO .................................................................................................... 111

5.5.10 Recuperar Documents relacionats ........................................................................................ 111


5.5.11 Recupera Entrades relacionades ........................................................................................... 113

5.5.12 Recupera Sortides relacionades ............................................................................................ 114

5.6 REGISTRE DE SORTIDA ........................................................................................................................ 116

5.6.1 Operacions ............................................................................................................................ 116

5.6.2 Crear o modificar. TODO ....................................................................................................... 116

5.6.3 Creació simple. TODO ........................................................................................................... 117

5.6.4 Modificació simple. TODO ..................................................................................................... 117

5.6.5 Cercar Registres. TODO ......................................................................................................... 118

5.6.6 Assignar Interessat. TODO .................................................................................................... 118

5.6.7 Recuperar Documents relacionats. TODO............................................................................. 119

5.6.8 Recuperar Entrades relacionades. TODO .............................................................................. 119

5.6.9 Recuperar Sortides relacionades. TODO ............................................................................... 120

5.7 EXPEDIENTS ..................................................................................................................................... 121

5.7.1 Operacions ............................................................................................................................ 121

5.7.2 Creació simple ....................................................................................................................... 121

5.7.3 Modificació simple ................................................................................................................ 122

5.7.4 Recuperar un Expedient ........................................................................................................ 127

5.7.5 Modificar o afegir dades addicionals .................................................................................... 132

5.7.6 Esborrar dades addicionals ................................................................................................... 133

5.7.7 Obtenir dades addicionals..................................................................................................... 134

5.8 DOCUMENTS .................................................................................................................................... 135

5.8.1 Operacions ............................................................................................................................ 135

5.8.2 Guardar un Document .......................................................................................................... 135

5.8.3 Obtenir un Document ............................................................................................................ 137

5.8.4 Modificar la informació associada ........................................................................................ 137

5.8.5 Obtenir la informació associada ........................................................................................... 139

5.8.6 Modificar o afegir dades addicionals .................................................................................... 141

5.8.7 Esborrar dades addicionals ................................................................................................... 142

5.8.8 Obtenir la informació associada a partir de l’identificador de Document. ........................... 142

5.9 ORGANIGRAMA ................................................................................................................................ 144

5.9.1 Operacions ............................................................................................................................ 144

5.9.2 Crea o modifica una àrea. ..................................................................................................... 145

5.9.3 Recupera totes les àrees. ...................................................................................................... 146

5.9.4 Recupera una àrea. ............................................................................................................... 147

5.9.5 Elimina una àrea. .................................................................................................................. 148

5.9.6 Crea o modifica un departament. ......................................................................................... 149


5.9.7 Recupera tots els departaments d’una àrea. ........................................................................ 151

5.9.8 Recupera un departament. ................................................................................................... 153

5.9.9 Elimina un departament. ...................................................................................................... 154

5.9.10 Crea o modifica un grup de treball. ...................................................................................... 156

5.9.11 Recupera tots els grups de treball d’un departments. .......................................................... 157

5.9.12 Recupera un grup de treball. ................................................................................................. 159

5.9.13 Elimina un grup de treball. .................................................................................................... 161

5.9.14 Crea o modifica un assumpte. ............................................................................................... 162

5.9.15 Recupera tots els assumptes ................................................................................................. 163

5.9.16 Recupera un assumpte. ......................................................................................................... 166

5.9.17 Elimina un assumpte. ............................................................................................................ 168

2 Metadades

2.1 Taula de control

Empresa

Projecte AOC

Autor

Data crecació 19/5/2020

Data entrega

Aprovat per

Data aprovació

2.2 Revisions

Autor

Data revisió 06/08/2020

Descripció

Aprovat per

Data aprovació

Ref.: ERES 2.0 – SERVEIS REST | Versió: 1.1

ERES 2.0: Document d’integracióveis REST 15/07/2020

Pàg. 8/169

3 Introducció Per millorar la integració de la aplicació Genesys amb altres entrorns, s’ha desenvolupat una API amb arquitectura REST.

3.1 Objectius

Aquest document té com objectiu proporcionar una guia tècnica completa per la utilització de la API REST de l’aplicació Genesys de Audifilm Consulting.

La documentació inclou la descripció detallada de totes les operacions així com exemples d’us que facilitin la integració.

3.2 Audiència

El present document va dirigit a equips o personal tècnic, encarregat de realitzar integracions amb l’aplicació Genesys de Audifilm Consulting.

Requeriments previs:

Coneixement de l’arquitectura REST

Estructures de dades en format JSON

Coneixement funcional de l’aplicació Genesys.

4 Consideracions generals La API s’ha construit seguint la arquitectura REST en la mesura del possible.

En els casos en que les peticions de dades requerien el pas d’estructures complexes de paràmetres, s’ha optat per definir-les amb la operació POST en lloc de GET. Això ens permet passar una estructura JSON complexa en el cos de la petició.

Les respostes correctes de la API s’indiquen amb un retorn HTTP 200.

Els error funcionals s’indiquen amb un HTTP 404 (Not Found) indicant el motiu de l’error.

Si es produeix algun altre tipus d’incidència, pot ser deguda a altres causes i retornar algun dels codis HTTP estàndards.

4.1 Swagger

La API ofereix una documentació interactiva en format Swagger v2 accessible per web. La web permet consumir directament la API des de la pròpia web i obtenir la seva definició en format Swagger.

Aquesta definició es pot utilitzar per generar automàticament les crides en clients com Postman o utilitzar generadors automàtics de codi.

Punts d’accés a la API:

URL http://xxxx

Endpoint /JGenesysREST/api



Pàg. 9/169

Swagger UI /JGenesysREST/api/swagger-ui.html

Swagger doc /JGenesysREST/api/v2/api-docs

4.2 Dades generals

Hi ha tres paràmetres que solen enviar-se en totes les peticions:

Paràmetre Descripció Proves de test

nivell Indica el nivell e seguretat. Podem utilitzar 9999

aplicacio Indica l’aplicació a la que accedim. Per exemple:

SDE - Seguiment D’Esxpedients

RES - Registre d’Entrada i Sortida

usuari Identificador de l’usuari Podem utilitzar G5Admin o qualsevol usuari de l’aplicació.



Pàg. 10/169

5 Recursos de la API Els recursos que ofereix la API són:

Carrers

Domicilis

Persones

Persona-Domicili

Registre

Registre d’Entrada

Registre de Sortida

Expedients

Documents

A continuació els descrivim en detall.



Pàg. 11/169

5.1 Carrers

Descripció Permet guardar i obtenir informació de carrers del territoris. També podem obtenir dades genèriques com partícules dels carrers o sigles.

Ruta /carrers

5.1.1 Operacions

Mètode

Ruta Descripció

POST /put Alta o modificació de Carrers.

POST /get Recuperar un Carrer.

POST /search Cerca de Carrers per diferents criteris.

POST /particules/put Modificació de partícules dels Carrers.

POST /particules/get Recuperar partícules dels Carrers.

POST /sigles/put Modificació de sigles dels Carrers.

POST /sigles/get Recuperar sigles dels Carrers.

5.1.2 Alta o modificació

Mètode POST

Ruta /carrers/put

Cos de la petició

{

"nivell": "string",

"aplicacio": "string",

"usuari": "string",

"carrer": {

"baixa": {

"dataBaixa": "string",

"esBaixa": "string"

},

"codiCarrer": 0,



Pàg. 12/169

"codiParticula": "string",

"codiSigla": "string",

"municipi": {

"codMunicipi": 0,

"codPais": 0,

"codProvincia": 0

},

"nom": "string",

"nomAbreujat": "string"

}

}

Paràmetres:

carrer.baixa Dades de baixa del Carrer.

carrer.codiCarrer Codi del Carrer.

carrer.codiParticula

Codi de Partícula del Carrer.

carrer.codiSigla Sigla del Carrer.

carrer.municipi Municipi del Carrer indicant codi de país, codi de provícia i codi de municipi.

carrer.nom Nom del Carrer.

carrer.nomAbreujat

Nom abreujaT del Carrer.

Exemple

Request:

POST /carrers/put

Request body:

{

"carrer": {

"codiCarrer": 3,

"codiSigla": "C/",



Pàg. 13/169

"municipi": {

"codMunicipi": 79,

"codPais": 108,

"codProvincia": 17

},

"nom": "MIGDIA PROVA",

"nomAbreujat": "MP"

},

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"nom": "MIGDIA PROVA",

"codiCarrer": 3,

"baixa": {

"dataBaixa": "",

"esBaixa": ""

},

"municipi": {

"codPais": 108,

"codProvincia": 17,

"descPais": "ESPAÑA",

"descProvincia": "GIRONA",

"baixa": null,

"codMunicipi": 79,

"descMunicipi": "GIRONA"

},

"codiSigla": "C/",

"codiParticula": "",

"nomAbreujat": "MP",

"descSigla": "C/",

"descParticula": ""



Pàg. 14/169

}

5.1.3 Recuperar un Carrer

Mètode POST

Ruta /carrers/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"carrer": {

"codCarrer": 0,

"codMunicipi": 0,

"codPais": 0,

"codProvincia": 0

}

}

Paràmetres:

carrer.codCarrer Codi del Carrer.

carrer.codMunicipi

Codi del Municipi.

carrer.codPais Codi del País.

carrer.codiProvincia

Codi de provincia.

Exemple:

Request:

POST /carrers/get

Request body:

{



Pàg. 15/169

"carrer": {

"codCarrer": 616,

"codMunicipi": 19,

"codPais": 108,

"codProvincia": 8

},

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response body:

{

"nom": "PUIGMARTI",

"codiCarrer": 616,

"baixa": {

"dataBaixa": "",

"esBaixa": ""

},

"municipi": {

"codPais": 108,

"codProvincia": 8,


"descProvincia": "BARCELONA",

"baixa": null,

"codMunicipi": 19,

"descMunicipi": "BARCELONA"

},

"codiSigla": "C/",


"nomAbreujat": "",

"descSigla": "C/",

"descParticula": ""

}



Pàg. 16/169

5.1.4 Cercar Carrers

Mètode POST

Ruta /carrers/search

Cos de la petició

{

"codiCarrer": 0,

"maxResults": 0,

"municipi": {

"codMunicipi": 0,

"codPais": 0,

"codProvincia": 0

},

"nomCarrer": "string",

"tipusVia": "string",

"nivell": "string",


"usuari": "string"

}

Paràmetres:

codiCarrer Codi del Carrer.

maxResults Número màxim de resultats retornats.

municipi Identificador de municipi. Inclou codi de país, codi de provincia i codi de municipi.

nomCarrer Nom del carrer.

tipusVia Tipus de via.

Exemple:

Request:

POST /carrerc/search

Request body:



Pàg. 17/169

{

"maxResults": 1,

"municipi": {

"codMunicipi": 79,

"codPais": 108,

"codProvincia": 17

},

"nomCarrer": "MUNTAN",

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}


{

"carrerArray": [

{

"nom": "MUNTANYA",

"codiCarrer": 234,

"baixa": {

"dataBaixa": "",

"esBaixa": ""

},

"municipi": {

"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 79,

"descMunicipi": "GIRONA"

},

"codiSigla": "C/",


"nomAbreujat": "",



Pàg. 18/169

"descSigla": "C/",

"descParticula": ""

},

....

]

}

5.1.5 Modificar Partícules dels Carrers. PARAMETRES

Mètode POST

Ruta /carrers/particules/put

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"particulaCarrer": {

"codi1": "string",

"codi2": "string",

"comptador": 0,

"descripcio": "string",

"descripcio2": "string",

"qual": "string"

}

}

Paràmetres:

codi1

codi2

comptador

descripcio

descripcio2



Pàg. 19/169

qual

Exemple:

Request:

POST /carrers/particules/put

Request body:

{

"particulaCarrer": {

"codi1": "A",

"codi2": "A",

"descripcio": "Partícula A"

},

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"descripcio": "Partícula A",

"descripcio2": "",

"codi1": "A",

"codi2": "A",

"qual": "",

"comptador": null

}

5.1.6 Recuperar Partícules dels Carrers

Mètode POST

Ruta /carrers/particules/get

Cos de la {



Pàg. 20/169

petició "nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /carrers/particules/get

Request body:

{

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}


{

"particulaCarrerArray": [

{

"descripcio": "Partícula A",

"descripcio2": "",

"codi1": "A",

"codi2": "A",

"qual": "",

"comptador": null

}

]

}

5.1.7 Modificar Sigles dels Carrers

Mètode POST

Ruta /carrers/sigles/put



Pàg. 21/169

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"sigla": {

"baixa": {


"esBaixa": "string"

},

"codiSigla": "string",

"descAbreujada": "string",

"descripcio": "string"

}

}

Paràmetres:

baixa Informació de la baixa del registre.

codiSigla Codi de Sigla.

descAbreujada

Descripció abreujada.

descripcio Descripció completa.

Exemple:

Request:

POST /carrers/sigles/put

Request body:

{

"sigla": {

"codiSigla": "XX",

"descAbreujada": "XX",

"descripcio": "SIGLA XX"



Pàg. 22/169

},

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"descripcio": "SIGLA XX",

"baixa": null,

"codiSigla": "XX",

"descAbreujada": "XX"

}

5.1.8 Recuperar Sigles dels Carrers

Mètode POST

Ruta /carrers/sigles/get

Cos de la petició

{

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /carrers/sigles/get

Request body:

{

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}



Pàg. 23/169

Expected response:

{

"siglaArray": [

{

"descripcio": "L",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},

"codiSigla": "L",

"descAbreujada": "L"

},

{

"descripcio": "-",

"baixa": {

"dataBaixa": "",

"esBaixa": ""

},

"codiSigla": "-",

"descAbreujada": "-"

},

....

]

}



Pàg. 24/169

5.2 Domicilis

Descripció Permet guardar i obtenir informació de domicilis del territoris. També podem obtenir dades genèriques com tipus de domicilis o tipus de locals. I finalment permet obtenir les persones d’un domicili.

Ruta /domicilis

5.2.1 Operacions

Mètode

Ruta Descripció

POST /put Alta d’un Domicili.

POST /get Recuperar un Domicili.

POST /search Cerca de Domicilis per diferents criteris.

POST /persones/get Recuperar les Persones d’un Domicili.

POST /getperterritori Recuperar Domicilis d’un Territori.

POST /tipus/get Recuperar els Tipus de Domicilis.

POST /tipuslocals/get Recuperar els Tipus de Locals.

5.2.2 Alta. PARAMETRES EXEMPLE

Mètode POST

Ruta /domicilis/put

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"ambKm": true,

"domTip": [

"string"

],

"domTloc": [



Pàg. 25/169

"string"

],

"domicili": {

"apartatCorreus": 0,

"baixa": {


"esBaixa": "string"

},

"bis1": "string",

"bis2": "string",

"bloc": "string",

"codiCarrer": 0,

"codiDomicili": 0,

"codiGIS": "string",

"codiPostal": "string",

"codiPseudovia": 0,

"codiTipusDomicili": "string",

"codiTipusLocal": "string",

"escala": "string",

"hm": 0,

"km": 0,

"municipi": {

"codMunicipi": 0,

"codPais": 0,

"codProvincia": 0

},

"num1": "string",

"num2": "string",

"observacions": "string",

"pis": "string",

"pobldesc": "string",

"porta": "string",

"portal": "string",

"refCadastral": "string"



Pàg. 26/169

},

"duplicarAcceptat": true,

"g_G5Municod": 0,

"g_G5Paiscod": 0,

"g_G5Provcod": 0,

"maxResults": 0,

"nomesBaixa": true,

"senseAproximadors": true,

"senseNumero": true

}

Paràmetres:

ambKm

domTip

domTLoc

apartatCorreus Apartat de Correus.

baixa Dades de baixa del Domicili.

bis1

bis2

bloc Número de bloc.

codiCarrer Codi del Carrer.

codiDomicili Codi del Domicili.

codiGIS

codiPostal Codi Postal.

codiPseudovia

codiTipusdomicili

Tipus de Domicili.

codiTipusLocal Tipus de Local.

escala Escala.

hm



Pàg. 27/169

km Kilòmetre per vies no numerades.

municipi Dades del Municipi. Inclou país, província i municipi.

num1 Número 1 del Domicili.

num2 Número 2 del Domicili.

observacions Observacions vàries.

pis Pis.

pobledesc

porta Porta.

portal Número de portal.

refCadastral Referència Cadastral de l’immoble.

duplicarAcceptat

g_G5Municod

g_G5Paiscod

g_G5provcod

maxResults

nomesBaixa

senseAproximadors

senseNumero Indicador de Domicili sense número.

Exemple:

Request:

POST /domicilis/put

Request body:




Pàg. 28/169

5.2.3 Recuperar un Domicili

Mètode POST

Ruta /domicilis/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiDomicili": 0,

"codiMunicipi": 0,

"codiPais": 0,

"codiProvincia": 0

}

Paràmetres:

codiDomicili Codi delDomicili.

codiMunicipi Codi del municipi.

codiPais Codi del País.

codiProvincia Codi de la Província.

Exemple:

Request:

POST /domicilis/get

Request body:

{

"codiDomicili": 555,

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}



Pàg. 29/169


{


"codiCarrer": 74,

"codiPseudovia": null,

"num1": "0138",

"num2": "",

"bis1": "",

"bis2": "",

"km": null,

"hm": null,

"bloc": "",

"portal": "",

"escala": "",

"pis": "",

"porta": "",

"descripcio": "C/ CREU N.0138 CP 17220 SANT FELIU DE GUIXOLS (GIRONA) - ESPAÑA",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},

"baixaRelacio": null,

"municipi": {

"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 160,

"descMunicipi": "SANT FELIU DE GUIXOLS"

},

"observacions": "",

"codiTipusDomicili": "POST",

"codiTipusLocal": "1",

"codiPostal": "17220",



Pàg. 30/169

"apartatCorreus": null,

"codiGIS": "2561923",

"refCadastral": "",

"descCarrer": "C/ CREU",

"descPseudovia": "",

"descTipusDomicili": null,

"descTipusLocal": null,

"pobldesc": "",

"paiscod": null,

"provcod": null,

"municod": null,

"stddgr": "20021129",

"stddmod": "20021129",

"stdhgr": "105010",

"stdhmod": "105010",

"stdugr": "traspas",

"stdumod": "traspas",

"stdapladd": "HAB",

"stdaplmod": "HAB",

"swRevisat": null

}

5.2.4 Cercar Domicilis

Mètode POST

Ruta /domicilis/search

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"ambKm": true,

"domTip": [

"string"

],



Pàg. 31/169

"domTloc": [

"string"

],

"domicili": {

"apartatCorreus": 0,

"baixa": {


"esBaixa": "string"

},

"bis1": "string",

"bis2": "string",

"bloc": "string",

"codiCarrer": 0,

"codiDomicili": 0,

"codiGIS": "string",


"codiPseudovia": 0,

"codiTipusDomicili": "string",

"codiTipusLocal": "string",

"escala": "string",

"hm": 0,

"km": 0,

"municipi": {

"codMunicipi": 0,

"codPais": 0,

"codProvincia": 0

},

"num1": "string",

"num2": "string",


"pis": "string",

"pobldesc": "string",

"porta": "string",

"portal": "string",



Pàg. 32/169

"refCadastral": "string"

},

"duplicarAcceptat": true,

"g_G5Municod": 0,

"g_G5Paiscod": 0,

"g_G5Provcod": 0,

"maxResults": 0,

"nomesBaixa": true,

"senseAproximadors": true,

"senseNumero": true

}

Paràmetres:

Veure la descrició de paràmetres de l’apartat Alta.

Exemple:

Request:

POST /domicilis/search

Request body:

{

"domicili": {

"codiCarrer": 74,

"municipi": {

"codMunicipi": 160,

"codPais": 108,

"codProvincia": 17

},

"num1": "0064",

"pis": "01"

},

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"



Pàg. 33/169

}

Expected response:

{

"domiciliArray": [

{


"codiCarrer": 74,


"num1": "0064",

"num2": "",

"bis1": "",

"bis2": "",

"km": null,

"hm": null,

"bloc": "",

"portal": "",

"escala": "",

"pis": "01",

"porta": "",

"descripcio": "C/ CREU N.0064 Pis.01 CP 17220 SANT FELIU DE GUIXOLS (GIRONA) -

ESPAÑA",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},


"municipi": {

"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 160,




Pàg. 34/169

},

"observacions": "",





"codiGIS": "2659213",

"refCadastral": "",

"descCarrer": "C/ CREU",




"pobldesc": "",

"paiscod": null,

"provcod": null,

"municod": null,

"stddgr": "20021129",

"stddmod": "20021129",

"stdhgr": "105819",

"stdhmod": "105819",


"stdumod": "traspas &1",

"stdapladd": "HAB",

"stdaplmod": "HAB",

"swRevisat": null

},

....

]

}

5.2.5 Recuperar les Persones d’un Domicili

Mètode POST

Ruta /domicilis/persones/get

Cos de {



Pàg. 35/169

lapetició "nivell": "string",


"usuari": "string",

"codiDomicili": 0,

"codiMunicipi": 0,

"codiPais": 0,

"codiProvincia": 0

}

Paràmetres:

Veure apartat Recuperar un domicili.

Exemple:

Request:

POST /domicilis/persones/get

Request body:

{


"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"personaArray": [

{

"nom": "PERE",

"nif": "40000000",

"nifDC": "F",

"particula1": "",

"cognom1": "XXXX",

"particula2": "",



Pàg. 36/169

"cognom2": "YYYY",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},

"password": "",

"descTipusPersona": null,

"descNacionalitat": "ESPAÑA",

"codi": 1820,

"codTipusPersona": "F",

"passaport": "",

"dataNaixement": "19190414",

"codNacionalitat": 108,

"sexe": "1",

"municipiNaixement": {

"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 160,


},

"nomComplet": "XXXX YYYY PERE",

"contacte": null,

"formaContacte": null,

"codIdioma": "",

"perssw": "0",

"nifOrig": "",

"esHabitant": false,

"esPersnull": false,

"esContribuent": false,

"esNifModificable": false,

"stddgr": "20021129",

"stddmod": "20021129",



Pàg. 37/169

"stdhgr": "105009",

"stdhmod": "000002",



"stdapladd": "HAB ",

"stdaplmod": "HAB ",

"codiEstudis": null,

"nomesBaixa": false,

"dataBaixa2": null,

"gestCont": false

}

]

}

5.2.6 Recuperar Domicilis d’un Territori

Mètode POST

Ruta /domicilis/getperterritori

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiTerritori": "string"

}

Paràmetres:

codiTerritori Codi de territori.

Exemple:

Request:

POST /domicilis/getperterritori

Request body:

{



Pàg. 38/169

"codiTerritori": "2163104",

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

[

265,

9607

]

5.2.7 Recuperar Tipus de Domicilis

Mètode POST

Ruta /domicilis/tipus/get

Cos de la petició

{

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /domicilis/tipus/get

Request body:

{

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}



Pàg. 39/169

Expected response:

{

"tipusDomiciliArray": [

{

"descripcio": "Apartat de correus",

"descripcio2": "",

"codi1": "APTC",

"codi2": "",

"qual": "",

"comptador": null

},

{

"descripcio": "Adreça postal",

"descripcio2": "",

"codi1": "POST",

"codi2": "",

"qual": "",

"comptador": null

}

]

}

5.2.8 Recuperar Tipus de Locals

Mètode POST

Ruta /domicilis/tipuslocals/get

Cos de la petició

{

"nivell": "string",


"usuari": "string"

}

Exemple:



Pàg. 40/169

Request:

POST /domicilis/tipuslocals/get

Request body:

{

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"tipusLocalArray": [

{

"descripcio": "DOMICILIO FAMILIAR",

"descripcio2": "",

"codi1": "1",

"codi2": "",

"qual": "",

"comptador": null

},

{

"descripcio": "LOCAL SOCIAL",

"descripcio2": "",

"codi1": "2",

"codi2": "",

"qual": "",

"comptador": null

},

{

"descripcio": "Apartat de correus",

"descripcio2": "",

"codi1": "A",

"codi2": "",

"qual": "",



Pàg. 41/169

"comptador": null

}

]

}



Pàg. 42/169

5.3 Persones

Descripció Permet guardar i obtenir informació de persones i dades relacionades com el domicili i el domicili bancari. També permetn obtenir dades genèriques com partícules dels cognoms o tipus de persones.

Ruta /persones

5.3.1 Operacions

Mètode

Ruta Descripció

POST /put Modificar les dades d’una Persona.

POST /putsimple Crea un registre de Persona amb les mínimes dades requerides.

POST /get Recupera una Persona.

POST /search Cerca Persones per diferents criteris.

POST /getmodificades Recupera les últimes Persones modificades per límits de dates.

POST /espersonafisica Retorna l’indicador de Persona Física.

POST /particulescognom/put Crea noves Partícules de Cognom.

POST /particulescognom/get Recupera les Partícules dels Cognoms.

POST /domicilis/get Recupera tots els Domicilis d’una Persona.

POST /domicilis/getone Recupera un Domicili d’una Persona.

POST /domicilis/getdefault Recupera el Domicili per defecte d’una Persona.

POST /domicilisbancaris/get Recupera els Domicilis Bancaris d’una Persona.

POST /noticies/get Recupera les Notícies d’una Persona.

POST /representants/get Recupera els Representants d’una Persona.

POST /tipus/get Recupera els tipus de Persones.



Pàg. 43/169

5.3.2 Modificar

Mètode POST

Ruta /persones/put

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"g_G5Paiscod": 0,

"maxResult": 0,

"persona": {

"baixa": {


"esBaixa": "string"

},

"codIdioma": "string",


"codTipusPersona": "string",

"codi": 0,

"codiEstudis": "string",

"cognom1": "string",


"contacte": "string",

"dataBaixa2": "string",

"dataNaixement": "string",

"descNacionalitat": "string",

"descTipusPersona": "string",

"esContribuent": true,

"esHabitant": true,

"esNifModificable": true,

"esPersnull": true,

"formaContacte": "string",

"gestCont": true,




Pàg. 44/169

"baixa": {


"esBaixa": "string"

},

"codMunicipi": 0,

"codPais": 0,

"codProvincia": 0,

"descMunicipi": "string",

"descPais": "string",

"descProvincia": "string"

},

"nif": "string",

"nifDC": "string",

"nifOrig": "string",

"nom": "string",

"nomComplet": "string",

"nomesBaixa": true,

"particula1": "string",


"passaport": "string",

"password": "string",

"perssw": "string",

"sexe": "string",

"stdapladd": "string",

"stdaplmod": "string",

"stddgr": "string",

"stddmod": "string",

"stdhgr": "string",

"stdhmod": "string",

"stdugr": "string",

"stdumod": "string"

},

"tipoPersona": [

"string"



Pàg. 45/169

]

}

Paràmetres:

g_G5Paiscod

maxResult

baixa

codiIdioma Codi d’idioma (per defecte català).

codiNacionalitat Codi de país.

codiTipusPersona

Cod de tipus de persona.

codi Codi de persona.

codiEstudis Codi d’estudis

cognom1

cognom2

contacte

dataBaixa2

dataNaixement

descNacionalitat

descTipusPersona

esContribuent True/false.

esHabitant True/false.

esNifModificable True/false.

esPersnull True/false.

formaContacte

gesCont



Pàg. 46/169

municipiNaixement

nif Part numèrica del NIF.

nifDC Dígit de control de l NIF.

nifOrig

nom

nomComplet Nom i cognoms.

nomesBaixa

particula1

particula2

passaport

password

perssw

sexe

stdapladd

stdasplmod

stdhgr

stdhmod

stdugr

stdumod

Exemple:

Request:

POST /persones/put

Request body:

{

"aplicacio": "NCL",



Pàg. 47/169

"nivell": "9999",

"persona": {



"codi": 1678,

"cognom1": "TESTC1",








"gestCont": false,


"codMunicipi": 232,

"codPais": 108,

"codProvincia": 31,

"descMunicipi": "TUDELA",


"descProvincia": "NAVARRA"

},

"nif": "00507486",

"nifDC": "Z",

"nom": "PACO",

"nomComplet": "PACO TESTC1 TESTC2",


"sexe": "1"

},

"tipoPersona": [

"F"

],

"usuari": "G5Admin"

}



Pàg. 48/169

Expected response:

{

"nom": "PACO",

"nif": "00507486",

"nifDC": "Z",

"particula1": "",


"particula2": "",


"baixa": {

"dataBaixa": "",

"esBaixa": ""

},

"password": "",



"codi": 1678,


"passaport": "",



"sexe": "1",


"codPais": 108,

"codProvincia": 31,


"descProvincia": "NAVARRA",

"baixa": null,

"codMunicipi": 232,

"descMunicipi": "TUDELA"

},

"nomComplet": "TESTC1 TESTC2 PACO",

"contacte": null,


"codIdioma": "",



Pàg. 49/169

"perssw": "",

"nifOrig": "",





"stddgr": "20021129",

"stddmod": "20200709",

"stdhgr": "104936",

"stdhmod": "092742",


"stdumod": "G5Admin",


"stdaplmod": "NCL",



"dataBaixa2": null,

"gestCont": false

}

5.3.3 Creacio simple

Mètode POST

Ruta /persones/putsimple

Cos de la petició

{

"nivell": "string",


"usuari": "string",



"document": "string",

"nom": "string"

}



Pàg. 50/169

Paràmetres:

cognom1 Primer cognom.

cognom2 Segon cognom.

document Document identificatiu

nom Nom.

Exemple:

Request:

POST /persones/putsimple

Request body:

{

"cognom1": "XXXX",

"cognom2": "YYYY",

"nom": "PACO",

"document”: "44332211X",

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

HTTP 200.

5.3.4 Recuperar una Persones

Mètode POST

Ruta /persones/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiPersona": 0,



Pàg. 51/169

"formatNomCognoms": true,

"g_G5Paiscod": 0,

"mostrarBaixes": true

}

Paràmetres:

codiPersona Codi de la persona a recuperar.

formatNomCosnoms

g_G5Paiscod

mostrarBaixes

Exemple:

Request:

POST /persones/get

Request body:

{

"codiPersona": 555,

"formatNomCognoms": false,

"mostrarBaixes": false,

"nivell": "string",


"usuari": "string"

}

Expected response:

{

"nom": "MARIA",

"nif": "41111111",

"nifDC": "J",

"particula1": "",



Pàg. 52/169

"cognom1": "XXXX",

"particula2": "",

"cognom2": "YYYY",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},

"password": "",



"codi": 555,


"passaport": "",



"sexe": "1",


"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 160,


},

"nomComplet": "XXXX YYYY MARIA",

"contacte": null,


"codIdioma": "",

"perssw": "0",

"nifOrig": "",







Pàg. 53/169

"stddgr": "20021129",

"stddmod": "20080508",

"stdhgr": "104455",

"stdhmod": "000002",


"stdumod": "ALFRED",


"stdaplmod": "HAB ",



"dataBaixa2": null,

"gestCont": false

}

5.3.5 Cercar Persones

Mètode POST

Ruta /persones/search

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"g_G5Paiscod": 0,

"maxResult": 0,

"persona": {

"baixa": {


"esBaixa": "string"

},

"codIdioma": "string",


"codTipusPersona": "string",

"codi": 0,

"codiEstudis": "string",



Pàg. 54/169



"contacte": "string",

"dataBaixa2": "string",

"dataNaixement": "string",

"descNacionalitat": "string",

"descTipusPersona": "string",

"esContribuent": true,

"esHabitant": true,

"esNifModificable": true,

"esPersnull": true,

"formaContacte": "string",

"gestCont": true,


"baixa": {


"esBaixa": "string"

},

"codMunicipi": 0,

"codPais": 0,

"codProvincia": 0,

"descMunicipi": "string",

"descPais": "string",

"descProvincia": "string"

},

"nif": "string",

"nifDC": "string",

"nifOrig": "string",

"nom": "string",

"nomComplet": "string",

"nomesBaixa": true,






Pàg. 55/169

"password": "string",

"perssw": "string",

"sexe": "string",

"stdapladd": "string",

"stdaplmod": "string",

"stddgr": "string",


"stdhgr": "string",


"stdugr": "string",

"stdumod": "string"

},

"tipoPersona": [

"string"

]

}

Paràmetres:

Veure l’apartat Modifcar.

Exemple:

Request:

POST /persones/search

Request body:

{

"persona": {

"cognom1": "SOLER"

},

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "string"

}



Pàg. 56/169

Expected response:

{

"personaArray": [

{

"nom": "SOLER XXXXXX JAUME",

"nif": "11111111",

"nifDC": "V",

"particula1": "",

"cognom1": "SOLER",

"particula2": "",

"cognom2": "",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},

"password": "",



"codi": 32871,


"passaport": "",

"dataNaixement": "",


"sexe": "",

"municipiNaixement": null,

"nomComplet": "SOLER XXXXX JAUME",

"contacte": null,


"codIdioma": "",

"perssw": "0",

"nifOrig": "",







Pàg. 57/169

"stddgr": "20031113",

"stddmod": "20031113",

"stdhgr": "165753",

"stdhmod": "000002",



"stdapladd": "GTR ",

"stdaplmod": "GTR ",



"dataBaixa2": null,

"gestCont": false

},

....

]

}

5.3.6 Recuperar les últimes Persones modificades

Mètode POST

Ruta /persones/getmodificades

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"dataModificacio": "string",

"horaModificacio": "string"

}

Parámetres:

dataModificacio

Dia de modificació.

horaModificacio

Hora de modificació.



Pàg. 58/169

Exemple:

Request:

POST /persones/getmodificades

Request body:

{

"dataModificacio": "20200101",

"horaModificacio": "000000",

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

Response body

{

"persones": [

106260

]

}

5.3.7 Indicador de Persona Física

Mètode POST

Ruta /persones/espersonafisica

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiPersona": 0,

"gestCont": true

}



Pàg. 59/169

Exemple:

Request:

POST /persones/espersonafisica

Request body:

{

"codiPersona": 555,

"gestCont": true,

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"response": true

}

5.3.8 Crear Partícules de cognoms

Mètode POST

Ruta /persones/particulescognom/put

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"particulaCognom": {

"codi1": "string",

"codi2": "string",

"comptador": 0,

"descripcio": "string",

"descripcio2": "string",

"qual": "string"

}



Pàg. 60/169

}

Paràmetres:

codi1 Codi partícula

codi2 No s’utilitza.

comptador No s’utilitza.

descripcio Descripció de la partícula.

descripcio2 No s’utilitza.

qual No s’utilitza.

Exemple:

Request:

POST /persones/particulescognom/put

Request body:

{

"particulaCognom": {

"codi1": "XX",

"descripcio": "XX"

},

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"descripcio": "XX",

"descripcio2": "",

"codi1": "XX",

"codi2": "",

"qual": "",



Pàg. 61/169

"comptador": null

}

5.3.9 Recuperar Partícules de cognoms

Mètode POST

Ruta /persones/particulescognom/get

Cos de la petició

{

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /persones/particulescognom/get

Request body:

{

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"particulaCognomArray": [

{

"descripcio": "D'",

"descripcio2": "",

"codi1": "D'",

"codi2": "",

"qual": "",

"comptador": null



Pàg. 62/169

},

{

"descripcio": "DE",

"descripcio2": "",

"codi1": "DE",

"codi2": "",

"qual": "",

"comptador": null

},

....

]

}

5.3.10 Recuperar tots els Domicilis

Mètode POST

Ruta /persones/domicilis/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiPersona": ,


"g_G5Paiscod": 0,


}

Exemple:

Request:

POST /persones/domicilis/get

Request body:

{

"codiPersona": 555,



Pàg. 63/169


"g_G5Paiscod": 0,

"mostrarBaixes": true,

"nivell": "string",


"usuari": "string"

}

Expected response:

{

"domiciliArray": [

{


"codiCarrer": 465,

"codiPseudovia": 10177,

"num1": "0016",

"num2": "",

"bis1": "",

"bis2": "",

"km": null,

"hm": null,

"bloc": "",

"portal": "",

"escala": "2",

"pis": "02",

"porta": "02",

"descripcio": null,

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},

"baixaRelacio": {

"dataBaixa": "",

"esBaixa": ""

},



Pàg. 64/169

"municipi": {

"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 160,


},

"observacions": "",





"codiGIS": "2355810",

"refCadastral": "",

"descCarrer": "PL LLUIS ESTEVA I CRUAÑAS",

"descPseudovia": "- APARTAMENTS GASELA",



"pobldesc": null,

"paiscod": null,

"provcod": null,

"municod": null,

"stddgr": "20050330",

"stddmod": "20050330",

"stdhgr": "091613",

"stdhmod": "091613",

"stdugr": "RAFA",

"stdumod": "RAFA",

"stdapladd": "PAD ",

"stdaplmod": "PAD ",

"swRevisat": null

},

....



Pàg. 65/169

]

}

5.3.11 Recuperar un Domicili

Mètode POST

Ruta /persones/domicilis/getone

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiDomicili": 0,

"perscod": 0,

"persnd": 0

}

Paràmetres:

codiDomicili Codi del domicili.

perscod Codi de persona.

persnd Número de domicili de la persona

Exemple:

Request:

POST /persones/domicilis/getone

Request body:

{

"perscod": 555,

"persnd": 1,

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}



Pàg. 66/169

Expected response:

{


"codiCarrer": 277,


"num1": "xx",

"num2": "",

"bis1": "",

"bis2": "",

"km": null,

"hm": null,

"bloc": "",

"portal": "",

"escala": "",

"pis": "xx",

"porta": "xx",

"descripcio": "CARRETERA GIRONA N.xx Pis.xx Pta.x CP 17220 SANT FELIU DE GUIXOLS

(GIRONA) - ESPAÑA",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},


"municipi": {

"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 160,


},

"observacions": "",




Pàg. 67/169




"codiGIS": "2064207",

"refCadastral": "",

"descCarrer": "CARRETERA GIRONA",




"pobldesc": "",

"paiscod": null,

"provcod": null,

"municod": null,

"stddgr": "20021129",

"stddmod": "20030206",

"stdhgr": "104455",

"stdhmod": "134208",


"stdumod": "INTER3",

"stdapladd": "HAB",

"stdaplmod": "HAB",

"swRevisat": null

}

5.3.12 Recuperar el Domicili per defecte

Mètode POST

Ruta /persones/domicilis/getdefault

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"perscod": 0

}



Pàg. 68/169

Exemple:

Request:

POST /persones/domicilio/detdefault

Request body:

{

"perscod": 555,

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{


"codiCarrer": 465,

"codiPseudovia": 10177,

"num1": "xx",

"num2": "",

"bis1": "",

"bis2": "",

"km": null,

"hm": null,

"bloc": "",

"portal": "",

"escala": "x",

"pis": "xx",

"porta": "xx",

"descripcio": "PL LLUIS ESTEVA I CRUAÑAS [- APARTAMENTS GASELA] N.xx Esc.x Pis.xx Pta.xx

CP 17220 SANT FELIU DE GUIXOLS (GIRONA) - ESPAÑA",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},




Pàg. 69/169

"municipi": {

"codPais": 108,

"codProvincia": 17,



"baixa": null,

"codMunicipi": 160,


},

"observacions": "",





"codiGIS": "2355810",

"refCadastral": "",

"descCarrer": "PL LLUIS ESTEVA I CRUAÑAS",

"descPseudovia": "- APARTAMENTS GASELA",



"pobldesc": "",

"paiscod": null,

"provcod": null,

"municod": null,

"stddgr": "20050330",

"stddmod": "20050330",

"stdhgr": "091613",

"stdhmod": "091613",

"stdugr": "RAFA",

"stdumod": "RAFA",

"stdapladd": "PAD",

"stdaplmod": "PAD",

"swRevisat": null

}



Pàg. 70/169

5.3.13 Recuperar els Domicilis Bancaris

Mètode POST

Ruta /persones/domicilisbancaris/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiPersona": 0,


"g_G5Paiscod": 0,


}

Exemple:

Request:

POST /persones/domicilisbancaris/get

Request body:

{

"codiPersona": 555,

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"comptadorDomiciliBancariArray": [

1

],

"domiciliBancariArray": [

{

"codiBanc": "0131",



Pàg. 71/169

"numeroCompte": "0000111122223333",

"observacions": "",

"numComptePrint": "0131 0000 11 1122223333",

"dataDomiciliacio": "",

"descBanc": "BANCO ESPIRITU SANTO",

"bic": "",

"iban": "",

"dataValidesa": ""

}

]

}

5.3.14 Recuperar les Notícies

Mètode POST

Ruta /persones/noticies/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiPersona": 0,

"idioma": 0

}

Exemple:

Request:

POST /persones/noticies/get

Request body:

{

"idioma": 0,

"codiPersona": 555,

"nivell": "9999",

"aplicacio": "NOTA",



Pàg. 72/169

"usuari": "G5Admin"

}

Expected response:

{

"noticies": [

{

"notcod": 23,

"notdesc": "X2012006089",

"nottxt": "es passa full d'incidències pel tractament amb XXXXX.",

"notsql": null,

"dataini": "20120727",

"datafi": null,

"aplcod": null,

"idiocod": null

},

....

]

}

5.3.15 Recuperar els Representants

Mètode POST

Ruta /persones/representants/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"perscod": 0,

"reprtip": "string",

"swBaixa": true

}

Exemple:



Pàg. 73/169

Request:

POST /persones/representants/get

Request body:

{

"perscod": 511,

"reprtip": "",

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"personaArray": [

{

"nom": "ANGEL",

"nif": "",

"nifDC": "",

"particula1": "",

"cognom1": "XXXX",

"particula2": "",

"cognom2": "YYYY",

"baixa": {

"dataBaixa": "",

"esBaixa": "0"

},

"password": "",


"descNacionalitat": null,

"codi": 89561,

"codTipusPersona": "Z",

"passaport": "",

"dataNaixement": "",

"codNacionalitat": null,



Pàg. 74/169

"sexe": "1",

"municipiNaixement": null,

"nomComplet": "XXXX YYYY ANGEL",

"contacte": null,


"codIdioma": "",

"perssw": "0",

"nifOrig": "",





"stddgr": "20080709",

"stddmod": "20080709",

"stdhgr": "123730",

"stdhmod": "000002",

"stdugr": "IPONT",

"stdumod": "IPONT",

"stdapladd": "SDE ",

"stdaplmod": "SDE ",



"dataBaixa2": null,

"gestCont": false

}

]

}

5.3.16 Recuperar Tipus de Persones

Mètode POST

Ruta /persones/tipus/get

Cos de la petició

{

"nivell": "string",




Pàg. 75/169

"usuari": "string"

}

Exemple:

Request:

POST /persones/tipus/get

Request body:

{

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"tipusPersonaArray": [

{

"descripcio": "ENTITAT",

"descripcio2": "",

"codi1": "E",

"codi2": "",

"qual": "",

"comptador": null

},

{

"descripcio": "PERSONA FÍSICA",

"descripcio2": "",

"codi1": "F",

"codi2": "",

"qual": "",

"comptador": null

},

....



Pàg. 76/169

]

}



Pàg. 77/169

5.4 Registre

Descripció Permet obtenir dades genèriques com àrees, departaments, unitats de treball, idiomes, assumptes i altres. També operacions com duplicar o reservar registres.

Ruta /registre

5.4.1 Operacions

Mètode

Ruta Descripció

POST /duplicar Duplica registres.

POST /reservar Reserva registres.

POST /arees/get Recupera les Àrees.

POST /departaments/get Recupera Departaments / Unitats de Treball d’una Àrea.

POST /assumptes/get Recupera un Assumpte.

POST /assumptes/getperdepartament

Recupera els Assumptes d’un Departament / Unitat de Treball.

POST /extractes/get Recupera Extractes.

POST /idiomes/get Recupera Idiomes.

POST /tipustransport/get Recupera Tipus de Transport.

5.4.2 Duplicar

Mètode POST

Ruta /registre/duplicar

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"codiEntitat": "string",

"copiarDownload4J": true,

"copiarFileBase64": true,



Pàg. 78/169

"crearPDF": true,

"directori": "string",

"idioma": "string",

"numeroRegistre": "string",

"plantilla": "string",

"quantitat": 0,

"recalcularDirectoriPlantilles": true,

"urlServer": "string"

}

Paràmetres:

codiEntitat

copiarDownload4J

copiarFileBase64

crearPDF

directori

idioma

numeroRegistre

plantilla

quantitat

recalcularDirectoriPlantilles

urlServer

Exemple:

Request:

POST /registre/duplicar



Pàg. 79/169

Request body:

{

"numeroRegistre": "E2020000001",

"quantitat": 1,

"crearPDF": false,

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"numeroRegistres": [

"E2020000014"

],

"fitxerPDF": null,

"linkDownload4J": null,

"fileBase64": null

}

5.4.3 Reservar

Mètode POST

Ruta /registre/reservar

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"areacodCreador": "string",

"assumcod": "string",


"copiarDownload4J": true,

"copiarFileBase64": true,

"crearPDF": true,



Pàg. 80/169

"data": "string",

"depcodCreador": "string",

"directori": "string",

"hora": "string",

"idioma": "string",

"plantilla": "string",

"quantitat": 0,

"recalcularDirectoriPlantilles": true,

"tipusRegistre": "string",

"urlServer": "string"

}

Paràmetres:

areacodCreador

assumcod Codi d’assumpte.

codiEntitat Codi d’entitat. Si no es multi-entitat, posar 1.

copiaDownload4J

copiarFileBase64

crearPDF INdica si cal crear un PDF (true/false).

data Data del registre reservat.

hora Hora del registre reservat.

idioma Codi d’idioma.

plantilla

quantitat Número de registres a reservar.

recalcularDirectoriPlantilles

tipusRegistre Tipus de registre E/S (entrada o sortida).

urlServer



Pàg. 81/169

Exemple:

Request:

POST /registre/reservar

Request body:

{

"assumcod": "COMU",

"codiEntitat": "1",

"crearPDF": false,

"data": "20200525",

"hora": "090000",

"quantitat": 1,

"tipusRegistre": "E",

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Audi"

}

Expected response:

{

"numeroRegistres": [

"E2020000015"

],

"fitxerPDF": null,

"linkDownload4J": null,

"fileBase64": null

}

5.4.4 Recuperar Àrees

Mètode POST

Ruta /registre/arees/get

Cos de la petició

{

"nivell": "string",



Pàg. 82/169


"usuari": "string"

}

Exemple:

Request:

POST /registre/arees/get

Request body:

{

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"areaArray": [

{

"codiArea": "ADM",

"descArea": "ADMINISTRACIÓ ELECTRÒNICA",

"sdeprioritat": null

},

{

"codiArea": "AL",

"descArea": "ALCALDIA",

"sdeprioritat": null

},

....

]

}

5.4.5 Recuperara Departaments

Mètode POST



Pàg. 83/169

Ruta /registre/departaments/get

Cos de la petició

{

"codiArea": "string",

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registre/departaments/get

Request body:

{

"codiArea": "AL",

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"departamentArray": [

{

"codiArea": "AL",


"codiDepartament": "XXXX",

"descDepartament": "XXXXXXXXXXXXXXX"

},

{

"codiArea": "AL",


"codiDepartament": "YYYY",

"descDepartament": "YYYYYYYYYYYYYYY"



Pàg. 84/169

},

....

]

}

5.4.6 Recuperar un Assumpte

Mètode POST

Ruta /registre/assumptes/get

Cos de la petició

{

"codiAssumpte": "string",

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registre/assumptes/get

Request body:

{

"codiAssumpte": "FACT",

"nivell": "9999",

"aplicacio": "NCL",

"usuari": "G5Admin"

}

Expected response:

{

"assumpteArray": [

{

"descripcio": "FACTURES",



Pàg. 85/169

"baixa": null,

"codi": "FACT",

"departament": {

"codiArea": "AL",


"codiDepartament": "G5AD",

"descDepartament": "AUDIFILM"

}

}

]

}

5.4.7 Recuperar Assumptes per Departament

Mètode POST

Ruta /registre/assumptes/getperdepartament

Cos de la petició

{

"codiArea": "string",

"codiDepartament": "string",

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registre/assumptes/getperdepartament

Request body:

{

"codiArea": "AL",


"nivell": "9999",



Pàg. 86/169

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"assumpteArray": [

{

"descripcio": "AJUTS I BEQUES",

"baixa": null,

"codi": "AJBE",

"departament": {

"codiArea": "AL",




}

},

{

"descripcio": "ALTA RÀPIDA",

"baixa": null,

"codi": "ALTA",

"departament": {

"codiArea": "AL",




}

},

....

]

}



Pàg. 87/169

5.4.8 Recuperar Extractes

Mètode POST

Ruta /registre/extracte/get

Cos de la petició

{

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registre/extracte/get

Request body:

{

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"extracteArray": [

{

"codi1": "XXX",

"codi2": "",

"comptador": 0,

"descripcio": "XXX",

"descripcio2": "",

"qual": ""

}

]

}



Pàg. 88/169

5.4.9 Recuperar Idiomes

Mètode POST

Ruta /registre/idiomes/get

Cos de la petició

{

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registre/idiomes/get

Request body:

{

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

"idiomaArray": [

{

"descripcio": "CATALA",

"descripcio2": "es",

"codi1": "0",

"codi2": "ca",

"qual": "",

"comptador": null

},

{



Pàg. 89/169

"descripcio": "ESPAÑOL",

"descripcio2": "ca",

"codi1": "1",

"codi2": "es",

"qual": "",

"comptador": null

}

]

}

5.4.10 Recuperar Tipus Transport

Mètode POST

Ruta /registre/tipustransport/get

Cos de la petició

{

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registre/tipustransport/get

Request body:

{

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{



Pàg. 90/169

"tipusTransportArray": [

{

"descripcio": "Correu electrònic",

"descripcio2": "",

"codi1": "1",

"codi2": "E",

"qual": "",

"comptador": null

},

{

"descripcio": "Correu administratiu",

"descripcio2": "",

"codi1": "10",

"codi2": "",

"qual": "",

"comptador": null

},

....

]

}



Pàg. 91/169

5.5 Registre d’entrada

Descripció Operacions relacionades amb el registre d’entrada. Creació i modificació de registres, obtenir registres relacionats, documents, relacionar registres, relacionar expedients, cercar i altres.

Ruta /registreentrada

5.5.1 Operacions

Mètode

Ruta Descripció

POST /put Crea o modifica un Registre d’Entrada.

POST /newsimple Crea un Registre d’Entrada amb les dades mínimes necessàries.

POST /putsimple Modifica dades concretes d’un Registre d’Entrada.

POST /get Recupera un Registre d’Entrada.

POST /search Cerca per diferents criteris.

POST /expedients/put Relaciona un Expedient amb un Registre d’Entrada.

POST /expedients/get Recupera els Expedients relacionats.

POST /interessat/put Assigna un Interessat a un Registre d’Entrada.

POST /documents/get Recupera els Documents d’un Registre d’Entrada.

POST /entrades/get Recupera els Registres d’Entrada relacionats.

POST /sortides/get Recupera els Registres de Sortida relacionats.

5.5.2 Crear o modificar

Mètode POST

Ruta /registreentrada/put

Cos de la petició

{


"gestCont": true,



Pàg. 92/169

"idioma": 0,

"nivell": "string",

"nivellTaula": "string",

"registreEntrada": {

"arxiu": "string",

"codiAreaAssumpte": "string",

"codiAreaCreador": "string",


"codiDepartamentAssumpte": "string",

"codiDepartamentCreador": "string",


"codiExtracte": "string",

"codiIdioma": "string",

"codiOrganismeOrigen": 0,

"codiPersona": 0,

"codiRepresentant": 0,

"codiTerritori": 0,

"codiTipusTransport": "string",

"comptDomiciliOrganisme": 0,

"comptDomiciliPersona": 0,

"comptDomiciliRepresentant": 0,

"contingutExtracte": "string",

"dataDocument": "string",

"dataPresentacio": "string",

"dataRegistreOrganisme": "string",

"dataTransport": "string",

"descAreaAssumpte": "string",

"descDepartamentAssumpte": "string",

"domNot": "string",

"efactComptabilitat": "string",

"efactEstat": "string",

"efactNumfactura": "string",

"efactObs": "string",

"efactProveidor": "string",



Pàg. 93/169

"fcontactMail": 0,

"fcontactSms": 0,

"firmaTopograficaArxiu": "string",

"habilitarEFactura": true,

"horaPresentacio": "string",

"horaRegistre": "string",

"horaRegistreOrganisme": "string",

"horaTransport": "string",

"ine10Origen": "string",

"notMail": "string",

"notSms": "string",

"numPagines": 0,

"numconordreMail": 0,

"numconordreSms": 0,

"numeroEntrada": "string",

"numeroEntradaEntitat": "string",

"numeroFormaContacte": 0,

"numeroOrdreContacte": 0,

"numeroRegistreOrganisme": "string",

"numeroTransport": "string",

"observacionsDocument": "string",

"observacionsTransport": "string",

"persNifFoto": "string",

"persNomFoto": "string",

"persNot": "string",

"perscontacn": "string",

"persndMail": 0,

"persndSms": 0,

"persnumconordre": "string",

"plataforma": "string",

"registreRelacionat": "string",

"repcontac": 0,

"repfcontac": 0,

"resNumeExt": "string",



Pàg. 94/169

"resorgcontac": 0,

"resorgfcontac": 0,

"responsable": "string",

"tipusOrganisme": "string",

"tractat": 0,

"tramcod": 0,

"tramdesc": "string"

},

"usuari": "string",

"validarCampsObligatoris": true

}

Paràmetres:

arxiu

codiAreaAssumpte

codiAreaCreador

codiAssumpte

codiDepartamentAssumpte

codiDepartamentCreador

coientitat

codiExtracte

codiIdioma

codiOrganismeOrigen

codiPersona

codiRepresentant

codiTerritori

codiTipusTransport

comptDomiciliOrganis



Pàg. 95/169

me

comptDomiciliPersona

comptDomiciliRepresentant00

contingutExtracte

dataDocument

dataPresentacio

dataRegistreOrganisme

dataTransport

descAreaAssumpte

descDepartamentAssumpte

domNot

efactComptabilitat

efactEstat

efactNumfactura

efactObs

efactProveidor

fcontactMail

fcontactSms

numPagines

numconordreMail

numconordreSms

numeroEntrada

numeroEntradaEntitat

numeroFormaContacte

numeroRegistreOrgani



Pàg. 96/169

sme

numeroTransport

observacionsDocument

observacionsTransport

persNifFoto

persNomFoto

persNot

perscontacn

persndMail

persnmSms

persnumconordre

plataforma

registreRelacionat

repcontac

repfcontac

resNumExt

resorgcontac

resorgfcontac

responsable

tipusOrganisme

tractat

tramcod

tramdesc

Exemple:

Request:



Pàg. 97/169

POST /registreentrada/put

Request body:

{

"aplicacio": "RES",

"gestCont": false,

"idioma": 0,

"nivell": "9999",

"nivellTaula": "9999",


"codiAreaCreador": "AL",

"codiAssumpte": "LLAC",

"codiDepartamentAssumpte": "G5AD",

"codiDepartamentCreador": "G5AD",

"codiEntitat": "1",

"codiPersona": 1678,

"codiTerritori": 500,

"codiTipusTransport": "5",


"descAreaAssumpte": "ALCALDIA",

"descDepartamentAssumpte": "AUDIFILM",

"fcontactMail": 0,

"fcontactSms": 0,


"numPagines": 0,

"numeroEntrada": "E2020000016",

"numeroEntradaEntitat": "E2020000016",

"observacionsDocument": "PROVA MODIFICACIO",

"observacionsTransport": "",

"persNifFoto": "00507486Z",

"persNomFoto": "PEP",

"persNot": "",

"perscontacn": "",

"persndMail": 0,

"persndSms": 0,



Pàg. 98/169

"repcontac": 0,

"repfcontac": 0,

"tractat": 0,

"tramcod": 0,

"horaRegistre": "124443"

},

"usuari": "G5Admin",

"validarCampsObligatoris": false

}

Expected response:

{

"registreEntrada": "E2020000016",

"registreEntradaEntitat": "E2020000016",

"dataRegistreEntrada": "20200708",

"horaRegistreEntrada": "124443",

"dataPresentacioEntrada": null,

"horaPresentacioEntrada": null

}

5.5.3 Creació simple.

Mètode POST

Ruta /registreentrada/newsimple

Cos de la petició

{


"areacodAssumpte": "string",


"codiTransport": "string",

"contingut": "string",

"depcodAssumpte": "string",

"descripcioCurta": "string",

"nivell": "string",



Pàg. 99/169

"notificacioElectronica": true,


"representant": {

"carcod": 0,




"crearPersonaSiNoExisteix": true,

"escala": "string",

"mail": "string",

"municipi": "string",

"municod": 0,

"nif": "string",

"nom": "string",


"numero": "string",

"pais": "string",

"paiscod": 0,


"pis": "string",

"porta": "string",

"provcod": 0,

"provincia": "string",

"telefon": "string"

},


"solicitant": {

"carcod": 0,




"crearPersonaSiNoExisteix": true,

"escala": "string",

"mail": "string",



Pàg. 100/169

"municipi": "string",

"municod": 0,

"nif": "string",

"nom": "string",


"numero": "string",

"pais": "string",

"paiscod": 0,


"pis": "string",

"porta": "string",

"provcod": 0,

"provincia": "string",

"telefon": "string"

},

"tramcod": 0,

"transObs": "string",

"usuari": "string"

}

Exemple:

Request:

POST /registreentrada/newsimple

Request body:

{

"aplicacio": "RES",

"areacodAssumpte": "",

"assumcod": "LLAC",

"codiTransport": "5",

"contingut": "",

"depcodAssumpte": "",

"descripcioCurta": "Proves registre entrada",

"nivell": "9999",



Pàg. 101/169

"notificacioElectronica": false,

"numeroTransport": "",

"solicitant": {

"nif": "00507486Z"

},

"tramcod": 20,

"transObs": "prova",

"usuari": "G5Admin"

}

Expected response:

{





"dataPresentacioEntrada": "20200708",

"horaPresentacioEntrada": "124442"

}

5.5.4 Modificació simple

Mètode POST

Ruta /registreentrada/putsimple

Cos de la petició

{


"gestCont": true,

"idioma": 0,

"nivell": "string",

"nivellTaula": "string",


"arxiu": "string",

"codiAreaAssumpte": "string",



Pàg. 102/169

"codiAreaCreador": "string",


"codiDepartamentAssumpte": "string",

"codiDepartamentCreador": "string",


"codiExtracte": "string",

"codiIdioma": "string",

"codiOrganismeOrigen": 0,

"codiPersona": 0,

"codiRepresentant": 0,

"codiTerritori": 0,

"codiTipusTransport": "string",

"comptDomiciliOrganisme": 0,


"comptDomiciliRepresentant": 0,

"contingutExtracte": "string",

"dataDocument": "string",

"dataPresentacio": "string",

"dataRegistreOrganisme": "string",

"dataTransport": "string",

"descAreaAssumpte": "string",

"descDepartamentAssumpte": "string",

"domNot": "string",

"efactComptabilitat": "string",

"efactEstat": "string",

"efactNumfactura": "string",

"efactObs": "string",

"efactProveidor": "string",

"fcontactMail": 0,

"fcontactSms": 0,


"habilitarEFactura": true,

"horaPresentacio": "string",

"horaRegistre": "string",



Pàg. 103/169

"horaRegistreOrganisme": "string",

"horaTransport": "string",

"ine10Origen": "string",

"notMail": "string",

"notSms": "string",

"numPagines": 0,

"numconordreMail": 0,

"numconordreSms": 0,

"numeroEntrada": "string",

"numeroEntradaEntitat": "string",

"numeroFormaContacte": 0,

"numeroOrdreContacte": 0,

"numeroRegistreOrganisme": "string",


"observacionsDocument": "string",

"observacionsTransport": "string",

"persNifFoto": "string",

"persNomFoto": "string",

"persNot": "string",

"perscontacn": "string",

"persndMail": 0,

"persndSms": 0,

"persnumconordre": "string",


"registreRelacionat": "string",

"repcontac": 0,

"repfcontac": 0,

"resNumeExt": "string",

"resorgcontac": 0,

"resorgfcontac": 0,


"tipusOrganisme": "string",

"tractat": 0,

"tramcod": 0,



Pàg. 104/169

"tramdesc": "string"

},

"usuari": "string",

"validarCampsObligatoris": true

}

Paràmetres:

Exemple:

Request:

POST /registreentrada/putsimple

Request body:

{

"aplicacio": "RES",

"gestCont": true,

"idioma": 0,

"nivell": "9999",

"nivellTaula": "9999",


"numeroEntrada": "E2020000016",

"numeroEntradaEntitat": "E2020000016",

"observacionsDocument": "MODIFICACIO SIMPLE",

"observacionsTransport": "MODIFICACIO SIMPLE"

},


"validarCampsObligatoris": false

}

Expected response:

{





Pàg. 105/169



"dataPresentacioEntrada": null,

"horaPresentacioEntrada": null

}

5.5.5 Recuperar un Registre

Mètode POST

Ruta /registreentrada/get

Cos de la petició

{

"idioma": 0,

"numeroRegistreEntrada": "string",

"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registreentrada/get

Request body:

{

"numeroRegistreEntrada": "E2020000001",

"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"numeroRegistre": "E2020000001",



Pàg. 106/169

"numeroRegistreEntitat": "E2020000001",

"codiEntitat": "1",

"codiPersona": 1,

"fotoRepresentant": null,

"fotoPersona": {

"nom": "AJUNTAMENT DE PROVES",

"nif": "P0826900C",

"particula1": "",

"cognom1": "",

"particula2": "",

"cognom2": "",

"domicili": null,

"esPersonaFisica": null

},

"descExtracte": null,

"codiAssumpte": "CEDU",

"responsable": "_RESPONSABLE_",

"numeroFormaContacte": null,

"numeroOrdreContacte": null,

"codiRepresentant": null,

"repcontac": null,

"repfcontac": null,

"repcontacdesc": null,

"repfcontacdesc": null,

"codiExtracte": null,

"contingutExtracte": "test",

"codiIdioma": "0",

"codiOrganismeOrigen": null,

"numeroRegistreOrganisme": "",

"nomComplertOrganisme": null,

"nifDcOrganisme": null,

"domiciliOrganisme": null,

"resNumeExt": "",

"fotoAssumpte": {

"codiArea": "AL",



Pàg. 107/169



"descDepartament": "AUDIFILM",

"descAssumpte": "CENTRES ESCOLARS"

},

"comptadorDomiciliPersona": 2,

"codiDomiciliPersona": 11494,

"baixaPersona": "0",

"baixaDomiciliPersona": "0",

"baixaRelacioDomiciliPersona": null,

"fotoDomiciliPersona": "C/ ALMERIA N.0005 CP 17220 SANT FELIU DE GUIXOLS (GIRONA) -

ESPAÑA",

"comptadorDomiciliRepresentant": null,

"codiDomiciliRepresentant": null,

"baixaRepresentant": null,

"baixaDomiciliRepresentant": null,

"baixaRelacioDomiciliRepresentant": null,

"fotoDomiciliRepresentant": null,

"dataCreacio": "20200217",

"horaCreacio": "104732",

"dataPresentacio": "20200217",

"horaPresentacio": "104722",

"codiAreaCreador": "AL",

"descAreaCreador": "ALCALDIA",

"codiDepartamentCreador": "G5AD",

"descDepartamentCreador": "AUDIFILM",

"dataDocument": "20200217",

"descIdioma": "CATALA",

"numPagines": 1,

"observacionsDocument": "",

"comptadorDomiciliOrganisme": null,

"codiDomiciliOrganisme": null,

"dataRegistreOrganisme": "",

"horaRegistreOrganisme": "",

"codiTerritori": null,



Pàg. 108/169

"descTerritori": null,

"codiTipusTransport": "12",

"descTipusTransport": "Notarial",

"numeroTransport": "",

"dataTransport": "",

"horaTransport": "",

"observacionsTransport": "ewrgewrg",

"arxiu": "",

"firmaTopograficaArxiu": "",

"descTipusContacte": null,

"descContacte": null,

"interessats": [

1

],

"efactNumfactura": "",

"registreTancat": true,

"registreRelacionat": "X2020000017",

"registreRelacionatEntitat": "X2020000017",

"tipusOrganisme": "",

"baixaOrganisme": null,

"baixaDomiciliOrganisme": null,

"baixaRelacioDomiciliOrganisme": null,

"resorgcontac": null,

"resorgfcontac": null,

"perscontacn": null,

"persnumconordre": null,

"plataforma": null,

"notSms": null,

"notMail": null,

"persndMail": null,

"fcontactMail": null,

"numconordreMail": null,

"persndSms": null,

"fcontactSms": null,

"numconordreSms": null,



Pàg. 109/169

"stddgr": "20200217",

"stddmod": "20200416",

"stdhgr": "104732",

"stdhmod": "093823",

"stdugr": "G5Admin",

"stdumod": "G5Admin",

"persNot": "I",

"domNot": "I",

"swAreaDepKO": 0,

"areaDepKODesc": null,

"swTractat": 0,

"nifPersSw": "F",

"nifReprSw": null,

"tramcod": null,

"tramdesc": null,

"efactComptabilitat": "",

"efactEstat": "",

"efactObs": "",

"efactProveidor": ""

}

5.5.6 Cercar Registres. TODO

Mètode POST

Ruta /registreentrada/

Paràmetres:

Exemple:

Request:

Request body:



Pàg. 110/169

Expected response:

5.5.7 Relacionar Expedient. TODO

Mètode POST


Paràmetres:

Exemple:

Request:

Request body:

Expected response:

5.5.8 Recuperar Expedient relacionat. TODO

Mètode POST

Ruta /registreentrada/expedients/get

Cos de la petició

{


"nivell": "string",


"usuari": "string"

}

Exemple:



Pàg. 111/169

Request:

POST /registreentrada/expedients/get

Request body:

Expected response:

5.5.9 Assignar Interessat. TODO

Mètode POST


Paràmetres:

Exemple:

Request:

Request body:

Expected response:

5.5.10 Recuperar Documents relacionats

Mètode POST

Ruta /registreentrada/documents/get

Cos de la petició

{


"nivell": "9999",

"aplicacio": "RES",



Pàg. 112/169

"usuari": "G5Admin"

}

Exemple:

Request:

POST /registreentrada/documents/get

Request body:

{


"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"documentArray": [

{

"descriptor": "ACTA TEST 01012020",

"nomDocument": "AnnexarDocSelenium.doc",

"idOrigen": null,

"codiTipusDocument": "T006",

"descTipusDocument": "DOCUMENT ANNEXAT",

"motiuRebut": "",

"idNReg": 6020506,

"guid": "9f32932e-0c2f-4761-8a30-cb19ce1b44ad"

},

{

"descriptor": "ACCEPTACIÓ TEST 01012020",

"nomDocument": "DOC2.Pdf",

"idOrigen": null,

"codiTipusDocument": "T001",

"descTipusDocument": "DOCUMENT ANNEXAT",



Pàg. 113/169

"motiuRebut": "",

"idNReg": 6020124,

"guid": "3813b39d-d40b-4afb-8166-4d86c101bf51"

},

....

]

}

5.5.11 Recupera Entrades relacionades

Mètode POST

Ruta /registreentrada/entrades/get

Cos de la petició

{


"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registreentrada/entrada/get

Request body:

{


"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{



Pàg. 114/169

"numeroRegistreEntradaArray": [

"string"

],

"regRelArray": [

{

"numeroRegEntRel": "string",


"stddgr": "string",


"stdhgr": "string",


"stdugr": "string",

"stdumod": "string"

}

]

}

5.5.12 Recupera Sortides relacionades

Mètode POST

Ruta /registreentrada/sortides/get

Cos de la petició

{

"mostrarRelExpedients": true,


"nivell": "string",


"usuari": "string"

}

Exemple:

Request:

POST /registreentrada/sortides/get



Pàg. 115/169

Request body:

{


"nivell": "9999",

"aplicacio": "RES",

"usuari": "G5Admin"

}

Expected response:

{

"numeroRegistreSortidaArray": [

"string"

],

"regRelArray": [

{

"numeroRegSortRel": "string",


"stddgr": "string",


"stdhgr": "string",


"stdugr": "string",

"stdumod": "string"

}

]

}



Pàg. 116/169

5.6 Registre de sortida

Descripció Operacions relacionades amb el registre de sortida. Creació i modificació de registres, obtenir registres relacionats, documents, relacionar registres, relacionar expedients, cercar i altres.

Ruta /registresortida

5.6.1 Operacions

Mètode

Ruta Descripció

POST /put Crea o modifica un Registre de Sortida.

POST /newsimple Crea un Registre de Sortida amb les dades mínimes necessàries.

POST /putsimple Modifica dades concretes d’un Registre de Sortida.

POST /get FALTA!!!

POST /search Cerca per diferents criteris.

POST /interessat/put Assigna un Interessat a un Registre de Sortida.

POST /documents/get Recupera els Documents d’un Registre de Sortida.

POST /entrades/get Recupera els Registres d’Entrada relacionats.

POST /sortides/get Recupera els Registres de Sortida relacionats.

5.6.2 Crear o modificar. TODO

Mètode POST

Ruta /registreSORTIDA/

Paràmetres:

Exemple:



Pàg. 117/169

Request:

Request body:

Expected response:

5.6.3 Creació simple. TODO

Mètode POST


Paràmetres:

Exemple:

Request:

Request body:

Expected response:

5.6.4 Modificació simple. TODO

Mètode POST


Paràmetres:



Pàg. 118/169

Exemple:

Request:

Request body:

Expected response:

5.6.5 Cercar Registres. TODO

Mètode POST


Paràmetres:

Exemple:

Request:

Request body:

Expected response:

5.6.6 Assignar Interessat. TODO

Mètode POST


Paràmetres:



Pàg. 119/169

Exemple:

Request:

Request body:

Expected response:

5.6.7 Recuperar Documents relacionats. TODO

Mètode POST


Paràmetres:

Exemple:

Request:

Request body:

Expected response:

5.6.8 Recuperar Entrades relacionades. TODO

Mètode POST


Paràmetres:



Pàg. 120/169

Exemple:

Request:

Request body:

Expected response:

5.6.9 Recuperar Sortides relacionades. TODO

Mètode POST


Paràmetres:

Exemple:

Request:

Request body:

Expected response:



Pàg. 121/169

5.7 Expedients

Descripció Operacions relacionades amb expedients.

Ruta /expedients

5.7.1 Operacions

Mètode

Ruta Descripció

POST /newsimple Crea un Expedient amb les dades mínimes necessàries.

POST /putsimple Modifica dades concretes d’un Expedient.

POST /get Recupera un Expedient.

POST /infoadicional/{sdenum}

Modificar o afegir dades addicionals d’un Expedient.

DELETE

/infoadicional/{sdenum}

Esborrar dades addicionals d’un Expedient

GET /infoadicional/{sdenum}

Obtenir les dades addicionals d’un expedient.

5.7.2 Creació simple

Mètode POST

Ruta /expedients/newsimple

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"entcod": "string",

"texpcod": "string",

"perscod": 0,

"sdenum": "string",

"data": "2020-05-20T13:43:05.126Z"

}



Pàg. 122/169

Paràmetres

entcod Identificador de l’entitat. Si només en tenim una utilitzar el valor 1.

texpcod Identificador de tipus d’Expedient.

perscod Codi de Persona.

sdenum Codi d’Expedient. Permet utilitzar les variables d’un altre Expedient.

data Data de l’Expedient. Per omisió la data actual.

Exemple:

POST /expedients/newsimple

Cos de la petició:

{

"nivell": "9999",

"aplicacio": "SDE",


"entcod": "1",

"texpcod": "GENE",

"perscod": 1,

"sdenum": "",

"data": ""

}

Resposta esperada:

{

"sdenum": "X2020000759"

}

5.7.3 Modificació simple

Mètode POST



Pàg. 123/169

Ruta /expedients/putsimple

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"sdenum": "string",

"perscod": 0,

"persnd": 0,

"reprcod": 0,

"reprnd": 0,

"areacod": "string",

"depcod": "string",

"grupcod": "string",

"rol": "string",

"entcod": "string",

"texpcod": "string",

"decnumreg": "string",

"extrcod": "string",

"sdetext": "string",

"arxsigtop": "string",

"identval": "string",

"idiomacod": "string",

"eventexpr": "string",

"sdenumtexp": "string",

"sdedomcod": 0,

"sderel": "string",

"resracodec": "string",

"resrorg": "string",

"sdedreg": "string",

"sdehreg": "string",

"resrdata": "string",

"connum2": 0,

"treccod": "string",




Pàg. 124/169

"subassumcod": "string",

"sdenumcont": "string",

"fcontacn": 0,

"numconordre": 0,

"tipocod": "string",

"licitacion": "string",

"descassumpte": "string",

"descsubassumpte": "string",

"transcod": "string",

"transcodarea": "string",

"assumcodorg": "string",

"subassumcodorg": "string",


"sdenument": "string",

"seccod": "string",

"subseccod": "string",

"sercod": "string",

"subsercod": "string

}

Paràmetres:

sdenum Codi d’Expedient. Obligatori.

percod Codi de Persona.

persnd Codi de Domicili de la Persona.

reprcod Codi de Representant.

reprnd Codi de Domicili del Representant.

areacod Cod d’Àrea.

depcod Codi de Departament.

grupcod Codi de Grup de Treball.

rol Codi de Rol.

entcod Codi Entitat. Per omissió: ‘1’



Pàg. 125/169

texpcod Codi del tipus d’expedient

decnumreg Número decret vinculat.

extrcod Codi Extracte

sdetext Text de l’expedient

arxsigtop Arxiu: signatura topogràfica

identval Valor identificador. Camp lliure

idiomacod Codi d’Idioma.

eventexpr Valor intern ja obsolet.

sdenumtexp Identificador a nivell de tipus d’expedient

sdedomcod Domicili vinculat a l’expedient

sderel Número d’expedient relacionat

resracodec

resrorg

sdedreg Data alta expedient

sdehreg Hora alta expedient

resrdata

connum2

treccod Tipus de recurs.

assumcod Codi d’Assumpte.

subassumcod

Codi de Subassumpte.

sdenumcont

fcontacn Forma de contacte de l’interessat principal

numconordre Número de forma de contacte de l’interessa principal.

tipcod

licitacion Valor obsolet.



Pàg. 126/169

descassumpte

Descripció de l’assumpte

descsubassumpte

Descripció del subassumpte

transcod Tipus de transport

transcodarea Àrea de transport

assumcodorg

subassumcodorg

plataforma Plataforma de notificació.

sdenument Número d’expedient a nivell d’entitat

seccod Codi Secció (classificació documental)

subseccod Codi SubSecció (classificació documental)

sercod Codi Sèrie (classificació documental)

subsercod Codi SubSerie (classificacio documental)

tancamentData

Data tancament

tancamentHora

Hora tancament

tancamentMotiu

Motiu tancament.

tancamentObs

Descripcio motiu tancament

texpcod Tipus Expedient

texpdesc Descripció del Tipus Expedient

En el cos de la petició s’indiquen totes les propietats possibles.

En la petició només cal indicar aquelles propietats que volem modificar, la resta quedaran inalterades.

Excepcions:

Per canviar el Domicili cal enviar perscod i persnd.



Pàg. 127/169

Per canviar el Domicili del Representant cal enviar reprcod i reprnd.

Per canviar Àrea, Departament o Grup, cal enviar les tres dades areacod,

depcod i grupcod.

Per canviar el contacte cal enviar perscod, persnd, numconorde i fcontactn.

Exemple:

Request:

POST /expedients/putsimple

Request body:

{

"nivell": "9999",

"aplicacio": "SDE",


"sdenum": "X2020000001",

"perscod": 1,

"persnd": 1,

"sdetext": "Prova de test"

}

Expected response:

{

"response": true

}

5.7.4 Recuperar un Expedient

Mètode POST

Ruta /expedients/get

Cos de la petició

{

"nivell": "string",


"usuari": "string",

"idioma": 0,



Pàg. 128/169

"nifPersona": "string",

"numeroExpedient": "string"

}

Paràmetres:

idioma Codi d’idioma.

nifPersona NIF de la Persona.

numeroExpedient

Codi d’expedient a recuperar.

Exemple:

Request:

POST /expedients/get

Request body:

{

"numeroExpedient": "X2020000001",

"nivell": "string",


"usuari": "string"

}


{

"perscod": 1,

"entcod": "1",

"fotoRepresentant": null,

"fotoPersona": {

"nom": "AJUNTAMENT DE PROVES",

"nif": "P0826900C",

"particula1": null,

"cognom1": "",

"particula2": null,



Pàg. 129/169

"cognom2": "",

"domicili": "C/ ALMERIA N.0005 Pis.02 CP 17220 SANT FELIU DE GUIXOLS (GIRONA) -

ESPAÑA",

"esPersonaFisica": null

},

"sdenum": "X2020000001",

"texpcod": "GENE",

"texpdesc": "PROCEDIMENT GENÈRIC",

"decnumreg": "",

"notes": null,

"format": 0,

"formatDesc": "Suport electrònic",

"extrcod": "",

"sdetext": "Prova de test",

"arxsigtop": "",

"identval": "",

"idiomacod": "0",

"eventexpr": "",

"stdugr": "G5Admin",

"stdumod": "",

"persnd": 1,

"reprcod": null,

"sdenumtexp": "2480-000001-2020",

"reprnd": null,

"sdedomcod": null,

"sderel": "",

"resracodec": "",

"resrorg": "",

"stddgr": "20200101",

"stdhgr": "203358",

"stddmod": "",

"stdhmod": "",

"sdedreg": "20200101",

"sdehreg": "203358",

"resrdata": "",



Pàg. 130/169

"connum2": 0,

"treccod": "",

"areacod": "AL",

"depcod": "G5AD",

"assumcod": "",

"subassumcod": "",

"tancamentData": "20200702",

"tancamentHora": "125800",

"tancamentMotiu": "Moti",

"tancamentObs": "Tancament expedient via REST",

"sdenumcont": "",

"fcontacn": null,

"numconordre": null,

"tipocod": "",

"licitacion": "",

"descassumpte": "",

"descsubassumpte": "",

"transcod": "",

"transcodarea": "",

"assumcodorg": "",

"subassumcodorg": "",

"sdeExpedientdoms": {

"domiciliArray": []

},

"resEntrelexps": {

"registreArray": []

},

"estats": {

"estatArray": []

},

"descTipusExpedient": "AUTORITZACIONS I CONCESSIONS",

"descExtracte": null,

"resSortidaRels": {

"registreSortidaArray": []

},



Pàg. 131/169

"descPersona": ", AJUNTAMENT DE PROVES",

"descDomiciliPersona": "C/ ALMERIA N.0005 Pis.02 CP 17220 SANT FELIU DE GUIXOLS

(GIRONA) - ESPAÑA",

"descDomiciliSdeDomCod": null,

"descRepresentant": null,

"descDomiciliRepresentant": null,

"nifPersona": "P0826900C",

"nifRepresentant": null,

"plataforma": "",

"sdenument": "2480-000001-2020",

"seccod": "02",

"subseccod": "04",

"sercod": "02",

"subsercod": "",

"baixaSW": 0,

"baixaData": null,

"baixaHora": null,

"grupcod": "GRUP",

"descEstat": "INFORME",

"esRAE": true,

"descDepResp": null

}



Pàg. 132/169

5.7.5 Modificar o afegir dades addicionals

Mètode POST

Ruta /infoadicional/{sdenum}

Paràmetre de ruta

sdenum

De tipus string. Identificador de l’expedient.

Cos de la petició

{


"nivell": "string",

"usuari": "string",

"infoAddicional": [

{

"variable": "string",

"valor": "string",

"varLabel": "string"

}

]

}

Paràmetres:

variable Codi de la dada addicional.

valor Valor a guardar.

varLabel Etiqueta de la dada.

Exemple:

Request:

POST /expedients/infoaddicional/X2020000010

Request body:

{

"aplicacio": "SDE",

"infoAddicional": [



Pàg. 133/169

{

"variable": "DAT1",

"valor": "D1",

"varLabel": "Dada 1"

}

],

"nivell": "9999",

"usuari": "G5Admin"

}

Expected response:

HTTP 200. Empty body.

5.7.6 Esborrar dades addicionals

Mètode DELETE


Paràmetre de ruta

sdenum


Cos de la petició

[

"string"

]

Paràmetres:

array Llista de variables a eliminar.

Exemple:

Request:

DELETE /expedients/infoaddicional/X2020000010

Request body:

[



Pàg. 134/169

"DAT1"

]

Expected response:


5.7.7 Obtenir dades addicionals

Mètode GET


Paràmetre de ruta

sdenum


Exemple:

Request:

GET /expedients/infoaddicional/X2020000010

Expected response:

[

{

"variable": "DAT1",

"valor": "D1",

"varLabel": "Dada 1"

}

]



Pàg. 135/169

5.8 Documents

Descripció Permet guardar i obtenir documents. Consultar i modificar la informació associada a un document.

Ruta /documents

5.8.1 Operacions

Mètode

Ruta Descripció

POST /file Guardar un Document.

GET /file/{guid} Obtenir un Document.

POST /info/{guid} Modificar la informació associada a un Document.

GET /info/{guid} Obtenir la informació associada a un Document.

POST /infoadicional/{idnreg} Modificar o afegir dades addicionals a un Document.

DELETE

/infoadicional/{idnreg} Esborrar dades adicionals a un Document.

GET /infobyidnreg/{idnreg} Obtenir la informació associada a un Document a partir del seu identificador.

Notes: el codi guid es una cadena alfanumèrica única de 36 caràcters que identifica de forma segura un document. L’idnreg es un codi numèric intern.

5.8.2 Guardar un Document

Mètode POST

Ruta /documents/file

Paràmetre file

Arxiu a guardar.

Paràmetre AnnexarDocumentReq

Cadena que conté una objecte JSON amb la següent estructura:

{


"nivell": "string",

"usuari": "string",



Pàg. 136/169

"aplcod": "string",

"docorigen": "string",

"doccod": "string",

"modelcod": "string",

"docnompc": "string",

"descriptor": "string",

"doctip": "string",

"identificador": "string"

}

Exemple:

Request:

POST /document/file

Parameters:

file : arxiu a enviar

AnnexarDocumentReq:

{

"nivell": "9999",


"aplicacio": "SDE",

"aplcod": "SDE",

"docorigen": "REGENT",

"doccod": "INST",

"modelcod": "****",

"docnompc": "test_doc.pdf",

"descriptor": "prova",

"doctip": "EXP",

"identificador": "E2020000001"

}

Expected response:

{

"idnreg": 6020720,



Pàg. 137/169

"guid": "4bf18bd4-c014-4bc9-8933-94520c225d6f"

}

5.8.3 Obtenir un Document

Mètode GET

Ruta /documents/file/{guid}

Paràmetre de ruta

guid

De tipus string. Identificador únic del document.

Exemple (utilitzarem el codi guid obtingut en l’exemple de guradar un document):

Request:

GET /documents/file/4bf18bd4-c014-4bc9-8933-94520c225d6f

Expected response:

File download.

5.8.4 Modificar la informació associada

Mètode POST

Ruta /documents/info/{guid}

Paràmetre de ruta

guid


Cos de la petició

{

"guid": "string",

"doctip": "string",

"doctitol": "string",

"descriptor": "string",


"estatsig": "string",

"motiurebu": "string",

"perscod": 0,



Pàg. 138/169

"sdenum": "string",

"persnd": 0,

"vidsignerGuid": "string",

"vidsignerEstat": 0,

"cmisDocId": 0,

"orgcod": "string",

"dataCaducitat": "string",

"infoAddicional": [

{


"valor": "string",


}

]

}

En el cos de la peticó s’indiquen totes les propietats possibles.

En la petició només cal indicar aquelles propietats que volem modificar, la resta quedaran inalterades.

Exemple:

Request:

POST /documents/info/4bf18bd4-c014-4bc9-8933-94520c225d6f

Request body:

{

"guid": "",

"doctip": "EXP",

"doctitol": "Títol del document",

"descriptor": "Això és un descriptor",

"observacions": "Algun comentari",

"infoAddicional": [

{

"variable": "CAMP1",

"valor": "C1",



Pàg. 139/169

"varLabel": ""

},

{


"valor": "C2",

"varLabel": ""

}

]

}

Expected response:


5.8.5 Obtenir la informació associada

Mètode GET

Ruta /documents/info/{guid}

Paràmetre de ruta

guid


Exemple:

Request:

GET /documents/info/4bf18bd4-c014-4bc9-8933-94520c225d6f


{

"aplcod": "SDE ",

"docorigen": "REGENT ",

"doccod": "INST",

"modelcod": "****",

"docnompc": "test_pdf_22.pdf",

"identificador": "test_pdf_22.pdf",

"docorigenDesc": "Registre Entrada",



Pàg. 140/169

"doccodDesc": "Instància",

"modelcodDesc": "Document annexat",

"doctip": "EXP ",

"idnreg": 6020720,




"stdugr": "G5Admin ",

"stdumod": "G5Admin ",

"stddgr": "20200519",

"stdhgr": "080429",

"stddmod": "20200519",

"stdhmod": "080429",

"estatsig": null,

"motiurebu": null,

"guid": "4bf18bd4-c014-4bc9-8933-94520c225d6f",

"eliminat": null,

"perscod": null,

"sdenum": null,

"persnd": null,

"vidsignerGuid": null,

"vidsignerEstat": null,

"cmisDocId": null,

"orgcod": null,

"dataSessio": null,

"dataCaducitat": null,

"swCciuAmagar": false,

"infoAddicional": [

{


"valor": "C1",

"varLabel": null

},

{




Pàg. 141/169

"valor": "C2",

"varLabel": null

}

]

}

5.8.6 Modificar o afegir dades addicionals

Mètode POST

Ruta /documents/infoadicional/{idnreg}

Paràmetre de ruta

idnreg

De tipus integer. Identificador únic del document.

Cos de la petició

[

{


"valor": "string",


}

]

Exemple:

Request:

POST /documents/infoadicional/6020720

Request body:

[

{

"variable": "VARX",

"valor": "XX",

"varLabel": ""

}

]



Pàg. 142/169

Expected response:


5.8.7 Esborrar dades addicionals

Mètode DELETE

Ruta /documents/infoadicional/{idnreg}

Paràmetre de ruta

idnreg


Cos de la petició

[

"string"

]

En el cos de la petició indicarem les variables a esborrar.

Exemple:

Request:

DELETE /documents/infoadicional/6020720

Request body:

[

“CAMP2”,

"VARX"

]

Expected response:


5.8.8 Obtenir la informació associada a partir de l’identificador de Document.

Mètode GET

Ruta /documents/info/{idnreg}



Pàg. 143/169

Paràmetre de ruta

idnreg


Exemple:

Request:

GET /documents/infobyidnreg/6020720


{

"aplcod": "SDE ",

"docorigen": "REGENT ",

"doccod": "INST",

"modelcod": "****",

"docnompc": "test_pdf_22.pdf",

"identificador": "test_pdf_22.pdf",

"docorigenDesc": "Registre Entrada",

"doccodDesc": "Instància",

"modelcodDesc": "Document annexat",

"doctip": "EXP ",

"idnreg": 6020720,




"stdugr": "G5Admin ",

"stdumod": "G5Admin ",

"stddgr": "20200519",

"stdhgr": "080429",

"stddmod": "20200519",

"stdhmod": "080429",

"estatsig": null,

"motiurebu": null,

"guid": "4bf18bd4-c014-4bc9-8933-94520c225d6f",

"eliminat": null,

"perscod": null,



Pàg. 144/169

"sdenum": null,

"persnd": null,

"vidsignerGuid": null,

"vidsignerEstat": null,

"cmisDocId": null,

"orgcod": null,

"dataSessio": null,

"dataCaducitat": null,

"swCciuAmagar": false,

"infoAddicional": [

{


"valor": "C1",

"varLabel": null

}

]

}

5.9 Organigrama

Descripció Permet consultar i actualitzar la informació de l’organigrama (àrees, departaments, grups de treball i assumptes).

Ruta /organigrama

5.9.1 Operacions

Mètode

Ruta Descripció

POST /arees Crea o modifica una àrea.

GET /arees Recupera totes les àrees.

GET /arees/{areacod} Recupera una àrea.

POST /arees/delete Elimina una àrea.

POST /arees/departaments Crea o modifica un departament.

GET /arees/{areacod}/departaments Recupera tots els departaments d’una àrea.



Pàg. 145/169

GET /arees/{areacod}/departaments/{depcod}

Recupera un departament.

POST /arees/departaments/delete Elimina un departament.

POST /arees/departaments/grupstreball Crea o modifica un grup de treball.

GET /arees/{areacod}/departaments/{depcod}/grupstreball

Recupera tots els grups de treball d’un departments.

GET /arees/{areacod}/departaments/{depcod}/grupstreball/{grupcod}

Recupera un grup de treball.

POST /arees/departaments/grupstreball/delete Elimina un grup de treball.

POST /assumptes Crea o modifica un assumpte.

GET /assumptes Recupera tots els assumptes

GET /assumptes/{assumcod} Recupera un assumpte.

POST /assumptes/delete Elimina un assumpte.

5.9.2 Crea o modifica una àrea.

Mètode POST

Ruta /organigrama/arees

Cos de la petició

{


"nivell": "string",

"usuari": "string",


"areadesc": "string",

"sdeprioritat": 0,

"entcod": "string"

}

Paràmetres:

areacod Codi d’àrea.



Pàg. 146/169

areadesc Descripció d’area.

sdeprioritat

entcod

Exemple:

Request:

POST /organigrama/arees

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",


"areacod": "TST",

"areadesc": "Area de test"

}

Expected response:

{

"nivell": "9999",

"aplicacio": "ORG",


"areacod": "TST",

"areadesc": "Area de test",

"sdeprioritat": null,

"entcod": null

}

5.9.3 Recupera totes les àrees.

Mètode GET

Ruta /organigrama/arees



Pàg. 147/169

Exemple:

Request:

GET /organigrama/arees

Expected response:

[

{

"areacod": "AL",

"areadesc": "ALCALDIA",

"audit": {

"usuariCreacio": null,

"usuariModificacio": null,

"dataCreacio": null,

"dataModificacio": null,

"horaCreacio": null,

"horaModificacio": null

},


"baixasw": 0,

"entcod": "1 "

},

...

]

5.9.4 Recupera una àrea.

Mètode GET

Ruta /organigrama/arees/{areacod}

Paràmetres:


Exemple:



Pàg. 148/169

Request:

GET /organigrama/arees/TST

Expected response:

{



"audit": {

"dataCreacio": "string",

"dataModificacio": "string",

"horaCreacio": "string",

"horaModificacio": "string",

"usuariCreacio": "string",

"usuariModificacio": "string"

},

"baixasw": 0,

"entcod": "string",

"sdeprioritat": 0

}

5.9.5 Elimina una àrea.

Mètode POST

Ruta /organigrama/arees/delete

Cos de la petició

{


"nivell": "string",

"usuari": "string",



"sdeprioritat": 0,

"entcod": "string"

}



Pàg. 149/169

Paràmetres:

areacod Codi d’àrea

areadesc No s’utilitza.

sdeprioritat No s’utilitza.

entcod No s’utilitza

Exemple:

Request:

POST /organigrama/arees/delete

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",


"areacod": "TST"

}

Expected response:

{

"timestamp": "2020-07-31T08:06:33.733+0000",

"status": 200,

"error": "OK",

"message": "Área eliminada.",

"path": "/JGenesysREST/api/organigrama/arees/delete"

}

5.9.6 Crea o modifica un departament.

Mètode POST

Ruta /organigrama/arees/departaments



Pàg. 150/169

Cos de la petició

{


"nivell": "string",

"usuari": "string",


"depcod": "string",

"depdesc": "string",

"depdesc2": "string",

"sdeprioritat": 0,

"responsable": "string"

}

Paràmetres:


depcod Codi de departament.

depdesc Descripció del departament.

depdesc2 Segona descripció del departament.

sdeprioritat

responsable Responsable del departament.

Exemple:

Request:

POST /organigrama/arees/departaments

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",


"areacod": "TST",

"depcod": "DT",



Pàg. 151/169

"depdesc": "Departament de test",

"depdesc2": "Dep. test"

}

Expected response:

{

"nivell": "9999",

"aplicacio": "ORG",


"areacod": "TST",

"depcod": "DT",


"depdesc2": "Dep. test",


"responsable": null

}

5.9.7 Recupera tots els departaments d’una àrea.

Mètode GET

Ruta /organigrama/arees/{areacod}/departaments

Paràmetres:


Exemple:

Request:

GET /organigrama/arees/TST/departaments

Expected response:

[

{

"id": {



Pàg. 152/169

"areacod": "TST",

"depcod": "DT"

},

"orgArea": {

"areacod": "TST",


"audit": {

"usuariCreacio": "G5Admin",

"usuariModificacio": "G5Admin",




"horaModificacio": "101238"

},


"baixasw": 0,

"entcod": " "

},



"audit": {







},


"baixasw": 0,

"responsable": null

},

...

]



Pàg. 153/169

5.9.8 Recupera un departament.

Mètode GET

Ruta /organigrama/arees/{areacod}/departaments/{depcod}

Paràmetres:

areacod Codi d’area.


Exemple:

Request:

GET /organigrama/arees/TST/departaments/DT

Expected response:

{

"id": {

"areacod": "TST",

"depcod": "DT"

},

"orgArea": {

"areacod": "TST",


"audit": {







},


"baixasw": 0,



Pàg. 154/169

"entcod": " "

},



"audit": {







},


"baixasw": 0,

"responsable": null

}

5.9.9 Elimina un departament.

Mètode POST

Ruta /organigrama/arees/departaments/delete

Cos de la petició

{


"nivell": "string",

"usuari": "string",


"depcod": "string",

"depdesc": "string",

"depdesc2": "string",

"sdeprioritat": 0,

"responsable": "string"

}



Pàg. 155/169

Paràmetres:



depdesc No s’utilitza.

Depdesc2 No s’utilitza.

sdeprioritat No s’utilitza.

responsable No s’utilitza.

Exemple:

Request:

POST /organigrama/arees/departaments/delete

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",


"areacod": "TST",

"depcod": "DT"

}

Expected response:

{

"timestamp": "2020-07-31T08:52:13.488+0000",

"status": 200,

"error": "OK",

"message": "Departamento eliminado.",

"path": "/JGenesysREST/api/organigrama/arees/departaments/delete"

}



Pàg. 156/169

5.9.10 Crea o modifica un grup de treball.

Mètode POST

Ruta /organigrama/arees/departaments/grupstreball

Cos de la petició

{


"nivell": "string",

"usuari": "string",


"depcod": "string",


"grupdesc": "string"

}

Paràmetres:



grupcod Codi de grup de treball.

grupdesc Descripció del grup de treball.

Exemple:

Request:

POST /organigrama/arees/departaments/grupstreball

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",


"areacod": "TST",

"depcod": "DT",

"grupcod": "GT",



Pàg. 157/169

"grupdesc": "Grup de test"

}

Expected response:

{

"nivell": "9999",

"aplicacio": "ORG",


"areacod": "TST",

"depcod": "DT",

"grupcod": "GT",

"grupdesc": "Grup de test"

}

5.9.11 Recupera tots els grups de treball d’un departments.

Mètode GET

Ruta /organigrama/arees/{areacod}/departaments/{depcod}/grupstreball

Exemple:

Request:

GET /organigrama/arees/TST/departaments/DT/grupstreball

Expected response:

[

{

"id": {

"areacod": "TST",

"depcod": "DT",

"grupcod": "GT"

},

"orgDepartament": {

"id": {

"areacod": "TST",



Pàg. 158/169

"depcod": "DT"

},

"orgArea": {

"areacod": "TST",


"audit": {







},


"baixasw": 0,

"entcod": " "

},



"audit": {







},


"baixasw": 0,

"responsable": null

},

"grupdesc": "Grup de test",

"audit": {





Pàg. 159/169





},

"baixasw": 0

},

...

]

5.9.12 Recupera un grup de treball.

Mètode GET

Ruta /organigrama/arees/{areacod}/departaments/{depcod}/grupstreball/{grupcod}

Exemple:

Request:

GET /organigrama/arees/TST/departaments/DT/grupstreball/GT

Expected response:

{

"id": {

"areacod": "TST",

"depcod": "DT",

"grupcod": "GT"

},

"orgDepartament": {

"id": {

"areacod": "TST",

"depcod": "DT"

},

"orgArea": {

"areacod": "TST",




Pàg. 160/169

"audit": {







},


"baixasw": 0,

"entcod": " "

},



"audit": {







},


"baixasw": 0,

"responsable": null

},

"grupdesc": "Grup de test",

"audit": {







},



Pàg. 161/169

"baixasw": 0

}

5.9.13 Elimina un grup de treball.

Mètode POST

Ruta /organigrama/arees/departaments/grupstreball/delete

Cos de la petició

{


"nivell": "string",

"usuari": "string",


"depcod": "string",


"grupdesc": "string"

}

Paràmetres:



grupcod Codi de grup de treball.

grupdesc No s’utilitza.

Exemple:

Request:

POST /organigrama/arees/departaments/grupstreball/delete

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",



Pàg. 162/169


"areacod": "TST",

"depcod": "DT",

"grupcod": "GT"

}

Expected response:

{

"timestamp": "2020-07-31T09:14:27.871+0000",

"status": 200,

"error": "OK",

"message": "Grupo de Trabajo eliminado.",

"path": "/JGenesysREST/api/organigrama/arees/departaments/grupstreball/delete"

}

5.9.14 Crea o modifica un assumpte.

Mètode POST

Ruta /organigrama/assumptes

Cos de la petició

{


"nivell": "string",

"usuari": "string",


"depcod": "string",


"assumdesc": "string"

}

Paràmetres:





Pàg. 163/169


assumdesc Descripció de l’assumpte.

Exemple:

Request:

POST /organigrama/assumptes

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",


"assumcod": "AST",

"depcod": "DT",

"areacod": "TST",

"assumdesc": "Assumpte de test"

}

Expected response:

{

"nivell": "9999",

"aplicacio": "ORG",


"assumcod": "AST",

"depcod": "DT",

"areacod": "TST",

"assumdesc": "Assumpte de test"

}

5.9.15 Recupera tots els assumptes

Mètode GET

Ruta /organigrama/assumptes



Pàg. 164/169

Exemple:

Request:

GET /organigrama/assumptes

Expected response:

[

{

"assumcod": "EDIC",

"depcod": "G5AD",

"areacod": "AL",

"assumdesc": "EDICTE",

"orgArea": {

"areacod": "AL",


"audit": {







},


"baixasw": 0,

"entcod": "1 "

},

"orgDepartament": {

"id": {

"areacod": "AL",

"depcod": "G5AD"

},

"orgArea": {

"areacod": "AL",




Pàg. 165/169

"audit": {







},


"baixasw": 0,

"entcod": "1 "

},

"depdesc": "AUDIFILM",

"depdesc2": null,

"audit": {







},


"baixasw": 0,

"responsable": null

},

"baixasw": 0,

"regswa": null,

"audit": {









Pàg. 166/169

}

},

...

]

5.9.16 Recupera un assumpte.

Mètode GET

Ruta /organigrama/assumptes/{assumcod}

Paràmetres:


Exemple:

Request:

GET /organigrama/assumptes/AST

Expected response:

{

"assumcod": "AST",

"depcod": "DT",

"areacod": "TST",

"assumdesc": "Assumpte de test",

"orgArea": {

"areacod": "TST",


"audit": {









Pàg. 167/169

},


"baixasw": 0,

"entcod": " "

},

"orgDepartament": {

"id": {

"areacod": "TST",

"depcod": "DT"

},

"orgArea": {

"areacod": "TST",


"audit": {







},


"baixasw": 0,

"entcod": " "

},



"audit": {







},



Pàg. 168/169


"baixasw": 0,

"responsable": null

},

"baixasw": 0,

"regswa": null,

"audit": {







}

}

5.9.17 Elimina un assumpte.

Mètode POST

Ruta /organigrama/assumptes/delete

Cos de la petició

{


"nivell": "string",

"usuari": "string",


"depcod": "string",


"assumdesc": "string"

}

Paràmetres:




Pàg. 169/169

depcod No s’utilitza.

areacod No s’utilitza.

assumdesc No s’utilitza.

Exemple:

Request:

POST /organigrama/assumptes/delete

Request body:

{

"aplicacio": "ORG",

"nivell": "9999",


"assumcod": "AST"

}

Expected response:

{

"timestamp": "2020-07-31T09:35:07.784+0000",

"status": 200,

"error": "OK",

"message": "Asunto eliminado.",

"path": "/JGenesysREST/api/organigrama/assumptes/delete"

}

ERES 2.0: Document d’integració · 2020. 9. 28. · ERES 2.0 – Document d’integració 2 de...

Documents

Transcript of ERES 2.0: Document d’integració · 2020. 9. 28. · ERES 2.0 – Document d’integració 2 de...