VehicleQuery is a list query that returns vehicle data for all vehicles that match the provided filter criteria. You can query by vehicle list ID, or its name, or by name comparision or by a range of name comparisons (name filters).
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 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="16.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <VehicleQueryRq 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 --> </VehicleQueryRq> <VehicleQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <VehicleRet> <!-- optional, may repeat --> <ListID >IDTYPE</ListID> <!-- optional --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- optional --> <TimeModified >DATETIMETYPE</TimeModified> <!-- optional --> <EditSequence >STRTYPE</EditSequence> <!-- optional --> <Name >STRTYPE</Name> <!-- optional --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <Desc >STRTYPE</Desc> <!-- optional --> </VehicleRet> </VehicleQueryRs> </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 | '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 DoVehicleQuery() 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 BuildVehicleQueryRq(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 WalkVehicleQueryRs(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 BuildVehicleQueryRq(requestMsgSet as IMsgSetRequest) Dim VehicleQueryRq as IVehicleQuery VehicleQueryRq= requestMsgSet.AppendVehicleQueryRq() Dim ORListQueryElementType23098 as String ORListQueryElementType23098 = "ListIDList" if (ORListQueryElementType23098 == "ListIDList") then 'Set field value for ListIDList 'May create more than one of these if needed VehicleQueryRq.ORListQuery.ListIDList.Add("200000-1011023419") End If if (ORListQueryElementType23098 == "FullNameList") then 'Set field value for FullNameList 'May create more than one of these if needed VehicleQueryRq.ORListQuery.FullNameList.Add("ab") End If if (ORListQueryElementType23098 == "ListFilter") then 'Set field value for MaxReturned VehicleQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6) 'Set field value for ActiveStatus VehicleQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]) 'Set field value for FromModifiedDate VehicleQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) 'Set field value for ToModifiedDate VehicleQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) Dim ORNameFilterElementType23099 as String ORNameFilterElementType23099 = "NameFilter" if (ORNameFilterElementType23099 == "NameFilter") then 'Set field value for MatchCriterion VehicleQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith) 'Set field value for Name VehicleQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab") End If if (ORNameFilterElementType23099 == "NameRangeFilter") then 'Set field value for FromName VehicleQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab") 'Set field value for ToName VehicleQueryRq.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 VehicleQueryRq.IncludeRetElementList.Add("ab") End Sub Public Sub WalkVehicleQueryRs( 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.rtVehicleQueryRs) then 'upcast to more specific type here, this is safe because we checked with response.Type check above Dim VehicleRet as IVehicleRetList VehicleRet = CType(response.Detail,IVehicleRetList) WalkVehicleRet(VehicleRet) End If End If End If Next j End Sub Public Sub WalkVehicleRet(VehicleRet as IVehicleRetList) if (VehicleRet is nothing) then Exit Sub End If 'Go through all the elements of IVehicleRetList 'Get value of ListID if ( not VehicleRet.ListID is nothing) then Dim ListID23100 as String ListID23100 = VehicleRet.ListID.GetValue() End If 'Get value of TimeCreated if ( not VehicleRet.TimeCreated is nothing) then Dim TimeCreated23101 as DateTime TimeCreated23101 = VehicleRet.TimeCreated.GetValue() End If 'Get value of TimeModified if ( not VehicleRet.TimeModified is nothing) then Dim TimeModified23102 as DateTime TimeModified23102 = VehicleRet.TimeModified.GetValue() End If 'Get value of EditSequence if ( not VehicleRet.EditSequence is nothing) then Dim EditSequence23103 as String EditSequence23103 = VehicleRet.EditSequence.GetValue() End If 'Get value of Name if ( not VehicleRet.Name is nothing) then Dim Name23104 as String Name23104 = VehicleRet.Name.GetValue() End If 'Get value of IsActive if ( not VehicleRet.IsActive is nothing) then Dim IsActive23105 as Boolean IsActive23105 = VehicleRet.IsActive.GetValue() End If 'Get value of Desc if ( not VehicleRet.Desc is nothing) then Dim Desc23106 as String Desc23106 = VehicleRet.Desc.GetValue() End If 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 194 195 196 | //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 DoVehicleQuery() { 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; BuildVehicleQueryRq(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; WalkVehicleQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildVehicleQueryRq(IMsgSetRequest requestMsgSet) { IVehicleQuery VehicleQueryRq= requestMsgSet.AppendVehicleQueryRq(); //Set attributes //Set field value for metaData VehicleQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORListQueryElementType23089 = "ListIDList"; if (ORListQueryElementType23089 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed VehicleQueryRq.ORListQuery.ListIDList.Add("200000-1011023419"); } if (ORListQueryElementType23089 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed VehicleQueryRq.ORListQuery.FullNameList.Add("ab"); } if (ORListQueryElementType23089 == "ListFilter") { //Set field value for MaxReturned VehicleQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus VehicleQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate VehicleQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate VehicleQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType23090 = "NameFilter"; if (ORNameFilterElementType23090 == "NameFilter") { //Set field value for MatchCriterion VehicleQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name VehicleQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType23090 == "NameRangeFilter") { //Set field value for FromName VehicleQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName VehicleQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed VehicleQueryRq.IncludeRetElementList.Add("ab"); } void WalkVehicleQueryRs(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.rtVehicleQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IVehicleRetList VehicleRet = (IVehicleRetList)response.Detail; WalkVehicleRet(VehicleRet); } } } } } void WalkVehicleRet(IVehicleRetList VehicleRet) { if (VehicleRet == null) return; //Go through all the elements of IVehicleRetList //Get value of ListID if (VehicleRet.ListID != null) { string ListID23091 = (string)VehicleRet.ListID.GetValue(); } //Get value of TimeCreated if (VehicleRet.TimeCreated != null) { DateTime TimeCreated23092 = (DateTime)VehicleRet.TimeCreated.GetValue(); } //Get value of TimeModified if (VehicleRet.TimeModified != null) { DateTime TimeModified23093 = (DateTime)VehicleRet.TimeModified.GetValue(); } //Get value of EditSequence if (VehicleRet.EditSequence != null) { string EditSequence23094 = (string)VehicleRet.EditSequence.GetValue(); } //Get value of Name if (VehicleRet.Name != null) { string Name23095 = (string)VehicleRet.Name.GetValue(); } //Get value of IsActive if (VehicleRet.IsActive != null) { bool IsActive23096 = (bool)VehicleRet.IsActive.GetValue(); } //Get value of Desc if (VehicleRet.Desc != null) { string Desc23097 = (string)VehicleRet.Desc.GetValue(); } } } } |