Dein Wohlfühlpaket für´s Homeoffice: Sichere Dir jetzt 50% Rabatt mit dem Code Feb_50_2021 auf den Tarif Deiner Wahl.
GET /api/reminder-items?reminder_id={reminder_id}
Reminder items can only be returned for a particular reminder.
Therefore reminder_id is a mandatory parameter.
<?xml version="1.0" encoding="UTF-8"?> <reminder-items type="array" page="1" per_page="100" total="2"> <ireminder-item> ... </reminder-item> <reminder-item> ... </reminder-item> </reminder-items>
GET /api/reminder-items/{id}
<?xml version="1.0" encoding="UTF-8"?> <reminder-item> <id type="integer">1</id> <reminder_id type="integer">1</reminder_id> <article_id type="integer">123</article_id> <position type="integer">1</position> <unit>Piece</unit> <quantity type="float">5.2</quantity> <unit_price type="float">10.0</unit_price> <title>Business cards</title> <description>Wonderful 4c business cards</description> <total type="float">61.88</total> </reminder-item>
POST /api/reminder-items
Reminder items can only be created for reminders with draft status (DRAFT).
XML element | Description | Type | Default value | Mandatory |
---|---|---|---|---|
reminder_id | ID of the reminder | INT | yes (except for creation of a reminder) | |
article_id | ID of the article, sets additionally the values from the article on creation | INT | ||
unit | Unit | ALNUM | ||
quantity | Quantity | FLOAT | 0.0 | |
unit_price | Price per unit | FLOAT | 0.0 | |
title | Title | ALNUM | ||
description | Description | ALNUM |
The line item is added to already existing positions.
<reminder-item> <reminder_id>1</reminder_id> <unit>Piece</unit> <quantity>1</quantity> <unit_price>10.0</unit_price> <title>Fines</title> <description></description> </reminder-item>
<?xml version="1.0" encoding="UTF-8"?> <reminder-item> <id type="integer">1</id> <article_id /> <reminder_id type="integer">1</reminder_id> <created>2007-12-13T12:12:00+01:00</created> <position type="integer">1</position> <unit>Piece</unit> <quantity type="float">1</quantity> <unit_price type="float">10.0</unit_price> <title>Fines</title> <description></description> <total type="float">10</total> </reminder-item>
PUT /api/reminder-items/{id}
Here the same parameters apply as for creating, however, the associated reminder (reminder_id) can not be changed.
Reminder items can be edited only for reminder with draft status (DRAFT).
<reminder-item> <quantity>8.5</quantity> </reminder-item>
DELETE /api/reminder-items/{id}
When deleting a reminder item, position of the remaining items is reassigned (without changing the sorting) to fill the resulting gap.
Reminder items can be deleted only for reminders with draft status (DRAFT).