Przejdź do głównej treści

Pobierz dane o kurierach

Ready_™ Developer TeamMniej niż 1 minuta

Pobierz dane o kurierach

Definicja Funkcji

Array getCouriers(Array $data)

Mechanizm kurierów

Wiecej o kurierach dowiesz się tutajopen in new window

Definicja parametrów

Metoda przyjmuje 1 argument, jako tablica lub string JSON. Dostępne klucze:

Nazwa parametruTyp parametruOpis
courierIntokreśla od którego kuriera (włącznie) mają zostać zwracani kolejni kurierzy (podobne działanie jak offset)
limitIntokreś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