CRMArticleTemplate.RetrieveByOrganization Method
The RetrieveByOrganization method retrieves all the active article templates of an organization.
Syntax
[Visual Basic .NET]
Public Function RetrieveByOrganization(
ByVal Caller As CUserAuth,
ByVal OrganizationId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByOrganization(
CUserAuth Caller,
string OrganizationId,
string ColumnSetXML
);
[C++]
public: String* RetrieveByOrganization(
CUserAuth* Caller,
String* OrganizationId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadArticleTemplate privilege and access rights on the objects to be retrieved. See CUserAuth.
OrganizationId
Specifies the ID of the organization.
ColumnSetXML
Specifies an XML string describing the set of columns that is 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 kbarticletemplate.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data representing the article template. The fields that are returned for each team depend on what fields are specified in the ColumnSetXML parameter. This XML string is in the format
<kbarticletemplates> + kbarticletemplate1..N + </kbarticletemplates>
where the XML schema for each article template is described by kbarticletemplate.xsd.
A sample output looks like:
<kbarticletemplates>
<kbarticletemplate>
<title>Title 1</title>
<title>Description 1</title>
</kbarticletemplate>
<kbarticletemplate>
<title>Title 2</title>
<title>Description 2</title>
</kbarticletemplate>
</kbarticletemplates>
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";
// CRMArticleTemplate proxy object
Microsoft.Crm.Platform.Proxy.CRMArticleTemplate articletemplate = new Microsoft.Crm.Platform.Proxy.CRMArticleTemplate ();
articletemplate.Credentials = System.Net.CredentialCache.DefaultCredentials;
articletemplate.Url = strDir + "CRMArticleTemplate.srf";
// BizMerchant proxy object
Microsoft.Crm.Platform.Proxy.BizMerchant merchant = new Microsoft.Crm.Platform.Proxy.BizMerchant ();
merchant.Credentials = System.Net.CredentialCache.DefaultCredentials;
merchant.Url = strDir + "BizMerchant.srf";
string strErrorMsg;
string strOrgId = "{3BECB6A6-0DD8-4061-98D9-0B9E897C5027}"
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>title</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "</columnset>";
// Retrieve the article template
string strArticleTemplatesXml = articletemplate.RetrieveByOrganization(userAuth, strOrgID, 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