Web Services - Options

Saturday, Dec 1, 2018

Swagger Definition

Refer to the swagger file for a full definition

Standard Web Service

This web service requires a standard web services user. It may be used in client or server-side applications.

Multiple requests

The OptionType corresponds directly to the various types of Options you will see inside If you wish to search two types of Options all you need to do is include both in the request, eg:

$request['Options'] = array();
$request['Options']['OptionType'] = array();
$request['Options']['OptionType'][] = "Course Category";
$request['Options']['OptionType'][] = "Course Location";
$request['Options']['OptionSoapDetail'] = "Names";

Level of Detail

Requests for Options may be for:

  • Names only - this will return the Id, Name, Depth and Parent Id of each Option

  • All - this will also return the Form Id and the Form Content.


This request will only return Options:

  • That have a status of Active

  • That are related to a Course Date that is Scheduled, and is visible to the Public

  • Where the Course Date is attached to a Course Master that has a status of Active

Query Parameters

You may also add global query parameters to your request. These parameters will be applied to each part of your request.

  • OptionDepth Integer - how far down the Option Tree to search

  • Course Provider Integer - the Id of a Course Provider

  • Course Location Integer - the Id of a Course Location (All locations which have this Location on their branch will be included)

  • CourseDateDiscount Boolean - whether to include only discounted courses (determined by whether the Current Price is less than the Recommended Retail Price)

  • CourseDateDateFrom Date - d/m/y (returns Course Dates with a Start Date greater than or equal to the date provided)