Versions Compared

Old Version 14

changes.mady.by.user Per Persson

Saved on

compared with

New Version Current

changes.mady.by.user Publisher User Atlassian Cloud

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Beskrivning

Generell tjänst för att hantera medborgares

(anonyma eller ej)

och organisationers inställningar för hur återkoppling ska ske (för till exempel felanmälningar och driftstörningar). 

Livscykelstatus

Under utveckling

Produktion

Lösningsbeskrivning

Gliffy

imageAttachmentIdatt29949965macroIde0cdd404-6147-48c0-b661-3cb73c11a997baseUrlhttps://sundsvall.atlassian.net/wiki

displayNamefeedbackSettingsAPI Copy
namefeedbackSettingsAPI Copy

diagramAttachmentIdatt29393082containerId29065265timestamp1611752577987

pagePin2



Hantering av personuppgifter

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

inte en obligatorisk parameter. Det är möjligt att endast registrera mobilnummer och/eller e-postadress.

API specifikation

Här beskrivs några exempel på anrop som är möjliga att göra mot:

En fullständig OpenAPI-specifikation finns i WSO2 Devportal:
https://api-im-test.sundsvall.se/devportal/apis/01500975-83c2-459a-b5b0-d68bf4bef188/test

Lagra återkopplingsinställningar

POST /settings

Request body:

Code Block
languagejson
{
  "emailAddress": "test.testorsson@test.se",
  "mobileNumber": "0731231212",
  "personId": "15aee472-46ab-4f03-9605-68bd64ebc73f",
  "primaryContactMethod": "SMS",
  "sendFeedback": true
}

Response body:

Code Block
languagejson
{
  "id": 1,
  "mobileNumber": "0731231212",
  "emailAddress": "test.testorsson@test.se",
  "personId": "15aee472-46ab-4f03-9605-68bd64ebc73f",
  "primaryContactMethod": "SMS",
  "sendFeedback": true
}

Hämta alla återkopplingsinställningar

GET /settings

Response body:

Code Block
languagejson
[
    {
        "id": 1,
        "mobileNumber": "0731231212",
        "emailAddress": "test.testorsson@test.se",
        "personId": "15aee472-46ab-4f03-9605-68bd64ebc73a",
        "primaryContactMethod": "SMS",
        "sendFeedback": true
    },
    {
        "id": 2,
        "mobileNumber": "0722222222",
        "emailAddress": "2.testorsson@test.se",
        "personId": "15aee472-46ab-4f03-9605-68bd64ebc732",
        "primaryContactMethod": "EMAIL",
        "sendFeedback": false
    },
    {
        "id": 3,
        "mobileNumber": "0703333333",
        "emailAddress": "3.testorsson@test.se",
        "personId": "15aee472-46ab-4f03-9605-61ba64ebc733",
        "primaryContactMethod": "SMS",
        "sendFeedback": false
    }
]

Hämta återkopplingsinställningar med query parameters

GET /settings?emailAddress=test.testorsson@test.se&mobileNumber=0731231212&personId=15aee472-46ab-4f03-9605-68bd64ebc73f

Query parameters:

  • emailAddress

  • mobileNumber

  • personId

Response body:

Code Block
languagejson
[
    {
        "id": 1,
        "mobileNumber": "0731231212",
        "emailAddress": "test.testorsson@test.se",
        "personId": "15aee472-46ab-4f03-9605-68bd64ebc73f",
        "primaryContactMethod": "SMS",
        "sendFeedback": true
    }
]

Hämta återkopplingsinställning med id

GET /settings/2

Code Block
languagejson
{
    "id": 2,
    "mobileNumber": "0722222222",
    "emailAddress": "2.testorsson@test.se",
    "personId": "15aee472-46ab-4f03-9605-68bd64ebc732",
    "primaryContactMethod": "EMAIL",
    "sendFeedback": false
}

Uppdatera återkopplingsinställning

Uppdaterar en viss del av resursen.

PATCH /settings/2

Request body:

Code Block
languagejson
{
    "mobileNumber": "0703213232",
    "emailAddress": "changed_email@test.se"
}

Response body:

Code Block
languagejson
{
    "id": 2,
    "mobileNumber": "0703213232",
    "emailAddress": "changed_email@test.se",
    "personId": "15aee472-46ab-4f03-9605-68bd64ebc732",
    "primaryContactMethod": "EMAIL",
    "sendFeedback": false
}

Ersätt återkopplingsinställning

Ersätter hela resursen.

PUT /settings/2

Request body:

Code Block
languagejson
{
    "mobileNumber": "0701111111",
    "emailAddress": "changed_email_again@test.se",
    "personId": "15aee472-46ab-4f03-9605-68bd64ebc999",
    "primaryContactMethod": "SMS",
    "sendFeedback": true
}

Response body:

Code Block
languagejson
{
    "id": 2,
    "mobileNumber": "0701111111",
    "emailAddress": "changed_email_again@test.se",
    "personId": "15aee472-46ab-4f03-9605-68bd64ebc999",
    "primaryContactMethod": "SMS",
    "sendFeedback": true
}

Ta bort återkopplingsinställning

DELETE /settings/2

Response body:

Code Block
languagejson
{ "id": 2, "mobileNumber": "0703213232", "emailAddress": "changed_email@test.se", "personId": "15aee472-46ab-4f03-9605-68bd64ebc732", "primaryContactMethod": "EMAIL", "sendFeedback": false }

obligatoriskt. I fall personen företräder en organisation så används personId i kombination med organisationsId för att knyta de återkopplingsuppgifter som gäller när personen företräder organisationen. Dvs, en person kan ha en specifik uppsättning återkopplingsuppgifter för personligt bruk samtidigt som hen har en annan uppsättning för respektive organisation som hen företräder. En organisation kan ha en eller flera företrädande personer.

En person eller företrädare för en organisation kan ha 0-n poster i listan över kontaktmetoder, men kan ej ha flera poster med samma innehåll. Dvs, hen kan tex bara ha en post med kontaktkanal SMS och destination 0701234567. Hen kan däremot ha flera poster för tex SMS, så länge destinationen skiljer sig åt mellan dem. Exempelvis:


Code Block
languagejson
API specifikation
 Open api
urlhttps://api.sundsvall.se/feedbacksettings/api-docs
Säkerhetsklassning
Säkerhetsklass 1
Autentiseringsmetod: Oauth2
(Ref: Säkerhetsklassning av APIer )
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/API 
För tekniska frågor: 
dennis.nilsson@sundsvall
 teamunmasked@sundsvall.se
Länkar
<Länkar till dev-portal;
FAQ
<FAQ>
Källkod
Github
FAQ