Requires the role: | manager |
GET | /packages |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces;
using Application.Interfaces.Resources;
namespace Application.Interfaces
{
public partial class Filtering
{
public Filtering()
{
Fields = new List<string>{};
}
public virtual List<string> Fields { get; set; }
public virtual string Search { get; set; }
}
public partial class SearchMetadata
{
public virtual int Total { get; set; }
public virtual int Limit { get; set; }
public virtual int Offset { get; set; }
public virtual Sorting Sort { get; set; }
public virtual Filtering Filter { get; set; }
}
public enum SortDirection
{
Ascending,
Descending,
}
public partial class Sorting
{
public virtual string By { get; set; }
public virtual SortDirection Direction { get; set; }
}
}
namespace Application.Interfaces.Resources
{
public partial class SalaryPackageSummary
: IIdentifiableResource
{
public virtual string CustomerId { get; set; }
public virtual string CustomerFirstName { get; set; }
public virtual string CustomerLastName { get; set; }
public virtual string EmployerName { get; set; }
public virtual string VehicleLicensePlate { get; set; }
public virtual decimal SalarySacrificeAmount { get; set; }
public virtual decimal CurrentBalance { get; set; }
public virtual decimal? PreTaxDeduction { get; set; }
public virtual decimal? PostTaxDeduction { get; set; }
public virtual int? LeaseTerm { get; set; }
public virtual string EmployerId { get; set; }
public virtual string Status { get; set; }
public virtual string Id { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations
{
public partial class GetOperationUnTenanted<TResponse>
: IHasGetOptions, IGet
{
public virtual string Embed { get; set; }
}
public partial class SearchOperationResponse
{
public virtual SearchMetadata Metadata { get; set; }
}
public partial class SearchOperationTenanted<TResponse>
: SearchOperationUnTenanted<TResponse>, ITenantedRequest
{
public virtual string OrganisationId { get; set; }
}
public partial class SearchOperationUnTenanted<TResponse>
: GetOperationUnTenanted<TResponse>, IHasSearchOptions
{
public virtual string Distinct { get; set; }
public virtual int? Limit { get; set; }
public virtual int? Offset { get; set; }
public virtual string Sort { get; set; }
public virtual string Filter { get; set; }
public virtual string Search { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages
{
public partial class SearchAllSalaryPackagesRequest
: SearchOperationTenanted<SearchAllSalaryPackagesResponse>
{
public virtual string EmployerId { get; set; }
}
public partial class SearchAllSalaryPackagesResponse
: SearchOperationResponse
{
public SearchAllSalaryPackagesResponse()
{
SalaryPackages = new List<SalaryPackageSummary>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<SalaryPackageSummary> SalaryPackages { get; set; }
}
}
C# SearchAllSalaryPackagesRequest 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 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>