Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
Funktion för att registrera påminnelser, och skicka ut dem.
I kommande steg kan påminnelser komma att triggas utifrån.
Livscykelstatus
Design
Lösningsbeskrivning
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Datamodell reminders (draft)
personId (den som vill ha påminnelsen)
companyId (vilket av de företag personen representerar som påminnelsen avser - är tom om den är en privat påminnelse)
todo (fritext - exempel: “Förnya ansökan skyltlov”)
caseId (ärendenummer i Open-E t ex - exempel: “23456” - ej obligatoriskt)
caseLink (länk till ärendet i Open-E t ex för ärendet med caseId ovan - ej obligatorisk)
reminderDate (när skall påminnelsen skickas ut)
Utskick av påminnelser
Att köras en gång per dygn:
För alla reminders i databasen som har reminderDate idag:
Hämta kontaktuppgifter från feedbackSettings
Skicka påminnelsen som e-post eller SMS (beroende på uppgifterna från feedbackSettings) via messaging
Hantering av personuppgifter
PersonId används för att knyta påminnelser till en specifik individ.
API specifikation (draft) - exempel
GET /reminders/persons/{personId}
Response body:
| Code Block |
|---|
[ {
"reminderId": "R-81471222-5798-11e9-ae24-57fa13b361e1",
"personId": "81471222-5798-11e9-ae24-57fa13b361e2",
"companyId": "",
"action": "Hämta på dagis",
"caseId": "",
"caseLink": "",
"reminderDate": "2021-11-11"
}, {
"reminderId": "R-81471222-5798-11e9-ae24-57fa13b361e1",
"personId": "81471222-5798-11e9-ae24-57fa13b361e2",
"companyId": "5566344434",
"action": "Förnya alkoholtillstånd",
"caseId": "123456",
"caseLink": "open-e.sundsvall.se/somethingsomething",
"reminderDate": "2022-09-11"
}] |
GET /persons/{personId}/companies/{companyId}
Response body:
| Code Block |
|---|
[ {
"reminderId": "R-81471222-5798-11e9-ae24-57fa13b361e1",
"personId": "81471222-5798-11e9-ae24-57fa13b361e2",
"companyId": "5566344434",
"action": "Förnya alkoholtillstånd",
"caseId": "123456",
"caseLink": "open-e.sundsvall.se/somethingsomething",
"reminderDate": "2022-09-11"
} ] |
POST /reminders
Request body:
| Code Block |
|---|
{
"personId": "15aee472-46ab-4f03-9605-68bd64ebc73f",
"companyId": "5566344434",
"action": "Förnya alkoholtillstånd",
"caseId": "123456",
"caseLink": "open-e.sundsvall.se/somethingsomething",
"reminderDate": "2022-09-11"
} |
PATCH /reminders/{reminderId}
Request body:
| Code Block |
|---|
{
"reminderId": "R-81471222-5798-11e9-ae24-57fa13b361e1",
"companyId": "5566344434",
"action": "Förnya alkoholtillstånd",
"caseId": "123456",
"caseLink": "open-e.sundsvall.se/somethingsomething",
"reminderDate": "2022-09-11"
} |
DELETE /reminders/{reminderId}
Response:
Status-code: 204
POST /reminders/send
Request body:
| Code Block |
|---|
{ "reminderDate": "2022-09-11" } |
Response:
Status-code: 204
Säkerhetsklassning
Säkerhetsklass 1
Autentiseringsmetod: Oauth2
(Ref: Säkerhetsklassning av APIer )
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
<Kontaktuppgifter till utvecklare/teknisk förvaltare>
Länkar
<Länkar till dev-portal;
Test
Sandbox
Produktion>
FAQ
<FAQ>