NAME
ZCS::Admin::Interfaces::Admin::AdminSoap12 - SOAP Interface for the Admin Web Service
SYNOPSIS
use ZCS::Admin::Interfaces::Admin::AdminSoap12;
my $interface = ZCS::Admin::Interfaces::Admin::AdminSoap12->new();
my $response;
$response = $interface->Auth();
$response = $interface->DelegateAuth();
$response = $interface->SearchDirectory();
$response = $interface->CreateDomain();
$response = $interface->ModifyDomain();
$response = $interface->GetDomain();
$response = $interface->GetAllDomains();
$response = $interface->DeleteDomain();
$response = $interface->GetServer();
$response = $interface->GetAllServers();
$response = $interface->CreateCos();
$response = $interface->GetCos();
$response = $interface->GetAllCos();
$response = $interface->ModifyCos();
$response = $interface->RenameCos();
$response = $interface->DeleteCos();
$response = $interface->CreateAccount();
$response = $interface->ModifyAccount();
$response = $interface->RenameAccount();
$response = $interface->GetAccountInfo();
$response = $interface->GetAccount();
$response = $interface->GetAccountMembership();
$response = $interface->GetAllAccounts();
$response = $interface->GetAllAdminAccounts();
$response = $interface->DeleteAccount();
$response = $interface->CheckPasswordStrength();
$response = $interface->SetPassword();
$response = $interface->AddAccountAlias();
$response = $interface->RemoveAccountAlias();
$response = $interface->EnableArchive();
$response = $interface->DisableArchive();
$response = $interface->ExportMailbox();
$response = $interface->PurgeMovedMailbox();
$response = $interface->GetDistributionList();
$response = $interface->CreateDistributionList();
$response = $interface->DeleteDistributionList();
$response = $interface->GrantRight();
$response = $interface->RevokeRight();DESCRIPTION
SOAP Interface for the Admin web service located at https://localhost:7071/service/admin/soap.
SERVICE Admin
Port AdminSoap12
METHODS
General methods
new
Constructor.
All arguments are forwarded to SOAP::WSDL::Client.
SOAP Service methods
Method synopsis is displayed with hash refs as parameters.
The commented class names in the method's parameters denote that objects of the corresponding class can be passed instead of the marked hash ref.
You may pass any combination of objects, hash and list refs to these methods, as long as you meet the structure.
List items (i.e. multiple occurences) are not displayed in the synopsis. You may generally pass a list ref of hash refs (or objects) instead of a hash ref - this may result in invalid XML if used improperly, though. Note that SOAP::WSDL always expects list references at maximum depth position.
XML attributes are not displayed in this synopsis and cannot be set using hash refs. See the respective class' documentation for additional information.
Auth
Returns a ZCS::Admin::Elements::AuthResponse object.
$response = $interface->Auth( {
name => $some_value, # string
account => { # ZCS::Admin::Types::Account
a => { value => $some_value },
},
password => $some_value, # string
},,
);DelegateAuth
Returns a ZCS::Admin::Elements::DelegateAuthResponse object.
$response = $interface->DelegateAuth( {
account => { value => $some_value },
},,
);SearchDirectory
Returns a ZCS::Admin::Elements::SearchDirectoryResponse object.
$response = $interface->SearchDirectory( {
query => $some_value, # string
},,
);CreateDomain
Returns a ZCS::Admin::Elements::CreateDomainResponse object.
$response = $interface->CreateDomain( {
name => $some_value, # string
a => { value => $some_value },
},,
);ModifyDomain
Returns a ZCS::Admin::Elements::ModifyDomainResponse object.
$response = $interface->ModifyDomain( {
id => $some_value, # string
a => { value => $some_value },
},,
);GetDomain
Returns a ZCS::Admin::Elements::GetDomainResponse object.
$response = $interface->GetDomain( {
domain => { value => $some_value },
},,
);GetAllDomains
Returns a ZCS::Admin::Elements::GetAllDomainsResponse object.
$response = $interface->GetAllDomains(,,
);DeleteDomain
Returns a ZCS::Admin::Elements::DeleteDomainResponse object.
$response = $interface->DeleteDomain( {
id => $some_value, # string
},,
);GetServer
Returns a ZCS::Admin::Elements::GetServerResponse object.
$response = $interface->GetServer( {
server => { value => $some_value },
},,
);GetAllServers
Returns a ZCS::Admin::Elements::GetAllServersResponse object.
$response = $interface->GetAllServers(,,
);CreateCos
Returns a ZCS::Admin::Elements::CreateCosResponse object.
$response = $interface->CreateCos( {
name => $some_value, # string
a => { value => $some_value },
},,
);GetCos
Returns a ZCS::Admin::Elements::GetCosResponse object.
$response = $interface->GetCos( {
cos => { value => $some_value },
},,
);GetAllCos
Returns a ZCS::Admin::Elements::GetAllCosResponse object.
$response = $interface->GetAllCos(,,
);ModifyCos
Returns a ZCS::Admin::Elements::ModifyCosResponse object.
$response = $interface->ModifyCos( {
id => $some_value, # string
a => { value => $some_value },
},,
);RenameCos
Returns a ZCS::Admin::Elements::RenameCosResponse object.
$response = $interface->RenameCos( {
id => $some_value, # string
newName => $some_value, # string
},,
);DeleteCos
Returns a ZCS::Admin::Elements::DeleteCosResponse object.
$response = $interface->DeleteCos( {
id => $some_value, # string
},,
);CreateAccount
Returns a ZCS::Admin::Elements::CreateAccountResponse object.
$response = $interface->CreateAccount( {
name => $some_value, # string
password => $some_value, # string
a => { value => $some_value },
},,
);ModifyAccount
Returns a ZCS::Admin::Elements::ModifyAccountResponse object.
$response = $interface->ModifyAccount( {
id => $some_value, # string
a => { value => $some_value },
},,
);RenameAccount
Returns a ZCS::Admin::Elements::RenameAccountResponse object.
$response = $interface->RenameAccount( {
id => $some_value, # string
newName => $some_value, # string
},,
);GetAccountInfo
Returns a ZCS::Admin::Elements::GetAccountInfoResponse object.
$response = $interface->GetAccountInfo( {
account => { value => $some_value },
},,
);GetAccount
Returns a ZCS::Admin::Elements::GetAccountResponse object.
$response = $interface->GetAccount( {
account => { value => $some_value },
},,
);GetAccountMembership
Returns a ZCS::Admin::Elements::GetAccountMembershipResponse object.
$response = $interface->GetAccountMembership( {
account => { value => $some_value },
},,
);GetAllAccounts
Returns a ZCS::Admin::Elements::GetAllAccountsResponse object.
$response = $interface->GetAllAccounts( {
domain => { value => $some_value },
server => { value => $some_value },
},,
);GetAllAdminAccounts
Returns a ZCS::Admin::Elements::GetAllAdminAccountsResponse object.
$response = $interface->GetAllAdminAccounts(,,
);DeleteAccount
Returns a ZCS::Admin::Elements::DeleteAccountResponse object.
$response = $interface->DeleteAccount( {
id => $some_value, # string
},,
);CheckPasswordStrength
Returns a ZCS::Admin::Elements::CheckPasswordStrengthResponse object.
$response = $interface->CheckPasswordStrength( {
id => $some_value, # string
password => $some_value, # string
},,
);SetPassword
Returns a ZCS::Admin::Elements::SetPasswordResponse object.
$response = $interface->SetPassword( {
id => $some_value, # string
newPassword => $some_value, # string
},,
);AddAccountAlias
Returns a ZCS::Admin::Elements::AddAccountAliasResponse object.
$response = $interface->AddAccountAlias( {
id => $some_value, # string
alias => $some_value, # string
},,
);RemoveAccountAlias
Returns a ZCS::Admin::Elements::RemoveAccountAliasResponse object.
$response = $interface->RemoveAccountAlias( {
id => $some_value, # string
alias => $some_value, # string
},,
);EnableArchive
Returns a ZCS::Admin::Elements::EnableArchiveResponse object.
$response = $interface->EnableArchive( {
account => { value => $some_value },
archive => { # ZCS::Admin::Types::ArchiveSpecifier
name => $some_value, # string
cos => { value => $some_value },
password => $some_value, # string
a => { value => $some_value },
},
},,
);DisableArchive
Returns a ZCS::Admin::Elements::DisableArchiveResponse object.
$response = $interface->DisableArchive( {
account => { value => $some_value },
},,
);ExportMailbox
Returns a ZCS::Admin::Elements::ExportMailboxResponse object.
$response = $interface->ExportMailbox( {
account => ,
},,
);PurgeMovedMailbox
Returns a ZCS::Admin::Elements::PurgeMovedMailboxResponse object.
$response = $interface->PurgeMovedMailbox( {
mbox => ,
},,
);GetDistributionList
Returns a ZCS::Admin::Elements::GetDistributionListResponse object.
$response = $interface->GetDistributionList( {
dl => { value => $some_value },
},,
);CreateDistributionList
Returns a ZCS::Admin::Elements::CreateDistributionListResponse object.
$response = $interface->CreateDistributionList( {
name => $some_value, # string
},,
);DeleteDistributionList
Returns a ZCS::Admin::Elements::DeleteDistributionListResponse object.
$response = $interface->DeleteDistributionList( {
id => $some_value, # string
},,
);GrantRight
Returns a ZCS::Admin::Elements::GrantRightResponse object.
$response = $interface->GrantRight( {
target => ,
grantee => ,
right => ,
},,
);RevokeRight
Returns a ZCS::Admin::Elements::RevokeRightResponse object.
$response = $interface->RevokeRight( {
target => ,
grantee => ,
right => ,
},,
);AUTHOR
Generated by SOAP::WSDL on Fri Oct 21 15:05:29 2011