| POST | /config/update |
|---|
import Foundation
import ServiceStack
public class UpdateConfigReq : Codable
{
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] = [:]
required public init(){}
}
public class Country : Codable
{
public var name:String?
public var languages:[String:String] = [:]
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 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 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /config/update HTTP/1.1
Host: hcbtas-q-albamfs-api.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateConfigReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
<Category>String</Category>
<Countries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringCountryFNLs6TVB>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
<d4p1:Languages>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</d4p1:Languages>
<d4p1:Name>String</d4p1:Name>
</d2p1:Value>
</d2p1:KeyValueOfstringCountryFNLs6TVB>
</Countries>
<ListItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
<d2p1:ListItem>
<Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
<d2p1:Code>String</d2p1:Code>
<d2p1:Country>String</d2p1:Country>
<d2p1:Custom>String</d2p1:Custom>
<d2p1:ListId>String</d2p1:ListId>
<d2p1:RelatedId>String</d2p1:RelatedId>
</d2p1:ListItem>
</ListItems>
<ListRelationships xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</ListRelationships>
<SectionElements xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>
<d2p1:string>String</d2p1:string>
</d2p1:Value>
</d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
</SectionElements>
<SiteStructure xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
<d4p1:HideFrom>
<d2p1:string>String</d2p1:string>
</d4p1:HideFrom>
<d4p1:Order>0</d4p1:Order>
<d4p1:Parent>String</d4p1:Parent>
<d4p1:Public>false</d4p1:Public>
<d4p1:Roles>0</d4p1:Roles>
<d4p1:Route>String</d4p1:Route>
</d2p1:Value>
</d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
</SiteStructure>
</UpdateConfigReq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<Configuration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
<Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
<Category>String</Category>
<Countries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringCountryFNLs6TVB>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>
<Languages>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Languages>
<Name>String</Name>
</d2p1:Value>
</d2p1:KeyValueOfstringCountryFNLs6TVB>
</Countries>
<CreatedBy>String</CreatedBy>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<ListItems>
<ListItem>
<Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
<Code>String</Code>
<Country>String</Country>
<Custom>String</Custom>
<ListId>String</ListId>
<RelatedId>String</RelatedId>
</ListItem>
</ListItems>
<ListRelationships xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</ListRelationships>
<SectionElements xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>
<d2p1:string>String</d2p1:string>
</d2p1:Value>
</d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
</SectionElements>
<SiteStructure xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>
<HideFrom>
<d2p1:string>String</d2p1:string>
</HideFrom>
<Order>0</Order>
<Parent>String</Parent>
<Public>false</Public>
<Roles>0</Roles>
<Route>String</Route>
</d2p1:Value>
</d2p1:KeyValueOfstringSiteSectionFNLs6TVB>
</SiteStructure>
<UpdatedBy>String</UpdatedBy>
<Version>0</Version>
</Configuration>