Komenda: create
Opis komendy
Komenda pozwala na utworzenie nowego konta abonenckiego.
| Parametr | Opis |
|---|---|
| name | nazwa/imię i nazwisko |
| reprezentant | reprezentant (dot. firm), dla osób fizycznych puste „” |
| IsIndividual | os.fizyczna (wartość 1)/firma (wartość 0) |
| IdNumber | PESEL (dla osób fizycznych) lub NIP (dla firm) |
| adres email | |
| phone | telefon w formacie +48.[numer] |
| mobile | telefon komórkowy w formacie +48.[numer] (w przypadku braku ”) |
| fax | faks w formacie +48.[numer] (w przypadku braku ”) |
| street | ulica |
| city | miasto |
| postcode | kod pocztowy |
| country | dwuliterowy kod kraju |
Zwracane dane
| Zwracane dane | Opis |
|---|---|
| clientId | Numer nowo utworzonego konta abonenckiego CSA |
Przykładowa komenda
create($name, $name2, $isIndividual, $idNumber, $email, $phone, $mobile, $fax, $street, $city, $pc, $country)
Przykładowa odpowiedź
1 | $response = $soap->create("HRD.pl", "Test Testowy", 0, "12345678", "test@hrd.pl", "+48.228538888", "", "", "Testowa 17", "Warszawa", "02-672", "PL"); |
Przykładowa odpowiedź
1 | {"status":true,"clientId":"csa269794"} |
Komenda: change
Opis komendy
Komenda pozwala na modyfikację danych w koncie abonenckim.
UWAGA! Komenda zmienia jedynie dane w CSA, nie pozwala na zmianę danych w identyfikatorach kontaktu.
Zmiany danych w identyfikatorach kontaktu dokonywane są wyłącznie przez Rejestratora zgodnie z aktualnie obowiązującą procedurą.
Parametry
| Parametr | Opis |
|---|---|
| name | nazwa/imię i nazwisko |
| reprezentant | reprezentant (dot. firm), dla osób fizycznych puste „” |
| adres email | |
| phone | telefon w formacie +48.[numer] |
| mobile | telefon komórkowy w formacie +48.[numer] (w przypadku braku ”) |
| fax | faks w formacie +48.[numer] (w przypadku braku ”) |
| street | ulica |
| city | miasto |
| postcode | kod pocztowy |
| country | dwuliterowy kod kraju |
Zwracane dane
| Zwracane dane | Opis |
|---|---|
| status | Status wykonania komendy – true lub false |
Przykładowa komenda
change(„csa123”, „Jacek1”, „”, „test@hrd.pl”, „+48.228538888”, „”, „+48.228538885”, „ulica testowa 17”, „testowo”, „96-100”, „PL”)
1 | $response = $soap->change("csa123", "Jacek1", "", "test@hrd.pl", "+48.228538888", "", "+48.228538885", "ulica testowa 17", "testowo", "96-100", "PL"); |
Przykładowa odpowiedź
1 | {"status":true} |
Komenda: listAll
Opis komendy
Komenda zwraca listę numerów kont abonenckich CSA obsługiwanych przez Partnera z limitem 100 kont na komendę; przesunięcie pozwala na wyświetlenie kolejnych numerów kont.
Parametry
| Parametr | Opis |
|---|---|
| offset | przesunięcie pozwalające na wyświetlenie kolejnych numerów kont |
Zwracane dane
| Zwracane dane | Opis |
|---|---|
| max | ilość kont obsługiwanych przez Partnera |
| clients | tablica numerów kont oddzielonych przecinkami |
Przykładowa komenda
listAll(100)
1 | $response = $soap->listAll(100); |
Przykładowa odpowiedź
1 | {"status":true,"max":"104","clients":["csa111","csaXXXX","csaXXXX","csaXXXX"]} |
Komenda: info
Opis komendy
Komenda pozwala na sprawdzanie dostępnych w bazie danych abonenta CSA.
Parametry
| Parametr | Opis |
|---|---|
| numer CSA | numer sprawdzanetgo konta abonenckiego CSA |
Zwracane dane
| Parametr | Opis |
|---|---|
| name | nazwa/imię i nazwisko |
| representative | reprezentant (dot. firm), dla osób fizycznych puste „” |
| creationDate | data utworzenia konta |
| documentId | numer NIP/PESEL |
| phone | telefon |
| mobile | telefon komórkowy (w przypadku braku ”) |
| fax | faks (w przypadku braku ”) |
| adres email | |
| isIndividual | osoba fizyczna (true)/firma (false) |
| street | ulica |
| city | miasto |
| postcode | kod pocztowy |
| country | dwuliterowy kod kraju |
| ProtectPrivacy | ochrona prywatności (true lub false) |
Przykładowa komenda
info(‚csa123’)
1 | $response = $soap->info('csa123'); |
Przykładowa odpowiedź
1 | {"status":true,"client":{"name":"testowy test","representative":"Jan Kowalski","creationDate":"2012-10-25 15:17:44","documentId":"123456789","phone":"+48.228538888","mobile":"","fax":"","email":"abonent@hrd.pl","isIndividual":false,"street":"Testowa 1/2","postalCode":"02-672","city":"Warszafka","country":"PL","protectPrivacy":false}} |