Overview
This document details the Q-Star legacy XML API
There is a demonstration for each of the functions provided that can be executed in real time. Use the Add and Delete functions with caution as the Q-Star account will be affected.
A new API interface is undevelopement see Q-Star API. Continued support for the functions detailed within this document cannot be guaranteed, thus it is strongly advised to develop any new code to use the Q-Star API interface, and to ensure continued support with these function migrate existing code to use the new API.
Authentication - Login
Login to Q-Star
New login page:
/Login/xml/login.aspx?UserName=[U]&PassWord=[P]
<login>
<message>Welcome to Q-Star</message>
</login>
Message will contain one the following:
- "Q-Star is currently undergoing maintenance. Please try again later"
- “Session time out has expired. Please re-login."
- "Thank you for using Q-Star."
- "Session time out has expired. The request has NOT been processed."
- "The system is currently unable to log you on. Please try again later."
- "Invalid User name or Password entered."
- "Account has been disabled."
- "Account has been disabled."
- "Welcome to Q-Star"
Authentication - Logout
New logout page:
Login/xml/logout.aspx
Returns:
Login/xml/LoginStatus.aspx
<login>
<message>Thank you for using Q-Star.</message>
</login>
Adding a part into the MPL
To Add a part to the MPL the URL should be:
MasterPartsList/xml/AddMpl.aspx
The input parameters are:
| Parameter |
Comment |
| In_House_PN |
Compulsory |
| Mfr_PN |
Compulsory |
| Spec |
Optional |
| Mfr |
Optional |
| CAGE_Code |
Optional |
| Description |
Optional |
| Part_Type |
Optional |
| NSN |
Optional |
If the Q-Star library id is known, it can be supplied and applied automatically avoiding the need for the part to be matched.
| Parameter |
Comment |
| lib_id |
Q-Star library id if known |
If the part matched or a valid lib_id was specified the part details will be shown see Show MPL part, however if an invalid lib_id was specified then see errors in Assign MPL Part
If Q-Star was unable to add the part the XML below will be returned, the mpl_id if set will be the part that was found that already exists
<QStarMessage>
<message>Part already exists. mpl_id=nnnn</message>
</QStarMessage>
If Q-Star was able to add the part, and the part matched the XML below will be returned:
<match_mpl>
<message />
<mpl_part mpl_id="4689">
<In_House_PN>12</In_House_PN>
<Input_Mfr_PN>2n2222a</Input_Mfr_PN>
<Input_Mfr />
<Input_Spec />
<match_option />
</mpl_part>
</match_mpl>
If Q-Star was able to add the part but the part was not matched the XML below will be returned:
<match_mpl>
<message>Match options</message>
<mpl_part mpl_id="34675">
<In_House_PN>SCD1</In_House_PN>
<Input_Mfr_PN>2n2222a</Input_Mfr_PN>
<Input_Mfr>test1</Input_Mfr>
<Input_Spec></Input_Spec>
<match_option>
<lib_part lib_id = "369986">
<Mfr_PN>2N2222A</Mfr_PN>
<Spec></Spec>
<Mfr>CENTRAL</Mfr>
<Availability_Status>Consult Manufacturer; Per Mfr request</Availability_Status>
<LTB></LTB>
<LCC>4.89</LCC>
<YTEOL>6.80</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Package>TO-18T-H</Package>
<Quality_Level>C</Quality_Level>
<Lead_Finish>SnPb</Lead_Finish>
<RoHS>Y</RoHS>
<Pb_Free>Y</Pb_Free>
<Pb_and_Pb-free>Y</Pb_and_Pb-free>
</lib_part>
<lib_part lib_id = "394070">
<Mfr_PN>2N2222A</Mfr_PN>
<Spec></Spec>
<Mfr>TELEFUNKEN</Mfr>
<Availability_Status>Discontinued-W/Alternates</Availability_Status>
<LTB></LTB>
<LCC>5.00</LCC>
<YTEOL>0</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Package>TO-18T-H</Package>
<Quality_Level>C</Quality_Level>
<Lead_Finish>SnPb</Lead_Finish>
<RoHS>N</RoHS>
<Pb_Free>N</Pb_Free>
<Pb_and_Pb-free>N</Pb_and_Pb-free>
</lib_part>
</mpl_part>
</match_option>
</match_mpl>
Message may contain:
- Could not add part – General failure occurred may need investigating
- No input data specified – url did not contain any data elements
- Must specify an In_House_PN – In_House_PN missing
- Insufficient data to identify part – Mfr_PN is required at a minimum
- Input data already exists
Match Part
To submit a part to matching the URL should be
MasterPartsList/xml/MatchMPL.aspx
The input parameters are:
| Parameter |
Comment |
| mpl_id |
Compulsory |
If Q-Star was able to match the part the XML below will be returned:
<match_mpl>
<message />
<mpl_part mpl_id="4689">
<In_House_PN>12</In_House_PN>
<Input_Mfr_PN>2n2222a</Input_Mfr_PN>
<Input_Mfr />
<Input_Spec />
<match_option />
</mpl_part>
</match_mpl>
If Q-Star was unable to match the part the XML below will be returned:
<match_mpl>
<message>Match options</message>
<mpl_part mpl_id="34675">
<In_House_PN>SCD1</In_House_PN>
<Input_Mfr_PN>2n2222a</Input_Mfr_PN>
<Input_Mfr>test1</Input_Mfr>
<Input_Spec></Input_Spec>
<match_option>
<lib_part lib_id = "369986">
<Mfr_PN>2N2222A</Mfr_PN>
<Spec></Spec>
<Mfr>CENTRAL</Mfr>
<Availability_Status>Consult Manufacturer; Per Mfr request</Availability_Status>
<LTB></LTB>
<LCC>4.89</LCC>
<YTEOL>6.80</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Package>TO-18T-H</Package>
<Quality_Level>C</Quality_Level>
<Lead_Finish>SnPb</Lead_Finish>
<RoHS>Y</RoHS>
<Pb_Free>Y</Pb_Free>
<Pb_and_Pb-free>Y</Pb_and_Pb-free>
</lib_part>
<lib_part lib_id = "394070">
<Mfr_PN>2N2222A</Mfr_PN>
<Spec></Spec>
<Mfr>TELEFUNKEN</Mfr>
<Availability_Status>Discontinued-W/Alternates</Availability_Status>
<LTB></LTB>
<LCC>5.00</LCC>
<YTEOL>0</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Package>TO-18T-H</Package>
<Quality_Level>C</Quality_Level>
<Lead_Finish>SnPb</Lead_Finish>
<RoHS>N</RoHS>
<Pb_Free>N</Pb_Free>
<Pb_and_Pb-free>N</Pb_and_Pb-free>
</lib_part>
</mpl_part>
</match_option>
</match_mpl>
Assign MPL Part
To assign a library part to the MPL use the following URL:
MasterPartsList/xml/AssignMPL.aspx?mpl_id=34675&lib_id=369986
The input parameters are:
| Parameter |
Comment |
| mpl_id |
Compulsory |
| lib_ID |
Compulsory |
If an error occurred then the message page will be displayed
<QStarMessage>
<message>MPL access is denied</message>
</QStarMessage>
Error messages from AssignMPL.aspx are:
- User access denied
- Invalid Input - mpl_ID
- Invalid Input - lib_ID
- MPL access is denied
If the part was successfully the part details will be shown see Show MPL part
<show_mpl>
<mpl_part mpl_id="34675">
<In_House_PN>SCD1</In_House_PN>
<Input_Mfr_PN>2n2222a</Input_Mfr_PN>
<Input_Mfr>test1</Input_Mfr>
<Input_Spec></Input_Spec>
<lib_part lib_ID="177033">
<Mfr_PN>2N2222A</Mfr_PN>
<Spec></Spec>
<Mfr>CENTRAL</Mfr>
<Availability_Status>Consult Manufacturer; Per Mfr request</Availability_Status>
<LTB></LTB>
<LCC>4.89</LCC>
<YTEOL>6.80</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Package>O-18T-H</Package>
<Quality_Level>C</Quality_Level>
<Lead_Finish>SnPb</Lead_Finish>
<RoHS>Y</RoHS>
<Pb_Free>Y</Pb_Free>
<Pb_and_Pb-free>Y</Pb_and_Pb-free>
</lib_part>
</mpl_part>
</show_mpl>
Show MPL part
To display an MPL part at any time you can use:
MasterPartsList/xml/ShowPartMPL.aspx?mpl_id=34675
<show_mpl>
<mpl_part mpl_id="34675">
<In_House_PN>SCD1</In_House_PN>
<Input_Mfr_PN>2n2222a</Input_Mfr_PN>
<Input_Mfr>test1</Input_Mfr>
<Input_Spec></Input_Spec>
<lib_part lib_ID="177033">
<Mfr_PN>2N2222A</Mfr_PN>
<Spec></Spec>
<Mfr>CENTRAL</Mfr>
<Availability_Status>Consult Manufacturer; Per Mfr request</Availability_Status>
<LTB></LTB>
<LCC>4.89</LCC>
<YTEOL>6.80</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Package>O-18T-H</Package>
<Quality_Level>C</Quality_Level>
<Lead_Finish>SnPb</Lead_Finish>
<RoHS>Y</RoHS>
<Pb_Free>Y</Pb_Free>
<Pb_and_Pb-free>Y</Pb_and_Pb-free>
</lib_part>
</mpl_part>
</show_mpl>
Delete MPL Part
To delete a library part from the MPL use the following URL:
MasterPartsList/xml/DeleteMPL.aspx?mpl_id=3462417
The input parameters are:
| Parameter |
Comment |
| mpl_id |
Compulsory |
If the part has been deleted successful the following xml message will be displayed:
<QStarMessage>
<message>Removed part</message>
</QStarMessage>
Downloading the MPL
For XML download
MasterPartsList/xml/DownLoadMPL.aspx
Optional parameters to only download parts where the availability data has changed between specific date(s) are:
| Parameter |
Comment |
| FromDate |
date of last download |
| ToDate |
default to today |
| Page |
page number default 1 |
| PageSize |
records per page default 0 (all records) |
Thus to only download the parts that have changed since the last successful download set the from date as the date of the last download. To avoid confusion with dates it is advisable to specify the date in ISO standard format it 2016-03-28.
<download_mpl>
<mpl_part mpl_id="3462352">
<cust_ref />
<In_House_PN>ZXTP2027FTA</In_House_PN>
<Input_Mfr_PN>ZXTP2027FTA</Input_Mfr_PN>
<Input_Spec />
<Input_Mfr>DIODES</Input_Mfr>
<Input_CAGE />
<Input_Description />
<Input_NSN />
<Input_Part_Type />
<lib_part lib_ID="9511940">
<Mfr_PN>ZXTP2027FTA</Mfr_PN>
<Spec />
<Mfr>DIODES</Mfr>
<Cage_Code>12060</Cage_Code>
<Company_Name>DIODES, INC.</Company_Name>
<Availability_Status>In Production</Availability_Status>
<LTB />
<LCC>3.76</LCC>
<YTEOL>8.00</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Family_Code>TRANSISTORS</Family_Code>
<Family_Assoc>SILICON DUAL PNP POWER</Family_Assoc>
<Funct_Desc>PNP, 1.2W, VCEO=60V, -4A</Funct_Desc>
<Package>PSOT-23S-M</Package>
<Lead_Finish>Sn-Matte</Lead_Finish>
<RoHS>Yes</RoHS>
<Pb_Free>Yes</Pb_Free>
<Pb_and_Pb-free>No</Pb_and_Pb-free>
<Generic_Nbr>2027</Generic_Nbr>
<Quality_Level>T</Quality_Level>
<data_sheet>https://qstar.qtec.us/Tools/DataSheet.aspx?DataSheet=113779</data_sheet>
<PCN_DataSheet>https://qstar.qtec.us/Tools/DataSheet.aspx?PCNDataSheet=DIODES_2305.PDF</PCN_DataSheet>
<Market_Entry_Date>1/1/2003</Market_Entry_Date>
<Obsolescence_Date />
<Update_Date>5/31/2017</Update_Date>
</lib_part>
</mpl_part>
</mpl_part>
</download_mpl>
Alert Download
To download Alerts for the MPL use the following URL:
PartLookup/xml/AlertDownloadMPL.aspx
This will return all the alerts for the MPL.
The input parameters are:
| Parameter |
Comment |
| alert_flag_id |
Optional, supply the maximum alert_flag_id from the last download |
| FromDate |
Optional, supply the date of last download |
| ToDate |
Optional, default current date |
| Page |
Page number, default 1 |
| PageSize |
Records per page, default 0 (all records) |
<alert_download>
<alert alert_flag_id="71186291">
<mpl_id>2638548</mpl_id>
<lib_id>209435</lib_id>
<Alert_Type>C2</Alert_Type>
<Description>Consult Manufacturer; Per Mfr request</Description>
<Alert_Date>4/29/2010</Alert_Date>
<Mfr_Alert_Date />
<Alert_LTB_date />
</alert>
<alert_download>
Alternate
Download Alternate part data
PartLookup/xml/AltDownLoad.aspx
The input parameters are:
| Parameter |
Comment |
| lib_ID |
Compulsory |
<alt_download>
<lib_alt lib_ID="3744425" alt_ID="105463">
<lib_part lib_ID="3744425">
<Mfr_PN>HIP6004ECBZ</Mfr_PN>
<Spec />
<Mfr>INTERSIL</Mfr>
<Cage_Code>34371</Cage_Code>
<Company_Name>INTERSIL, CORP.</Company_Name>
<Availability_Status>In Production</Availability_Status>
<LTB />
<LCC>3.97</LCC>
<YTEOL>6.40</YTEOL>
<Generic_YTEOL>6.40</Generic_YTEOL>
<Family_Code>MIX SIGNAL</Family_Code>
<Family_Assoc>PWM</Family_Assoc>
<Funct_Desc>BUCK AND SYNCHRONOUS-RECTIFIER (PWM) CONTROLLER AND OUTPUT VOLTAGE MONITOR</Funct_Desc>
<Package>PSOPS-M</Package>
<Lead_Finish>Sn-Matte</Lead_Finish>
<RoHS>Yes</RoHS>
<Pb_Free>Yes</Pb_Free>
<Pb_and_Pb-free>No</Pb_and_Pb-free>
<Generic_Nbr>6004</Generic_Nbr>
<Quality_Level>C</Quality_Level>
<data_sheet>https://qstar.qtec.us/Tools/DataSheet.aspx?DataSheet=1060</data_sheet>
<PCN_DataSheet>https://qstar.qtec.us/Tools/DataSheet.aspx?PCNDataSheet=INTERSIL_PCN12094.PDF</PCN_DataSheet>
<Market_Entry_Date />
<Obsolescence_Date />
<Update_Date>04/01/2011</Update_Date>
</lib_part>
</lib_alt>
</alt_download>
Part Lookup
A part search has been added, the search criteria and returned values are as specified, however the fields returned my be expanded to satisfy other users requirements. The search on the mfr_pn is performed by removing all non alpha-numeric characters, and can also be performed using wild cards.
PartLookup/xml/PartLookup.aspx
The input parameters are:
| Parameter |
Comment |
| Mfr_Part_Nbr |
Optional |
| mfr_code |
Optional |
| specification |
Optional |
| Quality_Level |
Optional |
| ExactPart |
true/false (Optional) |
This will return the follwing:
<part_lookup>
<lib_part lib_ID="9511940">
<Mfr_PN>ZXTP2027FTA</Mfr_PN>
<Spec />
<Mfr>DIODES</Mfr>
<Cage_Code>12060</Cage_Code>
<Company_Name>DIODES, INC.</Company_Name>
<Availability_Status>In Production</Availability_Status>
<LTB />
<LCC>3.76</LCC>
<YTEOL>8.00</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Family_Code>TRANSISTORS</Family_Code>
<Family_Assoc>SILICON DUAL PNP POWER</Family_Assoc>
<Funct_Desc>PNP, 1.2W, VCEO=60V, -4A</Funct_Desc>
<Package>PSOT-23S-M</Package>
<Lead_Finish>Sn-Matte</Lead_Finish>
<RoHS>Yes</RoHS>
<Pb_Free>Yes</Pb_Free>
<Pb_and_Pb-free>No</Pb_and_Pb-free>
<Generic_Nbr>2027</Generic_Nbr>
<Quality_Level>T</Quality_Level>
<data_sheet>https://qstar.qtec.us/Tools/DataSheet.aspx?DataSheet=113779</data_sheet>
<PCN_DataSheet>https://qstar.qtec.us/Tools/DataSheet.aspx?PCNDataSheet=DIODES_2209.PDF</PCN_DataSheet>
<Market_Entry_Date>1/1/2003</Market_Entry_Date>
<Obsolescence_Date />
<Update_Date>5/31/2017</Update_Date>
</lib_part>
</part_lookup>
Manufacturer Search
To access Manufacturer data from Q-Star then issue the following URL:
PartLookup/xml/MfrLookup.aspx?
The input parameters are:
| Parameter |
Comment |
| mfr_code |
Compulsory/Optional |
| cage_code |
Compulsory/Optional |
If the manufacturer wasn't found the following message is displayed:
<QStarMessage>
<message>No data found</message>
</QStarMessage>
If the manufacturer was found the following xml is returned:
<mfr_lookup>
<mfr_data>
<Mfr>FAIRCHILD</Mfr>
<Cage_Code>7D893</Cage_Code>
<Company_Name>FAIRCHILD SEMICONDUCTOR</Company_Name>
<division>** NOW ON SEMICONDUCTOR</division>
<address1>82 RUNNING HILL ROAD</address1>
<address2 />
<City>SOUTH PORTLAND</City>
<State>ME</State>
<Zip>32902-0883</Zip>
<Country>US</Country>
<Phone_Nbr>(800) 341-0392</Phone_Nbr>
</mfr_data>
</mfr_lookup>
Part Alternate
PartLookup/xml/AlternateLookup.aspx
The input parameters are:
| Parameter |
Comment |
| MFR_Part_Nbr |
Compulsory |
| MFR_Code |
Compulsory/Optional |
| Cage_Code |
Compulsory/Optional |
If Q-Star can not find an Alternate the following will be displayed:
<QStarMessage>
<message>No Available Alternates</message>
</QStarMessage>
If found the following is displayed:
<alt_download>
<lib_alt lib_ID="101629391" alt_ID="2088321">
<lib_part lib_ID="101629391">
<Mfr_PN>354146</Mfr_PN>
<Spec />
<Mfr>ERNI</Mfr>
<Cage_Code>3M8K7</Cage_Code>
<Company_Name>ERNI ELECTRONICS, INC.</Company_Name>
<Availability_Status>In Production</Availability_Status>
<LTB />
<LCC>4.04</LCC>
<YTEOL>8.00</YTEOL>
<Generic_YTEOL>8.00</Generic_YTEOL>
<Family_Code>CONNECTORS</Family_Code>
<Family_Assoc>PCB</Family_Assoc>
<Funct_Desc>FEMALE, CONTACTS:95</Funct_Desc>
<Package>N/A</Package>
<Lead_Finish>N/A</Lead_Finish>
<RoHS>Yes</RoHS>
<Pb_Free>Yes</Pb_Free>
<Pb_and_Pb-free>No</Pb_and_Pb-free>
<Generic_Nbr>354146</Generic_Nbr>
<Quality_Level>T</Quality_Level>
<data_sheet>https://qstar.qtec.us/Tools/DataSheet.aspx?DataSheet=32793</data_sheet>
<PCN_DataSheet />
<Market_Entry_Date>1/1/1990</Market_Entry_Date>
<Obsolescence_Date />
<Update_Date>5/30/2017</Update_Date>
</lib_part>
</lib_alt>
</alt_download>
PCN Notification
To access Product Change Notices from Q-Star then issue the following URL:
PartLookup/XML/PCNPartLookup.aspx?
The input parameters are:
| Parameter |
Comment |
| Mfr_Part_Nbr |
Compulsory |
| mfr_code |
Optional |
| cage_code |
Optional |
| DateRange |
Optional - Enter the Month Number(1-12) |
| ExactPart |
Optional - Returns exact Part False-Returns Matches -Default True If |
If Q-Star was unable to find the PCN(s) the XML below will be returned:
<PCNPartLookup>
<PCNdata>
<PCN>PCN - None Available</PCN>
</PCNdata>
If Q-Star finds the data the following output is returned:
<PCNPartLookup>
<PCNdata>
<PCN>advisory 0</PCN>
<MFR_Part_Nbr>2N2222A</MFR_Part_Nbr>
<Mfr>STM</Mfr>
<Cage_Code>F8859</Cage_Code>
<PCN_Details>
<Date_Issued>4/22/2010</Date_Issued>
<Category>WAFER FABRICAITON</Category>
<Desc>PRODUCTION CONVERSION FROM 5" TO 6" WAFER SIZE</Desc>
<PCN_Nbr>APM-PWR/10/5519</PCN_Nbr>
<PCN_DataSheet>https://qstar.qtec.us/Tools/DataSheet.aspx?PCNDataSheet=STM_APM-PWR105519.PDF</PCN_DataSheet>
</PCN_Details>
</PCNdata>
</PCNPartLookup>
Part Lookup
Part search will return the part numbers for a given Family / Family Associate.
PartLookup/xml/PartSearch.aspx
The input parameters are:
| Parameter |
Comment |
| Component_Type |
Optional |
| Family |
Optional |
| Family_Associate |
Optional |
This will return the follwing:
- Without any parameters the report returns Component Type & Family
<part_search>
<Part_Type>
<Component_Type>Capacitor</Component_Type>
<Family>CAPACITORS</Family>
</Part_Type>
<Part_Type>
<Component_Type>Resistor</Component_Type>
<Family>RESISTORS</Family>
</Part_Type>
</part_search>
- Suppling only the Component Type will return the Family
<part_search>
<Component_Type>Semiconductor Component</Component_Type>
<Part_Family>
<Family>ARRESTERS</Family>
<Family>ASIC</Family>
<Family>CRYSTAL UNIT</Family>
<Family>TRANSISTORS</Family>
<Family>TRIGGER DEVICES</Family>
</Part_Family>
</part_search>
- Suppling the Family the Family Associate will be returned, the Component Type is ignored.
<part_search>
<Component_Type>Semiconductor Component</Component_Type>
<Family>TRANSISTORS</Family>
<Part_Family_Associate>
<Family_Associate>ARRAY</Family_Associate>
<Family_Associate>COMPLEMENTARY NPN/PNP</Family_Associate>
<Family_Associate>DARLINGTON</Family_Associate>
<Family_Associate>OPTOCOUPLER</Family_Associate>
</Part_Family_Associate>
</part_search>
- Suppling both Family and Family Associate the parts numbers will be returned (first 1000).
<part_search>
<Component_Type>Semiconductor Component</Component_Type>
<Family>TRANSISTORS</Family>
<Family_Associate>OPTOCOUPLER</Family_Associate>
<Part_Family_Parts>
<Mfr_PN>LTV-354T</Mfr_PN>
<Mfr_PN>FOD053LR1</Mfr_PN>
</Part_Family_Parts>
</part_search>