RatePlan.fetchByVid

The fetchByVid method fetches an existing RatePlan by its VID.

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.

vid: the Vindicia ID for the RatePlan you wish to fetch.

Output

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

ratePlan: the returned RatePlan. (Optional.)

Returns

This method returns the codes listed in Standard Return Codes.

Example

$rateplan = new RatePlan;
$response =

$rateplan->fetchByVid('2a99928a749ac05cdc8041aee3cacedcb4b6962e');

if ($response['returnCode'] == 200) {

fetchedRatePlan = $response['data']->ratePlan;

// process fetched RatePlan here

}

// check $response