CRMSalesLiteratureItem.RetrieveByObject Method
The RetrieveByObject method retrieves all sales literature items that are associated with an object (sales literature).
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Entity As CObjectName,
ByVal ColumnSet As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Entity,
string ColumnSet
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Entity,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadSalesLiterature privilege to perform this action. See CUserAuth.
Entity
Specifies the object (sales literature). See CObjectName.
ColumnSet
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 salesliteratureitem.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the set of sales literature items associated with the specified object. The fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by salesliteratureitem.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";
// CRMSalesLiteratureItem proxy object
Microsoft.CRM.Proxy.CRMSalesLiteratureItem salesliteratureitem = new Microsoft.CRM.Proxy.CRMSalesLiteratureItem();
salesliteratureitem.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesliteratureitem.Url = strDir + "CRMSalesLiteratureItem.srf";
string strErrorMsg;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strSalesLiteratureId = "{706D1D72-CF08-40CD-8059-CC0DF6377A19}";
Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
objName.Id = strSalesLiteratureId;
objName.Type = Microsoft.CRM.Proxy.ObjectType.otSalesLiterature;
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "</columnset>";
// Retrieve all of the items for a sales literature object
string strResultsXml = salesliteratureitem.RetrieveByObject(userAuth, objName, 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