From 0870c8cee1b67aacafebf4d52f141abb31bdaebb Mon Sep 17 00:00:00 2001 From: Thomas Brinkmann Date: Wed, 1 Jun 2022 20:10:37 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EGET=20/order=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- GET-%2Forder.md | 121 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 GET-%2Forder.md diff --git a/GET-%2Forder.md b/GET-%2Forder.md new file mode 100644 index 0000000..0bb892d --- /dev/null +++ b/GET-%2Forder.md @@ -0,0 +1,121 @@ +## **GET /order** + + +## **Inhalt** +--- +- Parameter +- Optionale Parameter +- Beispiel Anfrage +- Beispiel Antwort +- Mögliche Fehlermeldungen +--- + +### Parameter + +|URL Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|- | -| - + +|Body Parameter | Typ | Beschreibung| +|----------|-----|-------------| +| - | - | - | + + +--- + +### Optionale Parameter + +|Query-String Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|?page | integer | Beschreibt die aktuelle Seitenzahl +|?limit | integer | Beschreibt wieviele Elemente pro Seite angezeigt werden sollen + +--- + +### Beispiel Anfrage + +##### PHP +```php + 'control.local/api/v2/order', + CURLOPT_CUSTOMREQUEST => 'GET', + CURLOPT_HTTPHEADER => array( + 'X-TOKEN: test-token', + 'Content-Type: application/json' + ), +)); + +$response = curl_exec($curl); + +curl_close($curl); +echo $response; +``` + +##### cURL +```bash +curl --location --request GET 'control.local/api/v2/order' \ +--header 'X-TOKEN: test-token' \ +--header 'Content-Type: application/json' +``` + +--- + +### Beispiel Antwort + +```json +{ + "status": "OK", + "totalResults": 25, + "page": 1, + "itemsPerPage": 10, + "maxPages": 3, + "items": [ + { + "id": 1, + "ordernum": 12345678910, + "amount": "0.00", + "date": "2000-00-00 00:00:00", + "paymentmethod": "paypal", + "paymentstatus": "Paid", + "name": "Test User", + "items": [ + { + "type": "product", + "producttype": "Dedicated/VPS Server", + "product": "KVM SSD Premium - KVM SSD Konfigurator Gen5", + "billingcycle": "Monthly", + "amount": "€0.00EUR" + } + ] + }, + { + "id": 2, + "ordernum": 123456789, + "amount": "0.00", + "date": "2000-00-00 00:00:00", + "paymentmethod": "paypal", + "paymentstatus": "Paid", + "name": "Test User", + "items": [ + { + "type": "product", + "producttype": "Hosting Account", + "product": "Gameserver - Valheim", + "billingcycle": "Monthly", + "amount": "€0.00EUR" + } + ] + } + ] +} +``` + +### Mögliche Fehlermeldungen + +> :warning: Status Code **403** - Permission denied + +> :warning: Status Code **500** - Oops! \ No newline at end of file