Alle Kommentare eines Briefs auflisten

GET /api/letter-comments?letter_id={letter_id}

Kommentare können immer nur für einen bestimmten Brief zurückgegeben werden.
Deshalb ist letter_id ein Pflichtparameter.

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

Einzelnen Kommentar aufrufen

GET /api/letter-comments/{id}
<?xml version="1.0" encoding="UTF-8"?>
<letter-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <letter_id type="integer">1</letter_id>
    <user_id type="integer">1</user_id>
    <comment>Brief erstellt.</comment>
    <actionkey>CREATED</actionkey>
    <public>0</public>
</letter-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/letter-comments?letter_id={letter_id}&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)
ERROR_MAIL Fehler beim Versenden (E-Mail)

Kommentar erstellen

POST /api/letter-comments
XML-Element Beschreibung Typ Default-Wert Pflichtfeld
letter_id ID des Briefs INT ja
comment Kommentar ALNUM ja
public Soll das Kommentar im Kundenportal angezeigt werden (0 = nein, 1 = ja)? BOOL 0 nein
<letter-comment>
    <letter_id>1</letter_id>
    <comment>Per Post verschickt</comment>
</letter-comment>
<?xml version="1.0" encoding="UTF-8"?>
<letter-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <letter_id type="integer">1</letter_id>
    <user_id type="integer">1</user_id>
    <comment>Per Post verschickt</comment>
    <actionkey>COMMENT</actionkey>
    <public>0</public>
</letter-comment>

Kommentar löschen

DELETE /api/letter-comments/{id}