Data Extraction Process
API Call Sequence

Creating a Customer Profile Extraction

Content

Once you have completed your Data Extract Integration, you will need to complete Certification. The following instructions let you know what is required.

Access to Restaurants

Use: Get Current User to get the list of restaurants you have access to

Earliest Booking (Created Date)

Use: Get Earliest Booking Date to find out the first date in which bookings were made. This tells you when the first customer profile was created in the system.

The Initial Customer Pickup

Use:GET-api-ConsumerApi-v1-DataExtract-Restaurant-deploymentId-providerId-Customers_fromCreationDate (where fromCreationDate = Earliest Booking Date)

 

The Daily Process

Use: GET-api-ConsumerApi-v1-DataExtract-Restaurant-deploymentId-providerId-Customers_fromCreationDate (where fromCreationDate = the previous date which you last picked up customers) to pick up newly created customer records.

Use:GET-api-ConsumerApi-v1-DataExtract-Restaurant-deploymentId-providerId-CustomerChange-changeDate on a regular basis (where changeDate = the previous date which you last picked up customers) to pick up any changes to customer profile marketing related changes.

Note: All marketing related changes must be picked up and applied to the alternative record.

 

Reciprocal Data Exchange

Use: POST-api-ConsumerApi-v1-Restaurant-micrositeName-Customers-Unsubscribe to send customer opt out values to records originating in ResDiary that have become opted out in the alternative database.

Important Note: POST-api-ConsumerApi-v1-Restaurant-micrositeName-Customers-Unsubscribe requires (microsite) name as the key identifier of the restaurant while…

All data extraction api calls require (Depolyment_id) + (Provider_id) as the key identifier of the restaurant.  Integration sending unsubscribes will need to store all three values against their restaurant object.

Alternatively

Use: The MarketingPreferencesUrl found against the customer record to direct customers directly to the ResDiary Marketing Management page so that the information can flow directly into ResDiary and be picked up with the next round of customer changes.

 

Creating a booking-guest data extraction

Once you have completed your Data Extract Integration, you will need to complete Certification. The following instructions let you know what is required.

Access to Restaurants

Use: Get Current User to get the list of restaurants you have access to

 

Earliest Booking (Created Date)

Use: Get Earliest Booking Date to find out the first date in which bookings were made.

Use: Get Bookings to allow you to scroll through all dates from the earliest booking date up until now to get all bookings made on past dates.

Note: The API will return the bookings in their present state in the database.

 

The Daily Process

Use: Get Bookings on a daily basis

Use: Get Booking Changes to get the list of restaurants you have access to