Session
Hämta session
GET /session
Returnerar sessionsobjektet i vilket den inloggade användarens
information finns tillgänglig.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| HämtaKund |
Booleskt värde |
|
|
5.9 |
| HämtaMarknadProfil |
Booleskt värde |
|
|
|
| HämtaKontaktuppgifter |
Booleskt värde |
|
|
5.9 |
| HämtaKundEkonomi |
Booleskt värde |
|
|
5.9 |
| HämtaTillfälligaAdresser |
Booleskt värde |
|
|
5.10 |
| HämtaDokument |
Booleskt värde |
|
|
5.10 |
| HämtaKundEkonomiAviseringar |
Booleskt värde |
|
|
5.9 |
| HämtaÄrende |
Booleskt värde |
|
|
5.9 |
| HämtaKundAviseringarAntMån |
Heltal |
12 |
|
5.10 |
| HämtaÄrendeRader |
Booleskt värde |
|
|
5.9 |
| HämtaTillgängligaObjekt |
Booleskt värde |
|
|
5.9 |
| HämtaUnderhåll |
Booleskt värde |
|
|
5.9 |
| HämtaMätdata |
Booleskt värde |
|
|
5.9 |
| HämtaKundMeddelanden |
Booleskt värde |
|
|
5.9 |
| HämtaÄrendeRaderMediaBytes |
Booleskt värde |
Används för att få med bilder direkt i första anropet. Man kan även använda Hämta Ärenderadfil och fil id. |
|
5.10 |
Resultat (PortalSession)
TillgängligaObjekt avser de objekt den inloggade användaren kan
interagera med, t.ex. göra en felanmälan på.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Kund |
SessionKund |
(se delresultat nedan) |
|
5.9 |
| Ärenden |
Lista av Ärende |
(se delresultat nedan) |
|
5.9 |
| TillgängligaObjekt |
Lista av SessionTillgängligtObjekt |
(se delresultat nedan) |
|
5.9 |
Delresultat (SessionKund)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Ekonomi |
SessionEkonomi |
(se delresultat nedan) |
|
5.9 |
| Kontaktuppgifter |
Lista av SessionKontaktuppgift |
(se delresultat nedan) |
|
5.9 |
| Kundinformation |
Kundinformation |
(se delresultat nedan) |
|
5.9 |
| TillfälligaAdresser |
Lista av SessionTillfälligAdress |
(se delresultat nedan) |
|
5.10 |
| Dokument |
Lista av SessionDokument |
(se delresultat nedan) |
|
5.10 |
| Skapad |
ISO 8601 |
1997-07-16T19:20:30+01:00) |
|
|
| MarknadAktörInkomst |
Typ |
*(se delresultat nedan) |
|
|
| MarknadAktörUtbildning |
Typ |
(se delresultat nedan) |
|
|
| MarknadAktörBoende |
Typ |
(se delresultat nedan) |
|
|
| MarknadAktörHushåll |
Typ |
(se delresultat nedan) |
|
|
| MarknadIntresse |
Typ |
(se delresultat nedan) |
|
|
| MaknadEkonomi |
|
|
|
|
| MarknadAktörInkomstId |
Heltal |
123456 |
|
|
| Skapad |
ISO 8601 |
2019-01-01 |
|
|
| Arbetsgivare |
Text |
Momentum Software |
|
|
| Kontaktperson |
Text |
Nils Hult |
|
|
| Telefonnummer |
Text |
076-999999 |
|
|
| InkomstSedan |
ISO 8601 |
2019-01-01 |
|
|
| MånadsinkomstNetto |
|
|
|
|
| MarknadAktörInkomstTyp |
Typ |
*(se delresultat nedan) |
|
|
| SystemName |
Text |
Forsorjningsstod |
|
|
| Beteckning |
Försörjningsstöd |
Försörjningsstöd |
|
|
| MarknadAktörInkomstTypGrupp |
Typ |
*(se delresultat nedan) |
|
|
| SystemName |
Text |
forsakringskassa |
|
|
| Beteckning |
Text |
Försäkringskassa |
|
|
| MarknadAktörUtbildningId |
Heltal |
123456 |
|
|
| Lärosäte |
Text |
Lunds Universitet |
|
|
| Ort |
Text |
Helsingborg |
|
|
| Kontaktperson |
Text |
Nils Hult |
|
|
| Telefonnummer |
Text |
040-999999 |
|
|
| Fom |
ISO 8601 |
1965-12-01 |
|
|
| Tom |
ISO 8601 |
2010-01-01 |
|
|
| MarknadAktörUtbildningTyp |
Typ |
*(se delresultat nedan) |
|
|
| SystemName |
Text |
hogskola |
|
|
| Beteckning |
Text |
Högskola |
|
|
| Namn |
Text |
Stena Fastigheter AB |
|
|
| Kontaktperson |
Text |
Nils Hult |
|
|
| Telefonnummer |
Text |
040-999999 |
|
|
| MarknadAktörBoendeTyp |
Typ |
*(se delresultat nedan) |
|
|
| SystemName |
Text |
hyresratt |
|
|
| Beteckning |
Text |
Hyresrätt |
|
|
| AntalVuxna |
Heltal |
2 |
|
|
| AntalBarn |
Heltal |
0 |
|
|
Delresultat (SessionKundInfomation)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Förnamn |
Fritext |
Kalle |
PM5 Fastighet |
5.9 |
| Efternamn |
Fritext |
Andersson |
PM5 Fastighet |
5.9 |
| Personnummer |
Fritext |
Format då svenskt personnr är satt: YYYYMMDDnnnn. Annars: YYYYMMDD. |
PM5 Fastighet |
5.9 |
| Kundnummer |
Fritext |
15555 |
PM5 Fastighet |
5.9 |
Delresultat (SessionKontaktuppgift)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Värde |
Text |
"Test@testsson.com" |
PM5 Fastighet |
5.9 |
| Validerad |
Booleskt värde |
True |
PM5 Fastighet |
5.9 |
| KontaktuppgiftsTyp |
KontaktuppgiftsTyp |
Se KontaktuppgiftsTyp |
PM5 Fastighet |
5.9 |
Delresultat (SessionTillfälligAdress)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| AdressId |
Heltal |
3617390 |
PM5 Fastighet |
5.10 |
| Fom |
ISO 8601 |
2016-11-01 |
PM5 Fastighet |
5.10 |
| Tom |
ISO 8601 |
2016-11-30 |
PM5 Fastighet |
5.10 |
| Gatuadress1 |
Text |
Testvägen 1 |
PM5 Fastighet |
5.10 |
| Gatuadress2 |
Text |
Testvägen |
PM5 Fastighet |
5.10 |
| Attention |
Text |
Test Testarsson |
PM5 Fastighet |
5.10 |
| Namn |
Text |
Test Kalle |
PM5 Fastighet |
5.10 |
| CareOf |
Text |
Test Nisse |
PM5 Fastighet |
5.10 |
| Postnummer |
Text |
80426 |
PM5 Fastighet |
5.10 |
| Postort |
Text |
Gävle |
PM5 Fastighet |
5.10 |
| Land |
Text |
Sverige |
PM5 Fastighet |
5.10 |
| LandReferensnamn |
Text |
SE |
PM5 Fastighet |
5.10 |
Delresultat (SessionDokument)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| AvtalVersionId |
Heltal |
12345 |
PM5 Fastighet |
5.10 |
| ObjektTyp |
Fritext |
Lägenhet |
PM5 Fastighet |
5.11 |
| ObjektAdress |
Fritext |
Storgatan 16 |
PM5 Fastighet |
5.11 |
| EntitetFilTypId |
Heltal |
12345 |
PM5 Fastighet |
5.10 |
| EntitetFilTypOrdning |
Heltal |
50 |
PM5 Fastighet |
5.10 |
| EntitetFilTypBeteckning |
Fritext |
Tvättstuga |
PM5 Fastighet |
5.10 |
| Filändelse |
Fritext |
.PDF |
PM5 Fastighet |
5.10 |
| EntitetFilId |
Heltal |
12345 |
PM5 Fastighet |
5.10 |
| EntitetFilOrdning |
Heltal |
50 |
PM5 Fastighet |
5.10 |
| Beteckning |
Fritext |
Tvättmaskin 1 |
PM5 Fastighet |
5.10 |
| FilUrl |
Fritext |
http://server/session/kund/dokument/12345 |
PM5 Fastighet |
5.10 |
| Webbadress |
Fritext |
http://www.exempel.com/Bruksanvisning.html |
PM5 Fastighet |
5.10 |
| Meddelande |
Fritext |
Bruksanvisning för tvättmaskin 1. |
PM5 Fastighet |
5.10 |
Delresultat (SessionEkonomi)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Hyressaldo |
Decimaltal |
7900 |
PM5 Fastighet |
5.9 |
| Fakturasaldo |
Decimaltal |
490 |
PM5 Fastighet |
5.9 |
| Aviseringar |
Lista av SessionAvisering |
(se delresultat nedan) |
|
5.9 |
Delresultat (NotifieringMeddelandeKanal)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| KanalTyp |
NotifieringKanalTyp |
(se delresultat nedan) |
PM5 Fastighet |
? (Nya mina sidor) |
| Notifierad |
Bool |
true |
PM5 Fastighet |
? (Nya mina sidor) |
| KlarUtc |
DataTime? |
2020-02-26 09:34:09.477 |
PM5 Fastighet |
? (Nya mina sidor) |
| ÖvergivenUtc |
DataTime? |
2020-02-26 09:29:52.557 |
PM5 Fastighet |
? (Nya mina sidor) |
| Ämne |
String |
Ny test av Utsida nyhet. |
PM5 Fastighet |
? (Nya mina sidor) |
| Brödtext |
String |
Hej Min, Ny test av Utsida nyhet. Med vänliga hälsningar Mitt Bolag AB, telefon |
PM5 Fastighet |
? (Nya mina sidor) |
Delresultat (NotifieringKanalTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| SystemName |
String |
Nyhet |
PM5 Fastighet |
? (Nya mina sidor) |
| Beteckning |
String |
Utsida nyhet |
PM5 Fastighet |
? (Nya mina sidor) |
| Hjälptext |
String |
"Denna är en förklaranade text för Kanaltypen Nyhet" |
PM5 Fastighet |
? (Nya mina sidor) |
Delresultat (NotifieringBilaga)
Null retuneras om inga bilagor finns.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| MeddelandeUtgåendeBilagaId |
Heltal |
12345 |
PM5 Fastighet |
5.? |
| MeddelandeUtgåendeId |
Heltal |
54321 |
PM5 Fastighet |
5.? |
| ExterntId |
Heltal |
12345 |
PM5 Fastighet |
5.? |
| ExterntNamn |
Text |
Bilaga1.jpg |
PM5 Fastighet |
5.? |
Delresultat (SessionAvisering)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Avinummer |
Text |
9213210 |
PM5 Fastighet |
5.9 |
| Typ |
SessionAviseringTyp |
(se delresultat nedan) |
|
5.9 |
| Betalningsreferens |
Text |
183786180 (OCR-nummer) |
PM5 Fastighet |
5.9 |
| MottagareNummer |
Text |
123456 |
PM5 Fastighet |
5.9 |
| BetalningsförmedlareSystemnamn |
Text |
BG |
PM5 Fastighet |
5.9 |
| BetalningsförmedlareBeteckning |
Text |
Bankgiro |
PM5 Fastighet |
5.9 |
| Förfallodag |
ISO 8601 |
2014-08-31 |
PM5 Fastighet |
5.9 |
| Nettobelopp |
Decimaltal |
7900 |
PM5 Fastighet |
5.9 |
| Momsbelopp |
Decimaltal |
0 |
PM5 Fastighet |
5.9 |
| Bruttobelopp |
Decimaltal |
7900 |
PM5 Fastighet |
5.9 |
| InbetaltBelopp |
Decimaltal |
6000 |
PM5 Fastighet |
5.9 |
| Restbelopp |
Decimaltal |
1900 |
PM5 Fastighet |
5.9 |
| BetalningFördeladBelopp |
Decimaltal |
120 |
PM5 Fastighet |
5.10 |
| AttBetala |
Decimaltal |
2560 |
PM5 Fastighet |
5.10 |
| DistribueradTill |
Lista av SessionAviseringDistribution |
(se delresultat nedan) |
|
5.9 |
| Reskontror |
Lista av SessionReskontra |
(se delresultat nedan) |
|
5.9 |
| Betalningar |
Lista av SessionBetalning |
(se delresultat nedan) |
|
5.9 |
Delresultat (SessionAviseringTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| AviseringId |
Heltal |
21563 |
PM5 Fastighet |
5.9 |
| Referensnamn |
Text |
Faktura |
PM5 Fastighet |
5.9 |
| Beteckning |
Text |
F |
PM5 Fastighet |
5.9 |
Delresultat (SessionAviseringDistrubution)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Typ |
Text |
"brev.direkt", "epost" |
|
5.9 |
| Adress |
Fritext |
"Anna Andersson Gatuvägen 23 B vån 3 123 45 Staden", "anna.andersson@mail.com" |
PM5 Fastighet |
5.9 |
| Distribuerad |
ISO 8601 |
2014-08-15 13:00 |
PM5 Fastighet |
5.9 |
Delresultat (SessionReskontra)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Period |
Text |
2014-09 |
PM5 Fastighet |
5.9 |
| Förfallodag |
ISO 8601 |
2014-08-31 |
PM5 Fastighet |
5.9 |
| Nettobelopp |
Decimaltal |
6500 |
PM5 Fastighet |
5.9 |
| Momsbelopp |
Decimaltal |
0 |
PM5 Fastighet |
5.9 |
| Bruttobelopp |
Decimaltal |
6500 |
PM5 Fastighet |
5.9 |
| SkickadTillInkasso |
ISO 8601 |
2014-01-01 är null om reskontran inte är skickad till inkasso. |
PM5 Fastighet |
5.9 |
| Hyresobjekt |
Hyresobjekt |
(se Hyresobjekt) |
|
5.9 |
| Rader |
Lista av SessionReskontraRad |
(se delresultat nedan) |
|
5.9 |
Delresultat (SessionReskontraRad)
Specifikation kan returneras null om innehållet inte är relevant,
såsom i fallet med "Grundhyra".
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Aviseringstext |
Text |
"Grundhyra", "Varmvatten" |
PM5 Fastighet |
5.9 |
| Nettobelopp |
Decimaltal |
6500 |
PM5 Fastighet |
5.9 |
| Momsbelopp |
Decimaltal |
0 |
PM5 Fastighet |
5.9 |
| Bruttobelopp |
Decimaltal |
6500 |
PM5 Fastighet |
5.9 |
| Specifikation |
SessionReskontraRadSpecifikation |
(se delresultat nedan) |
|
5.9 |
Delresultat (SessionReskontraRadSpecifikation)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| AvserFom |
ISO 8601 |
2014-07-01 |
PM5 Fastighet |
5.9 |
| AvserTom |
ISO 8601 |
2014-07-31 |
PM5 Fastighet |
5.9 |
| KällaBeteckning |
Text |
Kök |
PM5 Fastighet |
5.9 |
| KällaIdentitet |
Text |
432105 |
PM5 Fastighet |
5.9 |
| VärdeFom |
Decimaltal |
13,432 |
PM5 Fastighet |
5.9 |
| VärdeTom |
Decimaltal |
14,532 |
PM5 Fastighet |
5.9 |
| Mängd |
Decimaltal |
1,100 |
PM5 Fastighet |
5.9 |
| Mängdenhet |
Text |
m³ |
PM5 Fastighet |
5.9 |
| Apris |
Decimaltal |
48 |
PM5 Fastighet |
5.9 |
| DebiteringsfriTom |
ISO 8601 |
2014-04-30 |
PM5 Fastighet |
5.9 |
| DebiteringsfrittNettobelopp |
Decimaltal |
53 |
PM5 Fastighet |
5.9 |
| DebiteringsfrittMomsbelopp |
Decimaltal |
0 |
PM5 Fastighet |
5.9 |
| DebiteringsfrittTotalbelopp |
Decimaltal |
53 |
PM5 Fastighet |
5.9 |
Delresultat (SessionBetalning)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Betalväg |
Text |
Manuell inbetalning via bankgiro |
PM5 Fastighet |
5.9 |
| Belopp |
Decimaltal |
6000 |
PM5 Fastighet |
5.9 |
| Betalningsdag |
ISO 8601 |
2014-08-28 |
PM5 Fastighet |
5.9 |
| Bokföringsdag |
ISO 8601 |
ISO 8601 |
PM5 Fastighet |
5.10 |
Delresultat (Ärende)
Avser, Adress och Processteg är alltid null, förutom vid
besiktningar. Observera att för Allmänna ärenden returneras endast
Ärendenummer, Ärendetyp, Kontaktperson Beskrivning, Status
(Proces.AktivitetSteg.ProcessDefinitionSteg), Tidpunkter och
SkapatDatum.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Id |
Heltal |
|
PM5 Fastighet |
5.9 |
| Nummer |
Fritext |
R-1501-1000 |
PM5 Fastighet |
5.9 |
| Typ |
Text |
"Order", "Underhåll" |
PM5 Fastighet |
5.9 |
| TypReferensNamn |
Text |
"Order", "Underhall" |
PM5 Fastighet |
5.9 |
| Avser |
Lista av ÄrendeNodstigdel |
(se delresultat nedan) |
|
5.9 |
| Adress |
Adress |
(Se Adress under V1/Inledning/Generella datastrukturer och datatyper) |
|
5.9 |
| Kontakter |
Lista av ÄrendeDeltagare |
(se delresultat nedan) |
|
5.9 |
| Rader |
Lista av ÄrendeRad |
(se delresultat nedan) |
|
5.9 |
| Processteg |
ÄrendeProcessteg |
(se delresultat nedan) |
|
5.9 |
| Handläggare |
Lista av ÄrendeDeltagare |
(se delresultat nedan) |
|
5.9 |
| Händelser |
ÄrendeHändelser |
(se delresultat nedan) |
|
5.9 |
| UnderhållsErbjudande |
ÄrendeUnderhållsErbjudande |
(se delresultat nedan) |
|
5.9 |
Delresultat (ÄrendeUnderhållsErbjudande)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ErbjudandeEkonomiSerieSvarSenast |
ISO 8601 |
2016-08-22 |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeNodstigdel)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Id |
Text |
n165492 |
PM5 Fastighet |
5.9 |
| Typ |
Enum |
"Nod", "Nodklass", "Detalj" |
PM5 Fastighet |
5.9 |
| Visningstext |
Fritext |
"Tvättstuga", "302-074-01" |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeDeltagare)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Visningsnamn |
Fritext |
Adam Bertilsson |
PM5 Fastighet |
5.9 |
| Telefon |
Fritext |
012 – 34 56 78 |
PM5 Fastighet |
5.9 |
| Mobil |
Fritext |
0701 – 23 45 67 |
PM5 Fastighet |
5.9 |
| Epost |
Fritext |
adam.bertilsson@mail.com |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeHändelser)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ÄrendeInkommen |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| ÄrendeKlarSenast |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| ÄrendeAvslutat |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| Borttagen |
Booleskt värde |
|
PM5 Fastighet |
5.9 |
| ÄrendePlaneradKlar |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| ÄrendePlaneradStart |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeRad)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Id |
Heltal |
|
|
5.9 |
| Avser |
ÄrendeNodstigdel |
(se delresultat nedan) |
|
5.9 |
| Adress |
Adress |
(se Adress under V1/Inledning/Generella datastrukturer och datatyper) |
|
5.9 |
| Status |
ÄrendeStatus |
(se delresultat nedan) |
|
5.9 |
| Processteg |
ÄrendeProcessteg |
(se delresultat nedan) |
|
5.9 |
| Huvudentitet |
Text |
|
|
5.9 |
| HuvudentitetNodKlassBeteckning |
Text |
Lägenhet |
|
5.9 |
| Nodstig |
Lista av ÄrendeNodstigdel |
(se delresultat nedan) |
|
5.9 |
| Handläggare |
Lista av ÄrendeDeltagare |
(se ÄrendeDeltagare) |
|
5.9 |
| Historik |
Lista av ÄrendeHistorik |
(se ÄrendeHistorik) |
|
5.9 |
| Åtgärd |
ÄrendeRadÅtgärd |
(se ÄrendeRadÅtgärd) |
|
5.9 |
| Media |
Lista av ÄrendeRadMedia |
(Se ÄrendeRadMedia) |
|
5.10 |
| PrisModell |
ÄrendeRadNodKlassPrisModell |
(se ÄrendeRadNodKlassPrisModell) |
|
5.9 |
| Tidpunkter |
Lista av ÄrendeRadÄrendeTidpunkt |
(se ÄrendeRadÄrendeTidpunkt) |
|
5.12 |
| Beskrivning |
ÄrendeRadBeskrivning |
(se ÄrendeRadBeskrivning) |
|
5.12 |
Delresultat (ÄrendeRadÅtgärd)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Beställd |
ISO 8601 |
2016-08-22 |
PM5 Fastighet |
5.9 |
| Utförd |
ISO 8601 |
2016-03-03 |
PM5 Fastighet |
5.9 |
| ÅtgärdNod |
ÅrendeRadÅtgärdNod |
|
PM5 Fastighet |
5.9 |
| ÅtgärdNodKlass |
ÄrendeRadÅtgärdNodKlassÅtgärd |
|
PM5 Fastighet |
5.9 |
| ÅtgärdNodKlassTyp |
ÄrendeRadÅtgärdNodKlassÅtgärdTyp |
|
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeRadÅtgärdNod)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Accepterad |
ISO 8601 |
2016-08-22 |
PM5 Fastighet |
5.9 |
| Planerad |
ISO 8601 |
2016-03-03 15:00:00 |
PM5 Fastighet |
5.9 |
| Skapad |
ISO 8601 |
2016-08-22 |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeRadÅtgärdNodKlassÅtgärd)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| IntervallEnhet |
Heltal |
10,20,30 |
PM5 Fastighet |
5.9 |
| IntervallEnhet |
TidEnhet |
(se TidEnhet) |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeRadÅtgärdNodKlassÅtgärdTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Beteckning |
Text |
Målas |
PM5 Fastighet |
5.9 |
| KortBeteckning |
Text |
Malas |
PM5 Fastighet |
5.9 |
Delresultat (TidEnhet)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ReferensNamn |
Text |
timme, minut, ar |
PM5 Fastighet |
5.9 |
| Beteckning |
Text |
Timme, minut, år |
PM5 Fastighet |
5.9 |
| BeteckningPlural |
Text |
Timmar, minuter, år |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeRadNodKlassPrisModell)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| RestVärde |
Decimaltal |
122,22, -122,22 |
PM5 Fastighet |
5.9 |
| Rabatt |
Decimaltal |
122,22 |
PM5 Fastighet |
5.9 |
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Media |
Byte[] |
|
PM5 Fastighet |
5.10 |
| Id |
Heltal |
Id för media som kan hämtas med |
PM5 Fastighet |
5.10 |
Delresultat (ÄrendeHistorik)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Beteckning |
Fritext |
"Hos handläggare" |
PM5 Fastighet |
5.9 |
| Tidpunkt |
ISO 8601 |
2016-03-03 15:00:00 |
PM5 Fastighet |
5.9 |
| Användare |
Fritext |
Kalle svensson |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeStatus)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Referensnamn |
Text |
"Pagaende", "Vilande", "Vantar" |
PM5 Fastighet |
5.9 |
| Beteckning |
Text |
"Pågående", "Vilande", "Väntar på användaren" |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeProcessteg)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Referensnamn |
Text |
"Handlaggare", "Leverantor", "Annullerad" |
PM5 Fastighet |
5.9 |
| Beteckning |
Text |
"Hos handläggare", "Hos leverantör", "Annullerad" |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeRadÄrendeTidpunkt)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ÄrendeRadId |
Heltal |
|
PM5 Fastighet |
5.12 |
| ÄrendeRadTidpunktId |
Heltal |
|
PM5 Fastighet |
5.12 |
| Värde |
ISO 8601 |
2016-03-03 15:00:00 |
PM5 Fastighet |
5.12 |
| ÄrendeRadTidpunktTypId |
Heltal |
|
PM5 Fastighet |
5.12 |
| ÄrendeRadTidpunktTypSystemName |
String |
"Intraffat" |
PM5 Fastighet |
5.12 |
| ÄrendeRadTidpunktTybBeteckning |
String |
"Inträffat" |
PM5 Fastighet |
5.12 |
Delresultat (ÄrendeRadBeskrivning)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ÄrendeRadId |
Heltal |
|
PM5 Fastighet |
5.12 |
| ÄrendeKlassificeringTypId |
Heltal |
|
PM5 Fastighet |
5.12 |
| ÄrendeKlassificeringSystemName |
String |
"Allvarligt" |
PM5 Fastighet |
5.12 |
| ÄrendeKlassificeringBeteckning |
String |
"Allvarligt" |
PM5 Fastighet |
5.12 |
Delresultat (ÄrendeRadHändelser)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ÄrendeRadAvslutat |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| ÄrendeRadInkommen |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| ÄrendeAvslutat |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| Borttagen |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| ÄrendeRadKlarSenast |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
| ÄrendeRadPlaneradKlar |
ISO 8601 |
|
PM5 Fastighet |
5.9 |
Delresultat (SessionTillgängligtObjekt)
Användning styr hur objektet kan användas i portalen. Användning
"Felanmälan" berättar således att objektet kan felanmälas.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Typ |
Text |
"Bostad", "Tvattstuga" |
PM5 Fastighet |
5.9 |
| Typbeteckning |
Text |
"Bostad", "Tvättstuga" |
PM5 Fastighet |
5.9 |
| ObjektTypBeteckning |
Text |
"Lägenhet", "Studentbostad" |
PM5 Fastighet |
5.10 |
| Nummer |
Text |
142-043-01 |
PM5 Fastighet |
5.9 |
| Användning |
Lista av AnvändningTyp |
(se delresultat nedan) |
PM5 Fastighet |
5.9 |
| Entitet |
ÄrendeNodstigdel |
(se delresultat ÄrendeNodstigdel) |
PM5 Fastighet |
5.9 |
| Adress |
Adress |
(se Adress under V1/Inledning/Generella datastrukturer och datatyper) |
PM5 Fastighet |
5.9 |
| ÄrendeRader |
ÄrendeRad |
(se ÄrendeRad) |
PM5 Fastighet |
5.10 |
| Underhåll |
SessionUnderhåll |
(se SessionUnderhåll) |
PM5 Fastighet |
5.9 |
| MätdataAnläggningar |
Lista av SessionMätdataAnläggningar |
(se SessionMätdataAnläggning) |
PM5 Fastighet |
5.9 |
Delresultat (AnvändningTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Referensnamn |
Text |
Felanmälan |
PM5 Fastighet |
5.9 |
Delresultat (SessionUnderhåll)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Åtgärd |
Text |
Bytes |
PM5 Fastighet |
5.9 |
| Planeratdatum |
ISO 8601 |
2014-09-01 |
PM5 Fastighet |
5.9 |
| Avser |
Text |
Badrum 1 / Handukstork |
PM5 Fastighet |
5.9 |
| Utförd |
ISO 8601 |
2014-09-01 |
PM5 Fastighet |
5.9 |
| Beställd |
ISO 8601 |
2014-09-24 |
PM5 Fastighet |
5.9 |
Delresultat (SessionMätdataAnläggning)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Användning |
Text |
Vatten |
PM5 Fastighet |
5.9 |
| Mätare |
Lista av SessionMätare |
|
PM5 Fastighet |
5.9 |
| Beteckning? |
Text |
705-079-01 Vatten |
PM5 Fastighet |
5.9 |
Delresultat (SessionMätare)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Användning |
Text |
Varmvatten |
PM5 Fastighet |
5.9 |
| Mätdata |
Lista av SessionMätdata |
|
PM5 Fastighet |
5.9 |
| Beteckning ??? |
Text |
|
PM5 Fastighet |
5.9 |
Delresultat (SessionMätdata)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Förbrukning |
Decimaltal |
5000 |
PM5 Fastighet |
5.9 |
| Mätarställning |
Decimaltal |
5000 |
PM5 Fastighet |
5.9 |
| Enhet |
Text |
m³ |
PM5 Fastighet |
5.9 |
| T o m |
ISO 8601 |
2014-09-24 |
PM5 Fastighet |
5.9 |
| Datum |
ISO 8601 |
2014-09-24 |
PM5 Fastighet |
5.9 |
| Kostnad |
Decimaltal |
6000 |
PM5 Fastighet |
5.9 |
| Debiterad |
bool |
true |
PM5 Fastighet |
5.9 |
| AvlästTid |
ISO 8601 |
2014-09-24 |
PM5 Fastighet |
5.9 |
| Pris |
Decimaltal |
85 |
PM5 Fastighet |
5.14 |
| Apris |
Decimaltal |
0,85 |
PM5 Fastighet |
5.14 |
| DebiterasTidigast |
ISO 8601 |
2019-04-01 |
PM5 Fastighet |
5.14 |
Delresultat (SessionMarknadProfil)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Skapad |
ISO 8601 |
1997-07-16T19:20:30+01:00) |
|
|
| MarknadAktörInkomst |
Typ |
(se delresultat nedan) |
|
|
| MarknadAktörUtbildning |
Typ |
(se delresultat nedan) |
|
|
| MarknadAktörBoende |
Typ |
(se delresultat nedan) |
|
|
| MarknadAktörHushåll |
Typ |
(se delresultat nedan) |
|
|
| MarknadIntresse |
Typ |
(se delresultat nedan) |
|
|
| MarknadEkonomi |
Typ |
(se delresultat nedan) |
|
|
Delresultat (MarknadAktörInkomst)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| MarknadAktörInkomstId |
Heltal |
123456 |
|
|
| Skapad |
ISO 8601 |
2019-01-01 |
|
|
| Arbetsgivare |
Text |
Momentum Software |
|
|
| Kontaktperson |
Text |
Nils Hult |
|
|
| Telefonnummer |
Text |
076-999999 |
|
|
| InkomstSedan |
ISO 8601 |
2019-01-01 |
|
|
| MånadsinkomstNetto |
Decimaltal |
|
|
|
| MarknadAktörInkomstTyp |
Typ |
*(se delresultat nedan) |
|
|
Delresultat (MarknadAktörInkomstTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| SystemName |
Text |
Forsorjningsstod |
|
|
| Beteckning |
Försörjningsstöd |
Försörjningsstöd |
|
|
| MarknadAktörInkomstTypGrupp |
Typ |
*(se delresultat nedan) |
|
|
Delresultat (MarknadAktörInkomstTypGrupp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| SystemName |
Text |
forsakringskassa |
|
|
| Beteckning |
Text |
Försäkringskassa |
|
|
Delresultat (MarknadAktörUtbildning)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| MarknadAktörUtbildningId |
Heltal |
123456 |
|
|
| Lärosäte |
Text |
Lunds Universitet |
|
|
| Ort |
Text |
Helsingborg |
|
|
| Kontaktperson |
Text |
Nils Hult |
|
|
| Telefonnummer |
Text |
040-999999 |
|
|
| Fom |
ISO 8601 |
1965-12-01 |
|
|
| Tom |
ISO 8601 |
2010-01-01 |
|
|
| MarknadAktörUtbildningTyp |
Typ |
*(se delresultat nedan) |
|
|
Delresultat (MarknadAktörUtbildningTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| SystemName |
Text |
hogskola |
|
|
| Beteckning |
Text |
Högskola |
|
|
Delresultat (MarknadAktörBoende)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Namn |
Text |
Stena Fastigheter AB |
|
|
| Kontaktperson |
Text |
Nils Hult |
|
|
| Telefonnummer |
Text |
040-999999 |
|
|
| MarknadAktörBoendeTyp |
Typ |
*(se delresultat nedan) |
|
|
Delresultat (MarknadAktörBoendeTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| SystemName |
Text |
hyresratt |
|
|
| Beteckning |
Text |
Hyresrätt |
|
|
Delresultat (MarknadAktörHushåll)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| AntalVuxna |
Heltal |
2 |
|
|
| AntalBarn |
Heltal |
0 |
|
|
Delresultat (MarknadIntresse)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| MarknadIntresseId |
Heltal |
123456 |
|
|
| Skapad |
ISO 8601 |
1997-07-16T19:20:30+01:00) |
|
|
| Nummer |
Text |
339-026-01 |
|
|
Delresultat (MarknadEkonomi)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Borgensman |
Booleskt |
true |
|
|
| Deposition |
Booleskt |
true |
|
|
| Kapital |
Booleskt |
true |
|
|
Hämta en bilaga som tillhör ett meddelande
GET /session/notifieringBilagaFil/{MeddelandeId}/{ExterntId}
Parameter
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.? |
| MeddelandeUtgåendeId |
Heltal |
54321 |
PM5 Fastighet |
5.? |
| ExterntId |
Heltal |
12345 |
PM5 Fastighet |
5.? |
Resultat (NotifieringBilagaFil)
Funktionen returnera Klassen NotifieringBilagaFil som innehålla filens
mimtyp, extention och filens bytes i en byte array (Data byte[]).
| Benämning |
Typ |
Exempel |
Källa |
Version |
| MimeTyp |
Text |
image/jpeg |
PM5 Fastighet |
5.? |
| Extension |
Text |
.jpeg |
PM5 Fastighet |
5.? |
| Data |
byte[] |
|
PM5 Fastighet |
5.? |
Hämta utskrift
GET /session/kund/ekonomi/avisering/{AviseringId}
Returnerar SessionAvisering i pdf-format, avi eller faktura.
Parameter
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| AviseringId |
Heltal |
10020030 |
PM5 Fastighet |
5.9 |
Resultat
Pdf:en som bytes.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Avi/faktura |
Byte[] |
|
Reporting |
5.9 |
Hämta noder under ett objekt
GET /session/arende/typ/{ArendeTyp}/{AnvandningaTyp}/{Id}
Returnerar en lista av listor som innehåller de underliggande objekten
för varje steg i Id-strängen. Det här anropet skall göras för varje
del i nodstigen (Id-strängen byggs på med ett bindestreck för varje
nod) och listan av listor byggs på för varje anrop. Sista listan är
den i Id-strängens sista nods underliggande objekt.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| ArendeTyp |
Text |
"Order", "Besiktning" |
PM5 Fastighet |
5.9 |
| Id |
Text |
n30212-n512431 |
PM5 Fastighet |
5.9 |
| Anvandningstyp |
AnvändningTyp |
Text |
|
5.9 |
| HämtaAvser |
Booleskt värde |
|
|
5.9 |
| HämtaFelbeskrivningstyper |
Booleskt värde |
|
|
5.9 |
| HämtaNyckelhanteringstyper |
Booleskt värde |
|
|
5.9 |
Resultat (ÄrendeAvserVäljareInställningar)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Avser |
Dubbelarray av ÄrendeNodstigdel |
|
|
5.9 |
| Felbeskrivningstyper |
Lista av ÄrendeFelbskrivningTyp |
|
|
5.9 |
| Nyckelhanteringstyper |
Lista av ÄrendeNyckelhanteringTyp |
|
|
5.9 |
Delresultat (ÄrendeFelbeskrivningTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| FelbeskrivningId |
Heltal |
2 |
PM5 Fastighet |
5.9 |
| Beteckning |
Text |
"Droppar", "Rinner", "Läcker" |
PM5 Fastighet |
5.9 |
Delresultat (ÄrendeNyckelhanteringTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| NyckelhanteringId |
Heltal |
2 |
PM5 Fastighet |
5.9 |
| Beteckning |
Text |
"Är hemma", "Lämnas på kontoret" |
PM5 Fastighet |
5.9 |
Exempel
Nedan följer ett exempel för att förtydliga hur den sammanslagna nodsträngen skapas.
GET /session/jCYrQ4tb(...) -> { "Kund" : {…}, " TillgängligaObjekt" : [ { "Användning" : {…}, "Nod" : { "Avser" : "n245612", "Typ" : "Nod", "Visningstext" : "Lägenhet" } }, {…} ] }
Med ett tillgängligt objekt går det att hämta hierarkiskt
underliggande objekt.
GET /session/jCYrQ4tb(...)/arende/typ/order/felanmälan/n245612 -> [ [ { "Avser" : "n512431", "Visningstext" : "Kök", "Typ" : "Nod" }, {…} ] ]
Sökvägen byggs vidare, åtskilt av ett bindestreck, "-", och det är
nödvändigt att för varje steg inkludera tidigare noder.
GET /session/jCYrQ4tb(...)/arende/typ/order/felanmälan/n245612-n512431 -> [ […], [ { "Avser" : "n188452", " Visningstext" : "Kyl/Frys", "Typ" : "Nod" }, {…} ] ]
GET /session/jCYrQ4tb(...)/arende/typ/order/felanmälan/n245612-n512431-n188452 -> [ […], […], [ { "Avser" : "n422831", " Visningstext" : "Frys - Standard", "Typ" : "Nod" }, {…} ] ]
Nodsträngen för att felanmäla frysen blir således:
n245612-n512431-n188452-n422831.
Skapa felanmälan
POST /session/arende/
Skapar en felanmälan i systemet, där Avser är den sammanslagna
nodsträngen. Anropet returnerar ett ÄrendeId för det nyligen skapta
ärendet.
Parametrar
Anges Kontakt läggs en ny Aktör upp i systemet, är Kontakt null blir
Kund Kontaktperson. Avser är huvudnoden, tex objektet som ska
felanmälas.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| Avser |
Text |
"n245612" |
|
5.9 |
| Ärendetyp |
Text |
"Felanmälan" |
PM5 Fastighet |
5.9 |
| Användningstyp |
AnvändningTyp |
(se AnvändningTyp) |
|
5.9 |
| Kontakt |
SparaÄrendeKontakt |
(se argument nedan) |
|
5.9 |
| Husdjur |
Fritext |
Stor hund |
|
5.9 |
| ÄrendeKällaSystemnamn |
Fritext |
MinaSidor,Internt,Korning, Externt |
PM5 fastighet(ÄrendeKällaTyp) |
5.9 |
| Rader |
Lista av SparaÄrendeRad |
(se argument nedan) |
|
5.9 |
Argument (SparaÄrendeKontakt)
| Benämning |
Typ |
Exempel |
Källa |
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 |
Argument (SparaÄrendeRad)
Om Husdjur inte finns i lägenheten ska Husdjur sättas till
null. Rekommendation är att Husdjur är ett aktivt val i gränssnittet,
ja/nej, följt av en förklarande textruta.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Avser |
Text |
n30212-n131564-nk1234 |
|
5.9 |
| Beskrivning |
Fritext |
Repareras |
PM5 Fastighet |
5.9 |
| NyckelhanteringId |
Heltal, lista med val från API |
2 |
PM5 Fastighet |
5.9 |
| Nyckelhanteringsnotering |
Fritext |
Hemma mellan 10:00 och 13:00 |
|
5.9 |
| FelbeskrivningstypId |
Heltal, lista med val från API |
12 |
PM5 Fastighet |
5.9 |
| Specifikation |
Text |
Stopp i avlopp |
PM5 Fastighet |
5.9 |
| Media |
Se SparaÄrendeRadMedia |
|
PM5 fastighet |
5.10 |
| Benämning |
Typ |
Exempel |
Källa |
Version |
| MediaByte |
Byte[] |
|
|
5.10 |
| Notering |
Text |
En notering till bilden |
|
5.10 |
Resultat (SkapaFelanmälanResultat)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ÄrendeId |
Heltal |
516849 |
PM5 Fastighet |
5.9 |
Hämta ett ärende
GET /session/arende/{ÄrendeId}
GET /arende/{Delningsnyckel}
Hämtar ett ärende med det angivna ärende-id:t, eller en
delningsnyckel.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| ÄrendeId |
Heltal |
516849 |
PM5 Fastighet |
5.9 |
Resultat
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Ärende |
Ärende |
(se Ärende) |
PM5 Fastighet |
5.9 |
Hämta besiktningsprotokoll
GET /session/arende/protokoll/{ArendeId}/{InflyttandeHyresgäst}
GET /arende/{Delningsnyckel}
Hämtar ett besiktningsprotokoll med det angivna ärende-id:t, och den
booleska parametern
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| ÄrendeId |
Heltal |
516849 |
PM5 Fastighet |
5.9 |
| InflyttandeHyresgäst |
bool |
True, False |
|
5.9 |
Resultat
Pdf:en som bytes.
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Besiktningsprotokoll |
Byte[] |
|
Reporting |
5.9 |
Spara tillfällig adress
POST /session/kund/sparatillfalligadress/
Skapar en ny eller ändrar en befintlig tillfällig aviadress för
inloggad kund i fastighetssystemet. Anges AdressId så ändras befintlig
tillfällig adress.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.10 |
| AdressId |
Heltal |
3617390 |
PM5 Fastighet |
5.10 |
| Namn |
ISO 8601 |
2014-09-30 |
PM5 Fastighet |
5.10 |
| Attention |
Text |
Test Testarsson |
PM5 Fastighet |
5.10 |
| CareOf |
Text |
Testare Testarsson |
PM5 Fastighet |
5.10 |
| Gatuadress1 |
Text |
Testvägen 1 |
PM5 Fastighet |
5.10 |
| Gatuadress2 |
Text |
Testvägen 2 |
PM5 Fastighet |
5.10 |
| Postnummer |
Text |
79156 |
PM5 Fastighet |
5.10 |
| Postort |
Text |
Malmö |
PM5 Fastighet |
5.10 |
| Fom |
ISO 8601 |
2016-11-01 |
PM5 Fastighet |
5.10 |
| Tom |
ISO 8601 |
2016-11-30 |
PM5 Fastighet |
5.10 |
| Land |
Text |
SE |
PM5 Fastighet |
5.10 |
Resultat (Felmeddelande)
Returnerar ett resultat av typen Felmeddelande.
Hämta tillfälliga adresser
GET /session/kund/tillfalligaadresser/
Returnerar en lista med tillfälliga adresser.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.10 |
| VisaAvslutade |
Bool |
true |
PM5 Fastighet |
5.10 |
Resultat (TillfälligAdress)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| AdressId |
Heltal |
3617390 |
PM5 Fastighet |
5.10 |
| Fom |
ISO 8601 |
2016-11-01 |
PM5 Fastighet |
5.10 |
| Tom |
ISO 8601 |
2016-11-30 |
PM5 Fastighet |
5.10 |
| Gatuadress1 |
Text |
Testvägen 1 |
PM5 Fastighet |
5.10 |
| Gatuadress2 |
Text |
Testvägen |
PM5 Fastighet |
5.10 |
| Attention |
Text |
Test Testarsson |
PM5 Fastighet |
5.10 |
| Namn |
Text |
Test Kalle |
PM5 Fastighet |
5.10 |
| CareOf |
Text |
Test Nisse |
PM5 Fastighet |
5.10 |
| Postnummer |
Text |
80426 |
PM5 Fastighet |
5.10 |
| Postort |
Text |
Gävle |
PM5 Fastighet |
5.10 |
| Land |
Text |
Sverige |
PM5 Fastighet |
5.10 |
| LandReferensnamn |
Text |
SE |
PM5 Fastighet |
5.10 |
Ändra kontaktuppgift
Post /session/andrakontaktuppgift/
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| Epost |
Text |
kalle@nomail.com |
PM5= E-postadress, Marknad= Epostadress |
5.9 |
| Telefonnummer |
Text |
040-5555555 |
PM5= Telefon hem, Marknad= Telefonnummer |
5.9 |
| Mobiltelefonnummer |
Text |
070-0000000 |
PM5= Mobilnummer, Marknad= Mobiltelefonnummer |
5.9 |
| Validera |
bool |
true |
|
5.9 |
| ValideringsUrl |
Fritext |
http://www.momentum.se/minasidor/uppgifter/?nyckel={0}&c=1 |
|
5.9 |
Resultat (Ändra kontaktuppgift)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Fel |
Felmeddelande |
(se Felmeddelande) |
|
5.9 |
Hämta Tvättstugor- (Ett första utkast)-Stryks från v.5.9!
GET /Session/{Sessionsnyckel}/Tvättstugor
Returnerar alla bokningsbara tvättstugor för inloggad användare,
inklusive bokningsbara tider. Inte implementerat ännu.
Resultat (SessionTvättstuga)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Nummer |
Text |
142-043-01 |
PM5 Fastighet |
1.x |
| Entitet? |
ÄrendeNodstigdel |
(Se ÄrendeNodstigdel) |
PM5 Fastighet |
1.x |
| Adress |
Adress |
(se Adress under V1/Inledning/Generella datastrukturer och datatyper) |
PM5 Fastighet |
1.x |
| Tider? |
Lista av bokningsbara tider |
(Se SessionTvättstugeTid) |
Externt system |
1.x |
| BokadeTider? |
Lista av bokade tider |
(Se SessionTvättstugeTid) |
Externt system |
1.x |
Delresultat (SessionTvättstugeTid)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Tid |
ISO 8601 |
2014-01-01 14:00 |
Externt system |
1.x |
| Id? |
Heltal |
1023 |
Externt system |
1.x |
| Bokad? |
Bool |
true |
Externt system |
1.x |
Boka Tvättstuga
POST/Session/{Sessionsnyckel}/Boka
Skapar en bokning i externt bokningssystem.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
1.x |
| Tid |
ISO 8601 |
2014-01-01 14:00 |
|
1.x |
| Id ? |
Heltal |
123126 |
|
1.x |
Resultat
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Fel |
Felmeddelande |
(se Felmeddelande) |
|
1.x |
Avboka Tvättstuga
POST/Session/{Sessionsnyckel}/Avboka
Avbokar tvättstugetid i externt bokningssystem.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
1.x |
| Tid |
ISO 8601 |
2014-01-01 14:00 |
|
1.x |
| Id |
Heltal |
123456 |
|
1.x |
Resultat
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Fel |
Felmeddelande |
(se Felmeddelande) |
|
1.x |
Spara erbjudandesvar
POST/session/arende/sparaerbjudanden
Skickar en eller flera rader (SparaUnderhållErbjudandeRad) och sparar
datum som accepterat-datum i PM 5.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.9 |
| Rader |
Lista med SparaUnderhållErbjudandeRad |
(se SparaUnderhållErbjudandeRad) |
PM5 Fastighet |
5.9 |
Delparameter (SparaUnderhållErbjudandeRad)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ÄrendeRadId |
Heltal |
123456 |
|
5.9 |
| Accepterad |
ISO 8601 |
2016-10-01 |
|
5.9 |
Resultat
Returnerar ett resultat av typen Felmeddelande.
Hämta dokument
GET /session/kund/dokument/{EntitetfilId}
Hämtar fildata till en lagrad fil med kundinformation.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Fritext |
jCYrQ4tb… |
|
5.10 |
| EntitetfilId |
Heltal |
12345 |
|
5.10 |
Resultat
Returnerar Byte[] med fildata och inkluderar filens mimetyp i
HttpResult.
Hämta Ärenderadfil
GET /session/arenderadfil/{ArendeId}/{ArendeRadId}/{FilesId}
Hämtar byte[] baserat på id och ärende information.
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Fritext |
jCYrQ4tb… |
|
5.10 |
| ArendeId |
Heltal |
12345 |
|
5.10 |
| ArendeRadId |
Heltal |
12345 |
|
5.10 |
| FilesId |
Heltal |
12345 |
|
5.10 |
Resultat
Returnerar Byte[] med fildata och inkluderar filens mimetyp i
HttpResult.
Hämta NodKlassInfoLista
GET /session/{NodKlassGruppSystemName}
Hämta en lista över NodKlass typer (Störning, Önskemål) utifrån en
viss NodKlassGruppSystemName t.ex. "AllmantArende".
Parametrar
| Benämning |
Typ |
Exempel |
Källa |
Version |
| Sessionsnyckel |
Fritext |
jCYrQ4tb… |
|
5.12 |
| NodKlassGruppSystemName |
Text |
AllmantArende |
PM5 Fastighet |
5.12 |
| NodKlassAnvändningTypSystemName |
Text |
ExternWebbArende |
PM5 Fastighet |
5.12 |
Resultat
| Benämning |
Typ |
Exempel |
Källa |
Version |
| NodKlass[] |
NodKlass[] |
(Se NodKlass) |
PM5 Fastighet |
5.12 |
Delresultat (NodKlass)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| NodKlassId |
Heltal |
12345 |
PM5 Fastighet |
5.12 |
| Beteckning |
Text |
Störning |
PM5 Fastighet |
5.12 |
| Kod |
Text |
S |
PM5 Fastighet |
5.12 |
| Borttagen |
Bool |
False |
PM5 Fastighet |
5.12 |
| Kortbeteckning |
Text |
Stör |
PM5 Fastighet |
5.12 |
| SystemName |
Text |
Storning |
PM5 Fastighet |
5.12 |
| ÄrendeKlassTidpunktLista |
ÄrendeKlassTidpunktTyp[] |
(Se ÄrendeKlassTidpunkt) |
PM5 Fastighet |
5.12 |
Delresultat (ÄrendeKlassTidpunktTyp)
| Benämning |
Typ |
Exempel |
Källa |
Version |
| ÄrendeTidpunktTypId |
Heltal |
12345 |
PM5 Fastighet |
5.12 |
| ÄrendeTidpunktTypBorttagen |
ISO 8601 |
2014-01-01 14:00 |
PM5 Fastighet |
5.12 |
| ÄrendeTidpunktTypBeteckning |
Text |
Inträffat |
PM5 Fastighet |
5.12 |
| ÄrendeTidpunktTypSystemName |
Text |
Intraffat |
PM5 Fastighet |
5.12 |
SessionAdresserGet
Get /v1/session/kund/adresser/
Get adress för a customer. Two types of adresses, kund.post and kund.besok
Parameters
| Name |
Type |
Example |
Source |
Version |
| Sessionsnyckel |
Text |
jCYrQ4tb… |
|
5.16.2 |
| Benämning |
Typ |
Exempel |
Källa |
Version |
| AdressId |
Heltal |
|
|
5.16.2 |
| Fom |
ISO 8601 |
|
|
5.16.2 |
| Tom |
ISO 8601 |
|
|
5.16.2 |
| Gatuadress1 |
Text |
|
|
5.16.2 |
| Gatuadress2 |
Text |
|
|
5.16.2 |
| Attention |
Text |
|
|
5.16.2 |
| Namn |
Text |
|
|
5.16.2 |
| CareOf |
Text |
|
|
5.16.2 |
| Postnummer |
Text |
|
|
5.16.2 |
| Postort |
Text |
|
|
5.16.2 |
| Land |
Text |
|
|
5.16.2 |
| LandReferensnamn |
Text |
|
|
5.16.2 |
| AdressTypReferensnamn |
Text |
|
|
5.16.2 |
| AdressTypBeteckning |
Text |
|
|
5.16.2 |
| FullständigAdress |
Text |
|
|
5.16.2 |
| FullständigAdress |
Text |
|
|
5.16.2 |