.. include:: globals.txt .. sidebar:: Token |needtokeninfo| Vermarkterdaten ========================== Hier sind die Funktionen zur Ablage und Abruf der Vermarkterdaten mit dem |connectcentername| beschrieben. Auf die Vermarkterdaten haben alle Teilnehmer des connect centers uneingeschränkten Zugriff. Vermarkterfunktionen -------------------------- setInventory ```````````` Dient zur Ablage des Inventars eines Vermarkters für den allgemeinen Zugriff. Ein evtl. bereits vorhandenes Inventar des Vermarkters wird überschrieben. ============= ================================ Aufruf |connecturl|/setInventory/ ============= ================================ Methoden **POST** (*multipart/form-data* encoded) Rückgabe Antwortstring "received" wenn Empfang abgeschlossen werden konnte. ============= ================================ \ \ ============= ========= **Parameter** ============= ========= **file** Inhalt der Iventory-XML Datei (*multipart/form-data* encoded). |maxuploadfile| ============= ========= Mögliche Fehlerrückgaben ''''''''''''''''''''''''' \ \ ========= ============================== ====================================================== **Code** Infotext Erläuterung ========= ============================== ====================================================== **400** **missing params** Parameter **file** wurde nicht übergeben. **401** *...* |autherrors| ========= ============================== ====================================================== Beispiel ''''''''''''' Anfrage ............. .. literalinclude:: tests/outputs_single/setInventory.in Beispieldatei placements.xml (Ausschnitt): .. literalinclude:: tests/files/placements.xml :language: xml :lines: 1-13 :append: ... :encoding: utf-8 Rückgabe ............. .. literalinclude:: tests/outputs_single/setInventory.out setPriceLists ````````````` Dient zur Ablage der Preislisten eines Vermarkters für den allgemeinen Zugriff. Eine evtl. bereits vorhandene Preisliste des Vermarkters wird überschrieben. ============= ================================ Aufruf |connecturl|/setPriceLists/ ============= ================================ Methoden **POST** Rückgabe Antwortstring "received" wenn Empfang abgeschlossen werden konnte. ============= ================================ \ \ ============= ========= **Parameter** ============= ========= **file** Inhalt der Preislisten-XML Datei (*multipart/form-data* encoded). |maxuploadfile| ============= ========= Mögliche Fehlerrückgaben ''''''''''''''''''''''''' \ \ ========= ============================== ====================================================== **Code** Infotext Erläuterung ========= ============================== ====================================================== **400** **missing params** Parameter **file** wurde nicht übergeben. **401** *...* |autherrors| ========= ============================== ====================================================== Beispiel ''''''''''''' Anfrage ............. .. literalinclude:: tests/outputs_single/setPriceLists.in Beispieldatei pricelist.xml (Ausschnitt): .. literalinclude:: tests/files/pricelist.xml :language: xml :lines: 1-13 :append: ... :encoding: utf-8 Rückgabe ............. .. literalinclude:: tests/outputs_single/setPriceLists.out setAdvertisements ````````````````` Dient zur Ablage der Werbeformen eines Vermarkters für den allgemeinen Zugriff. Evtl. bereits vorhandene Werbeformen des Vermarkters werden überschrieben. ============= ==================================== Aufruf |connecturl|/setAdvertisements/ ============= ==================================== Methoden **POST** Rückgabe Antwortstring "received" wenn Empfang abgeschlossen werden konnte. ============= ==================================== \ \ ============= ========= **Parameter** ============= ========= **file** Inhalt der Werbeformen-XML Datei (*multipart/form-data* encoded). |maxuploadfile| ============= ========= Mögliche Fehlerrückgaben ''''''''''''''''''''''''' \ \ ========= ============================== ====================================================== **Code** Infotext Erläuterung ========= ============================== ====================================================== **400** **missing params** Parameter **file** wurde nicht übergeben. **401** *...* |autherrors| ========= ============================== ====================================================== Beispiel ''''''''''''' Anfrage ............. .. literalinclude:: tests/outputs_single/setAdvertisements.in Beispieldatei advertisements.xml (Ausschnitt): .. literalinclude:: tests/files/offer.xml :language: xml :lines: 1-13 :append: ... :encoding: utf-8 Rückgabe ............. .. literalinclude:: tests/outputs_single/setAdvertisements.out Agenturfunktionen -------------------------- .. |getsuffix| replace:: aller Vermarkter oder des spezifisch abgefragen Vermarkters als XML .. |infone| replace:: Kann auf einen Vermarkter eingeschränkt werden. getInventory ````````````` Dient zum Abruf der Inventories der Vermarkter. |infone| ============= ================================ Aufruf |connecturl|/getInventory/ ============= ================================ Methoden **GET** Rückgabe Inventory |getsuffix| ============= ================================ \ \ =============== ========= **Parameter** =============== ========= **publisher** ID des Vermarkters im |connectcentername| |useridinfo| =============== ========= Mögliche Fehlerrückgaben ''''''''''''''''''''''''' \ \ ========= ============================== ====================================================== **Code** Infotext Erläuterung ========= ============================== ====================================================== **401** *...* |autherrors| ========= ============================== ====================================================== Beispiel ''''''''''''' Anfrage ............. .. literalinclude:: tests/outputs_single/getInventory.in Rückgabe ............. .. literalinclude:: tests/outputs_single/getInventory.out :language: xml :lines: 1-13 :append: ... :encoding: utf-8 getPriceLists ````````````` Dient zum Abruf der Preislisten der Vermarkter. |infone| ============= ================================ Aufruf |connecturl|/getPriceLists/ ============= ================================ Methoden **GET** Rückgabe Preislisten |getsuffix| ============= ================================ \ \ =============== ========= **Parameter** =============== ========= **publisher** ID des Vermarkters im |connectcentername| |useridinfo| =============== ========= Mögliche Fehlerrückgaben ''''''''''''''''''''''''' \ \ ========= ============================== ====================================================== **Code** Infotext Erläuterung ========= ============================== ====================================================== **401** *...* |autherrors| ========= ============================== ====================================================== Beispiel ''''''''''''' Anfrage ............. .. literalinclude:: tests/outputs_single/getPriceLists.in Rückgabe ............. .. literalinclude:: tests/outputs_single/getPriceLists.out :language: xml :lines: 1-13 :append: ... :encoding: utf-8 getAdvertisements ````````````````` Dient zum Abruf der Werbeformen der Vermarkter. |infone| ============= ================================ Aufruf |connecturl|/getAdvertisements/ ============= ================================ Methoden **GET** Rückgabe Werbformen |getsuffix| ============= ================================ \ \ =============== ========= **Parameter** =============== ========= **publisher** ID des Vermarkters im |connectcentername| |useridinfo| =============== ========= Mögliche Fehlerrückgaben ''''''''''''''''''''''''' \ \ ========= ============================== ====================================================== **Code** Infotext Erläuterung ========= ============================== ====================================================== **401** *...* |autherrors| ========= ============================== ====================================================== Beispiel ''''''''''''' Anfrage ............. .. literalinclude:: tests/outputs_single/getAdvertisements.in Rückgabe ............. .. literalinclude:: tests/outputs_single/getAdvertisements.out :language: xml :lines: 1-13 :append: ... :encoding: utf-8