AlbaApi

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:
Name	Parameter	Data Type	Required	Description
Country	path	string	No
Lang	path	string	No

**AdminAppData** Parameters:
Name	Parameter	Data Type	Required
SiteStructure	form	Dictionary<string, SiteSection>	No
SectionElements	form	Dictionary<string, List<String>>	No
ListRelationships	form	Dictionary<string, string>	No
ListItems	form	List<ListItem>	No
Countries	form	Dictionary<string, Country>	No
Content	form	List<Content>	No
User	form	User	No
ScriptTrackerRecords	form	List<ScriptTracker>	No
Configurations	form	IEnumerable<Configuration>	No

**SiteSection** Parameters:
Name	Parameter	Data Type	Required
Route	form	string	No
Public	form	bool	No
Parent	form	string	No
Roles	form	int	No
HideFrom	form	List<string>	No
Order	form	int	No

**ListItem** Parameters:
Name	Parameter	Data Type	Required
ListId	form	string	No
Country	form	string	No
RelatedId	form	string	No
Code	form	string	No
Custom	form	string	No

**Entity** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No

**Country** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Languages	form	Dictionary<string, string>	No

**Content** Parameters:
Name	Parameter	Data Type	Required
Section	form	string	No
ItemId	form	string	No
ItemCode	form	string	No
Country	form	string	No
Lang	form	string	No
App	form	string	No
CompanyId	form	string	No
Company	form	string	No
Elements	form	Dictionary<string, string>	No

**User** Parameters:
Name	Parameter	Data Type	Required	Description
Roles	form	Roles	No

**Roles** Enum:
Name	Value
None	0
Employee	1
Member	2
Employer	4
Broker	8
Developer	16
SysAdmin	32

**ScriptTracker** Parameters:
Name	Parameter	Data Type	Required
Sprint	form	string	No
Country	form	string	No
Language	form	string	No
Section	form	string	No
ItemCode	form	string	No
Element	form	string	No
Value	form	string	No
IsFromMerge	form	bool	No

**Configuration** Parameters:
Name	Parameter	Data Type	Required
Category	form	string	No
Countries	form	Dictionary<string, Country>	No
ListItems	form	List<ListItem>	No
ListRelationships	form	Dictionary<string, string>	No
SectionElements	form	Dictionary<string, List<String>>	No
SiteStructure	form	Dictionary<string, SiteSection>	No
Version	form	int	No
CreatedBy	form	string	No
DateCreated	form	DateTime?	No
UpdatedBy	form	string	No
DateUpdated	form	DateTime?	No

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	country: String,
	lang: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	]
}