CRMProduct.RetrieveByOrganization Method
The RetrieveByOrganization method retrieves all products that are associated with an organization.
Syntax
[Visual Basic .NET]
Public Function RetrieveByOrganization(
ByVal Caller As CUserAuth,
ByVal OrganizationId As String,
ByVal StateCodes As Integer(),
ByVal ColumnSetXml As String
) As String
[C#]
public string RetrieveByOrganization(
CUserAuth Caller,
string OrganizationId,
int[] StateCodes,
string ColumnSetXml
);
[C++]
public: String* RetrieveByOrganization(
CUserAuth* Caller,
String* OrganizationId,
long StateCodes __gc[],
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadProduct privilege to perform this action. See CUserAuth.
OrganizationId
Specifies the ID of the organization to find.
StateCodes
Specifies an array of states to find. See PRODUCT_STATE.
ColumnSetXml
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in product.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the set of products associated with the specified organization. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by product.xsd.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMProduct proxy object
Microsoft.CRM.Proxy.CRMProduct product = new Microsoft.CRM.Proxy.CRMProduct();
product.Credentials = System.Net.CredentialCache.DefaultCredentials;
product.Url = strDir + "CRMProduct.srf";
string strErrorMsg;
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// An array of state codes to find
int[] arrStateCodes = new int[] {Microsoft.CRM.Flags.INVOICE_STATE.INS_ACTIVE,Microsoft.CRM.Flags.PRODUCT_STATE.PS_ACTIVE};
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "<column>price</column>";
strColumnSetXml += "</columnset>";
// Retrieve the products for this organization
string strResultsXml= product.RetrieveByOrganization (userAuth, strOrgId, arrStateCodes, strColumnSetXml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.CRM.Proxy
Assembly: microsoft.crm.proxy.dll
See Also