GET | /config |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Languages | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ListId | form | string | No | |
Country | form | string | No | |
RelatedId | form | string | No | |
Code | form | string | No | |
Custom | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv 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-01, updatedBy: String, dateUpdated: 0001-01-01, id: String }