Website logo

Retrieve positions for a member

Retrieves paginated set of positions for a member or company

URL: https://api.trademe.co.nz/v1/Jobs/Positions.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
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.

Query String parameters

archived Boolean (optional)

Filter to include or exclude archived positions.
company_id Integer (optional)

Filter to retrieve the positions for a company.
current Boolean (optional)

Filter to include or exclude current positions.
page Integer (optional)

The page of results to return, defaults to 1.
rows Integer (optional)

The number of results to return, defaults to 20 with a max of 500.

Returns

<PositionsCollection>

Positions accessible by the member

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <PositionSummary> or null InnerList
PositionId Integer PositionId
PublishedState String or null PublishedState
Title String or null Title
OwnerMemberId Integer OwnerMemberId
OwnerCompanyId Integer OwnerCompanyId
HasLiveListing Boolean HasLiveListing
LatestListingStart DateTime or null LatestListingStart
LatestListingEnd DateTime or null LatestListingEnd
IsArchived Boolean IsArchived
ListingCount Integer ListingCount
LatestListingId Integer or null LatestListingId
TotalCandidateCount Integer TotalCandidateCount
NewCandidateCount Integer NewCandidateCount
LatestListingVisitCount Integer or null LatestListingVisitCount
LatestListingWatchCount Integer or null LatestListingWatchCount
AllowScoutAndViewCandidate Boolean AllowScoutAndViewCandidate
Counts <PositionCounts> or null Counts
All Integer All
Current Integer Current
Expired Integer Expired
Archived Integer Archived

Example XML Response (switch to JSON) 

<PositionsCollection xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <PositionSummary>
      <PositionId>123</PositionId>
      <PublishedState>ABC</PublishedState>
      <Title>ABC</Title>
      <OwnerMemberId>123</OwnerMemberId>
      <OwnerCompanyId>123</OwnerCompanyId>
      <HasLiveListing>false</HasLiveListing>
      <LatestListingStart>2018-01-01T00:00:00Z</LatestListingStart>
      <LatestListingEnd>2018-01-01T00:00:00Z</LatestListingEnd>
      <IsArchived>false</IsArchived>
      <ListingCount>123</ListingCount>
      <LatestListingId>123</LatestListingId>
      <TotalCandidateCount>123</TotalCandidateCount>
      <NewCandidateCount>123</NewCandidateCount>
      <LatestListingVisitCount>123</LatestListingVisitCount>
      <LatestListingWatchCount>123</LatestListingWatchCount>
      <AllowScoutAndViewCandidate>false</AllowScoutAndViewCandidate>
    </PositionSummary>
    <PositionSummary>
      <PositionId>123</PositionId>
      <PublishedState>ABC</PublishedState>
      <Title>ABC</Title>
      <OwnerMemberId>123</OwnerMemberId>
      <OwnerCompanyId>123</OwnerCompanyId>
      <HasLiveListing>false</HasLiveListing>
      <LatestListingStart>2018-01-01T00:00:00Z</LatestListingStart>
      <LatestListingEnd>2018-01-01T00:00:00Z</LatestListingEnd>
      <IsArchived>false</IsArchived>
      <ListingCount>123</ListingCount>
      <LatestListingId>123</LatestListingId>
      <TotalCandidateCount>123</TotalCandidateCount>
      <NewCandidateCount>123</NewCandidateCount>
      <LatestListingVisitCount>123</LatestListingVisitCount>
      <LatestListingWatchCount>123</LatestListingWatchCount>
      <AllowScoutAndViewCandidate>false</AllowScoutAndViewCandidate>
    </PositionSummary>
  </List>
  <Counts>
    <All>123</All>
    <Current>123</Current>
    <Expired>123</Expired>
    <Archived>123</Archived>
  </Counts>
</PositionsCollection>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "PositionId": 123,
      "PublishedState": "ABC",
      "Title": "ABC",
      "OwnerMemberId": 123,
      "OwnerCompanyId": 123,
      "HasLiveListing": false,
      "LatestListingStart": "\/Date(1514764800)\/",
      "LatestListingEnd": "\/Date(1514764800)\/",
      "IsArchived": false,
      "ListingCount": 123,
      "LatestListingId": 123,
      "TotalCandidateCount": 123,
      "NewCandidateCount": 123,
      "LatestListingVisitCount": 123,
      "LatestListingWatchCount": 123,
      "AllowScoutAndViewCandidate": false
    },
    {
      "PositionId": 123,
      "PublishedState": "ABC",
      "Title": "ABC",
      "OwnerMemberId": 123,
      "OwnerCompanyId": 123,
      "HasLiveListing": false,
      "LatestListingStart": "\/Date(1514764800)\/",
      "LatestListingEnd": "\/Date(1514764800)\/",
      "IsArchived": false,
      "ListingCount": 123,
      "LatestListingId": 123,
      "TotalCandidateCount": 123,
      "NewCandidateCount": 123,
      "LatestListingVisitCount": 123,
      "LatestListingWatchCount": 123,
      "AllowScoutAndViewCandidate": false
    }
  ],
  "Counts": {
    "All": 123,
    "Current": 123,
    "Expired": 123,
    "Archived": 123
  }
}