Billiecart API

SearchHeldSalaryPackagesRequest

**Requires Authentication**
Requires the role:	holder

The following routes are available for this service:
GET	/packages/held

namespace Application.Interfaces

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type SortDirection =
        | Ascending = 0
        | Descending = 1

    [<AllowNullLiteral>]
    type Sorting() = 
        member val By:String = null with get,set
        member val Direction:SortDirection = new SortDirection() with get,set

    [<AllowNullLiteral>]
    type Filtering() = 
        member val Fields:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Search:String = null with get,set

    [<AllowNullLiteral>]
    type SearchMetadata() = 
        member val Total:Int32 = new Int32() with get,set
        member val Limit:Int32 = new Int32() with get,set
        member val Offset:Int32 = new Int32() with get,set
        member val Sort:Sorting = null with get,set
        member val Filter:Filtering = null with get,set

    [<AllowNullLiteral>]
    type SearchOperationResponse() = 
        member val Metadata:SearchMetadata = null with get,set

    [<AllowNullLiteral>]
    type SalaryPackageSummary() = 
        member val CustomerId:String = null with get,set
        member val CustomerFirstName:String = null with get,set
        member val CustomerLastName:String = null with get,set
        member val EmployerName:String = null with get,set
        member val VehicleLicensePlate:String = null with get,set
        member val SalarySacrificeAmount:Decimal = new Decimal() with get,set
        member val CurrentBalance:Decimal = new Decimal() with get,set
        member val PreTaxDeduction:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PostTaxDeduction:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LeaseTerm:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EmployerId:String = null with get,set
        member val Status:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type SearchHeldSalaryPackagesResponse() = 
        inherit SearchOperationResponse()
        member val ResponseStatus:ResponseStatus = null with get,set
        member val SalaryPackages:ResizeArray<SalaryPackageSummary> = new ResizeArray<SalaryPackageSummary>() with get,set

    [<AllowNullLiteral>]
    type SearchHeldSalaryPackagesRequest() = 
        inherit SearchOperationTenanted<SearchHeldSalaryPackagesResponse>()

    [<AllowNullLiteral>]
    type SearchOperationTenanted<'TResponse>() = 
        inherit SearchOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type SearchOperationUnTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val Distinct:String = null with get,set
        member val Limit:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Offset:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Sort:String = null with get,set
        member val Filter:String = null with get,set
        member val Search:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# SearchHeldSalaryPackagesRequest 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

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}