Companywebcast API Wiki

AdminService Web Service

http://services.companywebcast.com/admin/1.0/adminservice.svc?wsdl

Description

A Service for management type operations 

Methods: AdminService

Methods
Name  Description 
CustomerCreate  Creates a new customer with the given ChildCustomerCode
CustomerDelete  Remove a customer, fails if a customer has any related data, for example webcasts or users 
CustomerGet  Get a Customer
CustomerList  Get a collection of child Customers, based on a parent CustomerCode
CustomerLogList  Get a collection of logs pertaining to a specific customer Fails if CustomerCode is null 
CustomerMove  Move a Customer from one parent to another Fails if CustomerCode, CustomerCodeChild or CustomerCodeNew is null Fails if either parent does not exist Fails if CustomerCode is not the current parent of CustomerCodeChild
CustomerSave  Saves changes to a Customer
CustomerSearch  Search for one or more customers 
GroupList  ? Fails if CustomerCode is null Fails if the Customer identified by CustomerCode does not exist 
GroupUserAdd  ? Fails if CustomerCode, GroupCode or GroupUserName is null Fails if the User identified by GroupUserName does not belong to the Customer identified by CustomerCode
GroupUserList  ? Fails if a customer can not be found for this CustomerCode Fails if a group can not be found for this GroupCode
GroupUserRemove  ? Removes a User from a group Fails if CustomerCode, GroupCode or GroupUserName is null Fails if the User identified by GroupUserName does not belong to the Customer identified by CustomerCode Fails if the Group identified by GroupCode does not exist 
ProfileCreate  Create a Profile
ProfileGet  Get a Profile
ProfileList  Get a collection of Profiles for a specific customer 
ProfileSave  Persist changes to a Profile
UserAuthenticate  Authenticate a User
UserCreate  Create a new User for a Customer Fails if CustomerCode is null Fails if ClientUsername is already in use 
UserDelete  Permanently remove a user Fails if ClientUsername is null Fails if a User with ClientUsername does not exist 
UserGet  Get a User Fails if Username is null 
UserPasswordSet  Sets a password for a specific User Fails if ClientUsernamePassword is null Fails if a User is not found for ClientUsername
UserSave  Save changes to a User Changes to Name, Properties and Email are persisted Other properties are ignored 
UserSearch  Search for one or more Users 
UserSettingSave  Persist a collection of settings for a specific domain This will not replace the entire domain, just those settings specified in Settings Fails if either Domain or ClientUserName is null 
UserSettingSearch  Get a collection of DomainSettings belonging to a User
Method: CustomerCreate
Description

Creates a new customer with the given ChildCustomerCode

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer this will be the new customer's parent  Username must be authorized for this customer
ChildCustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer, used to create a new customer
Returns

A CustomerCreateResult element.

Output (Literal)

The output of this method is the document element CustomerCreateResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerCreateResult  int  No  0..1  No   
Method: CustomerDelete
Description

Remove a customer, fails if a customer has any related data, for example webcasts or users 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  The customer to be removed
Returns

A CustomerDeleteResult element.

Output (Literal)

The output of this method is the document element CustomerDeleteResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerDeleteResult  int  No  0..1  No   
Method: CustomerGet
Description

Get a Customer

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
ChildCustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
Customer  Customer  Output  Yes  1..1  No  A Customer, or null if not found
Returns

A CustomerGetResult element.

Output (Literal)

The output of this method is the document element CustomerGetResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerGetResult  int  No  0..1  No   
Customer  Customer  No  0..1  Yes   
Method: CustomerList
Description

Get a collection of child Customers, based on a parent CustomerCode

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  The parent customer
Customers  CustomerSummaries  Output  Yes  1..1  No  A collection of Customers
Returns

A CustomerListResult element.

Output (Literal)

The output of this method is the document element CustomerListResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerListResult  int  No  0..1  No   
Customers  CustomerSummaries  No  0..1  Yes   
Method: CustomerLogList
Description

Get a collection of logs pertaining to a specific customer Fails if CustomerCode is null 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
PageNumber  int  Input  No  0..1  No  Used for paginating results
PageSize  int  Input  No  0..1  No  Used for paginating results
LogEntries  LogEntries  Output  Yes  1..1  No  A collection of LogEntrys
Returns

A CustomerLogListResult element.

Output (Literal)

The output of this method is the document element CustomerLogListResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerLogListResult  int  No  0..1  No   
LogEntries  LogEntries  No  0..1  Yes   
Method: CustomerMove
Description

Move a Customer from one parent to another Fails if CustomerCode, CustomerCodeChild or CustomerCodeNew is null Fails if either parent does not exist Fails if CustomerCode is not the current parent of CustomerCodeChild

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  The current parent customer
CustomerCodeChild  string  Input  No  0..1  No  The customer to be moved
CustomerCodeNew  string  Input  No  0..1  No  The new parent customer
Returns

A CustomerMoveResult element.

Output (Literal)

The output of this method is the document element CustomerMoveResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerMoveResult  int  No  0..1  No   
Method: CustomerSave
Description

Saves changes to a Customer

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
Customer  Customer  Input  No  0..1  No  A Customer containing changes that need to be saved
Returns

A CustomerSaveResult element.

Output (Literal)

The output of this method is the document element CustomerSaveResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerSaveResult  int  No  0..1  No   
Method: CustomerSearch
Description

Search for one or more customers 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
UserName  string  Input  No  0..1  No   
Password  string  Input  No  0..1  No  Used for authentication
Id  int  Input  No  0..1  No  Uniquely identifies a customer
Code  string  Input  No  0..1  No  Uniquely identifies a customer
Name  string  Input  No  0..1  No  (part of) a customer's name
OrderBy  CustomerSearchOrder  Input  No  0..1  No  Orders the results
PageNumber  int  Input  No  0..1  No  Used for paginating results
PageSize  int  Input  No  0..1  No  Used for paginating results
Customers  CustomerSummaries  Output  Yes  1..1  No  A collection of Customers
Returns

A CustomerSearchResult element.

Output (Literal)

The output of this method is the document element CustomerSearchResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
CustomerSearchResult  int  No  0..1  No   
Customers  CustomerSummaries  No  0..1  Yes   
Method: GroupList
Description

? Fails if CustomerCode is null Fails if the Customer identified by CustomerCode does not exist 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
Groups  Groups  Output  Yes  1..1  No  A collection of Groups
Returns

A GroupListResult element.

Output (Literal)

The output of this method is the document element GroupListResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
GroupListResult  int  No  0..1  No   
Groups  Groups  No  0..1  Yes   
Method: GroupUserAdd
Description

? Fails if CustomerCode, GroupCode or GroupUserName is null Fails if the User identified by GroupUserName does not belong to the Customer identified by CustomerCode

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
GroupCode  string  Input  No  0..1  No  Uniquely identifies a group
GroupUsername  string  Input  No  0..1  No  Uniquely identifies a user
Returns

A GroupUserAddResult element.

Output (Literal)

The output of this method is the document element GroupUserAddResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
GroupUserAddResult  int  No  0..1  No   
Method: GroupUserList
Description

? Fails if a customer can not be found for this CustomerCode Fails if a group can not be found for this GroupCode

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
GroupCode  string  Input  No  0..1  No  Uniquely identifies a group
Users  GroupUsers  Output  Yes  1..1  No  A collection of group users
Returns

A GroupUserListResult element.

Output (Literal)

The output of this method is the document element GroupUserListResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
GroupUserListResult  int  No  0..1  No   
Users  GroupUsers  No  0..1  Yes   
Method: GroupUserRemove
Description

? Removes a User from a group Fails if CustomerCode, GroupCode or GroupUserName is null Fails if the User identified by GroupUserName does not belong to the Customer identified by CustomerCode Fails if the Group identified by GroupCode does not exist 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
GroupCode  string  Input  No  0..1  No  Uniquely identifies a group
GroupUsername  string  Input  No  0..1  No  Uniquely identifies a user
Returns

A GroupUserRemoveResult element.

Output (Literal)

The output of this method is the document element GroupUserRemoveResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
GroupUserRemoveResult  int  No  0..1  No   
Method: ProfileCreate
Description

Create a Profile

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
ProfileCode  string  Output  Yes  1..1  No  Uniquely identifies the created Profile
Returns

A ProfileCreateResult element.

Output (Literal)

The output of this method is the document element ProfileCreateResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
ProfileCreateResult  int  No  0..1  No   
ProfileCode  string  No  0..1  Yes   
Method: ProfileGet
Description

Get a Profile

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
ProfileCode  string  Input  No  0..1  No  Uniquely identifies a Profile
Profile  Profile  Output  Yes  1..1  No  A Profile
Returns

A ProfileGetResult element.

Output (Literal)

The output of this method is the document element ProfileGetResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
ProfileGetResult  int  No  0..1  No   
Profile  Profile  No  0..1  Yes   
Method: ProfileList
Description

Get a collection of Profiles for a specific customer 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
Profiles  ProfileSummaries  Output  Yes  1..1  No  A collection of Profiles
Returns

A ProfileListResult element.

Output (Literal)

The output of this method is the document element ProfileListResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
ProfileListResult  int  No  0..1  No   
Profiles  ProfileSummaries  No  0..1  Yes   
Method: ProfileSave
Description

Persist changes to a Profile

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
Profile  Profile  Input  No  0..1  No  The profile that needs to be persisted
Returns

A ProfileSaveResult element.

Output (Literal)

The output of this method is the document element ProfileSaveResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
ProfileSaveResult  int  No  0..1  No   
Method: UserAuthenticate
Description

Authenticate a User

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
IsAuthenticated  boolean  Output  Yes  1..1  No  True if authenticated, false otherwise
Returns

A UserAuthenticateResult element.

Output (Literal)

The output of this method is the document element UserAuthenticateResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserAuthenticateResult  int  No  0..1  No   
IsAuthenticated  boolean  No  0..1  No   
Method: UserCreate
Description

Create a new User for a Customer Fails if CustomerCode is null Fails if ClientUsername is already in use 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
ClientUsername  string  Input  No  0..1  No  Name used to create a new User
Returns

A UserCreateResult element.

Output (Literal)

The output of this method is the document element UserCreateResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserCreateResult  int  No  0..1  No   
Method: UserDelete
Description

Permanently remove a user Fails if ClientUsername is null Fails if a User with ClientUsername does not exist 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
ClientUsername  string  Input  No  0..1  No  Uniquely identifies a User to be deleted
Returns

A UserDeleteResult element.

Output (Literal)

The output of this method is the document element UserDeleteResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserDeleteResult  int  No  0..1  No   
Method: UserGet
Description

Get a User Fails if Username is null 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
ClientUsername  string  Input  No  0..1  No  Uniquely identifies a User
User  User  Output  Yes  1..1  No  A User
Returns

A UserGetResult element.

Output (Literal)

The output of this method is the document element UserGetResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserGetResult  int  No  0..1  No   
User  User  No  0..1  Yes   
Method: UserPasswordSet
Description

Sets a password for a specific User Fails if ClientUsernamePassword is null Fails if a User is not found for ClientUsername

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
ClientUsername  string  Input  No  0..1  No  Uniquely identifies a User
ClientUsernamePassword  string  Input  No  0..1  No  The new password
Returns

A UserPasswordSetResult element.

Output (Literal)

The output of this method is the document element UserPasswordSetResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserPasswordSetResult  int  No  0..1  No   
Method: UserSave
Description

Save changes to a User Changes to Name, Properties and Email are persisted Other properties are ignored 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
User  User  Input  No  0..1  No  User to be persisted
Returns

A UserSaveResult element.

Output (Literal)

The output of this method is the document element UserSaveResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserSaveResult  int  No  0..1  No   
Method: UserSearch
Description

Search for one or more Users 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
CustomerCode  string  Input  No  0..1  No  Uniquely identifies a customer
Email  string  Input  No  0..1  No  (part of) a valid email adress
Role  string  Input  No  0..1  No  Only users who have this role will be returned, use "none" to return users with no roles
Name  string  Input  No  0..1  No  (part of) the user's name
Domain  string  Input  No  0..1  No  Only users who have settings belonging to this domain will be returned
Setting  string  Input  No  0..1  No  Only users who have this setting will be returned
QueryText  string  Input  No  0..1  No  A generic way of searching for users
Order  UserSearchOrder  Input  No  0..1  No  Used for ordering results
PageNumber  int  Input  No  0..1  No  Used for paginating results
PageSize  int  Input  No  0..1  No  Used for paginating results
Users  UserSummaries  Output  Yes  1..1  No  A collection of Users
Returns

A UserSearchResult element.

Output (Literal)

The output of this method is the document element UserSearchResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserSearchResult  int  No  0..1  No   
Users  UserSummaries  No  0..1  Yes   
Method: UserSettingSave
Description

Persist a collection of settings for a specific domain This will not replace the entire domain, just those settings specified in Settings Fails if either Domain or ClientUserName is null 

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
ClientUserName  string  Input  No  0..1  No  Owner of the settings to be persisted
Domain  string  Input  No  0..1  No  Domain to which these settings belong
Settings  Settings  Input  No  0..1  No  A collection of settings
Returns

A UserSettingSaveResult element.

Output (Literal)

The output of this method is the document element UserSettingSaveResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserSettingSaveResult  int  No  0..1  No   
Method: UserSettingSearch
Description

Get a collection of DomainSettings belonging to a User

Parameters
Name  Type  Direction  Required?  Occurs  Nillable?  Description 
Username  string  Input  No  0..1  No  Used for authentication
Password  string  Input  No  0..1  No  Used for authentication
ClientUserName  string  Input  No  0..1  No  Uniquely identifies a user
Domain  string  Input  No  0..1  No  Only settings belonging to this domain will be returned
Setting  string  Input  No  0..1  No  Only this setting will be returned
settings  DomainSettings  Output  Yes  1..1  No  A collection of DomainSettings
Returns

A UserSettingSearchResult element.

Output (Literal)

The output of this method is the document element UserSettingSearchResponse having the structure defined by the following table.

Name  Type  Required?  Occurs  Nillable?  Description 
UserSettingSearchResult  int  No  0..1  No   
settings  DomainSettings  No  0..1  Yes   

Complex Types: AdminService

Complex Types
Name  Description 
ArrayOfModule   
ArrayOfstring   
Customer  Represents a Customer
CustomerSummaries  A collection of CustomerSummarys
CustomerSummary  A concise representation of a customer
DomainSetting  Helper class, used to map settings to a domain
DomainSettings  A collection of DomainSettings
Groups  A collection of Role Groups
GroupUsers  A collection of Role Group Users
KeyValueItem  A key / value pair
LogEntries  A collection of LogEntrys
LogEntry  An Agatha-related log entry Describes events logged in the Agatha pipeline
Name  A person's name
Profile  Metadata defaults used to create new webcasts
ProfileSummaries  A collection of ProfileSummarys
ProfileSummary   
Properties  A Collection of KeyValueItems
Settings  A collection of settings
User  A system user
UserSummaries  A collection of Users
Complex Type: ArrayOfModule
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Module  Module  0..*   
Element: Module (type ArrayOfModule)
Referenced By
Name  Type 
ArrayOfModule  Complex Type 
Definition

See ArrayOfModule

Complex Type: ArrayOfstring
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
string  string  0..*   
Element: string (type ArrayOfstring)
Referenced By
Name  Type 
ArrayOfstring  Complex Type 
Definition

See ArrayOfstring

Complex Type: Customer
Description

Represents a Customer

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1  Uniquely identifies this customer
Description  string  0..1  A customer's description
Name  string  0..1  A customer's name
Reference  string  0..1  An external reference
TimeZoneName  string  0..1  The time zone name pertaining to this customer
Referenced By
Name  Type 
Customer (element CustomerGetResponse)  Element 
Element: Code (type Customer)
Referenced By
Name  Type 
Customer  Complex Type 
Definition

See Customer

Element: Description (type Customer)
Referenced By
Name  Type 
Customer  Complex Type 
Definition

See Customer

Element: Name (type Customer)
Referenced By
Name  Type 
Customer  Complex Type 
Definition

See Customer

Element: Reference (type Customer)
Referenced By
Name  Type 
Customer  Complex Type 
Definition

See Customer

Element: TimeZoneName (type Customer)
Referenced By
Name  Type 
Customer  Complex Type 
Definition

See Customer

Complex Type: CustomerSummaries
Description

A collection of CustomerSummarys

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerSummary  CustomerSummary  0..*   
Referenced By
Name  Type 
Customers (element CustomerListResponse)  Element 
Customers (element CustomerSearchResponse)  Element 
Element: CustomerSummary (type CustomerSummaries)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1  Uniquely identifies this Customer
Name  string  0..1  this Customer's name
Referenced By
Name  Type 
CustomerSummaries  Complex Type 
Definition

See CustomerSummaries

Complex Type: CustomerSummary
Description

A concise representation of a customer

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1  Uniquely identifies this Customer
Name  string  0..1  this Customer's name
Element: Code (type CustomerSummary)
Referenced By
Name  Type 
CustomerSummary  Complex Type 
Definition

See CustomerSummary

Element: Name (type CustomerSummary)
Referenced By
Name  Type 
CustomerSummary  Complex Type 
Definition

See CustomerSummary

Complex Type: DomainSetting
Description

Helper class, used to map settings to a domain

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Domain  string  0..1   
Setting  string  0..1   
Element: Domain (type DomainSetting)
Referenced By
Name  Type 
DomainSetting  Complex Type 
Definition

See DomainSetting

Element: Setting (type DomainSetting)
Referenced By
Name  Type 
DomainSetting  Complex Type 
Definition

See DomainSetting

Complex Type: DomainSettings
Description

A collection of DomainSettings

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
DomainSetting  DomainSetting  0..*   
Referenced By
Name  Type 
settings (element UserSettingSearchResponse)  Element 
Element: DomainSetting (type DomainSettings)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Domain  string  0..1   
Setting  string  0..1   
Referenced By
Name  Type 
DomainSettings  Complex Type 
Definition

See DomainSettings

Complex Type: Groups
Description

A collection of Role Groups

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
string  string  0..*   
Referenced By
Name  Type 
Groups (element GroupListResponse)  Element 
Element: string (type Groups)
Referenced By
Name  Type 
Groups  Complex Type 
Definition

See Groups

Complex Type: GroupUsers
Description

A collection of Role Group Users

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
string  string  0..*   
Referenced By
Name  Type 
Users (element GroupUserListResponse)  Element 
Element: string (type GroupUsers)
Referenced By
Name  Type 
GroupUsers  Complex Type 
Definition

See GroupUsers

Complex Type: KeyValueItem
Description

A key / value pair

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Key  string  0..1   
Value  string  0..1   
Element: Key (type KeyValueItem)
Referenced By
Name  Type 
KeyValueItem  Complex Type 
Definition

See KeyValueItem

Element: Value (type KeyValueItem)
Referenced By
Name  Type 
KeyValueItem  Complex Type 
Definition

See KeyValueItem

Complex Type: LogEntries
Description

A collection of LogEntrys

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
LogEntry  LogEntry  0..*   
Referenced By
Name  Type 
LogEntries (element CustomerLogListResponse)  Element 
Element: LogEntry (type LogEntries)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ActionCode  string  0..1  Type of action that caused this entry to be created
At  dateTime  0..1  Time of creation
ObjectCode  string  0..1  Identifier of object that was affected
ObjectType  string  0..1  Type of object that was affected
UserName  string  0..1  User that caused this entry to be created
Referenced By
Name  Type 
LogEntries  Complex Type 
Definition

See LogEntries

Complex Type: LogEntry
Description

An Agatha-related log entry Describes events logged in the Agatha pipeline

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ActionCode  string  0..1  Type of action that caused this entry to be created
At  dateTime  0..1  Time of creation
ObjectCode  string  0..1  Identifier of object that was affected
ObjectType  string  0..1  Type of object that was affected
UserName  string  0..1  User that caused this entry to be created
Element: ActionCode (type LogEntry)
Referenced By
Name  Type 
LogEntry  Complex Type 
Definition

See LogEntry

Element: At (type LogEntry)
Referenced By
Name  Type 
LogEntry  Complex Type 
Definition

See LogEntry

Element: ObjectCode (type LogEntry)
Referenced By
Name  Type 
LogEntry  Complex Type 
Definition

See LogEntry

Element: ObjectType (type LogEntry)
Referenced By
Name  Type 
LogEntry  Complex Type 
Definition

See LogEntry

Element: UserName (type LogEntry)
Referenced By
Name  Type 
LogEntry  Complex Type 
Definition

See LogEntry

Complex Type: Name
Description

A person's name

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
First  string  0..1   
Last  string  0..1   
Middle  string  0..1   
Title  string  0..1   
Element: First (type Name)
Referenced By
Name  Type 
Name  Complex Type 
Definition

See Name

Element: Last (type Name)
Referenced By
Name  Type 
Name  Complex Type 
Definition

See Name

Element: Middle (type Name)
Referenced By
Name  Type 
Name  Complex Type 
Definition

See Name

Element: Title (type Name)
Referenced By
Name  Type 
Name  Complex Type 
Definition

See Name

Complex Type: Profile
Description

Metadata defaults used to create new webcasts

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1   
DefaultTitle  string  0..1   
Modules  ArrayOfModule  0..1   
Name  string  0..1   
Public  boolean  0..1   
Referenced By
Name  Type 
Profile (element ProfileGetResponse)  Element 
Element: Code (type Profile)
Referenced By
Name  Type 
Profile  Complex Type 
Definition

See Profile

Element: DefaultTitle (type Profile)
Referenced By
Name  Type 
Profile  Complex Type 
Definition

See Profile

Element: Modules (type Profile)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Module  Module  0..*   
Referenced By
Name  Type 
Profile  Complex Type 
Definition

See Profile

Element: Name (type Profile)
Referenced By
Name  Type 
Profile  Complex Type 
Definition

See Profile

Element: Public (type Profile)
Referenced By
Name  Type 
Profile  Complex Type 
Definition

See Profile

Complex Type: ProfileSummaries
Description

A collection of ProfileSummarys

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ProfileSummary  ProfileSummary  0..*   
Referenced By
Name  Type 
Profiles (element ProfileListResponse)  Element 
Element: ProfileSummary (type ProfileSummaries)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1   
Title  string  0..1   
Referenced By
Name  Type 
ProfileSummaries  Complex Type 
Definition

See ProfileSummaries

Complex Type: ProfileSummary
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1   
Title  string  0..1   
Element: Code (type ProfileSummary)
Referenced By
Name  Type 
ProfileSummary  Complex Type 
Definition

See ProfileSummary

Element: Title (type ProfileSummary)
Referenced By
Name  Type 
ProfileSummary  Complex Type 
Definition

See ProfileSummary

Complex Type: Properties
Description

A Collection of KeyValueItems

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
KeyValueItem  KeyValueItem  0..*   
Element: KeyValueItem (type Properties)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Key  string  0..1   
Value  string  0..1   
Referenced By
Name  Type 
Properties  Complex Type 
Definition

See Properties

Complex Type: Settings
Description

A collection of settings

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
string  string  0..*   
Element: string (type Settings)
Referenced By
Name  Type 
Settings  Complex Type 
Definition

See Settings

Complex Type: User
Description

A system user

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerCode  string  0..1  Identifies the customer to whom this user belongs
Email  string  0..1  The user's email adress
Groups  ArrayOfstring  0..1  A collection of role groups
Name  Name  0..1  The user's actual Name
Properties  Properties  0..1  A collection of custom settings
Username  string  0..1  The user's username
Referenced By
Name  Type 
User (element UserGetResponse)  Element 
Element: CustomerCode (type User)
Referenced By
Name  Type 
User  Complex Type 
Definition

See User

Element: Email (type User)
Referenced By
Name  Type 
User  Complex Type 
Definition

See User

Element: Groups (type User)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
string  string  0..*   
Referenced By
Name  Type 
User  Complex Type 
Definition

See User

Element: Name (type User)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
First  string  0..1   
Last  string  0..1   
Middle  string  0..1   
Title  string  0..1   
Referenced By
Name  Type 
User  Complex Type 
Definition

See User

Element: Properties (type User)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
KeyValueItem  KeyValueItem  0..*   
Referenced By
Name  Type 
User  Complex Type 
Definition

See User

Element: Username (type User)
Referenced By
Name  Type 
User  Complex Type 
Definition

See User

Complex Type: UserSummaries
Description

A collection of Users

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
User  User  0..*   
Referenced By
Name  Type 
Users (element UserSearchResponse)  Element 
Element: User (type UserSummaries)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerCode  string  0..1  Identifies the customer to whom this user belongs
Email  string  0..1  The user's email adress
Groups  ArrayOfstring  0..1  A collection of role groups
Name  Name  0..1  The user's actual Name
Properties  Properties  0..1  A collection of custom settings
Username  string  0..1  The user's username
Referenced By
Name  Type 
UserSummaries  Complex Type 
Definition

See UserSummaries

Simple Types: AdminService

Simple Types
Name  Description 
CustomerSearchOrder  Used to determine sort order for customer related queries
UserSearchOrder  Used to order user related queries
Simple Type: CustomerSearchOrder
Enumeration
Value  Description 
IdAsc   
IdDesc   
CodeAsc   
CodeDesc   
NameAsc   
NameDesc   
DomainAsc   
DomainDesc   
Simple Type: UserSearchOrder
Enumeration
Value  Description 
IdAsc   
IdDesc   
UserNameAsc   
UserNameDesc   
EmailAsc   
EmailDesc   
FirstNameAsc   
FirstNameDesc   
LastNameAsc   
LastNameDesc   

Elements: AdminService

Elements
Name  Description 
Customer (element CustomerGetResponse)   
CustomerCreateResponse   
CustomerCreateResult (element CustomerCreateResponse)   
CustomerDeleteResponse   
CustomerDeleteResult (element CustomerDeleteResponse)   
CustomerGetResponse   
CustomerGetResult (element CustomerGetResponse)   
CustomerListResponse   
CustomerListResult (element CustomerListResponse)   
CustomerLogListResponse   
CustomerLogListResult (element CustomerLogListResponse)   
CustomerMoveResponse   
CustomerMoveResult (element CustomerMoveResponse)   
Customers (element CustomerListResponse)   
Customers (element CustomerSearchResponse)   
CustomerSaveResponse   
CustomerSaveResult (element CustomerSaveResponse)   
CustomerSearchResponse   
CustomerSearchResult (element CustomerSearchResponse)   
GroupListResponse   
GroupListResult (element GroupListResponse)   
Groups (element GroupListResponse)   
GroupUserAddResponse   
GroupUserAddResult (element GroupUserAddResponse)   
GroupUserListResponse   
GroupUserListResult (element GroupUserListResponse)   
GroupUserRemoveResponse   
GroupUserRemoveResult (element GroupUserRemoveResponse)   
IsAuthenticated (element UserAuthenticateResponse)   
LogEntries (element CustomerLogListResponse)   
Profile (element ProfileGetResponse)   
ProfileCode (element ProfileCreateResponse)   
ProfileCreateResponse   
ProfileCreateResult (element ProfileCreateResponse)   
ProfileGetResponse   
ProfileGetResult (element ProfileGetResponse)   
ProfileListResponse   
ProfileListResult (element ProfileListResponse)   
Profiles (element ProfileListResponse)   
ProfileSaveResponse   
ProfileSaveResult (element ProfileSaveResponse)   
settings (element UserSettingSearchResponse)   
User (element UserGetResponse)   
UserAuthenticateResponse   
UserAuthenticateResult (element UserAuthenticateResponse)   
UserCreateResponse   
UserCreateResult (element UserCreateResponse)   
UserDeleteResponse   
UserDeleteResult (element UserDeleteResponse)   
UserGetResponse   
UserGetResult (element UserGetResponse)   
UserPasswordSetResponse   
UserPasswordSetResult (element UserPasswordSetResponse)   
Users (element GroupUserListResponse)   
Users (element UserSearchResponse)   
UserSaveResponse   
UserSaveResult (element UserSaveResponse)   
UserSearchResponse   
UserSearchResult (element UserSearchResponse)   
UserSettingSaveResponse   
UserSettingSaveResult (element UserSettingSaveResponse)   
UserSettingSearchResponse   
UserSettingSearchResult (element UserSettingSearchResponse)   
Element: CustomerCreateResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerCreateResult  int  0..1   
Element: CustomerCreateResult (element CustomerCreateResponse)
Referenced By
Name  Type 
CustomerCreateResponse  Element 
CustomerCreate  Method 
Definition

See CustomerCreateResponse

Element: CustomerDeleteResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerDeleteResult  int  0..1   
Element: CustomerDeleteResult (element CustomerDeleteResponse)
Referenced By
Name  Type 
CustomerDeleteResponse  Element 
CustomerDelete  Method 
Definition

See CustomerDeleteResponse

Element: CustomerGetResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerGetResult  int  0..1   
Customer  Customer  0..1   
Element: CustomerGetResult (element CustomerGetResponse)
Referenced By
Name  Type 
CustomerGetResponse  Element 
CustomerGet  Method 
Definition

See CustomerGetResponse

Element: Customer (element CustomerGetResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1  Uniquely identifies this customer
Description  string  0..1  A customer's description
Name  string  0..1  A customer's name
Reference  string  0..1  An external reference
TimeZoneName  string  0..1  The time zone name pertaining to this customer
Referenced By
Name  Type 
CustomerGetResponse  Element 
CustomerGet  Method 
Definition

See CustomerGetResponse

Element: CustomerListResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerListResult  int  0..1   
Customers  CustomerSummaries  0..1   
Element: CustomerListResult (element CustomerListResponse)
Referenced By
Name  Type 
CustomerListResponse  Element 
CustomerList  Method 
Definition

See CustomerListResponse

Element: Customers (element CustomerListResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerSummary  CustomerSummary  0..*   
Referenced By
Name  Type 
CustomerListResponse  Element 
CustomerList  Method 
Definition

See CustomerListResponse

Element: CustomerLogListResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerLogListResult  int  0..1   
LogEntries  LogEntries  0..1   
Element: CustomerLogListResult (element CustomerLogListResponse)
Referenced By
Name  Type 
CustomerLogListResponse  Element 
CustomerLogList  Method 
Definition

See CustomerLogListResponse

Element: LogEntries (element CustomerLogListResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
LogEntry  LogEntry  0..*   
Referenced By
Name  Type 
CustomerLogListResponse  Element 
CustomerLogList  Method 
Definition

See CustomerLogListResponse

Element: CustomerMoveResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerMoveResult  int  0..1   
Element: CustomerMoveResult (element CustomerMoveResponse)
Referenced By
Name  Type 
CustomerMoveResponse  Element 
CustomerMove  Method 
Definition

See CustomerMoveResponse

Element: CustomerSaveResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerSaveResult  int  0..1   
Element: CustomerSaveResult (element CustomerSaveResponse)
Referenced By
Name  Type 
CustomerSaveResponse  Element 
CustomerSave  Method 
Definition

See CustomerSaveResponse

Element: CustomerSearchResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerSearchResult  int  0..1   
Customers  CustomerSummaries  0..1   
Element: CustomerSearchResult (element CustomerSearchResponse)
Referenced By
Name  Type 
CustomerSearchResponse  Element 
CustomerSearch  Method 
Definition

See CustomerSearchResponse

Element: Customers (element CustomerSearchResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerSummary  CustomerSummary  0..*   
Referenced By
Name  Type 
CustomerSearchResponse  Element 
CustomerSearch  Method 
Definition

See CustomerSearchResponse

Element: GroupListResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
GroupListResult  int  0..1   
Groups  Groups  0..1   
Element: GroupListResult (element GroupListResponse)
Referenced By
Name  Type 
GroupListResponse  Element 
GroupList  Method 
Definition

See GroupListResponse

Element: Groups (element GroupListResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
string  string  0..*   
Referenced By
Name  Type 
GroupListResponse  Element 
GroupList  Method 
Definition

See GroupListResponse

Element: GroupUserAddResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
GroupUserAddResult  int  0..1   
Element: GroupUserAddResult (element GroupUserAddResponse)
Referenced By
Name  Type 
GroupUserAddResponse  Element 
GroupUserAdd  Method 
Definition

See GroupUserAddResponse

Element: GroupUserListResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
GroupUserListResult  int  0..1   
Users  GroupUsers  0..1   
Element: GroupUserListResult (element GroupUserListResponse)
Referenced By
Name  Type 
GroupUserListResponse  Element 
GroupUserList  Method 
Definition

See GroupUserListResponse

Element: Users (element GroupUserListResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
string  string  0..*   
Referenced By
Name  Type 
GroupUserListResponse  Element 
GroupUserList  Method 
Definition

See GroupUserListResponse

Element: GroupUserRemoveResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
GroupUserRemoveResult  int  0..1   
Element: GroupUserRemoveResult (element GroupUserRemoveResponse)
Referenced By
Name  Type 
GroupUserRemoveResponse  Element 
GroupUserRemove  Method 
Definition

See GroupUserRemoveResponse

Element: ProfileCreateResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ProfileCreateResult  int  0..1   
ProfileCode  string  0..1   
Element: ProfileCreateResult (element ProfileCreateResponse)
Referenced By
Name  Type 
ProfileCreateResponse  Element 
ProfileCreate  Method 
Definition

See ProfileCreateResponse

Element: ProfileCode (element ProfileCreateResponse)
Referenced By
Name  Type 
ProfileCreateResponse  Element 
ProfileCreate  Method 
Definition

See ProfileCreateResponse

Element: ProfileGetResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ProfileGetResult  int  0..1   
Profile  Profile  0..1   
Element: ProfileGetResult (element ProfileGetResponse)
Referenced By
Name  Type 
ProfileGetResponse  Element 
ProfileGet  Method 
Definition

See ProfileGetResponse

Element: Profile (element ProfileGetResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code  string  0..1   
DefaultTitle  string  0..1   
Modules  ArrayOfModule  0..1   
Name  string  0..1   
Public  boolean  0..1   
Referenced By
Name  Type 
ProfileGetResponse  Element 
ProfileGet  Method 
Definition

See ProfileGetResponse

Element: ProfileListResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ProfileListResult  int  0..1   
Profiles  ProfileSummaries  0..1   
Element: ProfileListResult (element ProfileListResponse)
Referenced By
Name  Type 
ProfileListResponse  Element 
ProfileList  Method 
Definition

See ProfileListResponse

Element: Profiles (element ProfileListResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ProfileSummary  ProfileSummary  0..*   
Referenced By
Name  Type 
ProfileListResponse  Element 
ProfileList  Method 
Definition

See ProfileListResponse

Element: ProfileSaveResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
ProfileSaveResult  int  0..1   
Element: ProfileSaveResult (element ProfileSaveResponse)
Referenced By
Name  Type 
ProfileSaveResponse  Element 
ProfileSave  Method 
Definition

See ProfileSaveResponse

Element: UserAuthenticateResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserAuthenticateResult  int  0..1   
IsAuthenticated  boolean  0..1   
Element: UserAuthenticateResult (element UserAuthenticateResponse)
Referenced By
Name  Type 
UserAuthenticateResponse  Element 
UserAuthenticate  Method 
Definition

See UserAuthenticateResponse

Element: IsAuthenticated (element UserAuthenticateResponse)
Referenced By
Name  Type 
UserAuthenticateResponse  Element 
UserAuthenticate  Method 
Definition

See UserAuthenticateResponse

Element: UserCreateResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserCreateResult  int  0..1   
Element: UserCreateResult (element UserCreateResponse)
Referenced By
Name  Type 
UserCreateResponse  Element 
UserCreate  Method 
Definition

See UserCreateResponse

Element: UserDeleteResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserDeleteResult  int  0..1   
Element: UserDeleteResult (element UserDeleteResponse)
Referenced By
Name  Type 
UserDeleteResponse  Element 
UserDelete  Method 
Definition

See UserDeleteResponse

Element: UserGetResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserGetResult  int  0..1   
User  User  0..1   
Element: UserGetResult (element UserGetResponse)
Referenced By
Name  Type 
UserGetResponse  Element 
UserGet  Method 
Definition

See UserGetResponse

Element: User (element UserGetResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
CustomerCode  string  0..1  Identifies the customer to whom this user belongs
Email  string  0..1  The user's email adress
Groups  ArrayOfstring  0..1  A collection of role groups
Name  Name  0..1  The user's actual Name
Properties  Properties  0..1  A collection of custom settings
Username  string  0..1  The user's username
Referenced By
Name  Type 
UserGetResponse  Element 
UserGet  Method 
Definition

See UserGetResponse

Element: UserPasswordSetResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserPasswordSetResult  int  0..1   
Element: UserPasswordSetResult (element UserPasswordSetResponse)
Referenced By
Name  Type 
UserPasswordSetResponse  Element 
UserPasswordSet  Method 
Definition

See UserPasswordSetResponse

Element: UserSaveResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserSaveResult  int  0..1   
Element: UserSaveResult (element UserSaveResponse)
Referenced By
Name  Type 
UserSaveResponse  Element 
UserSave  Method 
Definition

See UserSaveResponse

Element: UserSearchResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserSearchResult  int  0..1   
Users  UserSummaries  0..1   
Element: UserSearchResult (element UserSearchResponse)
Referenced By
Name  Type 
UserSearchResponse  Element 
UserSearch  Method 
Definition

See UserSearchResponse

Element: Users (element UserSearchResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
User  User  0..*   
Referenced By
Name  Type 
UserSearchResponse  Element 
UserSearch  Method 
Definition

See UserSearchResponse

Element: UserSettingSaveResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserSettingSaveResult  int  0..1   
Element: UserSettingSaveResult (element UserSettingSaveResponse)
Referenced By
Name  Type 
UserSettingSaveResponse  Element 
UserSettingSave  Method 
Definition

See UserSettingSaveResponse

Element: UserSettingSearchResponse
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
UserSettingSearchResult  int  0..1   
settings  DomainSettings  0..1   
Element: UserSettingSearchResult (element UserSettingSearchResponse)
Referenced By
Name  Type 
UserSettingSearchResponse  Element 
UserSettingSearch  Method 
Definition

See UserSettingSearchResponse

Element: settings (element UserSettingSearchResponse)
Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
DomainSetting  DomainSetting  0..*   
Referenced By
Name  Type 
UserSettingSearchResponse  Element 
UserSettingSearch  Method 
Definition

See UserSettingSearchResponse