Get position packages

Returns a set of position package tiers

URL:	https://api.trademe.co.nz/v1/Jobs/Catalogue/PositionPackages.{file_format}
HTTP Method:	GET
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.

Query String parameters

category_id	Integer (optional)	Used to determine pricing based on category if applicable
position_id	Integer (optional)	Used when editing a position to ensure you get the version of package data included when the position was created
return_metadata	Boolean (optional)	Should be provided if we want to return metadata about the PackageSetVersion
skip_current_agent	Boolean (optional)	Used when want to get all packages tiers as an anonymous member

Returns

PackageSetVersionMetadata

<PackageSetVersionMetadata> or null

PackageSetVersionMetadata

PackageSetVersionId	Integer	PackageSetVersionId

PackageData

Collection of <PackageData> or null

PackageData

Tier

Enumeration

Tier

None	0	None
Bronze	1	Bronze
Silver	2	Silver
Gold	3	Gold
Platinum	4	Platinum
Fifth	5	Fifth
Sixth	6	Sixth

DisplayName

String or null

DisplayName

PriceGstExcluded

Number

PriceGstExcluded

PriceGstIncluded

Number

PriceGstIncluded

HighlightFlagValue

String or null

HighlightFlagValue

Featured

Boolean

Featured

AllowsBranding

Boolean

AllowsBranding

AllowsPhotos

Boolean

AllowsPhotos

AllowsVideo

Boolean

AllowsVideo

AllowsPromotedListing

Boolean

AllowsPromotedListing

DurationDays

Integer

DurationDays

CandidateSearchQuotaAdded

Integer

CandidateSearchQuotaAdded

ProvidingSource

<FeeItemProvidingSource> or null

ProvidingSource

Name	String or null	Name
Remaining	Integer	Remaining
IsUnlimited	Boolean	IsUnlimited

GroupName

String or null

GroupName

Example XML Response (switch to JSON)

<PositionPackageResponse xmlns="http://api.trademe.co.nz/v1">
  <PackageSetVersionMetadata>
    <PackageSetVersionId>123</PackageSetVersionId>
  </PackageSetVersionMetadata>
  <PackageData>
    <PackageData>
      <Tier>None</Tier>
      <DisplayName>ABC</DisplayName>
      <PriceGstExcluded>123.0</PriceGstExcluded>
      <PriceGstIncluded>123.0</PriceGstIncluded>
      <HighlightFlagValue>ABC</HighlightFlagValue>
      <Featured>false</Featured>
      <AllowsBranding>false</AllowsBranding>
      <AllowsPhotos>false</AllowsPhotos>
      <AllowsVideo>false</AllowsVideo>
      <AllowsPromotedListing>false</AllowsPromotedListing>
      <DurationDays>123</DurationDays>
      <CandidateSearchQuotaAdded>123</CandidateSearchQuotaAdded>
      <ProvidingSource>
        <Name>ABC</Name>
        <Remaining>123</Remaining>
        <IsUnlimited>false</IsUnlimited>
      </ProvidingSource>
      <GroupName>ABC</GroupName>
    </PackageData>
    <PackageData>
      <Tier>None</Tier>
      <DisplayName>ABC</DisplayName>
      <PriceGstExcluded>123.0</PriceGstExcluded>
      <PriceGstIncluded>123.0</PriceGstIncluded>
      <HighlightFlagValue>ABC</HighlightFlagValue>
      <Featured>false</Featured>
      <AllowsBranding>false</AllowsBranding>
      <AllowsPhotos>false</AllowsPhotos>
      <AllowsVideo>false</AllowsVideo>
      <AllowsPromotedListing>false</AllowsPromotedListing>
      <DurationDays>123</DurationDays>
      <CandidateSearchQuotaAdded>123</CandidateSearchQuotaAdded>
      <ProvidingSource>
        <Name>ABC</Name>
        <Remaining>123</Remaining>
        <IsUnlimited>false</IsUnlimited>
      </ProvidingSource>
      <GroupName>ABC</GroupName>
    </PackageData>
  </PackageData>
</PositionPackageResponse>

Example JSON Response (switch to XML)

{
  "PackageSetVersionMetadata": {
    "PackageSetVersionId": 123
  },
  "PackageData": [
    {
      "Tier": 0,
      "DisplayName": "ABC",
      "PriceGstExcluded": 123.0,
      "PriceGstIncluded": 123.0,
      "HighlightFlagValue": "ABC",
      "Featured": false,
      "AllowsBranding": false,
      "AllowsPhotos": false,
      "AllowsVideo": false,
      "AllowsPromotedListing": false,
      "DurationDays": 123,
      "CandidateSearchQuotaAdded": 123,
      "ProvidingSource": {
        "Name": "ABC",
        "Remaining": 123,
        "IsUnlimited": false
      },
      "GroupName": "ABC"
    },
    {
      "Tier": 0,
      "DisplayName": "ABC",
      "PriceGstExcluded": 123.0,
      "PriceGstIncluded": 123.0,
      "HighlightFlagValue": "ABC",
      "Featured": false,
      "AllowsBranding": false,
      "AllowsPhotos": false,
      "AllowsVideo": false,
      "AllowsPromotedListing": false,
      "DurationDays": 123,
      "CandidateSearchQuotaAdded": 123,
      "ProvidingSource": {
        "Name": "ABC",
        "Remaining": 123,
        "IsUnlimited": false
      },
      "GroupName": "ABC"
    }
  ]
}