Modtag beskeder¶
Modtag en liste af beskeder fra en bruger. User id tages ud fra access token.
Endpoint¶
GET capl/v1/messages/
Request Parametre¶
Header¶
Key |
Værdi |
|---|---|
Authorization |
Obligatorisk
Valid access token
|
Path Parametre¶
Key |
Værdi |
|---|---|
start_index |
Start index hvor fra der requestes beskeder
Hvis start_index ikke er givet, sættes den automatisk til 0
|
count |
Antal beskeder der skal returneres
Hvis count ikke er givet, sættes den automatisk til 1e12
|
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 dato med nyeste først.
Messages objekt¶
Key |
Type |
Beskrivelse |
|---|---|---|
id |
int |
ID på den aktuelle bruger |
datetime |
string |
Afsendelses tidspunkt i formatet |
date |
string |
Afsendelses dato i formatet |
time |
string |
Afsendelses tidspunkt i formatet |
sender |
string |
Afsenderens display navn |
subject |
string |
Beskedens emne |
content |
string |
Beskedens indhold, begrænset til 100 karakterer |
content_link_data |
Array |
|
read_status |
bool |
Læst status, hvor True betyder at beskeden er læst |
Eksempel¶
// json response
[
{
"id": 137,
"datetime": "17/01-24 13:15",
"date": "17/01-24",
"time": "13:15",
"sender": "Vibeke Våger",
"subject": "Kørepenge indtastet i Careplanner",
"content": "Hej Alexander Aktivitetsleder Vibeke Våger har d.d. indberettet kørepenge i Careplanner. Se de indtastede kørepenge: {{link:65a7c4c584aa0}} Dette er en automatisk oprettet mail. Careplanner - Concept",
"content_link_data": [
{
"id": "65a7c4c584aa0",
"type": 0,
"text": "Link til kørepenge",
"target_type": 2,
"target_id": 0
}
],
"read_status": false,
"archived": false
},
{
"id": 127,
"datetime": "16/01-24 18:40",
"date": "16/01-24",
"time": "18:40",
"sender": "Alexander Aktivitetsleder",
"subject": "Ny besked i logbogen",
"content": "Hej Alexander Der er ny besked i logbogen i forbindelse med vågningen af Egon. Læs logbogen via følgende link: <a href=\"https://concept.careplanner.dk/task_planning/?task_unique_id=6593ed8d2b3ec6593ed8d2b3ed\">Careplanner</a> Dette er en automatisk oprettet mail. Careplanner - Concept",
"content_link_data": [],
"read_status": false,
"archived": false
}
]