Website logo

Get a suggested salary for the given listing details

This method is to retrieve a salary suggestion for the given listing details

URL: https://api.trademe.co.nz/v1/Jobs/Listings/SalarySuggestions.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: None
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

POST Data

<SalarySuggestionsRequest>

CategoryId Integer (required)

Category ID for the job listing
RegionId Integer (required)

Region Id for the job listing
DistrictId Integer (required)

District Id for the job listing
JobType String (required)

Job type of the job listing (FULL_TIME or PART_TIME)
ContractType String (required)

Contract type for the job listing (CONTRACT or PERMANENT)
Title String (required)

Title for the job listing
PayType String (optional)

Pay type of the job listing (HOURLY or SALARY)

Returns

<SalarySuggestionsResponse>

Success Boolean

Indicates whether the operation was successful.
BandHigher Integer

The upper bound of the recommended salary for the given position
BandLower Integer

The lower bound of the recommended salary for the given position
PayType String or null

The pay type of the recommended salary for the given position (e.g. SALARY or HOURLY)

Example XML Request (switch to JSON) 

<SalarySuggestionsRequest xmlns="http://api.trademe.co.nz/v1">
  <CategoryId>123</CategoryId>
  <RegionId>123</RegionId>
  <DistrictId>123</DistrictId>
  <JobType>ABC</JobType>
  <ContractType>ABC</ContractType>
  <Title>ABC</Title>
  <PayType>ABC</PayType>
</SalarySuggestionsRequest>

Example JSON Request (switch to XML) 

{
  "CategoryId": 123,
  "RegionId": 123,
  "DistrictId": 123,
  "JobType": "ABC",
  "ContractType": "ABC",
  "Title": "ABC",
  "PayType": "ABC"
}

Example XML Response (switch to JSON) 

<SalarySuggestionsResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <BandHigher>123</BandHigher>
  <BandLower>123</BandLower>
  <PayType>ABC</PayType>
</SalarySuggestionsResponse>

Example JSON Response (switch to XML) 

{
  "Success": false,
  "BandHigher": 123,
  "BandLower": 123,
  "PayType": "ABC"
}