Queries for the specified date-driven terms or set of terms.
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 | <?xml version="1.0" encoding="utf-8"?> <?qbxml version="16.0"?> <QBXML> <QBXMLMsgsRq onError="stopOnError"> <DateDrivenTermsQueryRq 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 --> </DateDrivenTermsQueryRq> <DateDrivenTermsQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE" retCount="INTTYPE"> <DateDrivenTermsRet> <!-- optional, may repeat --> <ListID >IDTYPE</ListID> <!-- required --> <TimeCreated >DATETIMETYPE</TimeCreated> <!-- required --> <TimeModified >DATETIMETYPE</TimeModified> <!-- required --> <EditSequence >STRTYPE</EditSequence> <!-- required --> <Name >STRTYPE</Name> <!-- required --> <IsActive >BOOLTYPE</IsActive> <!-- optional --> <DayOfMonthDue >INTTYPE</DayOfMonthDue> <!-- required --> <DueNextMonthDays >INTTYPE</DueNextMonthDays> <!-- optional --> <DiscountDayOfMonth >INTTYPE</DiscountDayOfMonth> <!-- optional --> <DiscountPct >PERCENTTYPE</DiscountPct> <!-- optional --> </DateDrivenTermsRet> </DateDrivenTermsQueryRs> </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 DoDateDrivenTermsQuery() 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 BuildDateDrivenTermsQueryRq(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 WalkDateDrivenTermsQueryRs(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 BuildDateDrivenTermsQueryRq(requestMsgSet as IMsgSetRequest) Dim DateDrivenTermsQueryRq as IDateDrivenTermsQuery DateDrivenTermsQueryRq= requestMsgSet.AppendDateDrivenTermsQueryRq() Dim ORListQueryElementType7939 as String ORListQueryElementType7939 = "ListIDList" if (ORListQueryElementType7939 == "ListIDList") then 'Set field value for ListIDList 'May create more than one of these if needed DateDrivenTermsQueryRq.ORListQuery.ListIDList.Add("200000-1011023419") End If if (ORListQueryElementType7939 == "FullNameList") then 'Set field value for FullNameList 'May create more than one of these if needed DateDrivenTermsQueryRq.ORListQuery.FullNameList.Add("ab") End If if (ORListQueryElementType7939 == "ListFilter") then 'Set field value for MaxReturned DateDrivenTermsQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6) 'Set field value for ActiveStatus DateDrivenTermsQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]) 'Set field value for FromModifiedDate DateDrivenTermsQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) 'Set field value for ToModifiedDate DateDrivenTermsQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false) Dim ORNameFilterElementType7940 as String ORNameFilterElementType7940 = "NameFilter" if (ORNameFilterElementType7940 == "NameFilter") then 'Set field value for MatchCriterion DateDrivenTermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith) 'Set field value for Name DateDrivenTermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab") End If if (ORNameFilterElementType7940 == "NameRangeFilter") then 'Set field value for FromName DateDrivenTermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab") 'Set field value for ToName DateDrivenTermsQueryRq.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 DateDrivenTermsQueryRq.IncludeRetElementList.Add("ab") End Sub Public Sub WalkDateDrivenTermsQueryRs( 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.rtDateDrivenTermsQueryRs) then 'upcast to more specific type here, this is safe because we checked with response.Type check above Dim DateDrivenTermsRet as IDateDrivenTermsRetList DateDrivenTermsRet = CType(response.Detail,IDateDrivenTermsRetList) WalkDateDrivenTermsRet(DateDrivenTermsRet) End If End If End If Next j End Sub Public Sub WalkDateDrivenTermsRet(DateDrivenTermsRet as IDateDrivenTermsRetList) if (DateDrivenTermsRet is nothing) then Exit Sub End If 'Go through all the elements of IDateDrivenTermsRetList 'Get value of ListID Dim ListID7941 as String ListID7941 = DateDrivenTermsRet.ListID.GetValue() 'Get value of TimeCreated Dim TimeCreated7942 as DateTime TimeCreated7942 = DateDrivenTermsRet.TimeCreated.GetValue() 'Get value of TimeModified Dim TimeModified7943 as DateTime TimeModified7943 = DateDrivenTermsRet.TimeModified.GetValue() 'Get value of EditSequence Dim EditSequence7944 as String EditSequence7944 = DateDrivenTermsRet.EditSequence.GetValue() 'Get value of Name Dim Name7945 as String Name7945 = DateDrivenTermsRet.Name.GetValue() 'Get value of IsActive if ( not DateDrivenTermsRet.IsActive is nothing) then Dim IsActive7946 as Boolean IsActive7946 = DateDrivenTermsRet.IsActive.GetValue() End If 'Get value of DayOfMonthDue Dim DayOfMonthDue7947 as Integer DayOfMonthDue7947 = DateDrivenTermsRet.DayOfMonthDue.GetValue() 'Get value of DueNextMonthDays if ( not DateDrivenTermsRet.DueNextMonthDays is nothing) then Dim DueNextMonthDays7948 as Integer DueNextMonthDays7948 = DateDrivenTermsRet.DueNextMonthDays.GetValue() End If 'Get value of DiscountDayOfMonth if ( not DateDrivenTermsRet.DiscountDayOfMonth is nothing) then Dim DiscountDayOfMonth7949 as Integer DiscountDayOfMonth7949 = DateDrivenTermsRet.DiscountDayOfMonth.GetValue() End If 'Get value of DiscountPct if ( not DateDrivenTermsRet.DiscountPct is nothing) then Dim DiscountPct7950 as Double DiscountPct7950 = DateDrivenTermsRet.DiscountPct.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 | //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 DoDateDrivenTermsQuery() { 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; BuildDateDrivenTermsQueryRq(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; WalkDateDrivenTermsQueryRs(responseMsgSet); } catch (Exception e) { MessageBox.Show(e.Message, "Error"); if (sessionBegun) { sessionManager.EndSession(); } if (connectionOpen) { sessionManager.CloseConnection(); } } } void BuildDateDrivenTermsQueryRq(IMsgSetRequest requestMsgSet) { IDateDrivenTermsQuery DateDrivenTermsQueryRq= requestMsgSet.AppendDateDrivenTermsQueryRq(); //Set attributes //Set field value for metaData DateDrivenTermsQueryRq.metaData.SetValue("IQBENmetaDataType"); string ORListQueryElementType7927 = "ListIDList"; if (ORListQueryElementType7927 == "ListIDList") { //Set field value for ListIDList //May create more than one of these if needed DateDrivenTermsQueryRq.ORListQuery.ListIDList.Add("200000-1011023419"); } if (ORListQueryElementType7927 == "FullNameList") { //Set field value for FullNameList //May create more than one of these if needed DateDrivenTermsQueryRq.ORListQuery.FullNameList.Add("ab"); } if (ORListQueryElementType7927 == "ListFilter") { //Set field value for MaxReturned DateDrivenTermsQueryRq.ORListQuery.ListFilter.MaxReturned.SetValue(6); //Set field value for ActiveStatus DateDrivenTermsQueryRq.ORListQuery.ListFilter.ActiveStatus.SetValue(ENActiveStatus.asActiveOnly [DEFAULT]); //Set field value for FromModifiedDate DateDrivenTermsQueryRq.ORListQuery.ListFilter.FromModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); //Set field value for ToModifiedDate DateDrivenTermsQueryRq.ORListQuery.ListFilter.ToModifiedDate.SetValue(DateTime.Parse("12/15/2007 12:15:12"),false); string ORNameFilterElementType7928 = "NameFilter"; if (ORNameFilterElementType7928 == "NameFilter") { //Set field value for MatchCriterion DateDrivenTermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.MatchCriterion.SetValue(ENMatchCriterion.mcStartsWith); //Set field value for Name DateDrivenTermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameFilter.Name.SetValue("ab"); } if (ORNameFilterElementType7928 == "NameRangeFilter") { //Set field value for FromName DateDrivenTermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.FromName.SetValue("ab"); //Set field value for ToName DateDrivenTermsQueryRq.ORListQuery.ListFilter.ORNameFilter.NameRangeFilter.ToName.SetValue("ab"); } } //Set field value for IncludeRetElementList //May create more than one of these if needed DateDrivenTermsQueryRq.IncludeRetElementList.Add("ab"); } void WalkDateDrivenTermsQueryRs(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.rtDateDrivenTermsQueryRs) { //upcast to more specific type here, this is safe because we checked with response.Type check above IDateDrivenTermsRetList DateDrivenTermsRet = (IDateDrivenTermsRetList)response.Detail; WalkDateDrivenTermsRet(DateDrivenTermsRet); } } } } } void WalkDateDrivenTermsRet(IDateDrivenTermsRetList DateDrivenTermsRet) { if (DateDrivenTermsRet == null) return; //Go through all the elements of IDateDrivenTermsRetList //Get value of ListID string ListID7929 = (string)DateDrivenTermsRet.ListID.GetValue(); //Get value of TimeCreated DateTime TimeCreated7930 = (DateTime)DateDrivenTermsRet.TimeCreated.GetValue(); //Get value of TimeModified DateTime TimeModified7931 = (DateTime)DateDrivenTermsRet.TimeModified.GetValue(); //Get value of EditSequence string EditSequence7932 = (string)DateDrivenTermsRet.EditSequence.GetValue(); //Get value of Name string Name7933 = (string)DateDrivenTermsRet.Name.GetValue(); //Get value of IsActive if (DateDrivenTermsRet.IsActive != null) { bool IsActive7934 = (bool)DateDrivenTermsRet.IsActive.GetValue(); } //Get value of DayOfMonthDue int DayOfMonthDue7935 = (int)DateDrivenTermsRet.DayOfMonthDue.GetValue(); //Get value of DueNextMonthDays if (DateDrivenTermsRet.DueNextMonthDays != null) { int DueNextMonthDays7936 = (int)DateDrivenTermsRet.DueNextMonthDays.GetValue(); } //Get value of DiscountDayOfMonth if (DateDrivenTermsRet.DiscountDayOfMonth != null) { int DiscountDayOfMonth7937 = (int)DateDrivenTermsRet.DiscountDayOfMonth.GetValue(); } //Get value of DiscountPct if (DateDrivenTermsRet.DiscountPct != null) { double DiscountPct7938 = (double)DateDrivenTermsRet.DiscountPct.GetValue(); } } } } |