CRMNotesManager.CreateAndRetrieve Method

The CreateAndRetrieve method creates a new note and then returns the XML data for the new note.

Syntax

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

Parameters

Caller

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

InNoteXml

Specifies an XML string describing the note. The XML schema is described by annotation.xsd.

Return Value

Returns a String type that specifies the XML data for the newly created note. The XML schema is described by annotation.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";

// CRMNotesManager proxy object
Microsoft.CRM.Proxy.CRMNotesManager  notesmanager = new Microsoft.CRM.Proxy.CRMNotesManager();
notesmanager.Credentials = System.Net.CredentialCache.DefaultCredentials;
notesmanager.Url = strDir + "CRMNotesManager.srf";

string strErrorMsg;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string for the note
   string strNotesManagerXml = "<annotation>";
   strNotesManagerXml += "<subject>A sample note</subject>";
   strNotesManagerXml += "<isdocument>1</isdocument>";
   strNotesManagerXml += "<ownerid type=\"" + Microsoft.CRM.Flags.ObjectType.otSystemUser.ToString() +"\">";
   strNotesManagerXml += userAuth.UserId + "</ownerid>";
   strNotesManagerXml += "</annotation>";

   // Now create and then retrieve the note
   string strNoteXml = notesmanager.CreateAndRetrieve(userAuth, strNotesManagerXml);
}
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.