Przejdź do głównej treści

Aktualizuj metadane odbiorcy kuriera

Ready_™ Developer TeamMniej niż 1 minuta

Aktualizuj metadane odbiorcy kuriera

Definicja Funkcji

updateCourierReceiverMeta($courid, $receiver, $meta)

Mechanizm kurierów

Wiecej o kurierach dowiesz się tutajopen in new window

Definicja parametrów

Metoda przyjmuje 3 argumentów

Nazwa parametruTyp parametruOpis
couridInt (Wymagany)Identyfikator kuriera (couriers.courid)
receiverInt (Wymagany)Identyfikator odbiorcy (users.usr_id)
metaArray lub JSON String (Wymagany)Metadane kuriera

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
$api = new \EDokApi();
try {
    $courid = 1;
    $receiver = 1;
    $meta = [
        'data' => 'example metadata'
    ];   
    $result = $api->updateCourierReceiverMeta($courid, $receiver, $meta);
} catch(\Exception $e) {
    throw new \Exception($e->getMessage());
}

Zwracane dane lub wyjątki

Metoda zwraca boolean(true) 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