| GET | /campaigns |
|---|
import Foundation
import ServiceStack
public class CampaignsGetList : Codable
{
required public init(){}
}
public class CampaignsGetListResponse : GetResponse<CampaignViewModel>
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class GetResponse<TEntity : Codable> : Codable
{
public var item:TEntity?
public var responseStatus:ResponseStatus?
required public init(){}
}
public class CampaignViewModel : Codable
{
public var currentCampaignNumber:Int?
public var priorYearCampaignNumber:Int?
public var campaigns:[CampaignDetails] = []
required public init(){}
}
public class CampaignDetails : Codable
{
public var campaignNumber:Int?
public var campaignName:String?
public var batchNumber:Double?
public var batchName:String?
public var campaignsAwayFromCurrent:Int?
public var cycle:Int?
public var periodStartTime:Date?
public var periodEndTime:Date?
public var fiscalYear:Int?
public var status:String?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /campaigns HTTP/1.1 Host: extensions.avon.ca Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"item":{"currentCampaignNumber":0,"priorYearCampaignNumber":0,"campaigns":[{"campaignNumber":0,"campaignName":"String","batchNumber":0,"batchName":"String","campaignsAwayFromCurrent":0,"cycle":0,"periodStartTime":"0001-01-01T00:00:00.0000000","periodEndTime":"0001-01-01T00:00:00.0000000","fiscalYear":0,"status":"String"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}