Skip to main content

The method allows to view or set additional options for each portal subscription:

  • PostDuration - a default, fixed posting duration for the board - this means you can, for example, allow users to post jobs for 1 week only.
    To obtain a list of particular portal's available durations, use the board-specific-fields webservice.
    This is not something that will work out-of-the-box inside the API - but it will on PCP.
  • CostPerPost - a price per post that you can use to display an estimation of your users' advert cost when they post.
  • AutoUnsubscribeDate - the date when the account will be automatically unsubscribed from the job board.
    Format is YYYY-MM-DD.
  • DefaultTeams - a comma-separated list of IDs identifying teams for which the portal will be chosen as a default (or required - see Forced below) posting destination.
    To obtain team IDs, use the list-teams webservice.
  • Forced - a boolean value deciding if the selected DefaultTeams should be forced to post to the portal (true) or not (false).
  • SectorFilter - a comma-separated list of IDs identifying job categories that are allowed to post to the board.
    To obtain a list of categories, refer to this article.

Parameters

No additional parameters.

Example - obtaining current setup

To view the current settings, just fire a GET request to the webservice.

Request​

GET https://ws.idibu.com/ws/rest/v1/portals/517/additional-options?hash=YOUR_HASH

Response​

<idibu generator="idibu" version="1.0">
	<response>
		<options>
			<option>
				<name>PostDuration</name>
				<value>1||7</value>
			</option>
			<option>
				<name>CostPerPost</name>
				<value>12.5</value>
			</option>
			<option>
				<name>AutoUnsubscribeDate</name>
				<value>2018-05-26</value>
			</option>
			<option>
				<name>DefaultTeams</name>
				<value>2000748,2001250</value>
			</option>
			<option>
				<name>Forced</name>
				<value>false</value>
			</option>
			<option>
				<name>SectorFilter</name>
				<value>1,3,4</value>
			</option>
		</options>
	</response>
	<status>success</status>
</idibu>

Example - editing the options

To edit or set the options, fire a POST request with an appropriate XML (see below) inside the data parameter.

Request​

POST https://ws.idibu.com/ws/rest/v1/portals/517/additional-options?hash=YOUR_HASH
<?xml version="1.0" encoding="utf8"?>
<idibu generator="idibu" version="1.0">
	<options>
		<option>
			<name>PostDuration</name>
			<value>1</value>
		</option>
		<option>
			<name>CostPerPost</name>
			<value>9</value>
		</option>
		<option>
			<name>AutoUnsubscribeDate</name>
			<value>2018-05-26</value>
		</option>
		<option>
			<name>DefaultTeams</name>
			<value>2000748,2000749</value>
		</option>
		<option>
			<name>Forced</name>
			<value>true</value>
		</option>
		<option>
			<name>SectorFilter</name>
			<value>1,4,2806</value>
		</option>
	</options>
</idibu>

Response​

<?xml version="1.0" encoding="UTF-8"?>
<idibu generator="idibu" version="1.0">
	<response>
		<message>Updated portal additional options</message>
	</response>
	<status>success</status>
</idibu>