Billiecart API

SearchHeldSalaryPackagesRequest

**Requires Authentication**
Requires the role:	holder

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces

        Public Partial Class Filtering
            Public Sub New()
                Fields = New List(Of String)
            End Sub

            Public Overridable Property Fields As List(Of String)
            Public Overridable Property Search As String
        End Class

        Public Partial Class SearchMetadata
            Public Overridable Property Total As Integer
            Public Overridable Property Limit As Integer
            Public Overridable Property Offset As Integer
            Public Overridable Property Sort As Sorting
            Public Overridable Property Filter As Filtering
        End Class

        Public Enum SortDirection
            Ascending
            Descending
        End Enum

        Public Partial Class Sorting
            Public Overridable Property By As String
            Public Overridable Property Direction As SortDirection
        End Class
    End Namespace

    Namespace Application.Interfaces.Resources

        Public Partial Class SalaryPackageSummary
            Implements IIdentifiableResource
            Public Overridable Property CustomerId As String
            Public Overridable Property CustomerFirstName As String
            Public Overridable Property CustomerLastName As String
            Public Overridable Property EmployerName As String
            Public Overridable Property VehicleLicensePlate As String
            Public Overridable Property SalarySacrificeAmount As Decimal
            Public Overridable Property CurrentBalance As Decimal
            Public Overridable Property PreTaxDeduction As Nullable(Of Decimal)
            Public Overridable Property PostTaxDeduction As Nullable(Of Decimal)
            Public Overridable Property LeaseTerm As Nullable(Of Integer)
            Public Overridable Property EmployerId As String
            Public Overridable Property Status As String
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class

        Public Partial Class SearchOperationResponse
            Public Overridable Property Metadata As SearchMetadata
        End Class

        Public Partial Class SearchOperationTenanted(Of TResponse)
            Inherits SearchOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class SearchOperationUnTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements IHasSearchOptions
            Public Overridable Property Distinct As String
            Public Overridable Property Limit As Nullable(Of Integer)
            Public Overridable Property Offset As Nullable(Of Integer)
            Public Overridable Property Sort As String
            Public Overridable Property Filter As String
            Public Overridable Property Search As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages

        Public Partial Class SearchHeldSalaryPackagesRequest
            Inherits SearchOperationTenanted(Of SearchHeldSalaryPackagesResponse)
        End Class

        Public Partial Class SearchHeldSalaryPackagesResponse
            Inherits SearchOperationResponse
            Public Sub New()
                SalaryPackages = New List(Of SalaryPackageSummary)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property SalaryPackages As List(Of SalaryPackageSummary)
        End Class
    End Namespace
End Namespace

VB.NET SearchHeldSalaryPackagesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>