Search Suburbs

Gets a list of suburbs that match the search term.

Request

GET https://api.yourpayroll.com.au/api/v2/ess/{employeeId}/lookup/suburbs

Path parameters

Parameter name Value Description Additional
employeeId string Required

Query parameters

Parameter name Value Description Additional
term string Required
pageNum int32
pageSize int32
countryId string

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 PagedResultModel<SuburbModel>