parent
1b57f96e75
commit
479efe4b26
1 changed files with 88 additions and 0 deletions
@ -0,0 +1,88 @@ |
||||
## **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 |
||||
<?php |
||||
|
||||
$curl = curl_init(); |
||||
|
||||
curl_setopt_array($curl, array( |
||||
CURLOPT_URL => 'control.local/api/v2/dns/zones', |
||||
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/dns/zones' \ |
||||
--header 'X-TOKEN: test-token' \ |
||||
--header 'Content-Type: application/json' |
||||
``` |
||||
|
||||
--- |
||||
|
||||
### Beispiel Antwort |
||||
|
||||
```json |
||||
{ |
||||
"status": "OK", |
||||
"totalResults": 5, |
||||
"page": 1, |
||||
"itemsPerPage": 10, |
||||
"maxPages": 1, |
||||
"items": [ |
||||
"domain1.de", |
||||
"domain2.de", |
||||
"domain3.de", |
||||
"domain4.de", |
||||
"domain5.de" |
||||
] |
||||
} |
||||
``` |
||||
|
||||
### Mögliche Fehlermeldungen |
||||
|
||||
> :warning: Status Code **403** - Permission denied |
Loading…
Reference in new issue