1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
|
<?php
namespace Globetrotter\API\Services\Order\V1;
use Globetrotter\API\Services\ServiceInterface;
/**
* Possible progress states:
* 0001 - foo
* 0002 - bar
*/
interface OrderServiceInterface extends ServiceInterface
{
/**
* Returns the currently open orders of the user.
*
* Returns:
* {
* "messageCode": null,
* "page": 1, // current result page
* "entriesPerPage": 10, // entries per page
* "entries": 4, // total entries found
* "orders": [
* {
* "id": "0000916122",
* "orderDetails": {
* "date": "28.04.2014",
* "progress": "0001", // for possible progress states see interface docs!
* "amount":500, // in Euro-Cent: 500 = 5,00 Euro
* "currency": "EUR",
* "state": "Bestellung eingegangen",
* "download": [
* {
* "Date": "28.04.2014",
* "Url": "...",
* "DocumentType": "Download",
* "MessageType": "n\/A"
* },
* { ... }
* ]
* }
* },
* { ... }
* ]
* }
*
* @param int $page
* @param int $entriesPerPage
* @return array
*/
public function getOpenOrders($page, $entriesPerPage);
/**
* Returns the closed orders of the user.
*
* @param int $page
* @param int $entriesPerPage
* @return array
*/
public function getClosedOrders($page, $entriesPerPage);
}
|