Rapleaf - Data and People Lookup

Request URL

http://www.rapleaf.com/API/report_rating

Request Format

The method is invoked with an HTTP POST.

HTTP Headers

The request must contain the HTTP header:

Content-Type: application/xml

HTTP Body

Request parameters are sent as XML inside the HTTP body. Variables are indicated below as "#{variable_name}".

<request> 
    <API_key>#{your_API_key}</API_key> 
    <query> 
        <rating>#{rating}</rating> 
        <relationship>#{relationship}</relationship> 
        <comment>#{comment}</comment> 
        <target_email>#{target_email}</target_email>
        <rater_email>#{rater_email}</rater_email> 
        <rater_verified>#{rater_verified}<rater_verified> 
        <send_email>#{send_email}<send_email> 
        <transaction_id>#{transaction_id}<transaction_id>
    </query>
</request>

Parameter Descriptions

Parameter	Value	Description
API_key	(Required)	This is your API Key given to you by Rapleaf when granting access to the API. You can find your API Key here.
rating	"positive", "neutral", or "negative" (Required)	Ratings are scored with either positive, neutral, or negative.
relationship	"Buyer", "Seller", "Swapper", "Barterer", or "Friend" (Required)	Ratings are given as either Buyer, Seller, Swapper, Barterer, or Friend.
comment	(Required)	This field contains the text to accompany the rating. Comments are required for all ratings. Commerce ratings (those given by buyers, sellers, or swappers) must have at least 40 characters. Personal comments (those given by friends) do not have a minimum. All comments have a max of 1000 characters. All comments must be in plain text; HTML is not allowed.
target_email	(Required)	This field specifies the person being rated. One or more emails can be included. If multiple are provided, the emails must be separated with commas. If no email results in finding a profile, the first email in the list is used to create one.
rater_email	(Required)	This field identifies the person giving the rating. It is used to find the Rapleaf member with this email address. If no Rapleaf member is found, an account will be created to post this rating and an email will be sent to the rater from Rapleaf stating the rating came from your site and was added to Rapleaf.
rater_verified	0 or 1 (Required)	This field specifies whether or not the partner site has already verified the email address of the person giving the rating (this means that you have checked that an email address is valid and it belongs to the user). A zero denotes unverified. A "1" denotes that you have verified the email address.
send_email	"yes" or "no" (Optional)	This parameter specifies whether or not Rapleaf should send an email to the person being rated ("yes" causes Rapleaf to send an email). This email would communicate that the person has received a rating and give them a response URL they can use to respond. This response URL will be included in the response of this method call, so you may elect to send this URL to the ratee yourself.You may decide to send a note to the ratee yourself and elect that Rapleaf not send an email.
transaction_id	(Optional)	This is your identifier for the transaction that took place between the buyer and the seller. This will allow Rapleaf to tag the rating and for you to query for based on transaction_ids in the future.

Response

Response Format

Responses are formatted as XML. Variables are indicated below as "#{variable_name}".

<response>
    <status>#{status}</status>
    <profile_stats>
        <rapleaf_member>#{yes or no}</rapleaf_member>
        <score>#{score}</score>
        <friend_score>#{friend_score}</friend_score>
        <percentage>#{percentage}</percentage>
        <profile_URL>#{profile_URL}</profile_URL>
        <image_URL_main>#{image_URL_main}</image_URL_main>
        <image_URL_small>#{image_URL_small}</image_URL_small> 
    </profile_stats>
</response>

Response Variable Descriptions

Parameter	Description
status	Contains the result of the lookup. It will either be "success" or "failed" (see below for failure). On a "success", the information sent back will be in the other parameters
rapleaf_member	Says whether or not the person found is a Rapleaf member. It will either be "yes" or "no". "No" indicates that this person has not signed up for rapleaf.
score	the current Rapleaf Score of the owner of the profile. This will always be an integer (the minimum value is zero).
friend_score	the current personal score of the profile owner. This will always be an integer (the minimum value is zero).
percentage	the current positive feedback percentage for the profile owner. This will be a number with one digit after the decimal. For instance "89.3" would be a common response. You will never have a number less then zero or great than 100.
profile_URL	the URL of the profile on Rapleaf (so you can link back to the full detail on the Rapleaf site)
image_URL_main	the URL for the main Rapleaf icon (the "badge") image for the profile. The icon image displays the stats for the profile just as they are displayed on Rapleaf. If the person is not found on Rapleaf, a generic image will be sent back with the same size as the main image sent for a person with Rapleaf stats (see below).
image_URL_small	the URL for a smaller Rapleaf icon image for the profile. (We might change this image later to be more customized to your site). The icon image displays the stats for the profile just as they are displayed on Rapleaf. If the person is not found on Rapleaf, a generic image will be sent back with the same size as the smaller image sent for a person with Rapleaf stats (see below).

Errors

When an error occurs, an XML formatted message will be returned:

<response> 
  <status>failed</status> 
  <reason>#{error_message}</reason> 
</response>