Beskrivning

Funktion för att registrera påminnelser, och skicka ut dem.

I kommande steg kan påminnelser komma att triggas utifrån.

Livscykelstatus

DesignProduktion

Lösningsbeskrivning

Datamodell reminders

• 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åminnelsepartyId (mottagare till påminnelsen, uuid för företag eller privatperson)

• 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)

• note (fritext - notering kopplad till påminnelsen. Ingår ej i påminnelsenutskicket)

• reminderDate (när skall påminnelsen skickas ut)

• created (tidsstämpel då påminnelsen skapades)

• createdBy (identifikation på individ som skapade påminnelsen)

• modified (tidsstämpel då påminnelsen senast uppdaterades, null om ingen uppdatering skett)

• modifiedBy (identifikation på individ som senast uppdaterade påminnelsen, null om ingen uppdatering skett)

Utskick av påminnelser

Att köras en gång per dygn:

För alla reminders i databasen som har reminderDate idag:

1. Hämta kontaktuppgifter via Messaging från feedbackSettings

2. Skicka påminnelsen som e-post eller SMS (beroende på uppgifterna från feedbackSettings) via messaging

Hantering av personuppgifter

PersonId partyId används för att knyta påminnelser till en specifik individ eller organisation.

API specifikation

GET /reminders/persons/{personId}

Response body:

[ {
  "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:

[ {
  "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:

{
  "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:

{
  "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:

{
  "reminderDate": "2022-09-11"
}

Response:

Open api
showCommonExtensions true deepLinking true supportedSubmitMethods none location url showExtensions true url https://api-test.sundsvall.se/reminders/api-docs