Alle Kommentare eines Lieferscheins auflisten

GET /api/delivery-note-comments?delivery_note_id={delivery_note_id}

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

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

Einzelnen Kommentar aufrufen

GET /api/delivery-note-comments/{id}
<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <delivery_note_id type="integer">1</delivery_note_id>
    <user_id type="integer">1</user_id>
    <comment>Lieferschein erstellt.</comment>
    <actionkey>CREATED</actionkey>
    <public>0</public>
</delivery-note-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/delivery-note-comments?delivery_note_id={delivery_note_id}&actionkey=CREATE,COPY
actionkeyBeschreibung
COMMENTein durch den Nutzer erstellter Kommentar
CREATEerstellen
COPYKopie
CREATE_FROM_OFFERerstellt aus Angebot
CREATE_FROM_INVOICEerstellt aus Rechnung
CREATE_FROM_CONFIRMATIONerstellt aus Auftragsbestätigung
STATUSStatusänderungen
MAILVersenden (E-Mail)
LETTERVersenden (Post)
FAXVersenden (Fax)
ERROR_MAILFehler beim Versenden (E-Mail)

Kommentar erstellen

POST /api/delivery-note-comments
XML-ElementBeschreibungTypDefault-WertPflichtfeld
delivery_note_idID des LieferscheinsINTja
commentKommentarALNUMja
publicSoll das Kommentar im Kundenportal angezeigt werden (0 = nein, 1 = ja)?BOOL0nein
<delivery-note-comment>
    <delivery_note_id>1</delivery_note_id>
    <comment>Per Post verschickt</comment>
</delivery-note-comment>
<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-comment>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <delivery_note_id type="integer">1</delivery_note_id>
    <user_id type="integer">1</user_id>
    <comment>Per Post verschickt</comment>
    <actionkey>COMMENT</actionkey>
    <public>0</public>
</delivery-note-comment>

Kommentar löschen

DELETE /api/delivery-note-comments/{id}