Versions Compared

Old Version 15

changes.mady.by.user Dennis Nilsson

Saved on

compared with

New Version 16

changes.mady.by.user Joakim Schürer

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

Lösningsbeskrivning

Gliffy
imageAttachmentIdatt29949965
macroIde0cdd404-6147-48c0-b661-3cb73c11a997
baseUrlhttps://sundsvall.atlassian.net/wiki
namefeedbackSettingsAPI
diagramAttachmentIdatt29393082
containerId29065265
timestamp16117525779871643707761929

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-postadressobligatoriskt. 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.

API specifikation

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

En fullständig OpenAPI-specifikation finns i WSO2 Devportal.

Lagra återkopplingsinställningar

POST /settings

Request body:

Code Block
languagejson
{
  	"emailAddresspersonId": "test.testorsson@test.se49a974ea-9137-419b-bcb9-ad74c81a1d1a",
	"channels": [
"mobileNumber		{
			"contactMethod": "0731231212SMS",
  "personId			"destination": "15aee472-46ab-4f03-9605-68bd64ebc73f",
  "primaryContactMethod": "SMS",
  "sendFeedback": true0701234567",
			"sendFeedback": false
		},
		{
			"contactMethod":"EMAIL",
			"destination":"test.testorsson@test.se",
			"sendFeedback":true
		}
	]
}

Response body:

Code Block
languagejson
{
  	"id": 1"15aee472-46ab-4f03-9605-68bd64ebc73a",
  	"mobileNumberpersonId": "073123121249a974ea-9137-419b-bcb9-ad74c81a1d1a",
	"channels":[
		{
			"emailAddresscontactMethod": "test.testorsson@test.seSMS",
  "personId			"destination": "15aee472-46ab-4f03-9605-68bd64ebc73f0701234567",
			"sendFeedback": false
		},
		{
			"primaryContactMethodcontactMethod":"EMAIL",
"SMS			"destination":"test.testorsson@successful.create",
			"sendFeedback":true
		}
	],
	"sendFeedbackcreated": true"${json-unit.any-string}"
}

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:

json
Code Block
language
{
    "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
}
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>