Typy i Klasy

Typy Proste

Typy proste wykorzystywane przez standard JSON takie jak:

  • object

  • array

  • string

  • int (number)

  • true / false (boolean)

  • null

class date

Data w formacie iso8601.

Przykład:

2016-01-20

class date_time

Data i czas w formacie iso8601 i oznaczeniem strefy czasowej.

Przykład:

2016-01-19T09:43:08.088149+00:00

class string

Nieskończony string

class string(x)

Skończony ciąg znaków ograniczony do maksimum x znaków

class interface_type

Typ wyliczeniowy. Określa w jaki sposób pobierany będzie adres interfejsu.

Dostępne wartości:

  • static - adres statycznie konfigurowany

  • dhcp -adres pobierany dynamicznie

class vlan_id

Identyfikator VLAN wg specyfikacji IEEE 802.1Q. Wartości 0-4094

Typ pierwotny - int

class cidr

Pełne i poprawne IP wraz z maską podsieci

x.x.x.x/yy

class ip

Adress ip, gdzie x może być wartością od 0-255

x.x.x.x

class service_state

Możliwe wartości stanu usługi.

Dostępne wartości:

  • payment_notyfy - Przypomnienie o płatnościach

  • on - Włączony

  • locked - Zablokowany

class wifi_sec_type

Możliwe wartości typu zabezpieczeń wifi.

Dostępne wartości:

  • open - Open

  • wpa-psk - WPA pre-shared key

  • wpa2-psk - WPA2 pre-shared key

class full_name

Identyfikator interfejsu w postaci nazwy host dla proxy oraz nazwa interfejsu. Przedzielone kropką.

proxy_hostname.proxy_interface_name

class stb_type

Możliwe wartości statusu boksów.

Dostępne wartości:

  • Mag200

  • Mag250

  • Korbox

  • Korbox 2.0

  • Korbox Wave

  • Korbox Magic

  • Korbox UltraHD

  • Korbox 3

class stb_status

Możliwe wartości statusu boksów.

Dostępne wartości:

  • off - Wyłaczony

  • on - Włączony

  • payment_notyfy - Przypomnienie o płatnościach

  • locked - Zablokowany

class dtmf_mode

Ustawienie wybierania tonowego dla Asterisk.

Dostępne wartości:

  • info

  • inbound

  • rfc2833

class streamersource_streamtype

Typ strumienia

Dostępne wartości:

  • HTTP

  • UDP/RTP Multicast

class streamersource_type

Typ źródła

Dostępne wartości:

  • Load Balancing

  • Backup only

class stb_rpc_operations

Wykonanie zdalnej operacji na STB. Operacje podane w innej części dokumentacji.

class proxy_rpx_operations

Wykonanie zdalnej operacji na proxy. Operacja podane w innej części dokumentacji.

class list_type
Dostępne wartości:

  • isp

  • global

  • stb

class args

Wartości dowolnego typu według specyfikacji metody, do której może on zostać przekazany.

Klasy

Obiekty klas mogą być przedstawiane w dwóch postaciach. Z założenia listy zawierają skrócona formę zawierające zazwyczaj tylko klucz lub ew. dodatkowe informacje. Jeśli metoda zwraca Pojedynczy obiekt to będzie on przedstawiony w rozszerzonej formie zawierającej wszystkie pola. Pola wchodzące w skład skróconej formy będą oznaczane gwiazdką. Druga gwiazdka oznacza że jest to ponadto klucz główny.

class client

Parameters:

  • id(int)** - identyfikator klienta

  • active(bool) - flaga aktywności

  • crm_id(string(200)) - referencja obiektu do bazy ISP

  • name(string(200)) - przyjazna nazwa lub adres

  • pin(string(255)) - pin, domyślnie wartość losowa

  • description(string) - pis zawierający dodatkowe informację o kliencie

class proxy

Parameters:

  • hostname(string(30))** - nazwa hosta

  • enabled(bool) - status włączenia domyślnie False

  • snmp_community(string(100)) - nazwa subskrypcji snmp

  • last_reload(date) - data ostatniego przeładowania

  • description(string) - opis

  • boot_interface(proxy_interface) - interfejs z którego ładowane będzie proxy

  • interfaces([proxy_interface]) - lista interfesjsów

class proxy_interface

  • full_name (full_name)** - nazwa interfejsu

  • name(string(60)) - nazwa interfejsu

  • type(interface_type) - typ interfejsu, domyślnie „static”

  • enabled(bool) - flaga oznaczającą włączenie, domyślnie false

  • stb_connectable(bool) - flaga oznaczająca możliwość podłaczania stb, domyślnie false

  • l3flag(bool) - STB podpięte pod ten interfejs są typu L3

  • mac(string(12)) - fizyczny adres interfejsu

  • device(string(60)) - urządzenia do którego jest przypisany dany interfejs, domyślnie eth0

  • vlan(vlan_id) – numer vlan lub null gdy brak vlan na tym interfejsie

  • cidr(cidr) – cidr

  • default_gateway(ip) – brama domyślna dla danego interfejsu

class service

Parameters:

  • id(int)** - identyfikator usługi

  • client(client) – podmiot usługi

  • package_base(package)* – pakiet podstawowy

  • package_additional([package ]) – lista pakietów dodatkowych

  • state(service_state) – stan usługi, domyślnie normal

  • proxy_interface(proxy_interface) – interfejs na którym będzie świadczona usługa

  • name(string)(255) – przyjazna nazwa usługi lub krótki opis

  • stbs([ stb ]) – lista urządzeń na których będzie świadczona usługa wraz z dodatkowymi

  • start(date)* – data rozpoczęcia usługi

  • end(date)* – data zakończenia usługi lub null gdy usługa bezterminowa

  • previous_service(int) - identyfikator poprzedniej usługi

  • next_service(int) - identyfikator kolejnej usługi

class user_info

Parameters:

  • user(string) - nazwa użytkownika

  • isp(string) - nazwa isp

class application

Parameters:

  • name(string(255))** - nazwa pakietu

  • description(string(255)) - nazwa aplikacji

class package

Parameters:

  • name(string)(60)** - nazwa pakietu

  • id(int) - nazwa pakietu

  • test(bool) - czy pakiet jest testowy

  • active(bool) - czy pakiet jest aktywny

  • interval(int) - ilość misięcy na

  • headend_name(string) - nazwa headendu

class stb

Parameters:

  • mac(string)** - adres MAC urządzenia

  • status(stb_status) - status urządzenia

  • type(stb_type) - typ urządzenia

  • serial_number(string) - numer seryjny

  • pin(string(10)) - pin

  • l3(bool) - czy box jest l3, domyślnie true

  • proxy_interface(proxy_interface), interfejs proxy do jakiego dany box jest przypisany

  • firmware(string) - firmware

  • ip(ip) - ip dla boxów l2

  • function_access_point(bool) - czy może pełnić funkcję Access Pointa, domyślnie true

  • function_standard_dhcp(bool) - czy ma pobierać standardowy adres dhcp, domyślnie false, dotyczy tylko l2

  • application_list([application ]) - lista aplikacji

  • description(string) - opis

  • available_streamers([proxy_interface]) - lista proxy z jakimi może się łączyć box

  • is_multicast(bool) - flaga świadcząca o wykorzystaniu stb w trybie multicast a nie unicast

class voip_setting

Parameters:

  • mac(string)** - urządzenie z mac którego dotyczą ustawienia

  • voip_server(string(128))* - ip lub nazwa hosta serwera VOIP

  • port(int)* – port na którym słucha serwer VOIP

  • username(string)(64)* – nazwa użytkownika

  • password(string)(64) – hasło dla użytkownika

  • dtmf_mode(dtmf_mode)info – tryb wybierania wielotonowego

class firmware

Parameters:

  • tag(string)** - tag firmware’u

  • device(stb_type) - urządzenie dla którego firmware został wydany

  • available(bool) - czy jest dostępny do instalacji

  • l3(stb).l3 - czy jest to firmware dla boxów l3

class streamersource

Parameters:

  • id(string)** - identyfikator

  • enabled(string) - czy źródło jest aktywne

  • dhcpboot(string) - czy jest to źródło adresu ip

  • tftpboot(string) - czy jest to źródło dla PXE

  • panelsource(string) - czy jest to źródło panelu

  • streamsource(string) - czy jest to źródło strumieni

  • streamtype(string) - jakiego typu jest strumień

  • streamer(string) - dla jakiego streamera należy to źródło

  • upstreamnic(string) - co jest źródłem

  • weight(string) - waga dla loadbalancingu

  • type(string) - typ źródła

  • sourceip(string) - na jakim interfejsie streamera docelowego realizowana jest transmisja do źródła

class wificonfig

Parameters:

  • ssid(string)** - ssid

  • sec_type(wifi_sec_type)** - typ zabezpieczeń

  • sec_key(bool)** - hasło

  • channel(int)** - kanał

  • can_edit(bool)** - czy użytkownik może zmienić swoje wifi