Share via


GetProfileDefinitions Method

Retrieves a set of profile definitions available to the Marketing system.

Namespace:  Microsoft.CommerceServer.Marketing.WebService
Assembly:  Microsoft.CommerceServer.Marketing.DataManagement (in Microsoft.CommerceServer.Marketing.DataManagement.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Overridable Function GetProfileDefinitions ( _
    profileNames As String() _
) As XmlElement
'Usage
Dim instance As MarketingWebService
Dim profileNames As String()
Dim returnValue As XmlElement

returnValue = instance.GetProfileDefinitions(profileNames)
[WebMethodAttribute]
public virtual XmlElement GetProfileDefinitions(
    string[] profileNames
)
[WebMethodAttribute]
public:
virtual XmlElement^ GetProfileDefinitions(
    array<String^>^ profileNames
)
public function GetProfileDefinitions(
    profileNames : String[]
) : XmlElement

Parameters

  • profileNames
    Type: array<System..::.String>[]()[]
    An optional array of the ProfileDefinition names to retrieve. If nullNothingnullptra null reference (Nothing in Visual Basic) or an empty string list is passed, then all profile definitions available to the campaigns system are returned, including the catalog product schema as a profile definition from Catalog System.

Return Value

Type: System.Xml..::.XmlElement
An XML document containing a set of ProfileDefinition values available.

Exceptions

Exception Condition
NotAuthorizedException

The user is not authorized to perform the requested operation.

EntityDoesNotExistException

One or more user specified ProfileDefinition name(s) does not exist in the Profile System.

Remarks

To get the catalog product schema, the user can either specify a special profile definition named, “Product”, or pass nullNothingnullptra null reference (Nothing in Visual Basic) or empty string list to get all the available profile definitions. GetProfileDefinitions internally uses the Profile system to get a ProfileDefinition and also interacts with the Catalog system to retrieve the catalog schema as a ProfileDefinition.

Permissions

See Also

Reference

MarketingWebService Class

MarketingWebService Members

Microsoft.CommerceServer.Marketing.WebService Namespace