CRMCompetitor.CreateAndRetrieve Method
The CreateAndRetrieve method creates a competitor and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InCompetitorXML As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string InCompetitorXML
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* InCompetitorXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvCreateCompetitor and prvReadCompetitor privileges to perform this action. See CUserAuth.
InCompetitorXML
Specifies an XML string representing a competitor. The XML schema is described by competitor.xsd.
Return Value
Returns a String type that specifies the XML data representing the new competitor. The XML schema is described by competitor.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";
// CRMCompetitor proxy object
Microsoft.CRM.Proxy.CRMCompetitor competitor = new Microsoft.CRM.Proxy.CRMCompetitor ();
competitor.Credentials = System.Net.CredentialCache.DefaultCredentials;
competitor.Url = strDir + "CRMCompetitor.srf";
string strErrorMsg;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the SML string for the competitor
string strCompetitorXml = "<competitor>";
strCompetitorXml += "<name>Adventure Works</name>";
strCompetitorXml += "<websiteurl>www.adventure-works.com</websiteurl>";
strCompetitorXml += "</competitor>";
string strResultsXml = competitor.CreateAndRetrieve(userAuth, strCompetitorXml);
}
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