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 kundtjänst (digilogt)MSVA och resterande till kundtjänst på servicecenter.

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

Mer information: Felanmälan

Livscykelstatus

TestProduktion

Lösningsbeskrivning

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

Fält som inte är ifyllda, till exempel att inget telefonnummer har angetts, kommer inte att skickas med.

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

imageAttachmentId	att86442117
macroId	df280ba3-c550-4e27-b653-4c987cfc4001
baseUrl	https://sundsvall.atlassian.net/wiki
name	incident-API
diagramAttachmentId	att88080415
containerId	22315023
timestamp	1613027090720

Hantering av personuppgifter

API Specifikation

Version 1.3

2021-02-15

Ändringar

1.1 Errorreport ändrat till Incident

1.2 statusupdate borttaget och utbytt mot patch-anrop

1.3 Uppdaterat sendincident att använda personId, incidentId är ändrat till en guid, alla properties i JSON-objekt börjar på liten bokstav

POST

api/sendincident

Exempelanrop:

Code Block

language	json

{
    "personId": <Guid>,
    "phoneNumber": "070123456789",
    "email": "test@test.se",
    "contactMethod": "email",
    "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

Obligatoriska fält är category, description och image
Övriga fält kan lämnas tomma eller utelämnas helt.

PATCH

api/{id}/status

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

Code Block

language	json

{
    “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

language	json

{
    “status”: 2
}

GET

api/validstatuses

Listar samtliga giltiga statusar.

Exempelsvar:

Code Block

language	json

[
    {
        "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

language	json

[
    {
        "incidentId": <guid>,
        "status": 1    },
    {
        "incidentId": <guid>,
        "status": 1    },
    {
        "incidentId": <guid>,
        "status": 1    },
    {
        "incidentId": <guid>,
        "status": 1    },
    {
        "incidentId": <guid>,
        "status": 1
    }
]

api/getincident/{id}

Returnerar ett ärende med angivet ID.

Exempelanrop: api/geterrand/00000000-0000-0000-0000-000000000000

Exempelsvar:

Code Block

language	json

{
    "incidentID": <guid>,
    "personID": <guid>,
    "created": "2020-12-10T22:33:07.000Z",
    "phoneNumber": "070123456789",
    "email": "test@test.se",
    "contactMethod": "email",
    "updated": null,
    "category": 6,
    "description": "Någon har kastat tugummi i en park",
    "mapCoordinates": "62.23162,17.27403",
    "fileName": "1ea519cfc1a9752bef04d6cc056bf8eb3cb7.jpg",
    "image": "<Base64>"
}