RESPOND RFQ INTAKE
PING POST API
VERSION 2.0
FOR
Annuities
ID: 605060000

Table of Contents

POST API

Description

This document will describe what is necessary to utilize the functionality of the RFQ INTAKE HTTP POST API. Each API call will be broken into description, format and return sections. The description will define the API point. The format will define the data structure of the API call. The return section will define how to determine if the API call was successful or not and some information in the case of an error condition.

Each RFQ API point will be executed via an HTTP or HTTPS POST to the following URL: http://www.respond.com/api/rfq/processlead.jsp OR a partner specific domain alias version of the URL. For example, if my domain alias was http://partnername.respond.com, I could use the following URL to "call" the API point: http://partnername.respond.com/api/rfq/processlead.jsp.

A response to the API call will be rooted with the same rfqapi element with a method attribute of "return". This will provide the result feedback to the calling entity. When appropriate, errors and warnings with detailed reasons will be returned to assist the caller in adjusting the data delivered initially. The caller can assume that if an error is returned for a method performed on a specific transaction, then the intended action was not performed. It is an all or nothing paradigm.

Production url
http://www.respond.com/api/rfq/processlead.jsp

Staging url
http://stagingprod.respond.com/api/rfq/processlead.jsp

Both post and get works

Security

With the release of the 1.0 RFQ INTAKE HTTP POST API, additional security procedures will be required for a partner to integrate with Respond’s RFQ account management system. The partner will be required to setup by their account manager to be able to post leads via this API. are defined in bold. An explanation of each element and attribute is given in the far right hand column.

How to use this guide

There are two parts to this api.

1. The buyer contact information ? common for all categories
2. Specific questions for the category

String formulation to post

Description

Query String Format

firstnm=name&sendzip=22031&Q1405156628=53547&Q1405156628=53549&Q1405156628=53554&Q1405156628=53546&Q1405155600monthyear=12|2006&cat=1800000760&src=11&comments=test&Q1405156090=50961&Q1405158907=66602&Q1405157409=6:30 am&Q1405157408=6:30 am&lastnm=lastname&hphone=2594000&Q1405155600day=02&sendstate=VA&email=someemail@email.com&release=P&sendcity=Fairfax&hsuffix=9251&besttime=A&harea=703&acceptedterms=Y&Q1405163432=121112&Q2000006740=78402&Q2000006741=78404&proximity=P

Each name and value needs to be URLEncoded. Ensure that ?,=,& are not encoded outside the name and values.

If there are multiple values accepted for a question, they need to be passed in as Q1=A1&Q1=A2&Q1=A3

Receiving output back

Returns

<?xml version="1.0" encoding="UTF-8"?>
<!-- (c) 2006 Respond.com, Inc. All Rights Reserved. -->
<rfqapi method="return" version="1.0">
<request-api-intake status="success">
	<email>gupta2@teoco.com</email>
	<requestid>1015044</requestid>
</request-api-intake>

<?xml version="1.0" encoding="UTF-8"?>
<!-- (c) 2006 Respond.com, Inc. All Rights Reserved. -->
<rfqapi method="return" version="1.0">
<request-api-intake status="error">
	<error-list>
		<error>
			<param>Q1405155600</param>
			<msg>
				<b>Wedding Date:</b> is a required field.
			</msg>
		</error>
		<error>
			<param>Q1405157408</param>
			<msg>
				<b>Start Time:</b> is a required field.
			</msg>
		</error>
		<error>
			<param>email</param>
			<msg>Email Address is a required field.</msg>
		</error>
		<error>
			<param>lastnm</param>
			<msg>
				<b>Last Name:</b>
				is a required field.
			</msg>
		</error>
	</error-list>
</request-api-intake>

PING API

Summary

Respond?s Ping/Post Lead Exchange provides a real-time process for buying and selling leads across our entire network. If you operate in a single vertical or in several vertical markets, your business has only a single set of integration specifications that you need to integrate.

Currently, Respond only buys and sells exclusive leads within our network. An exclusive lead is defined as a lead that is sold to a single buyer. Respond will not compensate partners for leads that are discovered to be sold more than once to our network

Description

This document will describe what is necessary to utilize the functionality of the PING POST API.

Each PING POST will be executed via an HTTP POST to the following URL: http://www.respond.com/api/rfq/pingpost.jsp

For security purposes, IP address range of the computers performing the ping post will be requested from partners.

A response to the API call will be rooted with pingpostapi element with a method attribute of ?return?. This will provide the result feedback to the calling entity. When appropriate, errors and warnings with detailed reasons will be returned to assist the caller in adjusting the data delivered initially. The caller can assume that if an error is returned for a method performed on a specific transaction, then the intended action was not performed. It is an all or nothing paradigm.

String formulation to post

Description

Query String Format

zip=22031&partnercat=1800000760&partnerid=11&Q1405162054=70062&Q200558=77057

Example call: http://www.respond.com/api/rfq/pingpost.jsp?zip=22031&partnercat=1800000760&partnerid=11&Q1405162054=70062&Q200558=77057

Note: partnerid will be provided to partners willing to use PING POST API.

If there are multiple values accepted for a question, they need to be passed in as Q1=A1&Q1=A2&Q1=A3

Receiving output back

Returns

<?xml version="1.0" encoding="UTF-8"?>
<!-- (c) 2012 Respond.com, Inc. All Rights Reserved. -->
<pingpostapi method="return" version="1.0">
  <pingpost status="success">
    <service-providers-available>Yes</service-providers-available>
  </pingpost>
</pingpostapi>

<?xml version="1.0" encoding="UTF-8"?>
<!-- (c) 2012 Respond.com, Inc. All Rights Reserved. -->
<pingpostapi method="return" version="1.0">
  <pingpost status="success">
    <service-providers-available>No</service-providers-available>
  </pingpost>
</pingpostapi>

<?xml version="1.0" encoding="UTF-8" ?>
<!-- (c) 2008 Respond.com, Inc. All Rights Reserved.   -->
<pingpostapi method="return" version="1.0">
  <pingpost status="error">
    <error-list>
      <error>
        <param>zip</param>
        <msg>You must provide a valid ZIP/Postal Code or a valid City/State combination.</msg>
      </error>

      <error>
        <param>partnercat</param>
        <msg>Invalid category.</msg>
      </error>
    </error-list>
  </pingpost>
</pingpostapi>