CRMFiscalCalendar.RetrieveByUserAndYear Method
The RetrieveByUserAndYear method retrieves any fiscal calendars that are associated with a specified user for specified year.
Syntax
[Visual Basic .NET]
Public Function RetrieveByUserAndYear(
ByVal Caller As CUserAuth,
ByVal CalendarType As Integer,
ByVal UserId As String,
ByVal EffectiveOn As String,
ByVal ColumnSet As String
) As String
[C#]
public string RetrieveByUserAndYear(
CUserAuth Caller,
int CalendarType,
string UserId,
string EffectiveOn,
string ColumnSet
);
[C++]
public: String* RetrieveByUserAndYear(
CUserAuth* Caller,
long CalendarType,
String* UserId,
String* EffectiveOn,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadUser privilege and access rights on the objects to be retrieved. See CUserAuth.
CalendarType
Specifies the calendar type. This is one of the following in the ObjectType class: otAnnualFiscalCalendar, otFixedMonthlyFiscalCalendar, otMonthlyFiscalCalendar, otQuarterlyFiscalCalendar, or otSemiAnnualFiscalCalendar.
UserId
Specifies the identity of the user whose calendar is to be retrieved.
EffectiveOn
Specifies the date on which the calendar becomes effective.
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). 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. The fields that are returned depend on what fields are specified in the ColumnSet parameter. 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.
For example, for a CalendarType of otAnnualFiscalCalendar, the returned XML string is in the following format:
<annualfiscalcalendars> + annualfiscalcalendar1..N + </annualfiscalcalendars>
where annualfiscalcalendar1..N is replaced by the appropriate data based on the annual fiscal calendar schema.
Remarks
Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.
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();
int type = Microsoft.Crm.Platform.Types.ObjectType.otSemiAnnualFiscalCalendar;
// 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>";
// Retrieve by user and by year
string strResultsXml = fiscalcalendar.RetrieveByUserAndYear(userAuth, type, userAuth.UserId, "2002:12:12", 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