| Requires the role: | manager |
| GET | /packages |
|---|
import Foundation
import ServiceStack
public class SearchAllSalaryPackagesRequest : SearchOperationTenanted<SearchAllSalaryPackagesResponse>
{
public var employerId:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case employerId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
employerId = try container.decodeIfPresent(String.self, forKey: .employerId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if employerId != nil { try container.encode(employerId, forKey: .employerId) }
}
}
public class SearchOperationTenanted<TResponse : Codable> : SearchOperationUnTenanted<TResponse>, ITenantedRequest
{
public var organisationId:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case organisationId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
}
}
public class SearchOperationUnTenanted<TResponse : Codable> : GetOperationUnTenanted<TResponse>, IHasSearchOptions
{
public var distinct:String?
public var limit:Int?
public var offset:Int?
public var sort:String?
public var filter:String?
public var search:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case distinct
case limit
case offset
case sort
case filter
case search
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
distinct = try container.decodeIfPresent(String.self, forKey: .distinct)
limit = try container.decodeIfPresent(Int.self, forKey: .limit)
offset = try container.decodeIfPresent(Int.self, forKey: .offset)
sort = try container.decodeIfPresent(String.self, forKey: .sort)
filter = try container.decodeIfPresent(String.self, forKey: .filter)
search = try container.decodeIfPresent(String.self, forKey: .search)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if distinct != nil { try container.encode(distinct, forKey: .distinct) }
if limit != nil { try container.encode(limit, forKey: .limit) }
if offset != nil { try container.encode(offset, forKey: .offset) }
if sort != nil { try container.encode(sort, forKey: .sort) }
if filter != nil { try container.encode(filter, forKey: .filter) }
if search != nil { try container.encode(search, forKey: .search) }
}
}
public class GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
public var embed:String?
required public init(){}
}
public class SearchAllSalaryPackagesResponse : SearchOperationResponse
{
public var responseStatus:ResponseStatus?
public var salaryPackages:[SalaryPackageSummary] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case responseStatus
case salaryPackages
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
salaryPackages = try container.decodeIfPresent([SalaryPackageSummary].self, forKey: .salaryPackages) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
if salaryPackages.count > 0 { try container.encode(salaryPackages, forKey: .salaryPackages) }
}
}
public class SearchOperationResponse : Codable
{
public var metadata:SearchMetadata?
required public init(){}
}
public class SearchMetadata : Codable
{
public var total:Int?
public var limit:Int?
public var offset:Int?
public var sort:Sorting?
public var filter:Filtering?
required public init(){}
}
public class Sorting : Codable
{
public var by:String?
public var direction:SortDirection?
required public init(){}
}
public enum SortDirection : String, Codable
{
case Ascending
case Descending
}
public class Filtering : Codable
{
public var fields:[String] = []
public var search:String?
required public init(){}
}
public class SalaryPackageSummary : IIdentifiableResource, Codable
{
public var customerId:String?
public var customerFirstName:String?
public var customerLastName:String?
public var employerName:String?
public var vehicleLicensePlate:String?
public var salarySacrificeAmount:Double?
public var currentBalance:Double?
public var preTaxDeduction:Double?
public var postTaxDeduction:Double?
public var leaseTerm:Int?
public var employerId:String?
public var status:String?
public var id:String?
required public init(){}
}
Swift SearchAllSalaryPackagesRequest DTOs
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 /packages HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
salaryPackages:
[
{
customerId: String,
customerFirstName: String,
customerLastName: String,
employerName: String,
vehicleLicensePlate: String,
salarySacrificeAmount: 0,
currentBalance: 0,
preTaxDeduction: 0,
postTaxDeduction: 0,
leaseTerm: 0,
employerId: String,
status: String,
id: String
}
],
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
],
search: String
}
}
}