Website logo

Retrieve a position

Retrieves a position

URL: https://api.trademe.co.nz/v1/Jobs/Positions/{positionId}.{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

positionId Integer (required)

The id of the position

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

Returns

<Position>

The position's details

PositionId Integer PositionId
PublishedState String or null PublishedState
Title String or null Title
DateCreated DateTime DateCreated
DateModified DateTime DateModified
DateArchived DateTime or null DateArchived
HasLiveListing Boolean HasLiveListing
TotalCandidates Integer TotalCandidates
Listings Collection of <PositionListingDetails> or null Listings
PositionListingId Integer PositionListingId
ListingId Integer or null ListingId
StartDate DateTime or null StartDate
EndDate DateTime or null EndDate
IsLive Boolean IsLive
IsAccessible Boolean IsAccessible
ShortDescription String or null ShortDescription
ReferenceId String or null ReferenceId
PayAndBenefits String or null PayAndBenefits
ContactDetails <PositionListingContactDetails> or null ContactDetails
ContactName String or null ContactName
PreferredApplicationMethod String or null PreferredApplicationMethod
EmailAddress String or null EmailAddress
ApplicationUrl String or null ApplicationUrl
PhoneNumbers Collection of <PhoneNumberDetails> or null PhoneNumbers
Prefix String or null Prefix
Number String or null Number
Descriptions Collection of <PositionListingDescription> or null Descriptions
Type String or null Type
Text String or null Text
Promotions <PositionListingPromotion> or null Promotions
BundleType Enumeration BundleType
None 0 None
Bronze 1 Bronze
Silver 2 Silver
Gold 3 Gold
Platinum 4 Platinum
Fifth 5 Fifth
Sixth 6 Sixth
PromotionData <PromotionData> or null PromotionData
Branding Collection of <PromotionBrandingItem> or null Branding
BrandingId Integer BrandingId
BrandingType String or null BrandingType
BrandingUri String or null BrandingUri
IsDeleted Boolean IsDeleted
BulletPoints Collection of String or null BulletPoints
CandidateAccessQuota Integer or null CandidateAccessQuota
EnabledPromotions Collection of Enumeration or null EnabledPromotions
Featured 1 Featured
Branded 2 Branded
SevenDayListing 3 SevenDayListing
BulletPoints 4 BulletPoints
CandidateDatabaseAccess 5 CandidateDatabaseAccess
Photos 6 Photos
Video 7 Video
PromotedListing 8 PromotedListing
PhotoIds Collection of Integer or null PhotoIds
PhotoDetails Collection of <PositionListingPhotoDetail> or null PhotoDetails
PhotoId Integer PhotoId
Urls <PositionListingPhotoUrls> or null Urls
Thumbnail String or null Thumbnail
List String or null List
Medium String or null Medium
Gallery String or null Gallery
Large String or null Large
FullSize String or null FullSize
PlusSize String or null PlusSize
TransformData <PositionListingPhotoTransformData> or null TransformData
SourcePhotoDetails <PositionListingSourcePhotoDetails> or null SourcePhotoDetails
PhotoId Integer PhotoId
Urls <PositionListingPhotoUrls> or null Urls
(This type has already been defined)
Dimensions <PositionListingPhotoDimensions> or null Dimensions
Width Integer Width
Height Integer Height
Rotation Integer Rotation
Crop <BoundingBox> or null Crop
Min <BoundingPoint> or null Min
X Integer X
Y Integer Y
Max <BoundingPoint> or null Max
(This type has already been defined)
Dimensions <PositionListingPhotoDimensions> or null Dimensions
(This type has already been defined)
Video <PositionListingVideoDetails> or null Video
VideoKey String or null VideoKey
Thumbnails Collection of <PositionListingVideoThumbnail> or null Thumbnails
Url String or null Url
Size String or null Size
Width Integer or null Width
Height Integer or null Height
SalaryOptIn Boolean SalaryOptIn
Stages Collection of <PositionStage> or null Stages
StageId Integer StageId
DisplayName String or null DisplayName
CandidateCount Integer CandidateCount
LatestListingVisitCount Integer or null LatestListingVisitCount
LatestListingWatchCount Integer or null LatestListingWatchCount
OwnerCompanyId Integer OwnerCompanyId
PositionCompanyName String or null PositionCompanyName
CategoryIds Collection of Integer or null CategoryIds
PayType String or null PayType
PayMin Number or null PayMin
PayMax Number or null PayMax
EmploymentDurationType String or null EmploymentDurationType
EmploymentType String or null EmploymentType
Self <Link> or null Self
Href String or null Href
Rel String or null Rel
Prompt String or null Prompt
Method String or null Method
Locations Collection of <PositionLocation> or null Locations
DistrictId Integer or null DistrictId
IsEntryLevel Boolean IsEntryLevel
IsWorkFromHome Boolean IsWorkFromHome

Example XML Response (switch to JSON)

<Position xmlns="http://api.trademe.co.nz/v1">
  <PositionId>123</PositionId>
  <PublishedState>ABC</PublishedState>
  <Title>ABC</Title>
  <DateCreated>2018-01-01T00:00:00Z</DateCreated>
  <DateModified>2018-01-01T00:00:00Z</DateModified>
  <DateArchived>2018-01-01T00:00:00Z</DateArchived>
  <HasLiveListing>false</HasLiveListing>
  <TotalCandidates>123</TotalCandidates>
  <Listings>
    <PositionListingDetails>
      <PositionListingId>123</PositionListingId>
      <ListingId>123</ListingId>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <IsLive>false</IsLive>
      <IsAccessible>false</IsAccessible>
      <ShortDescription>ABC</ShortDescription>
      <ReferenceId>ABC</ReferenceId>
      <PayAndBenefits>ABC</PayAndBenefits>
      <ContactDetails>
        <ContactName>ABC</ContactName>
        <PreferredApplicationMethod>ABC</PreferredApplicationMethod>
        <EmailAddress>ABC</EmailAddress>
        <ApplicationUrl>ABC</ApplicationUrl>
        <PhoneNumbers>
          <PhoneNumberDetails>
            <Prefix>ABC</Prefix>
            <Number>ABC</Number>
          </PhoneNumberDetails>
          <PhoneNumberDetails>
            <Prefix>ABC</Prefix>
            <Number>ABC</Number>
          </PhoneNumberDetails>
        </PhoneNumbers>
      </ContactDetails>
      <Descriptions>
        <PositionListingDescription>
          <Type>ABC</Type>
          <Text>ABC</Text>
        </PositionListingDescription>
        <PositionListingDescription>
          <Type>ABC</Type>
          <Text>ABC</Text>
        </PositionListingDescription>
      </Descriptions>
      <Promotions>
        <BundleType>None</BundleType>
        <PromotionData>
          <Branding>
            <PromotionBrandingItem>
              <BrandingId>123</BrandingId>
              <BrandingType>ABC</BrandingType>
              <BrandingUri>ABC</BrandingUri>
              <IsDeleted>false</IsDeleted>
            </PromotionBrandingItem>
            <PromotionBrandingItem>
              <BrandingId>123</BrandingId>
              <BrandingType>ABC</BrandingType>
              <BrandingUri>ABC</BrandingUri>
              <IsDeleted>false</IsDeleted>
            </PromotionBrandingItem>
          </Branding>
          <BulletPoints>
            <string>ABC</string>
            <string>ABC</string>
          </BulletPoints>
          <CandidateAccessQuota>123</CandidateAccessQuota>
        </PromotionData>
        <EnabledPromotions>
          <PromotionType>Featured</PromotionType>
          <PromotionType>Featured</PromotionType>
        </EnabledPromotions>
      </Promotions>
      <PhotoIds>
        <long>123</long>
        <long>123</long>
      </PhotoIds>
      <PhotoDetails>
        <PositionListingPhotoDetail>
          <PhotoId>123</PhotoId>
          <Urls>
            <Thumbnail>ABC</Thumbnail>
            <List>ABC</List>
            <Medium>ABC</Medium>
            <Gallery>ABC</Gallery>
            <Large>ABC</Large>
            <FullSize>ABC</FullSize>
            <PlusSize>ABC</PlusSize>
          </Urls>
          <TransformData>
            <SourcePhotoDetails>
              <PhotoId>123</PhotoId>
              <Urls />
              <Dimensions>
                <Width>123</Width>
                <Height>123</Height>
              </Dimensions>
            </SourcePhotoDetails>
            <Rotation>123</Rotation>
            <Crop>
              <Min>
                <X>123</X>
                <Y>123</Y>
              </Min>
              <Max />
            </Crop>
          </TransformData>
          <Dimensions />
        </PositionListingPhotoDetail>
        <PositionListingPhotoDetail>
          <PhotoId>123</PhotoId>
          <Urls>
            <Thumbnail>ABC</Thumbnail>
            <List>ABC</List>
            <Medium>ABC</Medium>
            <Gallery>ABC</Gallery>
            <Large>ABC</Large>
            <FullSize>ABC</FullSize>
            <PlusSize>ABC</PlusSize>
          </Urls>
          <TransformData>
            <SourcePhotoDetails>
              <PhotoId>123</PhotoId>
              <Urls />
              <Dimensions>
                <Width>123</Width>
                <Height>123</Height>
              </Dimensions>
            </SourcePhotoDetails>
            <Rotation>123</Rotation>
            <Crop>
              <Min>
                <X>123</X>
                <Y>123</Y>
              </Min>
              <Max />
            </Crop>
          </TransformData>
          <Dimensions />
        </PositionListingPhotoDetail>
      </PhotoDetails>
      <Video>
        <VideoKey>ABC</VideoKey>
        <Thumbnails>
          <PositionListingVideoThumbnail>
            <Url>ABC</Url>
            <Size>ABC</Size>
            <Width>123</Width>
            <Height>123</Height>
          </PositionListingVideoThumbnail>
          <PositionListingVideoThumbnail>
            <Url>ABC</Url>
            <Size>ABC</Size>
            <Width>123</Width>
            <Height>123</Height>
          </PositionListingVideoThumbnail>
        </Thumbnails>
      </Video>
      <SalaryOptIn>false</SalaryOptIn>
    </PositionListingDetails>
    <PositionListingDetails>
      <PositionListingId>123</PositionListingId>
      <ListingId>123</ListingId>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <IsLive>false</IsLive>
      <IsAccessible>false</IsAccessible>
      <ShortDescription>ABC</ShortDescription>
      <ReferenceId>ABC</ReferenceId>
      <PayAndBenefits>ABC</PayAndBenefits>
      <ContactDetails>
        <ContactName>ABC</ContactName>
        <PreferredApplicationMethod>ABC</PreferredApplicationMethod>
        <EmailAddress>ABC</EmailAddress>
        <ApplicationUrl>ABC</ApplicationUrl>
        <PhoneNumbers>
          <PhoneNumberDetails>
            <Prefix>ABC</Prefix>
            <Number>ABC</Number>
          </PhoneNumberDetails>
          <PhoneNumberDetails>
            <Prefix>ABC</Prefix>
            <Number>ABC</Number>
          </PhoneNumberDetails>
        </PhoneNumbers>
      </ContactDetails>
      <Descriptions>
        <PositionListingDescription>
          <Type>ABC</Type>
          <Text>ABC</Text>
        </PositionListingDescription>
        <PositionListingDescription>
          <Type>ABC</Type>
          <Text>ABC</Text>
        </PositionListingDescription>
      </Descriptions>
      <Promotions>
        <BundleType>None</BundleType>
        <PromotionData>
          <Branding>
            <PromotionBrandingItem>
              <BrandingId>123</BrandingId>
              <BrandingType>ABC</BrandingType>
              <BrandingUri>ABC</BrandingUri>
              <IsDeleted>false</IsDeleted>
            </PromotionBrandingItem>
            <PromotionBrandingItem>
              <BrandingId>123</BrandingId>
              <BrandingType>ABC</BrandingType>
              <BrandingUri>ABC</BrandingUri>
              <IsDeleted>false</IsDeleted>
            </PromotionBrandingItem>
          </Branding>
          <BulletPoints>
            <string>ABC</string>
            <string>ABC</string>
          </BulletPoints>
          <CandidateAccessQuota>123</CandidateAccessQuota>
        </PromotionData>
        <EnabledPromotions>
          <PromotionType>Featured</PromotionType>
          <PromotionType>Featured</PromotionType>
        </EnabledPromotions>
      </Promotions>
      <PhotoIds>
        <long>123</long>
        <long>123</long>
      </PhotoIds>
      <PhotoDetails>
        <PositionListingPhotoDetail>
          <PhotoId>123</PhotoId>
          <Urls>
            <Thumbnail>ABC</Thumbnail>
            <List>ABC</List>
            <Medium>ABC</Medium>
            <Gallery>ABC</Gallery>
            <Large>ABC</Large>
            <FullSize>ABC</FullSize>
            <PlusSize>ABC</PlusSize>
          </Urls>
          <TransformData>
            <SourcePhotoDetails>
              <PhotoId>123</PhotoId>
              <Urls />
              <Dimensions>
                <Width>123</Width>
                <Height>123</Height>
              </Dimensions>
            </SourcePhotoDetails>
            <Rotation>123</Rotation>
            <Crop>
              <Min>
                <X>123</X>
                <Y>123</Y>
              </Min>
              <Max />
            </Crop>
          </TransformData>
          <Dimensions />
        </PositionListingPhotoDetail>
        <PositionListingPhotoDetail>
          <PhotoId>123</PhotoId>
          <Urls>
            <Thumbnail>ABC</Thumbnail>
            <List>ABC</List>
            <Medium>ABC</Medium>
            <Gallery>ABC</Gallery>
            <Large>ABC</Large>
            <FullSize>ABC</FullSize>
            <PlusSize>ABC</PlusSize>
          </Urls>
          <TransformData>
            <SourcePhotoDetails>
              <PhotoId>123</PhotoId>
              <Urls />
              <Dimensions>
                <Width>123</Width>
                <Height>123</Height>
              </Dimensions>
            </SourcePhotoDetails>
            <Rotation>123</Rotation>
            <Crop>
              <Min>
                <X>123</X>
                <Y>123</Y>
              </Min>
              <Max />
            </Crop>
          </TransformData>
          <Dimensions />
        </PositionListingPhotoDetail>
      </PhotoDetails>
      <Video>
        <VideoKey>ABC</VideoKey>
        <Thumbnails>
          <PositionListingVideoThumbnail>
            <Url>ABC</Url>
            <Size>ABC</Size>
            <Width>123</Width>
            <Height>123</Height>
          </PositionListingVideoThumbnail>
          <PositionListingVideoThumbnail>
            <Url>ABC</Url>
            <Size>ABC</Size>
            <Width>123</Width>
            <Height>123</Height>
          </PositionListingVideoThumbnail>
        </Thumbnails>
      </Video>
      <SalaryOptIn>false</SalaryOptIn>
    </PositionListingDetails>
  </Listings>
  <Stages>
    <PositionStage>
      <StageId>123</StageId>
      <DisplayName>ABC</DisplayName>
      <CandidateCount>123</CandidateCount>
    </PositionStage>
    <PositionStage>
      <StageId>123</StageId>
      <DisplayName>ABC</DisplayName>
      <CandidateCount>123</CandidateCount>
    </PositionStage>
  </Stages>
  <LatestListingVisitCount>123</LatestListingVisitCount>
  <LatestListingWatchCount>123</LatestListingWatchCount>
  <OwnerCompanyId>123</OwnerCompanyId>
  <PositionCompanyName>ABC</PositionCompanyName>
  <CategoryIds>
    <int>123</int>
    <int>123</int>
  </CategoryIds>
  <PayType>ABC</PayType>
  <PayMin>123.0</PayMin>
  <PayMax>123.0</PayMax>
  <EmploymentDurationType>ABC</EmploymentDurationType>
  <EmploymentType>ABC</EmploymentType>
  <Self>
    <Href>ABC</Href>
    <Rel>ABC</Rel>
    <Prompt>ABC</Prompt>
    <Method>ABC</Method>
  </Self>
  <Locations>
    <PositionLocation>
      <DistrictId>123</DistrictId>
    </PositionLocation>
    <PositionLocation>
      <DistrictId>123</DistrictId>
    </PositionLocation>
  </Locations>
  <IsEntryLevel>false</IsEntryLevel>
  <IsWorkFromHome>false</IsWorkFromHome>
</Position>

Example JSON Response (switch to XML)

{
  "PositionId": 123,
  "PublishedState": "ABC",
  "Title": "ABC",
  "DateCreated": "\/Date(1514764800)\/",
  "DateModified": "\/Date(1514764800)\/",
  "DateArchived": "\/Date(1514764800)\/",
  "HasLiveListing": false,
  "TotalCandidates": 123,
  "Listings": [
    {
      "PositionListingId": 123,
      "ListingId": 123,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "IsLive": false,
      "IsAccessible": false,
      "ShortDescription": "ABC",
      "ReferenceId": "ABC",
      "PayAndBenefits": "ABC",
      "ContactDetails": {
        "ContactName": "ABC",
        "PreferredApplicationMethod": "ABC",
        "EmailAddress": "ABC",
        "ApplicationUrl": "ABC",
        "PhoneNumbers": [
          {
            "Prefix": "ABC",
            "Number": "ABC"
          },
          {
            "Prefix": "ABC",
            "Number": "ABC"
          }
        ]
      },
      "Descriptions": [
        {
          "Type": "ABC",
          "Text": "ABC"
        },
        {
          "Type": "ABC",
          "Text": "ABC"
        }
      ],
      "Promotions": {
        "BundleType": 0,
        "PromotionData": {
          "Branding": [
            {
              "BrandingId": 123,
              "BrandingType": "ABC",
              "BrandingUri": "ABC",
              "IsDeleted": false
            },
            {
              "BrandingId": 123,
              "BrandingType": "ABC",
              "BrandingUri": "ABC",
              "IsDeleted": false
            }
          ],
          "BulletPoints": [
            "ABC",
            "ABC"
          ],
          "CandidateAccessQuota": 123
        },
        "EnabledPromotions": [
          1,
          1
        ]
      },
      "PhotoIds": [
        123,
        123
      ],
      "PhotoDetails": [
        {
          "PhotoId": 123,
          "Urls": {
            "Thumbnail": "ABC",
            "List": "ABC",
            "Medium": "ABC",
            "Gallery": "ABC",
            "Large": "ABC",
            "FullSize": "ABC",
            "PlusSize": "ABC"
          },
          "TransformData": {
            "SourcePhotoDetails": {
              "PhotoId": 123,
              "Urls": {
              },
              "Dimensions": {
                "Width": 123,
                "Height": 123
              }
            },
            "Rotation": 123,
            "Crop": {
              "Min": {
                "X": 123,
                "Y": 123
              },
              "Max": {
              }
            }
          },
          "Dimensions": {
          }
        },
        {
          "PhotoId": 123,
          "Urls": {
            "Thumbnail": "ABC",
            "List": "ABC",
            "Medium": "ABC",
            "Gallery": "ABC",
            "Large": "ABC",
            "FullSize": "ABC",
            "PlusSize": "ABC"
          },
          "TransformData": {
            "SourcePhotoDetails": {
              "PhotoId": 123,
              "Urls": {
              },
              "Dimensions": {
                "Width": 123,
                "Height": 123
              }
            },
            "Rotation": 123,
            "Crop": {
              "Min": {
                "X": 123,
                "Y": 123
              },
              "Max": {
              }
            }
          },
          "Dimensions": {
          }
        }
      ],
      "Video": {
        "VideoKey": "ABC",
        "Thumbnails": [
          {
            "Url": "ABC",
            "Size": "ABC",
            "Width": 123,
            "Height": 123
          },
          {
            "Url": "ABC",
            "Size": "ABC",
            "Width": 123,
            "Height": 123
          }
        ]
      },
      "SalaryOptIn": false
    },
    {
      "PositionListingId": 123,
      "ListingId": 123,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "IsLive": false,
      "IsAccessible": false,
      "ShortDescription": "ABC",
      "ReferenceId": "ABC",
      "PayAndBenefits": "ABC",
      "ContactDetails": {
        "ContactName": "ABC",
        "PreferredApplicationMethod": "ABC",
        "EmailAddress": "ABC",
        "ApplicationUrl": "ABC",
        "PhoneNumbers": [
          {
            "Prefix": "ABC",
            "Number": "ABC"
          },
          {
            "Prefix": "ABC",
            "Number": "ABC"
          }
        ]
      },
      "Descriptions": [
        {
          "Type": "ABC",
          "Text": "ABC"
        },
        {
          "Type": "ABC",
          "Text": "ABC"
        }
      ],
      "Promotions": {
        "BundleType": 0,
        "PromotionData": {
          "Branding": [
            {
              "BrandingId": 123,
              "BrandingType": "ABC",
              "BrandingUri": "ABC",
              "IsDeleted": false
            },
            {
              "BrandingId": 123,
              "BrandingType": "ABC",
              "BrandingUri": "ABC",
              "IsDeleted": false
            }
          ],
          "BulletPoints": [
            "ABC",
            "ABC"
          ],
          "CandidateAccessQuota": 123
        },
        "EnabledPromotions": [
          1,
          1
        ]
      },
      "PhotoIds": [
        123,
        123
      ],
      "PhotoDetails": [
        {
          "PhotoId": 123,
          "Urls": {
            "Thumbnail": "ABC",
            "List": "ABC",
            "Medium": "ABC",
            "Gallery": "ABC",
            "Large": "ABC",
            "FullSize": "ABC",
            "PlusSize": "ABC"
          },
          "TransformData": {
            "SourcePhotoDetails": {
              "PhotoId": 123,
              "Urls": {
              },
              "Dimensions": {
                "Width": 123,
                "Height": 123
              }
            },
            "Rotation": 123,
            "Crop": {
              "Min": {
                "X": 123,
                "Y": 123
              },
              "Max": {
              }
            }
          },
          "Dimensions": {
          }
        },
        {
          "PhotoId": 123,
          "Urls": {
            "Thumbnail": "ABC",
            "List": "ABC",
            "Medium": "ABC",
            "Gallery": "ABC",
            "Large": "ABC",
            "FullSize": "ABC",
            "PlusSize": "ABC"
          },
          "TransformData": {
            "SourcePhotoDetails": {
              "PhotoId": 123,
              "Urls": {
              },
              "Dimensions": {
                "Width": 123,
                "Height": 123
              }
            },
            "Rotation": 123,
            "Crop": {
              "Min": {
                "X": 123,
                "Y": 123
              },
              "Max": {
              }
            }
          },
          "Dimensions": {
          }
        }
      ],
      "Video": {
        "VideoKey": "ABC",
        "Thumbnails": [
          {
            "Url": "ABC",
            "Size": "ABC",
            "Width": 123,
            "Height": 123
          },
          {
            "Url": "ABC",
            "Size": "ABC",
            "Width": 123,
            "Height": 123
          }
        ]
      },
      "SalaryOptIn": false
    }
  ],
  "Stages": [
    {
      "StageId": 123,
      "DisplayName": "ABC",
      "CandidateCount": 123
    },
    {
      "StageId": 123,
      "DisplayName": "ABC",
      "CandidateCount": 123
    }
  ],
  "LatestListingVisitCount": 123,
  "LatestListingWatchCount": 123,
  "OwnerCompanyId": 123,
  "PositionCompanyName": "ABC",
  "CategoryIds": [
    123,
    123
  ],
  "PayType": "ABC",
  "PayMin": 123.0,
  "PayMax": 123.0,
  "EmploymentDurationType": "ABC",
  "EmploymentType": "ABC",
  "Self": {
    "Href": "ABC",
    "Rel": "ABC",
    "Prompt": "ABC",
    "Method": "ABC"
  },
  "Locations": [
    {
      "DistrictId": 123
    },
    {
      "DistrictId": 123
    }
  ],
  "IsEntryLevel": false,
  "IsWorkFromHome": false
}