Manual de serveis web BIG 3 - corporatives/BIG/Proveidors... · tipus Paràmetre per poder filtrar...

Via Laietana, 15 Principal 08003 Barcelona Tel. 933 10 60 30 Suport: 638 87 22 22 [email protected]

Manual de serveis web BIG 3.0 20 d’agost de 2013

Via Laietana, 15 Principal 08003 Barcelona Tel. 933 10 60 30 Suport: 638 87 22 22 [email protected]

Índex Introducció ..................................................................................................................... 2

Servei web per fer cerques de media ............................................................................. 2

Procés de cerca ......................................................................................................... 2

Recuperació d’un media mitjançant l’identificador .................................................. 5

Tractament de la sortida ......................................................................................... 5

Servei web per fer cerques de media mitjançant mètodes SOAP .................................. 8

Cerca de media .......................................................................................................... 8

Recuperació de media per ID ................................................................................... 13

Servei web per a la gestió de les quicklists .................................................................. 13

Recuperació de les quicklists disponibles al BIG ...................................................... 14

Recuperació dels valors d’una quicklist .................................................................... 15

Recarregar els valors de les quicklists ..................................................................... 17

Servei web per a la gestió de galeries i col·leccions .................................................... 18

Recuperar les col·leccions d’un usuari ..................................................................... 19

Recuperar les galeries d’un usuari ........................................................................... 21

Recuperar les galeries d’una col·lecció .................................................................... 23

Fer cerques de galeries i col·leccions ...................................................................... 24

Recuperar els media d’una galeria ........................................................................... 25

Recuperar la informació d’una col·lecció o galeria ................................................... 32

Annexos ....................................................................................................................... 34

Configuració d’IPTC al BIG ...................................................................................... 34

Codis dels àlbums del BIG. Valors per a l’IPTC 110................................................. 36

Via Laietana, 15 Principal 2 08003 Barcelona Tel. 933 10 60 30 Suport: 638 87 22 22 [email protected]

Introducció El servei web “bigWS” permet fer cerques i consultes de media al Banc iconogràfic de la Generalitat (BIG) mitjançant peticions HTTP. Els resultats obtinguts es retornen en format XML.

A continuació es detallen les característiques principals del servei web:

Les cerques es poden paginar i ordenar.

Els resultats de les cerques es retornen en un document XML amb una estructura fixa, on s’inclouen, entre d’altres, la metainformació dels media, els URL de previsualitzacions i miniatures, els criteris de cerca utilitzats i la informació de la paginació.

Es fa servir una memòria cau per optimitzar el rendiment.

Recuperació de les llistes de dades (quicklists) utilitzades al BIG.

Recuperació de les col·leccions i les galeries configurades per un usuari.

Recuperació dels media configurats en una galeria.

Servei web per fer cerques de media Procés de cerca Per fer una cerca de media al BIG farem servir l’URL que s’indica tot seguit. Combinant els paràmetres que apareixen al llistat, aquest servei es fa servir en crides get i post. Per fer cerques mitjançant un servei SOAP, mireu els mètodes amb el sufix SOAP. Per exemple, per a la cerca SearchSOAP, a l’apartat mètodes de cerca SOAP:

http:// big.gencat.intranet /bigws/BigWS.asmx/Search

Criteris de cerca (IPTC)

Servei web de cerca del BIG


Servei web: bigws.asmx.

Mètode: Search.

Paràmetre Descripció

nomIPTCx Nom de l’IPTC pel qual volem filtrar la cerca. La x serà un número correlatiu i el farem servir per filtrar per múltiples camps d’IPTC. Si fem constar aquest camp, és obligatori fer constar el corresponent valor *IPTCx. Per exemple, si volem cercar tots els media de l’autor “Pepe”, farem servir la combinació de paràmetres següent: .../Search?nomIPTC1=IPTC080&valorIPTC1=Pepe.

Deixant aquest valor en blanc indiquem que volem cercar el valor en tots els IPTC.

valorIPTCx Criteri de cerca que cal emprar per a l’IPTC relacionat. L’aplicació cercarà tots els media que continguin la paraula introduïda al camp IPTC configurat.

Altres característiques:

Es poden fer servir els caràcters comodí ‘%’ o ‘*’. Per exemple: ...valorIPTC1=Pep*.

Per fer negacions, cal afegir el caràcter ‘!’ al criteri de cerca. Per exemple: ...valorIPTC1=!Pep.

Es poden concatenar diversos paràmetres mitjançant el caràcter ‘;’. Per exemple: ...valorIPTC1=Pep*;Josep*. Aquesta cerca mira si el valor comença per Pep o per Josep.

La mateixa cerca de dalt es pot fer mitjançant els caràcters especials ‘OR’ o ‘AND’. Per exemple: valorIPTC1=Pep* or Josep*.

valorIniIPTCx

valorFiIPTCx

Aquests paràmetres es fan servir per indicar un rang de valors. Per exemple, si l’IPTC seleccionat és una data, podem filtrar entre la combinació de dates indicades. Per exemple, si volem obtenir els media compresos entre les dates de catalogació 01/01/2009 i 01/02/2009: .../Search?nomIPTC1=IPTC030&valorIniIPTC1=20090101&valorFiIPTC1=20090201.

Aquests valors no accepten caràcters comodí.

tipus Paràmetre per poder filtrar pel tipus de media. Hi ha les combinacions següents:

Imatge: recupera només les imatges.


Video: recupera només els vídeos.

So: recupera només els àudios.

Imatge&Video: recupera les imatges i els vídeos.

Imatge&So: recupera les imatges i els àudios.

Video&So: recupera els vídeos i els àudios.

Si no es fa constar, se cercaran tots els tipus de media.

ppal Número del recurs que retornarà com a seleccionat. Si no es fa constar, el valor per defecte és 1.

pagina Número de pàgina per visualitzar. Si no es fa constar, el valor per defecte és 1 (la primera pàgina).

rp_pagina Nombre d’elements per pàgina. Si no es fa constar (0), retornarà tots els elements trobats. No hi haurà paginació.

ordenaIPTC Nom de l’IPTC pel qual es vol ordenar el resultat. Per exemple, ordenació per autor: .../Search?ordenaIPTC=IPTC080.

ordenaTipus Tipus d’ordenació, ascendent o descendent. Per defecte serà descendent. Els valors acceptats són ASC per a ascendent i DESC per a descendent.

codiIdioma Codi de l’idioma en què volem recuperar el títol i la descripció dels media. L’idioma ha de complir el format estàndard ISO. Per exemple: ca_ES. Si no s’envia, es recuperaran els valors en l’idioma català.

Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

* El format de dates ha de ser yyyymmdd.

Exemples d’ús:

Recuperació de tots els media de tipus vídeo de l’autor Pepe:

http:// big.gencat.intranet /bigws/BigWS.asmx/Search?tipus=Video&nomIPTC1=IPTC080&valorIPTC1=Pepe


Recuperació de tots els media de tipus vídeo de l’autor Pepe paginats de 10 en 10; recuperem la pàgina 2 ordenada per autor i decreixent:

http:// big.gencat.intranet /bigws/BigWS.asmx/Search?tipus=Video&nomIPTC1=IPTC080&valorIPTC1=Pepe&rp_pagina=10&pagina=2&ordenaIPTC=IPTC080&ordenaTipus=DESC

Recuperació de tots els media de tipus vídeo de l’autor Pepe paginats de 10 en 10 i catalogats entre les dates 01/01/2009 i 01/05/2009:

http:// big.gencat.intranet /bigws/BigWS.asmx/Search?tipus=Video&nomIPTC1=IPTC080&valorIPTC1=Pepe&nomIPTC2=IPTC030&valorIniIPTC2=20090101&valorFiIPTC2=20090501&rp_pagina=10

Recuperació d’un media mitjançant l’identificador

Per recuperar la informació d’un media mitjançant el seu identificador farem servir la crida següent del servei web:

http:// big.gencat.intranet /bigws/BigWS.asmx/Search?id=xxxxxxxxxx


Id Identificador del media.

codiIdioma Codi ISO de l’idioma

Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

Tractament de la sortida

El servei web del BIG de cerca ens retornarà un document en format XML. A continuació se’n detallen els valors principals:

A l’apartat “query” es retornen els criteris de cerca i ordenació utilitzats.


<?xml version="1.0" encoding="utf-16"?>

<llista_medias xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<results>

<query>

<iptcs>

<iptc>

<nom>IPTC080</nom>

<valor>Fris imatge</valor>

</iptc>

</iptcs>

<tipus>Imatge</tipus>

<ordenacio />

</query>

A l’apartat “medias” obtindrem el resultat de la cerca realitzada. En groc s’han introduït algunes descripcions.

<medias>

<media seleccionat="1"> Correspon al paràmetre ppal

<identificador>000003126</identificador>

<titol />

<descripcio>Vista parcial de l'Hospital de la Vall d'Hebron de Barcelona (Barcelonès). Foto: Fris imatge</descripcio>

<data />

<autor>Fris imatge</autor>

<fullmedia>http://www.gencat.cat/big/img/BIG_000003126_00.jpg</fullmedi

a> Imatge principal, si és un vídeo, l’URL del vídeo

<preview /> Imatge de previsualització (amb vídeos i àudios)

<thumbnail>http://www.gencat.cat/big/img/BIG_000003126_01.jpg</thumbnai

l> Imatge miniatura. Imatge de 200 px

<amplada>2362</amplada>

<alcada>2362</alcada>



<iptcs> Llistat de tots els IPTC que estan omplerts al media. Cal tenir en compte que els IPTC amb més d’un valor estaran repetits per a cada valor.

<iptc>

<nom>IPTC2:7</nom>

<valor>Publicat</valor>

</iptc>

<iptc>

<nom>IPTC2:20</nom>

<valor>Salut</valor>

</iptc>

<iptc>

<nom>IPTC2:20</nom>

<valor>Hospitals (XHUP)</valor>

</iptc>

<iptc>

<nom>IPTC2:20</nom>

<valor>Regió Sanitària Barcelona</valor>

</iptc>

<iptc>

<nom>IPTC2:20</nom>

<valor>Hospital General Vall d'Hebron</valor>

</iptc>

……………………………

</iptcs>

</media>

<media seleccionat="0">

..............

Informació de la paginació

<paginacion>

<paginastotales>4</paginastotales>


<paginaActual>1</paginaActual>

<anterior>1</anterior>

<paginas>

<pagina>

<indice>1</indice>

</pagina>

<pagina>

<indice>2</indice>

</pagina>

<pagina>

<indice>3</indice>

</pagina>

<pagina>

<indice>4</indice>

</pagina>

</paginas>

<siguiente>2</siguiente>

<elementosPagina>50</elementosPagina>

<numeroElementos>188</numeroElementos> Elements totals trobats

</paginacion>

Servei web per fer cerques de media mitjançant mètodes SOAP Aquests mètodes són iguals que els mètodes anteriors, amb la diferència que es poden fer servir utilitzant el protocol SOAP:

http:// big.gencat.intranet /bigws/BigWS.asmx?wsdl

Cerca de media Mètode: SearchSOAP.

Descripció: fa cerques de media públics del BIG fent servir certs criteris de cerca.

Paràmetres:



nomsIPTCs Conjunt d’IPTC on volem fer la cerca. Els diferents IPTC estaran separats pel caràcter #. Exemples d’utilització:

nomsIPTCs= IPTC080#IPTC120 Cerques per autor i descripció.

nomsIPTCs= Si es deixa el camp en blanc, es farà la cerca del valor seleccionat a qualsevol camp. Si volem combinar una cerca a qualsevol camp i autor, per exemple, farem: nomsIPTCs = IPTC080#.

valorsIPTCs Criteris de cerca utilitzats. Hem de tenir els mateixos valors que noms utilitzats. O sigui, si fem una cerca per qualsevol camp i el camp “autor” tindrem els valors següents:

nomsIPTCs = #IPTC080

valorsIPTCs = qualsvolValor#autor

Si fem servir els valors Ini i Fi, podrem deixar aquest camp en blanc. Ara bé, si fem cerques combinant els tres camps, és obligatori que els camps tinguin el mateix nombre de valors que IPTC introduïts. Per exemple, si volem fer una cerca de media d’un autor en un període de dates determinat i amb la paraula clau monument, farem servir els valors següents:

nomsIPTCs = IPTC080#IPTC055#IPTC020

valorsIPTCs = Autor##monument

valorsIniIPTCs = #01/01/2009#

valorsFiIPTCs = #01/02/2009#

Fixeu-vos que tenim els mateix nombre de caràcters separadors en tots tres paràmetres.

Accepta les mateixes característiques explicades en la cerca i el paràmetre valorIPTCx (concatenació de valors amb AND i OR, negacions, caràcters comodí, etc.).

valorsIniIPTCs

valorsFiIPTCs

Aquests paràmetres es faran servir per indicar un rang de valors. Per exemple, Si l’IPTC seleccionat és una data, podrem filtrar entre la combinació de dates indicades. Per exemple, si volem els media compresos entre les dates de catalogació 01/01/2009 i 01/02/2009: valorsIniIPTCs=01/01/2009 i valorsFiIPTCs= 01/02/2009.

Aquests valors no accepten caràcters comodí.

tipus Paràmetre per poder filtrar pel tipus de media. Hi ha les combinacions següents:


Imatge: recupera només les imatges.

Video: recupera només els vídeos.

So: recupera només els àudios.

Imatge&Video: recupera les imatges i els vídeos.

Imatge&So: recupera les imatges i els àudios.

Video&So: recupera els vídeos i els àudios.

Si no es fa constar, se cercaran tots els tipus de media.

ppal Número del recurs que retornarà com a seleccionat. Si no es fa constar (0), el valor per defecte és 1.

pagina Número de pàgina per visualitzar. Si no es fa constar (0), el valor per defecte és 1 (la primera pàgina).

rp_pagina Nombre d’elements per pàgina. Si no es fa constar (0), retornarà tots els elements trobats. No hi haurà paginació.

ordenaIPTC Nom de l’IPTC pel qual es vol ordenar el resultat. Per exemple, ordenació per autor: .../Search?ordenaIPTC=IPTC080

ordenaTipus Tipus d’ordenació, ascendent o descendent. Per defecte serà descendent. Els valors acceptats són ASC per a l’ascendent i DESC per a la descendent.

codiIdioma Idioma (format ISO) amb el qual es volen els valors Títol i Descripció del media. Per defecte és ca_ES.

Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

* El format de dates ha de ser yyyymmdd.

Resultat: objecte MediaListXML:


MediaListXML:

Results: objecte de resultat, conté els criteris de cerca, el llistat de media resultat i la informació de la paginació.

Error: informació de l’error, si es produeix.

Query:

Iptcs: llistat d’IPTC utilitzats per filtrar el resultat.

Tipus: indica els tipus de media que es volen recuperar (imatges, vídeos i/o àudios).

Ordenació: indica l’ordenació utilitzada.

Galeria: identificador de la galeria utilitzada per filtrar el resultat.

Media:

Seleccionat: indica si el media està seleccionat. Aquest valor s’ha mantingut per la compatibilitat amb les galeries GECO.

Identificador: identificador del BIG del media.


Títol: títol del media configurat al BIG.

Descripció: descripció del media configurada al BIG.

Data: data original del media configurada al BIG.

Autor: autor del media configurat al BIG.

FullMedia: URL del media.

Preview: imatge de previsualització. No escau en el cas de les imatges, només en el cas de vídeos i àudios.

Thumbnail: imatge miniatura (imatge de 200 píxels).

Amplada: amplada del media. No escau en el cas dels àudios.

Alçada: alçada del media. No escau en el cas dels àudios.

Tipus: tipus de media (imatge, vídeo o àudio).

IPTCS: llistat d’IPTC del media configurats al BIG. Aquest llistat conté tota la bossa de dades del media (vegeu l’apèndix per a més informació).

hasFullInfo: indica si s’ha recuperat tota la informació del media (true).

Path: camí del media; es fa servir junt amb la funció d’aquest servei web per recuperar un media pel seu identificador.

IPTC:

Nom: nom de l’ITPC. El format serà IPTCxxx, on xxx és el codi numèric de l’IPTC. Exemples: IPTC005, IPTC120, etc.

Valor: valor de l’IPTC.

valorInicial: valor configurat a la cerca com a valorInicial.

valorFinal: valor configurat a la cerca com a valorFinal.

Paginació:

paginasTotales: nombre de pàgines totals calculades segons les propietats elementosPagina i numeroElementos trobades.

paginaActual: pàgina actual.

anterior: pàgina anterior.

siguiente: pàgina següent.

elementosPagina: elements per pàgina configurats.


numeroElementos: nombre d’elements totals trobats.

Ordenació (no correspon en el cas del servei web de galeries, ja que les galeries són ordenades des del BIG):

Iptc: IPTC configurat per l’usuari pel qual es vol ordenar.

Tipus: tipus d’ordenació “asc” ascendent, “desc” descendent.

Recuperació de media per ID Mètode: SearchByIdSOAP.

Descripció: recupera la informació del media seleccionat.

Paràmetres:


Id Identificador del media que es vol recuperar.

codiIdioma Idioma (format ISO) amb què es volen els valors Títol i Descripció del media. Per defecte és ca_ES.

Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

Resultat: objecte MediaListXML (vegeu l’apartat anterior).

Servei web per a la gestió de les quicklists Les quicklists són els llistats de paraules predefinits utilitzats al BIG per fer les catalogacions. Hi ha dos tipus de quicklists, les taxonomies, que equivalen a llistats jeràrquics, o sigui, valors relacionats entre ells, i els llistats simples.

Exemples:


Taxonomia Llistat simple

Per veure tots els mètodes disponibles i el fitxer de definició, podeu accedir a l’adreça següent:

http://big.gencat.intranet/bigws/Quicklists.asmx

A continuació es descriuen els diferents mètodes disponibles:

Recuperació de les quicklists disponibles al BIG Aquest mètode recupera la llista de quicklists disponibles al BIG, amb el seu identificador, el seu nom i un camp que ens indicarà si es tracta d’un llistat simple o una taxonomia.

Mètode: GetQuickLists.

Paràmetres: no rep paràmetres.

Resultat: llista d’objectes QuickList:

Id: identificador.

Nom: nom de la quicklist.

IsTaxonomia: indica si els valors de la quicklist són una taxonomia, és a dir, que els valors estan jerarquitzats, tenen

<ArrayOfQuickList>

<QuickList>

<Id>1</Id>

<Nom>Categories</Nom>

<IsTaxonomia>true</IsTaxonomia>

</QuickList>

...........

</ArrayOfQuickList>


pare i/o fills. La millor manera de pintar el resultat és en forma d’arbre.

En cas contrari, tindrem una llista de valors simples (=false).

Recuperació dels valors d’una quicklist Hi ha tres mètodes per a la recuperació dels valors d’una quicklist:

GetQuickList: recupera tots els valors d’una quicklist de tipus llistat simple. En cas que hi hagi taxonomia, es recuperaran els valors del primer nivell. Per a aquest cas, el combinarem amb crides al mètode GetChildValues per recuperar els respectius valors fill.

GetChildValues: mètode per recuperar els valors fills d’un valor. Aquest mètode té sentit utilitzar-lo en les quicklists que siguin taxonomies.

SearchValues: recupera els valors trobats de la quicklist seleccionada, segons un criteri de cerca.

A continuació es mostren amb més detall:

Mètode: GetQuickList.

Descripció: aquest mètode recupera tots els valors d’una quicklist, en cas que es tracti d’un llistat simple. Per al cas de les taxonomies, es recuperaran els valors del primer nivell.

Paràmetres:

Paràmetre Tipus Descripció

idQuicklist Long Identificador de la quicklist que es vol recuperar.

Resultat: objecte Quicklist amb els valors del primer nivell emplenats:

-Id : long-Nom : string-IsTaxonomia : bool-Valors : ValorQuickList

QuickList

-Id : long-Value : string-HasChilds : bool

ValorQuickList1

*

0..*

*

<QuickList>

<Id>1</Id>

<Nom>Categories</Nom>

<IsTaxonomia>true</IsTaxonomia>

<Valors>

<ValorQuickList>


ValorQuickList:

Id: identificador del valor.

Value: literal del valor en l’idioma per defecte (català).

HasChilds: indica si el valor té valors associats.

<Id>145351</Id>

<Value>A.D. Tramontana</Value>

<HasChilds>true</HasChilds>

</ValorQuickList>

.......

</Valors>

</QuickList>

Mètode: GetChildValues.

Descripció: recupera els valors fill d’un valor pare seleccionat.

Paràmetres:


idValorPare String Identificador del valor pare dels fills que es vol recuperar.

Resultat: llistat de valors fills:

ValorQuickList:




<ArrayOfValorQuickList>

<ValorQuickList>

<Id>145351</Id>



</ValorQuickList>

.......

</Valors>

</ArrayOfValorQuickListt>

Mètode: SearchValues.

Descripció: realitza cerques de valors en una quicklist seleccionada.


Paràmetres:


idQuicklist Long Identificador de la quicklist seleccionada.

Criteri String Criteri de cerca.

Resultat: llistat de valors trobats. Si se cerca en una quicklist de tipus taxonomia, es recuperaran els valors junt amb els pares, per poder mostrar el resultat en arbre:

ValorQuickList:




Childs: fills del valor. Objectes ValorQuickList. La relació és de 0...*

<ArrayOfValorQuickList>

<ValorQuickList>

<Id>145351</Id>



[<Childs>

<ValorQuickList>

<Id>134234</Id>

<Value>XXXXXX</Value>

<HasChilds>false</HasChilds>

</ValorQuickList>

.........

</Childs>]

</ValorQuickList>

.......

</Valors>

</ArrayOfValorQuickListt>

Recarregar els valors de les quicklists Per optimitzar la recuperació dels valors de les quicklists, aquests es mantenen a la memòria. Per evitar desincronitzacions amb els valors introduïts al BIG, s’han


implementat un parell de mètodes per poder recarregar (elimina de la memòria cau els valors perquè es tornin a calcular) una quicklist determinada o totes.

Mètode: ReloadQuicklist.

Descripció: recarrega els valors de la quicklist passada com a paràmetre.

Paràmetres:


idQuicklist Long Identificador de la quicklist que es vol recarregar.

Resultat: retorna “true” si es recarrega correctament, i “false” en cas contrari.

Mètode: ReloadAllQuicklists.

Descripció: recarrega totes les quicklists. Aquest mètode és útil per quan s’afegeixin noves quicklists al BIG.

Paràmetres: no rep cap paràmetre.

Resultat: retorna “true” si es recarrega correctament, i “false” en cas contrari.

Servei web per a la gestió de galeries i col·leccions Les col·leccions són agrupacions de galeries (contenen un conjunt de galeries), i les galeries són una agrupació de media ordenats pels usuaris.

Per veure tots els mètodes disponibles i el fitxer de definició, podeu accedir a l’adreça següent:

http://big.gencat.intranet/bigws/Galeries.asmx


A continuació es descriuen els diferents mètodes disponibles:

Recuperar les col·leccions d’un usuari Mètode: GetColleccions.

Descripció: recupera totes les col·leccions de l’usuari seleccionat.

Paràmetres:


idUsuari String Identificador de l’usuari al BIG.

codiIdioma String Codi ISO de l’idioma (opcional, per defecte ca_ES)

Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR


oc_FR

Pagina Int Número de pàgina que es vol recuperar.

Rp_pagina Int Nombre d’elements per pàgina. Si s’envia un valor igual a 0 o inferior, vol dir que no es vol paginació i es recuperaran tots els elements trobats.

Resultat: llista d’objectes Recurs (Col·lecció) de l’usuari seleccionat disponibles al programari BIG:

Id: identificador.

Nom: nom descriptiu de la col·lecció.

Descripció: descripció més acurada de la col·lecció (camp opcional).

DataCreacio: data de creació de la col·lecció.

DataModificacio: data de modificació de la col·lecció.

DataPublicació: data de publicació de la col·lecció (estarà buida, ja que les col·leccions no es publiquen).

TipusRecurs: indica el tipus de recurs. Col·lecció = 2, Galeria = 3.

Galeries: llistat de les galeries de la galeria.

<ArrayOfRecurs>

<Recurs>

<Id>89</Id>

<Nom>Col·lecció 1</Nom>

<Descripcio>Col·lecció de prova 1</Descripcio>

<DataModificacio>2009-09-01T13:10:39</DataModificacio>

<DataCreacio>2009-08-26T15:00:25</DataCreacio>

<DataPublicacio/>

<TipusRecurs>

<Id>2</Id>

<Nom>Galeria</Nom>

</TipusRecurs>

<Galeries>

<Recurs>

<Id>90</Id>

<Nom>Galeria 1</Nom>

<Descripcio>Galeria de prova</Descripcio>


<DataCreacio>2009-08-


26T15:00:25</DataCreacio>

<DataPublicacio xsi:nil="true"/>

<TipusRecurs>

<Id>3</Id>

<Nom>Galeria</Nom>

</TipusRecurs>

</Recurs>

......

</Galeries>

</Recurs>

....

</ArrayOfRecurs>

Si l’usuari passat com a paràmetre no existeix, es llança l’excepció GenericBigException amb el missatge d’error Identificador d’usuari no vàlid.

Si l’usuari no té col·leccions definides, es retorna un llistat buit.

Recuperar les galeries d’un usuari Mètode: GetGaleries.

Descripció: recupera totes les galeries de l’usuari seleccionat.

Paràmetres:


idUsuari String Identificador de l’usuari al BIG.


Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR


oc_FR


Rp_pagina Int Nombre d’elements per pàgina. Si s’envia un valor igual a 0 o inferior, vol dir que no es vol paginació i es recuperaran tots els elements trobats

Resultat: llista d’objectes Recurs (Galeria) de l’usuari seleccionat disponibles al programari BIG:

Id: identificador.

Nom: nom descriptiu de la galeria.

Descripcio: descripció més acurada de la galeria (camp opcional).

DataCreacio: data de creació de la galeria.

DataModificacio: data de modificació de la galeria.

DataPublicació: data de publicació de la galeria.

Preview: imatge de previsualització (portada de la galeria).

Thumbnail: imatge miniatura de la galeria (portada de la galeria)

PlayList: URL de la llista de

<ArrayOfRecurs>

<Recurs>

<Id>89</Id>


<Descripcio>Galeria de prova 1</Descripcio>




<Preview>

http://www.gencat.cat/big/

img/000/BIG_000008441_00.jpg

</Preview>

<Thumbnail>

http://www.gencat.cat/big/

img/000/BIG_000008441_01.jpg

</Thumbnail>

<PlayList>

http://www.gencat.cat/big/list/playlist_75.xml

</PlayList>

</Recurs>


reproducció (playlist), si la galeria està publicada; en cas contrari estarà buit.

....

</ArrayOfRecurs>


Si l’usuari no té galeries definides, es retorna un llistat buit.

Recuperar les galeries d’una col·lecció Mètode: GetGaleriesColleccio.

Descripció: recupera totes les galeries de la col·lecció seleccionada.

Paràmetres:


idColeccio Long Identificador de la col·lecció.


Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR


Rp_pagina Int Nombre d’elements per pàgina. Si s’envia un valor igual a 0 o inferior, vol dir que no es vol paginació i es recuperaran tots els elements trobats.

Resultat: llista d’objectes Recurs (Galeria) de l’usuari seleccionat disponibles al programari BIG. Veure resultat de l’apartat “Recuperar les galeries d’un usuari”

Si la col·lecció passada com a paràmetre no existeix, es llança l’excepció GenericBigException amb el missatge d’error Identificador de col·lecció no vàlid.


Si la col·lecció no té galeries definides, es retorna un llistat buit.

Fer cerques de galeries i col·leccions Mètode: Search.

Descripció: fa cerques de galeries i col·leccions.

Paràmetres:


idUsuari String Identificador de l’usuari al BIG. Aquest camp és obligatori.

coleccio String Paràmetre per filtrar pel nom de la col·lecció. Optatiu, si es deixa blanc es farà la cerca a totes les col·leccions.

galeria String Paràmetre per filtrar pel nom de la galeria. Si no s’indica, es recuperaran totes les galeries.


Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

Resultat: llista d’objectes Recurs que compleixen els criteris de cerca:

Id: identificador.

Nom: nom descriptiu de la col·lecció.

Descripcio: descripció més

<ArrayOfRecurs>

<Recurs>

<Id>89</Id>






acurada de la col·lecció (camp opcional).

DataCreacio: data de creació de la col·lecció.

DataModificacio: data de modificació de la col·lecció.

DataPublicació: data de publicació de la col·lecció (estarà buida, ja que les col·leccions no es publiquen).

Tipus de recurs: indica el tipus de recurs, Col·lecció o Galeria.

Galeries: llistat de les galeries de la galeria.

<DataPublicacio/>

<TipusRecurs>

<Id>2</Id>

<Nom>Col·lecció</Nom>

</TipusRecurs>

<Galeries>

<Recurs>

<Id>90</Id>


<Descripcio>Galeria de prova</Descripcio>




</Recurs>

......

</Galeries>

</Recurs>

....

</ArrayOfRecurs>


Si no es troben resultats es mostra un llistat buit.

Recuperar els media d’una galeria Mètode: GetMediesGaleria.

Descripció: recupera els media associats a una galeria d’una manera paginada i ordenats segons la configuració realitzada al BIG.


Paràmetres:


idGaleria String Identificador de la galeria.

pagina Integer Número de pàgina que es vol recuperar. Es comença amb la pàgina 1.

rp_pagina Integer Nombre de media per cada pàgina.

ppal Integer Element seleccionat. Aquest paràmetre s’ha mantingut per compatibilitat amb el servei web de cerca.


Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

Resultat: objecte MediaListXML:


MediaListXML:

Results: objecte de resultat, conté els criteris de cerca, el llistat de media resultat i la informació de la paginació.

Error: informació de l’error, si es produeix.

Query:

Iptcs: llistat d’IPTC utilitzats per filtrar el resultat.

Tipus: indica els tipus de media que es volen recuperar. Imatges, vídeos i/o àudios.

Ordenació: indica l’ordenació utilitzada.

Galeria: identificador de la galeria utilitzada per filtrar el resultat.

Media:

Seleccionat: indica si el media està seleccionat. Aquest valor s’ha mantingut per la compatibilitat amb les galeries GECO.

Identificador: identificador del BIG del media.

Títol: títol del media configurat al BIG.

Descripció: descripció del media configurada al BIG.

Data: data original del media configurada al BIG.

Autor: autor del media configurat al BIG.

FullMedia: URL del media.

Preview: imatge de previsualització. Per al cas de les imatges no escau, només per a vídeos i àudios.

Thumbnail: imatge miniatura (imatge de 200 píxels).

Amplada: amplada del media. Per a un àudio no escau.

Alçada: alçada del media. Per a un àudio no escau.

Tipus: tipus de media, imatge, vídeo o àudio.

IPTCS: llistat d’IPTC del media configurats al BIG. Aquest llistat conté tota la bossa de dades del media (vegeu l’apèndix per a més informació).

hasFullInfo: indica si s’ha recuperat tota la informació del media (true).

Path: camí del media, el farem servir junt amb la funció d’aquest servei web per recuperar un media pel seu identificador.


IPTC:

Nom: nom de l’ITPC. El format ha de ser IPTCxxx, on xxx és el codi numèric de l’IPTC. Exemples: IPTC005, IPTC120, etc.

Valor: valor de l’IPTC.

valorInicial: valor configurat a la cerca com a valorInicial.

valorFinal: valor configurat a la cerca com a valorFinal.

Paginació:

paginasTotales: nombre de pàgines totals calculat segons les propietats elementosPagina i numeroElementos trobades.

paginaActual: pàgina actual.

anterior: pàgina anterior.

siguiente: pàgina següent.

elementosPagina: elements per pàgina configurats.

numeroElementos: nombre d’elements totals trobats.

L’Ordre dels elements serà el configurat a BIG.

Exemple de resultat en XML:

<llista_medias xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://big.gencat.intranet/">

<results>

<query>

<iptcs />

<ordenacio />

<galeria>114</galeria>

</query>

<medias>

<media seleccionat="1">

<identificador>642385716081709</identificador>

<titol />


<descripcio />

<data />

<autor />

<fullmedia>http://www.gencat.cat/big/img/642/BIG_642385716081709_00.jpg</fullmedia>

<preview>http://www.gencat.cat/big/img/642/BIG_642385716081709_00.jpg</preview>

<thumbnail>http://www.gencat.cat/big/img/642/BIG_642385716081709_01.jpg</thumbnail>

<amplada />

<alcada />


<iptcs />

<hasFullInfo>false</hasFullInfo>

<path>\\WNBIG2P01\ALBUMS1\CATSALUT\642385716081709.jpg</path>

</media>

..............

</medias>

<links />

<paginacion>

<paginastotales>1</paginastotales>

<paginaActual>1</paginaActual>

<anterior>1</anterior>

<paginas />

<siguiente>1</siguiente>

<elementosPagina>10</elementosPagina>

<numeroElementos>7</numeroElementos>

</paginacion>

</results>

<error>

<descripcio />


</error>

</llista_medias>

També es podrien recuperar els media d’una galeria fent servir el servei web de cerca, passant com a paràmetre l’identificador de la galeria on es troben els media. Per exemple:

http:// big.gencat.intranet /bigws/BigWS.asmx/Search? nomIPTC1=IPTC560&valorIPTC1=identificadorDeGaleria

A més es poden filtrar els resultats introduint altres criteris de cerca i reordenar la galeria per algun dels IPTC.

Mètode: GetMediesGaleriaInfo.

Descripció: recupera els media associats a una galeria d’una manera paginada i ordenats segons la configuració realitzada al BIG. A més, també recupera la informació de la galeria relacionada.

Paràmetres:


idGaleria String Identificador de la galeria.

pagina Integer Número de pàgina que es vol recuperar. Es comença amb la pàgina 1.

rp_pagina Integer Nombre de media per cada pàgina.

ppal Integer Element seleccionat. Aquest paràmetre s’ha mantingut per compatibilitat amb el servei web de cerca.


Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

Resultat: objecte MediaListInfoXML:


Galeria:

nom: Nom de la galeria en l’idioma seleccionat. Si el nom, amb l’idioma seleccionat, no es troba informat, es retornarà en català (idioma per defecte)

descripcio: Descripció de la galeria en l’idioma seleccionat. Si la descripció, amb l’idioma seleccionat, no es troba informat, es retornarà en català (idioma per defecte).

portada: url de la imatge de portada de la galeria configurada al BIG.

playlist: url del fitxer playlist relacionat amb la galeria. Si la galeria no s’ha configurat com a playlist, aquest camp estarà en blanc

Per obtenir més informació de la resta de camps, mireu el mètode anterior, GeteMediesGaleria

! Qualsevol canvi que es faci a les galeries dins del BIG, provocarà l’eliminació de les memòries cau relacionades, mostrant automàticament els nous canvis a les pàgines on es trobin configurades.


Recuperar la informació d’una col·lecció o galeria Mètode: GetColleccio.

Descripció: recupera la informació de la col·lecció. No recupera les galeries associades a la col·lecció, si voleu aquesta funcionalitat, heu de cridar al mètode GetGalereisColleccio.

Paràmetres:


idColleccio Long Identificador de la col·lecció


Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR

oc_FR

Mètode: GetGaleria.

Descripció: recupera la informació de la galeria. No recupera els media associats. Si voleu recuperar els media d’una galeria, consulteu el mètode GetMediasGaleria o GetMediasGaleriaInfo

Paràmetres:


idColleccio Long Identificador de la col·lecció


Idiomes acceptats:

ca_ES

es_ES

en_GB

fr_FR


oc_FR

Resultat: objecte Recurs:

Id: identificador.

Nom: nom descriptiu de la col·lecció/galeria.

Descripcio: descripció més acurada de la col·lecció/galeria (camp opcional).

DataCreacio: data de creació.

DataModificacio: data de modificació.

DataPublicació: data de publicació (obsolet, mateixa data que la data de modificació).

Tipus de recurs: indica el tipus de recurs, Col·lecció o Galeria.

Preview: url de la imatge de portada amb la mida màxima de 600px d’amplada.

Thumbnail: url de la imatge de portada amb la mida màxima de 200px d’amplada.

Playlist: url de la playlist Per les col·leccions estarà en

<Recurs>

<Id>89</Id>





<DataPublicacio/>

<TipusRecurs>

<Id>2</Id>

<Nom>Col·lecció</Nom>

</TipusRecurs>

<Galeries/>

<Preview>//www.gencat.cat/big/img/xxx/BIG_xxxxxxxx_00.jpg</Preview>

<Thumbnail>//www.gencat.cat/big/img/xxx/BIG_xxxxxxx_01.jpg</Thumbnail>

<PlayList/>

<HasFathers>false</HasFathers>

</Recurs>


blanc

HasFathers: Per les col·leccions aquest valor estarà en blanc. Per les galeries, estarà informat si pertany a alguna col·lecció, indicant que té pares.

Annexos Configuració d’IPTC al BIG A la taula següent es mostra la configuració d’IPTC utilitzada al BIG 2.0:

IPTC Descripció

005 Títol en català (idioma per defecte).

010 Codi de colors amb la prioritat (1 = urgent, 5 = normal i 8 = sense urgència).

020 Categories a les quals pertany el media.

025 Paraules clau.

030 Data de catalogació. Format: MM/DD/YYYY.

040 Restriccions d’ús del media.

055 Data original del media. Format: MM/DD/YYYY.

080 Autor del media.

090 Municipi.

095 Comunitat autònoma.

100 Codi de país (exemple: ESP (Espanya), FRA (França)).

101 País (literal del país).

110 Sigles de l’àlbum relacionat al BIG.

116 Conté els drets d’autor del media.

120 Descripció del media en català.

230 Notes dels usuaris.


502 Nom original del media.

503 Format d’origen (exemple, diapositiva, foto en paper, etc.).

505 Referència 1 (camp lliure per als usuaris).

506 Referència 2 (camp lliure per als usuaris).

507 Idioma de locució (per a vídeos o àudios). Valors acceptats:

Angles

Castella

Catala

Frances

Occita

en_GB

es_ES

ca_ES

fr_FR

oc_FR

510 Noms propis (paraules clau que contenen noms propis).

511 Data de caducitat. Format: MM/DD/YYYY.

520 Adreça.

521 Àrea (té a veure amb la localització).

522 Localitat.

523 Comarca.

524 Província.

541 Coordenada GPS X.

542 Coordenada GPS Y.

543 Coordenada GPS Z

544 Latitud (coordenades per Google Maps).

545 Longitud (Coordenades per Google Maps).

560 Llista d’identificadors de galeries on es troba el media.

561 Llista d’identificadors de col·leccions on es troba el media (només per a cerques).


562 Enllaços relacionats en català. El format d’un enllaç és el següent:

Nom de l’enllaç[##]Adreça de l’enllaç

563 No visible al cercador multimèdia Gencat.cat (S = no visible).

564 Identificador del vídeo a YouTube (Si el vídeo no es troba publicat a YouTube, aquest valor estarà en blanc). Amb aquest identificador es pot muntar l’adreça per visualitzar el vídeo de la següent manera: http://www.youtube.com/watch?v=[id] on s’ha de substituir [id] per l’identificador recuperat.

565 Estat de la publicació del vídeo a YouTube, possibles valors:

Sense valor : El vídeo no es troba publicat a YouTube.

Publicat : El vídeo es troba publicat a YouTube

Processant : El vídeo es troba en procés de publicació/despublicació a/de YouTube

566 Indica si el media es troba configurat com lliure de drets (S)

567 Identificador del vídeo a Nice People.

601 Títol en castellà (si no està indicat, retorna el literal en català).

611 Títol en anglès (si no està indicat, retorna el literal en català).

621 Títol en francès (si no està indicat, retorna el literal en català).

631 Títol en occità (si no està indicat, retorna el literal en català).

602 Descripció en castellà (si no està indicat, retorna el literal en català).

612 Descripció en anglès (si no està indicat, retorna el literal en català).

622 Descripció en francès (si no està indicat, retorna el literal en català).

632 Descripció en occità (si no està indicat, retorna el literal en català).

603 Enllaços relacionats en castellà. Mirar el valor 563 per veure el format.

613 Enllaços relacionats en anglès. Mirar el valor 563 per veure el format.

623 Enllaços relacionats en francès. Mirar el valor 563 per veure el format.

633 Enllaços relacionats en occità. Mirar el valor 563 per veure el format.

Codis dels àlbums del BIG. Valors per a l’IPTC 110


Codi àlbum Descripció

DGAC Direcció General d’Atenció Ciutadana i Difusió

DGCG Direcció General de Comunicació del Govern

DGPC Direcció General del Patrimoni Cultural

GISA Gestió d’Infraestructures, SA (GISA)

CATSALUT CatSalut

DMAH Medi Ambient

DIRIP Departament d’Interior

DAR Departament d'Agricultura, Ramaderia, Pesca, Alimentació i Medi Natural

DGDC Palau Robert

ICAEN Institut Català de l’Energia

INCASOL Institut Català del Sòl (INCASÒL)

DPTOP Departament de Territori i Sostenibilitat

DASC Departament de Benestar Social i Família

ILC Institució de les Lletres Catalanes

CPCPTC Centre de Promoció de la Cultura Popular i Tradicional Catalana

ICDONES Institut Català de les Dones

PMM Patronat de la Muntanya de Montserrat

DJUSTICIA Departament de Justícia

CULTURA Departament de Cultura

EDUCACIO Departament d’Ensenyament

VICEPRESIDENCIA Vicepresidència

DEF Departament d’Economia i Coneixement

DURSI Universitats i Recerca

EAPC Escola d'Administració Pública de Catalunya

LINGUAMON Linguamón (Casa de les Llengües)

GPRESIDENT Gabinet del President


DGAP Departament de Governació i Relacions Institucionals

SRIP Relacions Institucionals

ICS Institut Català de la Salut

SALUT Departament de Salut

AAAA Arts Santa Mònica

DPRE Departament de la Presidència

ACPD Agència Catalana de Protecció de Dades

SPL Direcció General de Política Lingüística

IDESCAT Institut d'Estadística de Catalunya

SAC Sistema d'Arxius de Catalunya

ICIC Institut Català de les Indústries Culturals

ICIP Institut Català Internacional per la Pau

DGCI Direcció General de Coordinació Interdepartamental

AQUC Agència per a la Qualitat del Servei Universitari de Catalunya

CAEC Comissionat d’Afers Exteriors i Cooperació

ACCD Agència Catalana de Cooperació al Desenvolupament

CTTI Centre de Telecomunicacions i Tecnologies de la Informació

TREBALL Departament d’Empresa i Ocupació

ACC Agència Catalana del Consum

SGE Secretaria General de l’Esport

ACA Agència Catalana de l’Aigua

CEB Consorci d’Educació de Barcelona

ARC Agència de Residus de Catalunya

CHCC Centre d’Història Contemporània de Catalunya

MDC Memorial Democràtic de Catalunya

GREP Gabinet de Relacions Externes i Protocol

CAC Consell de l’Audiovisual de Catalunya


MEC Mossos d’Esquadra

DGTSI Direcció General de Telecomunicacions i Societat de la Informació

SMC Servei Meteorològic de Catalunya

CAGTU Centre d'Atenció i Gestió de Trucades d'Urgència 112 Catalunya

PGC Ports de la Generalitat

CCAP Casa de la Generalitat de Catalunya a Perpinyà

OCDC Oficina de Comunicació del Departament de Cultura

ACC10 ACC1Ó

DIXIT Centre de Documentació dels Servei Socials del DBF

ACA Agència Catalana de l’Aigua

SCT Servei Català de Trànsit

DGCC Direcció General de Cooperació Cultural

IEM Institut Europeu de la Mediterrània

SHMU Secretaria d’Habitatge i Millora Urbana

OSIC Oficina de Suport a la Iniciativa Cultural (OSIC)

Manual de serveis web BIG 3 - corporatives/BIG/Proveidors... · tipus Paràmetre per poder filtrar...

Documents

Transcript of Manual de serveis web BIG 3 - corporatives/BIG/Proveidors... · tipus Paràmetre per poder filtrar...