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
1634905182378
imageAttachmentIdatt826179599
macroId4a9f70e6-1685-4918-84f6-0633586f01dc
baseUrlhttps://sundsvall.atlassian.net/wiki
nameremindAndInformAPI
diagramAttachmentIdatt826114052
containerId823558153
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å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)

Hantering av personuppgifter

<Vilka personuppgifter hanteras och varför?>

API specifikation

<API specifikation>

Säkerhetsklassning

Säkerhetsklass <0, 1, 2, 3, 4>

Autentiseringsmetod: <API Key, Oauth2>

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

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 /

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>