Alle Kommentare einer Auftragsbestätigung auflisten

GET /api/confirmation-comments?confirmation_id={confirmation_id}

Kommentare können immer nur für ein bestimmte Auftragsbestätigung zurückgegeben werden.
Deshalb ist confirmation_id ein Pflichtparameter.

<?xml version="1.0" encoding="UTF-8"?>
<confirmation-comments type="array" page="1" per_page="100" total="2">
    <confirmation-comment>
        ...
    <confirmation-comment>
    <confirmation-comment>
        ...
    <confirmation-comment>
</confirmation-comments>

Einzelnen Kommentar aufrufen

GET /api/confirmation-comments/{id}

 

<?xml version="1.0" encoding="UTF-8"?>
<confirmation-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <confirmation_id type="integer">1</confirmation_id>
    <user_id type="integer">1</user_id>
    <comment>Auftragsbestätigung erstellt.</comment>
    <actionkey>CREATED</actionkey>
    <public>0</public>
</confirmation-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/confirmation-comments?confirmation_id={confirmation_id}&amp;actionkey=CREATE,COPY
actionkey Beschreibung
COMMENT ein durch den Nutzer erstellter Kommentar
CREATE erstellen
COPY Kopie
STATUS Statusänderungen
MAIL Versenden (E-Mail)
LETTER Versenden (Post)
FAX Versenden (Fax)
CANCEL stornieren
ERROR_MAIL Fehler beim Versenden (E-Mail)

Kommentar erstellen

POST /api/confirmation-comments
XML-Element Beschreibung Typ Default-Wert Pflichtfeld
confirmation_id ID der Auftragsbestätigung INT ja
comment Kommentar ALNUM ja
public Soll das Kommentar im Kundenportal angezeigt werden (0 = nein, 1 = ja)? BOOL 0 nein 
<confirmation-comment>
    <confirmation_id>1</confirmation_id>
    <comment>Es kann los gehen</comment>
</confirmation-comment>

 

<?xml version="1.0" encoding="UTF-8"?>
<confirmation-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <confirmation_id type="integer">1</confirmation_id>
    <user_id type="integer">1</user_id>
    <comment>Es kann los gehen</comment>
    <actionkey>COMMENT</actionkey>
    <public>0</public>
</confirmation-comment>

Kommentar löschen

DELETE /api/confirmation-comments/{id}