Answerco - accurate, reference, knowledge, cross reference guide for computer supplies
Thursday, March 11, 2010
Frustrated Searching - A Cross Reference Solution Contact AnswerCo for Computer Supplies Cross Reference Contact AnswerCo for Ink & Toner Finder Find Compatibility Guide at AnswerCo Found Compatibility Guide for Printer Supplies
home - answerco cartridge cross reference customer login - cross reference entry order now - order cross reference guide news & resources - imaging industry company information - cross reference database contact us - cross reference needs testimonials - users of the cross reference guide solutions - ink & toner finder partners - ink & toner finder tools - super merchant searching
FREE trial offer! - printer cross reference guide

7 DAY FREE TRIAL
Enter email address to start searching:

AnswerCo Xrefengine XML Service Guide

Abstract

The AnswerCo Xrefengine XML Service provides an XML search engine to all the products in the AnswerCo reference database. The goal of this document is to help our valued partners understand the technical requirements of our XML over HTTP solution.

 

XrefEngine Sequence Diagram         Sample XML scripts

 

System Overview

AnswerCo Xrefengine XML Service provides an XML feed to all the products in AnswerCo reference database. It enables retailers capitalize on emerging business opportunities by providing behind-the-scenes, back end search engine to complement your company’s front-end sales and online marketing presence.

 

This project utilizes HTTP (Hypertext Transfer Protocol), a protocol that is designed to transfer information between computers over the World Wide Web. And XML (Extensible Markup Language), a markup language designed to describe data and to focus on what data is.

 

1. Requirements

In order to use the AnswerCo Xrefengine XML Service, you need to have a valid AnswerCo XML account with user id and password. And the ability to generate and parse XML documents using any programming or scripting language.

 

2. Installation

The service doesn’t require the installation of any product which makes it compatible with all Operating Systems and Web Application Servers.

 

3. Usage

Please note that the instructions below provide a general guidance on how to use the system. For specific programming language implementation, please consult your I.T. team.

 

In order to use the XML feed, partners will need to create an XML/HTTP client. This client will consist of scripts that generate the XML requests and parse the XML responses.

 

3.1 Generate XML request: The generated XML request document includes your company id, user id and password in the request header, and the query information in the request body. Send the request in an HTTP POST to the corresponding XML listener URL. The validity of the XML request document should be validated against the correspondent DTD document.

 

 

3.2 Parse XML response: Receive the XML response document and parse it to retrieve the requested products’ information.

 

Note

Each request / response below may or may not be included in your subscription.  Please refer to your purchase agreement for details of your licensed XML requests.

 

 

 

 

 

 

3.3 Types of Request

 

3.3.1 Search Products by Mfg, Model

Request Type

Search Products by Mfg Model

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByMfgModelListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request4.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <mfg>mfg</mfg>

   <model>model</model>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request4.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

  <mfg>mfg</mfg>

  <model>model</model>

  <desc>desc</desc>

  </product>

  </xml_response>

 

3.3.2 Search Products by Mfg, Model

Request Type

Search Products by Distinct Mfg Model

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByDistinctMfgModelListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request4.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <mfg>mfg</mfg>

    <model>model</model>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request4.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

  <mfg>mfg</mfg>

  <model>model</model>

  <desc>desc</desc>

  </product>

  </xml_response>

 

3.3.3 Search Products by Mfg, Model

Request Type

Search Products by Mfg Model Distinct by Engine

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByMfgModelDistinctByEngineListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request4.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <mfg>mfg</mfg>

    <model>model</model>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request4.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

  <mfg>mfg</mfg>

  <model>model</model>

  <engine>engine</engine>

  </product>

  </xml_response>

 

3.3.4 Search Part No. by Product Type

Request Type

Search Products by Engine (product type)

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByEngineListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request1.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <engine>engine</engine>

  </query_info> </xml_request>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request1.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

    <mfg>mfg</mfg>

    <engine>engine</engine>

    <oem>oem</oem>

    <yeld>yeld</yeld>

    <mfds>mfds</mfds>

  </product> 

  </xml_response>

 

3.3.5 Search Models by Product Type

Request Type

Search Models by Engine (product type)

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchModelsByEngineListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request1.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <engine>engine</engine>

  </query_info> </xml_request>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request1.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

    <mfg>mfg</mfg>

   <model>model</model>

   <desc>desc</desc>

  </product> 

  </xml_response>

 

3.3.6 Search Products by Mfg, Part No.

Request Type

Search Products by Mfg Part No.

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByMfgOemListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request3.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <oem>oem</oem>

    <mfg>mfg</mfg>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request3.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

    <mfg>mfg</mfg>

    <engine>engine</engine>

    <oem>oem</oem>

    <upc>upc<upc/>

    <yeld>yeld</yeld>

    <mfds>mfds</mfds>

  </product> 

  </xml_response>

 

3.3.7 Search Products by UPC

Request Type

Search Products by UPC

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByUpcListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request5.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <upc>upc</upc>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request5.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

    <mfg>mfg</mfg>

    <engine>engine</engine>

    <oem>oem</oem>

    <upc>upc<upc/>

    <yeld>yeld</yeld>

    <mfds>mfds</mfds>

  </product> 

  </xml_response>

 

3.3.8 Search Compatible Products by Mfg, Product Type

Request Type

Search Compatible Products by Engine Mfg

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchCompatibleProductsByEngineMfgListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request2.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <engine>engine</engine>

    <mfg>mfg</mfg>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request2.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

    <mfg>mfg</mfg>

    <engine>engine</engine>

    <oem>oem</oem>

    <yeld>yeld</yeld>

    <mfds>mfds</mfds>

  </product> 

  </xml_response>

 

3.3.9 Search OEM Products by Mfg, Product Type

Request Type

Search Oem Products by Engine Mfg

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchOemProductsByEngineMfgListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request2.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <engine>engine</engine>

    <mfg>mfg</mfg>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request2.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

    <mfg>mfg</mfg>

    <engine>engine</engine>

    <oem>oem</oem>

    <yeld>yeld</yeld>

    <mfds>mfds</mfds>

  </product> 

  </xml_response>

 

3.3.10 Search Products by Model, Product Type

Request Type

Search Products by Model Engine

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByModelEngineListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request6.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <engine>engine</engine>

    <model>model</model>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request6.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

   <mfg>mfg</mfg>

   <model>model</model>

   <engine>engine</engine>

   <desc>desc</desc>

  </product> 

  </xml_response>

 

3.3.11 Search Products by Mfg, Keyword

Request Type

Search Products by Mfg Keyword

HTTP Request Type

POST

XML Listener URL

http://xml.xrefengine.com/xml/SearchProductsByKeywordMfgListener

XML Request Format

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE xml_request SYSTEM "http://xml.xrefengine.com/dtd/request7.dtd">

<xml_request>

  <auth_info>

    <company_id>your company id</company_id>

    <user_id>your user id</user_id>

    <password>your password</password>

  </auth_info>

  <query_info>

    <keyword>keyword</keyword>

    <mfg>mfg</mfg>

  </query_info>

</xml_request>

XML Request DTD

http://xml.xrefengine.com/dtd/request7.dtd

XML Response Format

<?xml version="1.0" encoding="UTF-8" ?>

  <xml_response>

  <product>

    <mfg>mfg</mfg>

    <engine>engine</engine>

    <oem>oem</oem>

    <upc>upc</upc>

    <yeld>yeld</yeld>

    <mfds>mfds</mfds>

  </product> 

  </xml_response>

 
© Copyright AnswerCo. Ver. 3.86 Home Contact Us Site Map Blogs Affiliate Program FREE Trial