ItemInventoryPicturesMod


Request

Response

XMLOPS

VB.NET

C#

Tag Type Max length Implementation Required

IItemInventoryPicturesMod

     2.5  

ListID

The unique ID returned by QBPOS for this object. If supplied in a request, the ListID is a reference to an object required in the request. For example, in a SalesOrder or PurchaseOrder line item, the ListID that is required is an Item list ID.
 IQBIDType     Y

ItemInventoryPictureList

List of item inventory picture objects.
 IItemInventoryPictureList      

(List of IItemInventoryPicture Objects)

        

EncodedPicture

Item inventory picture encoded in Base-64.
 IQBStringType      

PictureName

File Name of the item image.
 IQBStringType      

IncludeRetElementList

You can use the IncludeRetElement feature to restrict the data returned in the response to the specified qbposXML field here. If you do this, only those elements specified will be returned. To use this feature, you simply add the qbposXML element name to the IncludeRetElementList. The following example shows how to do this, specifying that only the CreatedBy and ClockOutTime elements are to be returned in the TimeEntryAdd response: Dim MyTimeEntry As ITimeEntryAdd Set MyTimeEntry = requestMsgSet.AppendTimeEntryAddRq MyTimeEntry.IncludeRetElementList.Add “CreatedBy” MyTimeEntry.IncludeRetElementList.Add “ClockOutTime” ‘ set the other properties as desired…
 IBSTRList 50 chars    
Tag Type Max length Implementation Required

IResponse

     2.5  

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

 IItemInventoryPicturesRet      

ListID

The unique ID returned by QBPOS for this object. If supplied in a request, the ListID is a reference to an object required in the request. For example, in a SalesOrder or PurchaseOrder line item, the ListID that is required is an Item list ID.
 IQBIDType      

ItemInventoryPictureList

List of item inventory picture objects.
 IItemInventoryPictureList      

(List of IItemInventoryPicture Objects)

        

EncodedPicture

Item inventory picture encoded in Base-64.
 IQBStringType      

PictureName

File Name of the item image.
 IQBStringType       

 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
<?xml version="1.0" encoding="utf-8"?>
<?qbposxml version="4.0"?>
<QBPOSXML>
        <QBPOSXMLMsgsRq onError="stopOnError">
                <ItemInventoryPicturesModRq>
                        <ItemInventoryPicturesMod> <!-- required -->
                                <ListID >IDTYPE</ListID> <!-- required -->
                                <ItemInventoryPicture> <!-- must occur 0 - 2 times -->
                                        <EncodedPicture >STRTYPE</EncodedPicture> <!-- optional -->
                                        <PictureName >STRTYPE</PictureName> <!-- optional -->
                                </ItemInventoryPicture>
                        </ItemInventoryPicturesMod>
                        <IncludeRetElement >STRTYPE</IncludeRetElement> <!-- optional, may repeat -->
                </ItemInventoryPicturesModRq>

                <ItemInventoryPicturesModRs statusCode="INTTYPE" statusSeverity="STRTYPE" statusMessage="STRTYPE">
                        <ItemInventoryPicturesRet> <!-- optional -->
                                <ListID >IDTYPE</ListID> <!-- optional -->
                                <ItemInventoryPicture> <!-- must occur 0 - 2 times -->
                                        <EncodedPicture >STRTYPE</EncodedPicture> <!-- optional -->
                                        <PictureName >STRTYPE</PictureName> <!-- optional -->
                                </ItemInventoryPicture>
                        </ItemInventoryPicturesRet>
                </ItemInventoryPicturesModRs>
        </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
147
148
149
150
151
'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 SampleItemInventoryPicturesMod
                Public Sub  DoItemInventoryPicturesMod()
                        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

                                BuildItemInventoryPicturesModRq(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

                                WalkItemInventoryPicturesModRs(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 BuildItemInventoryPicturesModRq(requestMsgSet as IMsgSetRequest)
                        Dim ItemInventoryPicturesModRq as IItemInventoryPicturesMod
                        ItemInventoryPicturesModRq= requestMsgSet.AppendItemInventoryPicturesModRq()
                        'Set field value for ListID
                        ItemInventoryPicturesModRq.ListID.SetValue("200000-1011023419")
                        Dim ItemInventoryPicture1803 as IItemInventoryPicture
                        ItemInventoryPicture1803=ItemInventoryPicturesModRq.ItemInventoryPictureList.Append()
                        'Set field value for EncodedPicture
                        ItemInventoryPicture1803.EncodedPicture.SetValue("ab")
                        'Set field value for PictureName
                        ItemInventoryPicture1803.PictureName.SetValue("ab")
                        'Set field value for IncludeRetElementList
                        'May create more than one of these if needed
                        ItemInventoryPicturesModRq.IncludeRetElementList.Add("ab")
                End Sub




                Public Sub WalkItemInventoryPicturesModRs( 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.rtItemInventoryPicturesModRs) then
                                                        'upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        Dim ItemInventoryPicturesRet as IItemInventoryPicturesRet
                                                        ItemInventoryPicturesRet = CType(response.Detail,IItemInventoryPicturesRet)
                                                                WalkItemInventoryPicturesRet(ItemInventoryPicturesRet)
                                                End If
                                        End If
                                End If
                        Next j
                End Sub




                Public Sub WalkItemInventoryPicturesRet(ItemInventoryPicturesRet as IItemInventoryPicturesRet)
                        if (ItemInventoryPicturesRet is nothing) then
                                Exit Sub
                        End If

                        'Go through all the elements of IItemInventoryPicturesRet
                        'Get value of ListID
                        if ( not ItemInventoryPicturesRet.ListID is nothing) then
                                Dim ListID1804 as String
                                ListID1804 = ItemInventoryPicturesRet.ListID.GetValue()
                        End If
                        if (not ItemInventoryPicturesRet.ItemInventoryPictureList is nothing)
                                Dim i1805 as Integer
                                for i1805 = 0  to ItemInventoryPicturesRet.ItemInventoryPictureList.Count - 1
                                        Dim ItemInventoryPicture as IItemInventoryPicture
                                        ItemInventoryPicture = ItemInventoryPicturesRet.ItemInventoryPictureList.GetAt(i1805)
                                        'Get value of EncodedPicture
                                        if ( not ItemInventoryPicture.EncodedPicture is nothing) then
                                                Dim EncodedPicture1806 as String
                                                EncodedPicture1806 = ItemInventoryPicture.EncodedPicture.GetValue()
                                        End If
                                        'Get value of PictureName
                                        if ( not ItemInventoryPicture.PictureName is nothing) then
                                                Dim PictureName1807 as String
                                                PictureName1807 = ItemInventoryPicture.PictureName.GetValue()
                                        End If
                                Next i1805
                        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
144
145
146
147
148
//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 SampleItemInventoryPicturesMod
        {
                public void  DoItemInventoryPicturesMod()
                {
                        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;

                                BuildItemInventoryPicturesModRq(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;

                                WalkItemInventoryPicturesModRs(responseMsgSet);
                        }
                        catch (Exception e)
                        {
                                MessageBox.Show(e.Message, "Error");
                                if (sessionBegun)
                                {
                                        sessionManager.EndSession();
                                }
                                if (connectionOpen)
                                {
                                        sessionManager.CloseConnection();
                                }
                        }
                }
                void BuildItemInventoryPicturesModRq(IMsgSetRequest requestMsgSet)
                {
                        IItemInventoryPicturesMod ItemInventoryPicturesModRq= requestMsgSet.AppendItemInventoryPicturesModRq();
                        //Set field value for ListID
                        ItemInventoryPicturesModRq.ListID.SetValue("200000-1011023419");
                        IItemInventoryPicture ItemInventoryPicture1808=ItemInventoryPicturesModRq.ItemInventoryPictureList.Append();
                        //Set field value for EncodedPicture
                        ItemInventoryPicture1808.EncodedPicture.SetValue("ab");
                        //Set field value for PictureName
                        ItemInventoryPicture1808.PictureName.SetValue("ab");
                        //Set field value for IncludeRetElementList
                        //May create more than one of these if needed
                        ItemInventoryPicturesModRq.IncludeRetElementList.Add("ab");
                }




                void WalkItemInventoryPicturesModRs(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.rtItemInventoryPicturesModRs)
                                                {
                                                        //upcast to more specific type here, this is safe because we checked with response.Type check above
                                                        IItemInventoryPicturesRet ItemInventoryPicturesRet = (IItemInventoryPicturesRet)response.Detail;
                                                                WalkItemInventoryPicturesRet(ItemInventoryPicturesRet);
                                                }
                                        }
                                }
                        }
                }




                void WalkItemInventoryPicturesRet(IItemInventoryPicturesRet ItemInventoryPicturesRet)
                {
                        if (ItemInventoryPicturesRet == null) return;
                        //Go through all the elements of IItemInventoryPicturesRet
                        //Get value of ListID
                        if (ItemInventoryPicturesRet.ListID != null)
                        {
                                string ListID1809 = (string)ItemInventoryPicturesRet.ListID.GetValue();
                        }
                        if (ItemInventoryPicturesRet.ItemInventoryPictureList != null)
                        {
                                for (int i1810 = 0; i1810 < ItemInventoryPicturesRet.ItemInventoryPictureList.Count; i1810++)
                                {
                                        IItemInventoryPicture ItemInventoryPicture = ItemInventoryPicturesRet.ItemInventoryPictureList.GetAt(i1810);
                                        //Get value of EncodedPicture
                                        if (ItemInventoryPicture.EncodedPicture != null)
                                        {
                                                string EncodedPicture1811 = (string)ItemInventoryPicture.EncodedPicture.GetValue();
                                        }
                                        //Get value of PictureName
                                        if (ItemInventoryPicture.PictureName != null)
                                        {
                                                string PictureName1812 = (string)ItemInventoryPicture.PictureName.GetValue();
                                        }
                                }
                        }
                }




        }
}