Documentation
Table of Contents
> Gebruikersobject
De volgende objecten zijn direct gerelateerd aan de user API.
Gebruiker
Het gebruikersobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| userid | string | (alleen-lezen) ID van de gebruiker. |
| gebruikersnaam (verplicht) |
string | Gebruikersnaam. |
| attempt_clock | timestamp | (alleen-lezen) Tijd van de laatste mislukte inlogpoging. |
| attempt_failed | integer | (alleen-lezen) Aantal recente mislukte inlogpogingen. |
| attempt_ip | string | (alleen-lezen) IP-adres waar de laatste mislukte inlogpoging vandaan kwam. |
| autologin | geheel getal | Automatisch inloggen inschakelen. Mogelijke waarden: 0 - (standaard) automatisch inloggen uitgeschakeld; 1 - automatisch inloggen ingeschakeld. |
| autologout | string | Levensduur gebruikerssessie. Accepteert seconden en tijdseenheid met achtervoegsel. Indien ingesteld op 0s, verloopt de sessie nooit. Standaard: 15m. |
| lang | string | Taalcode van de taal van de gebruiker, bijvoorbeeld en_GB.Standaard: default - systeemstandaard. |
| name | string | Naam van de gebruiker. |
| refresh | string | Automatische vernieuwingsperiode. Accepteert seconden en tijdseenheid met achtervoegsel. Standaard: 30s. |
| rows_per_page | integer | Aantal objectrijen dat per pagina moet worden weergegeven. Standaard: 50. |
| achternaam | string | Achternaam van de gebruiker. |
| theme | string | Gebruikersthema. Mogelijke waarden: default - (default) systeemstandaard;blue-theme - Blauw;dark-theme - Donker. |
| url | string | URL van de pagina waarnaar de gebruiker moet worden doorverwezen na het inloggen. |
| timezone | string | Tijdzone van gebruiker, bijvoorbeeld Europe/London, UTC.Standaard: default - systeemstandaard.Voor de volledige lijst met ondersteunde tijd zones verwijzen wij u naar PHP-documentatie. |
| roleid (verplicht) |
string | Rol-ID van de gebruiker. |
Media
Het mediaobject heeft de volgende eigenschappen.
| Eigendom | Type | Beschrijving |
|---|---|---|
| mediatypeid (verplicht) |
string | ID van het mediatype dat door de media wordt gebruikt. |
| sendto (vereist) |
string/array | Adres, gebruikersnaam of andere identificatie van de ontvanger. If type of Media type is e-mail, waarden worden weergegeven als array. Voor andere typen Mediatypen wordt de waarde weergegeven als een tekenreeks. |
| active | integer | Of de media is ingeschakeld. Mogelijke waarden: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
| ernst | integer | Activeer ernst om meldingen over te verzenden. Ernsten worden in binaire vorm opgeslagen, waarbij elk bit de bijbehorende ernst vertegenwoordigt. Bijvoorbeeld, 12 is binair gelijk aan 1100 en betekent dat er meldingen worden verzonden vanaf triggers met een waarschuwing voor de ernst en het gemiddelde. Raadpleeg de trigger-objectpagina voor een lijst met ondersteunde trigger-ernsten. Standaard: 63 |
| periode | string | Tijd waarop de meldingen kunnen worden verzonden als time period of gebruikersmacro's gescheiden door een puntkomma. Standaard: 1-7, 00:00-24:00 |