Kommentare
Alle Kommentare eines Angebotes auflisten
GET /api/offer-comments?offer_id={offer_id}Kommentare können immer nur für ein bestimmtes Angebot zurückgegeben werden.
Deshalb ist offer_id ein Pflichtparameter.
<!--?xml version="1.0" encoding="UTF-8"?--> <offer-comments type="array" page="1" per_page="100" total="2"> <offer-comment> ... <offer-comment> <offer-comment> ... <offer-comment> </offer-comment></offer-comment></offer-comment></offer-comment></offer-comments>
Einzelnen Kommentar aufrufen
GET /api/offer-comments/{id}
<!--?xml version="1.0" encoding="UTF-8"?--> <offer-comment> <id type="integer">1</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <offer_id type="integer">1</offer_id> <user_id type="integer">1</user_id> <comment>Angebot erstellt.</comment> <actionkey>CREATED</actionkey> <public>0</public> </offer-comment>
actionkey
Der Wert für actionkey gibt an, um was für eine Art von Kommentar es sich handelt. Er ist bei allen Aktionen gesetzt, die vom System ausgelöst wurden.
Über den actionkey ist auch eine Filterung möglich. Dabei können mehrerer Werte angegeben werden. Sie werden dann mit einen Komma getrennt.
GET /api/offer-comments?offer_id={offer_id}&amp;amp;actionkey=CREATE,COPY| actionkey | Beschreibung |
|---|---|
| COMMENT | ein durch den Nutzer erstellter Kommentar |
| CREATE | erstellen |
| COPY | Kopie |
| STATUS | Statusänderungen |
| Versenden (E-Mail) | |
| LETTER | Versenden (Post) |
| FAX | Versenden (Fax) |
| CANCEL | stornieren |
| ERROR_MAIL | Fehler beim Versenden (E-Mail) |
| VALIDITY | Gültigkeitsdatum erreicht |
Kommentar erstellen
POST /api/offer-comments
| XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
| offer_id | ID des Angebotes | INT | ja | |
| comment | Kommentar | ALNUM | ja | |
| public | Soll das Kommentar im Kundenportal angezeigt werden (0 = nein, 1 = ja)? | BOOL | 0 | nein |
<offer-comment> <offer_id>1</offer_id> <comment>Es kann los gehen</comment> </offer-comment>
<!--?xml version="1.0" encoding="UTF-8"?--> <offer-comment> <id type="integer">1</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <offer_id type="integer">1</offer_id> <user_id type="integer">1</user_id> <comment>Es kann los gehen</comment> <actionkey>COMMENT</actionkey> <public>0</public> </offer-comment>
Kommentar löschen
DELETE /api/offer-comments/{id}