| GET | /principal/get |
|---|
import Foundation
import ServiceStack
public class GetPrincipal : ApiServiceRequest
{
public var principalId:Int?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case principalId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
principalId = try container.decodeIfPresent(Int.self, forKey: .principalId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if principalId != nil { try container.encode(principalId, forKey: .principalId) }
}
}
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 GetPrincipalResponse : ApiServiceResponse
{
public var data:PrincipalData?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case data
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
data = try container.decodeIfPresent(PrincipalData.self, forKey: .data)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if data != nil { try container.encode(data, forKey: .data) }
}
}
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(){}
}
public class PrincipalData : Codable
{
public var principalId:Int?
public var name:String?
public var logoImageUrl:String?
public var products:[ProductDataCategory] = []
public var upliftPrefix:String?
public var contactName:String?
public var contactNumber:String?
public var contactEmail:String?
public var hasLogo:Bool?
public var allowProductLookup:Bool?
public var captureSerialNumber:Bool?
public var showProductionDate:Bool?
public var showExpiryDate:Bool?
public var showBatchCode:Bool?
public var sealNumberPerProduct:Bool?
public var allowedProductStockStatuses:[StockStatusData] = []
public var enabled:Bool?
public var showSealNumber:Bool?
public var showSealWeight:Bool?
public var consolidationEnabled:Bool?
required public init(){}
}
public class ProductDataCategory : Codable
{
public var unitBarcode:String?
public var products:[ProductData] = []
required public init(){}
}
public class ProductData : Codable
{
public var productId:Int?
public var principalId:Int?
public var principalPrefix:String?
public var name:String?
public var category:String?
public var productCode:String?
public var unitBarcode:String?
public var cartonQuantity:Int?
public var shrinkQuantity:Int?
public var unitQuantity:Int?
public var cartonMeasurement:String?
public var shrinkMeasurement:String?
public var unitMeasurement:String?
public var cartonWeight:Double?
public var shrinkWeight:Double?
public var unitWeight:Double?
public var cartonPrice:Double?
public var shrinkPrice:Double?
public var unitPrice:Double?
public var unitOfMeasureId:Int?
required public init(){}
}
public class StockStatusData : Codable
{
public var id:Int?
public var name:String?
public var photoRequired:Bool?
public var batchCodeMandatory:Bool?
public var color: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 /principal/get HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Data":{"PrincipalId":0,"Name":"String","LogoImageUrl":"String","Products":[{"UnitBarcode":"String","Products":[{"ProductId":0,"PrincipalId":0,"PrincipalPrefix":"String","Name":"String","Category":"String","ProductCode":"String","UnitBarcode":"String","CartonQuantity":0,"ShrinkQuantity":0,"UnitQuantity":0,"CartonMeasurement":"String","ShrinkMeasurement":"String","UnitMeasurement":"String","CartonWeight":0,"ShrinkWeight":0,"UnitWeight":0,"CartonPrice":0,"ShrinkPrice":0,"UnitPrice":0,"UnitOfMeasureId":0}]}],"UpliftPrefix":"String","ContactName":"String","ContactNumber":"String","ContactEmail":"String","HasLogo":false,"AllowProductLookup":false,"CaptureSerialNumber":false,"ShowProductionDate":false,"ShowExpiryDate":false,"ShowBatchCode":false,"SealNumberPerProduct":false,"AllowedProductStockStatuses":[{"Id":0,"Name":"String","PhotoRequired":false,"BatchCodeMandatory":false,"Color":"String"}],"Enabled":false,"ShowSealNumber":false,"ShowSealWeight":false,"ConsolidationEnabled":false},"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"}}}