Requires the role: | manager |
GET | /employers |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Employers;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;
using Application.Interfaces;
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 Address
{
public virtual string AddressLine1 { get; set; }
public virtual string AddressLine2 { get; set; }
public virtual string Suburb { get; set; }
public virtual string StateTerritory { get; set; }
public virtual string Postcode { get; set; }
}
public partial class BusinessDetails
{
public virtual string TradingName { get; set; }
public virtual string AustralianBusinessNumber { get; set; }
public virtual string AustralianCompanyNumber { get; set; }
}
public partial class Contact
{
public virtual string ContactName { get; set; }
public virtual string Email { get; set; }
public virtual string PhoneNumber { get; set; }
public virtual string PreferredContactMethod { get; set; }
}
public partial class Employer
: IIdentifiableResource
{
public virtual string Name { get; set; }
public virtual BusinessDetails BusinessDetails { get; set; }
public virtual Contact Contact { get; set; }
public virtual Address PostalAddress { get; set; }
public virtual Address PhysicalAddress { 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 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.Employers
{
public partial class SearchAllEmployersRequest
: SearchOperationTenanted<SearchAllEmployersResponse>
{
}
public partial class SearchAllEmployersResponse
{
public SearchAllEmployersResponse()
{
Employers = new List<Employer>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<Employer> Employers { get; set; }
public virtual SearchMetadata Metadata { get; set; }
}
}
C# SearchAllEmployersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK Content-Type: text/csv 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"}}}