DataExtDefQuery

Queries for the specified data extension defintion or set of definitions.


Request

Response

XMLOPS

VB.NET

C#

Tag Type Max length Implementation Required

IDataExtDefQuery

Queries for the specified data extension defintion or set of definitions.
        

ORDataExtDefQuery

 IORDataExtDefQuery      

OwnerIDList

The list of Owner IDs in the requests. An ownerID refers to the owner of a data extension:If OwnerID is 0, this is a public data extension. For example, if you intend to use this with a custom field that is supported in the UI, you must use an owner ID of 0.If OwnerID is a GUID, for example {6B063959-81B0-4622-85D6-F548C8CCB517}, this field is a private data extension defined by an integrated application. Note that OwnerID values are not case-sensitive, meaning that if you enter an OwnerID value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IGUIDList      

AssignToObjectList

This list contains one or more type enums that specify the object types that can use the data extension definition. To add a type to this list, you invoke AssignToObjectList.Add on the data extension def add object, specifying the object type, as in the following snippet that adds two types to the AssignToObjectList: MyDataExtDefAdd.AssignToObjectList.Add atoDepartment MyDataExtDefAdd.AssignToObjectList.Add atoVendor
 ENAssignToObject      
Tag Type Max length Implementation Required

IResponse

Queries for the specified data extension defintion or set of definitions.
        

StatusCode

A number that corresponds to a statusSeverity and statusMessage. Five status codes relate directly to signon messages: 2000, 2010, 2020, 2030, and 2040. For details about these and other statusCode values that can be returned, see the statusCode table on the Error Codes page.
 IQBIntType     Y

StatusSeverity

One of the following values: INFO The request was completed, and the results are consistent with what your application expected. WARNING The request was completed, but the results might not be consistent with what you expected. ERROR The request was not completed. No data will appear in the server’s response after the statusMessage.
 IQBStringType     Y

StatusMessage

A user-readable explanation of the success or error condition that is indicated by the statusCode. For details about the statusMessage values that can be returned, see the “Explanation” column of the statusCode table on the Error Codes page.
 IQBStringType     Y

Detail

 IDataExtDefRetList      

(List of IDataExtDefRet Objects)

        

OwnerID

OwnerID refers to the owner of a data extension. A value of 0 means the data extension is a custom field visible and usable within the QuickBooks UI. Any other non zero value that is a valid GUID means that the data extension is a private data extension. Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a data extension with another application, the other application must know both the OwnerID and the DataExtName, as these together form a data extension’s unique name.
 IQBGUIDType     Y

DataExtName

The name of the data extension. If this is a custom field, DataExtName will be visible as a label in the QuickBooks user interface. Also because OwnerID and DataExtName together make the data extension unique, and because custom fields all have the same OwnerID of zero, the DataExtName must be a unique value among existing custom fields. In contrast, the DataExtName for private data extensions must be unique only for the specified OwnerID GUID.
 IQBStringType     Y

DataExtType

b>DataExtType The type of the data extension.
 IQBENDataExtTypeType     Y

AssignToObjectList

This list contains one or more type enums that specify the object types that can use the data extension definition. To add a type to this list, you invoke AssignToObjectList.Add on the data extension def add object, specifying the object type, as in the following snippet that adds two types to the AssignToObjectList: MyDataExtDefAdd.AssignToObjectList.Add atoDepartment MyDataExtDefAdd.AssignToObjectList.Add atoVendor
 ENAssignToObject       

 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
<?xml version="1.0" encoding="utf-8"?>
<?qbposxml version="4.0"?>
<QBPOSXML>
        <QBPOSXMLMsgsRq onError="stopOnError">
                <DataExtDefQueryRq>
                        <!-- BEGIN OR -->
                                <OwnerID >GUIDTYPE</OwnerID> <!-- optional, may repeat -->
                        <!-- OR -->
                                <!-- AssignToObject may have one of the following values: Department, Customer, Vendor, Employee, ItemInventory, SalesReceipt, Voucher, InventoryQtyAdjustment, InventoryCostAdjustment, TransferSlip, SalesOrder, PurchaseOrder, TimeEntry, Company -->
                                <AssignToObject >ENUMTYPE</AssignToObject> <!-- optional, may repeat -->
                        <!-- END OR -->
                </DataExtDefQueryRq>

                <DataExtDefQueryRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                        <DataExtDefRet> <!-- optional, may repeat -->
                                <OwnerID >GUIDTYPE</OwnerID> <!-- required -->
                                <DataExtName >STRTYPE</DataExtName> <!-- required -->
                                <!-- DataExtType may have one of the following values: INTTYPE, AMTTYPE, PRICETYPE, QUANTYPE, PERCENTTYPE, DATETIMETYPE, STR255TYPE, STR1024TYPE -->
                                <DataExtType >ENUMTYPE</DataExtType> <!-- required -->
                                <!-- AssignToObject may have one of the following values: Department, Customer, Vendor, Employee, ItemInventory, SalesReceipt, Voucher, InventoryQtyAdjustment, InventoryCostAdjustment, TransferSlip, SalesOrder, PurchaseOrder, TimeEntry, Company -->
                                <AssignToObject >ENUMTYPE</AssignToObject> <!-- optional, may repeat -->
                        </DataExtDefRet>
                </DataExtDefQueryRs>
        </QBPOSXMLMsgsRq>
</QBPOSXML>


  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
'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.qbposfc4

        Public Class SampleDataExtDefQuery
                Public Sub  DoDataExtDefQuery()
                        Dim sessionBegun as Boolean
                        sessionBegun = False
                        Dim connectionOpen as Boolean
                        connectionOpen = False
                        Dim sessionManager as QBPOSSessionManager
                        sessionManager = nothing

                        Try
                                'Create the session Manager object
                                sessionManager = new QBPOSSessionManager

                                'Create the message set request object to hold our request
                                Dim requestMsgSet as IMsgSetRequest
                                requestMsgSet = sessionManager.CreateMsgSetRequest(4,0)
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue

                                BuildDataExtDefQueryRq(requestMsgSet)

                                'Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR")
                                connectionOpen = True
                                sessionManager.BeginSession("")
                                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

                                WalkDataExtDefQueryRs(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 BuildDataExtDefQueryRq(requestMsgSet as IMsgSetRequest)
                        Dim DataExtDefQueryRq as IDataExtDefQuery
                        DataExtDefQueryRq= requestMsgSet.AppendDataExtDefQueryRq()
                        Dim ORDataExtDefQueryElementType569 as String
                        ORDataExtDefQueryElementType569 = "OwnerIDList"
                        if (ORDataExtDefQueryElementType569 = "OwnerIDList") then
                                'Set field value for OwnerIDList
                                'May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.OwnerIDList.Add(System.Guid.NewGuid().ToString())
                        End If
                        if (ORDataExtDefQueryElementType569 = "AssignToObjectList") then
                                'Set field value for AssignToObjectList
                                'May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.AssignToObjectList.Add(ENAssignToObject.atoDepartment)
                        End If
                End Sub




                Public Sub WalkDataExtDefQueryRs( 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.rtDataExtDefQueryRs) then
                                                        'upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        Dim DataExtDefRet as IDataExtDefRetList
                                                        DataExtDefRet = CType(response.Detail,IDataExtDefRetList)
                                                        for z=0 to DataExtDefRet.Count-1
                                                                WalkDataExtDefRet(DataExtDefRet.GetAt(z))
                                                        Next z
                                                End If
                                        End If
                                End If
                        Next j
                End Sub




                Public Sub WalkDataExtDefRet(DataExtDefRet as IDataExtDefRet)
                        if (DataExtDefRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IDataExtDefRetList
                        'Get value of OwnerID
                        Dim OwnerID570 as String
                        OwnerID570 = DataExtDefRet.OwnerID.GetValue()
                        'Get value of DataExtName
                        Dim DataExtName571 as String
                        DataExtName571 = DataExtDefRet.DataExtName.GetValue()
                        'Get value of DataExtType
                        Dim DataExtType572 as ENDataExtType
                        DataExtType572 = DataExtDefRet.DataExtType.GetValue()
                        'Get value of AssignToObjectList
                        if ( not DataExtDefRet.AssignToObjectList is nothing) then
                                Dim AssignToObject573 as ENAssignToObject
                                AssignToObject573 = DataExtDefRet.AssignToObjectList.GetAt(0)
                        End If
                End Sub




        End Class


  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
//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.qbposfc4;

namespace com.intuit.idn.samples
{
        public class SampleDataExtDefQuery
        {
                public void  DoDataExtDefQuery()
                {
                        bool sessionBegun = false;
                        bool connectionOpen = false;
                        QBPOSSessionManager sessionManager = null;

                        try
                        {
                                //Create the session Manager object
                                sessionManager = new QBPOSSessionManager();

                                //Create the message set request object to hold our request
                                IMsgSetRequest requestMsgSet = sessionManager.CreateMsgSetRequest(4,0);
                                requestMsgSet.Attributes.OnError = ENRqOnError.roeContinue;

                                BuildDataExtDefQueryRq(requestMsgSet);

                                //Connect to QuickBooks and begin a session
                                sessionManager.OpenConnection("","Sample Code from OSR");
                                connectionOpen = true;
                                sessionManager.BeginSession("");
                                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;

                                WalkDataExtDefQueryRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildDataExtDefQueryRq(IMsgSetRequest requestMsgSet)
                {
                        IDataExtDefQuery DataExtDefQueryRq= requestMsgSet.AppendDataExtDefQueryRq();
                        string ORDataExtDefQueryElementType574 = "OwnerIDList";
                        if (ORDataExtDefQueryElementType574 == "OwnerIDList")
                        {
                                //Set field value for OwnerIDList
                                //May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.OwnerIDList.Add(Guid.NewGuid().ToString());
                        }
                        if (ORDataExtDefQueryElementType574 == "AssignToObjectList")
                        {
                                //Set field value for AssignToObjectList
                                //May create more than one of these if needed
                                DataExtDefQueryRq.ORDataExtDefQuery.AssignToObjectList.Add(ENAssignToObject.atoDepartment);
                        }
                }




                void WalkDataExtDefQueryRs(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.rtDataExtDefQueryRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IDataExtDefRetList DataExtDefRet = (IDataExtDefRetList)response.Detail;
                                                        for(int z=0; z < DataExtDefRet.Count; z++)
                                                        {
                                                                WalkDataExtDefRet(DataExtDefRet.GetAt(z));
                                                        }
                                                }
                                        }
                                }
                        }
                }




                void WalkDataExtDefRet(IDataExtDefRet DataExtDefRet)
                {
                        if (DataExtDefRet == null) return;
                        //Go through all the elements of IDataExtDefRetList
                        //Get value of OwnerID
                        string OwnerID575 = (string)DataExtDefRet.OwnerID.GetValue();
                        //Get value of DataExtName
                        string DataExtName576 = (string)DataExtDefRet.DataExtName.GetValue();
                        //Get value of DataExtType
                        ENDataExtType DataExtType577 = (ENDataExtType)DataExtDefRet.DataExtType.GetValue();
                        //Get value of AssignToObjectList
                        if (DataExtDefRet.AssignToObjectList != null)
                        {
                                ENAssignToObject AssignToObject578 = (ENAssignToObject)DataExtDefRet.AssignToObjectList.GetAt(0);
                        }
                }




        }
}