Queries for existing classes.
Request
Response
XMLOps
VB.NET
C#
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="16.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <ClassQueryRq metaData="ENUMTYPE"> <!-- BEGIN OR --> <ListID >IDTYPE</ListID> <!-- optional, may repeat --> <!-- OR --> <FullName >STRTYPE</FullName> <!-- optional, may repeat --> <!-- OR --> <MaxReturned >INTTYPE</MaxReturned> <!-- optional --> <!-- ActiveStatus may have one of the following values: ActiveOnly [DEFAULT], InactiveOnly, All --> <ActiveStatus >ENUMTYPE</ActiveStatus> <!-- optional --> <FromModifiedDate >DATETIMETYPE</FromModifiedDate> <!-- optional --> <ToModifiedDate >DATETIMETYPE</ToModifiedDate> <!-- optional --> <!-- BEGIN OR --> <NameFilter> <!-- optional --> <!-- MatchCriterion may have one of the following values: StartsWith, Contains, EndsWith --> <MatchCriterion >ENUMTYPE</MatchCriterion> <!-- required --> <Name >STRTYPE</Name> <!-- required --> </NameFilter> <!-- OR --> <NameRangeFilter> <!-- optional --> <FromName >STRTYPE</FromName> <!-- optional --> <ToName >STRTYPE</ToName> <!-- optional --> </NameRangeFilter> <!-- END OR --> <!-- END OR --> <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat --> </ClassQueryRq> <ClassQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <ClassRet> <!-- optional, may repeat --> <ListID >IDTYPE</ListID> <!-- required --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required --> <TimeModified >DATETIMETYPE</TimeModified> <!-- required --> <EditSequence >STRTYPE</EditSequence> <!-- required --> <Name >STRTYPE</Name> <!-- required --> <FullName >STRTYPE</FullName> <!-- required --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <ParentRef> <!-- optional --> <ListID >IDTYPE</ListID> <!-- optional --> <FullName >STRTYPE</FullName> <!-- optional --> </ParentRef> <Sublevel >INTTYPE</Sublevel> <!-- required --> </ClassRet> </ClassQueryRs> </QBXMLMsgsRq> </QBXML> |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | 'The following sample code is generated as an illustration of 'Creating requests and parsing responses ONLY 'This code is NOT intended to show best practices or ideal code 'Use at your most careful discretion imports System imports System.Net imports System.Drawing imports System.Collections imports System.ComponentModel imports System.Windows.Forms imports System.Data imports System.IO imports Interop.QBFC16 Module com.intuit.idn.samples Public Class Sample Public Sub DoClassQuery() Dim sessionBegun as Boolean sessionBegun = False Dim connectionOpen as Boolean connectionOpen = False Dim sessionManager as QBSessionManager sessionManager = nothing Try 'Create the session Manager object sessionManager = new QBSessionManager 'Create the message set request object to hold our request Dim requestMsgSet as IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest("US",16,0) requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue BuildClassQueryRq(requestMsgSet) 'Connect to QuickBooks and begin a session sessionManager.OpenConnection("","Sample Code from OSR") connectionOpen = True sessionManager.BeginSession("", ENOpenMode.omDontCare) sessionBegun = True 'Send the request and get the response from QuickBooks Dim responseMsgSet as IMsgSetResponse responseMsgSet = sessionManager.DoRequests(requestMsgSet) 'End the session and close the connection to QuickBooks sessionManager.EndSession() sessionBegun = False sessionManager.CloseConnection() connectionOpen = False WalkClassQueryRs(responseMsgSet) Catch e as Exception MessageBox.Show(e.Message, "Error") if (sessionBegun) then sessionManager.EndSession() End If if (connectionOpen) then sessionManager.CloseConnection() End If End Try End Sub Public Sub BuildClassQueryRq(requestMsgSet as IMsgSetRequest) Dim ClassQueryRq as IClassQuery ClassQueryRq= requestMsgSet.AppendClassQueryRq() Dim ORListQueryElementType3703 as String ORListQueryElementType3703 = "ListIDList" if (ORListQueryElementType3703 == "ListIDList") then 'Set field value for ListIDList 'May create more than one of these if needed ClassQueryRq.ORListQuery.ListIDList.Add("200000-1011023419") End If if (ORListQueryElementType3703 == "FullNameList") then 'Set field value for FullNameList 'May create more than one of these if needed ClassQueryRq.ORListQuery.FullNameList.Add("ab") End If if (ORListQueryElementType3703 == "ListFilter") then 'Set field value for MaxReturned ClassQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6) 'Set field value for ActiveStatus ClassQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]) 'Set field value for FromModifiedDate ClassQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) 'Set field value for ToModifiedDate ClassQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) Dim ORNameFilterElementType3704 as String ORNameFilterElementType3704 = "NameFilter" if (ORNameFilterElementType3704 == "NameFilter") then 'Set field value for MatchCriterion ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith) 'Set field value for Name ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab") End If if (ORNameFilterElementType3704 == "NameRangeFilter") then 'Set field value for FromName ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab") 'Set field value for ToName ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab") End If End If 'Set field value for IncludeRetElementList 'May create more than one of these if needed ClassQueryRq.IncludeRetElementList.Add("ab") End Sub Public Sub WalkClassQueryRs( responseMsgSet as IMsgSetResponse) if (responseMsgSet is nothing) then Exit Sub End If Dim responseList as IResponseList responseList = responseMsgSet.ResponseList if (responseList is nothing) then Exit Sub End If 'if we sent only one request, there is only one response, we'll walk the list for this sample for j=0 to responseList.Count-1 Dim response as IResponse response = responseList.GetAt(j) 'check the status code of the response, 0=ok, >0 is warning if (response.StatusCode >= 0) then 'the request-specific response is in the details, make sure we have some if (not response.Detail is nothing) then 'make sure the response is the type we're expecting Dim responseType as ENResponseType responseType = CType(response.Type.GetValue(),ENResponseType) if (responseType == ENResponseType.rtClassQueryRs) then 'upcast to more specific type here, this is safe because we checked with response.Type check above Dim ClassRet as IClassRetList ClassRet = CType(response.Detail,IClassRetList) WalkClassRet(ClassRet) End If End If End If Next j End Sub Public Sub WalkClassRet(ClassRet as IClassRetList) if (ClassRet is nothing) then Exit Sub End If 'Go through all the elements of IClassRetList 'Get value of ListID Dim ListID3705 as String ListID3705 = ClassRet.ListID.GetValue() 'Get value of TimeCreated Dim TimeCreated3706 as DateTime TimeCreated3706 = ClassRet.TimeCreated.GetValue() 'Get value of TimeModified Dim TimeModified3707 as DateTime TimeModified3707 = ClassRet.TimeModified.GetValue() 'Get value of EditSequence Dim EditSequence3708 as String EditSequence3708 = ClassRet.EditSequence.GetValue() 'Get value of Name Dim Name3709 as String Name3709 = ClassRet.Name.GetValue() 'Get value of FullName Dim FullName3710 as String FullName3710 = ClassRet.FullName.GetValue() 'Get value of IsActive if ( not ClassRet.IsActive is nothing) then Dim IsActive3711 as Boolean IsActive3711 = ClassRet.IsActive.GetValue() End If if (not ClassRet.ParentRef. is nothing) then 'Get value of ListID if ( not ClassRet.ParentRef.ListID is nothing) then Dim ListID3712 as String ListID3712 = ClassRet.ParentRef.ListID.GetValue() End If 'Get value of FullName if ( not ClassRet.ParentRef.FullName is nothing) then Dim FullName3713 as String FullName3713 = ClassRet.ParentRef.FullName.GetValue() End If End If 'Get value of Sublevel Dim Sublevel3714 as Integer Sublevel3714 = ClassRet.Sublevel.GetValue() End Sub End Class End Module |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | //The following sample code is generated as an illustration of //Creating requests and parsing responses ONLY //This code is NOT intended to show best practices or ideal code //Use at your most careful discretion using System; using System.Net; using System.Drawing; using System.Collections; using System.ComponentModel; using System.Windows.Forms; using System.Data; using System.IO; using Interop.QBFC16; namespace com.intuit.idn.samples { public class Sample { public void DoClassQuery() { bool sessionBegun = false; bool connectionOpen = false; QBSessionManager sessionManager = null; try { //Create the session Manager object sessionManager = new QBSessionManager(); //Create the message set request object to hold our request IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest("US",16,0); requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue; BuildClassQueryRq(requestMsgSet); //Connect to QuickBooks and begin a session sessionManager.OpenConnection("","Sample Code from OSR"); connectionOpen = true; sessionManager.BeginSession("", ENOpenMode.omDontCare); sessionBegun = true; //Send the request and get the response from QuickBooks IMsgSetResponse responseMsgSet = sessionManager.DoRequests(requestMsgSet); //End the session and close the connection to QuickBooks sessionManager.EndSession(); sessionBegun = false; sessionManager.CloseConnection(); connectionOpen = false; WalkClassQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildClassQueryRq(IMsgSetRequest requestMsgSet) { IClassQuery ClassQueryRq= requestMsgSet.AppendClassQueryRq(); //Set attributes //Set field value for metaData ClassQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORListQueryElementType3691 = "ListIDList"; if (ORListQueryElementType3691 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed ClassQueryRq.ORListQuery.ListIDList.Add("200000-1011023419"); } if (ORListQueryElementType3691 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed ClassQueryRq.ORListQuery.FullNameList.Add("ab"); } if (ORListQueryElementType3691 == "ListFilter") { //Set field value for MaxReturned ClassQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus ClassQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate ClassQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate ClassQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType3692 = "NameFilter"; if (ORNameFilterElementType3692 == "NameFilter") { //Set field value for MatchCriterion ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType3692 == "NameRangeFilter") { //Set field value for FromName ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName ClassQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed ClassQueryRq.IncludeRetElementList.Add("ab"); } void WalkClassQueryRs(IMsgSetResponse responseMsgSet) { if (responseMsgSet == null) return; IResponseList responseList = responseMsgSet.ResponseList; if (responseList == null) return; //if we sent only one request, there is only one response, we'll walk the list for this sample for(int i=0; i < responseList.Count; i++) { IResponse response = responseList.GetAt(i); //check the status code of the response, 0=ok, >0 is warning if (response.StatusCode >= 0) { //the request-specific response is in the details, make sure we have some if (response.Detail != null) { //make sure the response is the type we're expecting ENResponseType responseType = (ENResponseType)response.Type.GetValue(); if (responseType == ENResponseType.rtClassQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IClassRetList ClassRet = (IClassRetList)response.Detail; WalkClassRet(ClassRet); } } } } } void WalkClassRet(IClassRetList ClassRet) { if (ClassRet == null) return; //Go through all the elements of IClassRetList //Get value of ListID string ListID3693 = (string)ClassRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated3694 = (DateTime)ClassRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified3695 = (DateTime)ClassRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence3696 = (string)ClassRet.EditSequence.GetValue(); //Get value of Name string Name3697 = (string)ClassRet.Name.GetValue(); //Get value of FullName string FullName3698 = (string)ClassRet.FullName.GetValue(); //Get value of IsActive if (ClassRet.IsActive != null) { bool IsActive3699 = (bool)ClassRet.IsActive.GetValue(); } if (ClassRet.ParentRef != null) { //Get value of ListID if (ClassRet.ParentRef.ListID != null) { string ListID3700 = (string)ClassRet.ParentRef.ListID.GetValue(); } //Get value of FullName if (ClassRet.ParentRef.FullName != null) { string FullName3701 = (string)ClassRet.ParentRef.FullName.GetValue(); } } //Get value of Sublevel int Sublevel3702 = (int)ClassRet.Sublevel.GetValue(); } } } |