Share via


CRMSalesPerson.RetrieveByOrganization Method

The RetrieveByOrganization method retrieves all salesperson objects that are assigned to an organization.

Syntax

[Visual Basic .NET]
Public Function RetrieveByOrganization(
  ByVal Caller As CUserAuth,
  ByVal OrganizationId As String,
  ByVal FiscalCalendarType As Integer,
  ByVal FiscalCalendarEffectiveOn As String,
  ByVal FiscalPeriod As Integer,
  ByVal ColumnSet As String
) As String
[C#]
public string RetrieveByOrganization(
  CUserAuth  Caller,
  string  OrganizationId,
  int  FiscalCalendarType,
  string  FiscalCalendarEffectiveOn,
  int  FiscalPeriod,
  string  ColumnSet
);
[C++]
public: String* RetrieveByOrganization(
  CUserAuth*  Caller,
  String*  OrganizationId,
  long  FiscalCalendarType,
  String*  FiscalCalendarEffectiveOn,
  long  FiscalPeriod,
  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.

OrganizationId

Specifies the ID of the organization.

FiscalCalendarType

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

FiscalCalendarEffectiveOn

Specifies the date on which the fiscal calendar is effective (beginning of the fiscal year).

FiscalPeriod

Specifies the fiscal period number (1Â…13).

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). You can find the valid column names in systemuser.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data containing the set of salesperson objects requested. The fields that are returned depend on what fields are specified in the ColumnSet parameter. This XML string is in the format

<systemusers> + systemuser1..N + </systemusers>

where the XML schema for each salesperson is described by systemuser.xsd.

Remarks

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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "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://" + strServerName + "/" + 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";

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

string strErrorMsg;
string strOrganizationId = "{B2BB383D-C9F2-4235-98DE-4A59F7569432}";

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

   // Set the fiscal calendar type
   int ftype = Microsoft.Crm.Platform.Types.CALENDAR_TYPE_CODE.CTC_APPOINTMENT;

   // Set up the columns that you want to retrieve
   string strColumnSet = "<columnset>";
   strColumnSet += "<column>fullname</column>";
   strColumnSet += "<column>businessunitid</column>";
   strColumnSet += "</columnset>";

   // Retrieve the salesperson objects by organization
   string strResultsXml = salesperson.RetrieveByOrganization (userAuth, strOrganizationId, ftype, "20030101T00:00:00", 1, strColumnSet);

}
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.