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

DesignProduktion

Lösningsbeskrivning

Gliffy
https://sundsvall.atlassian.net/wiki
imageAttachmentIdatt826179599
baseUrlhttps://sundsvall.atlassian.net/wiki
macroId4a9f70e6-1685-4918-84f6-0633586f01dc
baseUrldisplayNameremindAndInformAPI
nameremindAndInformAPI
diagramAttachmentIdatt826114052
containerId823558153
pagePin4
timestamp1634907453023

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å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

(draft) - exempel

GET /{personId}

Response body:

Code Block
[ {
  "id": "1",
  "companyId": "",
  "todo": "Hämta på dagis",
  "caseId": "",
  "caseLink": "",
  "remiderDate": "2021-11-11"
}, {
  "id": "2",
  "companyId": "5566344434",
  "todo": "Förnya alkoholtillstånd",
  "caseId": "123456",
  "caseLink": "open-e.sundsvall.se/somethingsomething",
  "remiderDate": "2022-09-11"
}]

GET /{personId}/{companyId}

Response body:

Code Block
[ {
  "id": "2",
  "companyId": "5566344434",
  "todo": "Förnya alkoholtillstånd",
  "caseId": "123456",
  "caseLink": "open-e.sundsvall.se/somethingsomething",
  "remiderDate": "2022-09-11"
} ]

PUT /

Request body:

Code Block
{
  "personId": "15aee472-46ab-4f03-9605-68bd64ebc73f",
  "companyId": "5566344434",
  "todo": "Förnya alkoholtillstånd",
  "caseId": "123456",
  "caseLink": "open-e.sundsvall.se/somethingsomething",
  "remiderDate": "2022-09-11"
}

PATCH /

Request body:

Code Block
{
  "id": "2",
  "companyId": "5566344434",
  "todo": "Förnya folkölstillstånd",
  "caseId": "123456",
  "caseLink": "open-e.sundsvall.se/somethingsomething",
  "remiderDate": "2022-09-11"
}
DELETE /

Open api
showCommonExtensionstrue
deepLinkingtrue
supportedSubmitMethodsnone
locationurl
showExtensionstrue
urlhttps://api-test.sundsvall.se/reminders/api-docs



Säkerhetsklassning

Säkerhetsklass 1

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>N/A

Teknisk ägare

<Kontaktuppgifter till utvecklare/teknisk förvaltare>

Team Unmasked
teamunmasked@sundsvall.se

Länkar

<Länkar till dev-portal;

Test

Sandbox

Produktion>

Produktion

Källkod

https://github.com/OpenSundsvall/api-service-remindandinform

FAQ

<FAQ>