ContactSettings
Beskrivning
Generell tjänst för att hantera medborgares och organisationers inställningar för hur återkoppling ska ske (för till exempel felanmälningar och driftstörningar).
Livscykelstatus
Produktion
Lösningsbeskrivning
Detaljer
Tjänsten håller alla kontaktinställningar för en person och gör det möjligt att söka ut kontaktuppgifter för olika typer av meddelanden.
Setting
En contactSetting är ett objekt som är knutet till en person/organisation och har en lista med kontaktuppgifter.
{
"id": "0d64c132-3aea-11ec-8d3d-0242ac130003",
"partyId": "15aee472-46ab-4f03-9605-68bd64ebc73f",
"alias": "Mina kontaktuppgifter",
"virtual": false,
"contactChannels": [
{
"contactMethod": "SMS",
"alias": "Privat mobil",
"destination": "+46701234567"
}
],
"created": "2020-10-31T01:30:00+02:00",
"modified": "2020-10-31T01:30:00+02:00"
}
Förklaring
2. Unikt ID för denna contactSetting.
3. Unikt ID som knyter denna contactSetting till en verklig person/organisation.
4. Attribut för att ge objektet ett eget namn.Främst användbart för virtuella instanser (T.ex. "Vaktmästare fastighet A")
5. Huruvuda denna instans är virtuell eller ej (om partyId inte är satt är virtual = true).
6. Kontaktvägarna. Det är här alla e-postadresser, telefonnummer osv. är definierade.
En contactSetting har i regel en 1-till-1 mappning mot en verklig person/organisation. PartyId används för att knyta en contactSetting till en specifik person eller organisation. PartyId är obligatoriskt för icke-virtuella contactSettings.
Det går naturligtvis även att skapa virtuella contactSettings utan partyId. Dessa används t.ex. när man vill delegera meddelanden till roller (istället för verkliga personer/organisationer). T.ex. en fastighetsägare som vill delegera meddelanden av en viss typ till en (eller flera) vaktmästare.
Delegate
Det är även möjligt att skapa delegeringar till andra contactSettings-instanser, både virtuella och sådana som är kopplade till en person/organisation. Vill man anpassa delegeringarna så att bara vissa typer av meddelanden delegeras, kan man göra det med hjälp av filter.
Exemplet nedan visar hur ett sådant delegeringsobjekt kan se ut:
{
"principalId": "0d64c132-3aea-11ec-8d3d-0242ac130003",
"agentId": "4a758ca4-6df5-43f4-a7ce-612f51f9da09",
"filters": [
{
"alias": "Delegerar meddelanden för el-abonnemanget till sommarstugan till min fru",
"rules": [
{
"attributeName": "facilityId",
"operator": "EQUALS",
"attributeValue": "123456"
},
{
"attributeName": "category",
"operator": "EQUALS",
"attributeValue": "ELECTRICITY"
}
]
}
]
}
Förklaring
API specifikation
Säkerhetsklassning
Säkerhetsklass 1
Autentiseringsmetod: Oauth2
Teknisk ägare
För tekniska frågor: teamunmasked@sundsvall.se