locationSuggestions
QUERY

An array of suggested locations for the text provided in decreasing order of relevance.While a maximum of 20 locations can be requested, the current implementation does not return more than 10 recommendations.This query accepts browser tokens that include the query:ontologies scope.

Arguments

NameDescription
schemeId*
String!
The scheme ID of the location dataset to query.Currently, only seekAnz and seekAnzPublicTest are supported.
text*
String!
Hirer-provided text used for the location suggestions.This currently expects a substring of a location's name (e.g. a suburb or city name). Postcodes and street addresses are not supported.
usageTypeCode*
String!
The context that the location suggestions will be used in.Not all locations are accepted by all SEEK API operations. Specifying the correct usage type ensures the returned locations are valid in the context they're consumed.Currently two codes are defined:
first
Int
A non-negative limit to the number of locations to return.Defaults to 10.
hirerId
String
The identifier for the HiringOrganization used to provide location suggestions weighted by the hirer's SEEK-configured domicile.

Result

NameDescription
[LocationSuggestion!]
A suggested location.

Sample

GraphQL
CopyGraphQL Explorer
query ($schemeId: String!, $text: String!, $usageTypeCode: String!) {
  locationSuggestions(
    schemeId: $schemeId
    text: $text
    usageTypeCode: $usageTypeCode
  ) {
    location {
      id {
        value
      }
    }
  }
}