Modtag alle brugere¶
Få basis informationer på alle aktive brugere
Endpoint¶
GET capl/v1/users/
Request Parametre¶
Header¶
Key |
Værdi |
|---|---|
Authorization |
Obligatorisk
Valid access token
|
Response format¶
Ved succes returneres HTTP status code i headeren med kode 200 OK og body indeholder et array af simple bruger objekter i JSON-format.
Objekterne returneres sorteret efter navn.
Simpelt bruger objekt¶
Key |
Type |
Beskrivelse |
|---|---|---|
id |
int |
ID på den aktuelle bruger |
name |
string |
Fuldt navn af bruger (Fornavn + Efternavn) |
initials |
string |
Initialer (Første karakter af Fornavn + 1 karakter af Efternavn) |
user_level |
int |
Bruger level bitmaske:
USER_LEVEL_ADMIN:
1 << 1USER_LEVEL_SUPER_USER:
1 << 2USER_LEVEL_USER:
1 << 3USER_LEVEL_SPECTATOR:
1 << 4 |
role_shortname |
string |
Bogstav der definerer brugertypen. Eks. “B” for Bruger |
phone |
int |
Telefonnummer |
string |
||
full_address |
string |
Fuld adresse: Adresse , postnummer og by |
protected_address |
bool |
Angiver om der er beskyttet adresse |
hidden_email |
bool |
Angiver om der er skjult email |
hidden_phone |
bool |
Angiver om der er skjult telefonnummer |
Eksempel¶
// json response
[
{
"id": 17,
"name": "Vibeke Vaager",
"initials": "VV",
"user_level": 8,
"role_shortname": "B",
"phone": 27129865,
"email": "v@ogdal.dk",
"full_address": "Vestergade 67, 3200 Helsinge",
"protected_address": false,
"hidden_email": false,
"hidden_phone": false
},
{
"id": 31,
"name": "Pernille Planlægger",
"initials": "PP",
"user_level": 4,
"role_shortname": "P",
"phone": 88888888,
"email": "p@ogdal.dk",
"full_address": "Platanvej, 3200 Helsinge",
"protected_address": false,
"hidden_email": false,
"hidden_phone": false
},
]