AlbaApi

<back to all web services

ConfigurationByCategoryReq

The following routes are available for this service:
GET/config/{Category}
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 ConfigurationByCategoryReq
            Public Overridable Property Category As String
        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 ConfigurationByCategoryReq DTOs

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

HTTP + XML

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

GET /config/{Category} HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Configuration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
  <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
  <Category>String</Category>
  <Countries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringCountryFNLs6TVB>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <Languages>
          <d2p1:KeyValueOfstringstring>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:KeyValueOfstringstring>
        </Languages>
        <Name>String</Name>
      </d2p1:Value>
    </d2p1:KeyValueOfstringCountryFNLs6TVB>
  </Countries>
  <CreatedBy>String</CreatedBy>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <DateUpdated>0001-01-01T00:00:00</DateUpdated>
  <ListItems>
    <ListItem>
      <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
      <Code>String</Code>
      <Country>String</Country>
      <Custom>String</Custom>
      <ListId>String</ListId>
      <RelatedId>String</RelatedId>
    </ListItem>
  </ListItems>
  <ListRelationships xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ListRelationships>
  <SectionElements xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>String</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </SectionElements>
  <SiteStructure xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <HideFrom>
          <d2p1:string>String</d2p1:string>
        </HideFrom>
        <Order>0</Order>
        <Parent>String</Parent>
        <Public>false</Public>
        <Roles>0</Roles>
        <Route>String</Route>
      </d2p1:Value>
    </d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
  </SiteStructure>
  <UpdatedBy>String</UpdatedBy>
  <Version>0</Version>
</Configuration>