AlbaApi

<back to all web services

ConfigurationReq

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

Namespace Global

    Namespace AlbaApi.Model

        Public Partial Class Configuration
            Inherits Entity
            Public Sub New()
                Countries = New Dictionary(Of String, Country)
                ListItems = New List(Of ListItem)
                ListRelationships = New Dictionary(Of String, String)
                SectionElements = New Dictionary(Of String, List(Of String))
                SiteStructure = New Dictionary(Of String, SiteSection)
            End Sub

            Public Overridable Property Category As String
            Public Overridable Property Countries As Dictionary(Of String, Country)
            Public Overridable Property ListItems As List(Of ListItem)
            Public Overridable Property ListRelationships As Dictionary(Of String, String)
            Public Overridable Property SectionElements As Dictionary(Of String, List(Of String))
            Public Overridable Property SiteStructure As Dictionary(Of String, SiteSection)
            Public Overridable Property Version As Integer
            Public Overridable Property CreatedBy As String
            Public Overridable Property DateCreated As Nullable(Of Date)
            Public Overridable Property UpdatedBy As String
            Public Overridable Property DateUpdated As Nullable(Of Date)
        End Class

        Public Partial Class Country
            Public Sub New()
                Languages = New Dictionary(Of String, String)
            End Sub

            Public Overridable Property Name As String
            Public Overridable Property Languages As Dictionary(Of String, String)
        End Class

        Public Partial Class ListItem
            Inherits Entity
            Public Overridable Property ListId As String
            Public Overridable Property Country As String
            Public Overridable Property RelatedId As String
            Public Overridable Property Code As String
            Public Overridable Property Custom As String
        End Class

        Public Partial Class SiteSection
            Public Sub New()
                HideFrom = New List(Of String)
            End Sub

            Public Overridable Property Route As String
            Public Overridable Property Public As Boolean
            Public Overridable Property Parent As String
            Public Overridable Property Roles As Integer
            Public Overridable Property HideFrom As List(Of String)
            Public Overridable Property Order As Integer
        End Class
    End Namespace

    Namespace AlbaApi.ServiceModel

        Public Partial Class ConfigurationReq
        End Class
    End Namespace

    Namespace TasSyd.Model.Base

        Public Partial Class Entity
            Implements IEntity
            Public Overridable Property Id As String
        End Class
    End Namespace
End Namespace

VB.NET ConfigurationReq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","updatedBy":"String","dateUpdated":"0001-01-01T00:00:00.0000000","id":"String"}