Billiecart API

SearchAllEmployersRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/employers

**SearchOperationTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
OrganisationId	form	string	No

**SearchOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required
Distinct	form	string	No
Limit	form	int?	No
Offset	form	int?	No
Sort	form	string	No
Filter	form	string	No
Search	form	string	No

**GetOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
Embed	form	string	No

**SearchAllEmployersResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Employers	form	List<Employer>	No
Metadata	form	SearchMetadata	No

**Employer** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
BusinessDetails	form	BusinessDetails	No
Contact	form	Contact	No
PostalAddress	form	Address	No
PhysicalAddress	form	Address	No
Id	form	string	No

**BusinessDetails** Parameters:
Name	Parameter	Data Type	Required
TradingName	form	string	No
AustralianBusinessNumber	form	string	No
AustralianCompanyNumber	form	string	No

**Contact** Parameters:
Name	Parameter	Data Type	Required
ContactName	form	string	No
Email	form	string	No
PhoneNumber	form	string	No
PreferredContactMethod	form	string	No

**Address** Parameters:
Name	Parameter	Data Type	Required
AddressLine1	form	string	No
AddressLine2	form	string	No
Suburb	form	string	No
StateTerritory	form	string	No
Postcode	form	string	No

**SearchMetadata** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
Limit	form	int	No
Offset	form	int	No
Sort	form	Sorting	No
Filter	form	Filtering	No

**Sorting** Parameters:
Name	Parameter	Data Type	Required	Description
By	form	string	No
Direction	form	SortDirection	No

**SortDirection** Enum:
Ascending
Descending

**Filtering** Parameters:
Name	Parameter	Data Type	Required	Description
Fields	form	List<string>	No
Search	form	string	No

**SearchAllEmployersResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Employers	form	List<Employer>	No
Metadata	form	SearchMetadata	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

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

<SearchAllEmployersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
  <Employers xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Employer>
      <d2p1:BusinessDetails>
        <d2p1:AustralianBusinessNumber>String</d2p1:AustralianBusinessNumber>
        <d2p1:AustralianCompanyNumber>String</d2p1:AustralianCompanyNumber>
        <d2p1:TradingName>String</d2p1:TradingName>
      </d2p1:BusinessDetails>
      <d2p1:Contact>
        <d2p1:ContactName>String</d2p1:ContactName>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
        <d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
      </d2p1:Contact>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PhysicalAddress>
        <d2p1:AddressLine1>String</d2p1:AddressLine1>
        <d2p1:AddressLine2>String</d2p1:AddressLine2>
        <d2p1:Postcode>String</d2p1:Postcode>
        <d2p1:StateTerritory>String</d2p1:StateTerritory>
        <d2p1:Suburb>String</d2p1:Suburb>
      </d2p1:PhysicalAddress>
      <d2p1:PostalAddress>
        <d2p1:AddressLine1>String</d2p1:AddressLine1>
        <d2p1:AddressLine2>String</d2p1:AddressLine2>
        <d2p1:Postcode>String</d2p1:Postcode>
        <d2p1:StateTerritory>String</d2p1:StateTerritory>
        <d2p1:Suburb>String</d2p1:Suburb>
      </d2p1:PostalAddress>
    </d2p1:Employer>
  </Employers>
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces">
    <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>
</SearchAllEmployersResponse>