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

Positions accessible by the member

TotalCount

Integer

The total number of results in the collection. Can be larger than the number of returned results.

Page

Integer

The index of the current page of results (starts at 1).

PageSize

Integer

The number of results in the current page.

List

Collection of <PositionSummary> or null

A list of the results in the current page.

PositionId	Integer	The id of the position
PublishedState	String or null	The published state of the position
Title	String or null	The title of the position
OwnerMemberId	Integer	The id of the member who owns the position
OwnerCompanyId	Integer	The id of the company who owns the position
HasLiveListing	Boolean	If the position has a live listing
LatestListingStart	DateTime or null	The date time of the start of the latest listing
LatestListingEnd	DateTime or null	The date time of the end of the latest listing
IsArchived	Boolean	If the position has been archived
ListingCount	Integer	Count of the position listings on the position
LatestListingId	Integer or null	The listing id of the latest listing
TotalCandidateCount	Integer	The count of all candidates for the latest listing
NewCandidateCount	Integer	The count of new candidates for the latest listing
LatestListingVisitCount	Integer or null	Count of how many times the latest listing has been visited
LatestListingWatchCount	Integer or null	Count of how many times the latest listing has been added to a watchlist
AllowScoutAndViewCandidate	Boolean	Allow cout and view candidate

Counts

<PositionCounts> or null

Counts of positions

All	Integer	The total number of positions
Current	Integer	The total number of un-archived positions with current listings
Expired	Integer	The total number of un-archived positions without current listings
Archived	Integer	The total number of archived positions

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
  }
}