CRMFiscalCalendar.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates a fiscal calendar and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal CalendarType As Integer,
ByVal EntityId As String,
ByVal EntityXml As String,
ByVal ColumnSet As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
int CalendarType,
string EntityId,
string EntityXml,
string ColumnSet
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
long CalendarType,
String* EntityId,
String* EntityXml,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteUser and prvReadUser privileges and access rights on the object to be updated. See CUserAuth.
CalendarType
Specifies the calendar type. This is one of the following in the ObjectType class: otAnnualFiscalCalendar, otFixedMonthlyFiscalCalendar, otMonthlyFiscalCalendar, otQuarterlyFiscalCalendar, or otSemiAnnualFiscalCalendar.
EntityId
Specifies the ID of the fiscal calendar to be updated.
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.
ColumnSet
Specifies an XML string describing the set of columns that are to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). Depending on the value of CalendarType, you can find the valid column names in one of the following: annualfiscalcalendar.xsd, fixedmonthlyfiscalcalendar.xsd, monthlyfiscalcalendar.xsd, quarterlyfiscalcalendar.xsd, or semiannualfiscalcalendar.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the requested fiscal calendar information. Depending on the value of CalendarType, the fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by one of the following: annualfiscalcalendar.xsd, fixedmonthlyfiscalcalendar.xsd, monthlyfiscalcalendar.xsd, quarterlyfiscalcalendar.xsd, or semiannualfiscalcalendar.xsd.
Remarks
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";
// 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();
string strFiscalCalendarId = "{6B4C1C0D-B62C-4BBF-A1EB-AAEE09ECE4C3}";
string xml = "<semiannualfiscalcalendar>";
xml += "<firsthalf>124.00</firsthalf>";
xml += "</semiannualfiscalcalendar>";
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>firsthalf</column>";
strColumnSetXml += "<column>effectiveon</column>";
strColumnSetXml += "<column>salespersonid</column>";
strColumnSetXml += "</columnset>";
int type = Microsoft.Crm.Platform.Types.ObjectType.otSemiAnnualFiscalCalendar;
// Update and then retrieve the fiscal calendar
string strResultsXml = fiscalcalendar.UpdateAndRetrieve(userAuth, type, strFiscalCalendarId, xml, 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