Class User.UserConsolidatedModifyRequest

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

public static class User.UserConsolidatedModifyRequest extends Request<DefaultResponse>
Request to modify a user. If deleteExistingDevices is set to true, when the devices for the main endpoint or SCA service are changed, devices with no more endpoint will be deleted if the command is executed with the correct privilege. Group administrator or above running this command can delete any group level devices. Service provider administrator or above can delete any service provider and group devices. Provisioning administrator or above can delete any devices. An ErrorResponse will be returned if any device cannot be deleted because of insufficient privilege. When phone numbers are un-assigned from the user, the unused numbers may be un-assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above. When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above. When omitted, the number(s) will be left assigned to the group. An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege. If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set to true, it will be added to group if needed if the command is executed by a service provider administrator and above. The command will fail otherwise. Alternate user ids can be added by a group level administrator or above. The password is not required if external authentication is enabled. When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call Appearance service is not assigned after this request, the request will fail. The userService/servicePackwill be authorized to the group if it has not been authorized to the group and the command is excuted by a service provider administrator. The request will fail otherwise. If not present, the authorizedQuantity will be set to unlimited if allowed. If any of the third party voice mail elements are included but the service is not assigned after this request, the request will fail. If the sip authentication elements are included but the SPI Authentication service is not assigned after this request, the request will fail. If the impPassword element is included but the Integrated IMP service is not assigned after this request, the request will fail. The following elements are ignored in XS data mode: nameDialingName alternateUserIdList passcode trunkAddressing thirdPartyVoiceMailServerSelection thirdPartyVoiceMailServerUserServer thirdPartyVoiceMailServerMailboxIdType thirdPartyVoiceMailMailboxURL sipAuthenticationData newUserExternalId emergencyCallbackNumber The response is either SuccessResponse or ErrorResponse.
Author:
AlpacaGenerator