AlbaApi

<back to all web services

ConfigurationByCategoryReq

The following routes are available for this service:
GET/config/{Category}
ConfigurationByCategoryReq Parameters:
NameParameterData TypeRequiredDescription
CategorypathstringNo
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 .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/{Category} 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"}