CRMSalesLiterature.CreateAndRetrieve Method
The CreateAndRetrieve method creates a sales literature object 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. To perform this action, the caller must have the prvCreateSalesLiterature and prvReadSalesLiterature privileges. See CUserAuth.
EntityXml
Specifies an XML string describing the new sales literature object. The XML schema is described by salesliterature.xsd.
ColumnSet
Specifies an XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). You can find the valid column names in salesliterature.xsd.
Return Value
Returns a String type that specifies the XML data describing the newly created sales literature object. The XML schema is described by salesliterature.xsd.
Remarks
This method always returns a single object so any filter criteria specified in the ColumnSet parameter are ignored.
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMSalesLiterature proxy object
Microsoft.Crm.Platform.Proxy.CRMSalesLiterature salesliterature = new Microsoft.Crm.Platform.Proxy.CRMSalesLiterature();
salesliterature.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesliterature.Url = strDir + "CRMSalesLiterature.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the sales literature XML string
string strSalesLiteratureXml = "<salesliterature>";
strSalesLiteratureXml += "<name>New Products</name>";
strSalesLiteratureXml += "<description>Describes the new products for this quarter.</description>";
strSalesLiteratureXml += "</salesliterature>";
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "</columnset>";
// Create and then retrieve the sales literature object
string strNewSalesLiteratureXml = salesliterature.CreateAndRetrieve(userAuth, strSalesLiteratureXml, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also