Versions Compared

Key

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

Beskrivning

Tar emot felanmälan, samt tillhandahåller master data för nya felanmälningar. 

Fas 1 (denna Aktuell version): skicka vidare felanmälan : integration mot ISYcase för SBK-relaterade felanmälningar - i övrigt så skickas felanmälan vidare via e-post, vattenmätarelarm och bräddmätarelarm går till MSVA och resterande till kundtjänst (digilogt)på servicecenter.

Fas 2: addera bildanalys samt integrationer mot fler verksamhetssystem (digitalt)

Mer information: Felanmälan

Livscykelstatus

TestProduktion

Lösningsbeskrivning

Code Block
languagejson
{
    "INCIDENT_ID": 17,
    "CITIZEN_ID": 14,
    "Created": "2020-12-10T22:33:07.000Z",
    "Updated": null,
    "Category": 6,
    "Description": "Någon har kastat tugummi i en park",
    "MapCoordinates": "62.23162,17.27403",
    "FileName": "1ea519cfc1a9752bef04d6cc056bf8eb3cb7.jpg",
    "Image": ”<Base64>”
}

 

Fältet Image innehåller en Base64-textsträng som motsvarar den bild som bifogats med anmälan.

När ett ärende skickas in skapas ett ID för personen som skickat, om en person tidigare skickat ett ärende, används det tidigare ID:t. Fältet Category motsvarar en kategori i anropet api/validcategories

Gliffy

macroIddf280ba3-c550-4e27-b653-4c987cfc4001

API Specifikation

Version 1.2

2021-02-09

Ändringar

1.1   Errorreport ändrat till Incident

1.2 statusupdate borttaget och utbytt mot patch-anrop

 

POST

api/sendincident

Exempelanrop:

Code Block
languagejson
{
    "PersonalNumber": "19990105-1236",
    "Name": "Challe Testberg",
    "Address": "Testgatan 11",
    "PhoneNumber": "070123456789",
    "ContactMethod": "Email",
    "Email": "challe@testbolaget.se",
    "Category": 6,
    "Description": "Någon har kastat tugummi i en park",
    "MapCoordinates": "62.23162,17.27403",
    "Image": ”<Base64>”
}
Fältet Image är en Base64-textsträng för bifogad bild.
Fältet Category är en siffra som motsvarar en kategori som hämtas via anropet api/validcategories

 

 

PATCH

api/{id}/status

Uppdaterar status för ett ärende (id). Tar emot ett JSON-objekt med följande format:

Code Block
languagejson
{
    “status”: <statusId>
}
Fältet status är en siffra som motsvarar en kategori som hämtas via anropet api/validstatuses

Exempelanrop:

api/3/status

Body:

Code Block
languagejson
{
    “status”: 2
}

GET

api/validstatuses

Listar samtliga giltiga statusar.

Exempelsvar:

Code Block
languagejson
[
    {
        "STATUS_ID": 1,
        "Status": "open"
    },
    {
        "STATUS_ID": 2,
        "Status": "resolved"
    },
    {
        "STATUS_ID": 3,
        "Status": "rejected"
    }
]

api/validcategories

Listar samtliga giltiga kategorier

Exempelsvar:

Code Block
[
    {
        "CATEGORY_ID": 1,
        "Category": "Belysning"
    },
    {
        "CATEGORY_ID": 2,
        "Category": "Bro/Tunnel/Konstruktion"
    },
    {
        "CATEGORY_ID": 3,
        "Category": "Felparkerat och övergivet fordon"
    }
]

api/setincidentfeedback

Uppdaterar vart ärendet ska, t.ex. Stadsbyggnadskontoret. Tar emot två query-parametrar, errandid(ärende-ID), samt feedback(vart ärendet ska, t.ex. Stadsbyggnadskontoret).
Exempelanrop: api/seterrandfeedback?errandid=1&feedback=Stadsbyggnadskontoret

 

api/listincidents

Listar de ärenden som finns i databasen, tar emot två query-parametrar, offset(hur många poster som ska hoppas över) samt limit(hur många poster som ska skickas), vilket möjliggör paginering. Om ingen parameter anges skickas alla poster, om endast offset anges skickas 100 poster per anrop.

Exempelanrop api/listincidents?offset=5&limit=5
Vilket returnerar 5 poster och hoppar över de 5 första i databasen.
Exempelsvar:

Code Block
languagejson
[
    {
        "ERRAND_ID": 6,
        "Status": 1    },
    {
        "ERRAND_ID": 7,
        "Status": 1    },
    {
        "ERRAND_ID": 8,
        "Status": 1    },
    {
        "ERRAND_ID": 9,
        "Status": 1    },
    {
        "ERRAND_ID": 10,
        "Status": 1
    }
]

 

api/getincident/{id} 

Returnerar ett ärende med angivet ID.

Exempelanrop: api/geterrand/1

Exempelsvar:

displayNameincident_copy
nameincident_copy
pagePin1

Hantering av personuppgifter

För att möjliggöra återkoppling till intressenter så sparas intressentens person-id om det angetts.

API Specifikation

Open api
showCommonExtensionstrue
deepLinkingtrue
supportedSubmitMethodsnone
locationurl
showExtensionstrue
urlhttps://api-test.sundsvall.se/incident/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

joel.lindberg@sundsvall.se

Länkar

<Länkar till dev-portal;

  • Test

  • Sandbox

    https://

    microservices

    sundsvall.

    sundsvall

    atlassian.

    se

    net/

    sandbox

    wiki/

    incident/helloProduktion https://microservices.sundsvall.se/incident/hello

    spaces/API

    Ansvarigt team: Team Unmasked

    För tekniska frågor: teamunmasked@sundsvall.se 

    Källkod

    Github

    FAQ

    <FAQ>