Web Service-Dokumentation - Eidgenössisches Institut für Geistiges

Werbung
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
Swissreg Web Service & Initial Load
Version 1.1
Swissreg - Web Service und Initial Load Schnittstelle
Abstract
Schnittstellenbeschreibung vom Swissreg Web Service und Initial Load.
Version
1.1.1
Status
Freigegeben
Ausgabedatum
02.10.2007
Gültigkeitsbereich
IGE
Gültig ab
12.11.2007 (ab R3/2007)
Gültig bis
n. a.
Dokumentname
SwissregWebService_V111.doc
Ablage
P:\Projekte\500033_Swissreg_II\1_Entwurf\7_Interfaces\SR2WebService\SwissregWebService_V111.doc
30.08.2006
Seite 1 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
Swissreg Web Service & Initial Load
Version 1.1
Änderungskontrolle
Änderung
Version
Datum
Ausführende Stelle
Bemerkung / Art der Änderung
0.1.0
04.08.2006
Thomas Iten
Erster Wurf (abgeleitet vom internen Swissreg Web
Service Design Dokument)
0.1.1
28.08.2006
Manfred Jäggi
Konfiguration für SSL beschrieben
0.2.0
31.08.2006
Thomas Iten
Kontakte, Url’s und Security Kapitel eingefügt
0.3.0
27.09.2006
Manfred Jäggi
Schnittstellenbeschreibung erweitert mit Funktion
searchIpRightXML
1.0.0
17.10.2006
Thomas Iten
Übersicht, Fault String, Divers Anpassungen
1.0.1
15.03.2007
Manfred Jäggi
Unklarheit in der Beschreibung von
getModifiedIpRightXML ausführlicher beschrieben
1.1.0
24.09.2007
Thomas Iten
Integration neue Web Service Schnittstelle Version 1.1
1.1.1
02.10.2007
Thomas Iten
Befunde vom br und cam zu Version 1.1.0
Version
Prüfdatum
Prüfende Stelle(n)
Bemerkung
1.0.0
18.10.2006
Bonacina Robert, Matthias
Guenter, Melchior Caduff
Web Service Version 1.0
1.1.0
25.09.2007
Bonacina Robert, Matthias
Guenter, Melchior Caduff,
Stefan Nydegger, Stephan Madl
Web Service Version 1.1
Version
Freigabedatum
Freigebende Stelle(n)
Bemerkung
1.0.0
19.10.2006
Bonacina Robert, Matthias
Guenter, Melchior Caduff
Web Service Version 1.0
Es sind keine Einwände eingetroffen
1.1.1
02.10.2007
Bonacina Robert, Matthias
Guenter, Melchior Caduff,
Stefan Nydegger, Stephan Madl
Web Service Version 1.1
Gemäss Befundliste zu Version 1.1.0
Prüfung
Freigabe
30.08.2006
Seite 2 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
Swissreg Web Service & Initial Load
Version 1.1
Inhaltsverzeichnis
1.
Einführung ...........................................................................................................................4
1.1.
Ziel und Zweck ............................................................................................................4
1.2.
Verwendung ................................................................................................................4
1.3.
Abgrenzung .................................................................................................................4
1.4.
Referenzen auf externe Dokumente ............................................................................4
2. Kontaktpersonen..................................................................................................................5
3. Übersicht .............................................................................................................................5
4. Web Service ........................................................................................................................6
4.1.
URL und Service Name ...............................................................................................6
4.2.
Security .......................................................................................................................6
4.3.
Abfrageverfahren.........................................................................................................7
4.4.
Funktion searchModifiedIpRight ..................................................................................8
4.5.
Funktion searchIpRight................................................................................................9
4.5.1.
Syntax queryString ............................................................................................10
4.5.2.
Attribut / Werte Tabelle für CH-TM .....................................................................10
4.6.
Funktion getIpRightXML ............................................................................................12
4.7.
Funktion getDomainXML ...........................................................................................13
5. Initial Load .........................................................................................................................14
5.1.
Struktur CH-TM .........................................................................................................14
6. Anhang ..............................................................................................................................15
6.1.
Schnittstellen Änderungen .........................................................................................15
6.1.1.
Version 1.1.0 .....................................................................................................15
6.1.2.
Version 1.0.0 .....................................................................................................15
6.2.
Beispiel SOAP Fault ..................................................................................................16
30.08.2006
Seite 3 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
1.
Einführung
1.1.
Ziel und Zweck
Swissreg Web Service & Initial Load
Version 1.1
Das vorliegende Dokument beschreibt die Swissreg Web Service und die Initial Load
Schnittstelle Version 1.1.
1.2.
Verwendung
Das Dokument richtet sich an die externen Benutzer der Swissreg Web Service Schnittstelle,
sowie an die internen Entwickler der Informatik.
1.3.
Abgrenzung
Es werden ausschliesslich die relevanten Punkte, für die Verwendung der Swissreg Web
Service und Initial Load Schnittstelle, beschrieben. Web Service im Allgemeinen oder andere
Komponenten der Swissreg Applikation sind nicht Bestandteil dieser Dokumentation.
1.4.
Referenzen auf externe Dokumente
[CH-TM-2100]
Schema und Beschreibung Marken XML Version 2.10.0
-
CH-TM_V2100.doc
-
ch-tm_v2100.xsd
Link auf Schema:
-
http://schema.ige.ch
[CH-DOMAIN-121] Schema und Beschreibung Domain XML für CH Schutzrechte Version 1.2.1
-
CH-DOMAIN_V121.doc
-
ch-domain_v121.xsd
Link auf Schema:
-
30.08.2006
http://schema.ige.ch
Seite 4 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
2.
Swissreg Web Service & Initial Load
Version 1.1
Kontaktpersonen
Bei Fragen zur Marken-Datenabgabe wenden Sie sich bitte an:
Eidgenössisches Institut für Geistiges Eigentum
Melchior Caduff
Stauffacherstrasse 65
CH-3003 Bern, Schweiz
Telefon: ++41 (0)31 377 74 21
Mail: [email protected]
3.
Übersicht
Mit dem Initial Load und der Web Service Schnittstelle stellt das Institut die öffentlichen
Schutzrechtsdaten externen Nutzern zum Gebrauch zur Verfügung. Es handelt sich dabei um
die gleichen Daten wie sie auch unter www.swissreg.ch eingesehen werden können.
Der Initial Load stellt, auf Bestellung, alle aktuellen Schutzrechtsdaten zu einem bestimmten
Stichtag in Form einer DVD zur Verfügung. Diese beinhaltet auch allfällige Bilder. Mit den Web
Service können alle geänderten Datensätze für einen angegebenen Zeitraum dynamisch
abgefragt werden. Sowohl der Initial Load als auch die Web Service liefern die
Schutzrechtsdaten im XML Format.
Kombiniert man nun die beiden Dienste, so ist es möglich ein externes System mit den immer
aktuellen Schutzrechtsdaten zu unterhalten. Dazu sind folgende Schritte notwendig:

Laden des Systems mit den Daten des Initial Load zum Stichtag X.

Periodische Aktualisierung des Systems mit den Daten der Web Service Schnittstelle ab
dem Stichtag X. Wichtig ist dabei dass der Stichtag selber auch noch einmal via Web
Service abgefragt wird, da es nach dem Bereitstellen der Daten am gleichen Tag noch
Mutationen geben kann.

Der Initial Load und die Web Service Schnittstelle steht momentan in folgenden
Versionen zur Verfügung:
Version Beschreibung

Verfügbarkeit
1.0
Bisherige Version,
wird durch Version 1.1 abgelöst.
13.11.2006
bis 29.02.2008
1.1
Neue Version mit erweiterten Markendaten und
neuem Abfrageverfahren.
ab 12.11.2007
Bei beiden Versionen werden momentan nur die Markendaten zur Verfügung gestellt.
30.08.2006
Seite 5 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
4.
Web Service
4.1.
URL und Service Name
Swissreg Web Service & Initial Load
Version 1.1
Die Swissreg Web Service sind unter folgenden URL’s erreichbar:
Umgebung
Version
Verfügbarkeit
URL
Produktion
1.0
13.11.2006 – 29.02.2008
https://www.swissreg.ch/services/1-0/
Produktion
1.1
ab 12.11.2007
https://www.swissreg.ch/services11/
Der Service Name lautet: SwissregWebService.
Bitte beachten Sie die die unterschiedliche URL im Bereich der Versionsnummer!
Die URL zur Abfrage der WSDL lautet dementsprechend:
Umgebung
Version
URL zur Abfrage der WSDL
Produktion
1.0
https://www.swissreg.ch/services/1-0/SwissregWebService?wsdl
Produktion
1.1
https://www.swissreg.ch/services11/SwissregWebService?wsdl
4.2.
Security
Folgende Punkte sind zu beachten:

Die Swissreg Web Service werden unter HTTPS angesprochen.

Die Authentifizierung (Login) erfolgt mit User/Passwort im BASIC Modus.

Auf dem produktiven System wird ein offizielles Zertifikat eingesetzt.

Auf eine zusätzliche Signatur wird verzichtet.
Weitere Angaben zu den Zertifikaten und Login Daten erhalten Sie durch die im Kapitel 2
definierten Kontaktpersonen.
30.08.2006
Seite 6 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
4.3.
Swissreg Web Service & Initial Load
Version 1.1
Abfrageverfahren
Änderungen an Adressen (z.B. beim Vertreter) können dazu führen, dass bei einer Abfrage
nach geänderten Schutztiteln mehrere Tausend Treffer geliefert werden. Dies führte vereinzelt
zu technischen Problemen bei der Verarbeitung der Datenmenge."
Aus diesem Grund wird das Abfrageverfahren der XML Daten neu in zwei Schritte aufgeteilt.
Damit ist es möglich beliebig grosse Datenmengen zu verarbeiten.
Eine typische Abfrage nach den geänderten Schutztiteln innerhalb einer Zeitperiode sieht
neu folgendermassen aus:
a) Zuerst werden mit der Funktion searchModifiedIpRight alle Schlüssel (keys) der
geänderten Daten abgefragt und als Komma separierten Liste zurückgeliefert.
b) Anschliessend teilt der Web Service Client die erhaltenen Schlüssel in einzelne Blöcke
(ebenfalls als Komma separierte Listen) auf.
c) Für jeden Block können jetzt mit der Funktion getIpRightXML die entsprechenden XML
Daten geladen werden.
Das gleiche Verfahren wird auch mit der Funktion searchIpRight angewendet. Diese liefert
ebenfalls eine Liste aller Schlüssel zurück, für die anschliessend blockweise die XML Daten
abgefragt werden können.
30.08.2006
Seite 7 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
4.4.
Swissreg Web Service & Initial Load
Version 1.1
Funktion searchModifiedIpRight
Beschreibung:
Liefert alle Schlüssel (keys) für das angegebene Schutzrecht welche im definierten Zeitraum
auf Swissreg neu geladen wurden.
Das können sowohl bestehende Schutzrechte sein, deren letzte Änderung in den
angegebenen Bereich fallen, als auch Schutzrechte welche neu hinzugekommen sind.
Syntax:
xsd:string searchModifiedIpRight
( xsd:string ipRight, xsd:dateTime fromDateTime, xsd:dateTime toDateTime)
throws Fault
Parameter:
ipRight
Schutzrecht für welches die geänderten Daten geliefert werden soll.
Gültige Werte: “CH-TM”
fromDateTime
Startdatum ab welchem die geänderten Daten geliefert werden sollen.
Die Zeit wird immer auf 00:00:00 gesetzt.
toDateTime
Enddatum bis und mit welchem die geänderten Daten geliefert
werden sollen. Die Zeit wird immer auf 23:59:59 gesetzt.
Beachte:
Um die mögliche Treffermenge pro Aufruf zu beschränken, beträgt der
maximale Datumsbereich 7 Tage.
Return:
String
Komma separierter String mit eindeutigen Schlüsseln (keys) des
entsprechenden Schutzrechtes.
Für die Marken wird die Gesuchsnummer in folgendem Format
zurückgegeben: nnnnn/yyyy wobei nnnnn eine 5 stellige Nummer mit
führenden Nullen ist und yyyy für das Jahr steht.
Beispiel: "04447/2002,08828/2001"
Fault String (1) :
(1)
InvalidIpRight
Exception
Ungültige Angabe für den Schutzrecht Parameter ipRight.
InvalidDateTime
RangeException
Ungültige Angabe für die DateTime Parameter. Entweder ist die
Differenz zwischen fromDateTime und toDateTime negativ oder
grösser als der maximal zulässige Datumsbereich.
EmptyResult
Exception
Für den angegeben Zeitraum wurden keine neu geladenen Daten
gefunden.
SwissregService
Exception
Fehler innerhalb der Swissreg Web Service Schnittstelle. Kann
beispielsweise auftreten wenn nicht alle Systeme verfügbar sind.
In einem solchen Fall ist der Aufruf zu einem späteren Zeitpunkt zu
wiederholen.
Der Fault String besteht jeweils aus einer Exception und einer detaillierten Fehlermeldung.
Anhang 6.2 zeigt ein entsprechendes Beispiel.
30.08.2006
Seite 8 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
4.5.
Swissreg Web Service & Initial Load
Version 1.1
Funktion searchIpRight
Beschreibung:
Liefert alle Schlüssel des angegebenen Schutzrechts welche die Suchkriterien erfüllen.
Syntax:
xsd:string searchIpRight ( xsd:string ipRight, xsd:string queryString)
throws Fault
Parameter:
ipRight
Schutzrecht für welches die geänderten Daten geliefert werden soll.
Gültige Werte: “CH-TM”
queryString
String mit Suchkriterien in der Form:
queryString := Attribut=Wert{;Attribut=Wert}
Wert
:= Einzelwert{,Einzelwert}
Gültige Attribute und Werte: siehe nachfolgende Unterkapitel.
Return:
String
Komma separierter String mit eindeutigen Schlüsseln (keys) des
entsprechenden Schutzrechtes.
Für die Marken wird die Gesuchsnummer in folgendem Format
zurückgegeben: nnnnn/yyyy wobei nnnnn eine 5 stellige Nummer mit
führenden Nullen ist und yyyy für das Jahr steht.
Beispiel: "04447/2002,08828/2001"
String
Marken XML gemäss [CH-TM-280]
Fault String (1) :
(1)
InvalidIpRight
Exception
Ungültige Angabe für den Schutzrecht Parameter ipRight.
InvalidQueryString
Exception
Mindestens ein angegebenes Argument im queryString ist unbekannt
oder ungültig.
EmptyResult
Exception
Für den angegeben Suchkriterien wurden keine Daten gefunden.
SwissregService
Exception
Fehler innerhalb der Swissreg Web Service Schnittstelle. Kann
beispielsweise auftreten wenn nicht alle Systeme verfügbar sind.
In einem solchen Fall ist der Aufruf zu einem späteren Zeitpunkt zu
wiederholen.
Der Fault String besteht jeweils aus einer Exception und einer detaillierten Fehlermeldung.
Anhang 6.2 zeigt ein entsprechendes Beispiel.
30.08.2006
Seite 9 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
4.5.1.
Swissreg Web Service & Initial Load
Version 1.1
Syntax queryString
Der queryString hat folgende Syntax:
queryString := Attribut=Wert{;Attribut=Wert}
Wert
:= Einzelwert{,Einzelwert}
Grundsätzlich gilt für den angegebenen Wert die gleiche Syntax wie bei einer Online Abfrage.
Details hierzu siehe unter www.swissreg.ch.
Handelt es sich bei der Online Abfrage um ein Combobox Element so ist nicht der angezeigte
Text anzugeben sondern der intern verwendete Code. Details hierzu siehe in den folgenden
Attribut / Werte Tabellen.
Handelt es sich bei der Online Abfrage um eine Gruppe von Checkboxen, so besteht der Wert
aus einer durch Komma separierten Liste von Einzelwerten. Details hierzu siehe ebenfalls in
den folgenden Attribut / Werte Tabellen.
4.5.2.
Attribut / Werte Tabelle für CH-TM
Der Parameter queryString unterstützt bei den Marken die folgenden Attribute:
Attribut
Beschreibung
Wertebereich
Beispiel
tmNo
Markennummer
Gültige Markennummer
tmNo=P-310325
tmAppNo
Gesuchnummer
Gültige Gesuchnummer
tmAppNo=02889/1981
tmText
Wortlaut der
Marke
Beliebiger Markenname oder
Teile davon
tmText=zero zone
tmApplicant
Inhaber/in
Beliebiger Inhabername oder
Teile davon
tmApplicant=jäggi
tmCountryCd
Land (Inhaber/in)
ISO-Ländercode,
tmCountryCd=CH
tmText=“Zero Zone“
Alle wenn nicht angegeben
tmAgent
Vertreter/in
Beliebiger Vertretername
oder Teile davon
tmAgent=jäggi
tmLicensee
Lizenznehmer/in
Beliebiger
Lizenznehmername oder
Teile davon
tmLicensee =jäggi
tmNizzaClass
Nizza
Klassifikation Nr.
Nizza Klassifikation Nr. 1..42
tmNizzaClass=42
tmAppDate
Hinterlegungsdat
um
Gültiges Datum in der
Vergangenheit
tmAppDate= 26.05.1981
tmExpiryDate
Ablauf Schutzfrist
Gültiges Datum
tmExpiryDate= 26.05.1981
tmTypeGrpCd
Markenart
30.08.2006
Keine
Angabe
alle
1
Kollektivmarke
2
Garantiemarke
3
Individualmarke
Seite 10 von 16
tmTypeGrpCd=3
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
Attribut
Beschreibung
tmFormCd
Markentyp
tmColorClaimFlag
Farbanspruch
tmPubDate
Publikationsdatum
tmPubReasonCd
Publikationsgrund
tmStateCdList
Status
In diesem Attribut
kann eine
Werteliste
angegeben
werden
30.08.2006
Swissreg Web Service & Initial Load
Version 1.1
Wertebereich
Keine
Angabe
alle
1
Wortmarke
2
Marke mit
Bildelementen
3
Farbmarke
4
Akustische Marke
5
Dreidimensionale
Marke
6
Bewegungsmarke
7
Positionsmarke
8
Hologramm
Keine
Angabe
alle
true
mit Farbanspruch
false
ohne
Farbanspruch
Gültiges Datum in der
Vergangenheit
Keine
Angabe
alle
1
Neueintragungen
2
Berichtigungen
3
Verlängerungen
4
Löschungen
5
Inhaberänderungen
6
Vertreteränderungen
7
Lizenzänderungen
8
Weitere Registeränderungen
Keine
Angabe
alle
1
hängige Gesuche
2
gelöschte
Gesuche
3
aktive Marken
4
gelöschte Marken
Beispiel
tmFormCd=8
tmColorClaimFlag=true
tmPubDate= 26.05.1981
tmPubReasonCd=2
tmStateCdList=2,4
tmStateCdList=1
Seite 11 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
4.6.
Swissreg Web Service & Initial Load
Version 1.1
Funktion getIpRightXML
Beschreibung:
Liefert die Schutzrechtesdaten als XML für die angegebenen Schlüssel (keys).
Beachte:
Falls nur für einen Teil der Schlüssel Daten gefunden werden, so wird die gefundene
Teilmenge zurückgegeben. Möchte man überprüfen ob dies der Fall ist, so kann die
Anzahl Schlüssel mit der Anzahl Einträge in der XML Datei verglichen werden.
Syntax:
xsd:string getIpRightXML (xsd:string ipRight, xsd:string keys)
throws Fault
Parameter:
ipRight
Schutzrecht für welches die XML Daten geliefert werden soll.
Gültige Werte: “CH-TM“
keys
Komma separiere Liste mit eindeutigen Schutzrechtschlüsseln
(geliefert durch die beiden search Funktionen).
Für die Marken wird die Gesuchsnummer in folgendem Format
erwartet: nnnnn/yyyy wobei nnnnn eine 5 stellige Nummer mit
führenden Nullen ist und yyyy für das Jahr steht.
Beispiel: "04447/2002,08828/2001"
Beachte:
Um die Resultat Grösse zu begrenzen, beträgt die maximal
zulässige Anzahl Schlüssel pro Aufruf 1000 Stück.
Return:
String
Marken XML gemäss [CH-TM-2100]
Fault String (1) :
(1)
InvalidIpRight
Exception
Ungültige Angabe für den Schutzrecht Parameter ipRight.
ExceededKeyLimit
Exception
Die maximal zulässigen Anzahl Schlüssel wurde überschritten
(Parameter keys).
InvalidKeyFormat
Exception
Der im Fehlertext angegebene Schlüssel hat ein ungültiges Format.
EmptyResult
Exception
Für die angegebenen Schlüssel Parameter keys wurden keine Daten
gefunden.
SwissregService
Exception
Fehler innerhalb der Swissreg Web Service Schnittstelle. Kann
beispielsweise auftreten wenn nicht alle Systeme verfügbar sind.
In einem solchen Fall ist der Aufruf zu einem späteren Zeitpunkt zu
wiederholen.
Der Fault String besteht jeweils aus einer Exception und einer detaillierten Fehlermeldung.
Anhang 6.2 zeigt ein entsprechendes Beispiel.
30.08.2006
Seite 12 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
4.7.
Swissreg Web Service & Initial Load
Version 1.1
Funktion getDomainXML
Beschreibung:
Liefert die Domänentexte für das angegebene Schutzrecht in den verfügbaren Sprachen.
In der Regel sind dies Deutsch, Französisch, Italienisch und Englisch.
Syntax:
xsd:string getDomainXML (xsd:string ipRight)
throws Fault
Parameter:
ipRight
Schutzrecht für welches die Domänenwerte geliefert werden soll.
Gültige Werte: “CH-TM“
Return:
String
Domain XML gemäss [CH-DOMAIN-121]
Fault String (1) :
(1)
InvalidIpRight
Exception
Ungültige Angabe für den Schutzrecht Parameter.
SwissregService
Exception
Fehler innerhalb der Swissreg Web Service Schnittstelle. Kann
beispielsweise auftreten wenn nicht alle Systeme verfügbar sind.
In einem solchen Fall ist der Aufruf zu einem späteren Zeitpunkt zu
wiederholen.
Der Fault String besteht jeweils aus einer Exception und einer detaillierten Fehlermeldung.
Anhang 6.2 zeigt ein entsprechendes Beispiel.
30.08.2006
Seite 13 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
5.
Swissreg Web Service & Initial Load
Version 1.1
Initial Load
Die Initial Load Daten werden in Form einer DVD zur Verfügung gestellt und stammen von
einem bestimmten Datum (Stichtag). Allfällige Bilder werden ebenfalls mitgeliefert.
Beachte:
Der Initial Load erfolgt ab dem produktiven System. Die gelieferten Daten entsprechen daher im
Minimum dem Stand des angegebenen Stichtages (und Zeitstempel) können aber auch
neueren Datums sein, wenn sie während der Laufzeit mutiert werden.
Nachfolgend wird die Struktur der Daten auf der DVD beschreiben.
5.1.
Struktur CH-TM
Verzeichnis / Dateien
Beschreibung
ch-tm-jjjj-mm-tt-hh-mm
Hauptverzeichnis der Markendaten mit Angabe des
Erstellungsdatums in der Form Jahr, Monat, Tag, Stunde und
Minuten.
Beispiel: ch-tm-2006-08-21-15-30
0001.zip … nnnn.zip
Mehrer Zip Dateien mit Sets von Markendaten und Bildern.
Jede Zip Datei besteht dabei aus folgendem Inhalt:
 ch-tm-nnnn.xml Datei mit 1..x Markendaten
 Dazugehörige Bilddateien im Format jpeg oder png
Der Dateiname wird im CH-TM Feld „marpicn“ angegeben und
besteht aus einem 40stelligen Hashwert des Bildes und der
entsprechenden Extension.
Beispiel: 0007.zip
 ch-tm-0007.xml
 1DF2C47E3890E99FAF68B294FEAB7EC0845E9ED7.png
 B8CB7ABC2E281FC39C3FFD7738ED4E70E160F42B.jpeg
Hinweise zu den Dateinamen der Bilder:

Jedes Bild hat einen eindeutigen Hashwert, der sich nur ändert, wenn auch das Bild
mutiert wird.

Es gibt zum Teil unterschiedliche Marken mit identischen Bildern. In diesem Fall gibt es
pro Zip Datei nur eine Bilddatei für die betroffenen Marken.

Da sich bei einer Bildänderung der Hashwert ändert, kann auf einfache Art und Weise
überprüft werden ob ein bestehendes Bild einer Marke geändert hat oder nicht.
30.08.2006
Seite 14 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
6.
Anhang
6.1.
Schnittstellen Änderungen
Swissreg Web Service & Initial Load
Version 1.1
Nachfolgend werden die Schnittstellenanpassungen für jede freigegebene Version aufgelistet.
6.1.1.
Version 1.1.0

Das Abfrage Verfahren ist neu zweistufig ausgeführt. Zuerst werden die keys abgefragt,
anschiessend können die XML Daten geladen werden.

Die CH-TM XML Daten wurden erweitert (Snapshot, Bilderhistorisierung, Bemerkungen).
Details hierzu siehe [CH-TM-2100]

Folgende Funktionen sind neu:
o searchModifiedIpRight
o searchIpRight
o getIpRightXML

Folgende Funktionen sind wie bisher:
o getDomainXML

Folgende Funktionen gibt es nicht mehr:
o getModifiedIpRightXML
o searchIpRightXML

Innerhalb des Fault Strings gibt es einen neuen Package Namen:
Beispiel:
Die Excepiton ch.ige.srwebservice.common.exception.InvalidIpRightException
heisst neu
ch.ige.srwebservice11.exception.InvalidIpRightException
6.1.2.
Version 1.0.0
Erste Version der Swissreg Web Service mit folgenden Funktionalitäten:




Initial Load Marken
Web Service für die Domänenwerte der Marken
Web Service für die Markendaten welche in einem angegeben Zeitraum geändert haben
Web Service für die Markendaten welche den angegebenen Suchkriterien entsprechen
30.08.2006
Seite 15 von 16
68615745
Eidgenössisches Institut für Geistiges Eigentum
Ressourcen + Dienstleistungen
Informatik
6.2.
Swissreg Web Service & Initial Load
Version 1.1
Beispiel SOAP Fault
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<soapenv:Fault>
<faultcode>
soapenv:Server.userException
</faultcode>
<faultstring>
ch.ige.srwebservice11.exception.InvalidIpRightException:
Value <123> for parameter ipRight is not supported
</faultstring>
<detail>
<ns1:hostname xmlns:ns1="http://xml.apache.org/axis/">
ipiesa1060.ipie.ch
</ns1:hostname>
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Bitte beachten Sie den neuen Package Namen (ch.ige.srwebservice11.excepiton)
innerhalb des Fault Strings!
30.08.2006
Seite 16 von 16
68615745
Herunterladen