Billiecart API

<back to all web services

SearchAllSalaryPackagesRequest

export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

    public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
    public distinct?: string;
    public limit?: number;
    public offset?: number;
    public sort?: string;
    public filter?: string;
    public search?: string;

    public constructor(init?: Partial<SearchOperationUnTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<SearchOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export enum SortDirection
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class Sorting
{
    public by?: string;
    public direction: SortDirection;

    public constructor(init?: Partial<Sorting>) { (Object as any).assign(this, init); }
}

export class Filtering
{
    public fields?: string[];
    public search?: string;

    public constructor(init?: Partial<Filtering>) { (Object as any).assign(this, init); }
}

export class SearchMetadata
{
    public total: number;
    public limit: number;
    public offset: number;
    public sort?: Sorting;
    public filter?: Filtering;

    public constructor(init?: Partial<SearchMetadata>) { (Object as any).assign(this, init); }
}

export class SearchOperationResponse
{
    public metadata?: SearchMetadata;

    public constructor(init?: Partial<SearchOperationResponse>) { (Object as any).assign(this, init); }
}

export class SalaryPackageSummary implements IIdentifiableResource
{
    public customerId?: string;
    public customerFirstName?: string;
    public customerLastName?: string;
    public employerName?: string;
    public vehicleLicensePlate?: string;
    public salarySacrificeAmount: number;
    public currentBalance: number;
    public preTaxDeduction?: number;
    public postTaxDeduction?: number;
    public leaseTerm?: number;
    public employerId?: string;
    public status?: string;
    public id?: string;

    public constructor(init?: Partial<SalaryPackageSummary>) { (Object as any).assign(this, init); }
}

export class SearchAllSalaryPackagesResponse extends SearchOperationResponse
{
    public responseStatus?: ResponseStatus;
    public salaryPackages?: SalaryPackageSummary[];

    public constructor(init?: Partial<SearchAllSalaryPackagesResponse>) { super(init); (Object as any).assign(this, init); }
}

export class SearchAllSalaryPackagesRequest extends SearchOperationTenanted<SearchAllSalaryPackagesResponse>
{
    public employerId?: string;

    public constructor(init?: Partial<SearchAllSalaryPackagesRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript SearchAllSalaryPackagesRequest DTOs

GET /packages HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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