All Verbs | /admin/app | ||
---|---|---|---|
All Verbs | /admin/app/{Country} | ||
All Verbs | /admin/app/{Country}/{Lang} |
import Foundation
import ServiceStack
public class AdminAppReq : Codable
{
public var country:String?
public var lang:String?
required public init(){}
}
public class AdminAppData : Codable
{
public var siteStructure:[String:SiteSection] = [:]
public var sectionElements:[String:[String]] = [:]
public var listRelationships:[String:String] = [:]
public var listItems:[ListItem] = []
public var countries:[String:Country] = [:]
public var content:[Content] = []
public var user:User?
public var scriptTrackerRecords:[ScriptTracker] = []
public var configurations:[Configuration] = []
required public init(){}
}
public class SiteSection : Codable
{
public var route:String?
public var `public`:Bool?
public var parent:String?
public var roles:Int?
public var hideFrom:[String] = []
public var order:Int?
required public init(){}
}
public class ListItem : Entity
{
public var listId:String?
public var country:String?
public var relatedId:String?
public var code:String?
public var custom:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case listId
case country
case relatedId
case code
case custom
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
listId = try container.decodeIfPresent(String.self, forKey: .listId)
country = try container.decodeIfPresent(String.self, forKey: .country)
relatedId = try container.decodeIfPresent(String.self, forKey: .relatedId)
code = try container.decodeIfPresent(String.self, forKey: .code)
custom = try container.decodeIfPresent(String.self, forKey: .custom)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if listId != nil { try container.encode(listId, forKey: .listId) }
if country != nil { try container.encode(country, forKey: .country) }
if relatedId != nil { try container.encode(relatedId, forKey: .relatedId) }
if code != nil { try container.encode(code, forKey: .code) }
if custom != nil { try container.encode(custom, forKey: .custom) }
}
}
public class Entity : IEntity, Codable
{
public var id:String?
required public init(){}
}
public class Country : Codable
{
public var name:String?
public var languages:[String:String] = [:]
required public init(){}
}
public class Content : Entity
{
public var section:String?
public var itemId:String?
public var itemCode:String?
public var country:String?
public var lang:String?
public var app:String?
public var companyId:String?
public var company:String?
public var elements:[String:String] = [:]
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case section
case itemId
case itemCode
case country
case lang
case app
case companyId
case company
case elements
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
section = try container.decodeIfPresent(String.self, forKey: .section)
itemId = try container.decodeIfPresent(String.self, forKey: .itemId)
itemCode = try container.decodeIfPresent(String.self, forKey: .itemCode)
country = try container.decodeIfPresent(String.self, forKey: .country)
lang = try container.decodeIfPresent(String.self, forKey: .lang)
app = try container.decodeIfPresent(String.self, forKey: .app)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
company = try container.decodeIfPresent(String.self, forKey: .company)
elements = try container.decodeIfPresent([String:String].self, forKey: .elements) ?? [:]
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if section != nil { try container.encode(section, forKey: .section) }
if itemId != nil { try container.encode(itemId, forKey: .itemId) }
if itemCode != nil { try container.encode(itemCode, forKey: .itemCode) }
if country != nil { try container.encode(country, forKey: .country) }
if lang != nil { try container.encode(lang, forKey: .lang) }
if app != nil { try container.encode(app, forKey: .app) }
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if company != nil { try container.encode(company, forKey: .company) }
if elements.count > 0 { try container.encode(elements, forKey: .elements) }
}
}
public class User : Codable
{
public var roles:Roles?
required public init(){}
}
// @Flags()
public enum Roles : Int, Codable
{
case None = 0
case Employee = 1
case Member = 2
case Employer = 4
case Broker = 8
case Developer = 16
case SysAdmin = 32
}
public class ScriptTracker : Entity
{
public var sprint:String?
public var country:String?
public var language:String?
public var section:String?
public var itemCode:String?
public var element:String?
public var value:String?
public var isFromMerge:Bool?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case sprint
case country
case language
case section
case itemCode
case element
case value
case isFromMerge
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
sprint = try container.decodeIfPresent(String.self, forKey: .sprint)
country = try container.decodeIfPresent(String.self, forKey: .country)
language = try container.decodeIfPresent(String.self, forKey: .language)
section = try container.decodeIfPresent(String.self, forKey: .section)
itemCode = try container.decodeIfPresent(String.self, forKey: .itemCode)
element = try container.decodeIfPresent(String.self, forKey: .element)
value = try container.decodeIfPresent(String.self, forKey: .value)
isFromMerge = try container.decodeIfPresent(Bool.self, forKey: .isFromMerge)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if sprint != nil { try container.encode(sprint, forKey: .sprint) }
if country != nil { try container.encode(country, forKey: .country) }
if language != nil { try container.encode(language, forKey: .language) }
if section != nil { try container.encode(section, forKey: .section) }
if itemCode != nil { try container.encode(itemCode, forKey: .itemCode) }
if element != nil { try container.encode(element, forKey: .element) }
if value != nil { try container.encode(value, forKey: .value) }
if isFromMerge != nil { try container.encode(isFromMerge, forKey: .isFromMerge) }
}
}
public class Configuration : Entity
{
public var category:String?
public var countries:[String:Country] = [:]
public var listItems:[ListItem] = []
public var listRelationships:[String:String] = [:]
public var sectionElements:[String:[String]] = [:]
public var siteStructure:[String:SiteSection] = [:]
public var version:Int?
public var createdBy:String?
public var dateCreated:Date?
public var updatedBy:String?
public var dateUpdated:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case category
case countries
case listItems
case listRelationships
case sectionElements
case siteStructure
case version
case createdBy
case dateCreated
case updatedBy
case dateUpdated
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
category = try container.decodeIfPresent(String.self, forKey: .category)
countries = try container.decodeIfPresent([String:Country].self, forKey: .countries) ?? [:]
listItems = try container.decodeIfPresent([ListItem].self, forKey: .listItems) ?? []
listRelationships = try container.decodeIfPresent([String:String].self, forKey: .listRelationships) ?? [:]
sectionElements = try container.decodeIfPresent([String:[String]].self, forKey: .sectionElements) ?? [:]
siteStructure = try container.decodeIfPresent([String:SiteSection].self, forKey: .siteStructure) ?? [:]
version = try container.decodeIfPresent(Int.self, forKey: .version)
createdBy = try container.decodeIfPresent(String.self, forKey: .createdBy)
dateCreated = try container.decodeIfPresent(Date.self, forKey: .dateCreated)
updatedBy = try container.decodeIfPresent(String.self, forKey: .updatedBy)
dateUpdated = try container.decodeIfPresent(Date.self, forKey: .dateUpdated)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if category != nil { try container.encode(category, forKey: .category) }
if countries.count > 0 { try container.encode(countries, forKey: .countries) }
if listItems.count > 0 { try container.encode(listItems, forKey: .listItems) }
if listRelationships.count > 0 { try container.encode(listRelationships, forKey: .listRelationships) }
if sectionElements.count > 0 { try container.encode(sectionElements, forKey: .sectionElements) }
if siteStructure.count > 0 { try container.encode(siteStructure, forKey: .siteStructure) }
if version != nil { try container.encode(version, forKey: .version) }
if createdBy != nil { try container.encode(createdBy, forKey: .createdBy) }
if dateCreated != nil { try container.encode(dateCreated, forKey: .dateCreated) }
if updatedBy != nil { try container.encode(updatedBy, forKey: .updatedBy) }
if dateUpdated != nil { try container.encode(dateUpdated, forKey: .dateUpdated) }
}
}
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.
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 } ] }