AlbaApi

<back to all web services

ConfigurationReq

The following routes are available for this service:
GET/config
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AlbaApi.ServiceModel;
using AlbaApi.Model;
using TasSyd.Model.Base;

namespace AlbaApi.Model
{
    public partial class Configuration
        : Entity
    {
        public Configuration()
        {
            Countries = new Dictionary<string, Country>{};
            ListItems = new List<ListItem>{};
            ListRelationships = new Dictionary<string, string>{};
            SectionElements = new Dictionary<string, List<String>>{};
            SiteStructure = new Dictionary<string, SiteSection>{};
        }

        public virtual string Category { get; set; }
        public virtual Dictionary<string, Country> Countries { get; set; }
        public virtual List<ListItem> ListItems { get; set; }
        public virtual Dictionary<string, string> ListRelationships { get; set; }
        public virtual Dictionary<string, List<String>> SectionElements { get; set; }
        public virtual Dictionary<string, SiteSection> SiteStructure { get; set; }
        public virtual int Version { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual DateTime? DateCreated { get; set; }
        public virtual string UpdatedBy { get; set; }
        public virtual DateTime? DateUpdated { get; set; }
    }

    public partial class Country
    {
        public Country()
        {
            Languages = new Dictionary<string, string>{};
        }

        public virtual string Name { get; set; }
        public virtual Dictionary<string, string> Languages { get; set; }
    }

    public partial class ListItem
        : Entity
    {
        public virtual string ListId { get; set; }
        public virtual string Country { get; set; }
        public virtual string RelatedId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Custom { get; set; }
    }

    public partial class SiteSection
    {
        public SiteSection()
        {
            HideFrom = new List<string>{};
        }

        public virtual string Route { get; set; }
        public virtual bool Public { get; set; }
        public virtual string Parent { get; set; }
        public virtual int Roles { get; set; }
        public virtual List<string> HideFrom { get; set; }
        public virtual int Order { get; set; }
    }

}

namespace AlbaApi.ServiceModel
{
    public partial class ConfigurationReq
    {
    }

}

namespace TasSyd.Model.Base
{
    public partial class Entity
        : IEntity
    {
        public virtual string Id { get; set; }
    }

}

C# 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
}