Skip to main content
Vindicia Knowledge Center

RatePlan.fetchEventById

RatePlan.fetchEventById

RatePlan.fetchEventById

The fetchEventById method returns the Event for the input merchantEventId.

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.

merchantEventId: your Event ID (merchantEventId), which serves as the search criterion.

Output

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

event: the returned Event. (Optional.)

Returns

This method returns the codes listed in Standard Return Codes.

Example

$event = new Event;
$response = $event->fetchEventById('rating_129');

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

$fetchedEvent = $response['data']->event;
// process fetched event here

}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top