Please advise clients to contact Yardi technical support to obtain the add-on package to load your company name into the list of available third-party vendors in Voyager.  Clients will need to be on Voyager 7S with Interfaces Plugin v12 with ILS Guest Card PIv11 and Resident Data PIv6 or higher or 6008 baseline Interfaces Plug-in v21 with ILS Guest Card PIv7 and Resident Data PIv3.1.  The Yardi account manager can determine if the client has the correct Interfaces Plug-in version and assist them with implementation if needed.  Respage has been scheduled for release in a future Interfaces Plug-in.  At that time, the add-on package will not be required.

 

Next steps:

  1. Clients must request the vendor package to add Respage into their Voyager database until the plugin is released and they choose to upgrade to the version that contains the vendor package
  2. Clients can review/download the Interface Setup Guides posted on Client Central for detailed information on how to configure each interface
  3. Clients provide vendor with the access credentials needed to access and/or transfer data:
    1. Voyager URL (vendor appends the appropriate web service extension to the Voyager URL)
    2. Interface username and password
    3. Database name
    4. Server name (same as Database Name)
  4. Respage pulls additional configuration data using web methods (i.e. Configured Properties, Optional Parameters, etc.)   You will need to enable this endpoint / WebMethod.

 

The standard interfaces are only available in the Yardi Voyager 60 and Voyager 7S products.  Standard Interfaces are not supported in Yardi Breeze or Genesis products.


One final step....

You can review the instructions in the ILS Guest Card Interface Setup Guide posted on the development sandbox under Documents > Document Search.
 
It is a simple drop-down selection. Your Voyager user has access to this setting by going to Interfaces > Review Interface Vendors > (Interface Configuration) > ILS/Guest Card > Submit
 
Choose Respage and review the ILS Guest Card optional settings.

Make sure Schema Version is marked v4.0

Image Placeholder


* Maintenance API for Customers with Surveys

You will also need to provide us with the following:

Service Requests API Username
Password
Interface Entity Name


NOTE:  The user credentials may be the same with access to both Yardi APIs.

Also Note: The interface user’s security access has to be enabled per the instructions in the ILS Guest Card and/or Common Data Interfaces Setup Guides.  The error response “Access denied.  Web Service User does not have rights to this WebMethod.”  is a common configuration error. To ensure we do not receive this error please do the following:

For Common Data, these instructions are detailed on Pages 7-10 in the Common Data Interfaces Setup Guide. 

  1. Log into Voyager development sandbox
  2. Click on Roles > ILS Guest Card
  3. Click on Documents > Document Search
  4. Select Document Type = Voyager Interface Setup Guides and check Common/Resident Data  (or ILS Guest Card)
  5. Click Submit and Accept Terms and Conditions
  6. Review and/or Download the Document
Image Placeholder
7. Specific details for setting up Common Data/Resident Data web service access permissions begin on Page  (Creating the Interface Security Group and User). 
8. These same instructions apply to the ILS Guest Card API for which you also have a license and will need the permissions enabled.