| Requires the role: | holder |
| GET | /packages/held |
|---|
import Foundation
import ServiceStack
public class SearchHeldSalaryPackagesRequest : SearchOperationTenanted<SearchHeldSalaryPackagesResponse>
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
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 SearchHeldSalaryPackagesResponse : 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 SearchHeldSalaryPackagesRequest DTOs
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 /packages/held HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchHeldSalaryPackagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages">
<Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">
<d2p1:Filter>
<d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Fields>
<d2p1:Search>String</d2p1:Search>
</d2p1:Filter>
<d2p1:Limit>0</d2p1:Limit>
<d2p1:Offset>0</d2p1:Offset>
<d2p1:Sort>
<d2p1:By>String</d2p1:By>
<d2p1:Direction>Ascending</d2p1:Direction>
</d2p1:Sort>
<d2p1:Total>0</d2p1:Total>
</Metadata>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<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>
<SalaryPackages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:SalaryPackageSummary>
<d2p1:CurrentBalance>0</d2p1:CurrentBalance>
<d2p1:CustomerFirstName>String</d2p1:CustomerFirstName>
<d2p1:CustomerId>String</d2p1:CustomerId>
<d2p1:CustomerLastName>String</d2p1:CustomerLastName>
<d2p1:EmployerId>String</d2p1:EmployerId>
<d2p1:EmployerName>String</d2p1:EmployerName>
<d2p1:Id>String</d2p1:Id>
<d2p1:LeaseTerm>0</d2p1:LeaseTerm>
<d2p1:PostTaxDeduction>0</d2p1:PostTaxDeduction>
<d2p1:PreTaxDeduction>0</d2p1:PreTaxDeduction>
<d2p1:SalarySacrificeAmount>0</d2p1:SalarySacrificeAmount>
<d2p1:Status>String</d2p1:Status>
<d2p1:VehicleLicensePlate>String</d2p1:VehicleLicensePlate>
</d2p1:SalaryPackageSummary>
</SalaryPackages>
</SearchHeldSalaryPackagesResponse>