Module endpoint.ArtikelMediaDaten

ArtikelMediaDaten - CASYMIR REST API Standard Endpunkt ArtikelMediaDaten

Methods

Methods

Request GET ArtikelMediaDaten

GET-Request-Field-Definition
GET-Request-Usage
GET-Response-Field-Definition
GET-Response

ArtikelMediaDaten-Request-Handler (Internal)

ArtikelMediaDaten (DB, EndUrl, Pattern, Methode, UserName, QueryStr, Bodytable) Endpunkt Handler.


Methods

Methods

Usage:

    GET 

Request GET ArtikelMediaDaten

GET-Request-Field-Definition
ArtikelMediaDaten gibt Bildmaterial und beschreibende Texte zum Artikel oder der Artikelgruppe zurück.

Ein Media-Datensatz mit {IDKey} kann zwei Typen von Daten enthalten: ein Bild und/oder einen beschreibenden Text.

Fields:

  • IDKey int -- Eindeutige Key für die Datei
  • type string -- 'Bild' oder 'Text' zum Abrufen der Datei
GET-Request-Usage

Usage:

    GET /www/artikelmediadaten/{IDKey}?type={Query}
    GET /www/artikelmediadaten/5000002?type=Bild
    GET /www/artikelmediadaten/5000002?type=Text
    GET /www/artikelmediadaten/5000002?type=txt
    GET /www/artikelmediadaten/5000002?type=png 
GET-Response-Field-Definition
type ist AMDTextFormat oder AMDBildFormat

Die Ausgabe ist eine Datei.

Fields:

  • Bild string -- Content-Type: {Format}
  • Text string -- Content-Type: text/plain
  • Format string -- AMDBildFormat von artikelmedia
GET-Response

Usage:

  • GET /www/artikelmediadaten/5000002?type=Text HTTP/1.1
    
    HTTP/1.1 200 OK
    Content-Length: 36
    Content-Type: text/plain; charset=UTF-8
  • GET /www/artikelmediadaten/5000002?type=Bild HTTP/1.1
    
    HTTP/1.1 200 OK
    Content-Length: 34112
    Content-Type: image/png
    Body binary 

ArtikelMediaDaten-Request-Handler (Internal)

ArtikelMediaDaten (DB, EndUrl, Pattern, Methode, UserName, QueryStr, Bodytable)
Endpunkt Handler.

[opt] Artikel-Attribut VERWENDUNG == WERT wie Beim RESTUser

Parameters:

  • DB UserData -- Datenbank Verbindung
  • EndUrl string -- Enthält die Ausgelesene URI aus der Datenbank
  • Pattern string -- Enthält den Patter Teil der URI else nil
  • Methode string -- HTTP Methode
  • UserName string -- Benutzer der Angemeldet wurde
  • QueryStr string -- Orginal String ohne Hex Zeichen
  • Bodytable table -- Request Body

Returns:

    table retBody
generated by LDoc 1.4.6 Last updated 2024-12-22 09:39:14