AlbaApi

<back to all web services

ConfigurationReq

The following routes are available for this service:
GET/config
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ConfigurationReq
{
}

open class Configuration : Entity()
{
    var category:String? = null
    var countries:HashMap<String,Country> = HashMap<String,Country>()
    var listItems:ArrayList<ListItem> = ArrayList<ListItem>()
    var listRelationships:HashMap<String,String> = HashMap<String,String>()
    var sectionElements:HashMap<String,ArrayList<String>> = HashMap<String,ArrayList<String>>()
    var siteStructure:HashMap<String,SiteSection> = HashMap<String,SiteSection>()
    var version:Int? = null
    var createdBy:String? = null
    var dateCreated:Date? = null
    var updatedBy:String? = null
    var dateUpdated:Date? = null
}

open class Entity : IEntity
{
    var id:String? = null
}

open class Country
{
    var name:String? = null
    var languages:HashMap<String,String> = HashMap<String,String>()
}

open class ListItem : Entity()
{
    var listId:String? = null
    var country:String? = null
    var relatedId:String? = null
    var code:String? = null
    var custom:String? = null
}

open class SiteSection
{
    var route:String? = null
    @SerializedName("public") var Public:Boolean? = null
    var parent:String? = null
    var roles:Int? = null
    var hideFrom:ArrayList<String> = ArrayList<String>()
    var order:Int? = null
}

Kotlin ConfigurationReq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /config HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	category: String,
	countries: 
	{
		String: 
		{
			name: String,
			languages: 
			{
				String: String
			}
		}
	},
	listItems: 
	[
		{
			listId: String,
			country: String,
			relatedId: String,
			code: String,
			custom: String,
			id: String
		}
	],
	listRelationships: 
	{
		String: String
	},
	sectionElements: 
	{
		String: 
		[
			String
		]
	},
	siteStructure: 
	{
		String: 
		{
			route: String,
			public: False,
			parent: String,
			roles: 0,
			hideFrom: 
			[
				String
			],
			order: 0
		}
	},
	version: 0,
	createdBy: String,
	dateCreated: 0001-01-01,
	updatedBy: String,
	dateUpdated: 0001-01-01,
	id: String
}