CRMSalesLiteratureItem.CreateAndRetrieve Method

The CreateAndRetrieve method creates a sales literature item and then retrieves it.

Syntax

[Visual Basic .NET]
Public Function CreateAndRetrieve(
  ByVal Caller As CUserAuth,
  ByVal EntityXml As String,
  ByVal ColumnSet As String
) As String
[C#]
public string CreateAndRetrieve(
  CUserAuth  Caller,
  string  EntityXml,
  string  ColumnSet
);
[C++]
public: String* CreateAndRetrieve(
  CUserAuth*  Caller,
  String*  EntityXml,
  String*  ColumnSet
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvCreateSalesLiterature and prvReadSalesLiterature privileges to perform this action. See CUserAuth.

EntityXml

Specifies an XML string describing the new sales literature item. The XML schema is described by salesliteratureitem.xsd.

ColumnSet

Specifies an XML string describing the set of columns that are 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 new sales literature item. 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}";

   // Set up the XML string for the sales literature item
   string strSalesLiteratureItemXml = "<salesliteratureitem>";
   strSalesLiteratureItemXml += "<salesliteratureid>" + strSalesLiteratureId + "</salesliteratureid>";
   strSalesLiteratureItemXml += "<title>salesforce</title>";
   strSalesLiteratureItemXml += "<authorname>Michael Blythe</authorname>";
   strSalesLiteratureItemXml += "<keywords>keys1234</keywords>";
   strSalesLiteratureItemXml += "</salesliteratureitem>";

   // Set up the columns that you want to retrieve
   string strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>title</column>";
   strColumnSetXml += "</columnset>";

   string strResultsXml = salesliteratureitem.CreateAndRetrieve(userAuth, strSalesLiteratureItemXml, 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

© 2003 Microsoft Corporation. All rights reserved.