PrintRequiredEUI

RequiredEUI Submit DTD

To obtain a list of required End User Information for purchase of requested products, submit document via an HTTPS post. The following DTD defines the RequiredEUI  Submit message:
<!ELEMENT XML_RequiredEUI_Submit (
        Header ,
        Detail ) >

    <!ELEMENT     Header (
                  UserName,
                  Password,
                  TransControlID,
                  ResponseVersion? ) >

        <!ELEMENT UserName          (#PCDATA) >
        <!ELEMENT Password          (#PCDATA) >
        <!ELEMENT TransControlID    (#PCDATA) >
        <!ELEMENT ResponseVersion   (#PCDATA) >

    	<!ELEMENT Detail (
		OrderLevel? ,
        	LineInfo+ ) >

	<!ELEMENT OrderLevel        (#PCDATA) >
        <!ELEMENT LineInfo (
                  RefIDQual ,
                  RefID ) >

        <!ELEMENT RefIDQual         (#PCDATA) >
        <!ELEMENT RefID             (#PCDATA) >

Following is an example of a RequiredEUI submit message with the element contents shown in bold:
<XML_RequiredEUI_Submit>
  <Header>
    <UserName>INSERT_ID_HERE</UserName>
    <Password>INSERT_PASSWORD_HERE</Password>
    <TransControlID>123456</TransControlID>
    <ResponseVersion>1.0</ResponseVersion>
  </Header>
  <Detail>
    <LineInfo>
      <RefIDQual>VP</RefIDQual>
      <RefID>10046310</RefID>
    </LineInfo>
  </Detail>
</XML_RequiredEUI_Submit>

RequiredEUI Submit Data Fields

The following table provides a detail description of each element defined in the XML_RequiredEUI_Submit.dtd.

Element Name
Optional
Required
Description
Data
Type
Max Len
Header R      
UserName R EC logon ID assigned by Tech Data A/N Note 1
Password R Password assigned by Tech Data A/N Note 1
TransControlID O Unique tracking identifier assigned by the customer for each Price and Availability document submitted A/N 100
ResponseVersion O Designates the Response DTD version that will be returned.
  • If omitted, the oldest supported Response DTD version is returned
  • In order to receive the latest functionality, you should specify the “highest” available (newest) Response DTD version number
  • Using older version numbers will generate legacy Response documents with reduced data content and functionality
 A/N 20
Detail R
OrderLevel O This element is only used when Government or Education pricing is desired. 

Order Level codes for U.S. Customers

Value Meaning
EF Education (Student & Staff)
EH Education (Higher)
EL Education (K-12)
ER Education (Erate)
FE Federal
FG Federal GSA
ST State
MD Medical

Order Level codes for Canadian Customers

Value Meaning
EF Education (Student & Staff)
EH Education (Higher)
EL Education (K-12)
FE Federal
LO Local
PR Provincial
A 2
LineInfo R      
RefIDQual R Two character code identifying the part number type that was contained in the Price and Availability submit document.  It identifies the part number type that is contained in the proceeding <RefID> element.
Value Meaning
VP Tech Data item number
BP Buyer Part (customer’s) item number
MG Manufacturer’s item number
UP UPC (Universal Product Code)
A 2
RefID R The item number A/N 20
Note 1
The actual maximum length is not documented.  Include on each XML message submitted the UserName and Password values assigned by your Master/Admin user.

RequiredEUI Response DTD

The following DTD defines the RequiredEUI Response message: 
<!ELEMENT XML_RequiredEUI_Response (
     Header ,
     Detail ) >

    <!ELEMENT   Header (
                TransControlID?,
                ResponseVersion? ) >

        <!ELEMENT TransControlID            (#PCDATA) >
        <!ELEMENT ResponseVersion           (#PCDATA) >

    <!ELEMENT Detail (
	OrderLevel? ,
	EUIFieldInfo* ,
	ErrorInfo? ) >
		  
	<!ELEMENT OrderLevel        (#PCDATA) >
	<!ELEMENT EUIFieldInfo (
		Name ,
		Element ,
		Length? ,
		RequiredInd ) >

		<!ELEMENT Name            (#PCDATA) >
		<!ELEMENT Element         (#PCDATA) >
		<!ELEMENT Length          (#PCDATA) >
		<!ELEMENT RequiredInd     (#PCDATA) >
				  
	<!ELEMENT ErrorInfo (ErrorDesc? ) >
					
		<!ELEMENT ErrorDesc            (#PCDATA) >

A sample XML RequiredEUI Response message will look like the following.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE XML_RequiredEUI_Response SYSTEM "XML_RequiredEUI_Response.dtd"[]>
<XML_RequiredEUI_Response>
  <Header>
    <TransControlID>123456</TransControlID>
    <ResponseVersion>1.0</ResponseVersion>
  </Header>
  <Detail>
    <OrderLevel>Commercial</OrderLevel>
    <EUIFieldInfo>
      <Name>Name</Name>
      <Element>EuiName</Element>
      <Length>40</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Address 1</Name>
      <Element>EuiAddr1</Element>
      <Length>30</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Address 2</Name>
      <Element>EuiAddr2</Element>
      <Length>30</Length>
      <RequiredInd>Optional</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Address 3</Name>
      <Element>EuiAddr3</Element>
      <Length>30</Length>
      <RequiredInd>Optional</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>City</Name>
      <Element>EuiCityName</Element>
      <Length>30</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>State</Name>
      <Element>EuiStateProvinceCode</Element>
      <Length>2</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Postal Code</Name>
      <Element>EuiPostalCode</Element>
      <Length>9</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Country</Name>
      <Element>EuiCountryCode</Element>
      <Length>3</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Contact</Name>
      <Element>EuiContactName</Element>
      <Length>30</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Phone</Name>
      <Element>EuiPhoneNbr</Element>
      <Length>20</Length>
      <RequiredInd>Required</RequiredInd>
    </EUIFieldInfo>
    <EUIFieldInfo>
      <Name>Reseller Email</Name>
      <Element>EuiContactEmailAddr2</Element>
      <Length>50</Length>
      <RequiredInd>Optional</RequiredInd>
    </EUIFieldInfo>
  </Detail>
</XML_RequiredEUI_Response>

RequiredEUI Response Data Fields

The following table provides a detailed description of each element defined in the XML_RequiredEUI_Response.dtd

Element Name
Optional
Required
Description
Data
Type
Max Len
Header
TransControlID O Unique tracking identifier assigned by the customer for each Price and Availability submit document submitted. The content of the element sent by the customer within the XML document is returned as is to the customer within the Response document.  The primary function of these types of elements is for tracking purposes. A/N 100
ResponseVersion O Designates the Response DTD version A/N 20
Detail R      
OrderLevel O This element is only used when Government or Education pricing is desired. 

Order Level codes for U.S. Customers

Value Meaning
EF Education (Student & Staff)
EH Education (Higher)
EL Education (K-12)
ER Education (Erate)
FE Federal
FG Federal GSA
ST State
MD Medical

Order Level codes for Canadian Customers

Value Meaning
EF Education (Student & Staff)
EH Education (Higher)
EL Education (K-12)
FE Federal
LO Local
PR Provincial
A 2
EUIFieldInfo O      
Name R Name of the End User Information field A/N 35
Element R Name of the coresponding XML Order Submit transaction element name to populate
Note: If their is no coresponding XML Order Submit transaction element, the value will be 'N/A' 		A/N 35
Length O Length of the End User Information field N 2
RequiredInd O Indicator for whether the feild is optional or required
Note: Optional fields are recommended but are not required to submit the Order. Optional fields are included for convenience.		 A/N 20
ErrorInfo O      
ErrorDesc   Error description A/N 250
©2015 Tech Data Corporation. All Rights Reserved. Tech Data proprietary and confidential