| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetPrincipalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
<Description xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">false</WasSuccessful>
<Data>
<AllowProductLookup>false</AllowProductLookup>
<AllowedProductStockStatuses>
<StockStatusData>
<BatchCodeMandatory>false</BatchCodeMandatory>
<Color>String</Color>
<Id>0</Id>
<Name>String</Name>
<PhotoRequired>false</PhotoRequired>
</StockStatusData>
</AllowedProductStockStatuses>
<CaptureSerialNumber>false</CaptureSerialNumber>
<ConsolidationEnabled>false</ConsolidationEnabled>
<ContactEmail>String</ContactEmail>
<ContactName>String</ContactName>
<ContactNumber>String</ContactNumber>
<Enabled>false</Enabled>
<HasLogo>false</HasLogo>
<LogoImageUrl>String</LogoImageUrl>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<Products>
<ProductDataCategory>
<Products>
<ProductData>
<CartonMeasurement>String</CartonMeasurement>
<CartonPrice>0</CartonPrice>
<CartonQuantity>0</CartonQuantity>
<CartonWeight>0</CartonWeight>
<Category>String</Category>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<PrincipalPrefix>String</PrincipalPrefix>
<ProductCode>String</ProductCode>
<ProductId>0</ProductId>
<ShrinkMeasurement>String</ShrinkMeasurement>
<ShrinkPrice>0</ShrinkPrice>
<ShrinkQuantity>0</ShrinkQuantity>
<ShrinkWeight>0</ShrinkWeight>
<UnitBarcode>String</UnitBarcode>
<UnitMeasurement>String</UnitMeasurement>
<UnitOfMeasureId>0</UnitOfMeasureId>
<UnitPrice>0</UnitPrice>
<UnitQuantity>0</UnitQuantity>
<UnitWeight>0</UnitWeight>
</ProductData>
</Products>
<UnitBarcode>String</UnitBarcode>
</ProductDataCategory>
</Products>
<SealNumberPerProduct>false</SealNumberPerProduct>
<ShowBatchCode>false</ShowBatchCode>
<ShowExpiryDate>false</ShowExpiryDate>
<ShowProductionDate>false</ShowProductionDate>
<ShowSealNumber>false</ShowSealNumber>
<ShowSealWeight>false</ShowSealWeight>
<UpliftPrefix>String</UpliftPrefix>
</Data>
</GetPrincipalResponse>