Get Application Settings
Provides the application settings for a specific subscription or multiple subscriptions. If your application is configured to receive CloudEvents, it will receive an Application-Settings-Changed-CloudEvent when there are new application settings available.
Query Parameters
- subscriptionId uuid
Subscription id
- offset int32
Offset for paging
- limit int32
Default value:
25
Limit for paging
- 200
- 400
- 401
Successful
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
- totalCount int32
Total count of items
data object[] nullable
List of application settings
Array [subscriptionId uuidSubscription id
countryId string nullableCountry id ISO 3166-1 alpha-2 code
internationalization object
Internationalization
locale string nullableLocale
timeZone string nullableTime zone (Windows format)
currency string nullableCurrency id based on ISO 4217
systemOfUnits string nullableSystem of units, possible values: "metric" or "imperial"
paperFormat string nullablePaper format, possible values: "A4" or "letter"
logo object
Logo information
uri string nullableUri to the logo (PNG). The URL path will change when the customer changes their logo. Be aware that the URLs expire. They are valid for seven days starting from the beginning of the day they were requested.
thumbnail string nullableUri to a thumbnail of the logo, Max 64px (height or width)
]
{
"totalCount": 0,
"data": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"countryId": "string",
"internationalization": {
"locale": "string",
"timeZone": "string",
"currency": "string",
"systemOfUnits": "string",
"paperFormat": "string"
},
"logo": {
"uri": "string",
"thumbnail": "string"
}
}
]
}
- Schema
- Example (from schema)
Schema
- totalCount int32
Total count of items
data object[] nullable
List of application settings
Array [subscriptionId uuidSubscription id
countryId string nullableCountry id ISO 3166-1 alpha-2 code
internationalization object
Internationalization
locale string nullableLocale
timeZone string nullableTime zone (Windows format)
currency string nullableCurrency id based on ISO 4217
systemOfUnits string nullableSystem of units, possible values: "metric" or "imperial"
paperFormat string nullablePaper format, possible values: "A4" or "letter"
logo object
Logo information
uri string nullableUri to the logo (PNG). The URL path will change when the customer changes their logo. Be aware that the URLs expire. They are valid for seven days starting from the beginning of the day they were requested.
thumbnail string nullableUri to a thumbnail of the logo, Max 64px (height or width)
]
{
"totalCount": 0,
"data": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"countryId": "string",
"internationalization": {
"locale": "string",
"timeZone": "string",
"currency": "string",
"systemOfUnits": "string",
"paperFormat": "string"
},
"logo": {
"uri": "string",
"thumbnail": "string"
}
}
]
}
- Schema
- Example (from schema)
Schema
- totalCount int32
Total count of items
data object[] nullable
List of application settings
Array [subscriptionId uuidSubscription id
countryId string nullableCountry id ISO 3166-1 alpha-2 code
internationalization object
Internationalization
locale string nullableLocale
timeZone string nullableTime zone (Windows format)
currency string nullableCurrency id based on ISO 4217
systemOfUnits string nullableSystem of units, possible values: "metric" or "imperial"
paperFormat string nullablePaper format, possible values: "A4" or "letter"
logo object
Logo information
uri string nullableUri to the logo (PNG). The URL path will change when the customer changes their logo. Be aware that the URLs expire. They are valid for seven days starting from the beginning of the day they were requested.
thumbnail string nullableUri to a thumbnail of the logo, Max 64px (height or width)
]
{
"totalCount": 0,
"data": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"countryId": "string",
"internationalization": {
"locale": "string",
"timeZone": "string",
"currency": "string",
"systemOfUnits": "string",
"paperFormat": "string"
},
"logo": {
"uri": "string",
"thumbnail": "string"
}
}
]
}
Bad request
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
Unauthorized
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}
- Schema
- Example (from schema)
Schema
- message string nullable
- details string[] nullable
{
"message": "string",
"details": [
"string"
]
}