Pobierz dane o kurierach
Mniej niż 1 minuta
Pobierz dane o kurierach
Definicja Funkcji
Array getCouriers(Array $data)
Mechanizm kurierów
Wiecej o kurierach dowiesz się tutaj
Definicja parametrów
Metoda przyjmuje 1 argument, jako tablica lub string JSON. Dostępne klucze:
Nazwa parametru | Typ parametru | Opis |
---|---|---|
courier | Int | określa od którego kuriera (włącznie) mają zostać zwracani kolejni kurierzy (podobne działanie jak offset) |
limit | Int | określa ile kurierów ma zostać zwróconych. |
Przykład użycia
require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
$data = [
'courier' => 3,
'limit' => 5,
];
$couriers = $api->getCouriers($data);
//id pobranych kurierów: 3,4,5,6,7
} catch(\Exception $e) {
throw new \Exception($e->getMessage());
}
Zwracane dane lub wyjątki
Metoda zwraca tablice asocjacyjną z danymi kurierów w przypadku sukcesu. Jeśli wystąpi błąd wtedy, zostanie zwrócony wyjątek.
Zwracane wyjątki w zależności od wywołania
- SOAP - SoapFault
- Lokalnie - Exception