| POST | /upliftrequest/auth |
|---|
import Foundation
import ServiceStack
public class UpliftRequestAuthRequest : ApiServiceRequest
{
public var upliftRequestOnDeviceId:String?
public var outletId:Int?
public var principalId:Int?
public var totalValue:Double?
public var totalUnits:Double?
public var region:String?
public var channel:String?
public var products:[UpliftRequestProductData] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftRequestOnDeviceId
case outletId
case principalId
case totalValue
case totalUnits
case region
case channel
case products
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftRequestOnDeviceId = try container.decodeIfPresent(String.self, forKey: .upliftRequestOnDeviceId)
outletId = try container.decodeIfPresent(Int.self, forKey: .outletId)
principalId = try container.decodeIfPresent(Int.self, forKey: .principalId)
totalValue = try container.decodeIfPresent(Double.self, forKey: .totalValue)
totalUnits = try container.decodeIfPresent(Double.self, forKey: .totalUnits)
region = try container.decodeIfPresent(String.self, forKey: .region)
channel = try container.decodeIfPresent(String.self, forKey: .channel)
products = try container.decodeIfPresent([UpliftRequestProductData].self, forKey: .products) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftRequestOnDeviceId != nil { try container.encode(upliftRequestOnDeviceId, forKey: .upliftRequestOnDeviceId) }
if outletId != nil { try container.encode(outletId, forKey: .outletId) }
if principalId != nil { try container.encode(principalId, forKey: .principalId) }
if totalValue != nil { try container.encode(totalValue, forKey: .totalValue) }
if totalUnits != nil { try container.encode(totalUnits, forKey: .totalUnits) }
if region != nil { try container.encode(region, forKey: .region) }
if channel != nil { try container.encode(channel, forKey: .channel) }
if products.count > 0 { try container.encode(products, forKey: .products) }
}
}
public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public var apiKey:String?
/**
* Latitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public var latitude:Double?
/**
* Longitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public var longitude:Double?
required public init(){}
}
public class UpliftRequestProductData : Codable
{
public var id:String?
public var upliftRequestProductId:Int?
public var productId:Int?
public var principalId:Int?
public var unitPrice:Double?
public var name:String?
public var category:String?
public var unitBarcode:String?
public var unitSize:String?
public var unitWeight:Double?
public var code:String?
public var images:[Object] = []
public var quantity:Double?
public var value:Double?
public var productionDate:String?
public var expiryDate:String?
public var batchCode:String?
public var seal:SealData?
public var serialNumber:String?
public var stockStatusId:Int?
public var principalLogoUrl:String?
public var principalName:String?
public var stockStatusName:String?
public var stockStatusColor:String?
public var unitOfMeasureId:Int?
required public init(){}
}
public class SealData : Seal
{
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 Seal : Codable
{
public var number:String?
public var weight:Double?
required public init(){}
}
public class UpliftRequestAuthRequestResponse : ApiServiceResponse
{
public var upliftRequestAuthRequestId:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftRequestAuthRequestId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftRequestAuthRequestId = try container.decodeIfPresent(String.self, forKey: .upliftRequestAuthRequestId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftRequestAuthRequestId != nil { try container.encode(upliftRequestAuthRequestId, forKey: .upliftRequestAuthRequestId) }
}
}
public class ApiServiceResponse : IServiceResponse, Codable
{
/**
* Information about the response.
*/
// @ApiMember(Description="Information about the response.", IsRequired=true)
public var Description:String?
/**
* Heading or summary of the response.
*/
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public var heading:String?
/**
* Did the intended operation for this response complete successfully?
*/
// @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
public var wasSuccessful:Bool?
public var responseStatus:ResponseStatus?
required public init(){}
}
Swift UpliftRequestAuthRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /upliftrequest/auth HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: application/json
Content-Type: application/json
Content-Length: length
{"OutletId":0,"PrincipalId":0,"TotalValue":0,"TotalUnits":0,"Region":"String","Channel":"String","Products":[{"UpliftRequestProductId":0,"ProductId":0,"PrincipalId":0,"UnitPrice":0,"Name":"String","Category":"String","UnitBarcode":"String","UnitSize":"String","UnitWeight":0,"Code":"String","Images":[{}],"Quantity":0,"Value":0,"ProductionDate":"String","ExpiryDate":"String","BatchCode":"String","Seal":{"Number":"String","Weight":0},"SerialNumber":"String","StockStatusId":0,"PrincipalLogoUrl":"String","PrincipalName":"String","StockStatusName":"String","StockStatusColor":"String","UnitOfMeasureId":0}],"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}