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 .jsv suffix or ?format=jsv

HTTP + JSV

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}