Modtag én bruger¶
Returnerer udvidede informationer på bruger med det angivne ID.
Note
Der er pt kun support for at hente oplysninger på den samme bruger som er i token.
Support for højere user_levels kommer senere.
Endpoint¶
GET capl/v1/users/{id}
Request Parametre¶
Header¶
Key |
Værdi |
|---|---|
Authorization |
Obligatorisk
Valid access token
|
Path Parametre¶
Key |
Værdi |
|---|---|
id |
ID for den forespurgte bruger
Hvis id er 0, anvendes user id fra access token
|
Response format¶
Ved succes returneres HTTP status code i headeren med kode 200 OK og body indeholder et objekt hvor værdien er et bruger objekt i JSON-format.
Bruger objekt¶
Key |
Type |
Beskrivelse |
|---|---|---|
id |
int |
ID på den aktuelle bruger |
name |
string |
Fuldt navn af bruger (Fornavn + Efternavn) |
firstname |
string |
Fornavn |
lastname |
string |
Efternavn |
initials |
string |
Initialer (Første karakter af Fornavn + 1 karakter af Efternavn) |
gender |
string |
Køn, “Mand” eller “Kvinde” |
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 |
||
address |
string |
Adresse |
postal |
int |
Postnummer |
city |
string |
By |
full_address |
string |
Fuld adresse: Adresse , postnummer og by |
active_state |
string |
“active” or “inactive” |
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 |
notification_new_task |
int |
Angiver hvor der skal sendes besked til ved Ny opgave
|
notification_end_task |
int |
Angiver hvor der skal sendes besked til ved Afsluttet opgave
|
notification_new_log |
int |
Angiver hvor der skal sendes besked til ved Ny besked i logbogen
|
notification_new_duties |
int |
Angiver hvor der skal sendes besked til ved Nye vagter
|
notification_updated_data |
int |
Angiver hvor der skal sendes besked til ved Opdatering af stamdata
|
notification_new_plan |
int |
Angiver hvor der skal sendes besked til ved Ny vagtplan
|
notification_updated_plan |
int |
Angiver hvor der skal sendes besked til ved Opdatering til vagtplan
|
notification_add_explicit_access |
int |
Angiver hvor der skal sendes besked til ved Tilknyttet opgave
|
notification_custom_message |
int |
Angiver hvor der skal sendes besked til ved Bruger-definerede beskeder
|
notification_mileage_log_book_sent_to_cashier |
int |
Angiver hvor der skal sendes besked til ved Kørepenge sendt til kasserer
|
notification_devices |
array |
Array med enheder der kan modtage notifikationer
Hvert element indeholder:
name: (string) Navn på enheden: Eks. “Peter’s iPhone”
token: (string) FCM token
timestamp: (int) Unix timestamp
notifications_enabled (bool) Notifikations status
|
Eksempel¶
// json response
{
"id": 10,
"name": "Vibeke Våger",
"firstname": "Vibeke",
"lastname": "Våger",
"initials": "VV",
"gender": "Kvinde",
"user_level": 8,
"role_shortname": "B",
"phone": 27129864,
"email": "v@ogdal.dk",
"address": "Vågevej 17",
"postal": 3200,
"city": "Helsinge",
"full_address": "Vågevej 17, 3200 Helsinge",
"active_state": "active",
"protected_address": true,
"hidden_email": true,
"hidden_phone": true,
"notification_new_task": "10",
"notification_end_task": "1",
"notification_new_log": "1",
"notification_new_duties": "1",
"notification_updated_data": "10",
"notification_new_plan": "1",
"notification_updated_plan": "10",
"notification_add_explicit_access": "10",
"notification_custom_message": "1",
"notification_mileage_log_book_sent_to_cashier": "2",
"notification_devices": [
{
"name": "Vibekes Enhed 2",
"token": "cFC5iY8RQ7ijHwNALXP5GA:APA91bHOwBmj_1OON2UiJF77ounVt_0a2NYICP8OyAdK7WCgYGJftUiHb3oJBu2oAfgC-aEEbdElWzYw6f_40wRRshhR9XwxE5IRryFkQZPHvzx2Mp7lPA9qmGsXOTLuZ9K-2D97N2Un",
"timestamp": 1645351616,
"notifications_enabled": true
}
],
"base64_profile_picture": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD//..."
}