GetPicture - Bilder abholen

Port: Biz

Beschreibung

Dieser Service gibt für einen BO-Typ (z.B. Addr), die gewählte BO-IDs (z.B. Adressnummer) und die gewählte Bild-Kategorie, den Bildtyp, das Format, den Pfad und Dateinamen des Bildes gem. Vorgabe in BC 92900, die Dateigröße, den Datei-Hash (optional) und den Time-Stamp der letzten Dateiänderung zurück.

Argumente

Nr.
Key
Name
Beschreibung
1
BoType
BO-Typ
BO-Typ für welchen Bilder abgeholt werden sollen. Zum Beispiel 'Art'. Die übergebenen BO-IDs müssen zu diesem BO-Typ gehören!
2
BoId
Objekt-ID(s)
ID(s) der BOs, für die Bilder abgeholt werden sollen. Mehrere (durch ',' getrennt möglich). Pro BO wird mindestens eine Resultat-Zeile zurückgegeben (auch wenn kein Bild auf entsprechendem BO definiert ist oder wenn Bild nicht vorhanden ist).
3
PictureCategory
Bild-Kategorie(n)
Bild-Kategorien, für die Bilder zurückgegeben werden sollen. '*' = Bilder aller Kategorien. Mehrere Blöcke möglich: durch ';' getrennt. Definition Fallback innerhalb Block möglich: durch ',' getrennt. Angabe des gewünschten Datei-Typs durch '.typ' möglich. Beispiel für 2 Blöcke: 'BOF;FOF.jpg,BOF.jpg' (Bild für Kategorie 'BOF' abholen; ausserdem Bild - nur 'jpg' für 'FOF' abholen mit Fallback auf 'BOF.jpg' wenn kein Bild in 'FOF.jpg' vorhanden).
4
WithoutPicture
Ohne Bild-Daten
Sollen die eigentlichen Bild-Daten nicht geliefert werden? Wenn ja, werden nur die Bild-Meta-Informationen zurückgegeben. Standardmässig (Argument nicht explizit definiert) werden Bild-Daten geliefert.
5
WithSizeFilter
Mit Grössen-Filter
Soll das Grössen-Filter berücksichtigt werden? Wenn ja (dies ist der Standard), werden Bilder, welche grösser als das in den Studio-Einstellungen definierte Limit sind, nicht zurückgegeben.
6
WithHash
Mit Datei-Hash
Soll Hash für Bild-Datei berechnet und zurückgegeben werden? Achtung: Hash-Berechnung kostet etwas Zeit (abhängig von Datei-Grösse). Deshalb werden standardmässig (Argument nicht explizit definiert) keine Hash-Werte berechnet und zurückgegeben.
7
ChangedSinceTimestamp
Seit Änderungs-Zeitpunkt (UTC)
Wenn ein Zeitpunkt angegeben wird, werden nur Bilder mit Datei-Änderungs-Zeitpunkten >= dem angegebenen Zeitpunkt geliefert. Man beachte, dass Datei-Datum- und -Zeit-Angaben immer in UTC erfolgen müssen!
8
MaxNmbOfPictures
Maximale Anzahl Bilder
Ermöglicht Beeinflussung der Anzahl zurückgegebener Bilder: 0 = Alle, -1 = Default. Wenn Bild-Kategorie='*': Jeweils Anzahl pro BO (Default: Alle). Wenn Bild-Kategorie<>'*': Jeweils Anzahl pro BO / pro Bild-Kategorie-Block (Blöcke getrennt durch ';' - Default: 1).

Rückgabewerte

Nr.
Key
Name
Beschreibung
1
BoId
Objekt-ID
ID des BOs zu welchem die zurückgegeben Bild-Informationen gehören.
2
PictureIdTypeCd
Bild-ID-Typ
Beschreibt Verfahren wie dazugehöriges Bild ermittelt werden soll (zum Beispiel 'ID des BOs' oder 'Explizit auf BO definiert').
3
PictureId
Bild-ID
ID für Ermittlung des dazugehörigen Bilds (Inhalt und Verfahren abhängig von 'Bild-ID-Typ').
4
PictureCategory
Abgefragte Bild-Kategorie(n)
Bild-Kategorie-Block für welchen die Abfrage ausgeführt und diese Resultat-Zeile ermittelt wurde.
5
FileName
Datei-Pfad
Pfad der beschriebenen Bild-Datei (nur auf Server-Seite gültig!). Wenn keine Bild-Datei gefunden werden konnte, werden die (erfolglos) angewendeten Datei-Such-Muster zurückgegeben.
6
FoundPictureCategory
Gefundene Bild-Kategorie
Effektive Bild-Kategorie zu der das beschriebene Bild gehört.
7
Existing
Vorhanden
Ist eine dazugehörige Bild-Datei tatsächlich vorhanden?
8
Picture
Bild-Daten
Binär-Daten des Bilds (werden nur geliefert, wenn gemäss entsprechendem Service-Argument auch gewünscht).
9
FileSize
Dateigrösse
Dateigrösse der dazugehörigen Bild-Datei in Anzahl Bytes.
10
FileHash
Datei-Hash
Datei-Hash der dazugehörigen Bild-Datei (wird nur geliefert, wenn gemäss entsprechendem Service-Argument auch gewünscht).
11
FileChangeTimestamp
Datei-Änderungs-Zeitpunkt (UTC)
Zeitpunkt des letzten Schreibzugriffs auf die Bild-Datei. Man beachte, dass Datei-Datum- und -Zeit-Angaben immer in UTC erfolgen!

Message Keys

keine