| GET | /api/AdvancedCustomerSearch |
|---|
import Foundation
import ServiceStack
/**
* AdvancedCustomerSearchRequires active-e Customer Service.
*/
// @DataContract
public class AdvancedCustomerSearchRequest : BaseSecureRequest
{
/**
* The type of advanced search. Options are SUBACCOUNT (Students and Dependents), CHECK (Exact Check# lookup), and CREDITCARD (Last 4 lookup)
*/
// @DataMember
// @ApiMember(DataType="string", Description="The type of advanced search. Options are SUBACCOUNT (Students and Dependents), CHECK (Exact Check# lookup), and CREDITCARD (Last 4 lookup)", IsRequired=true, Name="SearchType")
public var searchType:String
/**
* What to search for
*/
// @DataMember
// @ApiMember(DataType="string", Description="What to search for", IsRequired=true, Name="SearchString")
public var searchString:String
/**
* The Starting Offset. Defaults to 0 if not sent.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="The Starting Offset. Defaults to 0 if not sent.", Format="int64", Name="StartOffset")
public var startOffset:Int?
/**
* The # of records to be returned. Defaults to 100 if not sent.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="The # of records to be returned. Defaults to 100 if not sent.", Format="int64", Name="RecordCount")
public var recordCount:Int?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case searchType
case searchString
case startOffset
case recordCount
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
searchType = try container.decodeIfPresent(String.self, forKey: .searchType)
searchString = try container.decodeIfPresent(String.self, forKey: .searchString)
startOffset = try container.decodeIfPresent(Int.self, forKey: .startOffset)
recordCount = try container.decodeIfPresent(Int.self, forKey: .recordCount)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if searchType != nil { try container.encode(searchType, forKey: .searchType) }
if searchString != nil { try container.encode(searchString, forKey: .searchString) }
if startOffset != nil { try container.encode(startOffset, forKey: .startOffset) }
if recordCount != nil { try container.encode(recordCount, forKey: .recordCount) }
}
}
// @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 AdvancedCustomerSearchResponse : BaseResponse
{
// @DataMember
public var remainingRecords:Int
// @DataMember
public var customers:[AdvancedCustomerSearchRecord] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case remainingRecords
case customers
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
remainingRecords = try container.decodeIfPresent(Int.self, forKey: .remainingRecords)
customers = try container.decodeIfPresent([AdvancedCustomerSearchRecord].self, forKey: .customers) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if remainingRecords != nil { try container.encode(remainingRecords, forKey: .remainingRecords) }
if customers.count > 0 { try container.encode(customers, forKey: .customers) }
}
}
// @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 AdvancedCustomerSearchRecord : Codable
{
// @DataMember
public var acct:Int
// @DataMember
public var sub:Int?
// @DataMember
public var name:String
// @DataMember
public var resultType:String
// @DataMember
public var resultDetail:String
// @DataMember
public var dateTime:Date?
// @DataMember
public var amount:Double?
required public init(){}
}
Swift AdvancedCustomerSearchRequest 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.
GET /api/AdvancedCustomerSearch HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"RemainingRecords":0,"Customers":[{"Acct":0,"Sub":0,"Name":"String","ResultType":"String","ResultDetail":"String","DateTime":"0001-01-01T00:00:00.0000000","Amount":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}