Share via


CRMFiscalCalendar.Create Method

The Create method creates a fiscal calendar.

Syntax

[Visual Basic .NET]
Public Function Create(
  ByVal Caller As CUserAuth,
  ByVal CalendarType As Integer,
  ByVal EntityXML As String
) As String
[C#]
public string Create(
  CUserAuth  Caller,
  int  CalendarType,
  string  EntityXML
);
[C++]
public: String* Create(
  CUserAuth*  Caller,
  long  CalendarType,
  String*  EntityXML
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteUser privilege. See CUserAuth.

CalendarType

Specifies the calendar type. This is one of the following in the ObjectType class: otAnnualFiscalCalendar, otFixedMonthlyFiscalCalendar, otMonthlyFiscalCalendar, otQuarterlyFiscalCalendar, or otSemiAnnualFiscalCalendar.

EntityXML

Specifies an XML string containing the fiscal calendar information. Depending on the value of CalendarType, the XML schema is described by one of the following: annualfiscalcalendar.xsd, fixedmonthlyfiscalcalendar.xsd, monthlyfiscalcalendar.xsd, quarterlyfiscalcalendar.xsd, or semiannualfiscalcalendar.xsd.

Return Value

Returns a String type that specifies the ID of the newly created fiscal calendar.

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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMFiscalCalendar proxy object
Microsoft.Crm.Platform.Proxy.CRMFiscalCalendar  fiscalcalendar  = new Microsoft.Crm.Platform.Proxy.CRMFiscalCalendar();
fiscalcalendar.Credentials = System.Net.CredentialCache.DefaultCredentials;
fiscalcalendar.Url = strDir + "CRMFiscalcalendar.srf";

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

   // Set up the XML string for the fiscal calendar
   string xml = "<semiannualfiscalcalendar>";
   xml += "<salespersonid>" + userAuth.UserId + "</salespersonid>";
   xml += "<effectiveon>2002:12:12</effectiveon>";
   xml += "<firsthalf>123.00</firsthalf>";
   xml += "</semiannualfiscalcalendar>";

   int type = Microsoft.Crm.Platform.Types.ObjectType.otSemiAnnualFiscalCalendar;

   string strFiscalCalendarId = fiscalcalendar.Create(userAuth, type, xml);
}
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

© 2005 Microsoft Corporation. All rights reserved.