10. The month_options method

This method takes the same inputs as “date_time_options” and returns almost the same outputs, except for where a performance list would be returned where it only returns a list of months which contain valid performances. The intended use is that this call is made first, with the result being used to allow the user to select a month before selcting their performance. This increases the speed with which a performance may be selected by reducing the data that needs to be transferred.

10.1. Required inputs

These are the same as for “date_time_options” and that section may be used as a reference.

10.1.1. Example input

<month_options>
<user_id>demo</user_id>
<crypto_block>M_--qRfq64CDfM9Vj4JBQdRMdOJPW0xEpX1WsPqJY6Sy_X--q
-u7vOoeQH9kWHcDhhX0y1R6--Q5LYtL2zZeBLtUFtT8k2_EW3NjhoJBWdGhx6TV
_mcqVl1vM---Y</crypto_block>
<event_token>MQ2JX</event_token>
</month_options>

10.2. Output data

No crypto_block is produced at the output, as the intent is to provie data which will be used for a real subsequent call to “date_time_options”. For the most part, the output is identical to that for “date_time_options” with the exception of the contents of the elements conatined within a using_perf_list element. Instead of individual performances, instead “month” elements will be output. Each element describes a single month containing valid performances. The year is held in “year_number” and a numeric value for the month in “month_number”. Textual descriptions of the name of the month in the current language, in both short and long form, are to be found in the “short_month_name” and “long_month_name” elements. Finally two elements are provided to give the first and last date of the month. These are “earliest_date” and “latest_date”, and may be fed directly into date_time_options to restrict the data it returns.

10.2.1. Example output

<month_options_result>
<need_departure_date>no</need_departure_date>
<using_perf_list>

<month>
<year_number>2004</year_number>
<month_number>02</month_number>
<short_month_name>Feb</short_month_name>
<long_month_name>February</long_month_name>
<earliest_date>20040201</earliest_date>
<latest_date>20040229</latest_date>
</month>

<month>
<year_number>2004</year_number>
<month_number>03</month_number>
<short_month_name>Mar</short_month_name>
<long_month_name>March</long_month_name>
<earliest_date>20040301</earliest_date>
<latest_date>20040331</latest_date>
</month>

</using_perf_list>
</month_options_result>

10.3. Potential failure codes

This call may respond with any failure codes returned by “date_time_options” with the same meanings.