Skip to content

Instantly share code, notes, and snippets.

@earth2marsh

earth2marsh/wadl.xml

Created June 21, 2012 18:44
Show Gist options
  • Save earth2marsh/2967692 to your computer and use it in GitHub Desktop.
Save earth2marsh/2967692 to your computer and use it in GitHub Desktop.
Download ZIP
Infogroup
Raw
wadl.xml
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:apigee="http://api.apigee.com/wadl/2010/07/"
xmlns="http://wadl.dev.java.net/2009/02"
xsi:schemaLocation="http://wadl.dev.java.net/2009/02 http://apigee.com/schemas/wadl-schema.xsd http://api.apigee.com/wadl/2010/07/ http://apigee.com/schemas/apigee-wadl-extensions.xsd">
<!-- Base defines the domain and base path of the endpoint -->
<resources base="https://api.infoconnect.com">
<!-- Companies -->
<resource path="v1/companies/{id}">
<param name="id" type="xsd:string" style="template" required="true">
<doc>A nine to ten digit Infogroup identification number. A number referencing the company assigned by Infogroup. This number will always refer to a single company and the reference will never change, unless the resource is permanently removed. Requesting a record by {id} will always return zero or one response.</doc>
</param>
<param name="resourcetype" type="xsd:string" style="query" default="basic" required="false">
<doc>Identifies the resource type for the response. The default value basic returns a base resource type that is valid across all methods; the resource type parameter is not needed to produce this response. To get a more detailed response set the resource type parameter to enhanced. To retrieve resources with Id's only, set the resource type parameter to core.</doc>
<option value="basic" />
<option value="enhanced" />
<option value="core" />
</param>
<param name="Content-Type" type="xsd:string" style="header" required="true" default="application/json">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="getCompany" name="GET" apigee:displayName="Get Company">
<apigee:tags>
<apigee:tag primary="true">Companies</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/companies/{id}" />
<doc apigee:url="http://developer.infoconnect.com/api/Companies/GET%2520Search-77">Retrieves details of the Company identified by the resource.</doc>
</method>
</resource>
<resource path="v1/companies">
<param name="resourcetype" type="xsd:string" style="query" default="basic" required="false">
<doc>Identifies the resource type for the response. The default value basic returns a base resource type that is valid across all methods; the resource type parameter is not needed to produce this response. To get a more detailed response set the resource type parameter to enhanced. To retrieve resources with Id's only, set the resource type parameter to core.</doc>
<option value="basic" />
<option value="enhanced" />
<option value="core" />
</param>
<param name="city" type="xsd:string" style="query" default="Omaha" required="false">
<doc>Filters through the Companies collection by city name.</doc>
</param>
<param name="companyname" type="xsd:string" style="query" default="ABC" required="false">
<doc>Filters through the Companies collection and returns resources by company name.</doc>
</param>
<param name="ein" type="xsd:string" style="query" default="521492843" required="false">
<doc>Filters through the Companies collection and returns resources with an Employer Identification Number (EIN).</doc>
</param>
<param name="email" type="xsd:string" style="query" default="[email protected]" required="false">
<doc>Filters through the Companies collection and returns resources with a case-insensitive email address match at the level.</doc>
</param>
<param name="firstname" type="xsd:string" style="query" default="bill" required="false">
<doc>Filters through the Companies collection by the primary contact's first name.</doc>
</param>
<param name="lastname" type="xsd:string" style="query" default="doe" required="false">
<doc>Filters through the Companies collection by the primary contact's last name.</doc>
</param>
<param name="phone" type="xsd:string" style="query" default="5558675309" required="false">
<doc>Filters through the Companies collection and returns resources with an ten-digit phone number match.</doc>
</param>
<param name="postalcode" type="xsd:string" style="query" default="68046" required="false">
<doc>Filters through the Companies collection by ZIP code or Postal code.</doc>
</param>
<param name="stateprovince" type="xsd:string" style="query" default="NE" required="false">
<doc>Filters through the Companies collection by State or Province abbreviation.</doc>
</param>
<param name="limit" type="xsd:integer" style="query" default="10" required="false">
<doc>Number of responses to return. If used, must be a number between 1 and 10. Default is 10.</doc>
</param>
<param name="offset" type="xsd:integer" style="query" default="0" required="false">
<doc>Number of responses to be skipped for generating the output. If used, must be a number between 0-100 minus limit. Default is 0.</doc>
</param>
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="getCompanies" name="GET" apigee:displayName="Get Companies">
<apigee:tags>
<apigee:tag primary="true">Companies</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/companies" />
<doc apigee:url="http://developer.infoconnect.com/api/Companies/GET%2520Search-77">Retrieves lists of companies.</doc>
</method>
</resource>
<resource path="v1/companies/search">
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="searchCompanies" name="POST" apigee:displayName="Search Companies">
<apigee:tags>
<apigee:tag primary="true">Companies</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/companies/search" />
<doc apigee:url="http://developer.infoconnect.com/api/Companies/POST%2520Search-76">Retrieves details of resources matching a given set of search fields that are submitted along with the request.</doc>
<request>
<representation mediaType="application/json">
<apigee:payload>
<![CDATA[{
"Phone":"4029303500",
"ResourceType":"Enhanced"
}]]>
</apigee:payload>
</representation>
</request>
</method>
</resource>
<resource path="v1/companies/counts">
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="countCompanies" name="POST" apigee:displayName="Count Companies">
<apigee:tags>
<apigee:tag primary="true">Companies</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/companies/counts" />
<doc apigee:url="http://developer.infoconnect.com/api/Companies/POST%2520Count-119">Retrieves counts on resources matching a given set of search fields that are submitted along with the request.</doc>
<request>
<representation mediaType="application/json">
<apigee:payload>
<![CDATA[{
"CompanyName":"ABC"
}]]>
</apigee:payload>
</representation>
</request>
</method>
</resource>
<!-- People -->
<resource path="v1/people/{id}">
<param name="id" type="xsd:string" style="template" required="true">
<doc>A twelve digit Infogroup identification number. A number referencing the individual assigned by Infogroup. This number will always refer to a single individual and the reference will never change, unless the resource is permanently removed. Requesting a record by {id} will always return zero or one response.</doc>
</param>
<param name="resourcetype" type="xsd:string" style="query" default="basic" required="false">
<doc>Identifies the resource type for the response. The default value basic returns a base resource type that is valid across all methods; the resource type parameter is not needed to produce this response. To get a more detailed response set the resource type parameter to enhanced. To retrieve resources with Id's only, set the resource type parameter to core. Additional ResourceTypes are Core, LifeStyle and TargetReady.</doc>
<option value="basic" />
<option value="enhanced" />
<option value="core" />
<option value="LifeStyle" />
<option value="TargetReady" />
</param>
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="getPerson" name="GET" apigee:displayName="Get Person">
<apigee:tags>
<apigee:tag primary="true">People</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/people/{id}" />
<doc apigee:url="http://developer.infoconnect.com/api/People/GET%2520Search-72">Retrieves details of the individual identified by the resource.</doc>
</method>
</resource>
<resource path="v1/people">
<param name="resourcetype" type="xsd:string" style="query" default="basic" required="false">
<doc>Identifies the resource type for the response. The default value basic returns a base resource type that is valid across all methods; the resource type parameter is not needed to produce this response. To get a more detailed response set the resource type parameter to enhanced. To retrieve resources with Id's only, set the resource type parameter to core. Additional ResourceTypes are Core, LifeStyle and TargetReady.</doc>
<option value="basic" />
<option value="enhanced" />
<option value="core" />
<option value="LifeStyle" />
<option value="TargetReady" />
</param>
<param name="city" type="xsd:string" style="query" default="Omaha" required="false">
<doc>Filters through the People collection by city name.</doc>
</param>
<param name="email" type="xsd:string" style="query" default="[email protected]" required="false">
<doc>Filters through the People collection and returns resources with a case-insensitive email address match at the level.</doc>
</param>
<param name="emailsha1upper" type="xsd:string" style="query" default="9d2972490f8c6a9a3a8e052d6050f9d3fde2e54d" required="false">
<doc>Filters through the People collection and returns resources with a case-insensitive email address match at the level. If used, must be a SHA1 hashed upper case email address.</doc>
</param>
<param name="includehistoricalemail" type="xsd:boolean" style="query" required="false">
<doc>IncludeHistoricalEmail can only be used in combination with Email or EmailSha1Upper. IncludeHistoricalEmail is used to retrieve historical records. Including this limits the ResourceType to Basic only. These records do not have an Id therefore cannot be used to return an Enhanced ResourceType. If used, must be True or False. Default is False.</doc>
</param>
<param name="firstname" type="xsd:string" style="query" default="bill" required="false">
<doc>Filters through the People collection by the primary contact's first name.</doc>
</param>
<param name="lastname" type="xsd:string" style="query" default="doe" required="false">
<doc>Filters through the People collection by the primary contact's last name.</doc>
</param>
<param name="phone" type="xsd:string" style="query" default="5558675309" required="false">
<doc>Filters through the People collection and returns resources with an ten-digit phone number match.</doc>
</param>
<param name="postalcode" type="xsd:string" style="query" default="68046" required="false">
<doc>Filters through the People collection by ZIP code or Postal code.</doc>
</param>
<param name="stateprovince" type="xsd:string" style="query" default="NE" required="false">
<doc>Filters through the People collection by State or Province abbreviation.</doc>
</param>
<param name="limit" type="xsd:integer" style="query" default="10" required="false">
<doc>Number of responses to return. If used, must be a number between 1 and 10. Default is 10.</doc>
</param>
<param name="offset" type="xsd:integer" style="query" default="0" required="false">
<doc>Number of responses to be skipped for generating the output. If used, must be a number between 0-100 minus limit. Default is 0.</doc>
</param>
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="getPeople" name="GET" apigee:displayName="Get People">
<apigee:tags>
<apigee:tag primary="true">People</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/people" />
<doc apigee:url="http://developer.infoconnect.com/api/People/GET%2520Search-72">Retrieves lists of people.</doc>
</method>
</resource>
<resource path="v1/people/search">
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="searchPeople" name="POST" apigee:displayName="Search People">
<apigee:tags>
<apigee:tag primary="true">People</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/people/search" />
<doc apigee:url="http://developer.infoconnect.com/api/People/POST%2520Search-78">Retrieves details of resources matching a given set of search fields that are submitted along with the request.</doc>
<request>
<representation mediaType="application/json">
<apigee:payload>
<![CDATA[{
"City":"Omaha",
"FirstName":"John",
"LastName":"Smith",
"StateProvince":"NE"
}]]>
</apigee:payload>
</representation>
</request>
</method>
</resource>
<resource path="v1/people/counts">
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="countPeople" name="POST" apigee:displayName="Count People">
<apigee:tags>
<apigee:tag primary="true">People</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/people/counts" />
<doc apigee:url="http://developer.infoconnect.com/api/People/POST%2520Count-120">Retrieves counts on resources matching a given set of search fields that are submitted along with the request.</doc>
<request>
<representation mediaType="application/json">
<apigee:payload>
<![CDATA[{
"Phone":"5558675309"
}]]>
</apigee:payload>
</representation>
</request>
</method>
</resource>
<!-- Match -->
<resource path="v3/match">
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="match" name="POST" apigee:displayName="Match">
<apigee:tags>
<apigee:tag primary="true">Match</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v3/match" />
<doc apigee:url="http://developer.infoconnect.com/api/Match/POST%2520Match-97">Matching and data append for partial name and address.</doc>
<request>
<representation mediaType="application/json">
<apigee:payload>
<![CDATA[{
"City":"Papillion",
"Confidence":"90",
"Country":"USA",
"Limit":"10",
"Name":"Infogroup",
"PostalCode":"68046",
"RequestType":"Company",
"ResourceType":"Basic",
"StateProvince":"NE"
}]]>
</apigee:payload>
</representation>
</request>
</method>
</resource>
<!-- Sics -->
<resource path="v1/sics/{id}">
<param name="id" type="xsd:string" style="template" required="true">
<doc>A two, four, or six numeric Standard Identification Classification (SIC) code.</doc>
</param>
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="getSic" name="GET" apigee:displayName="Get SIC">
<apigee:tags>
<apigee:tag primary="true">Sics</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/sics/{id}" />
<doc apigee:url="http://developer.infoconnect.com/api/Sics/GET%2520Sic-125">Retrieves details of Standard Identification Classification (SIC) code.</doc>
</method>
</resource>
<resource path="v1/sics">
<param name="keyword" type="xsd:string" style="query" default="barber" required="true">
<doc>By SIC description. Example "barber".</doc>
</param>
<param name="Content-Type" type="xsd:string" style="header" default="application/json" required="true">
<doc>The content type.</doc>
<option value="application/json" />
<option value="application/xml" />
</param>
<method id="getSics" name="GET" apigee:displayName="Get SICs">
<apigee:tags>
<apigee:tag primary="true">Sics</apigee:tag>
</apigee:tags>
<apigee:authentication required="true" />
<apigee:example url="v1/sics" />
<doc apigee:url="http://developer.infoconnect.com/api/Sics/GET%2520Sic-125">Retrieves details of Standard Identification Classification (SIC) code.</doc>
</method>
</resource>
</resources>
</application>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment