Skip to content

Systemintegration för ärendehantering

Fastighetssystemet Momentum PM notifierar när ärenden skapas eller ändras genom API-anrop till yttre system. Dessa anrop görs i form av REST/JSON enligt formatet som anges i avsnittet Notifiering (API hos yttre system).

Observera: Notifiering via denna integration görs endast till leverantören som valts specifikt på det aktuella ärendet i PM. Detta är alltså ingen generell notifiering som kan användas för att t ex notifiera ett yttre system om statusändringar för alla ärenden. Integrationen är endast tänkt att notifiera ett yttre system hos en extern leverantör, att just den leverantören har en nytt ärende.

Yttre system kan hämta och ändra information om ärenden. Detta beskrivs i avsnitten Hämta ärenderad och Spara ärenderad. Innan ett yttre system kan hämta eller ändra ett ärende måste systemet vara inloggat. Det är alltså leverantörspersonen som behöver logga in. Vid slutet av en inloggningssession bör det yttre systemet logga ut. För inloggning och utloggning, se avsnitten Logga in och Logga ut.

Exempel på arbetsflöde

  1. Ett ärende skapas i PM5.
  2. Ärendet tilldelas utförare A.
  3. PM5 anropar utförare As externa system för att signalera att ett nytt ärende finns tillgängligt.
  4. Extern part hämtar information via Momentum PM API om ärendet på utförare A.
  5. Utföraren ser ärendet och kan välja rätt processteg i det externa systemet på ärendet.
  6. Utföraren utför ärendet och väljer processteget "utförd".
  7. Handläggaren ser att ärendet är utfört i PM5 och kan fortsätta behandlingen av ärendet i PM5.

Notifiering (API hos yttre system)

POST /[…]

Notifierar att en ärenderad har skapats eller ändrats.

Parametrar

Benämning Typ Exempel Version
ArenderadId Heltal 12345 5.9
ErrandRowId Fritext 960ce59193114d3f8e0ce076f23fe8f4 5.18.3
Organisationsnummer Fritext 512345-1234 5.9
Arenderad URL http://www.domain.com/session/arenderad/ 5.9

Resultat

Se avsnittet Felmeddelande.

Exempel

POST från fastighetssystemet till ett yttre system: 

{
  "ArenderadId": 12345,
  "ErrandRowId": "960ce59193114d3f8e0ce076f23fe8f4",
  "Organisationsnummer": "512345-1234",
  "Arenderad": "http://www.domain.com/session/arenderad/"
}
Resultat returnerat från det yttre systemet: 
{
  "Lyckat": true,
  "Meddelande": "Notifieringsanropet lyckades."
}

Hämta ärenderad

GET /session/arenderad/{ArendeRadId}

Returnerar ärendeinformation.

Parametrar

Benämning Typ Exempel Version
ÄrendeRadId Heltal 12345 5.9

Resultat

Benämning Typ Exempel Version
ÄrendeNummer Fritext R-1501-1000 5.9
Nummer Fritext 2 5.9
Ärendetyp Fritext "Order", "Objektsbeställning" 5.9
Fakturareferens Fritext IB-1408-10000 5.9
Felbeskrivning Fritext "Droppar" 5.9
Åtgärd Fritext "Bytes" 5.9
Avser Fritext "301-001-01/kök/spis/trasig" 5.9
HuvudentitetNummer Fritext "301-001-01" 5.9
ProcesSteg ÄrendeProcessteg (Se ÄrendeProcessteg) 5.9
Adress Adress (Se Adress under V1/Inledning/Generella datastrukturer och datatyper) 5.9
Deltagare Lista med ÄrendeDeltagare (Se ÄrendeRadDeltagare) 5.9
Noteringar Lista med Notering (Se Notering) 5.9
Media Utgått Utgått 5.9
Händelser Lista med Händelser (Se Händelse) 5.9
Specifikation Fritext "Byt spisen" 5.9
### Delresultat (LeverantörÄrendeDeltagare)
Benämning Typ Exempel Version
Visningsnamn Fritext Adam Bertilsson 5.9
ÄrendeRadRollTypBeteckning Fritext "Leverantör", "Handläggare", "Beställare" 5.9
Telefon Fritext 012 – 34 56 78 5.9
Mobil Fritext 0701 – 23 45 67 5.9
Epost Fritext adam.bertilsson@mail.com 5.9

Delresultat (ÄrendeProcessteg)

Benämning Typ Exempel Version
Referensnamn Text "Handlaggare", "Leverantor", "Annullerad" 5.9
Beteckning Text "Hos handläggare", "Hos leverantör", "Annullerad" 5.9

Delresultat (Notering)

Benämning Typ Exempel Version
Notering Text "Ärenderaden har upppdaterats" 5.9
Skapad ISO 8601 2015-04-01 00:00:00 5.9
Fil Utgått Utgått 5.9
SkapadAv Text "Anders Svensson" 5.9

Delresultat (Händelse)

Benämning Typ Exempel Version
Beteckning Fritext "Inväntar Material" 5.9
Referensnamn Fritext "InvantarMaterial" 5.9
Knappbeteckning Fritext "Inväntar Material" 5.9

Spara ärenderad

POST /session/arenderad/{ArendeRadId}

Parametrar

Benämning Typ Exempel Version
Sessionsnyckel Text jCYrQ4tb… 5.9
Kontakt SparaÄrendeKontakt (se delparameter nedan) 5.9
Notering Text "Ärendet har uppdaterats" 5.9
HandelseReferensnamn Text "InvantarMaterial" 5.9

Delparameter (SparaÄrendeKontakt)

Benämning Typ Exempel Version
Visningsnamn Fritext Adam Bertilsson 5.9
Förnamn Fritext 5.9
Efternamn Fritext 5.9
Telefon Fritext 012 – 34 56 78 5.9
Mobil Fritext 0701 – 23 45 67 5.9
Epost Fritext adam.bertilsson@mail.com 5.9

Spara FakturaServiceorder

POST /fakturaserviceorder/spara

Parametrar

Benämning Typ Exempel Version
Ordernummer Text 12345 5.15
Orgnummer Text 5555555555 5.15
LeversntorNamn Text Leverantören AB 5.15
Fakturanummer Text 12345 5.15
Belopp Decimaltal 123,50 5.15
Status Heltal 1 5.15
BetaldDatum ISO 8601 2019-08-30 5.15

Resultat

Benämning Typ Exempel Version
Success Bool 5.15

Hämta FakturaServiceorder

GET /fakturaserviceorder/lista

Returnerar en lista med alla fakturor som matchar parametrarna. Använd tom sträng för att matcha alla. Kan använda SQL LIKE syntax, t.ex. "abc%" för allt som börjar på "abc" följt av 0 eller flera valfria tecken.

Parametrar

Benämning Typ Exempel Version
Ordernummer Text 12345 5.15
Orgnummer Text 5555555555 5.15
LeverantorNamn Text Leverantören AB 5.15
Fakturanummer Text 12345 5.15

Resultat (FakturaServiceorder)

Benämning Typ Exempel Version
Borttagen ISO 8601 2019-08-30 10:11:12 5.15
Skapad ISO 8601 2019-08-30 10:11:12 5.15
ÄrendeFakturaExternStatusTypId Heltal 1 5.15
ÄrendeNummer Text 12345 5.15
Organisationsnummer Text 5555555555 5.15
LeverantörNamn Text Leverantör AB 5.15
ExterntFakturanummer Text 123456 5.15
Belopp Decimaltal 123,50 5.15
BetaldDatum ISO 8601 2019-08-30 5.15
StatusTypBeteckning Text Status typ 1 5.15
StatusTypKortbeteckning Text typ1 5.15
StatusTypHjälptext Text 5.15
ÄrendeBeteckning Text Byte av trasig sak 5.15
OrganisationBeteckning Text Organisationen 5.15
LeverantörNummer Text 12345 5.15