Configuration
Get client configuration
Retrieve client configuration for visual branding (including colours, files and icons to be used in browsers, apps etc), security, localization, analytics and other options.
Request
Example
Parameters
| Name | Description |
|---|---|
| market | Boolean value indicating whether or not market information such as market object types (ad types) are included in the response. |
Response
Example
{
"app": {
"name": "Mina sidor"
},
"brand": {
"files": {
"externalAppIcon": {
"displayName": "Utsida Appikon",
"address": "http://localhost/Momentum.Pm.PortalApi.WebHost/files/554746"
}
},
"themes": {
"light": {
"displayName": "Ljust",
"colours": {
"primary": {
"displayName": "Primär",
"colourCode": "#214755"
},
"accent": {
"displayName": "Accent",
"colourCode": "#ff4200"
},
"warning": {
"displayName": "Varning",
"colourCode": "#cc0000"
},
"toolbar": {
"displayName": "Verktygsrad",
"colourCode": "#214755"
},
"defaultBackground": {
"displayName": "Standard bakgrund",
"colourCode": "#f4eeee"
}
},
"files": {
"logoPrimaryBackground": {
"displayName": "Logotyp primär bakgrund"
},
"logoDefaultBackground": {
"displayName": "Logotyp standard bakgrund"
},
"externalFavIcon": {
"displayName": "Utsida Favikon",
"address": "http://host.domain.tld/portal-api/files/554747"
}
}
},
"dark": {
"displayName": "Mörkt",
"colours": {
"primary": {
"displayName": "Primär",
"colourCode": "#90a3aa"
},
"accent": {
"displayName": "Accent",
"colourCode": "#faa19b"
},
"warning": {
"displayName": "Varning",
"colourCode": "#fc4b4b"
},
"toolbar": {
"displayName": "Verktygsrad",
"colourCode": "#90a3aa"
},
"defaultBackground": {
"displayName": "Standard bakgrund",
"colourCode": "#303030"
}
},
"files": {
"logoPrimaryBackground": {
"displayName": "Logotyp primär bakgrund"
},
"logoDefaultBackground": {
"displayName": "Logotyp standard bakgrund"
},
"externalFavIcon": {
"displayName": "Utsida Favikon",
"address": "http://host.domain.tld/portal-api/files/554747"
}
}
}
}
},
"globalization": {
"languages": [
{
"localeId": 1053,
"name": "Svenska",
"shortName": "SV",
"texts": {
"Landingp3": " och kika runt!",
"Showallfeatures": "+ alla snabbfunktioner",
"News": "Aktuellt",
"Checkpersoninfo": "Bara en sak till kontrollera dina uppgifter!",
"Payments": "Betalningar",
"Invoice": "Betalningar",
"Booklaundry": "Boka tvättstuga",
"Landingp2": "Du kan dygnet runt tryggt göra en felanmälan och sedan följa ditt ärende. Du kan ändra dina uppgifter, ta emot meddelanden och i den digitala kundinformationen kan du läsa om vad som gäller för dig som hyresgäst.",
"Errorreport": "Felanmälan",
"Consumption": "Förbrukning",
"Landingp1": "Här får du tillgång till information och tjänster som är till nytta för dig som hyresgäst. På Mina sidor finns dina hyresavier och där hittar du enkelt OCR-nummer eller ser om din avi/faktura är betald.",
"Herobodytext": "Här hittar du information om dina boendekostnader, kontaktuppgifter till ansvariga, skapa felanmälan m.m.",
"Welcomehelp": "Här hittar du information om dina boendekostnader, kontaktuppgifter till ansvariga, skapa felanmälan mm.",
"Errorreporthelp": "Här kan du se dina felanmälningar",
"Tempaddrhelp": "Här kan du ändra din tillfälliga kundadress, d.v.s. den adress din avi når. Detta kan t.ex. vara bra när du befinner dig i din sommarstuga på semester.",
"Contactbyhelp": "Här kan du ändra dina kontaktvägar",
"Contactbytitle": "Kontaktvägar",
"Account": "Konto",
"Residentinfo": "Kundinformation",
"Residentinfomissing": "Kundinformation saknas",
"Messages": "Meddelanden",
"Mycontracts": "Mina avtal",
"Myinfo": "Mina uppgifter",
"Errorheader": "Nu blev det lite tokigt!",
"Createerrorreport": "Skapa felanmälan",
"Quickactions": "Snabbfunktioner",
"Temporaryaddress": "Tillfällig adress",
"Tempaddr": "Tillfällig adress",
"Maintenance": "Underhåll",
"Errorreportquestion": "Vad vill du felanmäla?",
"Showallerrorreports": "Visa alla felanmälningar",
"Showallmessages": "Visa alla meddelanden",
"Herotext": "Välkommen",
"Landingtitle": "Välkommen till Mina Sidor"
}
},
{
"localeId": 1033,
"name": "Engelska",
"shortName": "EN",
"texts": {
"Landingp3": " and have a look!",
"Showallfeatures": "+ all features",
"News": "News",
"Checkpersoninfo": "Just one more thing, check your information!",
"Payments": "Payments",
"Invoice": "Invoices",
"Booklaundry": "Book laundry",
"Landingp2": "You can safely make a mistake report around the clock and then follow your case. You can change your information, receive messages and in your digital housing permit you can read about what applies to you as a tenant.",
"Errorreport": "Error report",
"Consumption": "Consumption",
"Landingp1": "Here you have access to information and services that are useful to you as a tenant. On My Pages you will find your rental pays and there you can easily find OCR numbers or see if your avi / invoice is paid.",
"Herobodytext": "Here you will find information about your accommodation costs, contact information for users, create a bug report, etc.",
"Welcomehelp": "Här hittar du information om dina boendekostnader, skapa felanmälan mm.",
"Errorreporthelp": "Here you can see your error reports",
"Tempaddrhelp": "Here you can change your temporary customer address, i.e. the address your rent invoice is sent to. This can be used when you are on holiday.",
"Contactbyhelp": "Here you can change your contact channels",
"Contactbytitle": "Contact channels",
"Account": "Account",
"Residentinfo": "Customer info",
"Residentinfomissing": "Customer info missing",
"Messages": "Messages",
"Mycontracts": "My agreements",
"Myinfo": "My info",
"Errorheader": "Something went wrong!",
"Createerrorreport": "Create error report",
"Quickactions": "Quick features",
"Temporaryaddress": "Temporary adress",
"Tempaddr": "Temporary adress",
"Maintenance": "Maintenance",
"Errorreportquestion": "What do you want to report?",
"Showallerrorreports": "Show all error reports",
"Showallmessages": "Show all messages",
"Herotext": "Welcome",
"Landingtitle": "Welcome to My Pages"
}
}
]
},
"security":
{
"authentication": {
"providers": [
{
"displayName": "BankID",
"realm": "bankid.com"
},
{
"displayName": "BankID test",
"realm": "bankid.com/test"
},
{
"displayName": "My Company External",
"realm": "ece00de1-26de-4857-9643-18999602fcbc"
}
]
}
},
"analytics":
{
"standard": true,
"services":
[
{
"name": "GoogleAnalytics",
"code": "Abc-123456"
},
{
"name": "GoogleAnalytics",
"code": " Efg-56789"
}
]
},
"options":
{
"previousVersionWebAddress": "http://moms444pm5.momentumsoftware.se/"
},
"feauture":
{
"avtal":
{
"enabled":true
},
"aktuellt":
{
"enabled":true
}
},
"market":
{
"types":
[
{
"id":"annonstyp.bostad",
"displayName":"Bostad",
"description": "Testar en annonstypbeskrivning",
"maxNumberOfApplications": 3,
"maxNumberOfRooms": 7,
"maxSize": 300,
"icon":
{
"svg": "M11.5,1L2,6V8H21V6M16,10V17H19V10M2,22H21V19H2M10,10V17H13V10M4,10V17H7V10H4Z"
}
},
{
"id":"annonstyp.fordonsplats",
"displayName":"Fordonsplats",
"maxNumberOfApplications": 3,
"maxPrice": 5000
},
{
"id":"annonstyp.lokal",
"displayName":"Lokal",
"maxNumberOfApplications": 3,
"maxNumberOfRooms": 7,
"maxSize": 300,
"maxPrice": 15000
}
]
}
}
Parameters
| Name | Description |
|---|---|
| app | Name typically shown in the browser title |
| brand | Visual brand |
| globalization | Languages and texts |
| security | Configured authentication services |
| analytics | Analytics and tracking |
| options | Other options, stored in a key/value dictionary. See example above. |
| feauture | Feauture flags and if these are enabled |
| Ads | Ads information |
.app
| Name | Description |
|---|---|
| name | string |
.brand
| Name | Description |
|---|---|
| files | Dictionary string, files configured independant of theme e.g. appicon |
| themes | Dictionary string |
.brand.files[name]
| Name | Description |
|---|---|
| displayName | Example Utsida Appikon |
| address | Example http://host.domain.tld/portal-api/files/595468 |
.brand.themes[theme]
| Name | Description |
|---|---|
| displayName | string |
| colours | Dictionary string |
| files | Dictionary string |
.brand.themes[theme].colours[name]
| Name | Description |
|---|---|
| displayName | Example: Primär |
| colourCode | Example #214755 |
.brand.themes[theme].files[name]
| Name | Description |
|---|---|
| displayName | Example Logotyp primär bakgrund |
| address | Example http://host.domain.tld/portal-api/files/595468 |
.globalization
| Name | Description |
|---|---|
| languages | List of supported languages |
.globalization.languages[n]
| Name | Description |
|---|---|
| localeId | Language code identifier (lcid). Example: 1053 |
| name | Example: Svenska |
| shortName | Example: SV |
| languageCode | Example: SV-SE |
| texts | Dictionary string, string |
.security
| Name | Description |
|---|---|
| authentication | Authentication configuration object. |
.security.authentication
| Name | Description |
|---|---|
| providers | List of configured authentication providers. |
.security.authentication.providers[n]
| Name | Description |
|---|---|
| displayName | Friendly display name. Example: BankID |
| realm | Use as realm parameter when starting authentication using the /v2/auth API. Example: bankid.com |
| type | Type information for the provider. |
.security.authentication.providers[n].type
| Name | Description |
|---|---|
| id | A unique identifier for type of provider. Example: OAuth and BankID |
.analytics
| Name | Description |
|---|---|
| standard | True if built-in standard tracking should be enabled. Example: true |
| services | List of configured analytics services. |
.analytics.services[n]
| Name | Description |
|---|---|
| name | Type of provider. Example: GoogleAnalytics |
| code | Tracking code. Eample: u-123 |
.market
| Name | Description |
|---|---|
| types | Information of the different market object types. Can be used when filtering list of market objects. |
.market.types[n]
| Name | Description |
|---|---|
| id | The systemname of the market object type. |
| displayName | Display name of the market object type. |
| description | Description of the market object type. |
| maxNumberOfApplications | Max number of active applications allowed for the market object type. |
| maxNumberOfRooms | Max number of rentable object rooms to be used when presenting filter options for the listing of market objects. |
| maxSize | Max rentable object floorspace to be used when presenting filter options for the listing of market objects. |
| maxPrice | Max rentable object price to be used when presenting filter options for the listing of market objects. |