SeasonSet.isInSeason

The isInSeason method returns a Boolean flag which indicates whether the input SeasonSet is in season.

Note This method will return all Season Sets which include a Season which is currently active. This method will not return any Season Sets which are currently off-season, even if that set includes a Season which will be active in the future.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

seasonSet: the SeasonSet object to query.

nowDate: the (optional) date to query. (Defaults to today.)

Output

return: an object of type Return that indicates the success or failure of the call.

inSeason: true if the SeasonSet is in season; false if it is not.

Returns

This method returns the codes listed in Standard Return Codes.

Example

# Given $my_ss, which we want to ask about:
$ss_factory = new SeasonSet();
$response = $ss_factory->isInSeason($my_ss);

// check $response

if($response['inSeason']) {

print "My Season Set has a Season that is in effect now.";

}

else {

print "My Season Set has no Season that is in effect now.";

}