| Requires the role: | manager |
| GET | /employers |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class SearchAllEmployersRequest extends SearchOperationTenanted<SearchAllEmployersResponse>
{
}
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 SearchAllEmployersResponse
{
public ResponseStatus responseStatus = null;
public ArrayList<Employer> employers = null;
public SearchMetadata metadata = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public SearchAllEmployersResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public ArrayList<Employer> getEmployers() { return employers; }
public SearchAllEmployersResponse setEmployers(ArrayList<Employer> value) { this.employers = value; return this; }
public SearchMetadata getMetadata() { return metadata; }
public SearchAllEmployersResponse setMetadata(SearchMetadata value) { this.metadata = value; return this; }
}
public static class Employer implements IIdentifiableResource
{
public String name = null;
public BusinessDetails businessDetails = null;
public Contact contact = null;
public Address postalAddress = null;
public Address physicalAddress = null;
public String id = null;
public String getName() { return name; }
public Employer setName(String value) { this.name = value; return this; }
public BusinessDetails getBusinessDetails() { return businessDetails; }
public Employer setBusinessDetails(BusinessDetails value) { this.businessDetails = value; return this; }
public Contact getContact() { return contact; }
public Employer setContact(Contact value) { this.contact = value; return this; }
public Address getPostalAddress() { return postalAddress; }
public Employer setPostalAddress(Address value) { this.postalAddress = value; return this; }
public Address getPhysicalAddress() { return physicalAddress; }
public Employer setPhysicalAddress(Address value) { this.physicalAddress = value; return this; }
public String getId() { return id; }
public Employer setId(String value) { this.id = value; return this; }
}
public static class BusinessDetails
{
public String tradingName = null;
public String australianBusinessNumber = null;
public String australianCompanyNumber = null;
public String getTradingName() { return tradingName; }
public BusinessDetails setTradingName(String value) { this.tradingName = value; return this; }
public String getAustralianBusinessNumber() { return australianBusinessNumber; }
public BusinessDetails setAustralianBusinessNumber(String value) { this.australianBusinessNumber = value; return this; }
public String getAustralianCompanyNumber() { return australianCompanyNumber; }
public BusinessDetails setAustralianCompanyNumber(String value) { this.australianCompanyNumber = value; return this; }
}
public static class Contact
{
public String contactName = null;
public String email = null;
public String phoneNumber = null;
public String preferredContactMethod = null;
public String getContactName() { return contactName; }
public Contact setContactName(String value) { this.contactName = value; return this; }
public String getEmail() { return email; }
public Contact setEmail(String value) { this.email = value; return this; }
public String getPhoneNumber() { return phoneNumber; }
public Contact setPhoneNumber(String value) { this.phoneNumber = value; return this; }
public String getPreferredContactMethod() { return preferredContactMethod; }
public Contact setPreferredContactMethod(String value) { this.preferredContactMethod = value; return this; }
}
public static class Address
{
public String addressLine1 = null;
public String addressLine2 = null;
public String suburb = null;
public String stateTerritory = null;
public String postcode = null;
public String getAddressLine1() { return addressLine1; }
public Address setAddressLine1(String value) { this.addressLine1 = value; return this; }
public String getAddressLine2() { return addressLine2; }
public Address setAddressLine2(String value) { this.addressLine2 = value; return this; }
public String getSuburb() { return suburb; }
public Address setSuburb(String value) { this.suburb = value; return this; }
public String getStateTerritory() { return stateTerritory; }
public Address setStateTerritory(String value) { this.stateTerritory = value; return this; }
public String getPostcode() { return postcode; }
public Address setPostcode(String value) { this.postcode = 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; }
}
}
Java SearchAllEmployersRequest 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 /employers 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"}},"employers":[{"name":"String","businessDetails":{"tradingName":"String","australianBusinessNumber":"String","australianCompanyNumber":"String"},"contact":{"contactName":"String","email":"String","phoneNumber":"String","preferredContactMethod":"String"},"postalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"physicalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}