AlbaApi

<back to all web services

ConfigurationReq

The following routes are available for this service:
GET/config
Configuration Parameters:
NameParameterData TypeRequiredDescription
CategoryformstringNo
CountriesformDictionary<string, Country>No
ListItemsformList<ListItem>No
ListRelationshipsformDictionary<string, string>No
SectionElementsformDictionary<string, List<String>>No
SiteStructureformDictionary<string, SiteSection>No
VersionformintNo
CreatedByformstringNo
DateCreatedformDateTime?No
UpdatedByformstringNo
DateUpdatedformDateTime?No
Entity Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
Country Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
LanguagesformDictionary<string, string>No
ListItem Parameters:
NameParameterData TypeRequiredDescription
ListIdformstringNo
CountryformstringNo
RelatedIdformstringNo
CodeformstringNo
CustomformstringNo
SiteSection Parameters:
NameParameterData TypeRequiredDescription
RouteformstringNo
PublicformboolNo
ParentformstringNo
RolesformintNo
HideFromformList<string>No
OrderformintNo

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 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>