SeasonSet.update

The update method creates a new, or updates an existing SeasonSet object.

To create a SeasonSet object, initialize the object, set the values for its data members, and then call the update method to store the changes in the Vindicia database. Do not set a value for VID; CashBox automatically generates a VID when you call update(). When updating an existing SeasonSet object, identify it with either its VID or your SeasonSet ID (merchantSeasonSetId).

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 create or update. To update an existing SeasonSet object, identify it with either its VID or your SeasonSet ID (merchantSeasonSetId). If you specify a new value for merchantSeasonSetId, CashBox will create a new SeasonSet.

Output

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

seasonSet: the SeasonSet object that was created or updated.

created: returns true if a new object was created; false if an existing object was updated.

Returns

This method returns the codes listed in Standard Return Codes.

Example

$summer_ss = new SeasonSet();
$summer_ss->setMerchantSeasonSetId('Summers');

$s2013 = new Season();
$s2013->setStartDate('2013-06-22');
$s2013->setEndDate('2013-09-22');

$s2014 = new Season();
$s2014->setStartDate('2014-06-21');
$s2014->setEndDate('2014-09-20');

$summer_ss->setSeasons(array($s2013, $s2014));

$ss_factory = new SeasonSet();
$response = $ss_factory->update($summer_ss);

// check $response