Module endpoint.ArtikelMedia

ArtikelMedia - CASYMIR REST API Standard Endpunkt ArtikelMedia

Methods

Methods

Request GET ArtikelMedia

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

ArtikelMedia-Request-Handler (Internal)

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


Methods

Methods

Usage:

    GET 

Request GET ArtikelMedia

GET-Request-Field-Definition
ArtikelMedia gibt eine Liste aller Medias zum Artikel aus

Fields:

  • ArtNr char(15) -- Artikelnummer
GET-Request-Usage

Usage:

    GET /www/artikelmedia/{ArtNr}
    GET /www/artikelmedia/C202 
GET-Response-Field-Definition

Fields:

  • IDKey int -- Eindeutige Key für die Datei,
  • AMDBildFormat varchar(12) --Bild Format (optional)
  • AMDTextFormat varchar(12) --Text Format (optional)
  • AMDVerwendung varchar(12) -- Verwendung, kann durch einen PHKey gesteuert werden (optional)
  • AdrSprache char(4) -- Sprache der Mediadatei ISO-639-2B Mapping (optional)
  • OrtLand char(4) -- Land zuordnung ISO 3166 ALPHA-2 Mapping (optional)
  • Modified_UTC string -- Letzte anpassung
  • ArtGruppe varchar(12) -- ArtGruppe (optional)
  • ArtNr char(15) -- ArtNr
  • AMDDateiName varchar(255) -- Dateiname
  • AMDText text -- Ausgabe des ISO-8859-1 Text
  • Kommentar varchar(255) -- Kommentar ausgabe zur Mediadatei
  • links table -- Verlinkungen
  • href varchar(2048) -- Verweis
  • type varchar(2048) -- type des Verweis
  • rel varchar(2048) -- relation des Verweis
GET-Response

Usage:

    GET /www/artikelmedia/C202 HTTP/1.1
    
    {"data": [
          {
          "AMDVerwendung": "Artikel",
          "IDKey": 5000002,
          "Modified_UTC": "May 16 2022 06:16:44:283PM",
          "AMDDateiName": "ArtikelBild",
          "AMDBildFormat": "html",
          "ArtNr": "C202",
          "links":       [
                      {
                "rel": "artikelmediadaten/",
                "type": "GET",
                "href": "https://casyrest.opag.loc/www/artikelmediadaten/5000002"
             },
                      {
                "rel": "artikel/",
                "type": "GET",
                "href": "https://casyrest.opag.loc/www/artikel/C202"
             }
          ]
       },
          {
          "AMDVerwendung": "Artikel",
          "IDKey": 5000003,
          "links":       [
                      {
                "rel": "artikelmediadaten/",
                "type": "GET",
                "href": "https://casyrest.opag.loc/www/artikelmediadaten/5000003"
             },
                      {
                "rel": "artikel/",
                "type": "GET",
                "href": "https://casyrest.opag.loc/www/artikel/C202"
             }
          ],
          "AdrSprache": "ger",
          "ArtNr": "C202",
          "Modified_UTC": "May 13 2022 03:12:32:550PM",
          "OrtLand": "CH",
          "AMDBildFormat": "jpg",
          "AMDDateiName": "ArtikelBild2",
          "AMDTextFormat": "txt",
          "AMDText": "Da Da Da",
          "Kommentar": "Text Kommentar"
       },
          {
          "AMDVerwendung": "Artikel",
          "IDKey": 5000004,
          "links":       [
                      {
                "rel": "artikelmediadaten/",
                "type": "GET",
                "href": "https://casyrest.opag.loc/www/artikelmediadaten/5000004"
             },
                      {
                "rel": "artikel/",
                "type": "GET",
                "href": "https://casyrest.opag.loc/www/artikel/C202"
             }
          ],
          "AdrSprache": "eng",
          "ArtNr": "C202",
          "AMDDateiName": "ArtikelBildE",
          "OrtLand": "ES",
          "AMDBildFormat": "pdf",
          "Modified_UTC": "May 11 2022 04:36:57:573PM"
       }
    ]} 

ArtikelMedia-Request-Handler (Internal)

ArtikelMedia (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