Angebotsdaten¶

Hier sind die Funktionen zum Versand und Empfang von Angeboten zwischen Vermarktern und Agenturen beschrieben. Auf die Angebotsdaten haben nur bestimmte Teilnehmer des connect centers Zugriff.

Vermarkterfunktionen¶

sendOffer¶

Verschickt ein Angebot.

Es findet vom connect center aus keinerlei weitere Verarbeitung der verschickten Datei statt. Das connect center speichert lediglich den Inhalt der Datei. Somit ist es z.B. auch möglich die Datei komprimiert oder verschlüsselt zu übergeben.

Aufruf	https://connectcenter.agof.de/sendOffer/
Methoden	POST (multipart/form-data encoded)
Rückgabe	Antwortstring “Offer for USERNAME received / TransactionID: ID“

¶

Parameter
receiver	Empfänger, ID des Teilnehmers im connect center , optional (ID kann über getConnectUsers bestimmt werden)
file	Inhalt der Angebots-XML Datei (multipart/form-data encoded). Die Dateigröße darf 256 Megabyte nicht überschreiten.
attr_XXX	Eine beliebige Anzahl von Attributen (key/value pairs) um das Angebot mit Metainformationen anzureichern. Diese haben das Prefix attr_ gefolgt vom Attributname (z.B. attr_codeinternal)

Mögliche Fehlerrückgaben

¶

Code	Infotext	Erläuterung
400	missing params	Parameter file wurde nicht übergeben
409	unknown receiver	Der angegebene Empfänger ist dem connect center nicht bekannt.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/sendOffer/ -F file="@files/examplefiles/18_Test Dokument ToFo.txt" -F receiver=4 --insecure 
 -F token=49d4cb305f324006f7ca191af908f72afea5689d8ebe837c5aa92deb8ff5d8b4

Beispieldatei offer.xml (Ausschnitt):

﻿<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="XSL/sample_1.xsl"?>
<offer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="XSD/offer.xsd" VID="32261">
  <offerid>27287</offerid>
  <version>1</version>
  <status>enquired</status>
  <businesssegment>Online</businesssegment>
  <validto>2012-09-10</validto>
  <campaign>TEST</campaign>
  <participants>
    <customer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="48604">
      <name>TEST</name>
      <type>customer</type>
...

Rückgabe¶

Offer for Vermarkter 2 received / TransactionID: 2-479

sendInventory¶

Verschickt ein Inventar an eine bestimmte Agentur.

Aufruf	https://connectcenter.agof.de/sendInventory/
Methoden	POST (multipart/form-data encoded)
Rückgabe	Antwortstring “Inventory for USERNAME received / TransactionID: ID“

¶

Parameter
receiver	Empfänger, ID der Agentur im connect center , optional (ID kann über getConnectUsers bestimmt werden)
file	Inhalt der Inventory-XML Datei (multipart/form-data encoded). Die Dateigröße darf 256 Megabyte nicht überschreiten.
attr_XXX	Eine beliebige Anzahl von Attributen (key/value pairs) um das Inventory mit Metainformationen anzureichern. Diese haben das Prefix attr_ gefolgt vom Attributname (z.B. attr_codeinternal)

Mögliche Fehlerrückgaben

¶

Code	Infotext	Erläuterung
400	missing params	Parameter file wurde nicht übergeben
409	unknown receiver	Der angegebene Empfänger ist dem connect center nicht bekannt.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/sendInventory/ -F file="@files/placements.xml" -F receiver=3 -F attr_test=isInventor --insecure 
 -F token=5372957f42ea93deb41ee83704118a59967926577f4676b899651ead19db46c6

Beispieldatei offer.xml (Ausschnitt):

﻿<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="XSL/sample_1.xsl"?>
<offer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="XSD/offer.xsd" VID="32261">
  <offerid>27287</offerid>
  <version>1</version>
  <status>enquired</status>
  <businesssegment>Online</businesssegment>
  <validto>2012-09-10</validto>
  <campaign>TEST</campaign>
  <participants>
    <customer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="48604">
      <name>TEST</name>
      <type>customer</type>
...

Rückgabe¶

Inventory for Agentur 1 received / TransactionID: 317

sendPriceLists¶

Verschickt eine Preisliste an eine bestimmte Agentur.

Aufruf	https://connectcenter.agof.de/sendPriceLists/
Methoden	POST (multipart/form-data encoded)
Rückgabe	Antwortstring “PriceLists for USERNAME received / TransactionID: ID“

¶

Parameter
receiver	Empfänger, ID der Agentur im connect center , optional (ID kann über getConnectUsers bestimmt werden)
file	Inhalt der Preislisten-XML Datei (multipart/form-data encoded). Die Dateigröße darf 256 Megabyte nicht überschreiten.
attr_XXX	Eine beliebige Anzahl von Attributen (key/value pairs) um die Preisliste mit Metainformationen anzureichern. Diese haben das Prefix attr_ gefolgt vom Attributname (z.B. attr_codeinternal)

Mögliche Fehlerrückgaben

¶

Code	Infotext	Erläuterung
400	missing params	Parameter file wurde nicht übergeben
409	unknown receiver	Der angegebene Empfänger ist dem connect center nicht bekannt.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/sendPriceLists/ -F file="@files/pricelist.xml" -F receiver=3 -F attr_test=IsNePreislist --insecure 
 -F token=5372957f42ea93deb41ee83704118a59967926577f4676b899651ead19db46c6

Beispieldatei offer.xml (Ausschnitt):

﻿<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="XSL/sample_1.xsl"?>
<offer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="XSD/offer.xsd" VID="32261">
  <offerid>27287</offerid>
  <version>1</version>
  <status>enquired</status>
  <businesssegment>Online</businesssegment>
  <validto>2012-09-10</validto>
  <campaign>TEST</campaign>
  <participants>
    <customer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="48604">
      <name>TEST</name>
      <type>customer</type>
...

Rückgabe¶

PriceLists for Agentur 1 received / TransactionID: 318

sendAdvertisements¶

Verschickt die Werbeformen eines Vermarkters an eine bestimmte Agentur.

Aufruf	https://connectcenter.agof.de/sendAdvertisements/
Methoden	POST (multipart/form-data encoded)
Rückgabe	Antwortstring “Advertisements for USERNAME received / TransactionID: ID“

¶

Parameter
receiver	Empfänger, ID der Agentur im connect center , optional (ID kann über getConnectUsers bestimmt werden)
file	Inhalt der Werbeformen-XML Datei (multipart/form-data encoded). Die Dateigröße darf 256 Megabyte nicht überschreiten.
attr_XXX	Eine beliebige Anzahl von Attributen (key/value pairs) um die Werbeform mit Metainformationen anzureichern. Diese haben das Prefix attr_ gefolgt vom Attributname (z.B. attr_codeinternal)

Mögliche Fehlerrückgaben

¶

Code	Infotext	Erläuterung
400	missing params	Parameter file wurde nicht übergeben
409	unknown receiver	Der angegebene Empfänger ist dem connect center nicht bekannt.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/sendAdvertisements/ -F file="@files/advertisements.xml" -F receiver=3 -F attr_test=IsNeAddvertisement --insecure 
 -F token=5372957f42ea93deb41ee83704118a59967926577f4676b899651ead19db46c6

Beispieldatei offer.xml (Ausschnitt):

﻿<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="XSL/sample_1.xsl"?>
<offer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="XSD/offer.xsd" VID="32261">
  <offerid>27287</offerid>
  <version>1</version>
  <status>enquired</status>
  <businesssegment>Online</businesssegment>
  <validto>2012-09-10</validto>
  <campaign>TEST</campaign>
  <participants>
    <customer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="48604">
      <name>TEST</name>
      <type>customer</type>
...

Rückgabe¶

Advertisements for Agentur 1 received / TransactionID: 319

getTransactionsList¶

Gibt eine Liste der eingestellten Dokumente und deren Status aus. Dokumente können drei verschiedene Zustände (Status) haben:

Status	Erläuterung
1	eingestellt => Das Dokument wurde eingestellt, aber noch nicht abgerufen.
2	abgerufen => Das Dokument wurde abgerufen, aber der Abruf wurde noch nicht mit fetch bestätigt.
3	bestätigt => Das Dokument wurde abgerufen und der Empfang per fetch bestätigt.

Aufruf	https://connectcenter.agof.de/getTransactionsList/
Methoden	GET
Rückgabe	XML-Liste der Angebote (encoding: utf-8)

¶

Parameter
states	Einschränkung auf den Status der Dokumente. Mögliche StatusIDs siehe oben. Es können mehrere States angegeben werden (kommasepariert). Parameter ist optional. Beispiel: “1,3“
lastChanged	Angabe eines Datumsbereiches (von-bis im Format “JJJJ-MM-DD, JJJJ-MM-DD”). Das erste Datum definiert den Beginn des Bereichs, das Zweite das Ende (optional). Parameter ist optional. Beispiele: “2014-01-01”, “2014-01-01, 2014-02-01“

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	wrong param format	Eines der beiden Datumsangaben im lastChanged Parameter hatte ein ungültiges Format.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/getTransactionsList/ -d states="3" -d lastChanged="2013-01-21,2013-03-07" --insecure 
 -d token=abef3f0c483acbc1a650a9bdffd341d74190397fb3c4639e924d0a9d799eac43

Rückgabe¶

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Documents>
  <Document id="4">
    <Receiver id="3" name="Agentur 1" />
    <State id="3" info="bestätigt" changed="2013-01-21 16:46:10.0" />
    <Attributes>
      <Attribute key="campain" value="WSV2013" />
      <Attribute key="internalid" value="1234" />
      <Attribute key="type" value="useroffer" />
    </Attributes>
  </Document>
  <Document id="63">
    <Receiver id="3" name="Agentur 1" />
    <State id="3" info="bestätigt" changed="2013-03-06 19:26:15.0" />
    <Attributes>
      <Attribute key="type" value="useroffer" />
    </Attributes>
  </Document>
</Documents>

getTransactionStatus¶

Gibt den Status eines einzelnen Dokumentes zurück. Erläuterung Status siehe getTransactionsList.

Aufruf	https://connectcenter.agof.de/getTransactionStatus/
Methoden	GET
Rückgabe	XML-Liste der Angebote (encoding: utf-8)

¶

Parameter
id	ID des Dokuments. Die ID entspricht der TransactionID, die beim Einstellen von Dokumenten zurückgegeben wird (siehe z.B. Rückgabe bei sendOffer). Die ID wird auch bei getTransactionsList ausgegeben.

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params id	Der Parameter id wurde nicht übergeben.
400	document not found	Unter der angegebenen ID wurde kein Dokument gefunden.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/getTransactionStatus/ -d id="200" --insecure 
 -d token=abef3f0c483acbc1a650a9bdffd341d74190397fb3c4639e924d0a9d799eac43

Rückgabe¶

<Document id="200">
  <Receiver id="3" name="Agentur 1" />
  <State id="3" info="bestätigt" changed="2013-08-09 11:12:24.0" />
  <Attributes>
    <Attribute key="pw" value="test" />
    <Attribute key="encrypted" value="1" />
    <Attribute key="type" value="offer" />
  </Attributes>
</Document>

Agenturfunktionen¶

getDocumentsList¶

Gibt eine Liste der von Vermarktern für den eingeloggten User eingestellten Angebote und anderer Inhalte aus (siehe sendOffer, sendInventory, sendPriceLists, sendAdvertisements). Kann auf die Angebote eines Vermarkters eingeschränkt werden.

Die Angebote werden dabei nicht abgerufen. Jedes Angebot hat ein id Tag, das es eindeutig identifiziert. Diese id muss beim eigentlichen Abruf (siehe fetchOffer, fetchInventory, fetchPriceLists, fetchAdvertisements) genutzt werden.

Aufruf	https://connectcenter.agof.de/getDocumentsList/
Methoden	GET
Rückgabe	XML-Liste der Angebote (encoding: utf-8)

¶

Parameter
type	Typ der Angebote, “offer“” für Angebote (siehe sendOffer), “inventory“” für Inventare (siehe sendInventory), “pricelist“” für Preislisten (siehe sendPriceLists) oder “advertisment” für Werbeformen (siehe sendAdvertisements). Parameter ist optional. Keine Angabe gibt alle Typen zurück.
sender	ID des Vermarkters, der das Angebot (bzw. die Angebote) eingestellt hat , optional (ID kann über getConnectUsers bestimmt werden)

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/getDocumentsList/ --insecure 
 -d token=43ffc70e36bb2d543f6c747274123d71fafe95e5172acb8f6ea5ca76e600b1c0

Rückgabe¶

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Offers>
  <Offer>
    <id>289</id>
    <From>
      <id>2</id>
      <name>Vermarkter 1</name>
      <date>2013-08-30 13:11:28.0</date>
    </From>
    <Attributes>
      <Attribute>
        <Key>encrypted</Key>
        <Value>1</Value>
      </Attribute>
      <Attribute>
        <Key>pw</Key>
        <Value>test</Value>
      </Attribute>
      <Attribute>
        <Key>type</Key>
        <Value>offer</Value>
      </Attribute>
      <Attribute>
        <Key>waitForConfirm</Key>
        <Value>0</Value>
...

fetchOffer¶

Ruft ein Angebot aus dem connect center ab.

Der Fetch erfolgt in zwei Stufen. Wenn der Fetch erfolgreich war, muss er im Anschluss mit confirmFetch abgeschlossen werden, um den Inhalt im connect center dauerhaft zu entfernen. Wenn ein Fetch nicht funktioniert hat, kann man nach Aufruf von undoFetch den Inhalt erneut abrufen.

Aufruf	https://connectcenter.agof.de/getOffers/
Methoden	GET
Rückgabe	Eingestelltes Angebot

¶

Parameter
id	Angebots-ID (id aus getDocumentsList)

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Angebots-ID wurde nicht übergeben.
404	not found	Das Angebot unter der ID konnte nicht gefunden werden.
409	allready fetched	Das Angebot wurde bereits abgerufen, ggf. undoFetch nutzen.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/fetchOffer/ -d id=316 --insecure 
 -d token=6977ed929ef01c99b4f66a78ca083ab38b31573f4704a54c9c707083b710daea

Rückgabe¶

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="XSL/sample_1.xsl"?>
<offer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="XSD/offer.xsd" VID="32261">
  <offerid>27287</offerid>
  <version>1</version>
  <status>enquired</status>
  <businesssegment>Online</businesssegment>
  <validto>2012-09-10</validto>
  <campaign>TEST</campaign>
  <participants>
    <customer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="48604">
      <name>TEST</name>
...

fetchInventory¶

Ruft ein agenturspezifisches Inventar eines Vermarkters ab (wurde mit sendInventory eingestellt).

Aufruf	https://connectcenter.agof.de/fetchInventory/
Methoden	GET
Rückgabe	Eingestelltes Inventory

¶

Parameter
id	Inventory-ID (id aus getDocumentsList parameter typ = ‘inventory’)

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Inventory-ID wurde nicht übergeben.
404	not found	Das Inventory unter der ID konnte nicht gefunden werden.
409	allready fetched	Das Inventory wurde bereits abgerufen, ggf. undoFetch nutzen.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/fetchInventory/ -d id=317 --insecure 
 -d token=6977ed929ef01c99b4f66a78ca083ab38b31573f4704a54c9c707083b710daea

Rückgabe¶

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="XSL/placements.xsl"?>
<placements xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="XSD/placements.xsd" version="2012-08-29"
publisherid="1000">
  <placement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="2341"
  validfrom="2010-03-01">
    <media xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="10061">
      <name>Bunch.tv</name>
    </media>
    <name>Bunch.tv</name>
    <description>Bunch.tv</description>
    <availableadvertisement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...

fetchPriceLists¶

Ruft eine agenturspezifische Preisliste eines Vermarkters ab (wurde mit sendPriceLists eingestellt).

Aufruf	https://connectcenter.agof.de/fetchPriceLists/
Methoden	GET
Rückgabe	Eingestellte Preisliste

¶

Parameter
id	PriceLists-ID (id aus getDocumentsList parameter typ = ‘pricelist’)

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	PriceLists-ID wurde nicht übergeben.
404	not found	Die Preisliste unter der ID konnte nicht gefunden werden.
409	allready fetched	Die Preisliste wurde bereits abgerufen, ggf. undoFetch nutzen.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/fetchPriceLists/ -d id=318 --insecure 
 -d token=6977ed929ef01c99b4f66a78ca083ab38b31573f4704a54c9c707083b710daea

Rückgabe¶

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="XSL/pricelist.xsl"?>
<pricelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="XSD/pricelist.xsd" publisherid="1000" issued="2012-08-29"
currency="€" version="20107567">
  <name>Online Preisliste IP Deutschland</name>
  <priceentry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="16374">
    <placement VID="2341" validfrom="2010-03-01">
      <media VID="10061">
        <name>Bunch.tv</name>
        <description />
      </media>
      <name>Bunch.tv</name>
...

fetchAdvertisements¶

Ruft die agenturspezifischen Werbeformen eines eines Vermarkters ab (wurde mit sendAdvertisements eingestellt).

Aufruf	https://connectcenter.agof.de/fetchAdvertisements/
Methoden	GET
Rückgabe	Eingestelltes Werbeform

¶

Parameter
id	Advertisements-ID (id aus getDocumentsList parameter typ = ‘advertisment’)

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Advertisements-ID wurde nicht übergeben.
404	not found	Die Werbeformen unter der ID konnte nicht gefunden werden.
409	allready fetched	Die Werbeformen wurde bereits abgerufen, ggf. undoFetch nutzen.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/fetchAdvertisements/ -d id=319 --insecure 
 -d token=6977ed929ef01c99b4f66a78ca083ab38b31573f4704a54c9c707083b710daea

Rückgabe¶

<advertisements xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
issued="2012-08-29">
  <advertisement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VID="55000"
  compoundadvertisement="false">
    <name>360 Grad Motion Ad</name>
    <advertisementtype VID="510302">
      <name>In-Stream</name>
    </advertisementtype>
    <delivery>
      <destination>banner@ip-deutschland.de</destination>
      <timeframe>5</timeframe>
    </delivery>
  </advertisement>
...

confirmFetch¶

Wenn Angebote aus dem connect center abgerufen werden (siehe fetchOffer, fetchInventory, fetchPriceLists, fetchAdvertisements) dann werden diese nicht gelöscht. Um diese Angebote zu löschen muss man die Abholung des Angebote mit den Aufruf dieser Funktion bestätigen. Erst dann wird das abgerufende Angebot gelöscht.

Wenn das confirmFetch durch ein connect kit durchgeführt wurde, verschickt dieses automatisch eine “confirm” Bestätigung an den Absender, welche dieser in seiner Nachrichtenauflistung angezeigt bekommt (siehe getMessagesList bzw. Nachrichten im Portal).

Aufruf	https://connectcenter.agof.de/confirmFetch/
Methoden	GET
Rückgabe	“fetch confirmed” oder “nothing to confirm”

¶

Parameter
id	id aus getDocumentsList

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Parameter id wurde nicht übergeben.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/confirmFetch/ -d id=316 --insecure 
 -d token=6977ed929ef01c99b4f66a78ca083ab38b31573f4704a54c9c707083b710daea

Rückgabe¶

fetch confirmed

undoFetch¶

Wenn beim Abruf von Angebote aus den connect center Fehler auftreten, dann kann man mit diesen Befehl die Abrufung des Angebotes rückgängig machen. Erst dann kann man das Angebot erneut abrufen.

Aufruf	https://connectcenter.agof.de/undoFetch/
Methoden	GET
Rückgabe	“undo fetch” oder “nothing to undo”

¶

Parameter
id	id aus getDocumentsList

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Parameter id wurde nicht übergeben.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/undoFetch/ -d id=316 --insecure 
 -d token=6977ed929ef01c99b4f66a78ca083ab38b31573f4704a54c9c707083b710daea

Rückgabe¶

undo fetch

getMessagesList¶

Gibt eine Liste der für den User anliegenden Nachrichten zurück.

Aufruf	https://connectcenter.agof.de/getMessagesList/
Methoden	GET
Rückgabe	XML-Liste der Nachrichten (encoding: utf-8)

¶

Parameter
sender	Filtert die Liste auf einen bestimmten Absender (id aus getDocumentsList). Parameter ist optional.
dateRange	Angabe eines Datumsbereiches (von-bis im Format “JJJJ-MM-DD, JJJJ-MM-DD”). Das erste Datum definiert den Beginn des Bereichs, das Zweite das Ende (optional). Parameter ist optional. Beispiele: “2014-01-01”, “2014-01-01, 2014-02-01“

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	wrong param format	Eines der beiden Datumsangaben im lastChanged Parameter hatte ein ungültiges Format.
409	internal error: missing user box	Angegebener Absender unbekannt
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/getMessagesList/ --insecure 
 -d token=35222a967536787a57c7b5d3f031a0c22ebf88ee72db4c50cbb55fbbde43abb3

Rückgabe¶

<?xml version="1.0" encoding="utf-8"?>
<Messages>
  <Message id="484" type="confirm" subject="Angebot abgerufen">
    <From>
      <id>3</id>
      <name>Agentur 1</name>
    </From>
    <Date>2014-01-23 14:17:30.0</Date>
  </Message>
</Messages>

readMessage¶

Ruft eine Nachricht ab.

Aufruf	https://connectcenter.agof.de/readMessage/
Methoden	GET
Rückgabe	Eingestellte Nachricht

¶

Parameter
id	Nachrichten-ID (id aus getMessagesList)

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Nachrichten-ID wurde nicht übergeben.
404	not found	Die Nachricht unter der ID konnte nicht gefunden werden.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/readMessage/ -d id=484 --insecure 
 -d token=35222a967536787a57c7b5d3f031a0c22ebf88ee72db4c50cbb55fbbde43abb3

Rückgabe¶

<?xml version="1.0" encoding="utf-8"?>
<Message id="484" type="confirm" subject="Angebot abgerufen">
  <From>
    <id>3</id>
    <name>Agentur 1</name>
  </From>
  <Date>2014-01-23 14:17:30.774</Date>
  <Detail />
</Message>
...

deleteMessage¶

Löscht eine Nachricht.

Aufruf	https://connectcenter.agof.de/deleteMessage/
Methoden	GET
Rückgabe	“delete confirmed” oder “nothing to delete”

¶

Parameter
id	id aus getMessagesList

¶

Mögliche Fehlerrückgaben¶

¶

Code	Infotext	Erläuterung
400	missing params	Parameter id wurde nicht übergeben.
400	nothing to delete	Nachricht wurde nicht gefunden oder schon gelöscht.
401	...	Bei einem Authentifizierungsproblem sind grundsätzlich die unter Authentifizierung aufgeführten Antworten möglich.

Beispiel¶

Anfrage¶

curl https://connectcenter.agof.de/deleteMessage/ -d id=484 --insecure 
 -d token=35222a967536787a57c7b5d3f031a0c22ebf88ee72db4c50cbb55fbbde43abb3

Rückgabe¶

delete confirmed