| 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 authLetterFileUrl:[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 allowProductLookup:Bool
public var hasLogo:Bool
public var hasAuthLetter:Bool
public var sealNetWeightMandatory:Bool
public var allowBillableSeals:Bool
public var captureSerialNumber:Bool
public var batchCodesMandatory:Bool
public var captureManufactureAndExpiryDate:Bool
public var productExceptions:[ProductExceptionData] = []
public var usesOwnSealNumbers: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 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 maxQuantity:Int
public var maxPrice:Int
required public init(){}
}
public class ProductExceptionData : Codable
{
public var region:String
public var channel:String
public var productId:Int
public var stockStatusIds:[Int] = []
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: antel.api.dev.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
data:
{
principalId: 0,
name: String,
authLetterFileUrl:
[
String
],
logoImageUrl: String,
products:
[
{
unitBarcode: String,
products:
[
{
productId: 0,
principalId: 0,
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,
maxQuantity: 0,
maxPrice: 0
}
]
}
],
upliftPrefix: String,
contactName: String,
contactNumber: String,
contactEmail: String,
allowProductLookup: False,
hasLogo: False,
hasAuthLetter: False,
sealNetWeightMandatory: False,
allowBillableSeals: False,
captureSerialNumber: False,
batchCodesMandatory: False,
captureManufactureAndExpiryDate: False,
productExceptions:
[
{
region: String,
channel: String,
productId: 0,
stockStatusIds:
[
0
]
}
],
usesOwnSealNumbers: 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
}
}
}