Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
Generell tjänst för att hantera medborgares (anonyma eller ej) inställningar för återkoppling (för till exempel felanmälningar och driftstörningar).
Livscykelstatus
Under utveckling
Lösningsbeskrivning
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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:
https://api-i-test.sundsvall.se/feedbacksettings/0.1 (intern API Gateway)
https://api-test.sundsvall.se/feedbacksettings/0.1 (extern API Gateway)
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 | ||
|---|---|---|
| ||
{
"emailAddress": "test.testorsson@test.se",
"mobileNumber": "0731231212",
"personId": "15aee472-46ab-4f03-9605-68bd64ebc73f",
"primaryContactMethod": "SMS",
"sendFeedback": true
} |
Response body:
| Code Block | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
[
{
"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 | ||
|---|---|---|
| ||
[
{
"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 | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
{
"mobileNumber": "0703213232",
"emailAddress": "changed_email@test.se"
} |
Response body:
| Code Block | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
{
"mobileNumber": "0701111111",
"emailAddress": "changed_email_again@test.se",
"personId": "15aee472-46ab-4f03-9605-68bd64ebc999",
"primaryContactMethod": "SMS",
"sendFeedback": true
} |
Response body:
| Code Block | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
{
"id": 2,
"mobileNumber": "0703213232",
"emailAddress": "changed_email@test.se",
"personId": "15aee472-46ab-4f03-9605-68bd64ebc732",
"primaryContactMethod": "EMAIL",
"sendFeedback": false
} |
Säkerhetsklassning
Säkerhetsklass TBD1
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.se
Länkar
<Länkar till dev-portal;
Test
Produktion & Sandbox - https://api-im-test.sundsvall.se/devportal/apis/01500975-83c2-459a-b5b0-d68bf4bef188/overview
FAQ
<FAQ>