| Requires the role: | holder |
| GET | /packages/held |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class SearchHeldSalaryPackagesRequest extends SearchOperationTenanted<SearchHeldSalaryPackagesResponse>
{
}
public static class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
public String organisationId = null;
public String getOrganisationId() { return organisationId; }
public SearchOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
}
public static class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
public String distinct = null;
public Integer limit = null;
public Integer offset = null;
public String sort = null;
public String filter = null;
public String search = null;
public String getDistinct() { return distinct; }
public SearchOperationUnTenanted<TResponse> setDistinct(String value) { this.distinct = value; return this; }
public Integer getLimit() { return limit; }
public SearchOperationUnTenanted<TResponse> setLimit(Integer value) { this.limit = value; return this; }
public Integer getOffset() { return offset; }
public SearchOperationUnTenanted<TResponse> setOffset(Integer value) { this.offset = value; return this; }
public String getSort() { return sort; }
public SearchOperationUnTenanted<TResponse> setSort(String value) { this.sort = value; return this; }
public String getFilter() { return filter; }
public SearchOperationUnTenanted<TResponse> setFilter(String value) { this.filter = value; return this; }
public String getSearch() { return search; }
public SearchOperationUnTenanted<TResponse> setSearch(String value) { this.search = value; return this; }
}
public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
public String embed = null;
public String getEmbed() { return embed; }
public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
}
public static class SearchHeldSalaryPackagesResponse extends SearchOperationResponse
{
public ResponseStatus responseStatus = null;
public ArrayList<SalaryPackageSummary> salaryPackages = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public SearchHeldSalaryPackagesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public ArrayList<SalaryPackageSummary> getSalaryPackages() { return salaryPackages; }
public SearchHeldSalaryPackagesResponse setSalaryPackages(ArrayList<SalaryPackageSummary> value) { this.salaryPackages = value; return this; }
}
public static class SearchOperationResponse
{
public SearchMetadata metadata = null;
public SearchMetadata getMetadata() { return metadata; }
public SearchOperationResponse setMetadata(SearchMetadata value) { this.metadata = value; return this; }
}
public static class SearchMetadata
{
public Integer total = null;
public Integer limit = null;
public Integer offset = null;
public Sorting sort = null;
public Filtering filter = null;
public Integer getTotal() { return total; }
public SearchMetadata setTotal(Integer value) { this.total = value; return this; }
public Integer getLimit() { return limit; }
public SearchMetadata setLimit(Integer value) { this.limit = value; return this; }
public Integer getOffset() { return offset; }
public SearchMetadata setOffset(Integer value) { this.offset = value; return this; }
public Sorting getSort() { return sort; }
public SearchMetadata setSort(Sorting value) { this.sort = value; return this; }
public Filtering getFilter() { return filter; }
public SearchMetadata setFilter(Filtering value) { this.filter = value; return this; }
}
public static class Sorting
{
public String by = null;
public SortDirection direction = null;
public String getBy() { return by; }
public Sorting setBy(String value) { this.by = value; return this; }
public SortDirection getDirection() { return direction; }
public Sorting setDirection(SortDirection value) { this.direction = value; return this; }
}
public static enum SortDirection
{
Ascending,
Descending;
}
public static class Filtering
{
public ArrayList<String> fields = null;
public String search = null;
public ArrayList<String> getFields() { return fields; }
public Filtering setFields(ArrayList<String> value) { this.fields = value; return this; }
public String getSearch() { return search; }
public Filtering setSearch(String value) { this.search = value; return this; }
}
public static class SalaryPackageSummary implements IIdentifiableResource
{
public String customerId = null;
public String customerFirstName = null;
public String customerLastName = null;
public String employerName = null;
public String vehicleLicensePlate = null;
public BigDecimal salarySacrificeAmount = null;
public BigDecimal currentBalance = null;
public BigDecimal preTaxDeduction = null;
public BigDecimal postTaxDeduction = null;
public Integer leaseTerm = null;
public String employerId = null;
public String status = null;
public String id = null;
public String getCustomerId() { return customerId; }
public SalaryPackageSummary setCustomerId(String value) { this.customerId = value; return this; }
public String getCustomerFirstName() { return customerFirstName; }
public SalaryPackageSummary setCustomerFirstName(String value) { this.customerFirstName = value; return this; }
public String getCustomerLastName() { return customerLastName; }
public SalaryPackageSummary setCustomerLastName(String value) { this.customerLastName = value; return this; }
public String getEmployerName() { return employerName; }
public SalaryPackageSummary setEmployerName(String value) { this.employerName = value; return this; }
public String getVehicleLicensePlate() { return vehicleLicensePlate; }
public SalaryPackageSummary setVehicleLicensePlate(String value) { this.vehicleLicensePlate = value; return this; }
public BigDecimal getSalarySacrificeAmount() { return salarySacrificeAmount; }
public SalaryPackageSummary setSalarySacrificeAmount(BigDecimal value) { this.salarySacrificeAmount = value; return this; }
public BigDecimal getCurrentBalance() { return currentBalance; }
public SalaryPackageSummary setCurrentBalance(BigDecimal value) { this.currentBalance = value; return this; }
public BigDecimal getPreTaxDeduction() { return preTaxDeduction; }
public SalaryPackageSummary setPreTaxDeduction(BigDecimal value) { this.preTaxDeduction = value; return this; }
public BigDecimal getPostTaxDeduction() { return postTaxDeduction; }
public SalaryPackageSummary setPostTaxDeduction(BigDecimal value) { this.postTaxDeduction = value; return this; }
public Integer getLeaseTerm() { return leaseTerm; }
public SalaryPackageSummary setLeaseTerm(Integer value) { this.leaseTerm = value; return this; }
public String getEmployerId() { return employerId; }
public SalaryPackageSummary setEmployerId(String value) { this.employerId = value; return this; }
public String getStatus() { return status; }
public SalaryPackageSummary setStatus(String value) { this.status = value; return this; }
public String getId() { return id; }
public SalaryPackageSummary setId(String value) { this.id = value; return this; }
}
}
Java 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
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"}}}