1. Home / Web Services API Version 8.x / UpdateDomain

UpdateDomain

Updates the properties of the specified domain/library.

Syntax

Visual Basic (declaration) 
Public Function UpdateDomain( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal DomainName as String, _ 
	ByVal NewDomainName as String, _ 
	ByVal Anonymous as bool, _ 
	ByVal Hidden as bool, _ 
	ByVal WelcomeMessage as String) as XmlNode

C# (declaration) 
public XmlNode UpdateDomain( 
	string AuthenticationTicket,
	string DomainName,
	string NewDomainName,
	bool Anonymous,
	bool Hidden,
	string WelcomeMessage)

Parameters

AuthenticationTicket
    string infoRouter ticket
DomainName
    string The domain/library name to be updated.
NewDomainName
    string The new name of the domain/library
Anonymous
    bool Sets the Anonymous flag of the domain.
Hidden
    bool Sets the hidden flag of the updated domain
WelcomeMessage
    string Sets the welcome message of the updated domain.

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the domain information has been updated successfully.
if success attribute is "false", the error attribute indicates the encountered error.

Remarks

The caller must be the system administrator.

See Also