GET | /homepage/images | Find homepage images for a company |
---|
import Foundation
import ServiceStack
public class HomepageImagesQuery : QueryDb2<HomepageImage, HomepageImageQueryResponse>, ICompanyRequest
{
/**
* Enter the company you want to see news for, if blank and you are an admin, your company id will be used
*/
// @ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")
public var companyId:String?
/**
* The image id.
*/
// @ApiMember(Description="The image id.")
public var id:Int?
/**
* The homeage sitepath.
*/
// @ApiMember(Description="The homeage sitepath.")
public var sitePath:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case id
case sitePath
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
id = try container.decodeIfPresent(Int.self, forKey: .id)
sitePath = try container.decodeIfPresent(String.self, forKey: .sitePath)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if id != nil { try container.encode(id, forKey: .id) }
if sitePath != nil { try container.encode(sitePath, forKey: .sitePath) }
}
}
public class HomepageImage : BaseModel
{
// @Required()
public var companyId:String?
public var id:Int
public var title:String
public var Description:String
// @Required()
public var imageUrl:String?
public var modifiedDate:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case id
case title
case Description
case imageUrl
case modifiedDate
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
id = try container.decodeIfPresent(Int.self, forKey: .id)
title = try container.decodeIfPresent(String.self, forKey: .title)
Description = try container.decodeIfPresent(String.self, forKey: .Description)
imageUrl = try container.decodeIfPresent(String.self, forKey: .imageUrl)
modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if id != nil { try container.encode(id, forKey: .id) }
if title != nil { try container.encode(title, forKey: .title) }
if Description != nil { try container.encode(Description, forKey: .Description) }
if imageUrl != nil { try container.encode(imageUrl, forKey: .imageUrl) }
if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
}
}
public class BaseModel : Codable
{
required public init(){}
}
public class HomepageImageQueryResponse : Codable
{
/**
* The company id.
*/
// @ApiMember(Description="The company id.")
public var companyId:String
/**
* The homepage image id.
*/
// @ApiMember(Description="The homepage image id.")
public var id:Int
/**
* The image title.
*/
// @ApiMember(Description="The image title.")
public var title:String
/**
* The image description.
*/
// @ApiMember(Description="The image description.")
public var Description:String
/**
* The image url.
*/
// @ApiMember(Description="The image url.")
public var imageUrl:Uri
required public init(){}
}
public class AccessKeyTypeResponse : Codable
{
public var id:Int
public var keyType:String
public var Description:String
required public init(){}
}
Swift HomepageImagesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /homepage/images HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"Offset":0,"Total":0,"Results":[{"Id":0,"Title":"String","Description":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}