Class User.UserConsolidatedAddRequest

java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>
co.ecg.alpaca.toolkit.generated.User.UserConsolidatedAddRequest
Enclosing class:
User

@ChoiceGroup("groupExternalId") @ChoiceGroup({"serviceProviderId","groupId"}) @Choice(minOccurs=0,value={@ChoiceGroup("accessDeviceEndpoint"),@ChoiceGroup("trunkAddressing")}) public static class User.UserConsolidatedAddRequest extends Request<DefaultResponse>
The response is either SuccessResponse or ErrorResponse. In AS Data Mode: The group user limit will be increased by one if needed. The group will be added if it does not exist and if the command is executed by a Service Provider level administrator or above. If the group needs to be created, the groupProperties element must be set or the request will fail. The groupProperties element will be ignored if the group already exists. If the domain has not been assigned to the group, it will be added to group if the command is executed by a Service provider level administrator or above. If the domain has not been assigned to the service provider, it will be added to the service provider if the command is executed by a Provisioning level administrator or above. The command will fail otherwise. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if the command is executed by a service provider administrator or above and the number is already assigned to the service provider. The command will fail otherwise. The password is not required if external authentication is enabled. Alternate user ids can be added by a group level administrator or above. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance is not included in the service/service pack of the request or in the "new user template", the request will fail. The userService/servicePack will be authorized to the group if it has not been authorized to the group if the command is executed by a Service Provider level administrator or above. The command will fail otherwise. The authorizedQuantity will be set to unlimited if not present. When thirdPartyVoiceMail elements are included and the Third Party Voice Mail Support service is not included in the service/service pack of the request or in the "new user template", the request will fail. When sipAuthenticationData element is included and the Authentication service is not included in the service/service pack of the request or in the "new user template", the request will fail. In XS data mode: only the System level administrator has the authorization level to execute the command. The group will be added if it does not exist. If the group needs to be created, the groupProperties element must be set or the request will fail. The groupProperties element will be ignored if the group already exists. If the phoneNumber has not been assigned to the group, it will be added to group and service provider if needed. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance is not included in the service/service pack of the request, the request will fail. The following elements are ignored in XS data mode: addPhoneNumberToGroup nameDialingName alternateUserId passcode trunkAddressing thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL sipAuthenticationData isPlace emergencyCallbackNumber
Author:
AlpacaGenerator