| GET | /api/PhysicalInventoryCycleLookup |
|---|
import Foundation
import ServiceStack
/**
* PhysicalInventoryCycleLookupRequires active-e Inventory Service
*/
// @DataContract
public class PhysicalInventoryCycleLookupRequest : BaseSecureRequest
{
/**
* Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SkuPk", ParameterType="query")
public var skuPk:Int?
/**
* Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="LocationId", ParameterType="query")
public var locationId:Int?
/**
* Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SaqPk", ParameterType="query")
public var saqPk:Int?
/**
* Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SasPk", ParameterType="query")
public var sasPk:Int?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case skuPk
case locationId
case saqPk
case sasPk
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
skuPk = try container.decodeIfPresent(Int.self, forKey: .skuPk)
locationId = try container.decodeIfPresent(Int.self, forKey: .locationId)
saqPk = try container.decodeIfPresent(Int.self, forKey: .saqPk)
sasPk = try container.decodeIfPresent(Int.self, forKey: .sasPk)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if skuPk != nil { try container.encode(skuPk, forKey: .skuPk) }
if locationId != nil { try container.encode(locationId, forKey: .locationId) }
if saqPk != nil { try container.encode(saqPk, forKey: .saqPk) }
if sasPk != nil { try container.encode(sasPk, forKey: .sasPk) }
}
}
// @DataContract
public class BaseSecureRequest : BaseRequest
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public var token:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public var deviceId:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public var appId:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case token
case deviceId
case appId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
token = try container.decodeIfPresent(String.self, forKey: .token)
deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
appId = try container.decodeIfPresent(String.self, forKey: .appId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if token != nil { try container.encode(token, forKey: .token) }
if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
if appId != nil { try container.encode(appId, forKey: .appId) }
}
}
// @DataContract
public class BaseRequest : Codable
{
/**
* This is your AIM API Key provided by Tri-Tech
*/
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
public var apiKey:String
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public var oAuthToken:String
required public init(){}
}
// @DataContract
public class PhysicalInventoryCycleLookupResponse : BaseResponse
{
// @DataMember
public var lookupResult:String
// @DataMember
public var cycle:PhysicalInventoryCycle
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case lookupResult
case cycle
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
lookupResult = try container.decodeIfPresent(String.self, forKey: .lookupResult)
cycle = try container.decodeIfPresent(PhysicalInventoryCycle.self, forKey: .cycle)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if lookupResult != nil { try container.encode(lookupResult, forKey: .lookupResult) }
if cycle != nil { try container.encode(cycle, forKey: .cycle) }
}
}
// @DataContract
public class BaseResponse : Codable
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public var status:BaseResponseResult
required public init(){}
}
// @DataContract
public class BaseResponseResult : Codable
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public var statusCode:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public var login:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public var errorCode:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public var errorDisplayText:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public var errorMessage:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public var domainName:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public var ipAddress:String
required public init(){}
}
// @DataContract
public class PhysicalInventoryCycle : Codable
{
// @DataMember
public var id:Int
// @DataMember
public var Description:String
// @DataMember
public var employeeName:String
// @DataMember
public var creationDate:Date
// @DataMember
public var lastUpdated:Date?
required public init(){}
}
Swift PhysicalInventoryCycleLookupRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/PhysicalInventoryCycleLookup HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"LookupResult":"String","Cycle":{"Id":0,"Description":"String","EmployeeName":"String","LastUpdated":"0001-01-01T00:00:00.0000000"},"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}