AlbaApi

<back to all web services

AdminAppReq

The following routes are available for this service:
All Verbs/admin/app
All Verbs/admin/app/{Country}
All Verbs/admin/app/{Country}/{Lang}
AdminAppReq Parameters:
NameParameterData TypeRequiredDescription
CountrypathstringNo
LangpathstringNo
AdminAppData Parameters:
NameParameterData TypeRequiredDescription
SiteStructureformDictionary<string, SiteSection>No
SectionElementsformDictionary<string, List<String>>No
ListRelationshipsformDictionary<string, string>No
ListItemsformList<ListItem>No
CountriesformDictionary<string, Country>No
ContentformList<Content>No
UserformUserNo
ScriptTrackerRecordsformList<ScriptTracker>No
ConfigurationsformIEnumerable<Configuration>No
SiteSection Parameters:
NameParameterData TypeRequiredDescription
RouteformstringNo
PublicformboolNo
ParentformstringNo
RolesformintNo
HideFromformList<string>No
OrderformintNo
ListItem Parameters:
NameParameterData TypeRequiredDescription
ListIdformstringNo
CountryformstringNo
RelatedIdformstringNo
CodeformstringNo
CustomformstringNo
Entity Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
Country Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
LanguagesformDictionary<string, string>No
Content Parameters:
NameParameterData TypeRequiredDescription
SectionformstringNo
ItemIdformstringNo
ItemCodeformstringNo
CountryformstringNo
LangformstringNo
AppformstringNo
CompanyIdformstringNo
CompanyformstringNo
ElementsformDictionary<string, string>No
User Parameters:
NameParameterData TypeRequiredDescription
RolesformRolesNo
Roles Enum:
NameValue
None0
Employee1
Member2
Employer4
Broker8
Developer16
SysAdmin32
ScriptTracker Parameters:
NameParameterData TypeRequiredDescription
SprintformstringNo
CountryformstringNo
LanguageformstringNo
SectionformstringNo
ItemCodeformstringNo
ElementformstringNo
ValueformstringNo
IsFromMergeformboolNo
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

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.

POST /admin/app HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"country":"String","lang":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"siteStructure":{"String":{"route":"String","public":false,"parent":"String","roles":0,"hideFrom":["String"],"order":0}},"sectionElements":{"String":["String"]},"listRelationships":{"String":"String"},"listItems":[{"listId":"String","country":"String","relatedId":"String","code":"String","custom":"String","id":"String"}],"countries":{"String":{"name":"String","languages":{"String":"String"}}},"content":[{"section":"String","itemId":"String","itemCode":"String","country":"String","lang":"String","app":"String","companyId":"String","company":"String","elements":{"String":"String"},"id":"String"}],"user":{"roles":0},"scriptTrackerRecords":[{"sprint":"String","country":"String","language":"String","section":"String","itemCode":"String","element":"String","value":"String","isFromMerge":false,"id":"String"}]}