From 52747ded9f2b98c1ff7a58a81b53fe2ba8ade2d1 Mon Sep 17 00:00:00 2001 From: Mark Wells Date: Sun, 31 May 2015 23:29:46 -0700 Subject: [PATCH] initial commit --- .gitignore | 6 + Changes | 5 + MANIFEST | 9 + Makefile.PL | 38 + README | 77 + debian/changelog | 5 + debian/compat | 1 + debian/control | 29 + debian/copyright | 28 + debian/rules | 4 + debian/source/format | 1 + debian/watch | 2 + ignore.txt | 18 + lib/BroadWorks/OCI.pm | 327 + share/OCISchemaAS/OCISchemaAS.xsd | 244 + .../OCISchemaASDeprecatedSpecialExceptions.xsd | 610 + share/OCISchemaAS/OCISchemaDataTypes.xsd | 7753 ++++++++ share/OCISchemaAS/OCISchemaDeprecated14.xsd | 7225 +++++++ share/OCISchemaAS/OCISchemaDeprecated15.xsd | 4548 +++++ share/OCISchemaAS/OCISchemaDeprecated16.xsd | 5915 ++++++ share/OCISchemaAS/OCISchemaDeprecated17.xsd | 5778 ++++++ share/OCISchemaAS/OCISchemaDeprecated18.xsd | 4863 +++++ share/OCISchemaAS/OCISchemaDeprecated19.xsd | 7862 ++++++++ share/OCISchemaAS/OCISchemaDeprecated20.xsd | 4459 +++++ share/OCISchemaAS/OCISchemaEnterprise.xsd | 1500 ++ share/OCISchemaAS/OCISchemaGroup.xsd | 6665 +++++++ share/OCISchemaAS/OCISchemaLogin.xsd | 667 + share/OCISchemaAS/OCISchemaSearchCriteria.xsd | 1489 ++ share/OCISchemaAS/OCISchemaServiceProvider.xsd | 5246 ++++++ share/OCISchemaAS/OCISchemaSortCriteria.xsd | 145 + share/OCISchemaAS/OCISchemaSystem.xsd | 18873 +++++++++++++++++++ share/OCISchemaAS/OCISchemaUser.xsd | 3043 +++ .../Services/OCISchemaService3G4GContinuity.xsd | 25 + .../OCISchemaServiceAccountAuthorizationCodes.xsd | 276 + .../Services/OCISchemaServiceAdviceOfCharge.xsd | 452 + .../Services/OCISchemaServiceAlternateNumbers.xsd | 107 + .../OCISchemaServiceAnonymousCallRejection.xsd | 140 + .../Services/OCISchemaServiceAttendantConsole.xsd | 258 + .../Services/OCISchemaServiceAuthentication.xsd | 99 + .../Services/OCISchemaServiceAutoAttendant.xsd | 648 + .../Services/OCISchemaServiceAutomaticCallback.xsd | 328 + .../OCISchemaServiceAutomaticHoldRetrieve.xsd | 103 + .../Services/OCISchemaServiceBargeInExempt.xsd | 88 + .../Services/OCISchemaServiceBasicCallLogs.xsd | 73 + .../OCISchemaServiceBroadWorksAnywhere.xsd | 549 + .../OCISchemaServiceBroadWorksMobility.xsd | 1528 ++ .../Services/OCISchemaServiceBusyLampField.xsd | 196 + .../OCISchemaServiceCallCapacityManagement.xsd | 279 + .../Services/OCISchemaServiceCallCenter.xsd | 8201 ++++++++ .../OCISchemaServiceCallCenterMonitoring.xsd | 88 + .../OCISchemaServiceCallForwardingAlways.xsd | 94 + .../OCISchemaServiceCallForwardingBusy.xsd | 92 + .../OCISchemaServiceCallForwardingNoAnswer.xsd | 124 + .../OCISchemaServiceCallForwardingNotReachable.xsd | 93 + .../OCISchemaServiceCallForwardingSelective.xsd | 226 + .../Services/OCISchemaServiceCallMeNow.xsd | 313 + .../Services/OCISchemaServiceCallNotify.xsd | 269 + .../Services/OCISchemaServiceCallPark.xsd | 428 + .../Services/OCISchemaServiceCallPickup.xsd | 249 + .../Services/OCISchemaServiceCallRecording.xsd | 504 + .../Services/OCISchemaServiceCallReturn.xsd | 95 + .../Services/OCISchemaServiceCallTransfer.xsd | 122 + .../Services/OCISchemaServiceCallWaiting.xsd | 156 + ...ISchemaServiceCallingLineIDBlockingOverride.xsd | 90 + ...ISchemaServiceCallingLineIDDeliveryBlocking.xsd | 90 + .../OCISchemaServiceCallingNameDelivery.xsd | 91 + .../OCISchemaServiceCallingNameRetrieval.xsd | 228 + .../OCISchemaServiceCallingNumberDelivery.xsd | 91 + .../OCISchemaServiceCallingPartyCategory.xsd | 279 + .../Services/OCISchemaServiceCallingPlan.xsd | 145 + .../Services/OCISchemaServiceChargeNumber.xsd | 91 + .../Services/OCISchemaServiceClassMark.xsd | 242 + .../Services/OCISchemaServiceCollaborate.xsd | 1092 ++ .../OCISchemaServiceCommPilotCallManager.xsd | 155 + .../Services/OCISchemaServiceCommPilotExpress.xsd | 314 + .../OCISchemaServiceCommPilotExpressSR.xsd | 365 + ...chemaServiceCommunicationBarringUserControl.xsd | 182 + .../Services/OCISchemaServiceCommunicator.xsd | 118 + ...viceConnectedLineIdentificationPresentation.xsd | 88 + ...rviceConnectedLineIdentificationRestriction.xsd | 90 + .../Services/OCISchemaServiceCustomRingback.xsd | 294 + .../OCISchemaServiceCustomerOriginatedTrace.xsd | 86 + ...ISchemaServiceDirectedCallPickupWithBargeIn.xsd | 92 + .../OCISchemaServiceDirectoryNumberHunting.xsd | 136 + .../Services/OCISchemaServiceDoNotDisturb.xsd | 91 + .../Services/OCISchemaServiceDualModeVCC.xsd | 100 + .../Services/OCISchemaServiceEmergencyZones.xsd | 278 + .../Services/OCISchemaServiceEnhancedCallLogs.xsd | 946 + .../Services/OCISchemaServiceExecutive.xsd | 705 + .../OCISchemaServiceExecutiveAssistant.xsd | 121 + ...ISchemaServiceExternalCallingLineIDDelivery.xsd | 90 + .../OCISchemaServiceExternalCustomRingback.xsd | 191 + .../Services/OCISchemaServiceFaxMessaging.xsd | 93 + .../Services/OCISchemaServiceFindMeFollowMe.xsd | 560 + .../OCISchemaServiceFlexibleSeatingGuest.xsd | 632 + .../OCISchemaServiceGroupNightForwarding.xsd | 235 + .../Services/OCISchemaServiceGroupPaging.xsd | 757 + .../Services/OCISchemaServiceHotelingGuest.xsd | 141 + .../Services/OCISchemaServiceHotelingHost.xsd | 112 + .../Services/OCISchemaServiceHuntGroup.xsd | 391 + .../Services/OCISchemaServiceINIntegration.xsd | 89 + .../OCISchemaServiceInCallServiceActivation.xsd | 186 + .../OCISchemaServiceIncomingCallingPlan.xsd | 230 + .../Services/OCISchemaServiceInstantGroupCall.xsd | 205 + .../Services/OCISchemaServiceIntegratedIMP.xsd | 292 + ...hemaServiceIntelligentNetworkServiceControl.xsd | 168 + .../Services/OCISchemaServiceIntercept.xsd | 399 + ...ISchemaServiceInternalCallingLineIDDelivery.xsd | 90 + .../Services/OCISchemaServiceInventoryReport.xsd | 124 + .../Services/OCISchemaServiceLDAPIntegration.xsd | 574 + .../OCISchemaServiceLegacyAutomaticCallback.xsd | 376 + ...hemaServiceLocationBasedCallingRestrictions.xsd | 109 + ...OCISchemaServiceMWIDeliveryToMobileEndpoint.xsd | 491 + .../OCISchemaServiceMaliciousCallTrace.xsd | 244 + .../OCISchemaServiceMeetMeConferencing.xsd | 1289 ++ .../Services/OCISchemaServiceMusicOnHold.xsd | 551 + ...ISchemaServiceNumberPortabilityAnnouncement.xsd | 102 + .../Services/OCISchemaServiceOMAPresence.xsd | 24 + .../OCISchemaServiceOutgoingCallingPlan.xsd | 2550 +++ .../OCISchemaServiceOutlookIntegration.xsd | 103 + .../Services/OCISchemaServicePersonalAssistant.xsd | 439 + .../Services/OCISchemaServicePhysicalLocation.xsd | 135 + .../OCISchemaServicePolycomPhoneServices.xsd | 186 + .../OCISchemaServicePreAlertingAnnouncement.xsd | 371 + .../Services/OCISchemaServicePreferredCarrier.xsd | 659 + .../Services/OCISchemaServicePrepaid.xsd | 89 + .../Services/OCISchemaServicePriorityAlert.xsd | 243 + .../Services/OCISchemaServicePrivacy.xsd | 220 + .../Services/OCISchemaServicePushToTalk.xsd | 165 + .../OCISchemaServiceReceptionistEnterprise.xsd | 220 + .../OCISchemaServiceReceptionistOffice.xsd | 134 + .../OCISchemaServiceReceptionistSmallBusiness.xsd | 136 + .../Services/OCISchemaServiceRemoteOffice.xsd | 89 + .../Services/OCISchemaServiceRouteList.xsd | 468 + .../Services/OCISchemaServiceRoutePoint.xsd | 1330 ++ .../Services/OCISchemaServiceSMDIMessageDesk.xsd | 389 + .../OCISchemaServiceSecurityClassification.xsd | 417 + .../OCISchemaServiceSelectiveCallAcceptance.xsd | 205 + .../OCISchemaServiceSelectiveCallRejection.xsd | 248 + .../Services/OCISchemaServiceSequentialRing.xsd | 261 + .../Services/OCISchemaServiceSeriesCompletion.xsd | 249 + .../Services/OCISchemaServiceServiceScripts.xsd | 287 + .../OCISchemaServiceSharedCallAppearance.xsd | 208 + .../OCISchemaServiceSimultaneousRingFamily.xsd | 194 + .../OCISchemaServiceSimultaneousRingPersonal.xsd | 194 + .../Services/OCISchemaServiceSpeedDial100.xsd | 298 + .../Services/OCISchemaServiceSpeedDial8.xsd | 114 + .../Services/OCISchemaServiceThirdPartyIMP.xsd | 93 + .../OCISchemaServiceThirdPartyVoiceMailSupport.xsd | 412 + .../Services/OCISchemaServiceTrunkGroup.xsd | 2228 +++ .../Services/OCISchemaServiceTwoStageDialing.xsd | 191 + .../Services/OCISchemaServiceVideoAddOn.xsd | 104 + ...hemaServiceVirtualOnNetEnterpriseExtensions.xsd | 362 + .../Services/OCISchemaServiceVoiceMessaging.xsd | 2305 +++ .../OCISchemaServiceVoicePortalCalling.xsd | 89 + .../Services/OCISchemaServiceVoiceXml.xsd | 190 + .../OCISchemaServiceZoneCallingRestrictions.xsd | 146 + share/OCISchemaBASE/OCISchemaBASE.xsd | 207 + t/00-load.t | 13 + t/boilerplate.t | 57 + t/manifest.t | 15 + t/pod-coverage.t | 20 + t/pod.t | 12 + 163 files changed, 136028 insertions(+) create mode 100644 .gitignore create mode 100644 Changes create mode 100644 MANIFEST create mode 100644 Makefile.PL create mode 100644 README create mode 100644 debian/changelog create mode 100644 debian/compat create mode 100644 debian/control create mode 100644 debian/copyright create mode 100755 debian/rules create mode 100644 debian/source/format create mode 100644 debian/watch create mode 100644 ignore.txt create mode 100644 lib/BroadWorks/OCI.pm create mode 100644 share/OCISchemaAS/OCISchemaAS.xsd create mode 100644 share/OCISchemaAS/OCISchemaASDeprecatedSpecialExceptions.xsd create mode 100644 share/OCISchemaAS/OCISchemaDataTypes.xsd create mode 100644 share/OCISchemaAS/OCISchemaDeprecated14.xsd create mode 100644 share/OCISchemaAS/OCISchemaDeprecated15.xsd create mode 100644 share/OCISchemaAS/OCISchemaDeprecated16.xsd create mode 100644 share/OCISchemaAS/OCISchemaDeprecated17.xsd create mode 100644 share/OCISchemaAS/OCISchemaDeprecated18.xsd create mode 100644 share/OCISchemaAS/OCISchemaDeprecated19.xsd create mode 100644 share/OCISchemaAS/OCISchemaDeprecated20.xsd create mode 100644 share/OCISchemaAS/OCISchemaEnterprise.xsd create mode 100644 share/OCISchemaAS/OCISchemaGroup.xsd create mode 100644 share/OCISchemaAS/OCISchemaLogin.xsd create mode 100644 share/OCISchemaAS/OCISchemaSearchCriteria.xsd create mode 100644 share/OCISchemaAS/OCISchemaServiceProvider.xsd create mode 100644 share/OCISchemaAS/OCISchemaSortCriteria.xsd create mode 100644 share/OCISchemaAS/OCISchemaSystem.xsd create mode 100644 share/OCISchemaAS/OCISchemaUser.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaService3G4GContinuity.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAccountAuthorizationCodes.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAdviceOfCharge.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAlternateNumbers.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAnonymousCallRejection.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAttendantConsole.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAuthentication.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAutoAttendant.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAutomaticCallback.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceAutomaticHoldRetrieve.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceBargeInExempt.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceBasicCallLogs.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceBroadWorksAnywhere.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceBroadWorksMobility.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceBusyLampField.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallCapacityManagement.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallCenter.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallCenterMonitoring.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallForwardingAlways.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallForwardingBusy.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNoAnswer.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNotReachable.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallForwardingSelective.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallMeNow.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallNotify.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallPark.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallPickup.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallRecording.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallReturn.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallTransfer.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallWaiting.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDBlockingOverride.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDDeliveryBlocking.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallingNameDelivery.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallingNameRetrieval.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallingNumberDelivery.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallingPartyCategory.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCallingPlan.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceChargeNumber.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceClassMark.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCollaborate.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCommPilotCallManager.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpress.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpressSR.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCommunicationBarringUserControl.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCommunicator.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationPresentation.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationRestriction.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCustomRingback.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceCustomerOriginatedTrace.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceDirectedCallPickupWithBargeIn.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceDirectoryNumberHunting.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceDoNotDisturb.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceDualModeVCC.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceEmergencyZones.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceEnhancedCallLogs.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceExecutive.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceExecutiveAssistant.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceExternalCallingLineIDDelivery.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceExternalCustomRingback.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceFaxMessaging.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceFindMeFollowMe.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceFlexibleSeatingGuest.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceGroupNightForwarding.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceGroupPaging.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceHotelingGuest.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceHotelingHost.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceHuntGroup.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceINIntegration.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceInCallServiceActivation.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceIncomingCallingPlan.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceInstantGroupCall.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceIntegratedIMP.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceIntelligentNetworkServiceControl.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceIntercept.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceInternalCallingLineIDDelivery.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceInventoryReport.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceLDAPIntegration.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceLegacyAutomaticCallback.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceLocationBasedCallingRestrictions.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceMWIDeliveryToMobileEndpoint.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceMaliciousCallTrace.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceMeetMeConferencing.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceMusicOnHold.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceNumberPortabilityAnnouncement.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceOMAPresence.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceOutgoingCallingPlan.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceOutlookIntegration.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePersonalAssistant.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePhysicalLocation.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePolycomPhoneServices.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePreAlertingAnnouncement.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePreferredCarrier.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePrepaid.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePriorityAlert.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePrivacy.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServicePushToTalk.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceReceptionistEnterprise.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceReceptionistOffice.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceReceptionistSmallBusiness.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceRemoteOffice.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceRouteList.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceRoutePoint.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSMDIMessageDesk.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSecurityClassification.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallAcceptance.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallRejection.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSequentialRing.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSeriesCompletion.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceServiceScripts.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSharedCallAppearance.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingFamily.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingPersonal.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSpeedDial100.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceSpeedDial8.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceThirdPartyIMP.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceThirdPartyVoiceMailSupport.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceTrunkGroup.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceTwoStageDialing.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceVideoAddOn.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceVirtualOnNetEnterpriseExtensions.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceVoiceMessaging.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceVoicePortalCalling.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceVoiceXml.xsd create mode 100644 share/OCISchemaAS/Services/OCISchemaServiceZoneCallingRestrictions.xsd create mode 100644 share/OCISchemaBASE/OCISchemaBASE.xsd create mode 100644 t/00-load.t create mode 100644 t/boilerplate.t create mode 100644 t/manifest.t create mode 100644 t/pod-coverage.t create mode 100644 t/pod.t diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9788afa --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +blib/ +*.sw? +Makefile +Makefile.old +MYMETA.yml +pm_to_blib diff --git a/Changes b/Changes new file mode 100644 index 0000000..11a6b39 --- /dev/null +++ b/Changes @@ -0,0 +1,5 @@ +Revision history for BroadWorks-OCI + +0.01 Date/time + First version, released on an unsuspecting world. + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..e85b5ac --- /dev/null +++ b/MANIFEST @@ -0,0 +1,9 @@ +Changes +lib/BroadWorks/OCI.pm +Makefile.PL +MANIFEST This list of files +README +t/00-load.t +t/manifest.t +t/pod-coverage.t +t/pod.t diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..3cd8198 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,38 @@ +use 5.006; +use strict; +use warnings FATAL => 'all'; +use ExtUtils::MakeMaker; +use File::ShareDir::Install; + +install_share dist => 'share'; + +WriteMakefile( + NAME => 'BroadWorks::OCI', + AUTHOR => q{Mark Wells }, + VERSION_FROM => 'lib/BroadWorks/OCI.pm', + ABSTRACT_FROM => 'lib/BroadWorks/OCI.pm', + LICENSE => 'Artistic_2_0', + PL_FILES => {}, + MIN_PERL_VERSION => 5.006, + CONFIGURE_REQUIRES => { + 'ExtUtils::MakeMaker' => 0, + }, + BUILD_REQUIRES => { + 'Test::More' => 0, + 'File::ShareDir::Install' => 0, + }, + PREREQ_PM => { + 'XML::Compile' => 1.02, + 'XML::Compile::Cache' => 1.02, + 'Log::Report' => 1.0, + 'Moose' => 2.0, + 'IO::Socket::Timeout' => 0.27, + 'MooseX::ClassAttribute' => 0.27, + }, + dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', }, + clean => { FILES => 'BroadWorks-OCI-*' }, +); + +package MY; +use File::ShareDir::Install qw(postamble); + diff --git a/README b/README new file mode 100644 index 0000000..ca2da65 --- /dev/null +++ b/README @@ -0,0 +1,77 @@ +BroadWorks-OCI + +Adapter to the BroadWorks Application Server OCI provisioning interface. + +INSTALLATION + +To install this module, run the following commands: + + perl Makefile.PL + make + make test + make install + +SUPPORT AND DOCUMENTATION + +After installing, you can find documentation for this module with the +perldoc command. + + perldoc BroadWorks::OCI + +You can also look for information at: + + RT, CPAN's request tracker (report bugs here) + http://rt.cpan.org/NoAuth/Bugs.html?Dist=BroadWorks-OCI + + AnnoCPAN, Annotated CPAN documentation + http://annocpan.org/dist/BroadWorks-OCI + + CPAN Ratings + http://cpanratings.perl.org/d/BroadWorks-OCI + + Search CPAN + http://search.cpan.org/dist/BroadWorks-OCI/ + +Commercia support is available from Freeside Internet Services, Inc. +L + +LICENSE AND COPYRIGHT + +Copyright (C) 2015 Mark Wells + +This program is free software; you can redistribute it and/or modify it +under the terms of the the Artistic License (2.0). You may obtain a +copy of the full license at: + +L + +Any use, modification, and distribution of the Standard or Modified +Versions is governed by this Artistic License. By using, modifying or +distributing the Package, you accept this license. Do not use, modify, +or distribute the Package, if you do not accept this license. + +If your Modified Version has been derived from a Modified Version made +by someone other than you, you are nevertheless required to ensure that +your Modified Version complies with the requirements of this license. + +This license does not grant you the right to use any trademark, service +mark, tradename, or logo of the Copyright Holder. + +This license includes the non-exclusive, worldwide, free-of-charge +patent license to make, have made, use, offer to sell, sell, import and +otherwise transfer the Package with respect to any patent claims +licensable by the Copyright Holder that are necessarily infringed by the +Package. If you institute patent litigation (including a cross-claim or +counterclaim) against any party alleging that the Package constitutes +direct or contributory patent infringement, then this Artistic License +to you shall terminate on the date that such litigation is filed. + +Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER +AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. +THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY +YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR +CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR +CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..3eafada --- /dev/null +++ b/debian/changelog @@ -0,0 +1,5 @@ +libbroadworks-oci-perl (0.01-1) unstable; urgency=low + + * Initial Release. + + -- Mark Wells Sun, 31 May 2015 23:22:11 -0700 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +9 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..b44fac3 --- /dev/null +++ b/debian/control @@ -0,0 +1,29 @@ +Source: libbroadworks-oci-perl +Section: perl +Priority: optional +Maintainer: Mark Wells +Build-Depends: debhelper (>= 9) +Build-Depends-Indep: libfile-sharedir-install-perl, + libio-socket-timeout-perl (>= 0.27), + liblog-report-perl (>= 1), + libmoose-perl (>= 2), + libmoosex-classattribute-perl (>= 0.27), + libxml-compile-cache-perl (>= 1.02), + libxml-compile-perl (>= 1.02), + perl +Standards-Version: 3.9.5 +Homepage: https://metacpan.org/release/BroadWorks-OCI + +Package: libbroadworks-oci-perl +Architecture: all +Depends: ${misc:Depends}, ${perl:Depends}, + libio-socket-timeout-perl (>= 0.27), + liblog-report-perl (>= 1), + libmoose-perl (>= 2), + libmoosex-classattribute-perl (>= 0.27), + libxml-compile-cache-perl (>= 1.02), + libxml-compile-perl (>= 1.02) +Description: Open Client Interface for BroadWorks Application Server. + (no description was found) + . + This description was automagically extracted from the module by dh-make-perl. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..a715802 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,28 @@ +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Source: https://metacpan.org/release/BroadWorks-OCI +Upstream-Contact: Mark Wells, +Upstream-Name: BroadWorks-OCI + +Files: * +Copyright: Mark Wells, +License: + +Files: debian/* +Copyright: 2015, Mark Wells +License: Artistic or GPL-1+ + +License: Artistic + This program is free software; you can redistribute it and/or modify + it under the terms of the Artistic License, which comes with Perl. + . + On Debian systems, the complete text of the Artistic License can be + found in `/usr/share/common-licenses/Artistic'. + +License: GPL-1+ + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + . + On Debian systems, the complete text of version 1 of the GNU General + Public License can be found in `/usr/share/common-licenses/GPL-1'. diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..2d33f6a --- /dev/null +++ b/debian/rules @@ -0,0 +1,4 @@ +#!/usr/bin/make -f + +%: + dh $@ diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 0000000..163aaf8 --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +3.0 (quilt) diff --git a/debian/watch b/debian/watch new file mode 100644 index 0000000..85d5fe0 --- /dev/null +++ b/debian/watch @@ -0,0 +1,2 @@ +version=3 +https://metacpan.org/release/BroadWorks-OCI .*/BroadWorks-OCI-v?(\d[\d.-]*)\.(?:tar(?:\.gz|\.bz2)?|tgz|zip)$ diff --git a/ignore.txt b/ignore.txt new file mode 100644 index 0000000..07658b7 --- /dev/null +++ b/ignore.txt @@ -0,0 +1,18 @@ +Makefile +Makefile.old +Build +Build.bat +META.* +MYMETA.* +.build/ +_build/ +cover_db/ +blib/ +inc/ +.lwpcookies +.last_cover_stats +nytprof.out +pod2htm*.tmp +pm_to_blib +BroadWorks-OCI-* +BroadWorks-OCI-*.tar.gz diff --git a/lib/BroadWorks/OCI.pm b/lib/BroadWorks/OCI.pm new file mode 100644 index 0000000..90bcc21 --- /dev/null +++ b/lib/BroadWorks/OCI.pm @@ -0,0 +1,327 @@ +package BroadWorks::OCI; + +use 5.006; +use strict; +use warnings 'all'; + +use XML::Compile::Cache; +use Log::Report 'broadworks-oci', syntax => 'SHORT'; +use IO::Socket::INET; +use IO::Socket::Timeout; +use Errno qw(ETIMEDOUT EWOULDBLOCK); +use Digest::MD5; +use Digest::SHA; + +use Moose; +use MooseX::ClassAttribute; + +use File::ShareDir; + +class_has '_XCC' => ( + is => 'ro', + lazy => 1, + default => sub { {} }, +); + +sub XCC { + my $self = shift; + my $schema = shift; + $self->_XCC->{$schema} ||= $self->_build_XCC($schema); +} + +sub _build_XCC { + my $self = shift; + my $schema = shift; + my @path = split('/', $schema); + $schema = pop @path; + $schema = join('/', 'OCISchemaAS', @path) . + '/OCISchema' . $schema . '.xsd'; + info "Loading $schema"; + + my $dist_dir = File::ShareDir::dist_dir('BroadWorks-OCI'); + my @schemata = ( + "OCISchemaBASE/OCISchemaBASE.xsd", + "OCISchemaAS/OCISchemaDataTypes.xsd", + "OCISchemaAS/OCISchemaSearchCriteria.xsd", + "OCISchemaAS/OCISchemaSortCriteria.xsd", + $schema, + ); + + # results in some repeat inclusion of BASE and DataTypes, but not in + # importing a huge pile of definitions we aren't going to use + my $XCC = XML::Compile::Cache->new( + \@schemata, + schema_dirs => $dist_dir, + xsi_type => { + '{C}OCICommand' => 'AUTO', + }, + ); + # we only ever send/receive one type of root element + $XCC->declare(RW => '{C}BroadsoftDocument'); + + return $XCC; +} + +sub reader { + my $self = shift; + my $schema = shift; + $self->XCC($schema)->reader('{C}BroadsoftDocument'); +} + +sub writer { + my $self = shift; + my $schema = shift; + $self->XCC($schema)->writer('{C}BroadsoftDocument'); +} + +has 'sessionId' => ( + is => 'ro', + default => sub { + Digest::MD5::md5_hex(time().{}.rand().$$); + }, +); + +has 'hostname' => ( + is => 'ro', + default => 'ews.xdp.broadsoft.com', # test server +); + +has 'port' => ( + is => 'ro', + default => 2208, +); + +has 'socket' => ( + is => 'rw', + lazy => 1, + builder => '_connect', +); + +has 'timeout' => ( + is => 'rw', + default => 30, +); + +sub _connect { + my $self = shift; + my $host = $self->hostname; + my $port = $self->port; + info("opening socket to $host:$port"); + my $socket = IO::Socket::INET->new( + PeerAddr => $host, + PeerPort => $port, + Proto => 'tcp', + Timeout => $self->timeout, + ) or die "failed to connect: $!\n"; + + IO::Socket::Timeout->enable_timeouts_on($socket); + $socket->read_timeout($self->timeout); + $socket->write_timeout($self->timeout); + + return $socket; +} + +has 'userId' => ( + is => 'ro', + required => 1, +); + +has 'password' => ( + is => 'ro', + required => 1, +); + +sub request { + my $self = shift; + my $schema = shift; + my $command = shift; + + my %args; + if (ref($_[0])) { + %args = %{ $_[0] }; + } else { + %args = @_; + } + # XML::Compile's way to deal with the "xsi:type=" attribute for late-binding + # element types: + $args{'XSI_TYPE'} = $command; + + my $doc = XML::LibXML::Document->new('1.0', 'UTF-8'); + info("sending $command"); + my $content = { + 'sessionId' => $self->sessionId, + 'protocol' => 'OCI', + 'command' => \%args, + }; + + # format and send request + local $@; + eval { + $doc->setDocumentElement( $self->writer($schema)->( $doc, $content ) ); + trace("$doc\n\n"); + $self->socket->print("$doc"); + }; + return (0, $@) if $@; + + local $!; + # responses from the API are _usually_ two lines, but sometimes only one. + my $xml_response = $self->socket->getline; + if ($xml_response and $xml_response !~ m[socket->getline; + } + if (!$xml_response and ($! == ETIMEDOUT or $! == EWOULDBLOCK)) { + return (0, 'OCI request timed out'); + } + + # parse response + trace("$xml_response\n\n"); + my $response = eval { $self->reader($schema)->( $xml_response ) }; + return (0, $@) if $@; + + $command = $response->{command}; + $command = $command->[0] if ref($command) eq 'ARRAY'; + + my $response_type = $command->{XSI_TYPE}; + if ($response_type eq 'SuccessResponse') { + return (1, ''); + } elsif ( $response_type eq '{C}ErrorResponse' ) { + return (0, $command->{summary}); + } else { # all other response types + info("received document type '$response_type'"); + return (1, $command); + } +} + +sub login { + my $self = shift; + my ($success, $message) = $self->request( 'Login', 'AuthenticationRequest', + userId => $self->userId, + ); + return ($success, $message) unless $success; + + # construct challenge response + my $token = Digest::MD5::md5_hex( + $message->{nonce} . ':' . Digest::SHA::sha1_hex($self->password) + ); + return $self->request('Login', 'LoginRequest14sp4', + userId => $self->userId, + signedPassword => $token, + ); +} + +sub BUILD { + my $self = shift; + my ($success, $message) = $self->login; + die "Login failed: $message" if !$success; + $self; +} + +=head1 NAME + +BroadWorks::OCI - Open Client Interface for BroadWorks Application Server. + +=head1 VERSION + +Version 0.01 + +=cut + +our $VERSION = '0.01'; + +=head1 SYNOPSIS + +Quick summary of what the module does. + +Perhaps a little code snippet. + + use BroadWorks::OCI; + + my $foo = BroadWorks::OCI->new(); + ... + +=head1 METHODS + +=cut + +=head1 AUTHOR + +Mark Wells, C<< >> + + +=head1 SUPPORT + +You can find documentation for this module with the perldoc command. + + perldoc BroadWorks::OCI + + +You can also look for information at: + +=over 4 + +=item * RT: CPAN's request tracker (report bugs here) + +L + +=item * AnnoCPAN: Annotated CPAN documentation + +L + +=item * CPAN Ratings + +L + +=item * Search CPAN + +L + +=back + + +=head1 ACKNOWLEDGEMENTS + + +=head1 LICENSE AND COPYRIGHT + +Copyright 2015 Mark Wells. + +This program is free software; you can redistribute it and/or modify it +under the terms of the the Artistic License (2.0). You may obtain a +copy of the full license at: + +L + +Any use, modification, and distribution of the Standard or Modified +Versions is governed by this Artistic License. By using, modifying or +distributing the Package, you accept this license. Do not use, modify, +or distribute the Package, if you do not accept this license. + +If your Modified Version has been derived from a Modified Version made +by someone other than you, you are nevertheless required to ensure that +your Modified Version complies with the requirements of this license. + +This license does not grant you the right to use any trademark, service +mark, tradename, or logo of the Copyright Holder. + +This license includes the non-exclusive, worldwide, free-of-charge +patent license to make, have made, use, offer to sell, sell, import and +otherwise transfer the Package with respect to any patent claims +licensable by the Copyright Holder that are necessarily infringed by the +Package. If you institute patent litigation (including a cross-claim or +counterclaim) against any party alleging that the Package constitutes +direct or contributory patent infringement, then this Artistic License +to you shall terminate on the date that such litigation is filed. + +Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER +AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. +THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY +YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR +CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR +CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +=cut + +1; # End of BroadWorks::OCI diff --git a/share/OCISchemaAS/OCISchemaAS.xsd b/share/OCISchemaAS/OCISchemaAS.xsd new file mode 100644 index 0000000..88afa54 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaAS.xsd @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaASDeprecatedSpecialExceptions.xsd b/share/OCISchemaAS/OCISchemaASDeprecatedSpecialExceptions.xsd new file mode 100644 index 0000000..55e9dc1 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaASDeprecatedSpecialExceptions.xsd @@ -0,0 +1,610 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's forced forwarding + settings. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's night service settings. + The response is either a GroupCallCenterNightServiceGetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterNightServiceGetRequest17sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's night service settings. + Only Group and Enterprise level schedules are + accepted. + The + response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's custom ringback + service. + The response is either a SuccessResponse or + an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a criteria for the user's custom ringback + service. + The response is either a SuccessResponse + or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a criteria for the user's custom ringback service. + The response is either a UserCustomRingbackUserGetCriteriaResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserCustomRingbackUserGetCriteriaRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's voice messaging greeting information. + The response is either a UserVoiceMessagingUserGetGreetingResponse18sp1 or an ErrorResponse. + + Replaced by UserVoiceMessagingUserGetGreetingRequest20 + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetGreetingRequest18sp1. + Contains the greeting configuration for a user's voice messaging. + The following elements are only used in AS data mode: + disableMessageDeposit + disableMessageDepositAction + greetingOnlyForwardDestination + extendedAwayEnabled + extendedAwayDisableMessageDeposit + extendedAwayAudioFile + extendedAwayAudioMediaType + extendedAwayVideoFile + extendedAwayVideoMediaTyp + + Replaced by UserVoiceMessagingUserGetGreetingResponse20 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's voice messaging voice portal settings. + The response is either a UserVoiceMessagingUserGetVoicePortalResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetVoicePortalRequest16. + + + + + + + + + + + + + + + + + + The configuration of a alternate no answer greeting. + It is used when geting a user's voice messaging greeting. + + + + + + + + + + + + + + + Modify the user's voice messaging voice portal settings. + The response is either a SuccessResponse + or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + + + + true + true + + + Modify the user's voice messaging greeting. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + The following elements are only used in AS data mode: + disableMessageDeposit + disableMessageDepositAction + greetingOnlyForwardDestination + + Replaced by UserVoiceMessagingUserModifyGreetingRequest20 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains list of file descriptions for audio or video files + + + + + + + + + + + + + + Contains list of file media types for audio or video files + + + + + + + + + + + + + + true + false + + + Modify the user's broadworks mobility service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the user's broadworks mobility service settings. + The response is either a UserBroadWorksMobilityGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to a UserBroadWorksMobilityGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the user's broadworks mobility service settings. + The response is either a SuccessResponse or an ErrorResponse. + If the request modifies the mobilePhoneNumber and the new number does not belong to the appropriate Mobile Subscriber Directory Numbers pool, the request is rejected. For a service provider the number must belong to the group Mobile Subscriber Directory Numbers pool. For an enterprise user, the number must belong to the enterprise Mobile Subscriber Directory Numbers pool. + If the request is executed by a user and modifies the mobilePhoneNumber, the request is rejected. + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDataTypes.xsd b/share/OCISchemaAS/OCISchemaDataTypes.xsd new file mode 100644 index 0000000..dd6f640 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDataTypes.xsd @@ -0,0 +1,7753 @@ + + + + + + + + + + + + + + + + + Digit Collection Access Code. + + + + + + + + + + Uniquely identifies an Identity/device profile created anywhere in the system. + + + + + + + + + + + The relative URL for web based configuration of the device, appended after the IP + Address of the device to identify the URL address for the web based configuration. + + + + + + + + + + + Access device description. + + + + + + + + + + + Access device enhanced configuration file name. + + + + + + + + + + + Choices for the access device configuration mode. + + + + + + + + + + + + Type of enhanced configuration supported by an access device. + "2 File Configuration" was formerly called "CPE Type 1" + "3 File Configuration" was formerly called "CPE Type 2" + + + + + + + + + + + + Access device end point used in the context of add. + Port numbers are only used by devices with static line ordering. + + + + + + + + + + + + + Access device end point in the context of a modify or delete command. + + + + + + + + + + + Also known as address of record, the Line/Port identifies a device endpoint + in standalone mode or a SIPURI public identity in IMS mode. + Line/port user@host or just the port. + Validation: + - don't allow sip: + - allow a leading + + - allow the following characters: + alphanumeric - _ . ! ~ * ' ( ) @ + - lineports for sip devices configured with Proxy Addressing must have a host portion + - lineports for sip devices configured with Device Addressing must not have a host portion + + + + + + + + + + + Access device end point used in the context of modify. + Port numbers are only used by devices with static line ordering. + + + + + + + + + + + + + The private identity is a SIP URI. + - don't allow sip: + - allow the following characters: + alphanumeric - _ . ! ~ * ' ( ) @ + - exactly one @ symbol + - user portion and host portion are both required + + + + + + + + + + + Access device end point. + + + + + + + + + + + + + + Access device end point used in the context of add that can have more than one contact defined. + Only Static Registration capabable devices may have more than one contact defined. + Port numbers are only used by devices with static line ordering. + + + + + + + + + + + + + Access device end point used in the context of modify that can have more than one contact defined. + Only Static Registration capabable devices may have more than one contact defined. + Port numbers are only used by devices with static line ordering. + + + + + + + + + + + + + Access device end point that can have multiple contacts. + Port numbers are only used by devices with static line ordering. + + + + + + + + + + + + + + + + A list of SIP contacts that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + Key to uniquely identify a system, service provider, or group device. + + + + + + + + + + + + Uniquely identifies a file within a group or user repository. + + + + + + + + + + + Uniquely identifies a file within a group or user repository. + Includes level to distinguish between group and user announcements + in scenarios where both are listed. + + + + + + + + + + + + Access device end point. + Port numbers are only used by devices with static line ordering. + + + + + + + + + + + + + + + Identifies at which level in the system an identity/device profile is created. + + + + + + + + + + + + Access device MAC address. + + + + + + + + + + + Access device name. + + + + + + + + + + + Access device protocol. + + + + + + + + + + + Physical geographic location of the device, used in conjunction with the Physical Location user service. + + + + + + + + + + + Choices for the reset event of an access device. + + + + + + + + + + + Access device serial number. + + + + + + + + + + + Choices for the access device status. + + + + + + + + + + + + + Access device type. + + + + + + + + + + + BroadWorks Mobility interrupt type. + + + + + + + + + + + + BroadWorks Mobility setting for the user level. + + + + + + + + + + Street address information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This is a unique key value returned when reading and specified when writing. + + + + + + + + + + + The display name is returned when reading and ignored when writing. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Address Location. + + + + + + + + + + Agent Automatic Call Distribution (ACD) State. + States available for Wrap-Up agent state management. + + + + + + + + + + + + Alternate Number Entry. + + + + + + + + + + + + + Alternate number description. + + + + + + + + + + + User alias usage mode for AS translations on incoming calls. + + + + + + + + + + + + Alternate Trunk Identity + + + + + + + + + + + The type of Announcement, the possible values are "Group" for a group level + announcement or "User" for a user level announcement. + + + + + + + + + + + Announcement types - audio or video + + + + + + + + + + + Announcement file name. + + + + + + + + + + + Announcement Selection. + + + + + + + + + + + Assigned Group Services List Entry. + The isActive element is true, false, or could be missing completely. + + + + + + + + + + + Assigned User Services List Entry. + The isActive element is true, false, or could be missing completely. + + + + + + + + + + + Audio file codec. + + + + + + + + + + + + + + + + Audio file codec. + The following values are only used in HSS data mode and will fail in AS data mode: + EVRC0 + EVRCNW + EVRCNW0 + + + + + + + + + + + + + + + + + + + Authentication Lockout type for device profile/SIP authentication password rules. Possible values: + None: No authentication lockout + Temporary: disable authentication with temporary lockout only + Temporary then Permanent: disable authentication with temporary lockout and permanent lockout + + + + + + + + + + + + Number of minutes to wait when AuthenticationLockoutWaitAlgorithmType is set to fixed. + + + + + + + + + + + + + + Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout. + + + + + + + + + + + Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout. + + + + + + + + + + + Wait algorithm type for device profile/SIP authentication password rules. Possible values: + Double: Double the previous lockout time (Starting with 5 minutes) + Fixed: Wait a fixed amount of time + + + + + + + + + + + Choices for SIP Device Authentication + + + + + + + + + + + Bursting Maximum Number of Active Calls + + + + + + + + + + BroadWorks Mobility setting for the group level. + + + + + + + + + + + Name of a BroadWorks Mobility Mobile Network. + + + + + + + + + + + BroadWorks Mobility setting for the service provider level. + + + + + + + + + + Bursting Maximum Number of Incoming Calls + + + + + + + + + Bursting Maximum Number of Outgoing Calls + + + + + + + + + + Call Center skill level. + + + + + + + + + + Call Center Agent Unavailable Code Value. + + + + + + + + + + Contains a list of announcement repository files + + + + + + + + + + + + + Contains a list of announcement repository files + + + + + + + + + + + + + Contains list of urls + + + + + + + + + + + + + Contains a list of URLs for modify. + + + + + + + + + + + + + Number of Service Level input parameters. + + + + + + + + + + + Number of Abandoned Call input parameters. + + + + + + + + + + + Call center force delivery wait time in seconds. + + + + + + + + + + + Call center manual night service announcement mode. + + + + + + + + + + + Call center media on hold message selection. + + + + + + + + + + + + + Contains the call center media on hold source configuration. + + + + + + + + + + + + + + + + + Contains the call center media on hold source configuration. + + + + + + + + + + + + + + + + + Call center overflow processing action. + + + + + + + + + + + + The limit for the number of calls the system will keep in queue, waiting for an available agent. + + + + + + + + + + + Index to a call center enhanced reporting data template's query set. + + + + + + + + + + + Fileter value for call center reporting data template query. + + + + + + + + + + + The file name for the Call Center Reporting templates Files. + + + + + + + + + + + The URI for the Call Center Reporting templates Files. + + + + + + + + + + + Uniquely identifies a call center report template created in the system. + + + + + + + + + + + Identifies at which level in the system a call center report template is created. + + + + + + + + + + + + The call center enhanced reporting report template name. + + + + + + + + + + + The call center enhanced reporting scheduled report name. + + + + + + + + + + + Call center scheduled service (Night Services, Holiday Services, etc.) processing action. + + + + + + + + + + + + The call center statistics source. + + + + + + + + + + + + The ACD wrap up time in seconds. + + + + + + + + + + + Maximum Call Time for Unanswered Calls + + + + + + + + + + + + Last Name for Calling Line Id Display. + + + + + + + + + + + First Name for Calling Line Id Display. + + + + + + + + + + + Name of a calling plan digit pattern. + + + + + + + + + + + Maximum Call Time for Answered Calls + + + + + + + + + + + Maximum Call Time for Unanswered Calls + + + + + + + + + + + Maximum number of Parties allowed in a conference call. + + + + + + + + + + + Maximum Number of Concurrent Redirected Calls + + + + + + + + + + + Maximum Number of Find Me Follow Me Depth + + + + + + + + + + + Maximum Number of Concurrent Find Me/Follow Me Invocations + + + + + + + + + + + Maximum Number of Redirections Depth + + + + + + + + + + + Maximum Number of Simultaneous Calls + + + + + + + + + + + Maximum Number of Forks + + + + + + + + + + + Maximum Number of Redirections + + + + + + + + + + + Maximum Number of Simultaneous Forwards + + + + + + + + + + Call Recording Platform Name. + + + + + + + + + Call Recording Platform Description. + + + + + + + + + + Supported versions of the BroadWorks-specific extension metadata. + + + + + + + + + + + Call Type Digit Map. + + + + + + + + + Call Log Id + + + + + + + + + Call Log Id + + + + + + + + + + Calling Name. + + + + + + + + + + + Call Log entry describing a placed, received, or missed call. + + + + + + + + + + + + + + Call Log type. + + + + + + + + + + + + Call Processing Policy Profile Name. + + + + + + + + + + + Call Processing Policy Profile Description. + + + + + + + + + + + Calling Line ID Policy Selections. + + + + + + + + + + + Communication Barring Alternate Call Indicator. + + + + + + + + + + + Communication Barring Authorization Code. + + + + + + + + + + + Communication Barring Authorization Code Description. + + + + + + + + + + + Communication Barring Authorization Code entry. + + + + + + + + + + + Possible Call Me Now actions for Communication Barring. + + + + + + + + + + + + Communication Barring Call Type. + + + + + + + + + + + Communication Barring Criteria Name + + + + + + + + + + + Communication Barring criteria priority. + + + + + + + + + + + Possible incoming call actions for Communication Barring. + + + + + + + + + + + + Communication Barring Incoming Rule + + + + + + + + + + + + + + + Communication Barring Incoming Rule + + + + + + + + + + + + + + + + + + Possible originating actions for Communication Barring. + + + + + + + + + + + + + + + + Communication Barring Profile Name + + + + + + + + + + + Communication Barring Profile description + + + + + + + + + + + Possible redirecting actions for Communication Barring. + + + + + + + + + + + + Time to wait before shutting down a call. + + + + + + + + + + + Choices for Connected Line Identification Privacy on Redirected Calls + + + + + + + + + + + Contact information. + + + + + + + + + + + + + + + + + + + + + + + + + + Country dialing code. + + + + + + + + + The name of a country. + + + + + + + + + + Counter reset time days. + + + + + + + + + + + Counter reset time hour. + + + + + + + + + + + Counter reset time minute. + + + + + + + + + + CPE device file format. + + + + + + + + + + CPE Configuration File Directory. + + + + + + + + + + + CPE system file name. + + + + + + + + + + + Criteria active status indicator + + + + + + + + + + + Call Center Agent Threshold Profile name. + + + + + + + + + + + Selection criteria for a dn. + + + + + + + + + + + The from dn criteria used within an add/get request. + + + + + + + + + + + + + The from dn criteria used within a modify request. + + + + + + + + + + + + Criteria Name + + + + + + + + + + A list of criteria DNs that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + Custom Contact Directory name. + + + + + + + + + + + The day of month. + + + + + + + + + + + Days of the week (Sunday-Saturday). + + + + + + + + + + + + + + + + Defines the day of week in the month (First, Second, Third, Fourth, or Last). + + + + + + + + + + + + + + The database instance name defined on a Database Server. + + + + + + + + + + + The default Network Class of Service to set during assignation/unassignation. + + + + + + + + + + + Uniquely identifies a department system-wide. + Departments are contained in either an enterprise or a group. Enterprise departments can be + used by any or all groups within the enterprise. Department names are unique within a group and + within an enterprise, but the same department name can exist in 2 different groups or in both + a group and its parent enterprise. Therefore, to uniquely identify a department, we must know + the department name and which enterprise or group contains the department. + This type is extended by group and enterprise department keys. + + + + + + + + Department Full Path name. This the full path name of the department. + + + + + + + + + + Department name. This is only the name of the department itself, not the full path name + of the department and all its parents. + + + + + + + + + + + FTP connect timeout in seconds + + + + + + + + + + + FTP file transfer timeout in seconds + + + + + + + + + + + Maps a BroadWorks language to a device-equivalent language. + + + + + + + + + + + Maximum time that IP Device Configuration Management should take to process all the file rebuild events currently queued. + + + + + + + + + + + Duration of the pause that IP Device Configuration Management should take between two consecutive file re-build and send. + + + + + + + + + + + Dialable Caller ID Criteria description. + + + + + + + + + + + Dialable Caller ID Criteria name. + + + + + + + + + + + Dialable Caller ID criteria priority. + + + + + + + + + + + Dialable Caller ID routing order + + + + + + + + + + + Digits that are prepended to the incoming Caller ID of public calls, so that the Caller ID is presented in dialable format. + The digit pattern may contain digits 0-9, *, #. + + + + + + + + + + + Dial Plan Access Code. + The Access Code may contain digits 0-9, *, and #. + + + + + + + + + + + Dial Plan Access Code Description. + + + + + + + + + + + A single dialing digit. Valid values are 0-9,*,#. + + + + + + + + + + + The action performed by a device management event. + + + + + + + + + + + + + + Additional information about the event. + Additional information includes the affected device type, device or group. + It depends on the level of the event: + Device Profile->"Device Name" "Service Provider Id" "Group Id" + Device Type->"Device Type Name" + Device Type Group->"Service Provider Id" "Group Id" "Device Type Name" + Group->"Service Provider Id" "Group Id" + User->"User Id" + + + + + + + + + + + The level of a device management event. + It can affect one device, all devices linked to a user, all devices + linked to a group, all devices linked to a device type or all devices + linked to a device type and group. + + + + + + + + + + + + + + Device Management queues available in the system. + They contain events at various stage of processing. + + + + + + + + + + + The status of a device management event. + It can be 'Pending', meaning that it is not yet queued for processing. + It can be 'Queued', waiting to be processed. + It can be 'In Progress', meaning that it is currently being processed. + It can be 'Process On Other Host', meaning that it is currently being + processed on another host. + It can be 'Stale', meaning that it should currently be queued in + the internal Device Management queue but is not. + + + + + + + + + + + + + + The status of a completed device management event. + It can be 'Canceled', meaning that it was canceled in the middle of processing. + It can be 'Completed', meaning that all its related expanded events have + been successfully processed. + + + + + + + + + + + The possible status used to cancel a device management event. + It can be 'Pending', meaning that it is not yet queued for processing. + It can be 'Queued', waiting to be processed. + It can be 'In Progress', meaning that it is currently being processed. + It can be 'Stale', meaning that it should currently be queued in + the internal Device Management queue but is not. + + + + + + + + + + + + + The type of the device management event. + Automatic means that the event was triggered automatically by the + system following a provisioning event from the user. + Manual means that the user triggered the event directly. The event + was not a result of an indirect provisioning event. + + + + + + + + + + + A static tag set name for access device files managed by the Device Management System on BroadWorks. + + + + + + + + + + + Possible algorithms for digital signatures supported by the provisioning server. + + + + + + + + + Digit Collection Digit Map. + + + + + + + + + + Digit patterns that are used to restrict calls Communicaton Barring. + The patterns can consist of the digits 0 through 9 and a leading + and the following wild cards: + $ - Any number of digits. For example 555$ matches any digit string beginning with 555 plus zero or more additional digits. The $ card may be placed at the beginning or the end of the digit pattern, but not both. + ? - a single-digit placeholder. For example, 555???? matches any string beginning with 555, plus at least four additional digits. + [] - Indicates a range of digits. A consecutive range indicated with a hyphen (-), or a nonconsecutive range with a comma (,). Hyphens and commas can be used in combination ie [5-7,9]. Only single-digit ranges are supported. ie. [98-102] is invalid. + + + + + + + + + + + Digit Pattern Criteria Description + + + + + + + + + + + Digit Pattern Criteria Name + + + + + + + + + + + A single dialing digit with valid values * and # only. + + + + + + + + + + + Directory Number in E164 Format. + + + + + + + + + + + Uniquely identifies a Call Center DNIS. + + + + + + + + + + + Call Center DNIS Name. + + + + + + + + + + + Directory number range. The minimum and maximum values are inclusive. + + + + + + + + + + Network domain name. + + + + + + + + + + A single DTMF dialing digit. Valid values are 0-9,*,#. + + + + + + + + + + + Dual Mode VCC subscriber password + + + + + + + + + + Email Address + + + + + + + + + Character-encoding scheme. + + + + + + + + + + Types of Endpoints in Broadworks. + + + + + + + + + + + + + + + This data type is applicable only for an Enterprise administrator. + It specifies the Enterprise Administrator's policy for accessing network policies (e.g. - VoiceVPN). + + + + + + + + + + + This data type is applicable only for an Enterprise administrator. + Enterprise Administrator's policy for accessing + the Number Activation information. + + + + + + + + + + + + Uniquely identifies a department defined within an enterprise. + To uniquely identify an enterprise department, we must know the department name and which + enterprise contains the department. + + + + + + + + + + + + + + + Internal Call CLID Policy applicable to enterprise. + + + + + + + + + + + + Enterprise Trunk name. + Uniquely identifies an Enterprise Trunk in an enterprise or group. + + + + + + + + + + + Enterprise Voice VPN Location Selection. + + + + + + + + + + + + + The identifier for an event channel. + + + + + + + + + + + The channel set id. + + + + + + + + + + + Event name. + + + + + + + + + + + Number of seconds before expiration. + + + + + + + + + + + Event Notification Event Channels Per Set. + + + + + + + + + + + Event Notification Channel stateful expiration minutes. + + + + + + + + + + + The rate to throttle the SubscriptionResyncEvents per second. + + + + + + + + + + + User name for exchange server. + + + + + + + + + + + Exchange server user name and password. + + + + + + + + + + + User password for exchange server. + + + + + + + + + + + Represents either an existing file for the application server to use, or + the contents of a file to transfer and an URL. + + + + + + + + + + + Choices for extended file resource usage. + + + + + + + + + + + + Represents either an existing file for the application server to use, or + the contents of a file to transfer and an URL. + + + + + + + + + + + Represents either an existing file for the application server to use, or + the contents of a file to transfer and an URL. + + + + + + + + + + + Represents either an existing file for the application server to use, or + the contents of a file to transfer and an URL. + + + + + + + + + + + Extension. + + + + + + + + + + + Extension range. The minimum and maximum values are inclusive. + + + + + + + + + + Feature Access Code + + + + + + + + + Feature Access Code Entry to be used in all the system, service provider and + group modify commands. + + + + + + + + + + + + Feature Access Code Entry to be used in all GET commands. + + + + + + + + + + + Feature Access Code Name + + + + + + + + + Description of a file resource. + + + + + + + + + + Name of a file on the filesystem. + + + + + + + + + File repository name. + + + + + + + + + + + Represents either an existing file for the application server to use, or + the contents of a file to transfer. + + + + + + + + + + + + + Time allowed for initial user input to Auto Attendant main menu. + + + + + + + + + + + First Name is the first name of a user or an administrator. + + + + + + + + + + + FTP remote directory. + + + + + + + + + + + A user id for an FTP server. + + + + + + + + + + + A password for an FTP server. + + + + + + + + + + + Group's policy for accessing group level and user level calling plan configuration. + "Full" provides full control over the configuration of group-level and user-level calling plans. + "Restricted" indicates + 1) not to provide access to group-level calling plan configuration, + 2) to provide access to only collect calls for user level incoming calling plan, + 3) to provide access to only international, operator assisted, 700/900, 976, and casual calls for user level outgoing calling plan. + + + + + + + + + + + Calling Line ID Policy Selections. + NOTE: The "Use Group CLID" value indicates the department CLID will be used if available otherwise the group CLID is used. + + + + + + + + + + + + Choices for the group Dial Plan Policy to decide which type of settings shall be used. + Notes: Choice cannot be 'sp' or 'group' if Service Provider or group does not have + public digit map set. + + + + + + + + + + + + Group's policy for accessing extension dialing configuration (i.e. - length of extensions). + + + + + + + + + + + + Group's policy for accessing LDAP Integration configuration. + + + + + + + + + + + + Choices for the group passcode rule to decide which type of rules to use. + + + + + + + + + + + + Group's policy for user access to his voice messaging configuration. + "Full" indicates full control over the voice messaging configuration. + "Restricted" indicates that the choice to either use unified messaging option (whereby the user can configure a mail server on which messages are stored) + or to forward the voice message to a designated email address is not available. + + + + + + + + + + + Group's policy for department administrator's access to trunk group configuration. + "Full" indicates full access to trunk groups in the department. + "None" indicates no access to trunk groups in the department. + + + + + + + + + + + Group's policy for department administrator's access to user configuration. + "Full" indicates full access to users in the department. + "Read-Only Profile" indicates + 1) the department administrator is restricted from adding or removing users, and + 2) read-only access is granted to the user's profile. + "No Profile" indicates + 1) the department administrator is restricted from adding or removing users, and + 2) no access is granted to the user's profile. + "None" indicates no access to users in the department. + + + + + + + + + + + + + Policy for a group administrator's access to the group profile. + + + + + + + + + + + + Policy for a group administrator's access to trunk groups. + "Full" indicates full access to add/modify/delete trunk groups in the group. + "Full Resources" indicates + 1) Restricted from adding or removing trunk groups, and + 2) Full access to trunk group resources + "Read-Only Resources" indicates + 1) Restricted from adding or removing trunk groups, and + 2) Read-only access to trunk group resources + "None" indicates no access to trunk groups in the group. + + + + + + + + + + + + + Policy for a group administrator's access to user configuration. + "Full" indicates full access to users in the group. + "Full Profile" indicates + 1) the group administrator is restricted from adding or removing users, but + 2) has full access to the user's profile + "Read-Only Profile" indicates + 1) the group administrator is restricted from adding or removing users, and + 2) read-only access is granted to the user's profile. + "No Profile" indicates + 1) the group administrator is restricted from adding or removing users, and + 2) no access is granted to the user's profile. + "None" indicates no access to users in the group. + + + + + + + + + + + + + + Policy for a group administrator's access to Verify Translation and Routing feature. + + + + + + + + + + + Policy for a group administrator's access to group administrators and department administrators. + + + + + + + + + + + + Policy for accessing the user Communication Barring user profile configuration. + + + + + + + + + + + Policy for a group administrator's access to departments. + "Full" indicates full access to departments. + "Read-Only" indicates read-only access to the department list + "None" indicates no access to the department list + + + + + + + + + + + + Policy for accessing the group Dialable Caller ID configuration. + + + + + + + + + + + + Policy for a group administrator's access to access devices. + "Full" indicates full access to access devices. + "Associate User With Device" indicates + 1) read-only access to devices, but + 2) the group administrator may associate users with devices + "Read-Only" indicates read-only access to devices and user-device associations + + + + + + + + + + + + Policy for a group administrator's access to enhanced service instances (e.g. - instances of Auto Attendants, Call Capacity Groups, + Conference Bridges, Hunt Groups, Call Centers, Series Completion Groups, etc.). + "Full" indicates full access to enhanced service instances. + "Modify-Only" indicates + 1) the group administrator is restricted from adding or removing enhanced service instances, but + 2) may modify existing instances. + + + + + + + + + + + Policy for a group administrator's access to assigning services to groups and users. + + + + + + + + + + + Policy for a group administrator's access to feature access codes. + + + + + + + + + + + Group Administrator's policy for accessing + the Office Zone information. + + + + + + + + + + + Group Administrator's policy for accessing + the Number Activation Control information. + + + + + + + + + + + + Policy for a group administrator's access to assigning phone numbers and extensions. + + + + + + + + + + + Group Administrator's policy for accessing + the Session Admission Control information. + + + + + + + + + + + + Uniquely identifies a department defined within a group. + To uniquely identify a group department, we must know the department name and which + group contains the department. + + + + + + + + + + + + + + + + Group Id identifies a group within a service provider or enterprise. The group id is not + unique system wide. It must be combined with a service provider id to be unique across the system. + + + + + + + + + + Group display name. + + + + + + + + + Group calling line ID name. + + + + + + + + + + Group level services. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Authorize (with quantity) or unauthorize a group service. + + + + + + + + + + + + + + Group's policy for a user's access to their Authentication service configuration. + + + + + + + + + + + Group's policy for a user's access to the group or enterprise directory. + + + + + + + + + + + Policy for user to delete call logs + + + + + + + + + + + Group's policy for a user's access to the name dialing override fields. + + + + + + + + + + + Group's policy for a user's access to his profile. + + + + + + + + + + + + Hiragana Last Name. + + + + + + + + + + + Hiragana First Name. + + + + + + + + + + + Choices for SIP Hold Normalization option + + + + + + + + + + + + Holiday name. + + + + + + + + + + + Holiday Schedule. + + + + + + + + + + + Maximum time limit for hoteling guests association to hoteling hosts + + + + + + + + + + + Hour. + + + + + + + + + + + Represents a specific time with hour and minute granularity + + + + + + + + + + + The weighted call distribution weight for an agent. + + + + + + + + + + + Time to wait for any agent to answer before forwarding the caller elsewhere. + + + + + + + + + + + Number of rings to wait for the currently hunted agent to answer before + hunting to the next available agent. + + + + + + + + + + + Policy for distributing calls within a hunt group or call center. + + + + + + + + + + + + + + Call distribution weight for an agent. + + + + + + + + + + + IMRN Timeout interval in milliseconds. + + + + + + + + + + + IMS User State per the 3GPP TS 29.328 V6.3.0 spec. + + + + + + + + + + + + + Numeric IP Address. + + + + + + + + + + + IP Address Range. + + + + + + + + + + + A no validation DN field. To be phased out, not for new + attributes. + + + + + + + + + + IMP userId + + + + + + + + + + Represents either an existing file for the application server to use, or + the contents of a file to transfer with a description. + + + + + + + + + + + + + + Represents either an existing file for the application server to use, or + the contents of a file to transfer with a description. + + + + + + + + + + + + + + + Represents an existing file for the application server to use, along with + a description and mediaType. + + + + + + + + + + + + Language identifies the language of a user or an administrator. + + + + + + + + + + + Last Name is the last name of a user or an administrator. + + + + + + + + + + + Group location dialing code for groups that are part of a enterprise. + + + + + + + + + + + Login Token. + + + + + + + + + + The login type of the admin/user. + + + + + + + + + + + + + + + + Subscriber Maintenance Partition name. + + + + + + + + + + Maximum Number of Active Calls + + + + + + + + + Password Rules can be used to specify the maximum allowed failed login attempts. + + + + + + + + + + Maximum Number of Incoming Calls. Value 0 indicates no incoming calls are allowed. + + + + + + + + + + Maximum number of users allowed in a monitored user list. + + + + + + + + + + + Maximum Number of No Answer Rings. + + + + + + + + + + Maximum Number of Outgoing Calls. Value 0 indicates no outgoing calls are allowed. + + + + + + + + + + Media Policy Selections. + + + + + + + + + + + + Media Set name + + + + + + + + + + + The media type of media data. + WMA - Windows Media Audio file + WAV - A WAV file + 3GP - A 3GP file + MOV - A MOV file using a H.263 or H.264 codec. + + + + + + + + + + + + + Media Stream Type. Subscriber's media is sent separately from the media generated by the called/calling parties when "Dual" is selected while "Single" is a single media stream that contains all media. + + + + + + + + + + + Minute. + + + + + + + + + + + Call Log entry describing a placed, received, or missed call. + + + + + + + + + + + + + + + + Mobility Manager provisioning user name + + + + + + + + + + + + Mobility Manager provisioning password + + + + + + + + + + + Mobility Manager service key + + + + + + + + + + + How the incomming caller ID should be displayed in the case of an NS screening failure + + + + + + + + + + + + Defines the month (January - December). + + + + + + + + + + + + + + + + + + + + + First name for the user's enhanced name dialing feature. + + + + + + + + + + + Last name for the user's enhanced name dialing feature. + + + + + + + + + + + Name dialing last and first names. + + + + + + + + + + The national prefix dialing digits. + + + + + + + + + IP Address, hostname, or domain. + + + + + + + + + + Communication Barring Profile defined as part of the Network Class + Of Service. There can be only one primary profile within a Network + Class Of Service. + + + + + + + + + + + Network Class of Service description. + + + + + + + + + + + Network Class of Service name. + + + + + + + + + + + Network Usage types. + + + + + + + + + + + + No charge treatments are handled by answering the call (via a 200 OK message) + or with early media (via a 18x message) + + + + + + + + + + + Non-negative integer. + + + + + + + + + + The Number Activation Modes + + The following values are only used in AS data mode: + Group And User Activation Enabled + + + + + + + + + + + + The time period for which a call processing thread waits for a number portability DNS lookup. + + + + + + + + + + Number Portability Status name. + + + + + + + + + + A OCI Call Control Application Id. + + + + + + + + + + + (ISO Language Code)_(ISO Country Code) or (ISO Language Code) only. + + + + + + + + + + Connection ping interval in seconds + + + + + + + + + + + Office Zone name. + + + + + + + + + + + Types of organizations. + + + + + + + + + + + An outgoing phone number or a number meant to be dialed. It is longer + than a DN so that equal access digits or access code digits may be + be included. It cannot be a SIP URL. + + + + + + + + + + + Phone Number or SIP URI that can be used to dial. + URI Validation: + - must be of the format string@string where string is at least one valid character and there is one and only one @. + - don't allow sip: + - allow the following characters in the user portions: + alphanumeric - _ . ! ~ * ' ( ) + - allow the following characters in the host portion: + alphanumeric - . + + + + + + + + + + + Overload Controls minimum time in zone milliseconds. + + + + + + + + + + + Overload Controls number of samples. + + + + + + + + + + + Overload Controls zone entry delay in milliseconds. + + + + + + + + + + + Overload Controls zone exit delay in milliseconds. + + + + + + + + + + user portion of the SIP URL. + + + + + + + + + + Portal passcode + + + + + + + + + + + Portal passcode expiration days. + + + + + + + + + + + Number of previous passwords to keep. + + + + + + + + + + + Maximum number of contiguously increasing or decreasing digits allowed in the passcode. + + + + + + + + + + + Maximum length of portal passcode. + + + + + + + + + + + Maximum number of repeated digits allowed in the passcode. + + + + + + + + + + + Minimum length of portal passcode. + + + + + + + + + + + + + + + + + + Password Rules can be used to specify when passwords expire. + + + + + + + + + + + Number of previous passwords to keep. + + + + + + + + + + + Password Rules can be used to require at least this many numeric digits in passwords. + + + + + + + + + + + Password Rules can be used to require at least this total characters in passwords. + + + + + + + + + + + Password Rules can be used to require at least this many lowercase letters in passwords. + + + + + + + + + + + Password Rules can be used to require at least this many non-alphanumeric characters in passwords. + + + + + + + + + + + Password Rules can be used to require at least this many uppercase letters in passwords. + + + + + + + + + + Phone list entry. + + + + + + + + + + The name in a phone list entry. + + + + + + + + + + + Physical geographic location of the zone + + + + + + + + + + + Possible values for administrative access policy settings. + + + + + + + + + + + + + + + + + + + + TCP/IP Port. + + + + + + + + + + + TCP/IP Port number above the well-known range. + + + + + + + + + + + TCP/IP Port. + + + + + + + + + + + TCP/IP Port. + + + + + + + + + + + Maximum allowed portal failed login attempts. + + + + + + + + + + Provisioning username for Messaging Server OSS authentication + + + + + + + + + Provisioning password for Messaging server OSS authentication + + + + + + + + + + Public User Identity + + + + + + + + + + + Represents either a random port number, or a specific port number. + + + + + + + + + + + Defines recurrence. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Defines daily event recurrence interval. + + + + + + + + + + + Defines the number of occurrences of a recurring event. + + + + + + + + + + + Defines monthly event recurrence interval. + + + + + + + + + + + Defines weekly event recurrence interval. + + + + + + + + + + + Defines yearly event recurrence interval. + + + + + + + + + + + A list of Communication Barring Incoming Rules that replaces a + previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + A list of Communication Barring Alternate Call Indicator that replaces + a previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + A list of Communication Barring Call Types that replaces a previously + configured list. By convention, an element of this type may be set + nill to clear the list. + + + + + + + + + + A list of devices that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + A list of communication barring profiles that replaces a previously configured list. + By convention, an element of this type may be set nil to clear the list. + + + + + + + + + + A list of Number Portability Query Statuses that replaces a previously + configured list. By convention, an element of this type may be set + to nill to clear the list. + + + + + + + + + + A list of outgoing dns that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + A list of phone numbers or sipuris that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + A list of service packs that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + A list of SIP aliases that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + A list of userIds that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + A list of user services that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + A list of Virtual On-Net Call Types that replaces a previously + configured list. By convention, an element of this type may be set + to nill to clear the list. + + + + + + + + + + Maximum number of rows to return in response to a paging request for data + + + + + + + + + + + Used in queries to restrict the set of result rows when making a request that can result in + a large dataset. The client specifies the starting row and the number of rows requested. + The server only provides those rows in results, if available. + + + + + + + + + + + The starting row number to return in a response. + The first row is numbered starting at 1, not 0. + + + + + + + + + + The supported ring patterns. + + + + + + + + + + + + + The Route Point External System's name. + + + + + + + + + + + Routing Profile. + + + + + + + + + + + The number of failure detections it takes to mark a server out of service. + + + + + + + + + + + The value in milliseconds specifying how long to wait for a response from a server. + + + + + + + + + + + The value in seconds specifying how long to wait before retrying a failed server. + + + + + + + + + + + Uniquely identifies Holiday and Time Schedules throughout all System, Service Provider, Group and User level. + + + + + + + + + + + Uniquely identifies Holiday and Time Schedules within a level(System, Service Provider, Group or User level). + + + + + + + + + + + Schedule access level. + + + + + + + + + + + + Schedule name. + + + + + + + + + + + Schedule type. + + + + + + + + + + + Security Classification name. + + + + + + + + + + + Retrives all Holiday or Time Event details for a given schedulel Level. + + + + + + + + + + + + + + + + + + + + Service Instance active status indicator + + + + + + + + + + + Service Codes that are used for dialing in lieu of phone numbers. + The digit pattern may contain digits 0-9, ?, *, and #. + + + + + + + + + + + Service Code description. + + + + + + + + + + + Service Instance Name for a service without a user id. + + + + + + + + + + + Service Instance Name for a service with a user id. + + + + + + + + + + + Service Profile Information for group service. + + + + + + + + + + + + + + + + + + + + + + + Service Profile Information for a call center. + Password is required. + + + + + + + + + + + + + + + + + + + + + + + + + + + Service Profile Information for a trunk group. + The publicUserIdentity element is not part of ServiceInstanceAddProfileTrunkGroup. + + + + + + + + + + + + + + + + + + + + + + + + + + Service Profile Information for group service used when modifying an existing service instance. + + + + + + + + + + + + + + + + + + + + + + + Service Profile Information for group service. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + Authorize (with quantity) or unauthorize a service pack. + + + + + + + + + + + + + Service Pack name. + + + + + + + + + Service Pack description. + + + + + + + + + + Service Provider Administrator's policy for accessing access devices. + + + + + + + + + + + + Service Provider Administrator's policy for accessing other + Service Provider Administrator's within the same service provider. + + + + + + + + + + + + Service Providers Administrator's policy for accessing + the Communication Barring information. + + + + + + + + + + + Service Provider Administrator's policy for accessing department lists + within the service provider. + + + + + + + + + + + + Policy for accessing the service provider Dialable Caller ID configuration. + + + + + + + + + + + + Service Provider Administrator's policy for accessing groups + within the service provider. + + + + + + + + + + + + Service Provider Administrator's policy for accessing + the Office Zone information. + + + + + + + + + + + Service Provider Administrator's policy for accessing phone numbers or + extensions. + + + + + + + + + + + + Service Provider Administrator's policy for accessing + the service provider profile information. + + + + + + + + + + + + Service Provider Administrator's policy for accessing services. + "No Authorization" was added in release 14. + + + + + + + + + + + + Service Provider Administrator's policy for accessing service packs. + + + + + + + + + + + Service Provider Administrator's policy for accessing + the Session Admission Control information. + + + + + + + + + + + + Service Provider Administrator type + "Normal" indicates the service provider admin is a normal admin. + "Customer" indicates the service provider admin is a customer admin. + "Password Reset Only" indicates the service provider admin is a password reset only admin. + + + + + + + + + + + + Policy for a service provider administrator's access to user configuration. + "Full" indicates full access to users in the service provider. + "Full Profile" indicates + 1) the service provider administrator is restricted from adding or removing users, but + 2) has full access to the user's profile + "Read-Only Profile" indicates + 1) the service provider administrator is restricted from adding or removing users, and + 2) read-only access is granted to the user's profile. + "No Profile" indicates + 1) the service provider administrator is restricted from adding or removing users, and + 2) no access is granted to the user's profile. + "None" indicates no access to users in the service provider. + + + + + + + + + + + + + + Service Provider Administrator's policy for accessing to Verify Translation and Routing feature. + + + + + + + + + + + Service Provider Administrator's policy for accessing web branding. + + + + + + + + + + + Service Provider Administrator's policy for accessing calling line id number. + + + + + + + + + + + Internal Call CLID Policy applicable to service providers. + + + + + + + + + + + Group Administrator's policy for accessing calling line id number. + + + + + + + + + + + Department Administrator's policy for accessing calling line id number. + + + + + + + + + + + Policy for a department administrator's access to assigning phone numbers and extensions. + + + + + + + + + + + Service Provider Communication Barring Hierarchical Call Me Now Rule + + + + + + + + + + + + + + + + + + Service Provider Communication Barring Hierarchical Originating Rule + + + + + + + + + + + + + + + + + + + + Service Provider Communication Barring Hierarchical Redirecting Rule + + + + + + + + + + + + + + + + + + Choices for the service provider conference URI + setting to decide which level of settings to use. + + + + + + + + + + + Service Provider Id uniquely identifies a service provider. + NOTE: The service provider id has a maximum length of 30 bytes, not 30 characters. + + + + + + + + + + Service Provider display name. + + + + + + + + + + A list of Service Provider Communication Barring Hierarchical Call Me Now Rules that replaces a previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + A list of Service Provider Communication Barring Hierarchical Originating Rules that replaces a previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + A list of Service Provider Communication Barring Hierarchical Redirecting Rules that replaces a previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + Session Admission Control Group name. + Uniquely identifies a Session Admission Control Group within a group or enterprise. + + + + + + + + + + + Maximum Shared Call Appearances. + + + + + + + + Warning tone types for Shared Call Appearance. + The bridge warning tone types are none, barge-in, barge-in repeat. + + + + + + + + + + + + Device type signaling address types. + + + + + + + + + + + + + Signed Password. + + + + + + + + + + Simultaneous Ring number entry. + + + + + + + + + + + A list of Simultaneous Ring numbers that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + Simultaneous Ring Selection. + + + + + + + + + + + SIP Registration Contact without the sip: prefix. + Validation: + - do not allow sip: + - allow the following characters: + alphanumeric ampersand = + $ , ; ? / - _ . ! ~ * ' ( ) : @ + + + + + + + + + + + SIP URI. + The SIP URI is used in many different places in the schema. + If the SIPURI is an alias, the Validation rules are: + - don't allow sip: + - allow the following characters: + alphanumeric - _ . ! ~ * ' ( ) @ + - exactly one @ symbol + - user portion and host portion are both required + + + + + + + + + + SIP Authentication User Name. + + + + + + + + + SIP Authentication Password + + + + + + + + + + Speed dial prefix. + + + + + + + + + + + Maximum length of SMPP short message in characters used for MWI Delivery to Mobile EndPoint. + + + + + + + + + + + Speed dial prefix. + + + + + + + + + + + Different type of user and virtual subscriber which could have a set of call processing policy profile defined in BroadWorks. + + + + + + + + + + + + + + + + + + + + + + + + A list of CallProcessingPolicyProfileSubscriberType21. The list replaces a previously configured list. + + + + + + + + + + System Administrator types. + + + + + + + + + + + System User Calling Line Id Options. + + + + + + + + + + + + + Ring timeout for a user. + + + + + + + + + + + The from dn criteria. + + + + + + + + + + Time zone key. + + + + + + + + + + Localized Time Zone Display Name + + + + + + + + + + Title. + + + + + + + + + + Valid range for space allocation (in Megabytes) for files in the announcement repository. + + + + + + + + + + + Network Transport Protocol. + + + + + + + + + + + + An SNMP trap will be sent when the number of counted events crosses this threshold value. + + + + + + + + + + Subsequent SNMP traps will be sent after the intial trap each time the number of + counted events increases by this value since the last trap. + + + + + + + + + Treatment name. + + + + + + + + + + Configurable Treatment Name + + + + + + + + + + + Trunk group endpoint. + + + + + + + + + + + + Trunk group endpoint. + + + + + + + + + + + + Trunk group endpoint. + + + + + + + + + + + + Trunk Group capacity exceeded action. + + + + + + + + + + + Trunk group device endpoint used in the context of modify. + + + + + + + + + + + + Trunk group device endpoint. + + + + + + + + + + + + + + + Trunk group device endpoint used in the context of modify. + + + + + + + + + + + + Trunk Group device name. + + + + + + + + + + + The timer to start when an invitation is sent to a device associated with a trunk group. + + + + + + + + + + + Uniquely identifies a Trunk Group system-wide. + The trunkGroupName is unique within a group, but not unique system-wide. + + + + + + + + + + + + Trunk Group pilot user information used when adding a Trunk Group. + + + + + + + + + + + + + + + + + + + + + + + Trunk Group name. + Uniquely identifies a Trunk Group within a business (or family) group. + + + + + + + + + + + Parameter to control whether to enable Trunking OOD PBX Redirection CLID mapping. + + + + + + + + + + + + Trunk Group pilot user information used when adding a Trunk Group. + + + + + + + + + + + + + + + + + + + + + + Trunk Group Pilot User Calling Line Identity policy + + + + + + + + + + + Trunk Group Call Count Highwater mark Holdover period in minutes + + + + + + + + + + + + + + + Trunk Group timezone offset minutes + + + + + + + + + + + + Unbounded Quantity. Can either be unlimited or a non-negative int quantity. + + + + + + + + + + + + + + + + + + Unbounded Quantity. Can either be unlimited or a positive int quantity. + + + + + + + + + + + + + + + + + + Choices for the user device policy line mode. + + + + + + + + + + + The parts of a user's display name that a client can display in whatever way is appropriate + for the client application. + + + + + + + + + + + + + Key to uniquely identify a user endpoint. + + + + + + + + + + + Feature Access Code Entry to be used in all user modify command. + + + + + + + + + + + A user id consists of a user-portion optionally followed by an @ sign and a domain name. + If the domain is not specified, it is assumed to be the system default domain. + The domain is required when adding normal users and virtual users, i.e. Auto Attendants, + Hunt Groups, Call Centers.... + The domain must not be specified for system-level and service-provider-level administrators. + + + + + + + + + + + User level services. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Authorize (with quantity) or unauthorize a user service. + + + + + + + + + + + + + + Types of users in BroadWorks. + + + + + + + + + + + + + + + + + + + + + + + URL. + + + + + + + + + + Virtual On-Net Call Type CDR value. + + + + + + + + + + + Virtual On-Net Call Type name. + + + + + + + + + + + Verification Translation and Routing destination + value. Represents the called user, number or URI. + + + + + + + + + + + Verification Translation and Routing origination + value. + + + + + + + + + + + + + Verification Translation and Routing parameters + for creating a Verify Translation and Routing request from + parameters. + + + + + + + + + + + + + Web based configuration URL. + + + + + + + + + + Yahoo Id. + + + + + + + + + Zone Name. + + + + + + + + + + Device Management System device type options during a modify request. + + + + + + + + + + + + + + + + + + + + + + + + + + CPE device's options. + + The field configType is optional to allow the use of field enableMonitoring for all device types being managed or not + ie. device configuration option equals to DeviceManagement, or Legacy, or Not Supported). + + If the device configuration option is set to "Not Supported", the value of configType is forced set to "None" regardless + of its current value. + + It is not allowed to add a device type with device configuration option set to Device Management or Legacy when the configType + is not set. + + + + + + + + + + + + + + Device Management System device type options. + + + + + + + + + + + + + + + + + + + + + + + + + + + CPE device's options. + + + + + + + + + + + + + + Device Management System device type options. + + + + + + + + + + + + + + + + + + + + + + + + + + + The file name format for an access device file managed by the Device Management System on BroadWorks. + + + + + + + + + + + The file category for an access device file managed by the Device Management System on BroadWorks. A static file has no variable content and only one copy is required on the repository. + + + + + + + + + + + + Choices for the device type configuration mode. + + + + + + + + + + + The Xtended Services Platform Device Management System webapp context name deployed to serve device access requests. + + + + + + + + + + + Access device credentials. + + + + + + + + + + + Protocols that an access device can use to fetch files from BroadWorks. + + + + + + + + + + + + + A device language name. + + + + + + + + + + + A static tag set name. + + + + + + + + + + + The access URI that a device uses to access files on BroadWorks. + + + + + + + + + + + Defines the tag sets used when device configuration files are built. + + + + + + + + + + + + CPE device's options when used with a modify request. + The following options are not changeable: + configType + systemFileName + deviceFileFormat + + + + + + + + + + + A static tag name for access device files managed by the Device Management System on BroadWorks. + The static tag name must start and end with a % with no other % in between. The tag must not + start with %BW. + + + + + + + + + + + A static tag value for access device files managed by the Device Management System on BroadWorks. + + + + + + + + + + + + + + + + + + + + + + + + + A user id for a File Repository. + + + + + + + + + + + A password for a File Repository. + + + + + + + + + + + Defines the maximum size in kB of an audio announcement file. + + + + + + + + + + + Defines the maximum size in kB of an video announcement file. + + + + + + + + + + Realm Name. + + + + + + + + + Byte Representation of a Md5 Hash. + + + + + + + + + Ha1 Complement of a Http Digest Authentication. + + + + + + + + + + The group's extension length. + + + + + + + + + + + The web display key used for localization. + + + + + + + + + + + In Call Service Activation DigitMap. + + + + + + + + + + + Controls the file customization privileges. + + + + + + + + + + + + Choices for the type of rebuild requested. + + + + + + + + + + BroadWorks server unique identifier. + + + + + + + + + + The Registration Address URI. + + + + + + + + + + + Application Server set name. + + + + + + + + + + Certificate file. + + + + + + + + Deactivation reason. + + + + + + + + + Domain name. + + + + + + + + + BroadWorks Mobile Manager name. + + + + + + + + + + Country dialing code. + A single asterisk or digit range from 000 to 999. + + + + + + + + + + + Network Country Code + A single asterisk or digit range from 00 to 999. + + + + + + + + + + + Location area code. + A single asterisk or digit range from 0 to 65535. + + + + + + + + + + + Cell ID. + A single asterisk or digit range from 0 to 65535. + + + + + + + + + + + Information file. + + + + + + + + + + Maximum number of simultaneous SS7 transactions allowed + per second before throttling occurs. + + + + + + + + + + + BroadWorks Mobile Manger API password + + + + + + + + + + + BroadWorks Mobile Manger API user name + + + + + + + + + + + Types of Endpoints in Broadworks. + + + + + + + + + + + + Choices for Service Type + + + + + + + + + + + + + + + + + + + + + + + Outgoing Calling Plan Authorization Code. + + + + + + + + + + + Device Type Configuration Option Type. + + + + + + + + + + + User Agent Header + + + + + + + + + + Access Device Port number value. + + + + + + + + + + + Line ordering value. + + + + + + + + + + + Line ordering task status value. + + + + + + + + + + + + Number of seconds to wait before playing Meet-Me conference Security Classification Change. + + + + + + + + + + + Phone number lookup service type. + + + + + + + + + + + + + + Type of reset event for a CPE device. + + + + + + + + + + + DEPRECATION NOTE: This is only used by deprecated R16 and R14 commands. + Extension. + + + + + + + + + + + The subscriber schema version. + + + + + + + + + + + Identifier for conference. + + + + + + + + + + + Conference Id or moderator pin. + + + + + + + + + + + Contains a list of audio or video files to modify. + + + + + + + + + + + + + The modify configuration of a key for Auto + Attendant. + + + + + + + + + + + The key of Auto Attendant. + + + + + + + + + + + + + + + + + + + + + The modify configuration entry of a key for Auto + Attendant. + The following data elements are only + used in AS data + mode: + audioFile + videoFile + submenuId + The following data elements are only valid for Standard Auto + Attendants: + submenuId + + + + + + + + + + + + + + + The description of each menu key. + + + + + + + + + + + The action of Auto Attendant key. + The following data elements are only used in AS data mode: + Transfer To Mailbox + Play Announcement + Transfer To Submenu + Return to Previous Menu + The following data elements are only valid for Standard Auto + Attendants: + Transfer To Submenu + Return to Previous Menu + The following data elements are only valid for submenus: + Return to Previous Menu + + + + + + + + + + + + + + + + + + + + The Submenu Id. + + + + + + + + + + + Branding Selection. + + + + + + + + + + + The scope of extension or name dialing. + + + + + + + + + + + + The format callers should use when dialing by name. + + + + + + + + + + + Announcement Selection. + + + + + + + + + + + + + + The configuration of a alternate no answer + greeting. + It is used when modifying a user's voice + messaging + greeting. + + + + + + + + + + + + The name of alternate no answer greeting. + + + + + + + + + + + The number of rings before greeting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Announcement Selection. + + + + + + + + + + + + + + The Service Access Code composed of DTMF digits 0-9, # or *. + + + + + + + + + + + Service Access Code description. + + + + + + + + + + + The service pack migration task will be aborted if this many errors occurs. + + + + + + + + + + The number of hours after the scheduled start time when a task becomes expired. + + + + + + + + + + + The maximum duration in hours for a service pack migration task to run after the task actually start running. + + + + + + + + + + Service pack migration task name. + + + + + + + + + + Possible status values of a service pack migration task. + + + + + + + + + + + + + + + + + Possible status values of a service pack migration task. + + + + + + + + + + + + Anser Confirmation Announcement Selection. + + + + + + + + + + + User types for which the Service Provider Password Rules apply. + The rules could apply to the Administrators (Group and Department) or + Administrators (Group and Department) and Users. + + + + + + + + + + + + The timer determines how long the system will wait for the confirmation. + + + + + + + + + + + Possible status values of a service pack migration task. + + + + + + + + + + + + + + + + Personal Assistant exclusion number description. + + + + + + + + + + The Call to Number type. + + + + + + + + + + + + + + + + + + + + + Call to Number. + + + + + + + + + + + + A list of Call to Numbers that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + For the callToNumbers, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + + + + + + + + + + Pattern of 3-digit status codes in the SIP OPTIONS response messages, ranging from "000" to "999", inclusively. + A status code pattern consists of digits "0" through "9" and the following wild cards: + ?: Denotes any single digit. For example, "2??" matches any three-digit string beginning with "2". + "?" cannot be used within brackets. + []: Denotes a single digit that satisfies the specified range of digits. A consecutive range is indicated with + a hyphen "-", while a nonconsecutive range is indicated with a comma ",". Hyphens and commas can be used + in combination, for example "[5-7,9]". Brackets cannot be nested. "?" cannot be used within brackets. + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDeprecated14.xsd b/share/OCISchemaAS/OCISchemaDeprecated14.xsd new file mode 100644 index 0000000..09f1c4a --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDeprecated14.xsd @@ -0,0 +1,7225 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + AuthenticationVerifyRequest is used to authenticate a user using the user Id and password. The response is a AuthenticationVerifyResponse or an ErrorResponse + Replaced By: AuthenticationVerifyRequest14sp8 + + + + + + + + + + + + + + + + Response to AuthenticationVerifyRequest + Replaced By: AuthenticationVerifyResponse14sp8 + + + + + + + + + + + + + + + + + + + + + + + + Request the enterprise level data associated with Voice VPN. + The response is either a EnterpriseVoiceVPNGetResponse or an ErrorResponse. + Replaced By: EnterpriseVoiceVPNGetRequest14sp3 + + + + + + + + + + + + + + + Response to EnterpriseVoiceVPNGetRequest. + Replaced By: EnterpriseVoiceVPNGetResponse14sp3 + + + + + + + + + + + + + + + + + Requests the configuration of a specified group access device. + The response is either GroupAccessDeviceGetResponse14 or ErrorResponse. + Replaced By: GroupAccessDeviceGetRequest14sp3 + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetRequest14. + Replaced By: GroupAccessDeviceGetResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified group access device. + The response is either GroupAccessDeviceGetResponse14sp3 or ErrorResponse. + Replaced By: GroupAccessDeviceGetRequest14sp6 + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetRequest14sp3. + Replaced By: GroupAccessDeviceGetResponse14sp6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest. + Contains the policy settings for the group administrator. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupCallCenterAddInstanceRequest14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupCallCenterAddInstanceRequest14sp9 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's announcement settings. + The response is either a GroupCallCenterGetAnnouncementResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAnnouncementRequest. + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse14 or ErrorResponse. + Replaced By: GroupCallCenterGetInstanceRequest14sp3 + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceRequest14. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight". + Replaced By: GroupCallCenterGetInstanceResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse14sp3 or ErrorResponse. + Replaced By: GroupCallCenterGetInstanceRequest14sp9 + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceRequest14sp3. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight". + Replaced By: GroupCallCenterGetInstanceResponse14sp9 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get Call Center queue and agent statistics. + The response is either GroupCallCenterGetInstanceStatisticsResponse13mp8 or ErrorResponse. + Replaced By: GroupCallCenterGetInstanceStatisticsRequest14sp9 + + + + + + + + + + + + + + + Contains Call Center statistics. + Replaced By: GroupCallCenterGetInstanceStatisticsResponse14sp9 + + + + + + + + + + + + + + + + + + + + + + Get a list of supervisors assigned to a call center. + Only users in the same group or enterprise as this call center can + successfully execute this request. + The response is either a GroupCallCenterGetSupervisorListResponse + or an ErrorResponse. + Replaced By: GroupCallCenterSupervisorReportingGetRequest + + + + + + + + + + + + + + + Response to the GroupCallCenterGetSupervisorListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + Element "reportingServerURL"" will always be blank. + Replaced By: GroupCallCenterSupervisorReportingGetResponse + + + + + + + + + + + + + + + + Modify a call center's announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Modify the Call Center statistics reporting frequency and destination. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupCallCenterModifyInstanceStatisticsReportingRequest14sp9 + + + + + + + + + + + + + + + + + + + + Replaces a list of users as supervisors for a call center. + Also allows the modification of the reporting server URL address. + The response is either a SuccessResponse or an ErrorResponse. + Element "reportingServerURL"" will always be ignored. + Replaced By: GroupCallCenterSupervisorReportingModifyRequest + + + + + + + + + + + + + + + + + Get the calling line id settings for a group. + The response is either a GroupCallingLineIdGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallingLineIdGetRequest. + The response contains the group's calling line id settings. + + + + + + + + + + + + + + + + + + Modify the calling line id settings for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse14 or an + ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest14. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse14sp1 or an + ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest14sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse14sp4 or an + ErrorResponse. + Replaced By : GroupCallProcessingGetPolicyRequest15 + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest14sp4. + Replaced By : GroupCallProcessingGetPolicyResponse15 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group level data associated with Call Procesing Policy. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By : GroupCallProcessingModifyPolicyRequest15 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the list of feature access codes for a group. + The response is either a GroupFeatureAccessCodeGetListResponse or an ErrorResponse. + Replaced by: GroupFeatureAccessCodeGetRequest + + + + + + + + + + + + + + + + Response to the GroupFeatureAccessCodeGetListRequest. + Replaced by: GroupFeatureAccessCodeGetResponse + + + + + + + + + + + + + + + Get the profile for a group. + The response is either a GroupGetResponse or an ErrorResponse. + Replaced By: GroupGetRequest14sp7 + + + + + + + + + + + + + + + + Response to the GroupGetRequest. + The response contains the group's profile information. + Replaced By: GroupGetResponse14sp7 + + + + + + + + + + + + + + + + + + + + + + + + Modify a list of feature access codes for a group. + The response is either a SuccessResponse or an ErrorResponse. + Replaced by: GroupFeatureAccessCodeModifyRequest + + + + + + + + + + + + + + + + + + + + Add a Music On Hold Instance to a department. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupMusicOnHoldAddInstanceRequest14Sp4 + + + + + + + + + + + + + + + + + + + + + + + Add a Music On Hold Instance to a department. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Get a Music On Hold data for a group or department instance. + The response is either GroupMusicOnHoldGetInstanceResponse14 or ErrorResponse. + Replaced By: GroupMusicOnHoldGetInstanceRequest14Sp4 + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetInstanceRequest14. + + + + + + + + + + + + + + + + + + + + + + Get a Music On Hold data for a group or department instance. + The response is either GroupMusicOnHoldGetInstanceResponse14sp4 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetInstanceRequest14sp4. + + + + + + + + + + + + + + + + + + + + + + + Modify data for a group or department Music On Hold Instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group's policy settings. + The response is either GroupPolicyGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPolicyGetRequest. + Contains the policy settings for the group. + + + + + + + + + + + + + + + + + + + + + + Requests the Group's policy settings. + The response is either GroupPolicyGetResponse14sp1 or ErrorResponse. + Replaced By : GroupPolicyGetRequest14sp4 + + + + + + + + + + + + + + + + Response to GroupPolicyGetRequest14sp1. + Contains the policy settings for the group. + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The domain is required in the serviceUserId. + The publicUserIdentity in the ServiceInstanceAddProfile is not allowed for trunk groups. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The domain is required in the serviceUserId. + The publicUserIdentity in the ServiceInstanceAddProfile is not allowed for trunk groups. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a Trunk Group Instance from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of Trunk Groups for the group or enterprise. + It is possible to restrict the results to a particular department, or expand the list to the entire enterprise. + The response is either a GroupTrunkGroupGetInstanceListResponse14 or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceListRequest14. + Contains a table with column headings "Service User Id", "Name", "Department", "Device Name", "Device Level", + "Group Id". + The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse14 or an ErrorResponse. + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest. + The publicUserIdentity in the ServiceInstanceReadProfile is not used for trunk groups. + Returns the profile information for the Trunk Group. + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse14sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest14sp1. + The publicUserIdentity in the ServiceInstanceReadProfile is not used for trunk groups. + Returns the profile information for the Trunk Group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest14sp4. + Returns the profile information for the Trunk Group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse14sp5 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest14sp5. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse14sp9 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest14sp9. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse14sp9A or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest14sp9A. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of user's on a Trunk Group Instance. + The response is either a GroupTrunkGroupGetInstanceUserListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceUserListRequest. + The response contains a 7 column table with column headings "User Id", "Last Name", + "First Name", "Department", "Phone Number", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Get the maximum permissible active trunk group calls for the group. + The response is either a GroupTrunkGroupGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupTrunkGroupGetRequest. + The response contains the maximum permissible active trunk group calls for the group. + + + + + + + + + + + + + + + + Get the maximum and bursting maximum permissible active trunk group calls for the group. + The response is either a GroupTrunkGroupGetResponse14sp1 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupTrunkGroupGetRequest14sp1. + The response contains the maximum and bursting maximum permissible active trunk group calls for the group. + + + + + + + + + + + + + + + + + + Modify the maximum and bursting maximum permissible active Trunk Group calls for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Modify a Trunk Group Instance in a group. + The publicUserIdentity in the ServiceInstanceModifyProfile is not allowed for trunk groups. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a Trunk Group Instance in a group. + The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a Trunk Group Instance in a group. + The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a user creation task for a trunk group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a user creation task for a trunk group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the list of user creation tasks for a trunk group. + The response is either GroupTrunkGroupUserCreationTaskGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupTrunkGroupUserCreationTaskGetListRequest. + Contains a table with a row for each user creation task and column headings : + "Name", "Status", "Users Created", "Total Users To Create", "Error Count". + + + + + + + + + + + + + + + Request the details of a specified user creation task for a trunk group. + The response is either GroupTrunkGroupUserCreationTaskGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to a GroupTrunkGroupUserCreationTaskGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + LoginRequest13mp10 is 2nd stage of the 2 stage OCI login process. + The signedPassword is not required for external authentication login from a trusted host (ACL). + + + + + + + + + + + + + + + + LoginRequest13mp10/Response13mp10 is 2nd stage of the 2 stage OCI login process. + + + + + + + + + + + + + + + + + Requests the group's voice portal passcode rules setting. + The response is either GroupVoiceMessagingGroupGetPasscodeRulesResponse or ErrorResponse. + Replaced By: GroupPortalPasscodeRulesGetRequest + + + + + + + + + + + + + + + + Response to GroupVoiceMessagingGroupGetPasscodeRulesRequest. + Contains the group's voice portal passcode rules setting. + Replaced By: GroupPortalPasscodeRulesGetResponse + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the group's voice messaging settings + The response is either GroupVoiceMessagingGroupGetVoicePortalResponse14 or ErrorResponse. + Replaced by GroupVoiceMessagingGroupGetVoicePortalRequest15 + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalRequest14. + Replaced by GroupVoiceMessagingGroupGetVoicePortalResponse15 + + + + + + + + + + + + + + + + + + + + + + Request to modify the group's voice portal passcode rules setting. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupPortalPasscodeRulesModifyRequest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified service provider access device. + The response is either ServiceProviderAccessDeviceGetResponse14 or ErrorResponse. + Replaced By: ServiceProviderAccessDeviceGetRequest14sp3 + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceGetRequest14. + Replaced By: ServiceProviderAccessDeviceGetResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified service provider access device. + The response is either ServiceProviderAccessDeviceGetResponse14sp3 or ErrorResponse. + Replaced By: ServiceProviderAccessDeviceGetRequest14sp6 + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceGetRequest14sp3. + Replaced By: ServiceProviderAccessDeviceGetRequest14sp6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse14 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest14. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse14sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest14sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse14sp4 or an ErrorResponse. + Replaced By : ServiceProviderCallProcessingGetPolicyRequest15 + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest14sp4. + Replaced By : ServiceProviderCallProcessingGetPolicyResponse15 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the service provider level data associated with Call Procesing + Policy. The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the service provider's password rules settings + setting applicable to Administrators (Group and Department) and Users. + The response is either SuccessResponse or ErrorResponse. + Replaced By: ServiceProviderPasswordRulesModifyRequest14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the details of a specified service pack migration task. + The response is either ServiceProviderServicePackMigrationTaskGetResponse + or ErrorResponse. + Replaced By: ServiceProviderServicePackMigrationTaskGetRequest14sp4 + + + + + + + + + + + + + + + + Response to ServiceProviderServicePackMigrationTaskGetRequest. + The groupTable column headings are: "Migrate", "Group Id", "Group Name", "User Count". + Replaced By: ServiceProviderServicePackMigrationTaskGetResponse14sp4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the maximum permissible active Trunk Group calls for the service provider. + The response is either a ServiceProviderTrunkGroupGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderTrunkGroupGetRequest. + The response contains the maximum permissible active trunk group calls for the service provider. + + + + + + + + + + + + + + + Requests the service provider's voice portal passcode rules setting. + The response is either ServiceProviderVoiceMessagingGroupGetPasscodeRulesResponse or ErrorResponse. + Replaced By: ServiceProviderPortalPasscodeRulesGetRequest + + + + + + + + + + + + + + + Response to ServiceProviderVoiceMessagingGroupGetPasscodeRulesRequest. + Contains the service provider's voice portal passcode rules setting. + Replaced By: ServiceProviderPortalPasscodeRulesGetResponse + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the service provider's voice portal passcode rules setting. + The response is either SuccessResponse or ErrorResponse. + Replaced By: ServiceProviderPortalPasscodeRulesModifyRequest + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified system access device. + The response is either SystemAccessDeviceGetResponse or ErrorResponse. + Replaced By: SystemAccessDeviceGetRequest14sp3 + + + + + + + + + + + + + + + Response to SystemAccessDeviceGetRequest. + Replaced By: SystemAccessDeviceGetResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified system access device. + The response is either SystemAccessDeviceGetResponse14sp3 or ErrorResponse. + Replaced By: SystemAccessDeviceGetRequest14sp6 + + + + + + + + + + + + + + + Response to SystemAccessDeviceGetRequest14sp3 + Replaced By: SystemAccessDeviceGetResponse14sp6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of Application Server Registration system parameters. + The response is either SystemASRParametersGetResponse or ErrorResponse. + Replaced By: SystemASRParametersGetRequest14sp5 + + + + + + + + + + + + + Response to SystemASRParametersGetRequest. + Contains a list of system Application Server Registration parameters. + Replaced By: SystemASRParametersGetResponse14sp5 + + + + + + + + + + + + + + + + + Request to get the list of Application Server Registration system parameters. + The response is either SystemASRParametersGetResponse14sp5 or ErrorResponse. + + + + + + + + + + + + + Response to SystemASRParametersGetRequest14sp5. + Contains a list of system Application Server Registration parameters. + + + + + + + + + + + + + + + + + + Request to modify Application Server Registration system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request the system's automatic callback attributes. + The response is either a SystemAutomaticCallbackGetResponse or an ErrorResponse. + Replaced By: SystemAutomaticCallbackGetRequest15 + + + + + + + + + + + + + Response to SystemAutomaticCallbackGetRequest. + Replaced By: SystemAutomaticCallbackGetResponse15 + + + + + + + + + + + + + + + + + + + Modifies the system's automatic callback attributes. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: SystemAutomaticCallbackModifyRequest15 + + + + + + + + + + + + + + + + + + + Add an OCI entry to the Broadworks Common Communication Transport (BCCT) protocol to interface mapping table. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Delete an OCI entry in the Broadworks Common Communication Transport (BCCT) protocol to interface mapping table. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the OCI entries from the Broadworks Common Communication Transport (BCCT) protocol to interface mapping list. + The response is SystemBCCTGetOCIInterfaceAddressListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemBCCTGetOCIInterfaceAddressListRequest. + + + + + + + + + + + + + + + Request the system level data associated with Call Center. + The response is either a SystemCallCenterGetResponse or an + ErrorResponse. + Replaced By: SystemCallCenterGetRequest14sp9 + + + + + + + + + + + + + Response to SystemCallCenterGetRequest. + Replaced By: SystemCallCenterGetResponse14sp9 + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse14 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest14. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse14sp1 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest14sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse14sp4 or an + ErrorResponse. + Replaced By : SystemCallProcessingGetPolicyRequest15 + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest14sp4. + Replaced By : SystemCallProcessingGetPolicyResponse15 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with Call Processing Policy. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By : SystemCallProcessingModifyPolicyRequest15 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get all the licensing information. + The response is either SystemLicensingGetResponse or ErrorResponse. + Replaced By: SystemLicensingGetRequest14sp3 + + + + + + + + + + + + + Response to SystemLicensingGetRequest. The license table columns are: "Name", "Licensed", "Used", + "Available" and "Expiration Date". + Replaced By: SystemLicensingGetResponse14sp3 + + + + + + + + + + + + + + + + + + + + Request to get the list of CAP system parameters. + The response is either SystemCAPParametersGetResponse or ErrorResponse. + Replaced By: SystemCAPParametersGetRequest14sp3 + + + + + + + + + + + + + Response to SystemCAPParametersGetRequest. + Contains a list of system CAP parameters. + Replaced By: SystemCAPParametersGetResponse14sp3 + + + + + + + + + + + + + + + + + + + + Add a device CPE config file server. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemCPEConfigAddFileServerRequest14sp6 + + + + + + + + + + + + + + + + + + + + Requests the list of device CPE config file servers. + The response is either SystemCPEConfigGetFileServerListResponse or ErrorResponse. + Replaced By: SystemCPEConfigGetFileServerListRequest14sp6 + + + + + + + + + + + + + Response to SystemCPEConfigGetFileServerListRequest. The table columns are: + "Device Type", "FTP Host Net Address", "FTP User Id", "Directory" and "Passive FTP". + Replaced By: SystemCPEConfigGetFileServerListResponse14sp6 + + + + + + + + + + + + + + + Modify a device CPE config file server. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemCPEConfigModifyFileServerRequest14sp6 + + + + + + + + + + + + + + + + + + + + Request to get the list of CPE Config system parameters. + The response is either SystemCPEConfigParametersGetResponse or ErrorResponse. + Replaced By: SystemCPEConfigParametersGetRequest14sp6 + + + + + + + + + + + + + Response to SystemCPEConfigParametersGetListRequest. + Contains a list of system CPE Config parameters. + Replaced By: SystemCPEConfigParametersGetResponse14sp6 + + + + + + + + + + + + + + + + + Request to get the list of Network Server Sync system parameters. + The response is either SystemNetworkServerSyncParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemNetworkServerSyncParametersGetListRequest. + Contains a list of system Network Server Sync parameters. + + + + + + + + + + + + + + + Requests a list of non-obsolete Identity/device profile types defined in the system. It is possible + to get either all conference device types or all non-conferernce types. This command is similar + to the SystemSIPDeviceTypeGetListRequest and SystemMGCPDeviceTypeGetListRequest + but gets both SIP and MGCP types. + The response is either SystemDeviceTypeGetlAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetAvailableListRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests a list of non-obsolete Identity/device profile types defined in the system. It is possible + to get either all conference device types or all non-conferernce types. This command is similar + to the SystemSIPDeviceTypeGetListRequest and SystemMGCPDeviceTypeGetListRequest + but gets both SIP and MGCP types. + The response is either SystemDeviceTypeGetlAvailableListResponse14sp1 or ErrorResponse. + Replaced By: SystemDeviceTypeGetAvailableListRequest14sp3 + + + + + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetAvailableListRequest14sp1. + Replaced By: SystemDeviceTypeGetAvailableListResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the information about the specified device type without regard to whether the + type is SIP or MGCP. + The response is either SystemDeviceTypeGetResponse or ErrorResponse. + Replaced By: SystemDeviceTypeGetRequest14sp3 + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetRequest. + Replaced By: SystemDeviceTypeGetResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + Requests the information about the specified device type without regard to whether the + type is SIP or MGCP. + The response is either SystemDeviceTypeGetResponse14sp3 or ErrorResponse. + Replaced By: SystemDeviceTypeGetRequest14sp6 + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetRequest14sp3. + Replaced By: SystemDeviceTypeGetResponse14sp6 + + + + + + + + + + + + + + + + + + + + + + + Get the utilization of a single DN. + The response is either SystemDnGetUtilizationResponse or ErrorResponse. + Replaced By: SystemDnGetUtilizationRequest14sp3 + + + + + + + + + + + + + + + Response to SystemDnGetUtilizationRequest. + Replaced By: SystemDnGetUtilizationResponse14sp3 + + + + + + + + + + + + + + + + + + + Add an entry to the external authentication access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete an entry from the external authentication access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Modify an entry from the external authentication access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Add an application to the OCI call control application list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of OCIReporting system parameters. + The response is either SystemOCIReportingParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemOCIReportingParametersGetListRequest. + Contains a list of system OCI Reporting parameters. + + + + + + + + + + + + + + + + + + Request to modify the system providers password rule + setting applicable to System Adminstrator, Provisioning Administrator, + and/or Service Provider Administrator, Group Administrator, Department Administrator, User. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemPasswordRulesModifyRequest14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse14 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest14. + Contains the default policy settings for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse14sp1 or ErrorResponse. + Replaced By: SystemPolicyGetDefaultRequest14sp4 + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest14sp1. + Contains the default policy settings for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the system's provisioning validation attributes. + The response is either a SystemProvisioningValidationGetResponse or and ErrorResponse. + + + + + + + + + + + + + Response to the SystemProvisioningValidationGetRequest. + + + + + + + + + + + + + + + Request the system level data associated with session audit. + The response is either a SystemSessionAuditGetResponse or an + ErrorResponse. + Replaced By: SystemSessionAuditGetRequest14sp3 + + + + + + + + + + + + + Response to SystemSessionAuditGetRequest. + Replaced By: SystemSessionAuditGetResponse14sp3 + + + + + + + + + + + + + + + + + Modify the system level data associated with session sudit. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: SystemSessionAuditModifyRequest14sp3 + + + + + + + + + + + + + + + + + Add an entry to the SIP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Delete an entry from the SIP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemSIPDeviceTypeAddRequest14sp2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemSIPDeviceTypeAddRequest14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + Replaced by: SystemSIPDeviceTypeAddRequest14sp6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + Replaced By : SystemSIPDeviceTypeAddRequest15 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse14sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest14sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse14sp2 or ErrorResponse. + Replaced By: SystemSIPDeviceTypeGetRequest14sp3 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest14sp2. + Replaced By: SystemSIPDeviceTypeGetResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse14sp6 or ErrorResponse. + Replaced By : SystemSIPDeviceTypeGetRequest15 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest14sp6. + Replaced by: SystemSIPDeviceTypeGetResponse14sp6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse14sp3 or ErrorResponse. + Replaced by: SystemSIPDeviceTypeGetRequest14sp6 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest14sp3. + Replaced by: SystemSIPDeviceTypeGetResponse14sp6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a sip device type. + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a sip device type. + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + isMobilityManagerDevice + The response is either SuccessResponse or ErrorResponse. + Replaced By : SystemSIPDeviceTypeModifyRequest15 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify an entry from the SIP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Add an entry to the SMDI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete an entry from the SMDI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Modify an entry from the SMDI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request the system level data associated with SMPP external interface. + The response is either a SystemSMPPGetResponse or an ErrorResponse. + Replaced By: SystemSMPPGetRequest14sp5 + + + + + + + + + + + + + Response to SystemSMPPGetRequest. + + + + + + + + + + + + + + + + + + + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse or an ErrorResponse. + Replaced By: SystemSubscriberGetCallProcessingParametersRequest14sp3 + + + + + + + + + + + + + Response to the SystemSubscriberGetCallProcessingParametersRequest. + Replaced By: SystemSubscriberGetCallProcessingParametersResponse14sp3 + + + + + + + + + + + + + + + + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse14sp3 or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemSubscriberGetCallProcessingParametersRequest14sp3. + + + + + + + + + + + + + + + + + + + Modify the system call processing configuration for all subscribers. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: SystemSubscriberModifyCallProcessingParametersRequest14sp7 + + + + + + + + + + + + + + + + + + + + Get the list of user creation tasks in the system. + The response is either SystemTrunkGroupUserCreationTaskGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemTrunkGroupUserCreationTaskGetListRequest. + Contains a table with a row for each user creation task and column headings : + "Service User Id", "Group Id", "Organization Id", "Organization Type", "Name", "Status", "Users Created", "Total Users To Create", "Error Count". + The "Organization Id" column is populated with either a service provider Id or an enterprise Id. + The "Organization Type" column is populated with one of the enumerated strings defined in the + OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType. + + + + + + + + + + + + + + + Requests the system voice portal passcode rules setting. + The response is either SystemVoiceMessagingGroupGetPasscodeRulesResponse14 or ErrorResponse. + Replaced By: SystemPortalPasscodeRulesGetRequest + + + + + + + + + + + + + Response to SystemVoiceMessagingGroupGetPasscodeRulesRequest14. + Contains the system voice portal passcode rules setting. + Replaced By: SystemPortalPasscodeRulesGetResponse + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the system voice portal passcode rules setting. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemPortalPasscodeRulesModifyRequest + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a user. + The domain is required in the userId. + The password is not required if external authentication is enabled. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request user's attendant console settings. + The response is either a UserAttendantConsoleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserAttendantConsoleGetRequest. + + + + + + + + + + + + + + + + + + Request user's call logs. + If the callLogType is not specified, all types of calls are returned. + The response is either a UserBasicCallLogsGetListResponse or an ErrorResponse. + Replaced By: UserBasicCallLogsGetListRequest14sp4 + + + + + + + + + + + + + + + + Response to UserBasicCallLogsGetListRequest. + Replaced By: UserBasicCallLogsGetListResponse14sp4 + + + + + + + + + + + + + + + + + Get the list of call centers the specified user belongs to. + The response is either a UserCallCenterGetListResponse or an ErrorResponse. + Replaced By: UserCallCenterGetRequest + + + + + + + + + + + + + + + Response to the UserCallCentersLoginGetListRequest. + Indicates whether the agent is current available (logged in) to each call center in the list. + Contains a table with column headings: "Service User Id", "Phone Number", "Extension", "Available", "Logoff Allowed". + ***** NOTE: Prior to release 14sp1, the AppServer had a bug that caused it to emit column heading "Service User ID" with + ***** the ID capitalized. Beginning in release 14sp1, the appserver is compliant with the schema and emits a + ***** the column heading "Service User Id". + Replaced By: UserCallCenterGetResponse + + + + + + + + + + + + + + + Request for an agent to login or logout of one or more Call Centers. + Contains a list specifing the desired login status of one or more call centers. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: UserCallCenterModifyRequest + + + + + + + + + + + + + + + + Clear a user's call logs associated with Basic Call Logs and Enhanced + Call Logs features. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: UserCallLogsClearRequest14sp4 + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse14 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest14. + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse14sp1 or an + ErrorResponse. + Replaced By: UserCallProcessingGetPolicyRequest14sp7 + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest14sp1. + Replaced By: UserCallProcessingGetPolicyResponse14sp7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the user level data associated with Call Procesing Policy. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: UserCallProcessingModifyPolicyRequest14sp7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Transfer. + The response is either a UserCallTransferGetResponse or an ErrorResponse. + Replaced By: UserCallTransferGetRequest14Sp4 + + + + + + + + + + + + + + + Response to UserCallTransferGetRequest. + + + + + + + + + + + + + + + + + + Request the user level data associated with Charge Number. + The response is either a UserChargeNumberGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserChargeNumberGetRequest. + + + + + + + + + + + + + + + Request the user level data associated with Directed Call Pickup With Barge In. + The response is either a UserDirectedCallPickupWithBargeInGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserDirectedCallPickupWithBargeInGetRequest. + + + + + + + + + + + + + + + Request user's call logs. It is possible to get a subset of the total list of calls + by specifying a starting offset and the number of calls to get. + If the callLogType is not specified, all types of calls are returned. + The response is either a UserEnhancedCallLogsGetListResponse or an ErrorResponse. + Replaced By: UserEnhancedCallLogsGetListRequest14sp4 + + + + + + + + + + + + + + + + + + Response to UserEnhancedCallLogsGetListRequest. + Replaced By: UserEnhancedCallLogsGetListResponse14sp4 + + + + + + + + + + + + + + + + + Request to get the user information. The response is either UserGetResponse14 + or ErrorResponse. + + + + + + + + + + + + + + + Response to UserGetRequest14. + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the user information. The response is either UserGetResponse14sp4 + or ErrorResponse. + + + + + + + + + + + + + + + Response to UserGetRequest14sp4. + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Hoteling Guest. + The response is either a UserHotelingGuestGetResponse14 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserHotelingGuestGetRequest14. + Replaced By: UserSharedCallAppearanceAddEndpointRequest14sp2 + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Hoteling Guest. + The response is either a UserHotelingGuestGetResponse14 or an ErrorResponse. + Replaced by: UserHotelingGuestGetRequest14sp4 + + + + + + + + + + + + + + + Response to UserHotelingGuestGetRequest14. + Replaced by: UserHotelingGuestGetResponse14sp4 + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Hoteling Host. + The response is either a UserHotelingHostGetResponse14 or an ErrorResponse. + Replaced by: UserHotelingHostGetRequest14sp4 + + + + + + + + + + + + + + + Response to UserHotelingHostGetRequest14. + Replaced by: UserHotelingHostGetResponse14sp4 + + + + + + + + + + + + + + + + + + + + + + + Request to modify a user. The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Associate an access device instance to the user's Shared Call Appearance. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the user level data associated with Privacy. + The response is either a UserPrivacyGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserPrivacyGetRequest. + + + + + + + + + + + + + + + Get the user's sequential ring service setting. + The response is either a UserSequentialRingGetResponse13mp16 or an ErrorResponse. + Replaced By: UserSequentialRingGetRequest14sp4 + + + + + + + + + + + + + + + Response to the UserSequentialRingGetRequest13mp16. The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule" and "Calls From". + Replaced By: UserSequentialRingGetResponse14sp4 + + + + + + + + + + + + + + + + + + + + + + + + Get the user's Shared Call Appearance service setting. + The response is either a UserSharedCallAppearanceGetResponse14 or an ErrorResponse. + Replaced By: UserSharedCallAppearanceGetRequest14sp2 + + + + + + + + + + + + + + + Response to the UserSharedCallAppearanceGetRequest14. + The endpointTable contains columns: + "Device Level", "Device Name", "Device Type", "Line/Port", "SIP Contact". + The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. + Replaced By: UserSharedCallAppearanceGetResponse14sp2 + + + + + + + + + + + + + + + + + + + + + Get the user's simultaneous ring service family setting. + The response is either a UserSimultaneousRingFamilyGetResponse or an ErrorResponse. + Replaced By: UserSimultaneousRingFamilyGetRequest14sp4 + + + + + + + + + + + + + + + Response to the UserSimultaneousRingFamilyGetRequest. + Replaced By: UserSimultaneousRingFamilyGetResponse14sp4 + + + + + + + + + + + + + + + + + Modify the user's simultaneous ring family service setting. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: UserSimultaneousRingFamilyModifyRequest14sp4 + + + + + + + + + + + + + + + + + + Get the user's simultaneous ring service personal setting. + The response is either a UserSimultaneousRingPersonalGetResponse or an ErrorResponse. + Replaced By: UserSimultaneousRingPersonalGetRequest14sp4 + + + + + + + + + + + + + + + Response to the UserSimultaneousRingPersonalGetRequest. + Replaced By: UserSimultaneousRingPersonalGetResponse14sp4 + + + + + + + + + + + + + + + + + Modify the user's simultaneous ring personal service setting. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: UserSimultaneousRingPersonalModifyRequest14sp4 + + + + + + + + + + + + + + + + + + Get the user's voice messaging advanced voice management service setting. + The response is either a UserVoiceMessagingUserGetAdvancedVoiceManagementResponse or an ErrorResponse. + Replaced By: UserVoiceMessagingUserGetAdvancedVoiceManagementRequest14sp3 + + + + + + + + + + + + + + + Response to the UserVoiceMessagingUserGetAdvancedVoiceManagementRequest. + Replaced By: UserVoiceMessagingUserGetAdvancedVoiceManagementResponse14sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user's voice portal password information. + The response is either a UserVoiceMessagingUserGetVoicePortalPasswordInfoResponse or an ErrorResponse. + Replaced By: UserPortalPasscodeGetInfoRequest + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetVoicePortalPasswordInfoRequest. + Replaced By: UserPortalPasscodeGetInfoResponse + + + + + + + + + + + + + + + + + + + + Modify the user's Voice Portal password + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + Replaced By: UserPortalPasscodeModifyRequest + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device profile basis. + The response is either GroupAccessDeviceFileGetListResponse or ErrorResponse. + Replaced By: GroupAccessDeviceFileGetListRequest14sp8 + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceFileGetListRequest. + Contains a table of device files managed by the Device Management System on a per-device profile basis. + The column headings are: "File Type", "File Format", "Is Authenticated". + Replaced By: GroupAccessDeviceFileGetListResponse14sp8 + + + + + + + + + + + + + + + Request to get a group device profile file. + The response is either GroupAccessDeviceFileGetResponse or ErrorResponse. + Replaced By: GroupAccessDeviceFileGetRequest14sp8 + + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceFileGetRequest. + Replaced By: GroupAccessDeviceFileGetResponse14sp8 + + + + + + + + + + + + + + + + Request to modify a specified group access device file. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: GroupAccessDeviceFileModifyRequest14sp8 + + + + + + + + + + + + + + + + + + + + Request to modify a specified device type file for a group. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: GroupDeviceTypeFileModifyRequest14sp8 + + + + + + + + + + + + + + + + + + + + Request to get the list of device type files managed by the Device Management System, on a per-group basis. + The response is either GroupDeviceTypeFileGetListResponse or ErrorResponse. + Replaced By: GroupDeviceTypeFileGetListRequest14sp8 + + + + + + + + + + + + + + + + + Response to GroupDeviceTypeFileGetListRequest. + Contains a table of device type files managed by the Device Management System, on a per-group basis. + The column headings are: "File Type", "File Format", "Is Authenticated". + Replaced By: GroupDeviceTypeFileGetListResponse14sp8 + + + + + + + + + + + + + + + Request to get a group device type file. + The response is either GroupDeviceTypeFileGetResponse or ErrorResponse. + Replaced By: GroupDeviceTypeFileGetRequest14sp8 + + + + + + + + + + + + + + + + + + Response to GroupDeviceTypeFileGetRequest. + Replaced By: GroupDeviceTypeFileGetResponse14sp8 + + + + + + + + + + + + + + + + Request to modify a specified service provider/enterprise access device file. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: ServiceProviderAccessDeviceFileModifyRequest14sp8 + + + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device profile basis. + The response is either ServiceProviderAccessDeviceFileGetListResponse or ErrorResponse. + Replaced By: ServiceProviderAccessDeviceFileGetListRequest14sp8 + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceFileGetListRequest. + Contains a table of device files managed by the Device Management System on a per-device profile basis. + The column headings are: "File Type", "File Format", "Is Authenticated". + Replaced By: ServiceProviderAccessDeviceFileGetListResponse14sp8 + + + + + + + + + + + + + + + Request to get a service provider device profile file. + The response is either ServiceProviderAccessDeviceFileGetResponse or ErrorResponse. + Replaced By: ServiceProviderAccessDeviceFileGetRequest14sp8 + + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceFileGetRequest. + Replaced By: ServiceProviderAccessDeviceFileGetResponse14sp8 + + + + + + + + + + + + + + + + Request to modify a specified system access device file. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: SystemAccessDeviceFileModifyRequest14sp8 + + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device profile basis. + The response is either SystemAccessDeviceFileGetListResponse or ErrorResponse. + Replaced By: SystemAccessDeviceFileGetListRequest14sp8 + + + + + + + + + + + + + + + Response to SystemAccessDeviceFileGetListRequest. + Contains a table of device files managed by the Device Management System on a per-device profile basis. + The column headings are: "File Type", "File Format", "Is Authenticated". + Replaced By: SystemAccessDeviceFileGetListResponse14sp8 + + + + + + + + + + + + + + + Request to get a device profile file. + The response is either SystemAccessDeviceFileGetResponse or ErrorResponse. + Replaced By: SystemAccessDeviceFileGetRequest14sp8 + + + + + + + + + + + + + + + + Response to SystemAccessDeviceFileGetRequest. + Replaced By: SystemAccessDeviceFileGetResponse14sp8 + + + + + + + + + + + + + + + + Request to add a sip device type file. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemSIPDeviceTypeFileAddRequest14sp8 + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to delete a sip device type file. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemSIPDeviceTypeFileDeleteRequest14sp8 + + + + + + + + + + + + + + + + Request to modify a sip device type file. + The response is either SuccessResponse or ErrorResponse. + Replaced By: SystemSIPDeviceTypeFileModifyRequest14sp8 + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device type basis. + The response is either SystemSIPDeviceTypeFileGetListResponse or ErrorResponse. + Replaced By: SystemSIPDeviceTypeFileGetListRequest14sp8 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeFileGetListRequest. + Contains a table of device files managed by the Device Management System on a per-device type basis. + The column headings are: "File Type", "File Format", "Is Authenticated". + Replaced By: SystemSIPDeviceTypeFileGetListResponse14sp8 + + + + + + + + + + + + + + + Request to get a sip device type file. + The response is either SystemSIPDeviceTypeFileGetResponse or ErrorResponse. + Replaced By: SystemSIPDeviceTypeFileGetRequest14sp8 + + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeFileGetRequest. + Replaced By: SystemSIPDeviceTypeFileGetResponse14sp8 + + + + + + + + + + + + + + + + + + + + + + + + + Maximum retry originator minutes. + + + + + + + + + + + + Wait between retry originator minutes. + + + + + + + + + + + + Call Log entry describing a placed, received, or missed call. + Replaced By: CallLogsEntry + + + + + + + + + + + + + + Calling Name. + Replaced By: CallLogsEntryName + + + + + + + + + + + + Call Log type. + Replaced By: CallLogsType + + + + + + + + + + + + + Contains Call Center statistics for a specified agent. + + + + + + + + + + + + + + + Contains Call Center Agent statistics for one day. + + + + + + + + + + + + + + + + Contains Call Center Queue statistics. + + + + + + + + + + + + + + + + + + + Call Log entry describing a placed, received, or missed call. + Replaced By: CallLogsEntry + + + + + + + + + + + + + + Calling Name. + Replaced By: CallLogsEntryName + + + + + + + + + + + + Call Log type. + Replaced By: CallLogsType + + + + + + + + + + + + + Sequential Ring Location. + Replaced By: SequentialRingLocation14sp4 + + + + + + + + + + + + Service Profile Information for a trunk group used when modifying an existing service instance. + + + + + + + + + + + + + + + + + + + + + + Maximum allowed failed login attempts. + + + + + + + + + + + + Trunk group device endpoint. + + + + + + + + + + + + + + + + Maximum length of voice messaging passcode. + + + + + + + + + + + + Minimum length of voice messaging passcode. + + + + + + + + + + + + Passcode expiration days. + + + + + + + + + + + + CPE device's options. + Replaced by: CPEDeviceOptions14sp6 + + + + + + + + + + + + + + + A file type (file key) for an access device file managed by the Device Management System on BroadWorks. + + + + + + + + + + + + Extension range. The minimum and maximum values are inclusive. + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDeprecated15.xsd b/share/OCISchemaAS/OCISchemaDeprecated15.xsd new file mode 100644 index 0000000..bc3bd03 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDeprecated15.xsd @@ -0,0 +1,4548 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified group access device. + The response is either GroupAccessDeviceGetResponse14sp6 or ErrorResponse. + Replaced by: GroupAccessDeviceGetRequest16 + + + + + + + + + + + + + + + + + Response to: GroupAccessDeviceGetRequest14sp6 + Replaced by: GroupAccessDeviceGetResponse16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Auto Attendant instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupAutoAttendantAddInstanceRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Auto Attendant instance. + The response is either GroupAutoAttendantGetInstanceResponse or ErrorResponse. + Replaced By: GroupAutoAttendantGetInstanceRequest16 + + + + + + + + + + + + + + + Response to GroupAutoAttendantGetInstanceRequest14. + Contains the service profile information. + Replaced By: GroupAutoAttendantGetInstanceResponse16 + + + + + + + + + + + + + + + + + + + + + + + Request to modify an Auto Attendant instance. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupAutoAttendantModifyInstanceRequest16 + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + Replaced By: GroupCallCenterAddInstanceRequest16, + GroupCallCenterAddAgentListRequest, + GroupCallCenterModifyPolicyRequest, + GroupCallCenterModifyAnnouncementRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's announcement settings. + The response is either a GroupCallCenterGetAnnouncementResponse14sp6 or an ErrorResponse. + + Replaced By: GroupCallCenterGetAnnouncementRequest16 + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAnnouncementRequest14sp6. + + + + + + + + + + + + + + + + + + + + + + + Get a list of users that can be assigned to a Call Center group. + Searching for users by group only makes sense when the call center is part of an Enterprise. + The response is either GroupCallCenterGetAvailableUserListResponse or ErrorResponse. + + Replaced By: GroupCallCenterGetAvailableAgentListRequest + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse14sp9 or ErrorResponse. + + Replaced By: GroupCallCenterGetInstanceRequest16 + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceRequest14sp9. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the call center statistics reporting settings. + The response is either GroupCallCenterGetInstanceStatisticsReportingResponse or ErrorResponse. + + Replaced By: GroupCallCenterGetInstanceStatisticsReportingRequest16 + + + + + + + + + + + + + + + Contains Call Center statistics reporting settings. + + + + + + + + + + + + + + + + + + Request to get the Call Center Enhanced configuration data for a + Call Center. + The response is either GroupCallCenterEnhancedGetResponse or + ErrorResponse. + + Replaced By: GroupCallCenterGetInstanceResponse16 + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedGetRequest. + + + + + + + + + + + + + + + + Modify the Call Center Enhanced configuration data for a Call + Center. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced By: GroupCallCenterModifyInstanceRequest16 + + + + + + + + + + + + + + + + + Modify a call center's announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced By: GroupCallCenterModifyAnnouncementRequest16 + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify a Call Center instance. + The response is either SuccessResponse or ErrorResponse. + + Replaced By: GroupCallCenterModifyInstanceRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of supervisors assigned to a call center. + Only users in the same group or enterprise as this call center + can successfully execute this request. + The response is either a + GroupCallCenterSupervisorReportingGetResponse or an + ErrorResponse. + + Replaced By: GroupCallCenterGetSupervisorListRequest16 + + + + + + + + + + + + + + + Response to the GroupCallCenterSupervisorReportingGetRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + Replaces a list of users as supervisors for a call center. + Also allows the modification of the reporting server URL address. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced By: GroupCallCenterModifySupervisorListRequest16 + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse15 or an + ErrorResponse. + Replaced By: GroupCallProcessingGetPolicyRequest16 + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest15. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group level data associated with Call Procesing Policy. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: GroupCallProcessingModifyPolicyRequest15sp2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse14sp7 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + Replaced By: GroupCallProcessingGetPolicyRequest16 + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest14sp7. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse15sp2 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, + maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, + useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, + useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, + overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest15sp2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group level data associated with Call Procesing Policy. + The response is either a SuccessResponse or an ErrorResponse. + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and + translation settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + Replaced By: GroupCallProcessingModifyPolicyRequest15sp2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the group's custom ring back service settings. + The response is either a GroupCustomRingbackGroupGetResponse or an ErrorResponse. + Replaced By: GroupCustomRingbackGroupGetRequest16 + + + + + + + + + + + + + + + + Response to the GroupCustomRingbackGroupGetRequest. + Replaced By: GroupCustomRingbackGroupGetResponse16 + + + + + + + + + + + + + + + + + + + + + Modify the group's custom ring back service settings. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: GroupCustomRingbackGroupModifyRequest16 + + + + + + + + + + + + + + + + + + + + + Get the group's intercept group service settings. + The response is either a GroupInterceptGroupGetResponse or an ErrorResponse. + Replaced By: GroupInterceptGroupGetRequest16 + + + + + + + + + + + + + + + + Response to the GroupInterceptGroupGetRequest. + Replaced By: GroupInterceptGroupGetResponse16 + + + + + + + + + + + + + + + + + + + + + + Get the group's intercept group service settings. + The response is either a GroupInterceptGroupGetResponse16 or an ErrorResponse. + Replaced By: GroupInterceptGroupGetRequest16sp1 + + + + + + + + + + + + + + + + Response to the GroupInterceptGroupGetRequest16. + Replaced By: GroupInterceptGroupGetResponse16sp1 + + + + + + + + + + + + + + + + + + + + + + + + Modify the group's intercept group service settings. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: GroupInterceptGroupModifyRequest16 + + + + + + + + + + + + + + + + + + + + + + + + Add a Music on Hold Instance to a department. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupMusicOnHoldAddInstanceRequest16 + + + + + + + + + + + + + + + + + + + + + + + Get a Music On Hold data for a group or department instance. + The response is either GroupMusicOnHoldGetInstanceResponse14sp6 or ErrorResponse. + Replaced By: GroupMusicOnHoldGetInstanceRequest16 + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetInstanceRequest14sp6. + Replaced By: GroupMusicOnHoldGetInstanceResponse16 + + + + + + + + + + + + + + + + + + + + + + Modify data for a group or department Music On Hold Instance. + The response is either SuccessResponse or ErrorResponse. + Replaced By: GroupMusicOnHoldModifyInstanceRequest16 + + + + + + + + + + + + + + + + + + + + + + + Requests the group's password rules setting that is applicable to + users within the group. + The response is either GroupPasswordRulesGetResponse or ErrorResponse. + Repleced by: GroupPasswordRulesGetRequest16 + + + + + + + + + + + + + + + + Response to GroupPasswordRulesGetRequest. + Contains the password rules applicable to users within the group. + Repleced by: GroupPasswordRulesGetResponse16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse15 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest15. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the group's voice portal branding settings. + The response is either a GroupVoiceMessagingGroupGetVoicePortalBrandingResponse or an ErrorResponse. + Replaced By: GroupVoiceMessagingGroupGetVoicePortalBrandingRequest16 + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalBrandingRequest. + Replaced By: GroupVoiceMessagingGroupGetVoicePortalBrandingResponse16 + + + + + + + + + + + + + + + + + + Modify the group's voice portal branding settings. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest16 + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified service provider access device. + The response is either ServiceProviderAccessDeviceGetResponse14sp6 or ErrorResponse. + Replaced by: ServiceProviderAccessDeviceGetRequest16 + + + + + + + + + + + + + + + + Response to: ServiceProviderAccessDeviceGetRequest14sp6 + Replaced by: ServiceProviderAccessDeviceGetRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a service provider or enterprise's answer confirmation settings. + The response is either a ServiceProviderAnswerConfirmationGetResponse or an ErrorResponse. + Replaced By: ServiceProviderAnswerConfirmationGetRequest16 + + + + + + + + + + + + + + + Response to the ServiceProviderAnswerConfirmationGetRequest. + Replaced By: ServiceProviderAnswerConfirmationGetResponse16 + + + + + + + + + + + + + + + + + Modify a service provider or enterprise's answer confirmation settings. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: ServiceProviderAnswerConfirmationModifyRequest16 + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse14sp7 or an ErrorResponse. + + Replaced By: ServiceProviderCallProcessingGetPolicyRequest16 + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest14sp7. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse15 or an ErrorResponse. + + Replaced By: ServiceProviderCallProcessingGetPolicyRequest16 + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest15. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse15sp2 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest15sp2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider's password rules setting applicable to + Administrators (Group and Department) and Users. + The response is either ServiceProviderPasswordRulesGetResponse13mp2 or ErrorResponse. + Replaced By: ServiceProviderPasswordRulesGetRequest16 + + + + + + + + + + + + + + + Response to ServiceProviderPasswordRulesGetRequest13mp2. + Contains the group, department administrator and/or user password + rules setting. + Replaced By: ServiceProviderPasswordRulesGetResponse16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the service provider's voice portal branding settings. + The response is either a ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingResponse or an ErrorResponse. + Replaced By: ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingRequest16 + + + + + + + + + + + + + + + Response to the ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingRequest. + Replaced By: ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingResponse16 + + + + + + + + + + + + + + + + + + Modify the service provider's voice portal branding settings. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: ServiceProviderVoiceMessagingGroupModifyVoicePortalBrandingRequest16 + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified system access device. + The response is either SystemAccessDeviceGetResponse14sp6 or ErrorResponse. + Replaced by: SystemAccessDeviceGetRequest16 + + + + + + + + + + + + + + + Response to: SystemAccessDeviceGetRequest14sp6 + Replaced by: SystemAccessDeviceGetRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system's automatic callback attributes. + The response is either a SystemAutomaticCallbackGetResponse15 or an ErrorResponse. + + Replaced By: SystemAutomaticCallbackGetRequest15sp2 + + + + + + + + + + + + + Response to SystemAutomaticCallbackGetRequest15. + + Replaced By: SystemAutomaticCallbackGetResponse15sp2 + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Center. + The response is either a SystemCallCenterGetResponse14sp9 or an + ErrorResponse. + + Replaced By: SystemCallCenterGetRequest16 + + + + + + + + + + + + + Response to SystemCallCenterGetRequest14sp9. + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse14sp7 or an + ErrorResponse. + Replaced By: SystemCallProcessingGetPolicyRequest16 + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest14sp7. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse15 or an + ErrorResponse. + + Replaced By: SystemCallProcessingGetPolicyRequest16 + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest15. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse15sp2 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest15sp2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a SystemCommunicationBarringProfileGetResponse + or an ErrorResponse. + Replaced by: SystemCommunicationBarringProfileGetRequest16 + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetRequest. + The response contains the Communication Barring Profile information. + Replaced by: SystemCommunicationBarringProfileGetResponse16 + + + + + + + + + + + + + + + + + + + + + Get all the attributes of a configurable treatment. + The response is either a SystemConfigurableTreatmentGetResponse or an ErrorResponse. + Replaced By: SystemConfigurableTreatmentGetRequest16 + + + + + + + + + + + + + + + Response to the SystemConfigurableTreatmentGetRequest. + The response contains the treatment configurable information. + Replaced By: SystemConfigurableTreatmentGetResponse16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the information about the specified device type without regard to whether the + type is SIP or MGCP. + The response is either SystemDeviceTypeGetResponse14sp6 or ErrorResponse. + Replaced by: SystemDeviceTypeGetRequest16 + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetRequest14sp6. + Replaced by: SystemDeviceTypeGetResponse16 + + + + + + + + + + + + + + + + + + + + + + + Add a new file repository. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Request to get the file repository information. + The response is either SystemFileRepositoryDeviceGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemFileRepositoryDeviceGetRequest. + + + + + + + + + + + + + + + + + + + + Request to add a Media to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to get the list of Network Server Sync system parameters. + The response is either SystemNetworkServerSyncParametersGetResponse14sp2 or ErrorResponse. + Replaced By: SystemNetworkServerSyncParametersGetRequest16 + + + + + + + + + + + + + Response to SystemNetworkServerSyncParametersGetRequest14sp2. + Contains a list of system Network Server Sync parameters. + Replaced By: SystemNetworkServerSyncParametersGetResponse16 + + + + + + + + + + + + + + + + Requests the system's password rules setting applicable to + System administrator, Provisioning Administrator, + and/or Service Provider Administrator, Group Administrator, Department Administrator, user. + The response is either SystemPasswordRulesGetResponse13mp2 or ErrorResponse. + Replaced By : SystemPasswordRulesGetRequest16 + + + + + + + + + + + + + Response to SystemPasswordRulesGetRequest13mp2. + Contains the password rules for System administrator, Provisioning Administrator, + and/or Service Provider Administrator, Group Administrator, Department Administrator, user. + Replaced By : SystemPasswordRulesGetResponse16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + Replaced By : SystemSIPDeviceTypeAddRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse15 or ErrorResponse. + Replaced By : SystemSIPDeviceTypeGetRequest16 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest15. + Replaced By : SystemSIPDeviceTypeAddResponse16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a sip device type. + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + isMobilityManagerDevice + The response is either SuccessResponse or ErrorResponse. + Replaced By : SystemSIPDeviceTypeModifyRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse14sp7 or an ErrorResponse. + Replaced By : SystemSubscriberGetCallProcessingParametersRequest15sp2 + + + + + + + + + + + + + Response to the SystemSubscriberGetCallProcessingParametersRequest14sp7. + + + + + + + + + + + + + + + + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse15 or an ErrorResponse. + Replaced By: SystemSubscriberGetCallProcessingParametersRequest15sp2 + + + + + + + + + + + + + Response to the SystemSubscriberGetCallProcessingParametersRequest15. + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Voice Messaging. + The response is either a SystemVoiceMessagingGroupGetResponse14 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemVoiceMessagingGroupGetRequest14. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with Voice Messaging. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's BroadWorks Anywhere phone number. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Get a criteria for the user's BroadWorks Anywhere phone number. + The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to the UserBroadWorksAnywhereGetSelectiveCriteriaRequest. + + + + + + + + + + + + + + + + Get the user's ACD state and the list of call centers the specified user belongs to. + The response is either a UserCallCenterGetResponse or an ErrorResponse. + + Replaced By: UserCallCenterGetRequest16 + + + + + + + + + + + + + + + Response to the UserCallCenterGetRequest. + Contains the user's ACD state + Indicates whether the agent is current available (logged in) to each call center in the list. + Contains a table with column headings: "Service User Id", "Phone Number", "Extension", "Available", "Logoff Allowed". + + + + + + + + + + + + + + + + Add a criteria to the user's call forwarding selective service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Get a criteria for the user's call forwarding selective service. + The response is either a UserCallForwardingSelectiveGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserCallForwardingSelectiveGetCriteriaRequest. + + + + + + + + + + + + + + + + + + Get the user's call forwarding selective service setting. + The response is either a UserCallForwardingSelectiveGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallForwardingSelectiveGetRequest. The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule", "Calls From" and "Forward To". + + + + + + + + + + + + + + + + + Request the user level data associated with Calling Party Category. + The response is either a UserCallingPartyCategoryGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallingPartyCategoryGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Calling Party Category. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a criteria to the user's call notify service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a criteria for the user's call notify service. + The response is either a UserCallNotifyGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserCallNotifyGetCriteriaRequest. + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse14sp7 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest14sp7. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's custom ringback service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Get a criteria for the user's custom ringback service. + The response is either a UserCustomRingbackUserGetCriteriaResponse or an ErrorResponse. + Replaced By: UserCustomRingbackUserGetCriteriaRequest15Sp2 + + + + + + + + + + + + + + + + Response to the UserCustomRingbackUserGetCriteriaRequest. + + + + + + + + + + + + + + + + + + + + + + Get a criteria for the user's custom ringback service. + The response is either a UserCustomRingbackUserGetCriteriaResponse15sp2 or an ErrorResponse. + Replaced By: UserCustomRingbackUserGetCriteriaRequest16 + + + + + + + + + + + + + + + + Response to the UserCustomRingbackUserGetCriteriaRequest15sp2. + Replaced By: UserCustomRingbackUserAddCriteriaResponse16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a criteria for the user's custom ringback service. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: UserCustomRingbackUserModifyCriteriaRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + Request user's call logs. It is possible to get a subset of the total list of calls + by specifying a starting offset and the number of calls to get. + If the callLogType is not specified, all types of calls are returned. + The response is either a UserEnhancedCallLogsGetListResponse14sp4 or an ErrorResponse. + Replaced by: + UserEnhancedCallLogsGetListRequest16 + + + + + + + + + + + + + + + + + + Response to UserEnhancedCallLogsGetListRequest14sp4. + Replaced by: UserEnhancedCallLogsGetListResponse16 + + + + + + + + + + + + + + + + + Request to get the user information. The response is either UserGetResponse14sp4 + or ErrorResponse. + + + + + + + + + + + + + + + Response to UserGetRequest14sp9. + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's intercept user service settings. + The response is either a UserInterceptUserGetResponse or an ErrorResponse. + Replaced By: UserInterceptUserGetRequest16 + + + + + + + + + + + + + + + Response to the UserInterceptUserGetRequest. + Replaced By: UserInterceptUserGetResponse16 + + + + + + + + + + + + + + + + + + + + + + Get the user's intercept user service settings. + The response is either a UserInterceptUserGetResponse16 or an ErrorResponse. + Replaced By: UserInterceptUserGetRequest16sp1 + + + + + + + + + + + + + + + Response to the UserInterceptUserGetRequest16. + Replaced By: UserInterceptUserGetResponse16sp1 + + + + + + + + + + + + + + + + + + + + + + + + Modify the user's intercept user service settings. + The response is either a SuccessResponse or an ErrorResponse. + Replaced By: UserInterceptUserModifyRequest16 + + + + + + + + + + + + + + + + + + + + + + + Request to modify a user. The response is either + SuccessResponse or ErrorResponse. + Replaced by: UserModifyRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Music On Hold User. + The response is either a UserMusicOnHoldUserGetResponse or an + ErrorResponse. + Replaced By: UserMusicOnHoldUserGetRequest16 + + + + + + + + + + + + + + + Response to UserMusicOnHoldUserGetRequest. + Replaced By: UserMusicOnHoldUserGetResponse16 + + + + + + + + + + + + + + + + + + Modify data for Music On Hold User. + The response is either a SuccessResponse or an + ErrorResponse. + Replaced By: UserMusicOnHoldUserModifyRequest16 + + + + + + + + + + + + + + + + + + Add a criteria to the user's priority alert service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a criteria for the user's priority alert service. + The response is either a UserPriorityAlertGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserPriorityAlertGetCriteriaRequest. + + + + + + + + + + + + + + + + Add a criteria to the user's selective call acceptance service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a criteria for the user's selective call acceptance service. + The response is either a UserSelectiveCallAcceptanceGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSelectiveCallAcceptanceGetCriteriaRequest. + + + + + + + + + + + + + + + + Add a criteria to the user's selective call rejection service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a criteria for the user's selective call rejection service. + The response is either a UserSelectiveCallRejectionGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSelectiveCallRejectionGetCriteriaRequest. + + + + + + + + + + + + + + + + Modify a criteria for the user's selective call rejection service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's sequential ring service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a criteria for the user's sequential ring service. + The response is either a UserSequentialRingGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSequentialRingGetCriteriaRequest. + + + + + + + + + + + + + + + + Get the user's voice messaging greeting information. + The response is either a UserVoiceMessagingUserGetGreetingResponse13mp16 or an ErrorResponse. + Replaced By: UserVoiceMessagingUserGetGreetingRequest16 + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetGreetingRequest13mp16. + Contains the greeting configuration for a user's voice messaging. + Replaced By: UserVoiceMessagingUserGetGreetingResponse16 + + + + + + + + + + + + + + + + + + + + + + + + Get the user's voice messaging voice portal settings. + The response is either a UserVoiceMessagingUserGetVoicePortalResponse or an ErrorResponse. + Replaced By: UserVoiceMessagingUserGetVoicePortalRequest16 + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetVoicePortalRequest. + Replaced By: UserVoiceMessagingUserGetVoicePortalResponse16 + + + + + + + + + + + + + + + + + Modify the user's voice messaging greeting. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + Replaced By: UserVoiceMessagingUserModifyGreetingRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + Modify the user's voice messaging voice portal settings. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + Replaced By: UserVoiceMessagingUserModifyVoicePortalRequest16 + + + + + + + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during after business hours. + + + + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during business hours. + It is used when modifying an Auto Attendant group. + + + + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during after business hours. + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + Communication Barring Redirecting Rule + + + + + + + + + + + + Calling Party Category Selection + + + + + + + + + + + + + + + + Maximum Call Time for Answered Calls + + + + + + + + + + + + Possible originating actions for Communication Barring. + + + + + + + + + + + + + + + Communication Barring Originating Rule + + + + + + + + + + + + + + Possible redirecting actions for Communication Barring. + + + + + + + + + + + + Communication Barring Redirecting Rule + + + + + + + + + + + + CPE device's options. + + + + + + + + + + + + + + + + CPE device's options when used with a modify request. + The following options are not changeable: + configType + systemFileName + deviceFileFormat + + + + + + + + + + + + + Device Management System device type options during a modify request. + + + + + + + + + + + + + + + + + + + + + + + + + + + CPE device's options. + + + + + + + + + + + + + + + + Protocols that an access device can use to fetch files from BroadWorks. + + + + + + + + + + + + + Device Management System device type options. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Device Management System device type options. + + + + + + + + + + + + + + + + + + + + + + + + + + + + A user name for an access device accessing files on BroadWorks. + + + + + + + + + + + + Access device credentials. + + + + + + + + + + + + A user password for an access device accessing files on BroadWorks. + + + + + + + + + + + + The offset into the list of calls in the call log. + + + + + + + + + + + + Attributes of the FTP protocol when the file repository interface is using FTP. + + + + + + + + + + + + Possible values for the protocol-neutral internal release cause. + Replaced By: InternalReleaseCause16 + + + + + + + + + + + + + + + + + + + + + Media types. + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold user source configuration. + + + + + + + + + + + + + + + + + + + + Contains the music on hold user source configuration. + + + + + + + + + + + + + + + + + + + + The configuration of a alternate no answer greeting. + It is used when modifying a user's voice messaging greeting. + + + + + + + + + + + + + The configuration of a alternate no answer greeting. + It is used when geting a user's voice messaging greeting. + + + + + + + + + + + + + Maximum length of voice messaging greeting in minutes. + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDeprecated16.xsd b/share/OCISchemaAS/OCISchemaDeprecated16.xsd new file mode 100644 index 0000000..ddad210 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDeprecated16.xsd @@ -0,0 +1,5915 @@ + + + + + + + + + + + + + + + + + + + + + + The limit for the number of calls the system will keep in queue, waiting for an available agent. + + + + + + + + + + + + + + + + + + Get the address and credentials of the File Repository hosting the requested access device file. Also get the file name and path on the File Repository. The response is either a DeviceManagementFileAuthLocationGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Return the address and credentials of the File Repository hosting the requested access device file. Also return the file name and path on the File Repository. This is a response to DeviceManagementFileAuthLocationGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request a table containing the phone directory for an enterprise. + The directory includes all users in the enterprise and all entries in the enterprise common phone list. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either EnterprisePhoneDirectoryGetListResponse or ErrorResponse. + + Replace by: EnterprisePhoneDirectoryGetListRequest17 + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterprisePhoneDirectoryGetListRequest. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", "Department", "Hiragana Name", "Group Id", "Yahoo Id". + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "User Id", "Pager", "Title", "Time Zone", "Location", "Address Line 1", "Address Line 2", + "City", "State", "Zip", "Country". + + Replace by: EnterprisePhoneDirectoryGetListResponse17 + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse14sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest14sp1. + Contains the policy settings for the group administrator. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + Replaced by: GroupCallCenterAddInstanceRequest17 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's bounced call settings. + The response is either a GroupCallCenterBouncedCallGetResponse or an ErrorResponse. + + Replaced by: GroupCallCenterBouncedCallGetRequest17 + + + + + + + + + + + + + + + Response to the GroupCallCenterBouncedCallGetRequest. + + + + + + + + + + + + + + + + + + + Get a call center's comfort message bypass settings. + The response is either a GroupCallCenterComfortMessageBypassGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterComfortMessageBypassGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's comfort message bypass settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Get a call center's forced forwarding settings. + The response is either a GroupCallCenterForcedForwardingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterForcedForwardingGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's forced forwarding settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Get a call center's announcement settings. + The response is either a GroupCallCenterGetAnnouncementResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAnnouncementRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's holiday service settings. + The response is either a GroupCallCenterHolidayServiceGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterHolidayServiceGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's holiday service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's night service settings. + The response is either a GroupCallCenterNightServiceGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterNightServiceGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's night service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's overflow settings. + The response is either a GroupCallCenterOverflowGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterOverflowGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's overflow settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's stranded call settings. + The response is either a GroupCallCenterStrandedCallGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterStrandedCallGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's stranded call settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Adds a Custom Contact Directory to a group. + The response is either SuccessResponse or ErrorResponse. + + Replace by: GroupCustomContactDirectoryAddRequest17 + + + + + + + + + + + + + + + + + + Get a list of users that can be part of a custom contact directory. + The response is either GroupCustomContactDirectoryGetAvailableUserListResponse or ErrorResponse. + + Replace by: GroupCustomContactDirectoryGetAvailableUserListRequest17 + + + + + + + + + + + + + + + + + + + + + Response to the GroupCustomContactDirectoryGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name". + + Replace by: GroupCustomContactDirectoryGetAvailableUserListResponse17 + + + + + + + + + + + + + + + Gets a Custom Contact Directory in a group. + The response is either GroupCustomContactDirectoryGetResponse or ErrorResponse. + + Replace by: GroupCustomContactDirectoryGetRequest17 + + + + + + + + + + + + + + + + + Response to the GroupCustomContactDirectoryGetRequest. + The response contains all the group's custom contact directory names. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". + + Replace by: GroupCustomContactDirectoryGetResponse17 + + + + + + + + + + + + + + + Adds a Custom Contact Directory to a group. + The response is either SuccessResponse or ErrorResponse. + + Replace by: GroupCustomContactDirectoryModifyRequest17 + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse16 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse16sp2 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + The useGroupDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) + + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest16sp2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a holiday schedule to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a holiday schedule from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a holiday schedule in a group. + The response is either a GroupHolidayScheduleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupHolidayScheduleGetRequest. + The response contains the group's holiday schedule information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a holiday schedule in a group. + The response is either a GroupHolidayScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupHolidayScheduleGetListRequest. + The response contains all the group's holiday schedule name. + + + + + + + + + + + + + + + Modify a holiday schedule in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group's policy settings. + The response is either GroupPolicyGetResponse14sp4 or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPolicyGetRequest14sp4. + Contains the policy settings for the group. + + + + + + + + + + + + + + + + + + + + + + + + Request a table containing the phone directory for a group. + If the specified group is part of an enterprise, the directory includes all users in the enterprise + and all entries in the enterprise common phone list and the common phone list of the specified group. + If the specified group is part of a service provider, the directory includes all users in the group + and all entries in the common phone list of the specified group. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either GroupPhoneDirectoryGetListResponse or ErrorResponse. + + Replace by: GroupPhoneDirectoryGetListRequest17 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupPhoneDirectoryGetListRequest. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", "Department", "Hiragana Name", "Group Id", "Yahoo Id". + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "User Id", "Pager", "Title", "Time Zone", "Location", "Address Line 1", "Address Line 2", + "City", "State", "Zip", "Country". + + Replace by: GroupPhoneDirectoryGetListResponse17 + + + + + + + + + + + + + + + Add a time schedule to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a time schedule from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request a list of all time schedules in a group. + The response is either a GroupTimeScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupTimeScheduleGetListRequest. + The response contains all the group's time schedule name. + + + + + + + + + + + + + + + Request to get a group time schedule. + The response is either a GroupTimeScheduleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupTimeScheduleGetRequest. + The response contains the group's time schedule information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a specified time schedule in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse15sp2 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest15sp2. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the group voice portal information for a voice messaging group. + The response is either GroupVoiceMessagingGroupGetVoicePortalResponse15 or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalRequest15. + + + + + + + + + + + + + + + + + + + + + + + Request to get a group device profile file. + The response is either GroupAccessDeviceFileGetResponse14sp8 or ErrorResponse. + Replaced by: GroupAccessDeviceFileGetRequest16sp1 + + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceFileGetRequest14sp8. + Replaced by: GroupAccessDeviceFileGetResponse16sp1 + + + + + + + + + + + + + + + + Request to get a group device type file. + The response is either GroupDeviceTypeFileGetResponse14sp8 or ErrorResponse. + Replaced by: GroupDeviceTypeFileGetRequest16sp1 + + + + + + + + + + + + + + + + + + Response to GroupDeviceTypeFileGetRequest14sp8. + Replaced by: GroupDeviceTypeFileGetResponse16sp1 + + + + + + + + + + + + + + + + Request the Group level data associated with Dial Plan Policy. + The response is either a GroupDialPlanPolicyGetResponse or an ErrorResponse. + + Replaced by: GroupDialPlanPolicyGetRequest17 + + + + + + + + + + + + + + + + Response to GroupDialPlanPolicyGetRequest + + Replaced by: GroupDialPlanPolicyGetResponse17 + + + + + + + + + + + + + + + + + + + Request to get a service provider device profile file. + The response is either ServiceProviderAccessDeviceFileGetResponse14sp8 or ErrorResponse. + Replaced by: ServiceProviderAccessDeviceFileGetRequest16sp1 + + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceFileGetRequest14sp8. + Replaced by: ServiceProviderAccessDeviceFileGetResponse16sp1 + + + + + + + + + + + + + + + + Request the Service Provider level data associated with Dial Plan Policy. + The response is either a ServiceProviderDialPlanPolicyGetResponse + or an ErrorResponse. + + Replaced by: ServiceProviderDialPlanPolicyGetRequest17 + + + + + + + + + + + + + + + Response to ServiceProviderDialPlanPolicyGetRequest + + Replaced by: ServiceProviderDialPlanPolicyGetResponse17 + + + + + + + + + + + + + + + + + + Request the service provider's DTMF based in-call service activation trigger attributes.The response is either a ServiceProviderInCallServiceActivationGetResponse or an ErrorResponse. + + Replaced by: ServiceProviderInCallServiceActivationGetRequest17 + + + + + + + + + + + + + + + Response to ServiceProviderInCallServiceActivationGetRequest. + + Replaced by: ServiceProviderInCallServiceActivationGetResponse17 + + + + + + + + + + + + + + + Modifies the service provider's DTMF based in-call service activation trigger attributes.The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: ServiceProviderInCallServiceActivationModifyRequest17 + + + + + + + + + + + + + + + + Request to get a device profile file. + The response is either SystemAccessDeviceFileGetResponse14sp8 or ErrorResponse. + Replaced by: SystemAccessDeviceFileGetRequest16sp1 + + + + + + + + + + + + + + + + Response to SystemAccessDeviceFileGetRequest14sp8. + Replaced by: SystemAccessDeviceFileGetResponse16sp1 + + + + + + + + + + + + + + + + Request the system's automatic callback attributes. + The response is either a SystemAutomaticCallbackGetResponse15sp2 or an ErrorResponse. + Replaced by: SystemAutomaticCallbackGetRequest17 + + + + + + + + + + + + + Response to SystemAutomaticCallbackGetRequest15sp2. + + + + + + + + + + + + + + + + + + + + + Requests the information about the specified device type without regard to whether the + type is SIP or MGCP. + The response is either SystemDeviceTypeGetResponse16 or ErrorResponse. + Replaced by: SystemDeviceTypeGetRequest16sp1 + + + + + + + + + + + + + + + Request the system level data associated with Dial Plan Policy. + The response is either a SystemDialPlanPolicyGetResponse or an + ErrorResponse. + + Replaced by: SystemDialPlanPolicyGetRequest17 + + + + + + + + + + + + + Response to SystemDialPlanPolicyGetRequest + + Replaced by: SystemDialPlanPolicyGetResponse17 + + + + + + + + + + + + + + + + + + Request the system's DTMF based in-call service activation trigger attributes. The response is either a SystemInCallServiceActivationGetResponse or an ErrorResponse. + + Replaced by: SystemInCallServiceActivationGetRequest17 + + + + + + + + + + + + + Response to SystemInCallServiceActivationGetRequest. + + Replaced by: SystemInCallServiceActivationGetResponse17 + + + + + + + + + + + + + + + Modifies the system's DTMF based in-call service activation trigger attributes.The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: SystemInCallServiceActivationModifyRequest17 + + + + + + + + + + + + + + + Request the list of users that use the Malicious Call Trace feature. + The response is either a SystemMaliciousCallTraceGetUserListResponse or an + ErrorResponse. + Replaced By: SystemMaliciousCallTraceGetRequest + + + + + + + + + + + + + Response to SystemMaliciousCallTraceGetUserListRequest. The column headings are "Service Provider Id", + "Group Id", "User Id", "Last Name", "First Name", "Phone Number", "Trace Type", "Status", + "Hiragana Last Name" and "Hiragana First Name". + + Replaced By: SystemMaliciousCallTraceGetResponse + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetRequest16. + Replaced by: SystemDeviceTypeGetResponse16sp1 + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + Replaced by: SystemSIPDeviceTypeAddRequest16sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + Replaced by: SystemSIPDeviceTypeAddRequest17 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type file. + The response is either SystemSIPDeviceTypeFileGetResponse14sp8 or ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeFileGetRequest14sp8. + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse16 or ErrorResponse. + Replaced by: SystemSIPDeviceTypeGetRequest16sp1 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest16. + Replaced by: SystemSIPDeviceTypeGetResponse16sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse16sp1 or ErrorResponse. + + Replaced by: SystemSIPDeviceTypeGetRequest17 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest16sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a sip device type. + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + isMobilityManagerDevice + The response is either SuccessResponse or ErrorResponse. + Replaced by: SystemSIPDeviceTypeModifyRequest16sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a sip device type. + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + isMobilityManagerDevice + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Center. + The response is either a SystemCallCenterGetResponse16 or an + ErrorResponse. + + Replaced by: SystemCallCenterGetRequest17 + + + + + + + + + + + + + Response to SystemCallCenterGetRequest16. + + + + + + + + + + + + + + + + + + + + + + Request the system's calling name retrieval attributes. + The response is either a SystemCallingNameRetrievalGetResponse14 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemCallingNameRetrievalGetRequest14. + + + + + + + + + + + + + + + + + + Modifies the system's calling name retrieval attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Add a new Communication Barring Criteria. + The response is either a SuccessResponse or an ErrorResponse. + Replaced by: SystemCommunicationBarringCriteriaAddRequest17 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Criteria. + The response is either a SystemCommunicationBarringCriteriaGetResponse + or an ErrorResponse. + + Replaced by: SystemCommunicationBarringCriteriaGetRequest17 + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringCriteriaGetRequest. + The response contains the Communication Barring Criteria information. + + Replaced by: SystemCommunicationBarringCriteriaGetResponse17 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of expensive alternate call indicators in the system. + The response is either a SystemExpensiveCallTypeGetListResponse or an ErrorResponse. + Replaced by: SystemExpensiveCallTypeGetListRequest16sp1 + + + + + + + + + + + + + Response to SystemExpensiveCallTypeGetListRequest. + Replaced by: SystemExpensiveCallTypeGetListResponse16sp1 + + + + + + + + + + + + + + + Add an application to the OCI call control application list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse14sp4 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest14sp4. + Contains the default policy settings for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse16sp1 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest16sp1. + Contains the default policy settings for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse16sp2 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest16sp2. + Contains the default policy settings for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Retrieves the Sh Interface system parameters. + The response is either a SystemShInterfaceParametersGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemShInterfaceParametersGetRequest. Contains the Sh Interface system parameters. + + + + + + + + + + + + + + + + + Modifies the Sh Interface system parameters. This request must be submitted on both nodes in the redundant Application Server cluster in order for the changes to take effect on each node without requiring a restart. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse14 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetPolicyRequest14. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess is returned only for the enterprise administrator. + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Auto Attendant instance. + The response is either GroupAutoAttendantGetInstanceResponse16 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAutoAttendantGetInstanceRequest16. + Contains the service profile information. + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse16 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a BroadWorks Anywhere instance. + The response is either GroupBroadWorksAnywhereGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupBroadWorksAnywhereGetInstanceRequest. + Contains the service profile information. + + + + + + + + + + + + + + + + + + + Request the group's extension length. + The response is either a GroupExtensionLengthGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupExtensionLengthGetRequest. + + + + + + + + + + + + + + + Modify the group's extension length. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse16sp1 or ErrorResponse. + Replaced by: ServiceProviderAdminGetPolicyRequest17 + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetPolicyRequest16sp1. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess is returned only for the enterprise administrator. + Replaced by: ServiceProviderAdminGetPolicyResponse17 + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse16sp2 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetPolicyRequest16sp1. + Response to ServiceProviderAdminGetPolicyRequest16sp2. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess is returned only for the enterprise administrator. + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse16sp1 or ErrorResponse. + Replaced by: GroupAdminGetPolicyRequest17 + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest16sp1. + Contains the policy settings for the group administrator. + Replaced by: GroupAdminGetPolicyRequest17 + + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse16sp2 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest16sp2. + Contains the policy settings for the group administrator. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse14 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupHuntGroupGetInstanceRequest14. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight". + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of an Instant Group Call service instance. + The response is either GroupInstantGroupCallGetInstanceResponse14 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupInstantGroupCallGetInstanceRequest14. + Contains the service profile information and a list of phone numbers. + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse16sp2 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest16sp2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse16 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse16sp2 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest16sp2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a system holiday schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a system holiday schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a system holiday schedule. + The response is either a SystemHolidayScheduleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemHolidayScheduleGetRequest. + The response contains the system holiday schedule information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request a list of all system holiday schedules. + The response is either a SystemHolidayScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemHolidayScheduleGetListRequest. + The response contains all the system holiday schedule names. + + + + + + + + + + + + + + + Modify a system holiday schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Hunt Group. + The response is either a SystemHuntGroupGetResponse or an + ErrorResponse. + Replaced by: SystemHuntGroupGetRequest17 + + + + + + + + + + + + + Response to SystemHuntGroupGetRequest. + Replaced by: SystemHuntGroupGetResponse17 + + + + + + + + + + + + + + + + Get an existing Network Class of Service. + The response is either a SystemNetworkClassOfServiceGetResponse + or an ErrorResponse. + Replaced by: SystemNetworkClassOfServiceGetRequest17 + + + + + + + + + + + + + + + Response to the SystemNetworkClassOfServiceGetRequest. + The response contains the Network Class of Service information. + Replaced by: SystemNetworkClassOfServiceGetResponse17 + + + + + + + + + + + + + + + + + + + + + + + + + Adds a list of IP addresses to a zone + The response is SuccessResponse or an ErrorResponse. + Replaced by: SystemZoneNetAddressAddListRequest + + + + + + + + + + + + + + + + + Deletes a list of IP addresses from a zone + The response is SuccessResponse or an ErrorResponse. + Replaced by: SystemZoneNetAddressDeleteListRequest + + + + + + + + + + + + + + + + + Gets a list of IP Addresses and/or Ranges assigned to a zone + Response is SystemZoneCallingRestrictionsNetAddressGetListResponse. + Replaced by: SystemZoneNetAddressGetListRequest + + + + + + + + + + + + + + + + + Response to SystemZoneCallingRestrictionsNetAddressGetListRequest. + Replaced by: SystemZoneNetAddressGetListResponse + + + + + + + + + + + + + + + + Add a zone. + The response is either a SuccessResponse or an ErrorResponse. + Replaced by: SystemZoneAddRequest + + + + + + + + + + + + + + + + Deletes a zone from the system + The response is either a SuccessResponse or an ErrorResponse. + Replaced by: SystemZoneDeleteRequest + + + + + + + + + + + + + + + Gets a list of all zones defined in the system + The response is SystemZoneCallingRestrictionsZoneGetListResponse or an ErrorResponse. + Replaced by: SystemZoneGetListRequest + + + + + + + + + + + + + Response to SystemZoneCallingRestrictionsZoneGetListRequest. + Contains a table of all the zones in the system. The column headings are "Zone Name" , "Physical Location". + Replaced by: SystemZoneGetListResponse + + + + + + + + + + + + + + + Modifies attributes of a zone in the system. + The response is either a SuccessResponse or an ErrorResponse. + Replaced by: SystemZonePhysicalLocationAddListRequest and + SystemZonePhysicalLocationDeleteListRequest + + + + + + + + + + + + + + + + Request the user level data associated with Alternate Numbers. + The response is either a UserAlternateNumbersGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserAlternateNumbersGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + Get the list of all the BroadWorks Anywhere phone numbers for the user. + The response is either a UserBroadWorksAnywhereGetResponse or an ErrorResponse. + Replaced by: UserBroadWorksAnywhereGetRequest16sp2 + + + + + + + + + + + + + + + Response to the UserBroadWorksAnywhereGetRequest. + The phoneNumberTable contains columns: "Phone Number", "Description" + Replaced by: UserBroadWorksAnywhereGetResponse16sp2 + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse16 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest16. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse16 or an + ErrorResponse. + + Replaced by: UserCallProcessingGetPolicyRequest17sp4 + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest16sp2. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useUserDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) + + Replaced by: UserCallProcessingGetPolicyResponse17sp4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Fax Messaging. + The response is either a UserFaxMessagingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserFaxMessagingGetRequest. + + + + + + + + + + + + + + + + + Request to get the user information. The response is either + UserGetResponse15sp2 or ErrorResponse. + + + + + + + + + + + + + + + Response to UserGetRequest15sp2. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's call center settings and the list of call centers the specified user belongs to. + The response is either a UserCallCenterGetResponse16 or an ErrorResponse. + + Replaced by: UserCallCenterGetRequest17 + + + + + + + + + + + + + + + Response to the UserCallCenterGetRequest16. + Contains the user's call center settings. + Indicates whether the agent is current available (logged in) to each call center in the list. + Contains a table with column headings: "Service User Id", "Phone Number", "Extension", "Available", "Logoff Allowed", "Type", and "Priority". + + + + + + + + + + + + + + + + + + + + + + + + Add a holiday schedule to a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a holiday schedule from a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a holiday schedule list for a user. + The response is either a UserHolidayScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserHolidayScheduleGetListRequest. + The response contains all the user's personal and user's group holiday schedule names. + + + + + + + + + + + + + + + Get a holiday schedule a user. + The response is either a UserHolidayScheduleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserHolidayScheduleGetRequest. + The response contains the user?s holiday schedule information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a holiday schedule for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Hoteling Host. + The response is either a UserHotelingHostGetResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserHotelingHostGetRequest14sp4. + + + + + + + + + + + + + + + + + + + + + + + + Add a new phone number and set the answer confirmation setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the user level data associated with Third-Party Voice Mail Support. + The response is either a UserThirdPartyVoiceMailSupportGetResponse13mp16 or an + ErrorResponse. + Replaced by: UserThirdPartyVoiceMailSupportGetRequest17 + + + + + + + + + + + + + + + Delete the phone number specified. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the answer confirmation setting for the phone number specified. + The response is either a UserSimultaneousRingFamilyGetPhoneNumberResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSimultaneousRingFamilyGetPhoneNumberRequest. + + + + + + + + + + + + + + + Get the user's simultaneous ring service Family setting. + The response is either a UserSimultaneousRingFamilyGetResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSimultaneousRingFamilyGetRequest14sp4. + Contains a table with column headings: "Phone Number", "Answer Confirmation Required". + + + + + + + + + + + + + + + + + Modify the require confirmation setting for the destination. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Modify the user's simultaneous ring family service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Add a new phone number and set the answer confirmation setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete the phone number specified. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the answer confirmation setting for the phone number specified. + The response is either a UserSimultaneousRingPersonalGetPhoneNumberResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSimultaneousRingPersonalGetPhoneNumberRequest. + + + + + + + + + + + + + + + Get the user's simultaneous ring service personal setting. + The response is either a UserSimultaneousRingPersonalGetResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSimultaneousRingPersonalGetRequest14sp4. + Contains a table with column headings: "Phone Number", "Answer Confirmation Required". + + + + + + + + + + + + + + + + + Modify the require confirmation setting for the destination. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Modify the user's simultaneous ring personal service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to UserThirdPartyVoiceMailSupportGetRequest13mp16. + Replaced by: UserThirdPartyVoiceMailSupportGetResponse17 + + + + + + + + + + + + + + + + + + + + + + + Get the user's voice messaging voice management service settings. + The response is either a UserVoiceMessagingUserGetVoiceManagementResponse13mp8 or an ErrorResponse. + Replaced by: UserVoiceMessagingUserGetVoiceManagementRequest17 + + + + + + + + + + + + + + + Response to the UserVoiceMessagingUserGetVoiceManagementRequest13mp8. + Replaced by: UserVoiceMessagingUserGetVoiceManagementResponse17 + + + + + + + + + + + + + + + + + + + + + + + + + + + Query timer milli-seconds. + + + + + + + + + + + + Holiday entry. + + + + + + + + + + + + + The group's extension length. + + + + + + + + + + + + Alternate Number Entry. + + + + + + + + + + + + + Service Profile Information for group service. + It is identical to the ServiceInstanceAddProfile, but without the password. + Prior to release 14 this was called ServiceInstanceProfile. + + + + + + + + + + + + + + + + + + + + + + + CPE device's options. + + + + + + + + + + + + + + + + CPE device's options when used with a modify request. + The following options are not changeable: + configType + systemFileName + deviceFileFormat + + + + + + + + + + + + + CPE device's options. + + + + + + + + + + + + + + + + Get a criteria for the user's selective call rejection service. + The response is either a UserSelectiveCallRejectionGetCriteriaResponse16 or an ErrorResponse. + Replaced by: UserSelectiveCallRejectionGetCriteriaRequest16sp1 + + + + + + + + + + + + + + + + Response to the UserSelectiveCallRejectionGetCriteriaRequest16. + Replaced by: UserSelectiveCallRejectionGetCriteriaResponse16sp1 + + + + + + + + + + + + + + + + + + Add a time schedule for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a user time schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get all time schedules for a user. This includes the user's personal schedules and user's group's + schedules. + The response is either a UserTimeScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserTimeScheduleGetListRequest. The column headings are "Time Schedule" and + "Type". + The response contains user's personal and user's group's schedule names. + + + + + + + + + + + + + + + Request to get a user time schedule. + The response is either a UserTimeScheduleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserTimeScheduleGetRequest. + The response contains the requested time schedule information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a user time schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the call center media on hold source configuration. + + + + + + + + + + + + + + + + Contains the call center media on hold source configuration. + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Policies. + The response is either a UserCallPoliciesGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallPoliciesGetRequest. + + + + + + + + + + + + + + + Time Interval. + + + + + + + + + + + + + + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse15sp2 or an ErrorResponse. + Replaced by: SystemSubscriberGetCallProcessingParametersRequest17 + + + + + + + + + + + + + Response to the SystemSubscriberGetCallProcessingParametersRequest15sp2. + Replaced by: SystemSubscriberGetCallProcessingParametersResponse17 + + + + + + + + + + + + + + + + + + + Add a system time schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a system time schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a system time schedule. + The response is either a SystemTimeScheduleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemTimeScheduleGetRequest. + The response contains the system time schedule's information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request a list of all system time schedules. + The response is either a SystemTimeScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemTimeScheduleGetListRequest. + The response contains all the system time schedule names. + + + + + + + + + + + + + + + Modify a specified system time schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Holiday name. + + + + + + + + + + + + Time schedule name. + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDeprecated17.xsd b/share/OCISchemaAS/OCISchemaDeprecated17.xsd new file mode 100644 index 0000000..0705895 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDeprecated17.xsd @@ -0,0 +1,5778 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the address and credentials of the File Repository hosting the requested access device file. + Also get the file name and path on the File Repository. + The response is either a DeviceManagementFileAuthLocationGetResponse17 or an ErrorResponse. + + Replaced by: DeviceManagementFileAuthLocationGetRequest18 + + + + + + + + + + + + + + + + + + + + + + + + Return the address and credentials of the File Repository hosting the requested access device file. + Also return the file name and path on the File Repository. + This is a response to DeviceManagementFileAuthLocationGetRequest17. + + Replaced by: DeviceManagementFileAuthLocationGetRequest18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request users' call logs within an enterprise + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either an EnterpriseEnhancedCallLogsGetListResponse or an ErrorResponse. + + Replaced by EnterpriseEnhancedCallLogsGetListRequest17sp4. + Originally deprecated in release 20. + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterpriseEnhancedCallLogsGetListRequest. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the EnterpriseEnhancedCallLogsGetListRequest, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The result is sorted by date/time of the call. + + Replaced by EnterpriseEnhancedCallLogsGetListResponse17sp4. + Originally deprecated in release 20. + + + + + + + + + + + + + + + + Request a table containing the phone directory for an enterprise. + The directory includes all users in the enterprise and all entries in the enterprise common phone list. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either EnterprisePhoneDirectoryGetListResponse17 or ErrorResponse. + + Replaced by: EnterprisePhoneDirectoryGetListRequest18 + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterprisePhoneDirectoryGetListRequest17. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", + "Department", "Hiragana Name", "Group Id", "Yahoo Id", "Is Virtual On-Net User". + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "User Id", "Pager", "Title", "Time Zone", + "Location", "Address Line 1", "Address Line 2", + "City", "State", "Zip", "Country". + + Replaced by: EnterprisePhoneDirectoryGetListResponse18 + + + + + + + + + + + + + + + Request a table containing the phone directory for an enterprise. + The directory includes all users in the enterprise and all entries in the enterprise common phone list. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either EnterprisePhoneDirectoryGetListResponse17sp3 or ErrorResponse. + + Replaced by: EnterprisePhoneDirectoryGetListRequest18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterprisePhoneDirectoryGetListRequest17sp3. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", + "Department", "Hiragana Name", "Group Id", "Yahoo Id", "IMP Id", "Is Virtual On-Net User". + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "User Id", "Pager", "Title", "Time Zone", + "Location", "Address Line 1", "Address Line 2", + "City", "State", "Zip", "Country". + + Replaced by: EnterprisePhoneDirectoryGetListResponse18 + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse17 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest17. + Contains the policy settings for the group administrator. + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse17sp3 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest17sp3. + Contains the policy settings for the group administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Add a Auto Attendant instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Auto Attendant instance. + The response is either GroupAutoAttendantGetInstanceResponse17 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAutoAttendantGetInstanceRequest17. + Contains the service profile information. + + + + + + + + + + + + + + + + + + + + + + + Request to modify an Auto Attendant instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + Replaced by: GroupCallCenterAddInstanceRequest17sp3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse17 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse17sp1 or ErrorResponse. + + Replaced by: GroupCallCenterGetInstanceRequest17sp3 + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceRequest17sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the call center statistics reporting settings. + The response is either GroupCallCenterGetInstanceStatisticsReportingResponse16 or ErrorResponse. + + + + + + + + + + + + + + + Contains Call Center statistics reporting settings. + + + + + + + + + + + + + + + + + + + Get a call center's holiday service settings. + The response is either a GroupCallCenterHolidayServiceGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterHolidayServiceGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's holiday service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a Call Center instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the Call Center statistics reporting frequency and destination. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Get a call center's night service settings. + The response is either a GroupCallCenterNightServiceGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterNightServiceGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's night service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds a Call Park group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Gets a Call Park group. + The response is either GroupCallParkGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallParkGetInstanceRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name". The users are in the table are in the order they will try to be parked on. + + + + + + + + + + + + + + + Gets the Call Park Group settings. + The response is either GroupCallParkGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallParkGetRequest. + Contains the settings that apply to the whole group for Call Park. + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse17 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse17sp3 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + The useGroupDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) + + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + + Replaced by GroupCallProcessingGetPolicyRequest17sp4 + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest17sp3. + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + + Replaced by GroupCallProcessingGetPolicyResponse17sp4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse17sp4 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + + Replaced by GroupCallProcessingGetPolicyRequest18 + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest17sp4. + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + + Replaced by GroupCallProcessingGetPolicyResponse18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request a list of departments in a group. You may request only the + list of departments defined at the group-level, or you may request + the list of all departments in the group including all the departments + defined within the enterprise the group belongs to. + The response is either GroupDepartmentGetListResponse or ErrorResponse. + + Replaced by: GroupDepartmentGetListRequest18 + + + + + + + + + + + + + + + + + Response to GroupDepartmentGetListRequest. + The response includes two parallel arrays of department keys and department display names. + + Replaced by: GroupDepartmentGetListResponse18 + + + + + + + + + + + + + + + + Get the list of assigned and unassigned DNs in a group. Each DN can be assigned + to a user and/or department. Ranges of DNs with identical assignment and activation properties + are coalesced to a single table row entry. + The response is either a GroupDnGetAssignmentListResponse or an ErrorResponse. + + Replaced by: GroupDnGetAssignmentListRequest18 + + + + + + + + + + + + + + + + + + + + + + Response to the GroupDnGetAssignmentListRequest. + The response contains a table with columns: "Phone Numbers", "Assigned To", "Department", "Activated". + The "Phone Numbers" column contains either a single DN or a range of DNs. + The "Assigned To" column contains the user name or service instance name possessing the DN(s). + The "Department" column contains the department of the DN, not the department of the user or service instance. + The "Activated" column indicates if the DN or DN range has been activated. Only has a value if the DN(s) is assigned to a user. + + Replaced by: GroupDnGetAssignmentListResponse18 + + + + + + + + + + + + + + + Request users' call logs within a group + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl.If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a GroupEnhancedCallLogsGetListResponse or an ErrorResponse. + + Replaced by GroupEnhancedCallLogsGetListRequest17sp4. + Originally deprecated in release 20. + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupEnhancedCallLogsGetListRequest. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the GroupEnhancedCallLogsGetListRequest, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The logs are sorted by date/time of the call. + + Replaced by GroupEnhancedCallLogsGetListResponse17sp4. + Originally deprecated in release 20. + + + + + + + + + + + + + + + + true + false + + + Replaced by: GroupGroupPagingGetInstanceRequest17sp3 + Request to get all the information of a Group Paging instance. + The response is either GroupGroupPagingGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Replaced by: GroupGroupPagingGetInstanceResponse17sp3 + Response to GroupGroupPagingGetInstanceRequest. + Contains the service profile information. + + + + + + + + + + + + + + + + + + Add a Hunt Group instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Hunt Group instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting, use value "true" in HSS data mode + includeHuntGroupNameInCLID, use value "true" in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse17 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupHuntGroupGetInstanceRequest17. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight". + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse17sp3 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupHuntGroupGetInstanceRequest17sp3. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight". + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting + includeHuntGroupNameInCLID + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Meet-Me Conferencing bridge to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Meet-Me Conferencing bridge. + The response is either GroupMeetMeConferencingGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupMeetMeConferencingGetInstanceRequest. + Contains the service profile information and a table of assigned hosts. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Meet-Me Conferencing bridge. + The response is either GroupMeetMeConferencingGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupMeetMeConferencingGetInstanceRequest17sp3. + Contains the service profile information and a table of assigned hosts. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Meet-Me Conferencing bridge. + The response is either GroupMeetMeConferencingGetInstanceResponse17sp4 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupMeetMeConferencingGetInstanceRequest17sp4. + Contains the service profile information and a table of assigned hosts. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + Request a table containing the phone directory for a group. + If the specified group is part of an enterprise, the directory + includes all users in the enterprise and all entries in the enterprise + common phone list and the common phone list of the specified group. + + If the specified group is part of a service provider, the directory + includes all users in the group and all entries in the common phone + list of the specified group. + + It is possible to search by various criteria to restrict the number of + rows returned. + + Multiple search criteria are logically ANDed together. + The response is either GroupPhoneDirectoryGetListResponse17 or + ErrorResponse. + + Replaced by: GroupPhoneDirectoryGetListRequest18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupPhoneDirectoryGetListRequest17. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", + "Department", "Hiragana Name", "Group Id", "Yahoo Id", + "Is Virtual On-Net User" + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "User Id", "Pager", "Title", "Time Zone", + "Location", "Address Line 1", "Address Line 2", "City", "State", + "Zip", "Country". + + Replaced by: GroupPhoneDirectoryGetListResponse18 + + + + + + + + + + + + + + + Request a table containing the phone directory for a group. + If the specified group is part of an enterprise, the directory + includes all users in the enterprise and all entries in the enterprise + common phone list and the common phone list of the specified group. + + If the specified group is part of a service provider, the directory + includes all users in the group and all entries in the common phone + list of the specified group. + + It is possible to search by various criteria to restrict the number of + rows returned. + + Multiple search criteria are logically ANDed together. + The response is either GroupPhoneDirectoryGetListResponse17sp3 or + ErrorResponse. + + Replaced by: GroupPhoneDirectoryGetListRequest18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupPhoneDirectoryGetListRequest17sp3. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", + "Department", "Hiragana Name", "Group Id", "Yahoo Id", "IMP Id" and + "Is Virtual On-Net User" + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "User Id", "Pager", "Title", "Time Zone", + "Location", "Address Line 1", "Address Line 2", "City", "State", + "Zip", "Country". + + Replaced by: GroupPhoneDirectoryGetListResponse18 + + + + + + + + + + + + + + + Get a route point's holiday service settings. + The response is either a GroupRoutePointHolidayServiceGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointHolidayServiceGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's holiday service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's night service settings. + The response is either a GroupRoutePointNightServiceGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointNightServiceGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's night service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the list of a group schedules. The list can be filtered by schedule type. + The response is either a GroupScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupScheduleGetListRequest. + The response contains a list of system schedules. + + + + + + + + + + + + + + + + + Request the data associated with Privacy for a service instance. + The response is either a GroupServiceInstancePrivacyGetResponse. + Replaced by: GroupServiceInstancePrivacyGetRequest17sp4 + + + + + + + + + + + + + + + Response to GroupServiceInstancePrivacyGetRequest. + Replaced by: GroupServiceInstancePrivacyGetResponse17sp4 + + + + + + + + + + + + + + + + Get the speed dial 100 service settings for a group. + The response is either a GroupSpeedDial100GetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupSpeedDial100GetRequest. + + + + + + + + + + + + + + + Replaced by: GroupTrunkGroupAddInstanceRequest17sp4 + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: GroupTrunkGroupAddInstanceRequest17sp4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse17 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest17. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse17sp3 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + Replaced by: GroupTrunkGroupGetInstanceRequest17sp4 + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest17sp3. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the group voice portal information for a voice messaging group. + The response is either GroupVoiceMessagingGroupGetVoicePortalResponse17 or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalRequest17. + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse17 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetPolicyRequest17. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess is returned only for the enterprise administrator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse17sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetPolicyRequest17sp1. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess is returned only for the enterprise administrator. + The following elements are only used in HSS data mode: + communicationBarringAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse17sp3 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetPolicyRequest17sp3. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess is returned only for the enterprise administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + The following elements are only used in HSS data mode: + communicationBarringAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a new Communication Barring Profile. + The priorities for OriginatingRules, RedirectingRules and IncomingRules are requantized to consecutive integers as part of the add. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a ServiceProviderCommunicationBarringProfileGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the ServiceProviderCommunicationBarringProfileGetRequest. + The response contains the Communication Barring Profile information. + The incoming, originating and redirecting rules are returned in ascending priority order. + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the service provider's enhanced call log settings. + The response is either a ServiceProviderEnhancedCallLogsGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderEnhancedCallLogsGetRequest. + + + + + + + + + + + + + + + + Get the profile for a service provider or enterprise. + The response is either a ServiceProviderGetResponse13mp2 or an ErrorResponse. + + Replaced by: ServiceProviderGetRequest17sp1 + + + + + + + + + + + + + + + Response to the ServiceProviderGetRequest13mp2. + The response contains the service provider or enterprise's profile information. + + Replaced by: ServiceProviderGetResponse17sp1 + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with the Busy Lamp + Field service. The response is either a + SystemBusyLampFieldGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemBusyLampFieldGetRequest. + + + + + + + + + + + + + + + true + false + + + Get the broadworks mobility system parameters. + The response is either a SystemBroadWorksMobilityGetResponse or an ErrorResponse. + + Replaced by: SystemBroadWorksMobilityGetRequest17sp4. + + + + + + + + + + + + + true + false + + + The response to a SystemBroadWorksMobilityGetRequest. + + Replaced by: SystemBroadWorksMobilityGetResponse17sp4. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the BroadWorks Mobility system parameters. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: SystemBroadWorksMobilityModifyRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + Requests the list of System Diameter base parameters. + The response is either SystemBwDiameterBaseDataGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemBwDiameterBaseDataGetRequest. + Contains a list of System Diameter base parameters. + + + + + + + + + + + + + + + + + + + + + + + + + + The response is either a SystemCallProcessingGetPolicyResponse17 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Processing Policy. + The response is either a SystemCallProcessingGetPolicyResponse17sp3 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest17sp3. + The following elements are only used in AS data mode: + enableDialableCallerID + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a new Communication Barring Profile. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Add a new Communication Barring Profile. + The priorities for IncomingRules are requantized to consecutive integers as part of the add. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in HSS data mode: + incomingDefaultAction + incomingDefaultCallTimeout + incomingRule + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a SystemCommunicationBarringProfileGetResponse16 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetRequest16. + The response contains the Communication Barring Profile information. + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a SystemCommunicationBarringProfileGetResponse17sp1 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetRequest17sp1. + The response contains the Communication Barring Profile information. + The incoming rules are returned in ascending priority order. + The following elements are only used in HSS data mode: + incomingDefaultAction + incomingDefaultCallTimeout + incomingRule + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Enhanced Call Logs. + The response is either a SystemEnhancedCallLogsGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Replaced by: SystemDeviceTypeGetRequest18. + Requests the information about the specified device type without regard to whether the + type is SIP or MGCP. + The response is either SystemDeviceTypeGetResponse16sp1 or ErrorResponse. + + + + + + + + + + + + + + + Replaced by: SystemSIPDeviceTypeGetReponse18. + Response to SystemDeviceTypeGetRequest16sp1. + + + + + + + + + + + + + + + + + + + + + + + Response to SystemEnhancedCallLogsGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + Gets system level the Location Based Calling Restrictions attributes. + The response is either a SystemLocationBasedCallingRestrictionsGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemLocationBasedCallingRestrictionsGetRequest. + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Meet-Me Conferencing functions. + The response is either a SystemMeetMeConferencingGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemMeetMeConferencingGetRequest. + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Meet-Me Conferencing functions. + The response is either a SystemMeetMeConferencingGetResponse17sp3 or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemMeetMeConferencingGetRequest17sp3. + + + + + + + + + + + + + + + + + + + + + + Request to get the list of Network Server Sync system parameters. + The response is either SystemNetworkServerSyncParametersGetResponse16 or ErrorResponse. + Replaced By: SystemNetworkServerSyncParametersGetRequest17sp4 + + + + + + + + + + + + + Response to SystemNetworkServerSyncParametersGetRequest16. + Contains a list of system Network Server Sync parameters. + Replaced By: SystemNetworkServerSyncParametersGetResponse17sp4 + + + + + + + + + + + + + + + + + Request the system level data associated with Outgoing Calling Plan. + The response is either a SystemOutgoingCallingPlanGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemOutgoingCallingPlanGetRequest. + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse17 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest17. + Contains the default policy settings for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse17sp1 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest17sp1. + Contains the default policy settings for the system. + The following elements are only used in HSS data mode: + serviceProviderAdminCommunicationBarringAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse17sp3 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest17sp3. + Contains the default policy settings for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: SystemRedundancyParametersGetRequest16sp2 + + Request to get the list of Redundancy system parameters. + The response is either SystemRedundancyParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Replaced by: SystemRedundancyParametersGetResponse16sp2 + + Response to SystemRedundancyParametersGetRequest. + Contains a list of system Redundancy parameters. + + + + + + + + + + + + + + + Request the system level data associated with session audit. + The response is either a SystemSessionAuditGetResponse14sp3 or + an ErrorResponse. + + + + + + + + + + + + + Response to SystemSessionAuditGetRequest14sp3. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + Replaced by: SystemSIPDeviceTypeAddRequest18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: SystemSIPDeviceTypeFileAddRequest18. + Request to add a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: SystemSIPDeviceTypeFileGetRequest18. + Request to get a sip device type file. + The response is either SystemSIPDeviceTypeFileGetResponse16sp1 or ErrorResponse. + + + + + + + + + + + + + + + + Replaced by: SystemSIPDeviceTypeFileGetResponse18. + Response to SystemSIPDeviceTypeFileGetRequest16sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse17 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: SystemSIPDeviceTypeGetRequest18. + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse17sp4 or ErrorResponse. + Replaced by: SystemSIPDeviceTypeGetRequest18 + + + + + + + + + + + + + + + Replaced by: SystemSIPDeviceTypeGetResponse18. + Response to SystemSIPDeviceTypeGetRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system's calling name retrieval attributes. + The response is either a SystemCallingNameRetrievalGetResponse16sp1 or an ErrorResponse. + + Replaced by: SystemCallingNameRetrievalGetRequest17sp4 + + + + + + + + + + + + + Response to SystemCallingNameRetrievalGetRequest16sp1. + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse17sp3 or an ErrorResponse. + + Replaced by ServiceProviderCallProcessingGetPolicyResponse17sp4 + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest17sp3. + The following elements are only used in AS data mode: + useServiceProviderDCLIDSetting + enableDialableCallerID + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the speed dial 100 system-wide default setting. + The response is either a SystemSpeedDial100GetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemSpeedDial100GetRequest. + + + + + + + + + + + + + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse17 + or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemSubscriberGetCallProcessingParametersRequest17. + + + + + + + + + + + + + + + + + + + + true + false + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse17sp3 + or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemSubscriberGetCallProcessingParametersRequest17sp3. + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Voice Messaging. + The response is either a SystemVoiceMessagingGroupGetResponse16 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemVoiceMessagingGroupGetRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the system voice portal Menus setting. + The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse14 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessagingGroupGetVoicePortalMenusRequest14. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: UserAddRequest17sp4 + + Request to add a user. + The domain is required in the userId. + The password is not required if external authentication is enabled. + The officeZoneName and primaryZoneName elements are ignored and provided here for backwards compatibility only. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the settings for the busy lamp field service. + The response is either a UserBusyLampFieldGetResponse or an ErrorResponse. + Replaced by: UserBusyLampFieldGetRequest16sp2 + + + + + + + + + + + + + + + Replaced by: UserBusyLampFieldGetResponse16sp2 + + Response to UserBusyLampFieldGetRequest. + The table has column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse17 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest17. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse17sp3 or an + ErrorResponse. + + Replaced by: UserCallProcessingGetPolicyRequest17Sp4 + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest17sp3. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useUserDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) + + The following elements are only used in AS data mode: + useUserDCLIDSetting + enableDialableCallerID + + Replaced by: UserCallProcessingGetPolicyResponse17Sp4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse17sp4 or an + ErrorResponse. + + Replaced by: UserCallProcessingGetPolicyRequest18 + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest17sp4. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useUserDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) + + The following elements are only used in AS data mode: + useUserDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + + Replaced by: UserCallProcessingGetPolicyResponse18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Waiting. + The response is either a UserCallWaitingGetResponse or an + ErrorResponse. + Replaced by: UserCallWaitingGetRequest17sp4 + + + + + + + + + + + + + + + Response to UserCallWaitingGetRequest. + + + + + + + + + + + + + + + Request user's call logs. + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", accountAuthorizationCodeFilter" + and ""subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified + as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a UserEnhancedCallLogsGetListResponse17sp4 or an ErrorResponse. + + Replaced by UserEnhancedCallLogsGetListRequest17sp4V2. + Originally deprecated in release 20. + + + + + + + + + + + + + + + + + + + + + + Response to UserEnhancedCallLogsGetListRequest17sp4. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest17sp4, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of MixedCallLogsEntry will be returned if the call logs are stored on CDS + A list of ExtendedMixedCallLogsEntry will be returned if the call logs are stored on DBS + The logs are sorted by date/time of the call. + + Replaced by UserEnhancedCallLogsGetListResponse17sp4V2. + Originally deprecated in release 20. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request user's call logs. + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl. + The response is either a UserEnhancedCallLogsGetListResponse16 or an ErrorResponse. + + Replaced by UserEnhancedCallLogsGetListRequest17sp4 + + + + + + + + + + + + + + + + + Response to UserEnhancedCallLogsGetListRequest16. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest16, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + + Replaced by UserEnhancedCallLogsGetListResponse17sp4 + + + + + + + + + + + + + + + + Request the user level data associated with Fax Messaging. + The response is either a UserFaxMessagingGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserFaxMessagingGetRequest17. + + + + + + + + + + + + + + + + + Replaced by: UserGetRequest17sp4 + + Request to get the user information. The response is either + UserGetResponse17 or ErrorResponse. + + + + + + + + + + + + + + + Replaced by: UserGetResponse17sp4 + + Response to UserGetRequest17. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: UserGetRequest18 + + Request to get the user information. The response is either + UserGetResponse17sp3 or ErrorResponse. + + + + + + + + + + + + + + + Replaced by: UserGetRequest18 + + Response to UserGetRequest17sp3. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: UserGetRequest18 + + Request to get the user information. The response is either + UserGetResponse17sp4 or ErrorResponse. + + + + + + + + + + + + + + + Replaced by: UserGetResponse18 + + Response to UserGetRequest17sp4. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + The following data elements are only used in AS data mode: + contact[2]-contact[5] + + The country code (countryCode) included is the user's phone number country code when the user has a phone number assigned, or the + user's Group associated country code when the user does not have a phone number assigned, or the system default country code when the + user's Group does not have an associated country code. + + The nationalPrefix in this response is the one associated to the included countryCode. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replaced by: UserModifyRequest17sp4 + + Request to modify a user. + When oldPassword is specified, all password rule applies. If oldPassword in not specified, + any password rule related to old password does not apply. + The request will fail if officeZoneName or primaryZoneName is present but the Location-Based Calling Restrictions service is not assigned to the user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the list of a user schedules. The list can be filtered by schedule type. + The response is either a UserScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserScheduleGetListRequest. + The response contains a list of system schedules. + + + + + + + + + + + + + + + + + Get the user's Shared Call Appearance service setting. + The response is either a UserSharedCallAppearanceGetResponse14sp2 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSharedCallAppearanceGetRequest14sp2. + The endpointTable contains columns: + "Device Level", "Device Name", "Device Type", "Line/Port", "SIP Contact". + The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. + + + + + + + + + + + + + + + + + + + + + + Get the speed dial 100 settings for a user. + The response is either a UserSpeedDial100GetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSpeedDial100GetListRequest. + + + + + + + + + + + + + + + + Sets the maximum number of logged calls that can be stored. + + + + + + + + + + + + Get the user's voice messaging greeting information. + The response is either a UserVoiceMessagingUserGetGreetingResponse16 or an ErrorResponse. + This request is replaced by: UserVoiceMessagingUserGetGreetingRequest18 + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetGreetingRequest16. + Contains the greeting configuration for a user's voice messaging. + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDeprecated18.xsd b/share/OCISchemaAS/OCISchemaDeprecated18.xsd new file mode 100644 index 0000000..a8473e2 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDeprecated18.xsd @@ -0,0 +1,4863 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the enterprise level data associated with Call Center Agents Unavailable Code Settings. + The response is either an EnterpriseCallCenterAgentUnavailableCodeSettingsGetResponse or an + ErrorResponse. + + Replaced by EnterpriseCallCenterAgentUnavailableCodeSettingsGetRequest17sp4. + + + + + + + + + + + + + + + Response to EnterpriseCallCenterAgentUnavailableCodeSettingsGetRequest. + + Replaced by EnterpriseCallCenterAgentUnavailableCodeSettingsGetResponse17sp4. + + + + + + + + + + + + + + + + + + + + Request to get an enterprise level call center enhanced reporting setting. + The response is either an EnterpriseCallCenterEnhancedReportingGetResponse or an ErrorResponse. + + Replaced by EnterpriseCallCenterEnhancedReportingGetRequest19 + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingGetRequest. + + Replaced by EnterpriseCallCenterEnhancedReportingGetResponse19 + + + + + + + + + + + + + + + + Request to modify enterprise level call center enhanced reporting settings. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by EnterpriseCallCenterEnhancedReportingModifyRequest19 + + + + + + + + + + + + + + + + + Request the enterprise level data associated with Call Center. + The response is either an EnterpriseCallCenterGetResponse or an + ErrorResponse. + + Replaced by EnterpriseCallCenterGetRequest17sp4. + + + + + + + + + + + + + + + Response to EnterpriseCallCenterGetRequest. + + Replaced by EnterpriseCallCenterGetResponse17sp4. + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Auto Attendant instance. + The response is either GroupAutoAttendantGetInstanceResponse17sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAutoAttendantGetInstanceRequest17sp1. + Contains the service profile information. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + Replaced by GroupCallCenterAddInstanceRequest19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Center Agents Unavailable Code Settings. + The response is either an GroupCallCenterAgentUnavailableCodeSettingsGetResponse or an + ErrorResponse. + + Replaced by GroupCallCenterAgentUnavailableCodeSettingsGetRequest17sp4. + + + + + + + + + + + + + + + + Response to GroupCallCenterAgentUnavailableCodeSettingsGetRequest. + + Replaced by GroupCallCenterAgentUnavailableCodeSettingsGetResponse17sp4. + + + + + + + + + + + + + + + + + + + + Request to get a group level call center enhanced reporting setting. + The response is either a GroupCallCenterEnhancedReportingGetResponse or an ErrorResponse. + + Replaced by GroupCallCenterEnhancedReportingGetRequest19 + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingGetRequest. + + Replaced by GroupCallCenterEnhancedReportingGetResponse19 + + + + + + + + + + + + + + + + Request to modify group level call center enhanced reporting settings. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by GroupCallCenterEnhancedReportingModifyRequest19 + + + + + + + + + + + + + + + + + + Get a call center's announcement settings. + The response is either a GroupCallCenterGetAnnouncementResponse17 or an ErrorResponse. + + Replaced by GroupCallCenterGetAnnouncementRequest17sp4 + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAnnouncementRequest17. + + Replaced by GroupCallCenterGetAnnouncementResponse17sp4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's DNIS Announcements + The response is either a GroupCallCenterGetDNISAnnouncementRequest or an ErrorResponse. + + Replaced by GroupCallCenterGetDNISAnnouncementRequest17sp4 + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDNISAnnouncementResponse. + + Replaced by GroupCallCenterGetDNISAnnouncementResponse17sp4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse17sp3 or ErrorResponse. + + Replaced by GroupCallCenterGetInstanceRequest19 + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceRequest17sp3. + + Replaced by GroupCallCenterGetInstanceResponse19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the Group level data associated with Call Center. + The response is either a GroupCallCenterGetResponse or an + ErrorResponse. + + Replaced by GroupCallCenterGetRequest17sp4. + + + + + + + + + + + + + + + + Response to GroupCallCenterGetRequest. + + Replaced by GroupCallCenterGetResponse17sp4. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a Call Center instance. + The response is either SuccessResponse or ErrorResponse. + + Replaced by: GroupCallCenterModifyInstanceRequest19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Trunk Group instance to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse17sp4 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address". + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest17sp4. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse17sp4V2 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + Replaced by: GroupTrunkGroupGetInstanceRequest19V2 + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceRequest17sp4V2. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name". + + Replaced by: GroupTrunkGroupGetInstanceResponse19V2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Center. + The response is either a SystemCallCenterGetResponse17 or an + ErrorResponse. + + Replaced by SystemCallCenterGetRequest17sp4. + + + + + + + + + + + + + Response to SystemCallCenterGetRequest17. + + Replaced by SystemCallCenterGetResponse17sp4. + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Call Center. + The response is either a SystemCallCenterGetResponse17sp4 or an + ErrorResponse. + + Replaced by: SystemCallCenterGetRequest19 + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterGetRequest17sp4. + + Replaced by: SystemCallCenterGetResponse19. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Call Recording platform. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get a list of Call Center Reporting Server. + The response is either SystemCallCenterReportingServerGetListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterReportingServerGetListRequest. The table columns are: + "Name", "URL", "Net Address", and "Description". + + + + + + + + + + + + + + + Get the system Integrated IMP service attributes. + The response is either SystemIntegratedIMPGetResponse or ErrorResponse. + + Replaced by SystemIntegratedIMPGetRequest19. + + + + + + + + + + + Response to the SystemIntegratedIMPGetRequest. + The response contains the system Integrated IMP service attributes. + + Replaced by SystemIntegratedIMPGetResponse19. + + + + + + + + + + + + + + + + + Request to get the Number Activation state. + The response is either SystemNumberActivationGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemNumberActivationGetRequest. + Contains the system number activation setting. + + + + + + + + + + + + + + + Request to modify system number activation setting. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Selective Services. + The response is either a SystemSelectiveServicesGetResponse or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSelectiveServicesGetRequest. + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in HSS data mode: + enable3G4GContinuity + + Replaced by: SystemSIPDeviceTypeAddRequest19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type file. + The response is either SystemSIPDeviceTypeFileGetResponse18 or ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeFileGetRequest18. + Take note: + + 1. accessUrl may have undefined content. + When it is the case, undefined content is put between []. + It may also be set to "Error Access FQDN Not Provisioned" when the access FQDN is not set, + or "Error Access Context Name Not Provisioned" when the context name is not set. + + 2. repositoryUrl may be set to "DEVICE_CONFIGURATION_FILE_REPOSITORY_MISSING", if there is no file repository defined. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse18 or ErrorResponse. + + Replaced by: SystemSIPDeviceTypeGetRequest19 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest18. + + The following elements are only used in HSS data mode: + enable3G4GContinuity + + Replaced by: SystemSIPDeviceTypeGetResponse19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a sip device type. + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + isMobilityManagerDevice + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in HSS data mode: + enable3G4GContinuity + + Replaced by: SystemSIPDeviceTypeModifyRequest19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in HSS data mode: + enable3G4GContinuity, use value "false" in AS data mode + The following elements are only used in AS data mode: + holdAnnouncementMethod, use value "useInactive" in HSS data mode + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse18sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest18sp1. + The following elements are only used in AS data mode: + holdAnnouncementMethod + The following elements are only used in HSS data mode: + enable3G4GContinuity + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the system Third-Party IMP service attributes. + The response is either SystemThirdPartyIMPGetResponse or ErrorResponse. + + Replaced by SystemThirdPartyIMPGetRequest19. + + + + + + + + + + + Response to the SystemThirdPartyIMPGetRequest. + The response contains the system Third-Party IMP service attributes. + + Replaced by SystemThirdPartyIMPGetResponse. + + + + + + + + + + + + + + + + Request the system level data associated with Third-party Voice Mail Support. + The response is either a SystemThirdPartyVoiceMailSupportGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemThirdPartyVoiceMailSupportGetRequest. + + + + + + + + + + + + + + + Add a Hunt Group instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in HSS data mode: + allowMembersToControlGroupBusy, use value "false" in AS data mode + enableGroupBusy, use value "false" in AS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Add a Hunt Group instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting, use value "true" in HSS data mode + includeHuntGroupNameInCLID, use value "true" in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse17sp1V1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupHuntGroupGetInstanceRequest17sp1V1. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight". + The following elements are only used in HSS data mode: + allowMembersToControlGroupBusy + enableGroupBusy + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse17sp4 or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to GroupHuntGroupGetInstanceRequest17sp4. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight", "Phone Number", + "Extension", "Department", "Email Address". + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting + includeHuntGroupNameInCLID + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified system access device. + The response is either SystemAccessDeviceGetResponse16 or ErrorResponse. + + Replaced by: SystemAccessDeviceGetRequest19 + + + + + + + + + + + + + + + Response to SystemAccessDeviceGetRequest16 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified service provider access device. + The response is either ServiceProviderAccessDeviceGetResponse16 or ErrorResponse. + + Replaced by: ServiceProviderAccessDeviceGetRequest19 + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceGetRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified group access device. + The response is either GroupAccessDeviceGetResponse16 or ErrorResponse. + + Replaced by: GroupAccessDeviceGetRequest18sp1 + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetRequest16. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's call center settings and the list of call centers the specified user belongs to. + The response is either a UserCallCenterGetResponse17 or an ErrorResponse. + + Replaced by UserCallCenterGetRequest17sp4. + + + + + + + + + + + + + + + Response to the UserCallCenterGetRequest17. + Contains the user's call center settings. + Indicates whether the agent is current available (logged in) to each call center in the list. + Contains a table with column headings: "Service User Id", "Phone Number", "Extension", "Available", "Logoff Allowed", "Type", and "Priority". + + Replaced by UserCallCenterGetResponse17sp4. + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's call center settings and the list of call centers the specified user belongs to. + The response is either a UserCallCenterGetResponse17sp4 or an ErrorResponse. + + Replaced by UserCallCenterGetRequest19 + + + + + + + + + + + + + + + Response to the UserCallCenterGetRequest17sp4. + Contains the user's call center settings. + Indicates whether the agent is current available (logged in) to each call center in the list. + Contains a table with column headings: "Service User Id", "Phone Number", "Extension", "Available", "Logoff Allowed", + "Type", and "Priority". + + Replaced by UserCallCenterGetResponse19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modifies the agents call center settings and the availability for an agent in one or more Call Centers. + Contains a list specifying the desired availability status of one or more call centers. + A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. + Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by UserCallCenterModifyRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modifies the agents call center settings and the availability for an agent in one or more Call Centers. + Contains a list specifying the desired availability status of one or more call centers. + A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. + Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by UserCallCenterModifyRequest19. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse17sp4 + or an ErrorResponse. + + Replaced by SystemSubscriberGetCallProcessingParametersRequest18sp1. + + + + + + + + + + + + + true + false + + + Response to the SystemSubscriberGetCallProcessingParametersRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Meet-Me Conferencing bridge to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Meet-Me Conferencing bridge. + The response is either GroupMeetMeConferencingGetInstanceResponse18 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupMeetMeConferencingGetInstanceRequest18. + Contains the service profile information and a table of assigned hosts. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Meet-Me conference. + The response is either UserMeetMeConferencingAddConferenceResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingAddConferenceRequest. + + + + + + + + + + + + + + + + true + false + + + Get the information of a conference owned by the user. + The response is either UserMeetMeConferencingGetConferenceResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingGetConferenceRequest. + Contains the information of a conference. + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the system voice portal Menus setting. + The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse18 or ErrorResponse. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusRequest19 + + + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessagingGroupGetVoicePortalMenusRequest18. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusResponse19 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the system voice portal Menus setting. + The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse18sp1 or ErrorResponse. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1 + + + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessagingGroupGetVoicePortalMenusRequest18sp1. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify the system voice portal menus setting. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the group's passcode rules setting. + The response is either GroupPortalPasscodeRulesGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPortalPasscodeRulesGetRequest. + Contains the group's passcode rules setting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider's passcode rules setting. + The response is either ServiceProviderPortalPasscodeRulesGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderPortalPasscodeRulesGetRequest. + Contains the service provider's passcode rules setting. + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system passcode rules setting. + The response is either SystemPortalPasscodeRulesGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemPortalPasscodeRulesGetRequest. + Contains the system passcode rules setting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in HSS data mode: + enable3G4GContinuity, use value "false" in AS data mode + The following elements are only used in AS data mode: + holdAnnouncementMethod, use value "useInactive" in HSS data mode + supportRFC3398, use value "false" in HSS data mode + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + Replaced by: SystemSIPDeviceTypeAddRequest19. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse19 or ErrorResponse. + + Replaced by: SystemSIPDeviceTypeGetRequest19. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest18sp1V2. + The following elements are only used in AS data mode: + holdAnnouncementMethod + supportRFC3398 + The following elements are only used in HSS data mode: + enable3G4GContinuity + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the information about the specified device type without regard to whether the + type is SIP or MGCP. + The response is either SystemDeviceTypeGetResponse18 or ErrorResponse. + Note: The elements deviceTypeConfigurationOption applies to SIP device types only. Therefore, only present in the response when the device type is SIP. + + Replaced by: SystemSIPDeviceTypeGetRequest19. + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetRequest18. + + + + + + + + + + + + + + + + + + + + + + + + Request to get the user information. The response is either + UserGetResponse18 or ErrorResponse. + + Replaced by: UserGetRequest19. + + + + + + + + + + + + + + + Response to UserGetRequest18. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + The following data elements are only used in AS data mode: + contact[2]-contact[5] + + The country code (countryCode) included is the user's phone number country code when the user has a phone number assigned, or the + user's Group associated country code when the user does not have a phone number assigned, or the system default country code when the + user's Group does not have an associated country code. + + The nationalPrefix in this response is the one associated to the included countryCode. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the list of available access devices for assignment to a user + within a group. The list includes devices created at the system, service provider, and group levels. + The response is either GroupAccessDeviceGetAvailableDetailListResponse14 or + ErrorResponse. + + Replaced by: GroupAccessDeviceGetAvailableDetailListRequest19. + + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetAvailableDetailListRequest14. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of CAP system parameters. + The response is either SystemCAPParametersGetResponse14sp3 or ErrorResponse. + + Replaced by SystemCAPParametersGetRequest19 + + + + + + + + + + + + + true + false + + + Response to SystemCAPParametersGetListRequest14sp3. + Contains a list of system CAP parameters. + + Replaced by SystemCAPParametersGetResponse19 + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify CAP system parameters. + The response is either SuccessResponse or ErrorResponse. + + Replaced by SystemCAPParametersModifyRequest19 + + + + + + + + + + + + + + + + + + + + + + Requests a list of non-obsolete Identity/device profile types defined in the system. It is possible + to get either all conference device types or all non-conferernce types. This command is similar + to the SystemSIPDeviceTypeGetListRequest and SystemMGCPDeviceTypeGetListRequest + but gets both SIP and MGCP types. + The response is either SystemDeviceTypeGetlAvailableListResponse14sp1 or ErrorResponse. + + Replaced by: SystemDeviceTypeGetAvailableListRequest19. + + + + + + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetAvailableListRequest14sp3. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's Video Add-On service setting. + The response is either a UserVideoAddOnGetResponse14 or an ErrorResponse. + + Replaced by: UserVideoAddOnGetRequest19. + + + + + + + + + + + + + + + Response to the UserVideoAddOnGetRequest14. + + + + + + + + + + + + + + + + + Get a Music On Hold data for a group or department instance. + The response is either GroupMusicOnHoldGetInstanceResponse16 or ErrorResponse. + + Replaced by: GroupMusicOnHoldGetInstanceRequest19. + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetInstanceRequest16. + + + + + + + + + + + + + + + + + + + + + + Get a route point's announcement settings. + The response is either a GroupRoutePointGetAnnouncementResponse or an ErrorResponse. + + Replaced by: GroupRoutePointGetAnnouncementRequest19. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetAnnouncementRequest. + + + + + + + + + + + + + + + Get a call center's announcement settings. + The response is either a GroupCallCenterGetAnnouncementResponse17sp4 or an ErrorResponse. + + Replaced by: GroupCallCenterGetAnnouncementRequest19. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAnnouncementRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's DNIS Announcements + The response is either a GroupRoutePointGetDNISAnnouncementResponse or an ErrorResponse. + + Replaced by: GroupRoutePointGetDNISAnnouncementRequest19. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetDNISAnnouncementRequest. + + + + + + + + + + + + + + + Get a call center's DNIS Announcements + The response is either a GroupCallCenterGetDNISAnnouncementRequest17sp4 or an ErrorResponse. + + Replaced by: GroupCallCenterGetDNISAnnouncementRequest19. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDNISAnnouncementResponse17sp4. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Add a Auto Attendant instance to a group. + The domain is required in the serviceUserId. + Only Group and Enterprise level schedules are accepted. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Meet-Me Conferencing functions. + The response is either a SystemMeetMeConferencingGetResponse18 or an ErrorResponse. + + Replaced by SystemMeetMeConferencingGetRequest19 + + + + + + + + + + + + + true + false + + + Response to SystemMeetMeConferencingGetRequest18. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Estimated Wait Message Options + + Replaced by EstimatedWaitMessageOptionsRead17sp4 + + + + + + + + + + + + + + + + + Access device end point that can have multiple contacts. + + Replaced by AccessDeviceMultipleContactEndpointRead19. + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + Replaced by: MusicOnHoldSourceRead19. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the call center media on hold source configuration. + + Replaced by: CallCenterMediaOnHoldSourceRead19. + + + + + + + + + + + + + + + + + + + Call Center Reporting Server Description. + + + + + + + + + + Call Center Reporting Server Name. + + + + + + + + + + + Call center report server choice. + + Replaced by CallCenterReportServerChoice19 + + + + + + + + + + + + + Call center report web statistics source. + + + + + + + + + + + + CAPServerCallCenter to number of client connections. + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during after business hours. + + + + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during after business hours. + + + + + + + + + + + + + + + + + The configuration of a key for Auto Attendant. + + + + + + + + + + + + The read configuration of a key for Auto Attendant. + + + + + + + + + + + + The configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: + audioFile + videoFile + + + + + + + + + + + + + + + The read configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: + audioFileDescription + audioMediaType + videoFileDescription + videoMediaType + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDeprecated19.xsd b/share/OCISchemaAS/OCISchemaDeprecated19.xsd new file mode 100644 index 0000000..ca63724 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDeprecated19.xsd @@ -0,0 +1,7862 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to add a session admission control group for the enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get a session admission control group for the enterprise. + The response is either an EnterpriseSessionAdmissionControlGroupGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to EnterpriseSessionAdmissionControlGroupGetRequest. + Returns the profile information for the session admission control group. + + + + + + + + + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse18 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest18. + Contains the policy settings for the group administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupAdminGetPolicyRequest19sp1. + Contains the policy settings for the group administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + communicationBarringUserProfileAccess (This element will not be returned in the response for Service Provider group administrators) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to get all the information of a Auto Attendant instance. + The response is either GroupAutoAttendantGetInstanceResponse19 or ErrorResponse. + + Replaced by: GroupAutoAttendantGetInstanceRequest19sp1 + + + + + + + + + + + + + + + true + true + + + Response to GroupAutoAttendantGetInstanceRequest19. + Contains the service profile information. + + + The following elements are only used in AS data mode: + type, use AutoAttendantType.BASIC in HSS mode. + holidayMenu. + The following elementsare only valid for Standard Auto + Attendants: + holidayMenu + + Replaced by: GroupAutoAttendantGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Auto Attendant instance. + The response is either GroupAutoAttendantGetInstanceResponse19sp1 or ErrorResponse. + + Replaced by: GroupAutoAttendantGetInstanceRequest20 + + + + + + + + + + + + + + + true + false + + + Response to GroupAutoAttendantGetInstanceRequest19sp1. + Contains the service profile information. + + + The following elements are only used in AS data mode: + type, use AutoAttendantType.BASIC in HSS mode. + holidayMenu. + The following elementsare only valid for Standard Auto + Attendants: + holidayMenu + + Replaced by: GroupAutoAttendantGetInstanceResponse20 + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify an Auto Attendant instance. + Only Group and Enterprise level schedules are + accepted. + The + response is either SuccessResponse or ErrorResponse. + + The + following elements are only used in AS data + mode: + holidayMenu. + The following elementsare only valid for Standard Auto + Attendants: + holidayMenu + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a BroadWorks Anywhere instance. + The response is either GroupBroadWorksAnywhereGetInstanceResponse17 or ErrorResponse. + + Replaced by: GroupBroadWorksAnywhereGetInstanceRequest19sp1 + + + + + + + + + + + + + + + Response to GroupBroadWorksAnywhereGetInstanceRequest17. + Contains the service profile information. + + Replaced by: GroupBroadWorksAnywhereGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse19 or ErrorResponse. + + Replaced by: GroupCallCenterGetInstanceRequest19sp1 + + + + + + + + + + + + + + + true + false + + + Response to GroupCallCenterGetInstanceRequest19. + + Replaced by: Response to GroupCallCenterGetInstanceRequest19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the properties of the DNH service for a specified serviceUserId. + It gets the agents of a call center or hunt group that are members + of a directory number hunting group. They are agents that are not already + assigned to any other directory number hunting group. + The response is either GroupDirectoryNumberHuntingGetResponse or ErrorResponse. + + Replaced by: GroupDirectoryNumberHuntingGetRequest17sp1 + + + + + + + + + + + + + + + Response to the GroupDirectoryNumberHuntingGetRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + Replaced by: GroupDirectoryNumberHuntingGetResponse17sp1 + + + + + + + + + + + + + + + Request to get all the information of a Find-me/Follow-me instance. + The response is either GroupFindMeFollowMeGetInstanceResponse or ErrorResponse. + + Replaced by: GroupFindMeFollowMeGetInstanceRequest19sp1 + + + + + + + + + + + + + + + Response to GroupFindMeFollowMeGetInstanceRequest. + Contains the service profile information. + + Replaced by: GroupFindMeFollowMeGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Group Paging instance. + The response is either GroupGroupPagingGetInstanceResponse17sp3 or ErrorResponse. + + Replaced by: GroupGroupPagingGetInstanceRequest19sp1 + + + + + + + + + + + + + + + true + false + + + Response to GroupGroupPagingGetInstanceRequest17sp3. + Contains the service profile information. + + Replaced by: GroupGroupPagingGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + + true + true + + + Add a Hunt Group instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting, use value "true" in HSS data mode + includeHuntGroupNameInCLID, use value "true" in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse19 or ErrorResponse. + + Replaced by: GroupHuntGroupGetInstanceRequest19sp1 + + + + + + + + + + + + + + + true + true + + + Response to GroupHuntGroupGetInstanceRequest19. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight", "Phone Number", + "Extension", "Department", "Email Address". + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting + includeHuntGroupNameInCLID + + The following elements are only used in HSS data mode: + allowMembersToControlGroupBusy + enableGroupBusy + + Replaced by: GroupHuntGroupGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse19sp1 or ErrorResponse. + + Replaced by: GroupHuntGroupGetInstanceRequest20 + + + + + + + + + + + + + + + true + true + + + Response to GroupHuntGroupGetInstanceRequest19sp1. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight", "Phone Number", + "Extension", "Department", "Email Address". + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting + includeHuntGroupNameInCLID + + The following elements are only used in HSS data mode: + allowMembersToControlGroupBusy + enableGroupBusy + + Replaced by: GroupHuntGroupGetInstanceResponse20 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of an Instant Group Call service instance. + The response is either GroupInstantGroupCallGetInstanceResponse17 or ErrorResponse. + + Replaced by: GroupInstantGroupCallGetInstanceRequest19sp1 + + + + + + + + + + + + + + + Response to GroupInstantGroupCallGetInstanceRequest17. + Contains the service profile information and a list of phone numbers. + + Replaced by: GroupInstantGroupCallGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Meet-Me Conferencing bridge. + The response is either GroupMeetMeConferencingGetInstanceResponse19 or ErrorResponse. + + Replaced by: GroupMeetMeConferencingGetInstanceRequest19sp1 + + + + + + + + + + + + + + + true + false + + + Response to GroupMeetMeConferencingGetInstanceRequest19. + Contains the service profile information and a table of assigned hosts. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", Phone Number", "Extension", "Department", "Email Address". + + Replaced by: GroupMeetMeConferencingGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a Route Point instance. + The response is either GroupRoutePointGetInstanceResponse or ErrorResponse. + + Replaced by: GroupRoutePointGetInstanceRequest19sp1 + + + + + + + + + + + + + + + Response to GroupRoutePointGetInstanceRequest. + + Replaced by: GroupRoutePointGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the group voice portal information for a voice messaging group. + The response is either GroupVoiceMessagingGroupGetVoicePortalResponse17sp4 or ErrorResponse. + + Replaced by: GroupVoiceMessagingGroupGetVoicePortalRequest19sp1 + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalRequest17sp4. + + The following elements are only used in HSS data mode: + enableExtendedScope + + Replaced by: GroupVoiceMessagingGroupGetVoicePortalResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a VoiceXML instance. + The response is either GroupVoiceXmlGetInstanceResponse or ErrorResponse. + + Replaced by: GroupVoiceXmlGetInstanceRequest19sp1 + + + + + + + + + + + + + + + Response to GroupVoiceXmlGetInstanceRequest. + Contains the service profile information and possibly access device information. + + Replaced by: GroupVoiceXmlGetInstanceResponse19sp1 + + + + + + + + + + + + + + + + + Get an existing Network Class of Service. + The response is either a SystemNetworkClassOfServiceGetResponse17 + or an ErrorResponse. + + Replaced by SystemNetworkClassOfServiceGetRequest19sp1 + + + + + + + + + + + + + + + Response to the SystemNetworkClassOfServiceGetRequest17. + The response contains the Network Class of Service information. + + Replaced by SystemNetworkClassOfServiceGetResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in HSS data mode: + enable3G4GContinuity, use value "false" in AS data mode + The following elements are only used in AS data mode: + holdAnnouncementMethod, use value "useInactive" in HSS data mode + supportRFC3398, use value "false" in HSS data mode + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + Replaced by: SystemSIPDeviceTypeAddRequest19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in HSS data mode: + enable3G4GContinuity, use value "false" in AS data mode + The following elements are only used in AS data mode: + holdAnnouncementMethod, use value "useInactive" in HSS data mode + supportRFC3398, use value "false" in HSS data mode + bypassMediaTreatment, use value "false" in HSS data mode + + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + Replaced by: SystemSIPDeviceTypeAddRequest20 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse19 or ErrorResponse. + + Replaced by: SystemSIPDeviceTypeGetRequest19sp1 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest19. + The following elements are only used in AS data mode: + holdAnnouncementMethod + supportRFC3398 + The following elements are only used in HSS data mode: + enable3G4GContinuity + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold + + Replaced by: SystemSIPDeviceTypeGetResponse19sSp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse19sp1 or ErrorResponse. + + Replaced by: SystemSIPDeviceTypeGetRequest20 + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetRequest19sp1. + The following elements are only used in AS data mode: + holdAnnouncementMethod + supportRFC3398 + bypassMediaTreatment + + The following elements are only used in HSS data mode: + enable3G4GContinuity + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold + + Replaced by: SystemSIPDeviceTypeGetResponse20 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the list of time zone names. + The response is either SystemTimeZoneGetListResponse or ErrorResponse. + + Replaced by SystemTimeZoneGetListRequest20. + + + + + + + + + + + + + Response to SystemTimeZoneGetListRequest. + Contains a 2 column table with column headings 'Key' and 'Display Name' and a row + for each time zone. + + Replaced by SystemTimeZoneGetListResponse20 + + + + + + + + + + + + + + + Request the system level data associated with Voice Messaging. + The response is either a SystemVoiceMessagingGroupGetResponse16sp2 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemVoiceMessagingGroupGetRequest16sp2. + + The following elements are only used in AS data mode: + realDeleteForImap + useDnInMailBody + useShortSubjectLine + maxMessageLengthMinutes + maxMailboxLengthMinutes + doesMessageAge + holdPeriodDays + mailServerNetAddress + mailServerProtocol + defaultDeliveryFromAddress + defaultNotificationFromAddress + useOutgoingMWIOnSMDI + mwiDelayInSeconds + voicePortalScope + enterpriseVoicePortalLicensed + networkWideMessaging + useExternalRouting + defaultExternalRoutingAddress + vmOnlySystem + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the system voice portal Menus setting. + The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse19 or ErrorResponse. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1 + + + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessagingGroupGetVoicePortalMenusRequest19. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the system voice portal Menus setting. + The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse19sp1 or ErrorResponse. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusRequest20 + + + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1. + + Replaced by SystemVoiceMessagingGroupGetVoicePortalMenusResponse20 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to add a session admission control group for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get a session admission control group for the group. + The response is either a GroupSessionAdmissionControlGroupGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to GroupSessionAdmissionControlGroupGetRequest. + Returns the profile information for the session admission control group. + + + + + + + + + + + + + + + + + + + + + + + Add a new Communication Barring Profile. + The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the add. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + callMeNowDefaultAction, use value "Block" in HSS data mode + callMeNowDefaultCallTimeout + callMeNowRule + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a ServiceProviderCommunicationBarringProfileGetResponse17sp3 + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the ServiceProviderCommunicationBarringProfileGetRequest17sp3. + The response contains the Communication Barring Profile information. + The incoming, originating, redirecting and call me now rules are returned in ascending priority order. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a new Communication Barring Profile. + The priorities for IncomingRules are requantized to consecutive integers as part of the add. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + callMeNowDefaultAction, use value "Block" in HSS data mode + callMeNowDefaultCallTimeout + callMeNowRule + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a SystemCommunicationBarringProfileGetResponse17sp3 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetRequest17sp3. + The response contains the Communication Barring Profile information. + The incoming rules are returned in ascending priority order. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest19sp1. + Contains the default policy settings for the system. + The following elements are only used in AS data mode: + GroupAdminDialableCallerIDAccess + ServiceProviderAdminDialableCallerIDAccess + GroupAdminCommunicationBarringUserProfileAccess (This element is only used for groups in an Enterprise) + The following elements are only used in HSS data mode: + serviceProviderAdminCommunicationBarringAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the user level data associated with Device Policy. + The response is either a UserDevicePoliciesGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserDevicePoliciesGetRequest. enableDeviceFeatureSynchronization is ignored by the application server in Multiple User Shared mode. + + + + + + + + + + + + + + + + Get the user's voice messaging greeting information. + The response is either a UserVoiceMessagingUserGetGreetingResponse18 or an ErrorResponse. + + Replaced by UserVoiceMessagingUserGetGreetingRequest18sp1 + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetGreetingRequest18. + Contains the greeting configuration for a user's voice messaging. + The following elements are only used in AS data mode: + disableMessageDeposit + disableMessageDepositAction + greetingOnlyForwardDestination + + Replaced by UserVoiceMessagingUserGetGreetingResponse18sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a group device profile file. + The response is either GroupAccessDeviceFileGetResponse16sp1 or ErrorResponse. + + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceFileGetRequest16sp1. + + + + + + + + + + + + + + + + + + + Request to get a service provider device profile file. + The response is either ServiceProviderAccessDeviceFileGetResponse16sp1 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceFileGetRequest16sp1. + + + + + + + + + + + + + + + + + + + Request to get a device profile file. + The response is either SystemAccessDeviceFileGetResponse16sp1 or ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemAccessDeviceFileGetRequest16sp1. + + + + + + + + + + + + + + + + + + + Add a new file repository. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Request to get the file repository information. The response is either SystemFileRepositoryDeviceGetResponse16 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemFileRepositoryDeviceGetRequest16. + + + + + + + + + + + + + + + + + + + + Request to add a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a sip device type file. + The response is either SystemSIPDeviceTypeFileGetResponse19 or ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeFileGetRequest19. + Take note: + + 1. accessUrl may have undefined content. + When it is the case, undefined content is put between []. + It may also be set to "Error Access FQDN Not Provisioned" when the access FQDN is not set, + or "Error Access Context Name Not Provisioned" when the context name is not set. + + 2. repositoryUrl may be set to "DEVICE_CONFIGURATION_FILE_REPOSITORY_MISSING", if there is no file repository defined. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse18 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetPolicyRequest18. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess and numberActivationAccess are returned only for the enterprise administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of CPE Config system parameters. + The response is either SystemCPEConfigParametersGetResponse14sp6 or ErrorResponse. + + + + + + + + + + + + + Response to SystemCPEConfigParametersGetListRequest14sp6. + Contains a list of system CPE Config parameters. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify CPE Config system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a call processing policy profile to system. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by SystemCallProcessingPolicyProfileAddRequest20. + + + + + + + + + + + + + + + + + true + false + + + Request to get a call processing policy profile in system. + The response is either a SystemCallProcessingPolicyProfileGetResponse or an ErrorResponse. + + Replaced by SystemCallProcessingPolicyProfileGetRequest20. + + + + + + + + + + + + + + + true + false + + + Response to a SystemCallProcessingPolicyProfileGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify a call processing policy profile in system. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by SystemCallProcessingPolicyProfileModifyRequest20. + + + + + + + + + + + + + + + + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse18 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPolicyGetDefaultRequest18. + Contains the default policy settings for the system. + The following elements are only used in AS data mode: + GroupAdminDialableCallerIDAccess + ServiceProviderAdminDialableCallerIDAccess + The following elements are only used in HSS data mode: + serviceProviderAdminCommunicationBarringAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get group FAC code level and the list of feature access codes for a group. + The response is either a GroupFeatureAccessCodeGetResponse or an ErrorResponse. + Returned Feature Access Codes may be group specific, or Service Provider Feature Access Codes, depending on FAC code level. + + + + + + + + + + + + + + + + Response to the GroupFeatureAccessCodeGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify group FAC code level and the list of feature access codes for a group. + The response is either a SuccessResponse or an ErrorResponse. + + Note: choice element is only valid when useFeatureAccessCodeLevel is set + to "Group", otherwise an ErrorResponse will be returned. + + + + + + + + + + + + + + + + + + + + + Get the list of feature access codes for a service provider or enterprise. + The response is either a ServiceProviderFeatureAccessCodeGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderFeatureAccessCodeGetListRequest. + + + + + + + + + + + + + + + true + false + + + Modify a list of feature access codes for a service provider or enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get list of default Feature Access Codes defined on system level. + The response is either SystemFeatureAccessCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to the SystemFeatureAccessCodeGetListRequest. + + + + + + + + + + + + + + + Modify default Feature Access Codes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the Call Recording attributes for a user. + The response is either a UserCallRecordingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserCallRecordingGetRequest. + The response contains the user's Call Recording option information. + + + + + + + + + + + + + + + Get the list of feature access codes for a user. + The response is either a UserFeatureAccessCodeGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserFeatureAccessCodeGetListRequest. + + + + + + + + + + + + + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse18 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowDepartmentCLIDNameOverride) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowDepartmentCLIDNameOverride + + Replaced By : GroupCallProcessingGetPolicyRequest18sp1 + + + + + + + + + + + + + + + + Response to GroupCallProcessingGetPolicyRequest18. + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + allowDepartmentCLIDNameOverride + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse18sp1 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowDepartmentCLIDNameOverride) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowDepartmentCLIDNameOverride + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + Replaced by: GroupCallProcessingGetPolicyRequest19sp1 + + + + + + + + + + + + + + + + true + true + + + Response to GroupCallProcessingGetPolicyRequest18. + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + allowDepartmentCLIDNameOverride + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + Replaced by: GroupCallProcessingGetPolicyResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse17sp4 or an ErrorResponse. + Replaced By : ServiceProviderCallProcessingGetPolicyRequest18sp1 + + + + + + + + + + + + + + + Response to ServiceProviderCallProcessingGetPolicyRequest17sp4. + The following elements are only used in AS data mode: + useServiceProviderDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse18sp1 or an ErrorResponse. + + Replaced by: ServiceProviderCallProcessingGetPolicyRequest19sp1 + + + + + + + + + + + + + + + true + true + + + Response to ServiceProviderCallProcessingGetPolicyRequest18sp1. + The following elements are only used in AS data mode: + useServiceProviderDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + Replaced by: ServiceProviderCallProcessingGetPolicyResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The response is either a SystemCallProcessingGetPolicyResponse17sp4 or an + ErrorResponse. + Replaced By : SystemCallProcessingGetPolicyRequest18sp1 + + + + + + + + + + + + + Response to SystemCallProcessingGetPolicyRequest17sp4. + The following elements are only used in AS data mode: + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + The response is either a SystemCallProcessingGetPolicyResponse18sp1 or an + ErrorResponse. + + Replaced by: SystemCallProcessingGetPolicyRequest19sp1 + + + + + + + + + + + + + true + true + + + Response to SystemCallProcessingGetPolicyRequest18sp1. + The following elements are only used in AS data mode: + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + enterpriseCallsCLIDPolicy + enterpriseGroupCallsCLIDPolicy + serviceProviderGroupCallsCLIDPolicy + + Replaced by: SystemCallProcessingGetPolicyResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Trunk Group instance to a group. + The command will fail if enableNetworkAddressIdentity is set to + true and administrator is not System/Provisioning level administrator. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by GroupTrunkGroupAddInstanceRequest19sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse19 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address". + + Replaced by GroupTrunkGroupGetInstanceRequest19sp1. + + + + + + + + + + + + + + + true + false + + + Response to GroupTrunkGroupGetInstanceRequest19. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department", "Email Address". + + Replaced by GroupTrunkGroupGetInstanceResponse19sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse19sp1 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address". + + Replaced by GroupTrunkGroupGetInstanceRequest19sp1V2. + + + + + + + + + + + + + + + true + false + + + Response to GroupTrunkGroupGetInstanceRequest19sp1. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department", "Email Address". + + Replaced by GroupTrunkGroupGetInstanceResponse19sp1V2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse19V2 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address". + + Replaced by GroupTrunkGroupGetInstanceRequest19sp1V2. + + + + + + + + + + + + + + + true + false + + + Response to GroupTrunkGroupGetInstanceRequest19V2. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department", "Email Address". + + Replaced by GroupTrunkGroupGetInstanceResponse19sp1V2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify a Trunk Group Instance in a group. + The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. + The command will fail if enableNetworkAddressIdentity is set and + administrator is not System/Provisioning level administrator. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by GroupTrunkGroupModifyInstanceRequest19sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with the Trunk Group service. + The response is either SystemTrunkGroupGetResponse or ErrorResponse. + + Replaced by SystemTrunkGroupGetRequest19sp1. + + + + + + + + + + + + + true + false + + + Response to SystemTrunkGroupGetRequest. + + Replaced by SystemTrunkGroupGetResponse19sp1. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the broadworks mobility system parameters. + The response is either a SystemBroadWorksMobilityGetResponse17sp4 or an ErrorResponse. + Replaced by: SystemBroadWorksMobilityGetRequest19sp1 + + + + + + + + + + + + + true + false + + + The response to a SystemBroadWorksMobilityGetRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the service provider BroadWorks Mobility service settings. + The response is either a ServiceProviderBroadWorksMobilityGetResponse or an ErrorResponse. + Replaced by: ServiceProviderBroadWorksMobilityGetRequest19sp1 + + + + + + + + + + + + + + + true + false + + + The response to a ServiceProviderBroadWorksMobilityGetRequest. + + + + + + + + + + + + + + + + + + + + true + false + + + Get the groups BroadWorks Mobility settings. + The response is either a GroupBroadWorksMobilityGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + The response to a GroupBroadWorksMobilityGetRequest. + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Call Recording platform. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Policies. + The response is either a UserCallPoliciesGetResponse17 + or an ErrorResponse. + + Replaced by: UserCallPoliciesGetRequest19sp1 + + + + + + + + + + + + + + + Response to UserCallPoliciesGetRequest17. + + Replaced by: UserCallPoliciesGetResponse19sp1 + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse18 or an + ErrorResponse. + + Replaced by: UserCallProcessingGetPolicyRequest19sp1 + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest18. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + The following elements are only used in AS data mode: + useUserDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + allowDepartmentCLIDNameOverride + + Replaced by: UserCallProcessingGetPolicyResponse19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the user information. The response is either + UserGetResponse19 or ErrorResponse. + + + + + + + + + + + + + + + Response to UserGetRequest19. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + The following data elements are only used in AS data mode: + contact[2]-contact[5] + + The country code (countryCode) included is the user's phone number country code when the user has a phone number assigned, or the + user's Group associated country code when the user does not have a phone number assigned, or the system default country code when the + user's Group does not have an associated country code. + + The nationalPrefix in this response is the one associated to the included countryCode. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the Group's policy settings. + The response is either GroupPolicyGetResponse17 or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPolicyGetRequest17. + Contains the policy settings for the group. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the information of a conference owned by the user. + The response is either UserMeetMeConferencingGetConferenceResponse19 or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingGetConferenceRequest19. + Contains the information of a conference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Add a Auto Attendant instance to a group. + The domain is required in the serviceUserId. + Only Group and Enterprise level schedules are accepted. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + type, use AutoAttendantType.BASIC in HSS mode. + holidayMenu. + The following elements are only valid for Standard Auto + Attendants: + holidayMenu + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system's calling name retrieval attributes. + The response is either a SystemCallingNameRetrievalGetResponse17sp4 or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallingNameRetrievalGetRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + + + Modifies the system's calling name retrieval attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Access device end point that can have multiple contacts. + Port numbers are only used by devices with static line ordering. + + Replaced by AccessDeviceMultipleContactEndpointRead20. + + + + + + + + + + + + + + + + Recording Service Configuration. + + + + + + + + + + + + + The configuration of the automated receptionist + greeting + prompt and dialing menu to be used during + after business + hours. + + + + + + + + + + + + + + + The configuration of the automated receptionist + greeting + prompt and dialing menu to be used during + after business + hours. + + + + + + + + + + + + + + + + + The configuration of a key for Auto Attendant. + + + + + + + + + + + + The read configuration of a key for Auto + Attendant. + + + + + + + + + + + + The configuration entry of a key for Auto + Attendant. + The following data elements are only used in + AS data + mode: + audioFile + videoFile + submenuId + The following data elements are only valid for Standard Auto + Attendants: + submenuId + + + + + + + + + + + + + + + + The read configuration entry of a key for Auto + Attendant. + The following data elements are only + used in AS data + mode: + audioFileDescription + audioMediaType + videoFileDescription + videoMediaType + submenuId + The following + data elements are only valid for Standard Auto + Attendants: + submenuId + + + + + + + + + + + + + + + + + + true + false + + + Request to get an Auto Attendant submenu instance. + The response is either GroupAutoAttendantSubmenuGetResponse or ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + + true + false + + + Response to GroupAutoAttendantSubmenuGetRequest. + Contains AutoAttendant submenu information. + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify an Auto Attendant submenu + instance. + The response is either SuccessResponse or + ErrorResponse. + This request is only valid for Standard auto + attendants. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to add an Auto Attendant submenu + instance. + The response is either SuccessResponse or + ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + + + + + + + Contains the call center media on hold source + configuration. + + + + + + + + + + + + + + + + + + Modify a call center's comfort message bypass + settings. + The response is either a SuccessResponse + or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's holiday service settings. + Only Group and Enterprise level schedules are + accepted. + The + response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's announcement settings. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center DNIS announcement settings. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's stranded call settings. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's overflow settings. + The + response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's stranded calls - + unavailable settings. + The response is either a + SuccessResponse or + an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group's custom ring back service + settings. + The response is either a SuccessResponse or + an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold user source + configuration. + + + + + + + + + + + + + + + + + + + + Add a Music on Hold Instance to a department. + The response is either SuccessResponse or + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Modify data for a group or department Music On + Hold Instance. + The response is either + SuccessResponse or + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Modify data for Music On Hold User. + The response + is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + Modify the group level pre-alerting service + settings. + The response is either a SuccessResponse or + an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Modify the user's pre-alerting service setting. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modify a route point's forced forwarding + settings. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Modify the group's voice portal branding + settings. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Modify an existing custom greeting audio file. + The response is either SuccessResponse or + ErrorResponse. + + + + + + + + + + + + + + + + + + Modify a route point's holiday service settings. + Only Group and Enterprise level schedules are accepted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a route point DNIS announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a route point's night service settings. + Only Group and Enterprise level schedules are accepted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the user level data associated with Device Policy. + The response is either a UserDevicePoliciesGetResponse19sp1 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserDevicePoliciesGetRequest19sp1. enableDeviceFeatureSynchronization is ignored by the application server in Multiple User Shared mode. + + + + + + + + + + + + + + + + + + + + + + + Request users' call logs within an enterprise + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either an EnterpriseEnhancedCallLogsGetListResponse17sp4 or an ErrorResponse. + The following elements are only used in AS data mode: + callAuthorizationCodeFilter + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterpriseEnhancedCallLogsGetListRequest17sp4. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the EnterpriseEnhancedCallLogsGetListRequest17sp4, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry17sp4 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The result is sorted by date/time of the call. + + + + + + + + + + + + + + + + Request users' call logs within a group + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl.If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a GroupEnhancedCallLogsGetListResponse17sp4 or an ErrorResponse. + The following elements are only used in AS data mode: + callAuthorizationCodeFilter + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupEnhancedCallLogsGetListRequest17sp4. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the GroupEnhancedCallLogsGetListRequest17sp4, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry17sp4 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The logs are sorted by date/time of the call. + + + + + + + + + + + + + + + + Request user's call logs. + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When + "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including + placed will be returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a UserEnhancedCallLogsGetListResponse17sp4V2 or an ErrorResponse. + The following elements are only used in AS data mode: + callAuthorizationCodeFilter + + + + + + + + + + + + + + + + + + + + + + + Response to UserEnhancedCallLogsGetListRequest17sp4V2. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest17sp4V2, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of MixedCallLogsEntry will be returned if the call logs are stored on CDS + A list of ExtendedMixedCallLogsEntry17sp4 will be returned if the call logs are stored on DBS + The logs are sorted by date/time of the call. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's overflow settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Extended Call Log entry describing a placed, received, or missed call. + "countryCode" is the user's country code + The following time elements are represented as timestamp, i.e., the number of milliseconds + since January 1, 1970, 00:00:00 GMT. + "startTime" represents the time when the system sends out a call invitation message (e.g. for + placed calls) or receives a call invitation message (e.g. for missed/received calls). + "answerTime" represents the time when the call is answered by the terminating party. + "detachTime" represents the time when the call is successfully redirected by the system. + "releaseTime" represents the time when the call is released. This time corresponds to the + moment the call is released by the system, and not necessarily when one party hangs up, since this + does not always mean the call is released (e.g. Emergency/911 calls). + The elements "userGroupId", "userId","userPrimaryDn" and "userPrimaryExtension" + are only returned when the enterprise or group level requests are used. + + Replaced by ExtendedMixedCallLogsEntry17sp4. + Originally deprecated in release 20. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extended Call Log entry describing a placed, received, or missed call. + "countryCode" is the user's country code + The following time elements are represented as timestamp, i.e., the number of milliseconds + since January 1, 1970, 00:00:00 GMT. + "startTime" represents the time when the system sends out a call invitation message (e.g. for + placed calls) or receives a call invitation message (e.g. for missed/received calls). + "answerTime" represents the time when the call is answered by the terminating party. + "detachedTime" represents the time when the call is successfully redirected by the system. + "releaseTime" represents the time when the call is released. This time corresponds to the + moment the call is released by the system, and not necessarily when one party hangs up, since this + does not always mean the call is released (e.g. Emergency/911 calls). + The elements "userGroupId", "userId","userPrimaryDn" and "userPrimaryExtension" + are only returned when the enterprise or group level requests are used. + The following elements are only used in AS data mode: + callAuthorizationCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Subscriber type + Replaced by EnhancedCallLogsSubscriberType19sp1. + + + + + + + + + + + + + + + + + Service Profile Information for group service. + It is identical to the ServiceInstanceAddProfile, but without the password. + + Replaced by: ServiceInstanceReadProfile17sp4 + + + + + + + + + + + + + + + + + + + + + + + Service Profile Information for group service. + + Replaced by: ServiceInstanceReadProfile19sp1 + + + + + + + + + + + + + + + + + + + + + + + + + Maximum Call Time for Unanswered Calls + + Replaced by: CallProcessingMaxCallTimeForUnansweredCallsMinutes19sp1 + + + + + + + + + + + + Maximum Number of Concurrent Redirected Calls + + Replaced by: CallProcessingMaxConcurrentRedirectedCalls19sp1 + + + + + + + + + + + + Maximum Number of Find Me Follow Me Depth + + Replaced by: CallProcessingMaxFindMeFollowMeDepth19sp1 + + + + + + + + + + + + Maximum Number of Concurrent Find Me/Follow Me Invocations + + Replaced by: CallProcessingMaxConcurrentFindMeFollowMeInvocations19sp1 + + + + + + + + + + + + Maximum Number of Redirections Depth + + Replaced by: CallProcessingMaxRedirectionDepth19sp1 + + + + + + + + + + + + Maximum Number of Simultaneous Calls + + Replaced by: CallProcessingMaxSimultaneousCalls19sp1 + + + + + + + + + + + + Different type of user and virtual subscriber which could have a set of call processing policy profile defined in BroadWorks. + + + + + + + + + + + + + + + + + + + + + + + A list of CallProcessingPolicyProfileSubscriberType. The list replaces a previously configured list. + + + + + + + + + + + Get a call center's comfort message bypass settings. + The response is either a GroupCallCenterComfortMessageBypassGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterComfortMessageBypassGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the call center media on hold source configuration. + + + + + + + + + + + + + + + + + + + + Get a call center's forced forwarding settings. + The response is either a GroupCallCenterForcedForwardingGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterForcedForwardingGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's announcement settings. + The response is either a GroupCallCenterGetAnnouncementResponse19 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAnnouncementRequest19. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's DNIS Announcements + The response is either a GroupCallCenterGetDNISAnnouncementRequest19 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDNISAnnouncementRequest19. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's holiday service settings. + The response is either a GroupCallCenterHolidayServiceGetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterHolidayServiceGetRequest17sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's overflow settings. + The response is either a GroupCallCenterOverflowGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterOverflowGetRequest17 . + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's stranded call settings. + The response is either a GroupCallCenterStrandedCallGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterStrandedCallGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's stranded calls - unavailable settings. + The response is either a GroupCallCenterStrandedCallUnavailableGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterStrandedCallUnavailableGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the group's custom ring back service settings. + The response is either a GroupCustomRingbackGroupGetResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCustomRingbackGroupGetRequest16. + + + + + + + + + + + + + + + + + + + + + + + Get a Music On Hold data for a group or department instance. + The response is either GroupMusicOnHoldGetInstanceResponse19 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetInstanceRequest19. + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Music On Hold User. + The response is either a UserMusicOnHoldUserGetResponse16 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserMusicOnHoldUserGetRequest16. + + + + + + + + + + + + + + + + + + Contains the music on hold user source configuration. + + + + + + + + + + + + + + + + + + + + + + Get the user's pre-alerting service setting. + The response is either a UserPreAlertingAnnouncementGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to a UserPreAlertingAnnouncementGetRequest. + The criteria table's column headings are: "Is Active", "Criteria Name", + "Blacklisted", and "Calls From". + + + + + + + + + + + + + + + + + + + + + + + + Get the group�s PreAlertingservice settings. + The response is either a GroupPreAlertingAnnouncementGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the group level pre-alerting service settings. + The response is either a GroupPreAlertingAnnouncementGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's announcement settings. + The response is either a GroupRoutePointGetAnnouncementResponse19 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetAnnouncementRequest19. + + + + + + + + + + + + + + + Get a route point's overflow settings. + The response is either a GroupRoutePointOverflowGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointOverflowGetRequest . + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's forced forwarding settings. + The response is either a GroupRoutePointForcedForwardingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointForcedForwardingGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's holiday service settings. + The response is either a GroupRoutePointHolidayServiceGetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointHolidayServiceGetRequest17sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's DNIS Announcements + The response is either a GroupRoutePointGetDNISAnnouncementResponse19 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetDNISAnnouncementRequest19. + + + + + + + + + + + + + + + Get a route point's night service settings. + The response is either a GroupRoutePointNightServiceGetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointNightServiceGetRequest17sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the group's voice portal branding settings. + The response is either a GroupVoiceMessagingGroupGetVoicePortalBrandingResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalBrandingRequest16. + + + + + + + + + + + + + + + + + + + + true + false + + + Get the information of a conference custom greeting. + The response is either UserMeetMeConferencingGetConferenceGreetingResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingGetConferenceGreetingRequest. + Contains the information of a conference custom greeting. + + + + + + + + + + + + + + + + + The configuration of the automated receptionist + greeting + prompt and dialing menu to be used during + business + hours. + It is used when modifying an Auto Attendant group. + + + + + + + + + + + + + + + Requests a table of all the existing Call Blocking Service Mappings in the system. + The response is either a SystemTreatmentMappingCallBlockingServicesGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemTreatmentMappingCallBlockingServiceGetListRequest. Contains a table with one row per mapping. + The table columns are: "Service", "Treatment Id". + + + + + + + + + + + + + + + A list of Communication Barring Incoming Rules that replaces a + previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaDeprecated20.xsd b/share/OCISchemaAS/OCISchemaDeprecated20.xsd new file mode 100644 index 0000000..730e881 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaDeprecated20.xsd @@ -0,0 +1,4459 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add an enterprise trunk in an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: EnterpriseEnterpriseTrunkAddRequest21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get an enterprise trunk + The response is either an EnterpriseEnterpriseTrunkGetResponse or an ErrorResponse. + + Replaced by: EnterpriseEnterpriseTrunkGetRequest21 + + + + + + + + + + + + + + + + Response to EnterpriseEnterpriseTrunkGetRequest. + + Replaced by: EnterpriseEnterpriseTrunkGetResponse21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add an enterprise trunk in a group. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: GroupEnterpriseTrunkAddRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get an enterprise trunk + The response is either an GroupEnterpriseTrunkGetResponse or an ErrorResponse. + + Replaced by: GroupEnterpriseTrunkGetRequest21. + + + + + + + + + + + + + + + + + Response to GroupEnterpriseTrunkGetRequest. + + Replaced by: GroupEnterpriseTrunkGetResponse21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of device type files managed by the Device Management System, on a per-group basis. + The response is either GroupDeviceTypeFileGetListResponse14sp8 or ErrorResponse. + Replaced by: GroupDeviceTypeFileGetListRequest21. + + + + + + + + + + + + + + + + + Response to GroupDeviceTypeFileGetListRequest14sp8. + Contains a table of device type files managed by the Device Management System, on a per-group basis. + The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL". + Replaced by: GroupDeviceTypeFileGetListResponset21. + + + + + + + + + + + + + + + + Assign a list of Network Classes of Service to a group. + The Element defaultNetworkClassOfService is required only for the first + assignment, for subsequent assignments it is optional. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Unassign a list of Network Classes of Service from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a list of users within a group that have a given Network Class + of Service assigned. + The response is either a GroupNetworkClassOfServiceGetAssignedUserListResponse + or an ErorResponse. + + Replaced by: GroupNetworkClassOfServiceGetAssignedUserListRequest21 + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupNetworkClassOfServiceGetAssignedUserListRequest. + Contains a table of users that have the Network Class of Service + assigned. The column headings are: "User Id", "User Type", "Last Name", "First Name", + "Department", "Phone Number", "Email Address", "Service Provider Id", + "Group Id", "Hiragana Last Name" and "Hiragana First Name" , "Extension". + + Replaced by GroupNetworkClassOfServiceGetAssignedUserListResponse21 + + + + + + + + + + + + + + + true + false + + + Add a Trunk Group instance to a group. + The command will fail if enableNetworkAddressIdentity is set to + true and administrator is not System/Provisioning level administrator. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: GroupTrunkGroupAddInstanceRequest20sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Trunk Group instance to a group. + The command will fail if enableNetworkAddressIdentity is set to + true and administrator is not System/Provisioning level administrator. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: GroupTrunkGroupAddInstanceRequest21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse19sp1V2 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address". + + Replaced by: GroupTrunkGroupGetInstanceRequest20sp1 + + + + + + + + + + + + + + + true + false + + + Response to GroupTrunkGroupGetInstanceRequest19sp1V2. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department", "Email Address". + + Replaced by: GroupTrunkGroupGetInstanceResponse20sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse20sp1 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address". + + Replaced by: GroupTrunkGroupGetInstanceRequest21 + + + + + + + + + + + + + + + true + false + + + Response to GroupTrunkGroupGetInstanceRequest20sp1. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department", "Email Address". + + Replaced by: GroupTrunkGroupGetInstanceResponse21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify a Trunk Group Instance in a group. + The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. + The command will fail if enableNetworkAddressIdentity is set and + administrator is not System/Provisioning level administrator. + Following attributes are only used in IMS mode: + implicitRegistrationSetSupportPolicy + useSystemImplicitRegistrationSetSupportPolicy + sipIdentityForPilotAndProxyTrunkModesPolicy + useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by: GroupTrunkGroupModifyInstanceRequest20sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Assign a list of Network Classes of Service to a service provider. + The Element defaultNetworkClassOfService is required only + for the first assignment, + for subsequent assignments it is optional. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Unassign a list of Network Classes of Service from a service provider. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of Advice of Charge system parameters. + The response is either SystemAdviceOfChargeGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemAdviceOfChargeGetRequest. + Contains a list of system Advice of Charge parameters. + + + + + + + + + + + + + + + + + Request to modify Advice of Charge system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of CPE Config system parameters. + The response is either SystemCPEConfigParametersGetResponse20 or ErrorResponse. + + + + + + + + + + + + + Response to SystemCPEConfigParametersGetListRequest20. + Contains a list of system CPE Config parameters. + + Replaced by: SystemCPEConfigParametersGetResponse21 + + + + + + + + + + + + + + + + + + + + Request to modify CPE Config system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request the system level data associated with the Trunk Group service. + The response is either SystemTrunkGroupGetResponse19sp1 or ErrorResponse. + + Replaced by: SystemTrunkGroupGetRequest21 + + + + + + + + + + + + + Response to SystemTrunkGroupGetRequest19sp1. + + + + + + + + + + + + + + + + + + + + + + + + Get the address and credentials of the File Repository hosting the requested access device file. + Also get the file name and path on the File Repository. + The response is either a DeviceManagementFileAuthLocationGetResponse18 or an ErrorResponse. + + Replaced by: DeviceManagementFileAuthLocationGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + + Return the address and credentials of the File Repository hosting the requested access device file. + Also return the file name and path on the File Repository. + This is a response to DeviceManagementFileAuthLocationGetRequest18. + + Replaced by: DeviceManagementFileAuthLocationGetResponse21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get list of default Feature Access Codes defined on system + level. + The response is either SystemFeatureAccessCodeGetListResponse20 or + ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: SystemFeatureAccessCodeGetListRequest21 + + + + + + + + + + + + + true + false + + + Response to the SystemFeatureAccessCodeGetListRequest20. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: SystemFeatureAccessCodeGetListResponse21 + + + + + + + + + + + + + + + true + false + + + Modify default Feature Access Codes. + The response is either a SuccessResponse or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: SystemFeatureAccessCodeModifyListRequest21 + + + + + + + + + + + + + + Feature Access Code Entry + + + + + + + + + + + + true + false + + + Get the list of feature access codes for a service provider or enterprise. + The response is either a ServiceProviderFeatureAccessCodeGetListResponse20 + or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: ServiceProviderFeatureAccessCodeGetListRequest21 + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderFeatureAccessCodeGetListRequest20. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: ServiceProviderFeatureAccessCodeGetListResponse21 + + + + + + + + + + + + + + + true + false + + + Modify a list of feature access codes for a service provider or enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: ServiceProviderFeatureAccessCodeModifyListRequest21 + + + + + + + + + + + + + + + + true + false + + + Get group FAC code level and the list of feature access codes for a group. + The response is either a GroupFeatureAccessCodeGetResponse20 or an + ErrorResponse. + Returned Feature Access Codes may be group specific, or Service Provider + Feature Access Codes, depending on FAC code level. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: GroupFeatureAccessCodeGetRequest21 + + + + + + + + + + + + + + + + true + false + + + Response to the GroupFeatureAccessCodeGetRequest20. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by : GroupFeatureAccessCodeGetResponse21 + + + + + + + + + + + + + + + + true + false + + + Modify group FAC code level and the list of feature access codes for a + group. + The response is either a SuccessResponse or an ErrorResponse. + Note: choice element is only valid when useFeatureAccessCodeLevel is set + to "Group", otherwise an ErrorResponse will be returned. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + Replaced by: GroupFeatureAccessCodeModifyRequest21 + + + + + + + + + + + + + + + + + + + + + Get the list of feature access codes for a user. + The response is either a UserFeatureAccessCodeGetListResponse20 or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording Start". + Replaced by: UserFeatureAccessCodeGetListRequest21 + + + + + + + + + + + + + + + Response to the UserFeatureAccessCodeGetListRequest20. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording Start". + Replaced by: UserFeatureAccessCodeGetListResponse21 + + + + + + + + + + + + + + + Create a service pack migration task. + The response is either SuccessResponse or ErrorResponse. + Replaced By: ServiceProviderServicePackMigrationTaskAddRequest21 + + + + + + + + + + + + + + + + + + + + + + + + Requests a list of all service pack migration task for a service provider. + The response is either ServiceProviderServicePackMigrationTaskGetListResponse + or ErrorResponse. + Replaced By: ServiceProviderServicePackMigrationTaskGetListRequest21 + + + + + + + + + + + + + + + Response to ServiceProviderServicePackMigrationTaskGetListRequest. + Contains a table with a row for each service pack migration task and column headings : + "Start Timestamp Milliseconds", "Name", "Status", "Error Count", "Users Processed", "Users Total". + The start timestamp column is the number of milliseconds since the standard base time known as "the epoch", + namely January 1, 1970, 00:00:00 GMT. + + + + + + + + + + + + + + + Requests the details of a specified service pack migration task. + The response is either ServiceProviderServicePackMigrationTaskGetResponse14sp4 + or ErrorResponse. + Replaced By: ServiceProviderServicePackMigrationTaskGetRequest21 + + + + + + + + + + + + + + + + Response to ServiceProviderServicePackMigrationTaskGetRequest14sp4. + The groupTable column headings are: "Group Id", "Group Name", "User Count". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Enhanced Call Logs. The response is either a + SystemEnhancedCallLogsGetResponse17sp4 or an ErrorResponse. + Replaced by:SystemEnhancedCallLogsGetRequest20sp1 + + + + + + + + + + + + + Response to SystemEnhancedCallLogsGetRequest17sp4. + The following elements are only used in AS data mode: + isSendEnabled + server1NetAddress + server1SendPort + server1RetrievePort + server2NetAddress + server2SendPort + server2RetrievePort + sharedSecret + retransmissionDelayMilliSeconds + maxTransmissions + soapTimeoutSeconds + useDBS + Replaced by:SystemEnhancedCallLogsGetResponse20sp1 + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Criteria. + The response is either a + SystemCommunicationBarringCriteriaGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringCriteriaGetRequest17. + The response contains the Communication Barring Criteria information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get an existing Communication Barring Profile. + The response is either a ServiceProviderCommunicationBarringProfileGetResponse19sp1 + or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderCommunicationBarringProfileGetRequest19sp1. + The response contains the Communication Barring Profile information. + The incoming, originating, redirecting and call me now rules are returned in ascending priority order. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the broadworks mobility system parameters. + The response is either a SystemBroadWorksMobilityGetResponse19sp1 or an ErrorResponse. + + Replaced by SystemBroadWorksMobilityGetRequest21 + + + + + + + + + + + + + true + false + + + The response to a SystemBroadWorksMobilityGetRequest19sp1. + + Replaced by SystemBroadWorksMobilityGetResponse21 + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the BroadWorks Mobility system parameters. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by SystemBroadWorksMobilityModifyRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Adds Mobile Subscriber Directory Numbers to a service provider. It is possible to add a single DN, + or a list of DNs. + The response is either SuccessResponse or ErrorResponse. + + Replaced by ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberAddListRequest21. + + + + + + + + + + + + + + + + true + false + + + Add a system service access code. + The response is either SuccessResponse or ErrorResponse. + + Replaced by SystemBroadWorksMobilityServiceAccessCodeAddRequest21. + + + + + + + + + + + + + + + + + true + false + + + Delete a system service access code. + The response is either SuccessResponse or ErrorResponse. + + Replaced by SystemBroadWorksMobilityServiceAccessCodeDeleteRequest21. + + + + + + + + + + + + + + + + true + false + + + Get a list of system service access codes. + The response is either SystemBroadWorksMobilityServiceAccessCodeGetListResponse or ErrorResponse. + + Replaced by SystemBroadWorksMobilityServiceAccessCodeGetListRequest21. + + + + + + + + + + + + + true + false + + + Response to SystemBroadWorksMobilityServiceAccessCodeGetListRequest. + Contains a table with column headings: "Country Code", "Service Access Code", "Description". + + Replaced by SystemBroadWorksMobilityServiceAccessCodeGetListReponse21. + + + + + + + + + + + + + + + true + false + + + Modify a system service access code. + The response is either SuccessResponse or ErrorResponse. + + Replaced by SystemBroadWorksMobilityServiceAccessCodeModifyRequest21. + + + + + + + + + + + + + + + + + Request the system level data associated with Hunt Group. + The response is either a SystemHuntGroupGetResponse or an + ErrorResponse. + + Replaced by SystemHuntGroupGetRequest21. + + + + + + + + + + + + + Response to SystemHuntGroupGetRequest. + + Replaced by SystemHuntGroupGetResponse21. + + + + + + + + + + + + + + + + + Modify the system level data associated with Hunt Group. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by SystemHuntGroupModifyRequest21 + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Call Center. + The response is either a SystemCallCenterGetResponse19 or an + ErrorResponse. + + Replaced by SystemCallCenterGetRequest21. + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterGetRequest19. + + Replaced by SystemCallCenterGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the system Integrated IMP service attributes. + The response is either SystemIntegratedIMPGetResponse19 or ErrorResponse. + + + + + + + + + + + Response to the SystemIntegratedIMPGetRequest19. + The response contains the system Integrated IMP service attributes. + + The following elements are only used in AS data mode: + boshURL + + + + + + + + + + + + + + + + + + Request to get the Number Activation state. + The response is either SystemNumberActivationGetResponse18sp1 or ErrorResponse. + + Replaced by: SystemNumberActivationGetRequest21 + + + + + + + + + + + + + Response to SystemNumberActivationGetRequest18sp1. + Contains the system number activation setting. + + + + + + + + + + + + + + + Request the system level data associated with SMPP external interface. + The response is either a SystemSMPPGetResponse14sp5 or an ErrorResponse. + + Replaced by: SystemSMPPGetRequest21 + + + + + + + + + + + + + Response to SystemSMPPGetRequest14sp5. + + Replaced by: SystemSMPPGetResponse21 + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a system Security Classifications parameters. + The response is either SystemSecurityClassificationGetResponse or ErrorResponse. + + + + + + + + + + + true + false + + + Response to the SystemSecurityClassificationGetRequest. + Contains a table with column headings: + "Name", "Priority". + + + + + + + + + + + + + + + + Request the system level data associated with Voice Messaging. + The response is either a SystemVoiceMessagingGroupGetResponse20 or an ErrorResponse. + + Replaced by: SystemVoiceMessagingGroupGetRequest21 + + + + + + + + + + + + + Response to SystemVoiceMessagingGroupGetRequest20. + + The following elements are only used in AS data mode: + realDeleteForImap + useDnInMailBody + useShortSubjectLine + maxMessageLengthMinutes + maxMailboxLengthMinutes + doesMessageAge + holdPeriodDays + mailServerNetAddress + mailServerProtocol + defaultDeliveryFromAddress + defaultNotificationFromAddress + useOutgoingMWIOnSMDI + mwiDelayInSeconds + voicePortalScope + enterpriseVoicePortalLicensed + networkWideMessaging + useExternalRouting + defaultExternalRoutingAddress + vmOnlySystem + clientInitiatedMailServerSessionTimeoutMinutes + + Replaced by: SystemVoiceMessagingGroupGetResponse21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the system voice portal Menus setting. + The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse20 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessagingGroupGetVoicePortalMenusRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request users' call logs within an enterprise + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either an EnterpriseEnhancedCallLogsGetListResponse20 or an ErrorResponse. + The following elements are only used in AS data mode: + callAuthorizationCodeFilter + callSecurityClassification + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterpriseEnhancedCallLogsGetListRequest20. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the EnterpriseEnhancedCallLogsGetListRequest20, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry20 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The result is sorted by date/time of the call. + + + + + + + + + + + + + + + + Request users' call logs within a group + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl.If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a GroupEnhancedCallLogsGetListResponse20 or an ErrorResponse. + The following elements are only used in AS data mode: + callAuthorizationCodeFilter + callSecurityClassification + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupEnhancedCallLogsGetListRequest20. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the GroupEnhancedCallLogsGetListRequest20, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry20 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The logs are sorted by date/time of the call. + + + + + + + + + + + + + + + + Request the user level data associated with Alternate Numbers. + The response is either a UserAlternateNumbersGetResponse17 or an ErrorResponse. + + Replaced by: UserAlternateNumbersGetRequest21 + + + + + + + + + + + + + + + Response to UserAlternateNumbersGetRequest17. + + Replaced by: UserAlternateNumbersGetResponse21 + + + + + + + + + + + + + + + + + + + + + + + + + Request user's call logs. + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When + "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including + placed will be returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a UserEnhancedCallLogsGetListResponse20 or an ErrorResponse. + The following elements are only used in AS data mode: + callAuthorizationCodeFilter + callSecurityClassification + + + + + + + + + + + + + + + + + + + + + + + Response to UserEnhancedCallLogsGetListRequest20. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest20, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of MixedCallLogsEntry will be returned if the call logs are stored on CDS + A list of ExtendedMixedCallLogsEntry20 will be returned if the call logs are stored on DBS + The logs are sorted by date/time of the call. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a call processing policy profile to system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to get a call processing policy profile in system. + The response is either a SystemCallProcessingPolicyProfileGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to a SystemCallProcessingPolicyProfileGetRequest20. + + + + + + + + + + + + + + + + Filter criteria based on the transferred/forwarded number. + + + + + + + + + + + + + + + + + + + true + false + + + Modify a call processing policy profile in system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Extended Call Log entry describing a placed, received, or missed call. + "countryCode" is the user's country code + The following time elements are represented as timestamp, i.e., the number of milliseconds + since January 1, 1970, 00:00:00 GMT. + "startTime" represents the time when the system sends out a call invitation message (e.g. for + placed calls) or receives a call invitation message (e.g. for missed/received calls). + "answerTime" represents the time when the call is answered by the terminating party. + "detachedTime" represents the time when the call is successfully redirected by the system. + "releaseTime" represents the time when the call is released. This time corresponds to the + moment the call is released by the system, and not necessarily when one party hangs up, since this + does not always mean the call is released (e.g. Emergency/911 calls). + The elements "userGroupId", "userId","userPrimaryDn" and "userPrimaryExtension" + are only returned when the enterprise or group level requests are used. + The following elements are only used in AS data mode: + callAuthorizationCode + callSecurityClassification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates the type of service invocation that caused the call to be detached. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Redirected call selection. + When " redirectedCall " is set to true, all call logs with redirected call are returned. When it + set to false, all call logs without redirected call are returned. + The redirected call can be defined by including a subset of Service Invocation Disposition here. + If none included, any call has a ServiceInvocationDisposition value defined in ServiceInvocationDisposition + is considered as a redirected call. + + + + + + + + + + + + true + false + + + Request the user level data associated with Device Policy. + The response is either a UserDevicePoliciesGetResponse20 or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserDevicePoliciesGetRequest201. enableDeviceFeatureSynchronization is ignored by the application server in Multiple User Shared mode. + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in HSS data mode: + enable3G4GContinuity, use value "false" in AS data mode + + The following elements are only used in AS data mode: + holdAnnouncementMethod, use value "useInactive" in HSS data mode + supportRFC3398, use value "false" in HSS data mode + supportClientSessionInfo, use value "false" in HSS data mode + supportCallInfoConferenceSubscriptionURI, use value "false" in HSS data mode + supportRemotePartyInfo, use value "false" in HSS data mode + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse20 or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to SystemSIPDeviceTypeGetRequest20. + The following elements are only used in AS data mode: + holdAnnouncementMethod + supportRFC3398 + supportClientSessionInfo + supportCallInfoConferenceSubscriptionURI + supportRemotePartyInfo + + The following elements are only used in HSS data mode: + enable3G4GContinuity + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + isMobilityManagerDevice + deviceTypeConfigurationOption + staticLineOrdering + + The following elements are only used in HSS data mode: + enable3G4GContinuity + + The following elements are only used in AS data mode: + holdAnnouncementMethod + supportRFC3398 + supportClientSessionInfo + supportCallInfoConferenceSubscriptionURI + supportRemotePartyInfo + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a criteria for the user's selective call acceptance service. + The response is either a UserSelectiveCallAcceptanceGetCriteriaResponse16 or an ErrorResponse. + + Replaced by: UserSelectiveCallAcceptanceGetCriteriaRequest21 + + + + + + + + + + + + + + + + Response to the UserSelectiveCallAcceptanceGetCriteriaRequest16. + + Replaced by: UserSelectiveCallAcceptanceGetCriteriaResponse21 + + + + + + + + + + + + + + + + + + Get a criteria for the user's call forwarding selective service. + The response is either a UserCallForwardingSelectiveGetCriteriaResponse16 or an ErrorResponse. + + Replaced by: UserCallForwardingSelectiveGetCriteriaRequest21 + + + + + + + + + + + + + + + + Response to the UserCallForwardingSelectiveGetCriteriaRequest16. + + Replaced by: UserCallForwardingSelectiveGetCriteriaResponse21 + + + + + + + + + + + + + + + + + + + Get a criteria for the user's selective call rejection service. + The response is either a UserSelectiveCallRejectionGetCriteriaResponse16sp1 or an ErrorResponse. + + Replaced by: UserSelectiveCallRejectionGetCriteriaRequest21 + + + + + + + + + + + + + + + + Response to the UserSelectiveCallRejectionGetCriteriaRequest16sp1. + Private Phone Numbers are omitted from the fromDnCriteria. + + Replaced by: UserSelectiveCallRejectionGetCriteriaResponse21 + + + + + + + + + + + + + + + + + + + Get a criteria for the user's BroadWorks Anywhere phone number. + The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse16 or an ErrorResponse. + + Replaced by: UserBroadWorksAnywhereGetSelectiveCriteriaRequest21 + + + + + + + + + + + + + + + + + Response to the UserBroadWorksAnywhereGetSelectiveCriteriaRequest16. + + Replaced by: UserBroadWorksAnywhereGetSelectiveCriteriaResponse21 + + + + + + + + + + + + + + + + + + Get a criteria for the user's call notify service. + The response is either a UserCallNotifyGetCriteriaResponse16 or an ErrorResponse. + + Replaced by: UserCallNotifyGetCriteriaRequest21 + + + + + + + + + + + + + + + + Response to the UserCallNotifyGetCriteriaRequest16. + + Replaced by: UserCallNotifyGetCriteriaResponse21 + + + + + + + + + + + + + + + + + + Get a criteria for the user's custom ringback service. + The response is either a UserCustomRingbackUserGetCriteriaResponse20 or an ErrorResponse. + + Replaced by: UserCustomRingbackUserGetCriteriaRequest21 + + + + + + + + + + + + + + + + Response to the UserCustomRingbackUserGetCriteriaRequest20. + + Replaced by: UserCustomRingbackUserGetCriteriaResponse21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a filtering criteria for an executive user. + Both executive and the executive assistant can run this command. + The response is either UserExecutiveGetSelectiveCriteriaResponse or ErrorResponse. + + Replaced by: UserExecutiveGetFilteringSelectiveCriteriaRequest21 + + + + + + + + + + + + + + + + true + false + + + Response to the UserExecutiveGetFilteringSelectiveCriteriaRequest. + + Replaced by: UserExecutiveGetFilteringSelectiveCriteriaResponse21 + + + + + + + + + + + + + + + + + + Request to get all the information of a specific Find-me/Follow-me alerting group selective criteria. + The response is either GroupFindMeFollowMeGetAlertingGroupResponse or ErrorResponse. + + Replaced by: GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest21 + + + + + + + + + + + + + + + + + Response to GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest. + Contains the alerting group selective criteria information. + + Replaced by: GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaResponse21 + + + + + + + + + + + + + + + + + + Add a Music on Hold Instance to a department. + The response is either SuccessResponse or ErrorResponse. + + Replaced by: GroupMusicOnHoldAddInstanceRequest21 + + + + + + + + + + + + + + + + + + + + + + + Get a Music On Hold data for a group or department instance. + The response is either GroupMusicOnHoldGetInstanceResponse20 or ErrorResponse. + + Replaced by: GroupMusicOnHoldGetInstanceRequest21 + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetInstanceRequest20. + + + + + + + + + + + + + + + + + + + + + + Modify data for a group or department Music On Hold Instance. + The response is either SuccessResponse or ErrorResponse. + + Replaced by: GroupMusicOnHoldModifyInstanceRequest21 + + + + + + + + + + + + + + + + + + + + + + + Get a criteria for the user's pre-alerting service. + The response is either a UserPreAlertingAnnouncementGetCriteriaResponse or an ErrorResponse. + + Replaced by: UserPreAlertingAnnouncementGetCriteriaRequest21 + + + + + + + + + + + + + + + + Response to the UserPreAlertingAnnouncementGetCriteriaRequest. + + Replaced by: UserPreAlertingAnnouncementGetCriteriaResponse21 + + + + + + + + + + + + + + + + + + Get a criteria for the user's priority alert service. + The response is either a UserPriorityAlertGetCriteriaResponse16 or an ErrorResponse. + + Replaced by: UserPriorityAlertGetCriteriaRequest21 + + + + + + + + + + + + + + + + Response to the UserPriorityAlertGetCriteriaRequest16. + + Replaced by: UserPriorityAlertGetCriteriaResponse21 + + + + + + + + + + + + + + + + + + Request to get the user information. The response is either + UserGetResponse20 or ErrorResponse. + + Replaced by: UserGetRequest21 + + + + + + + + + + + + + + + Response to UserGetRequest20. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + The following data elements are only used in AS data mode: + contact[2]-contact[5] + + The country code (countryCode) included is the user's phone number country code when the user has a phone number assigned, or the + user's Group associated country code when the user does not have a phone number assigned, or the system default country code when the + user's Group does not have an associated country code. + + The nationalPrefix in this response is the one associated to the included countryCode. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the Integrated IMP service attributes for the service provider. + The response is either ServiceProviderIntegratedIMPGetResponse or ErrorResponse. + + Replaced by: ServiceProviderIntegratedIMPGetRequest21 + + + + + + + + + + + + + + + Response to the ServiceProviderIntegratedIMPGetRequest. + The response contains the service provider Integrated IMP service attributes. + + Replaced by: ServiceProviderIntegratedIMPGetResponse21 + + + + + + + + + + + + + + + + Request to get the list of system licenses in the system. + The response is either a SystemLicensingGetSystemLicenseListResponse or an ErrorResponse. + + Replaced by SystemLicensingGetSystemLicenseListRequest21 + + + + + + + + + + + + + Response to SystemLicensingGetSystemLicenseListRequest. + + Replaced by SystemLicensingGetSystemLicenseListResponse21 + + + + + + + + + + + + + + + Modify the user level data associated with Hoteling Guest. + There is no provisioning error will be given when setting hostUserId to not nil value while Hoteling Guest feature is not active. + The response is either a SuccessResponse or an ErrorResponse. + + Replaced by UserHotelingGuestModifyRequest21 + + + + + + + + + + + + + + + + + + + Load a new license file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + Trunk group endpoint that can have multiple contacts. + + Replaced by: TrunkAddressingMultipleContactRead21 + + + + + + + + + + + + + Contains the music on hold source configuration. + + Replaced by: MusicOnHoldSourceAdd21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + Replaced by: MusicOnHoldSourceRead21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + + Replaced by: MusicOnHoldSourceModify21 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Alternate Number Entry. + + + + + + + + + + + + + Different type of user and virtual subscriber which could have a set of call processing policy profile defined in BroadWorks. + + + + + + + + + + + + + + + + + + + + + + + + A list of CallProcessingPolicyProfileSubscriberType20. The list replaces a previously configured list. + + + + + + + + + + Maximum Number of Incoming Calls + + + + + + + + + + Maximum Number of Outgoing Calls + + + + + + + + + + + System License type. + + Replaced by: SystemLicenseType21. + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaEnterprise.xsd b/share/OCISchemaAS/OCISchemaEnterprise.xsd new file mode 100644 index 0000000..0587f0c --- /dev/null +++ b/share/OCISchemaAS/OCISchemaEnterprise.xsd @@ -0,0 +1,1500 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add the BroadWorks Mobile Manager. + Only one BroadWorks Mobile Manager can be added per + enterprise. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the BroadWorks Mobile Manager. + The response is either EnterpriseBroadWorksMobileManagerGetResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the EnterpriseBroadWorksMobileManagerGetRequest + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the list of domains of the BroadWorks Mobile Manager. + The response is either EnterpriseBroadWorksMobileManagerGetDomainListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the EnterpriseBroadWorksMobileManagerGetDomainListRequest. + Contains the list of domains. + + + + + + + + + + + + + + + true + false + + + Delete the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Modify the BroadWorks Mobile Manager settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Activates or Deactivates the BroadWorks Mobile Manager. + The deactivationReason is required when isActive is set to false. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Sends an email with the carrier information and certificate files. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Add a home zone to the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Get the list of home zones of the BroadWorks Mobile Manager. + The response is either EnterpriseBroadWorksMobileManagerGetHomeZoneListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the + EnterpriseBroadWorksMobileManagerGetHomeZoneListRequest. + Contains a table with column headings: + "Home Zone Id", "Domain Name", "Mobile Country Code", + "Mobile Network Code", "Local Area Code" and "Cell Identity". + + + + + + + + + + + + + + + true + false + + + Get a home zone from the BroadWorks Mobile Manager. + The response is either EnterpriseBroadWorksMobileManagerGetHomeZoneResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the EnterpriseBroadWorksMobileManagerGetHomeZoneRequest + + + + + + + + + + + + + + + + + + + true + false + + + Delete a home zone from the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete a list of home zones from the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Modify an existing home zone in the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Add one or more entries to an enterprise's common phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete one or more entries from an enterprise's common phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get an enterprise's common phone list. + The response is either a EnterpriseCommonPhoneListGetListResponse or an ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. + In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an + ErrorResponse is returned. + + + + + + + + + + + + + + + + + + + Response to the EnterpriseCommonPhoneListGetListRequest. + The response contains the enterprise's common phone list. + + + + + + + + + + + + + + + Modify an entry in an enterprise's common phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Add a department to enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a department from an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a list of enterprise level departments in an enterprise that could be the parent of the + specified department. The department itself and all its decendents are not eligible to be + the parent department. + The response is either EnterpriseDepartmentGetAvailableParentListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to EnterpriseDepartmentGetAvailableParentListRequest. + The response includes two parallel arrays of department keys and department display names. + + + + + + + + + + + + + + + + Request a list of departments in an enterprise. You may request only the + list of departments defined at the enterprise-level, or you may request + the list of all departments in the enterprise including all the departments + defined within the groups inside the enterprise. + The response is either EnterpriseDepartmentGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to EnterpriseDepartmentGetListRequest. + The response includes two parallel arrays of department keys and department display names. + + + + + + + + + + + + + + + + Modify a department of an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request a table containing the phone directory for an enterprise. + The directory includes all users in the enterprise and all entries in the enterprise common phone list. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either EnterprisePhoneDirectoryGetListResponse18 or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterprisePhoneDirectoryGetListRequest18. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", + "Department", "Hiragana Name", "Group Id", "Yahoo Id", "User Id", "IMP Id", "Is Virtual On-Net User". + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "Pager", "Title", "Time Zone", + "Location", "Address Line 1", "Address Line 2", + "City", "State", "Zip", "Country". + + + + + + + + + + + + + + + true + false + + + Request to get the list of devices can be assigned to session admission control group for the enterprise. + The response is either an EnterpriseSessionAdmissionControlGetAvailableDeviceListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to EnterpriseSessionAdmissionControlGetAvailableDeviceListRequest. + Contains a table of devices can be assigned to session admission control group in the enterprise. + + + + + + + + + + + + + + + true + false + + + Request to add one or more devices to an enterprise level session admission control group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to add a session admission control group for the enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to delete one or more devices from an enterprise level session admission control group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to delete one or more session admission control groups for the enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get the list of session admission control group for the enterprise. + The response is either an EnterpriseSessionAdmissionControlGroupGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to EnterpriseSessionAdmissionControlGroupGetListRequest. + Contains a table of session admission control group configured in the enterprise. + The column headings are: "Name", "Is Default", "Maximum Sessions", "Maximum Originating Sessions", "Maximum Terminating Sessions".. + + + + + + + + + + + + + + + true + false + + + Request to get a session admission control group for the enterprise. + The response is either an EnterpriseSessionAdmissionControlGroupGetResponse19sp1 or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to EnterpriseSessionAdmissionControlGroupGetRequest19sp1. + Returns the profile information for the session admission control group. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a session admission control group for the enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + Add the enterprise level data associated with a Voice VPN location code. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Delete a enterprise voice VPN location. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the Voice VPN default settings for the enterprise. + The response is EnterpriseVoiceVPNGetDefaultResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseVoiceVPNGetDefaultResponse. + + + + + + + + + + + + + + + + + + Request the enterprise level data associated with Voice VPN location code. + The response is either a EnterpriseVoiceVPNGetPolicyResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to EnterpriseVoiceVPNGetPolicyRequest. + + + + + + + + + + + + + + + + + + + + + + + Request the enterprise level data associated with Voice VPN. + The response is either a EnterpriseVoiceVPNGetResponse14sp3 or an ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseVoiceVPNGetRequest14sp3. + + + + + + + + + + + + + + + + + + Request the list of Voice VPN locations. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a EnterpriseVoiceVPNGetPolicyListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to EnterpriseVoiceVPNGetListResponse. + Returns a 4 column table with column headings: + "Location Code", "Min Extension Length", "Max Extension Length", "Location Selection". + + + + + + + + + + + + + + + Modify the enterprise level data associated with a Voice VPN location code. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Modify the enterprise voice VPN level data associated with voice VPN. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Uniquely identifies an access device accessible for an enterprise. It could be a system level device, an enterprise level device or a group level device. + + + + + + + + + + + + Enterprise Voice VPN Default Selector. + + + + + + + + + + + + Enterprise Voice VPN description. + + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation Entry. + + + + + + + + + Enterprise Voice VPN Digit Manipulation Entry that has no value. + + + + + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation operations. + + + + + + + + + + + + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation Operations that have no value. + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation Operations that may or may not have a value. + + + + + + + + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation Operations that have a value. + + + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation Entry that optionally has a value. + + + + + + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation Entry that has a value. + + + + + + + + + + + + + + + + Enterprise Voice VPN Digit Manipulation value. + + + + + + + + + + + + Enterprise Voice VPN Extension Length. + + + + + + + + + + + + Enterprise Voice VPN Selector for Non Matching E164 Number. + + + + + + + + + + + + Enterprise Voice VPN Treatment Description. + + + + + + + + + + + + Enterprise Voice VPN Treatment entry + + + + + + + + + + + + Enterprise Voice VPN Treatment Id. + + + + + + + + + + + + Enterprise Voice VPN location code. + + + + + + + + + + + + A list of enterprise accessible devices that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaGroup.xsd b/share/OCISchemaAS/OCISchemaGroup.xsd new file mode 100644 index 0000000..89eb4fc --- /dev/null +++ b/share/OCISchemaAS/OCISchemaGroup.xsd @@ -0,0 +1,6665 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a group access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a static configuration tag for a group access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to delete static configuration tags for a group access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis. + The response is either GroupAccessDeviceCustomTagGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceCustomTagGetListRequest. + Contains a table of custom configuration tags managed by the Device Management System on a per-device profile basis. + The column headings are: "Tag Name", "Tag Value" + + + + + + + + + + + + + + + Request to modify a static configuration tag for a group access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to delete a specified group access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device profile basis. + The response is either GroupAccessDeviceFileGetListResponse14sp8 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceFileGetListRequest14sp8. + Contains a table of device files managed by the Device Management System on a per-device profile basis. + The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL", "Extended Capture". + + The following columns are only used in AS data mode: + "Extended Capture" + + + + + + + + + + + + + + + true + false + + + Request to get a group device profile file. + The response is either GroupAccessDeviceFileGetResponse20 or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Response to GroupAccessDeviceFileGetRequest20. + + + + + + + + + + + + + + + + + + + + + Request to modify a specified group access device file. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + extendedCaptureEnabled + + + + + + + + + + + + + + + + + + + + + Requests the list of configurable device types of devices that have already been + added to the group. + The response is either GroupAccessDeviceGetEnhancedConfigurationTypeListResponse + or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetEnhancedConfigurationTypeListRequest. + + + + + + + + + + + + + + + Requests the details of a specified configurable device type for a group. + The response is either GroupAccessDeviceGetEnhancedConfigurationTypeResponse14 + or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetEnhancedConfigurationTypeRequest14. + + + + + + + + + + + + + + + + + + Requests the list of available access devices for assignment to a user + within a group. The list includes devices created at the system, service provider, and group levels. + The response is either GroupAccessDeviceGetAvailableDetailListResponse19 or + ErrorResponse. + + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetAvailableDetailListRequest19. + + + + + + + + + + + + + + + + + + + + + + + + + Requests the list of access devices in a group. + The response is either GroupAccessDeviceGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetListRequest. + Contains a table of devices configured in the group. + The column headings are: "Device Name", "Device Type", "Available Ports", "Net Address", "MAC Address", "Status" and "Version". + + + + + + + + + + + + + + + Requests the configuration of a specified group access device. + The response is either GroupAccessDeviceGetResponse18sp1 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetRequest18sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the configuration of a specified group access device. + The response is either GroupAccessDeviceGetUserListResponse or ErrorResponse. + The following elements are only used in HSS data mode and ignored in AS data mode: + searchCriteriaAccessDeviceEndpointPrivateIdentity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceGetUserListRequest. + The column headings for the deviceUserTable are: "Line/Port", "Last Name", + "First Name", "Phone Number", "User Id", "User Type", "Endpoint Type", "Order", "Primary Line/Port", "Extension", "Department", "Email Address", "Private Identity". + In IMS mode, the table will contain a row for each TEL-URI in the Phone Number column. + In Standalone mode, rows for the alternate numbers are not included. + The User Type column contains one of the enumerated UserType values. + The Endpoint Type column contains one of the enumerated EndpointType values. + The Private Identity column is empty is AS mode. + + + + + + + + + + + + + + + Request to modify a specified group access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify attributes for line/ports assigned on the group device profile. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in HSS data mode and ignored in AS data mode: + privateIdentity + + + + + + + + + + + + + + + + + + + + Reset a specific group SIP device that supports the reset operation. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Add an announcement to the group announcement repository + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete one or more announcements from the group announcement repository + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the list of available announcement files for a Group. + The response is either a GroupAnnouncementFileGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Response to GroupAnnouncementFileGetAvailableListRequest. + When requested, the response contains a table with columns: "Name", "Media Type" and "File Size". + The "Name" column contains the name of the announcement file. + The "Media Type" column contains the media type of the announcement + File with the possible values: + WMA - Windows Media Audio file + WAV - A WAV file + 3GP - A 3GP file + MOV - A MOV file using a H.263 or H.264 codec. + The "File Size" column contains the file size (KB) of the announcement file. + The response also contains the current total file size (KB) for the group across + all media types and the maximum total file size (MB) allowed for the group. + + + + + + + + + + + + + + + + + Request to get the announcement repository file information. + The response is either GroupAnnouncementFileGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupAnnouncementFileGetRequest. + The response contains the file size, uploaded timestamp, description and usage for + an announcement file in the user announcement repository. + The usage table has columns "Service Name", and "Instance Name". + The Service Name values correspond to string values of the GroupService and UserService data types. + With the exception of the string "Voice Portal" which is returned when the announcement is being used by Voice Portal Personalized Name. + + + + + + + + + + + + + + + + + + Modify an existing announcement in the group repository + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Add a new Dialable Caller ID Criteria. Criteria are added at the bottom of the list with the lowest priority. The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a Dialable Caller ID Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get an existing Dialable Caller ID Criteria. + The response is either a + GroupDialableCallerIDCriteriaGetRequest or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupDialableCallerIDCriteriaGetRequest. + The response contains the Dialable Caller ID Criteria information. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify a Dialable Caller ID Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the Group’s Dialable Caller ID settings and criteria list. + The response is either a + GroupDialableCallerIDGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the GroupDialableCallerIDGetRequest. + The criteria table�s column headings are "Active", "Name", "Description", �Prefix Digits�, �Priority�. + + + + + + + + + + + + + + + + + true + false + + + Modify the group�s Dialable Caller ID settings and criteria list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Add a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Add a group administrator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a group administrator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of group and department administrators within the group. + The response is either a GroupAdminGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupAdminGetListRequest. + Contains a 5 column table with column headings "Administrator ID", + "Last Name", "First Name", "Department", "Language". + + + + + + + + + + + + + + + Get a group administrators profile. + The response is either a GroupAdminGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupAdminGetRequest. + The response contains the group administrators profile information. + + + + + + + + + + + + + + + + + + + true + true + + + Requests the Group administrator's policy settings. + The response is either GroupAdminGetPolicyResponse20 or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to GroupAdminGetPolicyRequest20. + Contains the policy settings for the group administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + verifyTranslationAndroutingAccess + communicationBarringUserProfileAccess (This element is only returned for groups in an enterprise) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify the group administrator's policy settings. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + dialableCallerIDAccess + verifyTranslationAndRoutingAccess + communicationBarringUserProfileAccess (only applicable to groups in an Enterprise) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a group administrator. + Since old password is not specified here, any password rule related to old password + does not apply. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Add the BroadWorks Mobile Manager. + Only one BroadWorks Mobile Manager can be added per group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the BroadWorks Mobile Manager. + The response is either GroupBroadWorksMobileManagerGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the GroupBroadWorksMobileManagerGetRequest + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the list of domains of the BroadWorks Mobile Manager. + The response is either GroupBroadWorksMobileManagerGetDomainListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the GroupBroadWorksMobileManagerGetDomainListRequest. + Contains the list of domains. + + + + + + + + + + + + + + + true + false + + + Delete the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Modify the BroadWorks Mobile Manager settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Activates or Deactivates the BroadWorks Mobile Manager. + The deactivationReason is required when isActive is set to false. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Sends an email with the carrier information and certificate files. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Add a home zone to the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the list of home zones of the BroadWorks Mobile Manager. + The response is either GroupBroadWorksMobileManagerGetHomeZoneListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the GroupBroadWorksMobileManagerGetHomeZoneListRequest. + Contains a table with column headings: + "Home Zone Id", "Domain Name", "Mobile Country Code", + "Mobile Network Code", "Local Area Code" and "Cell Identity". + + + + + + + + + + + + + + + true + false + + + Get a home zone from the BroadWorks Mobile Manager. + The response is either GroupBroadWorksMobileManagerGetHomeZoneResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupBroadWorksMobileManagerGetHomeZoneRequest + + + + + + + + + + + + + + + + + + + true + false + + + Delete a home zone from the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Delete a list of home zones from the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Modify an existing home zone in the BroadWorks Mobile Manager. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request the group level data associated with Call Processing Policy. + The response is either a GroupCallProcessingGetPolicyResponse19sp1 or an + ErrorResponse. + + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowDepartmentCLIDNameOverride) + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, + useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings + (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, + allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowDepartmentCLIDNameOverride + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + + + + + + + + + + + + + + + + true + true + + + Response to GroupCallProcessingGetPolicyRequest. + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + allowDepartmentCLIDNameOverride + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Modify the group level data associated with Call Procesing Policy. + The response is either a SuccessResponse or an ErrorResponse. + The useGroupCLIDSetting attribute controls the CLID settings + (clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride) + + The allowDepartmentCLID attribute is automatically set to false when the useGroupName attribute is set to false. + + The useGroupMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useGroupCallLimitsSetting attribute controls the Call Limits settings + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useGroupTranslationRoutingSetting attribute controls the routing and translation settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing) + + The useGroupDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) + + The following elements are only used in AS data mode: + useGroupDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + allowDepartmentCLIDNameOverride + allowConfigurableCLIDForRedirectingIdentity + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add one or more entries to a group's common phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete one or more entries from a group's common phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a group's common phone list. + The response is either a GroupCommonPhoneListGetListResponse or an ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. + In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an + ErrorResponse is returned. + + + + + + + + + + + + + + + + + + + + Response to the GroupCommonPhoneListGetListRequest. + The response contains the group's common phone list. + + + + + + + + + + + + + + + Modify an entry in a group's common phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Assign a replacement list of Communication Barring Profiles to a group. + The response is either a SuccessResponse or an ErrorResponse. + This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider. + + + + + + + + + + + + + + + + + true + false + + + Get the list of all communication barring profiles assigned to the group. The response is either a + GroupCommunicationBarringProfileGetAssignedListResponse or an ErrorResponse. + This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider. + + + + + + + + + + + + + + + + Response to the GroupCommunicationBarringProfileGetAssignedListRequest. + The response contains a simple list of all communication barring profiles assigned to the group. + + + + + + + + + + + + + + + Add a list of Communication Barring Authorization codes to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a list of Communication Barring Authorization codes from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of Communication Barring Authorization Codes for a group. + The response is either a GroupCommunicationBarringAuthorizationCodeGetListResponse + or an ErorResponse. + + + + + + + + + + + + + + + + Response to GroupCommunicationBarringAuthorizationCodeGetListRequest. + Contains a list of Communication Barring Authorization Codes + assigned to the group. + + + + + + + + + + + + + + + Gets Communication Barring setting for a group. + The response is either a GroupCommunicationBarringGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemCommunicationBarringGetRequest. + + + + + + + + + + + + + + + + Gets Communication Barring setting for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Rebuild the group default config file for the specified device type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Rebuild the config file for a specified device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Reorder the lines of a group device. You can not add or delete line ports, only + re-ordering the list is allowed. The ordered list of line ports can be obtained + with the GroupAccessDeviceGetRequest16 command. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Reset a specific group device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Reset all the devices of the specified device type in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to set a new group default configuration file for a device type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Adds a Custom Contact Directory to a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Deletes a Custom Contact Directory to a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of users that can be part of a custom contact directory. + The response is either GroupCustomContactDirectoryGetAvailableUserListResponse17 or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the + GroupCustomContactDirectoryGetAvailableUserListRequest17. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Virtual On-Net Phone Number", "Group Id", "Is Virtual On-Net User", + "Phone Number", "Extension", "Department", "Email Address". + + If the entry represents a Virtual On-Net user then "User Id" is blank, + the "Virtual On-Net Phone Number" contains the phone Number of the + Virtual On-Net user, the "Group Id" contains the Virtual On-Net user's + group and the "Is Virtual On-Net User" contains true. + + If the entry represents a BroadWorks user then the "User Id" contains + his BroadWorks userId, the "Virtual On-Net Phone Number" and + "Group Id" fields are blank and the "Is Virtual On-Net User" + contains false. + + + + + + + + + + + + + + + Gets the list of Custom Contact Directories for a group. + The response is either GroupCustomContactDirectoryGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCustomContactDirectoryGetListRequest. + The response contains all the group's custom contact directory names. + + + + + + + + + + + + + + + Gets a Custom Contact Directory in a group. + The response is either GroupCustomContactDirectoryGetResponse17 or + ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. + In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an + ErrorResponse is returned. + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCustomContactDirectoryGetRequest17. + The response contains all the contacts in the group's given custom + contact directory. Contains a table with column headings: "User Id", + "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Virtual On-Net Phone Number", "Group Id", + "Is Virtual On-Net User", "Department", "Phone Number", "Extension", + "Mobile", "Email Address", "Yahoo Id", "Title", "IMP Id". + If the entry represents a Virtual On-Net user then "User Id" is blank, + the "Virtual On-Net Phone Number" contains the phone Number of the + Virtual On-Net user, the "Group Id" contains the Virtual On-Net user's + group and the "Is Virtual On-Net User" contains true. + If the entry represents a BroadWorks user then the "User Id" contains + his BroadWorks userId, the "Virtual On-Net Phone Number" and + "Group Id" fields are field is blank and the "Is Virtual On-Net User" + contains false. + + + + + + + + + + + + + + + Adds a Custom Contact Directory to a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Delete a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a department to a group. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + callingLineIdName + caliingLineIdPhoneNumber + + + + + + + + + + + + + + + + + + + + Add a department administrator to a group department. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a group department administrator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of department administrators for the department. + The response is either a GroupDepartmentAdminGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to GroupDepartmentAdminGetListRequest. + Contains a 5 column table with column headings "Administrator ID", + "Last Name", "First Name", "Department", "Language". + + + + + + + + + + + + + + + Get a group department administrators profile. + The response is either a GroupDepartmentAdminGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupDepartmentAdminGetRequest. + The response contains the group department administrators profile information. + + + + + + + + + + + + + + + + + + + Modify a group department administrator. + Since old password is not specified here, any password rule related to old password + does not apply. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Delete a department from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of departments that could be the parent department of the specified + department. The department itself and all its descendents are not eligible to be + the parent department. If the group belongs to an enterprise, it also returns the + departments defined in the enterprise it belongs to. + The response is either GroupDepartmentGetAvailableParentListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupDepartmentGetAvailableParentListRequest. + The response includes two parallel arrays of department keys and department display names. + + + + + + + + + + + + + + + + Request a list of departments in a group. You may request only the + list of departments defined at the group-level, or you may request + the list of all departments in the group including all the departments + defined within the enterprise the group belongs to. + The response is either GroupDepartmentGetListResponse18 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupDepartmentGetListRequest18. + Contains a table of department attributes. + The column headings are: "Is Enterprise Department", "Department Name", "Full Path Name", "Calling Line Id Name", and "Calling Line Id Phone Number" + + + + + + + + + + + + + + + Request the attributes of a department. + The response is either a GroupDepartmentGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupDepartmentGetRequest. + The following elements are only used in AS data mode: + callingLineIdName + caliingLineIdPhoneNumber + + + + + + + + + + + + + + + + + Modify a department of a group. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + callingLineIdName + caliingLineIdPhoneNumber + + + + + + + + + + + + + + + + + + + + + true + false + + + Request device management's events for a specific queue. + It is possible to restrict the number of rows returned using + responseSizeLimit. + If eventQueueType is not specified, the events from all the + event queues are returned. + The response is either a GroupDeviceManagementEventGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to GroupDeviceManagementEventGetListRequest. + Contains a table with column headings: "Event Id", "Status", "Action", + "Level", "Type", "Additional Info", "Is Local", "Completion %", + "Pushed/ Same Hash/ Not Pushed", "Login Id", "Start Time", + "Process Time". + "Event Id" is a unique identifer for the event. + "Status" can be: Pending, Queued, In Progress, + Process On Other Host, Stale, Completed, Canceled. + "Action" can be: Delete, Download, Rebuild, Reset, Upload. + "Level" can be: Device, Device Type, Device Type Group, Group, User. + "Type" can be: Automatic, Manual. + "Additional Info" includes the affected device type, device or group. + It depends on the level of the event: + Device Profile: "Device Name" "Service Provider Id" "Group Id" + Device Type: "Device Type Name" + Device Type Group: "Service Provider Id" "Group Id" "Device Type Name" + Group: "Service Provider Id" "Group Id" + User: "User Id" + "Is Local" is set to "yes" if the event is processed on the server + who received the request, "no" otherwise meaning that the event is + processed on another server. + "Completion %" provides an estimate of the completion of the event. + A percentage is given, the current number of completed expanded event, + and the total number of expanded event. + "Pushed/ Same Hash/ Not Pushed" gives the total number of files that + were pushed, not pushed because of same hash, and not pushed when + processing the event. + "LoginId" is the user or admin id who triggered the event. + "Start Time" is the date when the event was started. The display + shows the month, days, hours, and minutes (MM-dd hh:mm). + "Process Time" is the time taken to process the event in hours, + minutes, seconds, and milliseconds (hhhh:mm:ss.SSS). + Each row represents an event sorted by priority of processing. The + first row in the table is an event that has an associated expanded + event currently being processed or next in line to be processed. + + + + + + + + + + + + + + + true + false + + + Request the number of access device of a particular device type and group. + If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset. + Devices are counted only if their device type supports Device Management. + An error is returned if deviceType is specified but does not support device management. + The response is either GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Response to GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupRequest. + + + + + + + + + + + + + + + true + false + + + Cancel pending and in progress events. A list of individual events can + be canceled. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to add a static configuration tag for an access device type used in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to delete static configuration tags for an access device type used in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to modify a static configuration tag for an access device type used in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to get the list of custom configuration tags managed by the Device Management System, on a per-device type basis for a group. + The response is either GroupDeviceTypeCustomTagGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupDeviceTypeCustomTagGetListRequest. + Contains a table of custom configuration tags managed by the Device Management System on a per-device type basis for a group. + The column headings are: "Tag Name", "Tag Value" + + + + + + + + + + + + + + + Request to modify a specified device type file for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to get the list of device type files managed by the Device Management System, on a per-group basis. + The response is either GroupDeviceTypeFileGetListResponse21 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupDeviceTypeFileGetListRequest21. + Contains a table of device type files managed by the Device Management System, on a per-group basis. + The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL". + + + + + + + + + + + + + + + + Request to get a group device type file. + The response is either GroupDeviceTypeFileGetResponse16sp1 or ErrorResponse. + + + + + + + + + + + + + + + + + + Response to GroupDeviceTypeFileGetRequest16sp1. + + + + + + + + + + + + + + + + + + + Request the Group level data associated with Dial Plan Policy. + The response is either a GroupDialPlanPolicyGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupDialPlanPolicyGetRequest17 + + + + + + + + + + + + + + + + + + + + Modify the Group level data associated with Dial Plan Policy. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Request the Group level data associated with Dial Plan Policy. + The response is either a GroupDialPlanPolicyGetAccessCodeListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupDialPlanPolicyGetAccessCodeListRequest + Contains a table with column headings: "Access Code", + "Enable Secondary Dial Tone", "Description" + + + + + + + + + + + + + + + Request access code data associated with Group level Dial Plan Policy access codes. + The response is either a GroupDialPlanPolicyGetAccessCodeResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupDialPlanPolicyGetAccessCodeRequest + + + + + + + + + + + + + + + + + + Request to add a Group level Dial Plan Access Code and its all attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Request to delete a Group level Dial Plan Access Code and its all attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to modify a Group level Dial Plan Access Code and its attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Request the group's digit collection attributes. + The response is either a GroupDigitCollectionGetResponse13mp4 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupDigitCollectionGetRequest13mp4. + + + + + + + + + + + + + + + + + + Modifies the group's digit collection attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Activate a list of assigned DNs on a group. It is possible to activate either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + + It is not an error to activate an already activated DN + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Assign a list of service provider DNs to a group. It is possible to assign either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The DNs must have previously been added to the service provider or enterprise. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Deactivate a list of activated DNs on a group. The DNs then become available for + activation again. It is possible to deactivate either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + It is not an error to deactivate an already deactivated DN. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Get the list of activated and deactivated DNs in a group. + Ranges of DNs with identical assignment and activation properties are coalesced + to a single table row entry. + Only DNs assigned to a users are listed in the response when the number + activation Mode is set to "User Activation Enabled" + Dns assigned to the IMRN pool are not listed in the response. + The response is either a GroupDnGetActivationListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupDnGetActivationListRequest. + The response contains a table with columns: "Phone Numbers", and "Activated". ". Phone Numbers are only returned if assigned to a user. + The "Phone Numbers" column contains either a single DN or a range of DNs. + The "Activated" column indicates if the phone number(s) are activated or not. + + + + + + + + + + + + + + + Get the list of assigned and unassigned DNs in a group. Each DN can be assigned + to a user and/or department. Ranges of DNs with identical assignment and activation properties + are coalesced to a single table row entry. + Dns assigned to the IMRN pool are not listed in the response. + The response is either a GroupDnGetAssignmentListResponse18 or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupDnGetAssignmentListRequest18. + The response contains a table with columns: "Phone Numbers", "Department", "Activated", "User Id", + "Last Name", "First Name", "Extension", "Email Address", "User Type". + The "Phone Numbers" column contains either a single DN or a range of DNs. + The "User Id", "Last Name" and "First Name" columns contains the corresponding attributes of the user possessing the DN(s). + For a service instance, "Last Name" contains the service instance name and "First Name" column contains the corresponding enumerated UserType value. + The "Department" column contains the department of the DN, not the department of the user or service instance. + The "Activated" column indicates if the DN or DN range has been activated. Only has a value if the DN(s) is assigned to a user. + The "User Type" column contains the corresponding enumerated UserType value. + NOTE: the same phone number can show up in the list twice if the phone number is being used as the group calling line Id. + + + + + + + + + + + + + + + Get the list of DNs that are assigned to a group and still available for + assignment to users within the group with the department name, if the DN + is assigned to the department. + Dns assigned to the IMRN pool are not listed in the response. + The response is either a GroupDnGetDetailedAvailableListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupDnGetDetailedAvailableListRequest. + The response contains a table with columns: "Phone Number", "Department". + The "Phone Numbers" column contains a single DN. + The "Department" column contains the department of the DN if the DN is part of the department. + The "Activated" column indicates if the DN has been activated. + Only has a value if the DN(s) is assigned to a user or if "Group + Enable Activation Mode" is enabled. + + + + + + + + + + + + + + + Get the list of DNs that are assigned to a group and still available for + assignment to users or service instances within the group. + Dns assigned to the IMRN pool are not listed in the response. + The response is either a GroupDnGetAvailableListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupDnGetAvailableListRequest. + The response contains the list of DNs that are assigned to a group and still available for + assignment to users or service instances within the group. + + + + + + + + + + + + + + + Get a list of group DNs that are not assigned to user, service instances or IMRN pool. + The Dns are returned in a list of DNs or DN ranges and formated in E164 format for display. + The response is either a GroupDnGetAvailableRangeListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupDnGetAvailableRangesListRequest. + The response contains the list of group DNs that are not assigned to user, service instances or IMRN pool. + The Dns are returned in a list of DNs or DN ranges and formated in E164 format for display. + + + + + + + + + + + + + + + Get the list of DNs that are assigned to a group. + Dns assigned to the IMRN pool are not listed in the response. + The response is either a GroupDnGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupDnGetListRequest. + The response contains the list of DNs assigned to the group. + + + + + + + + + + + + + + + Get the list of assigned and unassigned DN ranges in a group. + Dns assigned to the IMRN pool are not listed in the response. + The response is either a GroupDnGetSummaryListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupDnGetSummaryListRequest. + The response contains a table with columns: "Phone Numbers", "Assigned". + The "Phone Numbers" column contains either a single DN or a range of DNs. + The "Assigned" column contains a boolean flag indicating if the DN(s) are + currently assigned to a user or service instance. + The "Activated" column indicates if the DN or DN range has been activated. + Only has a value if the DN(s) is assigned to a user or if "Group Enable Activation + Mode" is enabled. + + + + + + + + + + + + + + + Assign a list of group DNs to a department. If the department is not specified, this + will make the DNs become unassigned from any department. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Unassign a list of service provider DNs from a group. The DNs then become available for + assignment to other groups. It is possible to unassign either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Assign a list of domains to a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request a list of users within in a group that have a given domain assigned. + The response is either GroupDomainGetAssignedUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupDomainGetAssignedUserListRequest. + The table columns are: "User Id", "Last Name", "First Name", "Department", "Phone Number", "Email Address", + "Service Provider Id", "Group Id", "Hiragana Last Name" and "Hiragana First Name", "Extension". + + + + + + + + + + + + + + + Requests the list of all domains assigned to a group. + The response is either GroupDomainGetAssignedListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Contains a simple list of all group domain names. + + + + + + + + + + + + + + + + Unassign a list of domains from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to search endpoints in the group. + The response is either GroupEndpointGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to GroupEndpointGetListRequest. + The column headings for the endpointTable are: + "Line/Port", "Last Name", "First Name", "User Id", "User Type", "Phone Number", "Extension", "Device Type", "Device Name", "Net Address", "MAC Address", "Department", "Email Address". + Possible values for User Type are �User�, �CCBasic�, �CCStandard�, �CCPremium�, �RP�, �MOH�, �MOHVideo�. + + + + + + + + + + + + + + + true + false + + + Request the group level configuration for Exchange Integration. + The response is either a GroupExchangeIntegrationGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupExchangeIntegrationGetRequest. + + + + + + + + + + + + + + + + + true + false + + + Modify the group level configuration for Exchange Integration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to assign the user services and service packs to all existing users within the group. + BroadSoft recommends using this command only for small groups with less than 100 users. This + command will return an error if the group has over 500 users. The recommended way to bulk + assign/unassign services is Service Pack Migration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Requests to unassign the user services and service packs for all existing users within the group. + BroadSoft recommends using this command only for small groups with less than 100 users. This + command will return an error if the group has over 500 users. The recommended way to bulk + assign/unassign services is Service Pack Migration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the group's extension length. + The response is either a GroupExtensionLengthGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupExtensionLengthGetRequest17. + + + + + + + + + + + + + + + + + Modify the group's extension length range. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Get group FAC code level and the list of feature access codes for a group. + The response is either a GroupFeatureAccessCodeGetResponse20 or an + ErrorResponse. + Returned Feature Access Codes may be group specific, or Service Provider + Feature Access Codes, depending on FAC code level. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + + true + false + + + Response to the GroupFeatureAccessCodeGetRequest21. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + + true + false + + + Modify group FAC code level and the list of feature access codes for a + group. + The response is either a SuccessResponse or an ErrorResponse. + Note: choice element is only valid when useFeatureAccessCodeLevel is set + to "Group", otherwise an ErrorResponse will be returned. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + + + + + + + Add a new group file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Delete a group file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Modify a group file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Request the list of group users for a file repository in the system. + The response is either a GroupFileRepositoryDeviceUserGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupFileRepositoryDeviceUserGetListRequest. + Contains a table with column headings : "User Name","Allow Delete","Allow Get","Allow Put" in a row for each file repository service provider user. + + + + + + + + + + + + + + + Request the default profile for a group. + The response is either a GroupGetDefaultResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupGetDefaultRequest. All values are default values for a group's profile. + + + + + + + + + + + + + + + + + + Request the list of groups in a service provider or enterprise. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a GroupGetListInServiceProviderResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to GroupGetListInServiceProviderRequest. + Contains a 3 column table with column headings: "Group Id", "Group Name", "User Limit" + and a row for each group. + + + + + + + + + + + + + + + Request the list of groups in the system. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a GroupGetListInSystemResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to GroupGetListInSystemRequest. + Contains a table with column headings: "Group Id", "Group Name", "User Limit", "Organization Id", "Organization Type" + and a row for each group. + The "Organization Id" column is populated with either a service provider Id or an enterprise Id. + The "Organization Type" column is populated with one of the enumerated strings defined in the + OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType. + + + + + + + + + + + + + + + Get the profile for a group. + The response is either a GroupGetResponse14sp7 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupGetRequest14sp7. + The response contains the group's profile information. + + + + + + + + + + + + + + + + + + + + + + + + + + Get the list of users assigned the user service or service pack. + The response is either a GroupGetUserServiceAssignedUserListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Return a table containing the list of users assigned the user service + or service pack. The table contains columns: "User Id", "Last Name", + "First Name", "Department", "Phone Number", "Email Address", "Hiragana Last Name"; + "Hiragana First Name", "Extension". + This is a response to the GroupGetUserServiceAssignedUserListRequest. + + + + + + + + + + + + + + + true + false + + + Assign a list of group DNs to the IMRN pool. It is possible to assign either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request a summary table of all DNs in a group IMRN pool. + The response is either GroupIMRNGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupIMRNGetListRequest. + + + + + + + + + + + + + + + true + false + + + Unassign a list of group DNs from the group IMRN pool. The DNs then become available for + assignment to users. It is possible to delete either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Modify the profile for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Assign a list of Network Classes of Service to a group. + A default Network Class of Service must be specified unless there is already one assigned to the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Assign a Network Classes of Service to all users with in a + group. The Network Classes of Service must be currently assigned to + the group. The response is either a SuccessResponse or + an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of Network Classes of Service assigned to a group. + The response is either a GroupNetworkClassOfServiceGetAssignedListResponse + or an ErorResponse. + + + + + + + + + + + + + + + + Response to GroupNetworkClassOfServiceGetAssignedListRequest. + Contains a table of all Network Classes of Service assigned to + the group. The column headings are: "Name", "Description" and "Default". + + + + + + + + + + + + + + + Get a list of users within a group that have a given Network Class + of Service assigned. + The response is either a GroupNetworkClassOfServiceGetAssignedUserListResponse21 + or an ErorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupNetworkClassOfServiceGetAssignedUserListRequest21. + Contains a table of users that have the Network Class of Service + assigned. The column headings are: "User Id", "User Type", "Last Name", "First Name", + "Department", "Phone Number", "Email Address", "Service Provider Id", + "Group Id", "Hiragana Last Name" and "Hiragana First Name" , "Extension". + The User type column will display Auto Attendant and the Call Center subtype. + Call Center - Basic, Call Center - Standard and Call Center - Premium will be displayed instead of Call Center and + Auto Attendant (for the Basic Auto Attendant) and Auto Attendant - Standard instead of Auto Attendant. + + + + + + + + + + + + + + + Modifies the default Network Classes of Service of a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Unassign a list of Network Classes of Service from a group. + If the default Network Class of Service is being unassigned, a new one must be specified unless there are no more + Network Classes of Service assigned to the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to assign the user services and service packs to all new users created within the group + after the completion of this request. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Requests to unassign the user services and service packs for all new users created within the group + after the completion of this request. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Assign a list of Office Zones to a group. + The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional. + Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the group otherwise the request will fail. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a list of Office Zones assigned to a group. + The response is either a GroupOfficeZoneGetAssignedListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOfficeZoneGetAssignedListRequest. + Contains a table of all Office Zones assigned to the + group. The column headings are: "Name", "Description" and "Default". + + + + + + + + + + + + + + + Get a list of users within a group that have a given Office Zone assigned. + The response is either a GroupOfficeZoneGetAssignedUserListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupOfiiceZoneGetAssignedUserListRequest. + Contains a table of users that have the Office Zone assigned. The column headings are: "User Id", "User Type", "Last Name", + "First Name", "Department", "Phone Number", "Email Address", "Hiragana Last Name" and "Hiragana First Name", "Extension". + Office Zones can only be unassigned if the Location-Based Calling Restrictions has been authorized to the group otherwise the request will fail. + + + + + + + + + + + + + + + Unassign a list of OfficeZones from a group. Note: a new default must be provided if unassigning the current default. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Requests the group's password rules setting that is applicable to + users within the group. + The response is either GroupPasswordRulesGetResponse16 or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPasswordRulesGetRequest16. + Contains the password rules applicable to users within the group. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the group's password rules setting that apply to the + users within the group. The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request a table containing the phone directory for a group. + If the specified group is part of an enterprise, the directory + includes all users in the enterprise and all entries in the enterprise + common phone list and the common phone list of the specified group. + + If the specified group is part of a service provider, the directory + includes all users in the group and all entries in the common phone + list of the specified group. + + It is possible to search by various criteria to restrict the number of + rows returned. + + Multiple search criteria are logically ANDed together. + The response is either GroupPhoneDirectoryGetListResponse18 or + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupPhoneDirectoryGetListRequest18. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", + "Department", "Hiragana Name", "Group Id", "Yahoo Id", "User Id", "IMP Id" and "Is Virtual On-Net User". + + If extended directory information is requested, the following columns are also included: + "First Name", "Last Name", "Pager", "Title", "Time Zone", + "Location", "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country". + + + + + + + + + + + + + + + Requests the Group's policy settings. + The response is either GroupPolicyGetResponse20 or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPolicyGetRequest20. + Contains the policy settings for the group. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the policies for a Group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the group's service authorization status. + The response is either GroupServiceGetAuthorizationListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupServiceGetAuthorizationListRequest. + Contains three tables, one for the service packs, one for the group services, and one for + the user services. + The user table has the following column headings: + "Service Name", "Authorized", "Assigned", "Limited", "Quantity", "Usage", "Licensed", "Allowed", "User Assignable", "Group Service Assignable". + The group service table has the following column headings: + "Service Name", "Authorized", "Assigned", "Limited", "Quantity", "Usage", "Licensed", "Allowed". + The service pack table's column headings are: + "Service Pack Name", "Authorized", "Assigned", "Limited", "Allocated", "Allowed", "Usage", "Description". + + + + + + + + + + + + + + + + + Requests the list of services and service packs authorized to a group. + The response is either GroupServiceGetAuthorizedListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupServiceGetAuthorizedListRequest. + + + + + + + + + + + + + + + + + Requests to change the group's service authorization status. + The boolean flags are used to authorize or unauthorize services and packs. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Requests the group's passcode rules setting. + The response is either GroupPortalPasscodeRulesGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPortalPasscodeRulesGetRequest19. + Contains the group's passcode rules setting. + + The following elements are only used in AS data mode: + numberOfRepeatedDigits + disallowRepeatedPatterns + disallowContiguousSequences + numberOfAscendingDigits + numberOfDescendingDigits + numberOfPreviousPasscodes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the group's passcode rules setting. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + numberOfRepeatedDigits + disallowRepeatedPatterns + disallowContiguousSequences + numberOfAscendingDigits + numberOfDescendingDigits + numberOfPreviousPasscodes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Assign a list of route point external systems to a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Requests the list of all Route Point External Systems assigned to a group. + The response is either GroupRoutePointExternalSystemGetAssignedListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupRoutePointExternalSystemGetAssignedListRequest. + Contains a table of all Route Point External Systems assigned to the + group. The column headings are: "Name" and "Description". + + + + + + + + + + + + + + + Request a list of route points within in a group that have a given external system assigned. + The response is either GroupRoutePointExternalSystemGetAssignedRoutePointListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to the GroupRoutePointExternalSystemGetAssignedRoutePointListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department". + The column values for "Video" can either be "true", or "false". + + + + + + + + + + + + + + + Unassign a list of route point external systems from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request the routing profile for the group. + The response is either a GroupRoutingProfileGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupRoutingProfileGetRequest. + + + + + + + + + + + + + + + Requests to modify the routing profile for a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Add an event to group schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a group schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a list of events from a group schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a list of group schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the list of events of a group schedule. + The response is either a GroupScheduleGetEventListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupScheduleGetEventListRequest. + The response contains a list of events. + + + + + + + + + + + + + + + Get an event from a group schedule. + The response is either a GroupScheduleGetEventResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to GroupScheduleGetEventRequest. + The response contains the event of the group schedule. + + + + + + + + + + + + + + + + + + + + + + + + Get the list of schedules viewable by a group. The list can be filtered by schedule type. + The response is either a GroupScheduleGetListResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupScheduleGetListRequest17sp1. + The response contains a list of group schedules. If the group belongs to an enterprise, + it also contains the schedules for the enterprise. + + + + + + + + + + + + + + + Modify an event of a group schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a group schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Assign one or more group services to the group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to determine if a GroupService is assigned to the group. + + + + + + + + + + + + + + + + + Returns true if the GroupService is assigned, otherwise false. + + + + + + + + + + + + + + + true + true + + + Lookup if the given number is defined in the specified service in the group. + The response is GroupServicePhoneNumberLookupResponse. + + + + + + + + + + + + + + + + + + true + true + + + Response to the GroupServicePhoneNumberLookupRequest. + The column headings for the userTable are: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension" and "Department". + + + + + + + + + + + + + + + Unassign one or more of the group's assigned services. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of devices can be assigned to session admission control group for the group. + The response is either an GroupSessionAdmissionControlGetAvailableDeviceListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to GroupSessionAdmissionControlGetAvailableDeviceListRequest. + Contains a table of devices can be assigned to session admission control group in the group. + + + + + + + + + + + + + + + true + false + + + Get the session admission control capacity for the group. + The response is either a GroupSessionAdmissionControlGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the GroupSessionAdmissionControlGetRequest. + The response contains the session admission control capacity allocated for the group. + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify session admission control capacity for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to add one ore more devices to a group level session admission control group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to add a session admission control group for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to delete one or more devices from a group level session admission control group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to delete one or more session admission control groups for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of session admission control group for the group. + The response is either a GroupSessionAdmissionControlGroupGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupSessionAdmissionControlGroupGetListRequest. + Contains a table of session admission control group configured in the group. + The column headings are: "Name", "Is Default", "Maximum Sessions", "Maximum Originating Sessions", "Maximum Terminating Sessions". + + + + + + + + + + + + + + + true + false + + + Request to get a session admission control group for the group. + The response is either a GroupSessionAdmissionControlGroupGetResponse19sp1 or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to GroupSessionAdmissionControlGroupGetRequest19sp1. + Returns the profile information for the session admission control group. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a session admission control group for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns a list of all Public User Identities and associated data in a group. + The response is either a GroupShInterfaceGetUserListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupShInterfaceGetUserListRequest. + The response contains the Sh Non Transparent data and associated Public User Identity + information for every Public User Identity in the group. + + + + + + + + + + + + + + + Requests the list of available trunk groups within a group. + The response is either GroupTrunkGroupGetAvailableDetailListResponse or + ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetAvailableDetailListRequest. + + + + + + + + + + + + + + + + + + + + + + + + Represents either an existing user's Id or an existing Virtual + On-Net user's DN. For a DN the groupId is used to make it unique + within an Enterprise, however the groupId is not used with Service + Providers. + + + + + + + + + + + + + + + + Department calling line ID name. + + + + + + + + + + + A list of userIds and/or Virtual On-Net user DNs that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + Choices for the group digit collection feature to decide which type of settings to use. + + + + + + + + + + + + + Feature Access Code Level defining group policy how Feature Access Codes will be used by a group. + + + + + + + + + + + + Configured maximum number of users in a group. + + + + + + + + + + + + ShInterface User List Entry. + + + + + + + + + + + + + + + + Modify the Application Server set for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the Application Server set for a group. + The response is either a GroupApplicationServerSetGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupApplicationServerSetGetRequest. + The response contains the group's Application Server set information. + + + + + + + + + + + + + + + Request to get the list of available ports in a device. + The response is either GroupAccessDeviceAvailablePortGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupAccessDeviceAvailablePortGetListRequest. + Contains a list of available ports in a device using static mode. The list is empty in case the device is using dynamic mode. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaLogin.xsd b/share/OCISchemaAS/OCISchemaLogin.xsd new file mode 100644 index 0000000..cde0458 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaLogin.xsd @@ -0,0 +1,667 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + AuthenticationRequest is 1st stage of the 2 stage OCI login process. + + + + + + + + + + + + + + + AuthenticationRequest/Response is 1st stage of the 2 stage OCI login process. + + + + + + + + + + + + + + + + + AuthenticationVerifyRequest14sp8 is used to authenticate a user either by userId/password, userId/sip username/sip password, + dn/passcode or a token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest. + The phone number may be any DN associated with a user. + The response is a AuthenticationVerifyResponse14sp8 or an ErrorResponse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to AuthenticationVerifyRequest14sp8 + If a phoneNumber is returned, it will be the primay DN of the user + + + + + + + + + + + + + + + + + + + + + + + + + AvailabilityTestRequest is for high-availability support. Response is either SuccessResponse + or ErrorResponse. + + + + + + + + + + + + + Get the address and credentials of the File Repository hosting the requested access device file. + Also get the file name and path on the File Repository. + The response is either DeviceManagementFileAuthLocationGetResponse21 or ErrorResponse. + The following elements are only used in AS data mode and will fail in HSS data mode: + deviceToken + + + + + + + + + + + + + + + + + + + + + + + + + This is a response to DeviceManagementFileAuthLocationGetRequest21. + Return the address and credentials of the File Repository hosting the requested access device file. + Also return the file name and path on the File Repository. + Also returns the status of the file authentication. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Informs BroadWorks that a file was uploaded to the repository. The response is always a SuccessResponse. + + + + + + + + + + + + + + + + This command is part of the Portal API. + Sent when a Web or CLI user logs in using external authentication. + The password must be hashed. The password hashing algorithm is: + 1) The message digest of the user's plain password is calculated using the SHA algorithm. + 2) For every four bits in the 160-bit digest, starting from the first bit, it is + converted into a character in ASCII Hex format (0 through 9, a through f). + The result is a 40-character string, for example, f7a9e24777ec23212c54d7a350bc5bea5477fdbb. + 3) The above string then is used to populate the password field in the request. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + This command allows a BroadWorks or Third-Party Client Application to + create a Single Sign-On token for a user. + The response is either ExternalAuthenticationCreateLoginTokenResponse + or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ExternalAuthenticationCreateLoginTokenRequest. + + + + + + + + + + + + + + + LoginRequest14sp4 is 2nd stage of the 2 stage OCI login process. + The signedPassword is not required for external authentication login from a trusted host (ACL). + + + + + + + + + + + + + + + + + LoginRequest14sp4/Response14sp4 is 2nd stage of the 2 stage OCI login process. + + + + + + + + + + + + + + + + + + + + + + LogoutRequest is sent when an OCI user logs out or when connection is lost. + This command can be sent either to the server, or to the client from OCS. + Response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Modify the password for a user/administrator. + When oldPassword is specified, password rule applies. If oldPassword in not specified, + any password rule related to old password does not apply. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Requests information about the primary server for high-availability support. + + + + + + + + + Dual homed side is private? + + + + + + + For optimization, we only get the hostname and addresses for primary if + they are explicitly requested or if the current server is not the primary. + So you might get back the list of server addresses even if you did not + ask for the list if the request is not serviced by the primary server. + + + + + + + + + + + + Information about the primary server in the high-availablity cluster. + For optimization, we only get the hostname and addresses for primary if they are + explicitly requested or if the current server is not the primary. + + + + + + + + Is the server that processed this request the primary in the cluster? + + + + + Primary server's hostname. + + + + + List of addresses for primary server in cluster. + + + + + List of private addresses for primary server in cluster. + + + + + + + + + + + Get the public cluster fully qualified domain name (FQDN). + The response is either a PublicClusterGetFullyQualifiedDomainNameResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to PublicClusterGetFullyQualifiedDomainNameRequest. + + + + + + + + + + + + + + + Get the tutorial flag setting for a user or admin. + The response is either a TutorialFlagGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the TutorialFlagGetRequest. + + + + + + + + + + + + + + + Modify the tutorial flag setting for a user or admin. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + UserGetLoginInfoRequest is used to access login information for a user + either by a userId or dn. The phone number may be any + DN associated with a user. + The response is a UserGetLoginInfoResponse or an ErrorResponse + + + + + + + + + + + + + + + + + + Response to UserGetLoginInfoRequest + If a phoneNumber is returned, it will be the primay DN of the user + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + This command allows a BroadWorks or Third-Party Client Application to + create a Single Sign-On token for a device of a user. + The token is created only if: + 1. the specified user is the owner of a lineport on the specified device + (including a trunk user on a trunk device). + 2. and, the specified device is not in locked state. + 3. and, the device type of the device does support Device Management. + The response is either UserSingleSignOnCreateDeviceTokenResponse + or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to UserSingleSignOnCreateDeviceTokenRequest. + + + + + + + + + + + + + + + Query the provisioning server to verify the session is authorized. Most + applications should not need this command, because the provisioning server + verifies the session is authorized for all commands. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + Logout request reason. + + + + + + + + + + + + + The status of a Device Management File Authentication. + The possible values are: + "Challenge" : authentication is required. + "Need Digest Authntication" : client needs to use digest authentication. + "Need User Password Authntication" : client needs to use user/pass authentication. + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaSearchCriteria.xsd b/share/OCISchemaAS/OCISchemaSearchCriteria.xsd new file mode 100644 index 0000000..c9c6a73 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaSearchCriteria.xsd @@ -0,0 +1,1489 @@ + + + + + + + + + + + + + + + Maximum number of rows to return in response to a search. + By convention, elements of this type can be omitted to allow an + unlimited number or rows in the search result. + + + + + + + + + + Abstract base type for specifying search criteria. A search criteria is an optional element + used to restrict the number of rows returned when requesting a potentially large set of + data from the provisioning server. + + + + + + + + Criteria for searching for device line/port, or SIPURI domain part. + + + + + + + + + + + + + + + + Criteria for searching for a call center + + + + + + + + + + + + + + + + Criteria for searching for a particular call center enhanced reporting report template. + + + + + + + + + + + + + + Criteria for searching for a particular call center enhanced reporting report template. + + + + + + + + + + + + + + + + Criteria for searching for a call center enhanced reporting scheduled report name. + + + + + + + + + + + + + + + + Criteria for searching for device line/port, or SIPURI user part. + + + + + + + + + + + + + + + + + + + + + + + + Criteria for searching for device MAC address. + + + + + + + + + + + + + + + + Criteria for searching for device name. + + + + + + + + + + + + + + + + Criteria for searching for device network address. + + + + + + + + + + + + + + + + Criteria for searching for device serial number. + + + + + + + + + + + + + + + + Criteria for searching for device type. + + + + + + + + + + + + + + + + Criteria for searching for digit pattern. + + + + + + + + + + + + + + + + Criteria for searching for a DN. + + + + + + + + + + + + + + + + Criteria for searching for call center scheduled report created by a + supervisor or administrator. + + + + + + + + + + + + + + Criteria for searching for a particular call center scheduled report's service provider. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified call center scheduled + report's group. + + + + + + + + + + + + + + + Criteria for searching a Call Center Agent Threshold Profile. + + + + + + + + + + + + + + + + Criteria for searching for an Announcement File Name. + + + + + + + + + + + + + + + + Criteria for searching for a Service Code. + + + + + + + + + + + + + + + + Criteria for searching for a Service Code description. + + + + + + + + + + + + + + + + Criteria for searching for a system service DN. + + + + + + + + + + + + + + + + Criteria for searching for a name in an enterprise common phone list. + + + + + + + + + + + + + + + + Criteria for searching for a phone number in an enterprise common phone list. + + + + + + + + + + + + + + + + Criteria for searching for a email address. + + + + + + + + + + + + + + + + Criteria for searching for a particular fully specified alternate trunk identity. + In IMS mode, it only applies to the user part of alternate trunk identity. + + + + + + + + + + + + + + + + Criteria for searching for alternate trunk identity domain part. + + + + + + + + + + + + + + + + Criteria for searching for a particular fully specified custom contact directory. + + + + + + + + + + + + + + Criteria for searching for a particular device level. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified service provider associated with a device. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified device type. + + + + + + + + + + + + + + Criteria for searching for users with/without Route List feature assigned. + + + + + + + + + + + + + + Criteria for searching for a particular additional info of a DeviceManagement event. + + + + + + + + + + + + + + + + Criteria for searching for a particular login id. + + + + + + + + + + + + + + + + Criteria for searching for a particular fully specified DeviceManagement event action. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified DeviceManagement event level. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified Device Management event in progress or pending status. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified Device Management completed event status. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified DeviceManagement event type. + + + + + + + + + + + + + + Criteria for searching for a particular Dn activation state. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified DN's department. + + + + + + + + + + + + + + Criteria for searching for a particular endpoint type. + + + + + + + + + + + + + + Criteria for searching for an organization type. + + + + + + + + + + + + + + Criteria for searching for a particular Voice VPN policy selection. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified service provider. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified SignalingAddressType. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified user's department. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified user's group. + + + + + + + + + + + + + + + Criteria for searching for a particular BroadWorks Mobility Mobile Network. + + + + + + + + + + + + + + Criteria for searching for users with a specified network class of service. + + + + + + + + + + + + + + Criteria for searching for a particular User Type. + + + + + + + + + + + + + + Criteria for searching for user in/not in a trunk group. + + + + + + + + + + + + + + Criteria for searching for a port number. + + + + + + + + + + + + + + Criteria for searching for a particular fully specified Virtual On-Net Call Type Name. + + + + + + + + + + + + + + Criteria for searching for an extension. + + + + + + + + + + + + + + + + + + + + + + + + Criteria for searching for a skill Level. + + + + + + + + + + + + + + Criteria for searching for a name in a group common phone list. + + + + + + + + + + + + + + + + Criteria for searching for a phone number in a group common phone list. + + + + + + + + + + + + + + + + Criteria for searching for a group ID. + + + + + + + + + + + + + + + + Criteria for searching for a group location dialing code. + + + + + + + + + + + + + + + + Criteria for searching for a group name. + + + + + + + + + + + + + + + + Criteria for searching for a system Home Network Msc Address. + + + + + + + + + + + + + + + + Criteria for searching for an IMRN Number. + + + + + + + + + + + + + + + + Criteria for searching for a Login Id. + + + + + + + + + + + + + + + + Criteria for searching for a user's mobile phone number. + + + + + + + + + + + + + + + + Criteria for searching for a BroadWorks Mobility Mobile Subscriber Directory Number. + + + + + + + + + + + + + + + + Criteria for searching for digit pattern. + + + + + + + + + + + + + + + + Criteria for searching for number portability status. + + + + + + + + + + + + + + + + Criteria for searching for a route point + + + + + + + + + + + + + + + + Criteria for searching for a Physical Location. + + + + + + + + + + + + + + + + Criteria for searching for a system Roaming Network Msc Address. + + + + + + + + + + + + + + + + Criteria for searching for a service provider ID. + + + + + + + + + + + + + + + + Criteria for searching for a service provider name. + + + + + + + + + + + + + + + + Criteria for searching for digit pattern. + + + + + + + + + + + + + + + + Criteria for searching for a trunk group + + + + + + + + + + + + + + + + Criteria for searching for a user's first name. + + + + + + + + + + + + + + + + Criteria for searching for a user's userId. + + + + + + + + + + + + + + + + Criteria for searching for a user's last name. + + + + + + + + + + + + + + + + Criteria for searching for a name in a user personal phone list. + + + + + + + + + + + + + + + + Criteria for searching for a phone number in a user personal phone list. + + + + + + + + + + + + + + + + Criteria for searching for a user's yahoo id. + + + + + + + + + + + + + + + + Criteria for searching for a system zone's IP Address. + + + + + + + + + + + + + + + + Criteria for searching for a RegistrationURI. + + + + + + + + + + + + + + + + Criteria for searching for a SIP Contact. + + + + + + + + + + + + + + + Search mode when searching for string data. + + + + + + + + + + + Criteria for searching for a particular fully specified service type. + + + + + + + + + + + + + + Criteria for searching for a user's IMP Id. + + + + + + + + + + + + + + + + Criteria for searching for an Access Device Version. + + + + + + + + + + + + + + + + Criteria for searching for a private identity. + + + + + + + + + + + + + + + + Criteria for searching for a user's department. + + + + + + + + + + + + + + + + Criteria for searching for a service instance name. + + + + + + + + + + + + + + + + Criteria for searching Personal Assistant Exclusion Number's Description. + + + + + + + + + + + + + + + + Criteria for searching for Personal Assistant Exclusion Number. + + + + + + + + + + + + + + + + Criteria for searching for an Enterprise Trunk name. + + + + + + + + + + + + + + + + Criteria for searching for users with Route List feature assignment. + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaServiceProvider.xsd b/share/OCISchemaAS/OCISchemaServiceProvider.xsd new file mode 100644 index 0000000..e806754 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaServiceProvider.xsd @@ -0,0 +1,5246 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a service provider access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a static configuration tag for a service provider access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to delete static configuration tags for a service provider access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis. + The response is either ServiceProviderAccessDeviceCustomTagGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceCustomTagGetListRequest. + Contains a table of custom configuration tags managed by the Device Management System on a per-device profile basis. + The column headings are: "Tag Name", "Tag Value" + + + + + + + + + + + + + + + Request to modify a static configuration tag for a service provider access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to delete a specified service provider access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to modify a specified service provider/enterprise access device file. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + extendedCaptureEnabled + + + + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device profile basis. + The response is either ServiceProviderAccessDeviceFileGetListResponse14sp8 or ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceFileGetListRequest14sp8. + Contains a table of device files managed by the Device Management System on a per-device profile basis. + The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL", "Extended Capture". + + The following columns are only used in AS data mode: + "Extended Capture" + + + + + + + + + + + + + + + true + false + + + Request to get a service provider device profile file. + The response is either ServiceProviderAccessDeviceFileGetResponse20 or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderAccessDeviceFileGetRequest20. + + + + + + + + + + + + + + + + + + + + + Requests the list of access devices in a service provider. + The response is either ServiceProviderAccessDeviceGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceGetListRequest. + Contains a table of devices configured in the service provider. + The column headings are: "Device Name", "Device Type", "Available Ports", + "Net Address", "MAC Address", "Status", and "Version". + + + + + + + + + + + + + + + Requests the configuration of a specified service provider access device. + The response is either ServiceProviderAccessDeviceGetResponse18sp1 or ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceGetRequest18sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the list of users on a specified device. + The response is either ServiceProviderAccessDeviceGetResponse or ErrorResponse. + The following elements are only used in HSS data mode and ignored in AS data mode: + searchCriteriaAccessDeviceEndpointPrivateIdentity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to ServiceProviderAccessDeviceGetUserListRequest. + The column headings for the deviceUserTable are: "Line/Port", "Last Name", + "First Name", "Phone Number", "Group Id", "User Id", + "User Type", "Endpoint Type", "Primary Line/Port", "Order", "Extension", "Department", "Email Address", "Private Identity". + In IMS mode, the table will contain a row for each TEL-URI in the Phone Number column. + In standalone mode, rows for the alternate numbers are not included. + The User Type column contains one of the enumerated UserType values. + The Endpoint Type column contains one of the enumerated EndpointType values. + The Private Identity column is empty is AS mode. + + + + + + + + + + + + + + + Request to modify a specified service provider access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify attributes for line/ports assigned on the service provider device profile. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in HSS data mode and ignored in AS data mode: + privateIdentity + + + + + + + + + + + + + + + + + + + Reset a specific service provider SIP device that supports the reset operation. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a service provider or enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Add a service provider administrator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a service provider administrator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of service provider administrators. + The response is either a ServiceProviderAdminGetListResponse14 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderAdminGetListRequest14. + Contains a 5 column table with column headings "Administrator ID", + "Last Name", "First Name", "Administrator Type", "Language". + + + + + + + + + + + + + + + true + true + + + Requests the service provider administrator's policy settings. + The response is either ServiceProviderAdminGetPolicyResponse20 or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to ServiceProviderAdminGetPolicyRequest20. + Contains the policy settings for the service provider administrator. + The networkPolicyAccess and numberActivationAccess are returned only for the enterprise administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + verifyTranslationAndRoutingAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a service provider administrators profile. + The response is either a ServiceProviderAdminGetResponse14 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderAdminGetRequest14. + The response contains the service provider administrators profile information. + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify the service provider administrator's policy settings. + The response is either SuccessResponse or ErrorResponse. + The networkPolicyAccess is only modified for the enterprise administrator. + The following elements are only used in AS data mode: + dialableCallerIDAccess + verifyTranslationAndroutingAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a service provider administrator. + Since old password is not specified here, any password rule related to old password + does not apply. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Get a service provider or enterprise's answer confirmation settings. + The response is either a ServiceProviderAnswerConfirmationGetResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderAnswerConfirmationGetRequest16. + + + + + + + + + + + + + + + + + + Modify a service provider or enterprise's answer confirmation settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + true + + + Request the service provider level data associated with Call Processing + Policy. The response is either a + ServiceProviderCallProcessingGetPolicyResponse18sp1 or an ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to ServiceProviderCallProcessingGetPolicyRequest19sp1. + The following elements are only used in AS data mode: + useServiceProviderDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Modify the service provider level data associated with Call Procesing + Policy. The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + useServiceProviderDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + enterpriseCallsCLIDPolicy + groupCallsCLIDPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Assign a list of Communication Barring Criteria to a service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a list of Communication Barring Criteria assigned to a service provider. + The response is either a ServiceProviderCommunicationBarringCriteriaGetAssignedListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderCommunicationBarringCriteriaGetAssignedListRequest. + Contains a table of all Communication Barring Criteria assigned to the + service provider. The column headings are: "Name" and "Description". + + + + + + + + + + + + + + + Unassign a list of Communication Barring Criteria from a service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a new Communication Barring Digit Pattern Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete an existing Communication Barring Digit Pattern Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the list of all Digit Pattern Criteria defined for the service provider. + The response is either a ServiceProviderCommunicationBarringDigitPatternCriteriaGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetListRequest. + The response contains a table of all Digit Pattern Criteria defined for the service provider. The column headings are "Name" and "Description" + + + + + + + + + + + + + + + Get an existing Digit Pattern Criteria. + The response is either a ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest. + The response contains the Digit Pattern Criteria information. + + + + + + + + + + + + + + + Get an existing Digit Pattern Criteria. + The response is either a ServiceProviderCommunicationBarringDigitPatternCriteriaGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetRequest. + The response contains the Digit Pattern Criteria information. + + + + + + + + + + + + + + + Modify an existing Communication Barring Digit Pattern Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Assign a list of Communication Barring Incoming Criteria to a service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get a list of Communication Barring Incoming Criteria assigned to a service provider. + The response is either a ServiceProviderCommunicationBarringIncomingCriteriaGetAssignedListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderCommunicationBarringIncomingCriteriaGetAssignedListRequest. + Contains a table of all Communication Barring Incoming Criteria assigned to the + service provider. The column headings are: "Name" and "Description". + + + + + + + + + + + + + + + true + false + + + Unassign a list of Communication Barring Incoming Criteria from a service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a new Communication Barring Profile. + The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the add. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + callMeNowDefaultAction, use value "Block" in HSS data mode + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers, use value "false" in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Deletes an existing Communication Barring Profile. Optionally, a new default profile can be chosen if the current default profile is being deleted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of groups within a service provider that have a given + Communication Barring Profile assigned. + The response is either a ServiceProviderCommunicationBarringProfileGetAssignedGroupListResponse + or an ErorResponse. + + + + + + + + + + + + + + + + + + + Response to ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest. + Contains a table of groups that have the Communication Barring Profile + assigned. The column headings are: "Group Id" and "Group Name". + + + + + + + + + + + + + + + Get a list of Communication Barring profiles within a service provider that have a given Communication Barring Criteria assigned. + The response is either a ServiceProviderCommunicationBarring ProfileGetCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderCommunicationBarring ProfileGetCriteriaUsageListRequest. Contains a table of profiles that have the Communication Barring Criteria assigned. The column headings are: "Name" and "Description". + + + + + + + + + + + + + + + Get the list of Profiles that use a specific Digit Pattern Criteria. + The response is either a ServiceProviderCommunicationBarringProfileGetDigitPatternCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the ServiceProviderCommunicationBarringProfileGetDigitPatternCriteriaUsageListRequest. + The response contains a table of all Profiles that use the specific Digit Pattern Criteria. The column headings are "Name" and "Description" + + + + + + + + + + + + + + + true + false + + + Get a list of Communication Barring profiles within a service provider that have a given Communication Barring Incoming Criteria assigned. + The response is either a ServiceProviderCommunicationBarring ProfileGetIncomingCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderCommunicationBarringProfileGetIncomingCriteriaUsageListRequest. + Contains a table of profiles that have the Communication Barring Incoming Criteria assigned. + The column headings are: "Name" and "Description". + + + + + + + + + + + + + + + Get the list of all Communication Barring Profiles. + The response is either a + ServiceProviderCommunicationBarringProfileGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderCommunicationBarringProfileGetListRequest. + The response contains a table of all Communication Barring Profiles + for the service provider. The column headings are "Default" , "Name" and "Description" + + + + + + + + + + + + + + + true + false + + + Get an existing Communication Barring Profile. + The response is either a ServiceProviderCommunicationBarringProfileGetResponse19sp1V2 + or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderCommunicationBarringProfileGetRequest19sp1V2. + The response contains the Communication Barring Profile information. + The incoming, originating, redirecting and call me now rules are returned in ascending priority order. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modifies the default Communication Barring Profile of a Service Provider. If a default has been previously selected, this command will swap the default profile with the profile provided. Selecting a nil profile will cause the service provider to not have a default Communicaton Barring Profile. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify an existing Communication Barring Profile. + The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the modify. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Rebuild the config file for a specified device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Reset a specific service provider or enterprise device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Reorder the lines of a Service Provider device. You can not add or delete line ports, only + re-ordering the list is allowed. The ordered list of line ports can be obtained + with the ServiceProviderAccessDeviceGetRequest command. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a service provider or enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request device management's events for a specific queue. + It is possible to restrict the number of rows returned using + responseSizeLimit. + If eventQueueType is not specified, the events from all the + event queues are returned. + The response is either a ServiceProviderDeviceManagementEventGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderDeviceManagementEventGetListRequest. + Contains a table with column headings: "Event Id", "Status", "Action", + "Level", "Type", "Additional Info", "Is Local", "Completion %", + "Pushed/ Same Hash/ Not Pushed", "Login Id", "Start Time", + "Process Time". + "Event Id" is a unique identifer for the event. + "Status" can be: Pending, Queued, In Progress, + Process On Other Host, Stale, Completed, Canceled. + "Action" can be: Delete, Download, Rebuild, Reset, Upload. + "Level" can be: Device, Device Type, Device Type Group, Group, User. + "Type" can be: Automatic, Manual. + "Additional Info" includes the affected device type, device or group. + It depends on the level of the event: + Device Profile: "Device Name" "Service Provider Id" "Group Id" + Device Type: "Device Type Name" + Device Type Group: "Service Provider Id" "Group Id" "Device Type Name" + Group: "Service Provider Id" "Group Id" + User: "User Id" + "Is Local" is set to "yes" if the event is processed on the server + who received the request, "no" otherwise meaning that the event is + processed on another server. + "Completion %" provides an estimate of the completion of the event. + A percentage is given, the current number of completed expanded event, + and the total number of expanded event. + "Pushed/ Same Hash/ Not Pushed" gives the total number of files that + were pushed, not pushed because of same hash, and not pushed when + processing the event. + "LoginId" is the user or admin id who triggered the event. + "Start Time" is the date when the event was started. The display + shows the month, days, hours, and minutes (MM-dd hh:mm). + "Process Time" is the time taken to process the event in hours, + minutes, seconds, and milliseconds (hhhh:mm:ss.SSS). + Each row represents an event sorted by priority of processing. The + first row in the table is an event that has an associated expanded + event currently being processed or next in line to be processed. + + + + + + + + + + + + + + + true + false + + + Cancel pending and in progress events. A list of individual events can + be canceled. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + true + + + Request to get the service provider level device profile authentication password rule settings. + The response is either a ServiceProviderDeviceProfileAuthenticationPasswordRulesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to ServiceProviderDeviceProfileAuthenticationPasswordRulesGetRequest. + Contains the device profile authentication password rules for the service provider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify the service provider level device profile authentication password rule settings. The useServiceProviderSettings element can only be modified by a system administrator or a provisioning administrator. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a new Dialable Caller ID Criteria. Criteria are added at the bottom of the list with the lowest priority. The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a Dialable Caller ID Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get an existing Dialable Caller ID Criteria. + The response is either a + ServiceProviderDialableCallerIDCriteriaGetRequest or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderDialableCallerIDCriteriaGetRequest. + The response contains the Dialable Caller ID Criteria information. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify a Dialable Caller ID Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the service provider?s Dialable Caller ID settings and criteria list. + The response is either a + ServiceProviderDialableCallerIDGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderDialableCallerIDGetRequest. + The criteria table?s column headings are ?Active?, "Name", "Description", ?Prefix Digits?, and ?Priority?. + + + + + + + + + + + + + + + + + true + false + + + Modify the service provider?s Dialable Caller ID settings and criteria list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the Service Provider level data associated with Dial Plan Policy. + The response is either a ServiceProviderDialPlanPolicyGetResponse17 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderDialPlanPolicyGetRequest17 + + + + + + + + + + + + + + + + + + + Modify the Service Provider level data associated with Dial Plan Policy. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request the Service Provider level data associated with Dial Plan Policy. + The response is either a ServiceProviderDialPlanPolicyGetAccessCodeListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderDialPlanPolicyGetAccessCodeListRequest. + Contains a table with column headings: "Access Code", + "Enable Secondary Dial Tone", "Description". + + + + + + + + + + + + + + + Request access code data associated with Service Provider level Dial Plan Policy access codes. + The response is either a ServiceProviderDialPlanPolicyGetAccessCodeResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderDialPlanPolicyGetAccessCodeRequest + + + + + + + + + + + + + + + + + + Request to add a Service Provider level Dial Plan Access Code and its all attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to delete a Service Provider level Dial Plan Access Code and its all attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to modify a Service Provider level Dial Plan Access Code and its attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request the service provider's digit collection attributes. + The response is either a ServiceProviderDigitCollectionGetResponse13mp4 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderDigitCollectionGetRequest13mp4. + + + + + + + + + + + + + + + + + Modifies the service provider's digit collection attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Adds DNs to a service provider. It is possible to add either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Deletes DNs from a service provider. It is possible to delete either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request a list of available DNs not yet assigned to any group. + Dns assigned to the IMRN pool are not listed in the response. + The response is either ServiceProviderDnGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderDnGetAvailableListRequest. + Contains a list of available DNs not yet assigned to any group. + + + + + + + + + + + + + + + Request a summary table of all DNs in a service provider. + Dns assigned to the IMRN pool are not listed in the response. + The response is either ServiceProviderDnGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderDnGetSummaryListRequest. + The column headings are "Phone Numbers, "Group Id" and "Can Delete" + + + + + + + + + + + + + + + Assign a list of domains to a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Requests a list of groups within a service provider that have a given domain assigned. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a ServiceProviderDomainGetAssignedGroupListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to ServiceProviderDomainGetAssignedGroupListRequest. + Contains a table with column headings: "Group Id", "Group Name" + and a row for each group. + + + + + + + + + + + + + + + Requests the list of all domains assigned to a service provider. + The response is either ServiceProviderDomainGetAssignedListResponse or ErrorResponse. + + + + + + + + + + + + + + + Contains a simple list of all service provider domain names. + + + + + + + + + + + + + + + + Unassign a list of domains from a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to search endpoints in the service provider/enterprise. + The response is either ServiceProviderEndpointGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderEndpointGetListRequest. + The column headings for the endpointTable are: + "Group Id", "Line/Port", "Last Name", "First Name", "User Id", "User Type", "Phone Number", "Extension", "Device Type", "Device Name", "Net Address", "MAC Address", "Department", "Email Address". + Possible values for User Type are "User", "CCBasic", "CCStandard", "CCPremium", "RP", "MOH", "MOHVideo". + + + + + + + + + + + + + + + true + false + + + Get the list of feature access codes for a service provider or enterprise. + The response is either a ServiceProviderFeatureAccessCodeGetListResponse21 + or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderFeatureAccessCodeGetListRequest20. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + true + false + + + Modify a list of feature access codes for a service provider or enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + + Add a new service provider file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a service provider file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Modify a service provider file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Request the list of service provider users for a file repository in the system. + The response is either a ServiceProviderFileRepositoryDeviceUserGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderFileRepositoryDeviceUserGetListRequest. + Contains a table with column headings : "User Name","Allow Delete","Allow Get","Allow Put" in a row for each file repository service provider user. + + + + + + + + + + + + + + + Request the default profile for a service provider or enterprise. + The response is either a ServiceProviderGetDefaultResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the ServiceProviderGetDefaultRequest. All values are default values for + a service provider or enterprise's profile. + + + + + + + + + + + + + + + + Request a list of service providers and/or enterprises in the system. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a ServiceProviderGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to ServiceProviderGetListRequest. + Contains a 3 column table with column headings 'Service Provider Id', 'Service Provider Name' + and 'Is Enterprise' and a row for each service provider or enterprise. + + + + + + + + + + + + + + + Get the profile for a service provider or enterprise. + The response is either a ServiceProviderGetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderGetRequest17sp1. + The response contains the service provider or enterprise's profile information. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Assign a list of service provider DNs to the IMRN pool. It is possible to assign either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Returns a list of dns or dn ranges in a service provider IMRN pool. + The response is either ServiceProviderIMRNGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderIMRNGetListRequest. + + + + + + + + + + + + + + + true + false + + + Unassign a list of service provider DNs from the service provider IMRN pool. The DNs then become available for + assignment to groups. It is possible to delete either: a single DN, + or a list of DNs, or a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Modify the profile for a service provider or enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modifies the default Network Classes of Service of a Service Provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Assign a list of Network Classes of Service to a service provider. + A default Network Class of Service must be specified unless + there is already one assigned to the service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Assign a list of Network Classes of Service to all groups with in a + service provider. If it is the first assigned Network Class of Service in + the group, it will be set as the default one. + The Network Classes of Service must be currently + assigned to the service provider. The response is either a + SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Assign a Network Classes of Service to all users with in a + service provider. This will also assign the Network Class of Service + to all the groups in the service provider if it is not assigned yet. + If it is the first assigned Network Class of Service in the group, + it will be set as the default one. + However, the Network Classes of Service must be currently assigned to + the service provider. The response is either a SuccessResponse or + an ErrorResponse. + + + + + + + + + + + + + + + + Get a list of Network Classes of Service assigned to a service provider. + The response is either a ServiceProviderNetworkClassOfServiceGetAssignedListResponse + or an ErorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderNetworkClassOfServiceGetAssignedListRequest. + Contains a table of all Network Classes of Service assigned to the + service provider. The column headings are: "Name", "Description" and "Default". + + + + + + + + + + + + + + + Get a list of groups within a service provider that have a given + Network Class of Service assigned. + The response is either a ServiceProviderNetworkClassOfServiceGetAssignedGroupListResponse + or an ErorResponse. + + + + + + + + + + + + + + + + + + + Response to ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest. + Contains a table of groups that have the Network Class of Service + assigned. The column headings are: "Group Id" and "Group Name". + + + + + + + + + + + + + + + Unassign a list of Network Classes of Service from a service provider. + If the default Network Class of Service is being unassigned, a new one must be specified unless there are no more + Network Classes of Service assigned to the service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to get the Service Provider Number Portability Query Digit Pattern Trigger List information. + The response is either a ServiceProviderNumberPortabilityQueryGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderNumberPortabilityQueryGetRequest. + The response contains the service provider number portability query information. + + + + + + + + + + + + + + + + + + true + false + + + Modify the Service Provider Number Portability Query information. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Add a list of the Service Provider Number Portability Query Digit Patterns. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Assign a list of Office Zones to a service provider. + The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional. + Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the service provider otherwise the request will fail. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get a list of Office Zones assigned to a service provider. + The response is either a ServiceProviderOfficeZoneGetAssignedListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get a list of groups within a service provider that have a given Office Zone assigned. + The response is either a ServiceProviderOfficeZoneGetAssignedGroupListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Unassign a list of OfficeZones from a service provider. Note: a new default must be provided if unassigning the current default. + Office Zones can only be unassigned if the Location-Based Calling Restrictions has been authorized to the service provider otherwise the request will fail. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderOfficeZoneGetAssignedGroupListRequest. Contains a table of groups that have the Office Zone assigned. The column headings are: "Group Id" and "Group Name". + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderOfficeZoneGetAssignedListRequest. + Contains a table of all Office Zones assigned to the + service provider. The column headings are: "Name", "Description" and "Default". + + + + + + + + + + + + + + + Requests the service provider's passcode rules setting. + The response is either ServiceProviderPortalPasscodeRulesGetResponse19 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderPortalPasscodeRulesGetRequest19. + Contains the service provider's passcode rules setting. + + The following elements are only used in AS data mode: + numberOfRepeatedDigits + disallowRepeatedPatterns + disallowContiguousSequences + numberOfAscendingDigits + numberOfDescendingDigits + numberOfPreviousPasscodes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the service provider's passcode rules setting. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + numberOfRepeatedDigits + disallowRepeatedPatterns + disallowContiguousSequences + numberOfAscendingDigits + numberOfDescendingDigits + numberOfPreviousPasscodes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider's password rules setting applicable to + Administrators (Group and Department) and Users. + The response is either ServiceProviderPasswordRulesGetResponse16 or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderPasswordRulesGetRequest16. + Contains the group, department administrator and/or user password + rules setting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the service provider's password rules settings + setting applicable to Administrators (Group and Department) and Users. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Assign a list of route point external systems to a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Requests a list of groups within a service provider that have a given external system assigned. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a ServiceProviderRoutePointExternalSystemGetAssignedGroupListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest. + Contains a table with column headings: "Group Id", "Group Name" + and a row for each group. + + + + + + + + + + + + + + + Requests the list of all Route Point External Systems assigned to a service provider. + The response is either ServiceProviderRoutePointExternalSystemGetAssignedListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderRoutePointExternalSystemGetAssignedListRequest. + Contains a table of all Route Point External Systems assigned to the + service provider. The column headings are: "Name" and "Description". + + + + + + + + + + + + + + + Unassign a list of route point external systems from a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request the routing profile for the service provider/enterprise. + The response is either a ServiceProviderRoutingProfileGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderRoutingProfileGetRequest. + + + + + + + + + + + + + + + Requests to modify the routing profile for a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Add an event to service provider schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a service provider schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a list of events from a service provider schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a list of service provider schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the list of events of a service provider schedule. + The response is either a ServiceProviderScheduleGetEventListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderScheduleGetEventListRequest. + The response contains a list of events. + + + + + + + + + + + + + + + Get an event from a service provider schedule. + The response is either a ServiceProviderScheduleGetEventResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to ServiceProviderScheduleGetEventRequest. + The response contains the event of the service provider schedule. + + + + + + + + + + + + + + + + + + + + + + + + Get the list of a service provider schedules. The list can be filtered by schedule type. + The response is either a ServiceProviderScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderScheduleGetListRequest. + The response contains a list of service provider schedules. + + + + + + + + + + + + + + + Modify an event of a service provider schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a service provider schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Requests the service provider's service authorization status. + The response is either ServiceProviderServiceGetAuthorizationListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderServiceGetAuthorizationListRequest. + Contains two tables, one for the group services and one for the user services. + The Group Service table has column headings: + "Service Name", "Authorized", "Assigned", "Limited", "Quantity", "Allocated", "Licensed", "Service Pack Allocation" + The User Service table has column headings: + "Service Name", "Authorized", "Assigned", "Limited", "Quantity", "Allocated", "Licensed", "Service Pack Allocation", "User Assignable", "Service Pack Assignable". + + + + + + + + + + + + + + + + Requests the list of all user services assignable to users in the specified service provider. + The response is either ServiceProviderServiceGetUserAssignableListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderServiceGetUserAssignableListRequest. + + + + + + + + + + + + + + + Requests to change the service provider's service authorization status. + The boolean flags are used to authorize or unauthorize services. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to add a service pack to a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to add services to a service pack if the pack has not been authorized to a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete a service pack from a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to get a service pack details. + The response is either ServiceProviderServicePackGetDetailListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderServicePackGetDetailListRequest. It contains the service pack details + and the list of services in a table format. The column headings are "Service", "Authorized" + "Allocated" and "Available". + + + + + + + + + + + + + + + + + + + + + Request to get a list of defined service packs for a service provider. + The response is either ServiceProviderServicePackGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderServicePackGetListRequest. + + + + + + + + + + + + + + + Request to get the list of service packs containing a specified service. + The response is either ServiceProviderServicePackGetServiceUsageListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderServicePackGetServiceUsageListRequest. + The column headings are "Service Pack Name", "Total Packs" and "Allocated to Groups" + + + + + + + + + + + + + + + Request to get the service pack utilization for a service provider. + For each service pack, a table of groups utilizing the pack is returned. + The response is either ServiceProviderServicePackGetUtilizationListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderServicePackGetUtilizationListRequest. + For each service pack, a table of groups utilizing the pack is returned. + The utilization table column headings are "Group", "Total Packs" and "Assigned". + + + + + + + + + + + + + + + + Create a service pack migration task. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Makes a copy of one or more existing service pack migration tasks. A copied task + can be edited with other commands and scheduled for future execution. The + name of the new task is chosen automatically. The name will + be "Copy (number) of taskName". + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Deletes a service pack migration task. It is not possible to delete a task while it is + currently executing. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Requests a list of groups to migrate. + The response is either ServiceProviderServicePackMigrationTaskGetAvailabeGroupListResponse + or ErrorResponse. + + + + + + + + + + + + + + + + + + Response to ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest. + The groupTable column headings are: "Group Id", "Group Name", "User Count". + + + + + + + + + + + + + + + Requests a list of all service pack migration tasks for a service provider. + The response is either ServiceProviderServicePackMigrationTaskGetListResponse21 + or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderServicePackMigrationTaskGetListRequest21. + Contains a table with a row for each service pack migration task and column headings : + "Start Timestamp Milliseconds", "Name", "Status", "Error Count", "Users Processed", "Users Total". + The start timestamp column is the number of milliseconds since the standard base time known as "the epoch", + namely January 1, 1970, 00:00:00 GMT. The status column is the task status which can be Awaiting edit, Pending, + Processing, Terminating, Terminated, Stopped by system, Completed, or Expired. + + + + + + + + + + + + + + + Requests the details of a specified service pack migration task. + The response is either ServiceProviderServicePackMigrationTaskGetResponse21 + or ErrorResponse. + + + + + + + + + + + + + + + + Response to ServiceProviderServicePackMigrationTaskGetRequest21. + The groupTable column headings are: "Group Id", "Group Name", and "User Count". + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Replace the list of services and packs to be assigned to users during the service pack migration. + Modification is only allowed prior to task execution. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Replace the list of groups to be migrated for a specified service pack migration task. + Modification is only allowed prior to task execution. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + Replace the list of services and packs to be removed from users during the service pack migration. + Modification is only allowed prior to task execution. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Modify the properties of a specified service pack migration task. + Modification is only allowed prior to task execution. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Replace the list of services and packs used to select which users will be migrated. + Modification is only allowed prior to task execution. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Terminates a service pack migration task that is currently executing. + Modification is only allowed prior to task execution. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Requests to modify a service pack for a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + true + + + Lookup if the given number is defined in the specified service in the service provider. + The response is ServiceProviderServicePhoneNumberLookupResponse. + + + + + + + + + + + + + + + + + true + true + + + Response to the ServiceProviderServicePhoneNumberLookupRequest. + The column headings for the userTable are: "Group Id", "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension" and "Department". + + + + + + + + + + + + + + + true + false + + + Get the session admission control capacity for the service provider. + The response is either a ServiceProviderSessionAdmissionControlGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderSessionAdmissionControlGetRequest. + The response contains the session admission control capacity allocated for the service provider. + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify session admission control capacity for the service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the Service Provider Session Admission White List information. + The response is either a ServiceProviderSessionAdmissionControlWhiteListGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the ServiceProviderSessionAdmissionControlWhiteListGetRequest. + The response contains the White List information. + + + + + + + + + + + + + + + + true + false + + + Modify the Service Provider Session Admission Control White List information. + The number of digit pattern entries is limited to 100. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to add a language for a service provder. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to modify a language properties for a service provider/enterprise. + If the becomeDefaultLanguage element is present, the language in this request + Becomes the default language for the service provider/enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete a language from a service provider supported languages. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the defined languages for a service provider. + The response is either a ServiceProviderLanguageGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderLanguageGetListRequest. + + + + + + + + + + + + + + + + Request the list of languages that a user or admin in a service provider is allowed to use. + The list will either be the system or service provider languages list, depending on the useServiceProviderLanguages flag. + The response is either a ServiceProviderLanguageGetAvailableListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderLanguageGetAvailableListRequest. + The language table column headings are: "Language", "Locale" and "Encoding". + + + + + + + + + + + + + + + + true + false + + + Request to get the service provider level SIP authentication password rule settings. + The response is either a ServiceProviderSIPAuthenticationPasswordRulesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderSIPAuthenticationPasswordRulesGetRequest. + Contains the SIP authentication password rules for the service provider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify the service provider level SIP authentication password rule settings. The useServiceProviderSettings element can only be modified by a system administrator or a provisioning administrator. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the Application Server set assigned to the service provider or enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the Application Server set for a service provider or enterprise. + The response is either a ServiceProviderApplicationServerSetGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderApplicationServerSetGetRequest. + The response contains the service provider or enterprise's Application Server set information. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaSortCriteria.xsd b/share/OCISchemaAS/OCISchemaSortCriteria.xsd new file mode 100644 index 0000000..a1a2a64 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaSortCriteria.xsd @@ -0,0 +1,145 @@ + + + + + + + + + + + + + + + The sort criteria specifies whether sort is ascending or descending, and + whether the sort is case sensitive. Sort order defaults to + ascending and case sensitive. + + + + + + + + + + + The sort criteria specifies the enterprise common phone list name as the + column for the sort, whether sort is ascending or descending, and + whether the sort is case sensitive. + + + + + + + + + + + + The sort criteria specifies the enterprise common phone list number as as the column + for the sort, whether sort is ascending or descending, and whether the sort is + case sensitive. + + + + + + + + + + + + The sort criteria specifies the group common phone list name as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. + + + + + + + + + + + + The sort criteria specifies the group common phone list number as the column for the sort, whether + sort is ascending or descending, and whether the sort is case sensitive. + + + + + + + + + + + + The sort criteria specifies the user personal phone list name as the column for the sort, whether + sort is ascending or descending, and whether the sort is case sensitive. + + + + + + + + + + + + The sort criteria specifies the user personal phone list number as the column for + the sort, whether the sort is ascending or descending, and whether the + sort is case sensitive. + + + + + + + + + + + + The sort criteria specifies the user last name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. + + + + + + + + + + + + The sort criteria specifies the user first name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. + + + + + + + + + + + + The sort criteria specifies the user department name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaSystem.xsd b/share/OCISchemaAS/OCISchemaSystem.xsd new file mode 100644 index 0000000..e3399d1 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaSystem.xsd @@ -0,0 +1,18873 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a system-level access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a static configuration tag for a system access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete static configuration tags for a system access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis. + The response is either SystemAccessDeviceCustomTagGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemAccessDeviceCustomTagGetListRequest. + Contains a table of custom configuration tags managed by the Device Management System on a per-device profile basis. + The column headings are: "Tag Name", "Tag Value" + + + + + + + + + + + + + + + Request to modify a static configuration tag for a system access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete a specified system access device. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to modify a specified system access device file. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + extendedCaptureEnabled + + + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device profile basis. + The response is either SystemAccessDeviceFileGetListResponse14sp8 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemAccessDeviceFileGetListRequest14sp8. + Contains a table of device files managed by the Device Management System on a per-device profile basis. + The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL", "Extended Capture". + + The following columns are only used in AS data mode: + "Extended Capture" + + + + + + + + + + + + + + + true + false + + + Request to get a device profile file. + The response is either SystemAccessDeviceFileGetResponse20 or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to SystemAccessDeviceFileGetRequest20. + + + + + + + + + + + + + + + + + + + + + Requests the list of all access devices in the entire system. + Prior to release 14, this functionality was provided with the SystemAccessDeviceGetListRequest. + The response is either SystemAccessDeviceGetAllResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Response to SystemAccessDeviceGetAllRequest. + Contains a table of devices configured in the entire system. + The column headings are: "Service Provider Id", "Is Enterprise", "Group Id", + "Device Name", "Device Type", "Net Address", "MAC Address", "Status". + + + + + + + + + + + + + + + Requests the list of access devices defined at the System-level. + Prior to release 14, this command requested a list of all devices in the entire system. That + functionality is now moved to the SystemAccessDeviceGetAllRequest. + The response is either SystemAccessDeviceGetListResponse14 or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Response to SystemAccessDeviceGetListRequest14. + Contains a table of devices defined at the System-level. + The column headings are: + "Device Name", "Device Type", "Available Ports", "Net Address" and "MAC Address", "Status", "Version". + + + + + + + + + + + + + + + Requests the configuration of a specified system access device. + The response is either SystemAccessDeviceGetResponse18sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemAccessDeviceGetRequest18sp1 + + + The following elements are only used in AS data mode: + version + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the users associated with a specified system access device. + The response is either SystemAccessDeviceGetUserListResponse or ErrorResponse. + The following elements are only used in HSS data mode and ignored in AS data mode: + searchCriteriaAccessDeviceEndpointPrivateIdentity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to SystemAccessDeviceGetUserListRequest. + The column headings for the deviceUserTable are: "Line/Port", "Last Name", + "First Name", "Phone Number", "Service Provider Id", "Group Id", "User Id", + "User Type", "Endpoint Type", "Primary Line/Port", "Order", "Extension", "Department", "Email Address", "Private Identity". + If the identity/device profile is an identity, the table will contain a row for each TEL-URI in the Phone Number column. + If the identity/device profile is a real device, rows for the alternate numbers are not included. + The User Type column contains one of the enumerated UserType values. + The Endpoint Type column contains one of the enumerated EndpointType values. + The Private Identity column is empty is AS mode. + + + + + + + + + + + + + + + Request to modify a specified system access device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify attributes for line/ports assigned on the system device profile. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in HSS data mode and ignored in AS data mode: + privateIdentity + + + + + + + + + + + + + + + + + + Add a device type to be monitored. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Remove a device type to be monitored. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a list of monitored device types. + The response is either a SystemAccessDeviceMonitorGetDeviceTypeListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemAccessDeviceMonitorGetDeviceTypeListRequest. + + + + + + + + + + + + + + + Request to get the list of Access Device Monitor system parameters. + The response is either SystemAccessDeviceMonitorParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemAccessDeviceMonitorParametersGetListRequest. + Contains a list of system Access Device Monitor parameters. + + + + + + + + + + + + + + + Request to modify Access Device Monitor system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Reset a specific system SIP device that supports the reset operation. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests the list of device types supporting enhanced configuration. + The response is either SystemAccessDeviceTypeGetEnhancedConfigurableListResponse + or ErrorResponse. + + + + + + + + + + + + + Response to SystemAccessDeviceTypeGetEnhancedConfigurableListRequest. + Contains a table with columns: "Access Device Type", "Enhanced Configuration Type", "Supports Reset". + The "Enhanced Configuration Type" column contains one of the AccessDeviceEnhancedConfigurationType14 + enumerated values. + The "Supports Reset" column is a boolean flag indicating the device can be remotely reset. + + + + + + + + + + + + + + + Requests the list of access device types. + The response is either SystemAccessDeviceTypeGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemAccessDeviceTypeGetListRequest. + + + + + + + + + + + + + + + true + false + + + Request to add a ChargingFunctionElement Server to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to add a Radius Server to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete a ChargingFunctionElementServer from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to delete a Radius Server from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get a list of ChargingFunctionElementServers defined in the system. + The response is either a SystemAccountingGetChargingFunctionElementServerListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to SystemAccountingGetChargingFunctionElementServerListRequest. The accounting charging function element Server table column + headings are: "Address", "Extended Net Address", "Type", "Description". + + + + + + + + + + + + + + + Request to get a list of Radius Servers defined in the system. + The response is either a SystemAccountingGetRadiusServerListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to SystemAccountingGetRadiusServerListRequest. The Radius Server table + column headings are: "Net Address", "Port", "Description" + + + + + + + + + + + + + + + true + false + + + Add an Attribute Value Pair (AVP) combination to disable. The AVP + combination includes a diameter AVP and a vendor ID. The response is either + a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Remove an Attribute Value Pair (AVP) combination from the list of disabled AVP + codes. The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get a list of Attribute Value Pair (AVP) combinations that are + disabled. The response is either a + SystemAccountingInhibitedAttributeValuePairCodeGetListResponse or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to + SystemAccountingInhibitedAttributeValuePairCodeGetListRequest. Contains a 2 column + table with column headings "Attribute Value Pair Code" and "Vendor Id". + + + + + + + + + + + + + + + Request to modify a ChargingFunctionElementServer in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to modify a Radius Server in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Reorder the charging function element servers. You can not add or delete addresses, + only re-ordering the list is allowed. The ordered list of addresses can be obtained + with the SystemAccountingGetChargingFunctionElementServerListRequest command. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Add a system or provisioning administrator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a system or provisioning administrator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of system administrators. + The response is either a SystemAdminGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemAdminGetListRequest. + Contains a 6 column table with column headings "Administrator ID", + "Last Name", "First Name", "Type", "Read Only", "Language". + + + + + + + + + + + + + + + Get a system or provisioning administrators profile. + The response is either a SystemAdminGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemAdminGetRequest. + The response contains the system or provisioning administrators profile information. + + + + + + + + + + + + + + + + + + + Modify a system or provisioning administrator. + Since old password is not specified here, any password rule related to old password + does not apply. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Add a system-level Application Server alias to the system. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Delete a system-level Application Server alias from the system. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Requests the list of all system-level Application Server aliases. + The response is either SystemAliasGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemAliasGetListRequest. Contains the list of all network alias' for + the Application Server. + + + + + + + + + + + + + + + Add an application controller, which is a server where remote + application resides and controls the Route Point. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete an application controller. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of application controllers that are configured for the system. + The response is either SystemApplicationControllerGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to the SystemApplicationControllerGetListRequest. + Contains a table with column headings: "Name", "Subscriber Id", "Channel Set Id", "Status". + The column values for "Status" can either be "ready" or "notReady". + + + + + + + + + + + + + + + Request to get the list of Application Server Registration system parameters. + The response is either SystemASRParametersGetResponse14sp7 or ErrorResponse. + + + + + + + + + + + + + Response to SystemASRParametersGetRequest14sp7. + Contains a list of system Application Server Registration parameters. + + + + + + + + + + + + + + + + + Request to modify Application Server Registration system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + true + + + Request to export system wide authentication lockout data to a file. All locked out device profiles, sip endpoints, and sip trunk groups are returned. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Request to get the authentication lockout settings in the system. + The response is either a SystemAuthenticationLockoutSettingsResponse or an ErrorResponse. + + + + + + + + + + + + + true + true + + + Response to SystemAuthenticationLockoutSettingsGetRequest. + Contains the authentication lockout settings in the system. + + + + + + + + + + + + + + + + + + true + true + + + Request to modify the system level device password lockout settings + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Get the system interface attributes for Messaging Server. + The response is either SystemBroadCloudGetResponse or ErrorResponse. + + + + + + + + + + + Response to the SystemBroadCloudGetRequest. + The response contains the system interface attributes for Messaging Server. + + + + + + + + + + + + + + + + + Modify the system interface attributes for Messaging Server. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request subscribers be exported to files on the AS filesystem. + The response is either a SuccessResponse or an + ErrorResponse. + + ***** Warning *****: + This activity should only be done during non-busy hours on the secondary + provisioning server because this may cause large amounts of data to be + dumped to disk and it may take some time to execute. + + + + + + + + + + + true + false + + + Get the BroadWorks Mobile Manager service system settings. + The response is either SystemBroadWorksMobileManagerGetResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemBroadWorksMobileManagerGetRequest + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the BroadWorks Mobile Manager service system settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Requests the list of System Diameter base parameters. + The response is either SystemBwDiameterBaseDataGetResponse17sp3 or ErrorResponse. + + + + + + + + + + + + + Response to SystemBwDiameterBaseDataGetRequest17sp3. + Contains a list of System Diameter base parameters. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modifies the System Diameter base parameters. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a static entry in the Diameter Peer Table. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Remove a Diameter peer. A peer cannot be removed if is referenced by a Realm Routing Table entry. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Requests the list of Diameter peers. + The response is either SystemBwDiameterPeerGetListResponse or ErrorResponse + + + + + + + + + + + + + Contains a 5 column table with column headings 'Instance', 'Identity', 'IP Address', 'Port', and 'Enabled'. One row is present for each peer. + + + + + + + + + + + + + + + Modifies the attributes of an entry in the Diameter Peer Table. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Add a static entry in the Realm Routing Table. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a static entry in the Realm Routing Table. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Requests the list of Diameter routing realms. + The response is either SystemBwDiameterRoutingRealmGetListResponse or ErrorResponse. + + + + + + + + + + + + + Contains a 4 column table with column headings 'Instance', 'Realm', 'ApplicationID', and 'Default'. One row is present for each Diameter routing realm. + + + + + + + + + + + + + + + Modify a static entry in the Realm Routing Table. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Add a Diameter routing peer. The realm must refer to a Diameter routing realm whose action is relay. The destinationPeerIdentity must refer to an existing Diameter peer whose mode is active. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Remove a Diameter routing peer. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Requests the list of Diameter routing peers associated with the specified realm. The response is either SystemBwDiameterRoutingPeerGetListResponse or ErrorResponse. + + + + + + + + + + + + + Contains a 6 column table with column headings 'Instance', 'Realm', 'ApplicationID', 'Identity, 'Priority', and 'Weight'. One row is present for each Diameter Routing Peer. + + + + + + + + + + + + + + + Modify a Diameter routing peer. The realm must refer to a Diameter routing realm whose action is relay. The destinationPeerIdentity must refer to an existing Diameter peer whose mode is active. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + true + + + The response is either a SystemCallProcessingGetPolicyResponse19sp1 or an + ErrorResponse. + + + + + + + + + + + + + true + true + + + Response to SystemCallProcessingGetPolicyRequest19sp1. + The following elements are only used in AS data mode: + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + enterpriseCallsCLIDPolicy + enterpriseGroupCallsCLIDPolicy + serviceProviderGroupCallsCLIDPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Modify the system level data associated with Call Processing Policy. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + enterpriseCallsCLIDPolicy + enterpriseGroupCallsCLIDPolicy + serviceProviderGroupCallsCLIDPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a call processing policy profile to system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Delete a call processing policy profile from system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Modify a call processing policy profile in system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to get a call processing policy profile in system. + The response is either a SystemCallProcessingPolicyProfileGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to a SystemCallProcessingPolicyProfileGetRequest21. + + + + + + + + + + + + + + + + true + false + + + Get the list of all Call Processing Policy Profiles. + The response is either a SystemCallProcessingPolicyProfileGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemCallProcessingPolicyProfileGetListRequest. + The response contains a table of all Call Processing Policy Profiles + in the system. The column headings are "Name" and "Description". + + + + + + + + + + + + + + + true + false + + + Request a list of NCOSs that have a given CallP Policy Profile assigned. + The response is either a + SystemCallProcessingPolicyProfileGetAssignedNCOSListResponse or + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the + SystemCallProcessingPolicyProfileGetAssignedNCOSListRequest. + The response contains a table of all Network Classes of Service that + contain the specific CAllP Policy Profile. The column headings + are "Name" and "Description". + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile user subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileUserProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileUserProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify a call processing policy profile user subscriber type profile in system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Trunk Group Pilot user subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileTrunkGroupPilotProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Auto Attendant subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequestResponse or an + ErrorResponse. + The response contains the call processing policy profile setting for Auto Attendant. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileAutoAttendantProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile BroadWorks Anywhere subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequestResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileBroadWorksAnywhereProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Call Center subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileCallCenterProfileGetRequestResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileCallCenterProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Collaborate subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileCollaborateProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileCollaborateProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get to modify the call processing policy profile collaborate subscriber type profile. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Find-me/Follow-me subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileFindMeFollowMeProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Flexible Seating Host subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileFlexibleSeatingHostProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Group Paging subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileGroupPagingProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileGroupPagingProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Hunt Group subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileHuntGroupProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileHuntGroupProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Instant Group Call subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileInstantGroupCallProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileInstantGroupCallProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Meet-Me Conferencing subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileMeetMeConferencingProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Route Point subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileRoutePointProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileRoutePointProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile Voice Portal subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileVoicePortalProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileVoicePortalProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the configuration for a call processing policy profile VoiceXML subscriber type profile. + The response is either a SystemCallProcessingPolicyProfileVoiceXMLProfileGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallProcessingPolicyProfileVoiceXMLProfileGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add an entry to the CAP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete an entry from the CAP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get the CAP access control list. + The response is either SystemCAPGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCAPGetACLListRequest14. The table columns are: + "Net Address" and "Description". + + + + + + + + + + + + + + + true + false + + + Modify an entry from the CAP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get the list of CAP system parameters. + The response is either SystemCAPParametersGetResponse19 or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCAPParametersGetRequest19. + Contains a list of system CAP parameters. + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify CAP system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to get the list of Client Session (web and CLI) system parameters. + The response is either SystemClientSessionParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemClientSessionParametersGetRequest. + Contains a list of system Client Session (web and CLI) parameters. + + + + + + + + + + + + + + + + Request to modify Client Session (web and CLI) system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to add a codec to the ordered list of codecs supported by the system. + The ordered list of codecs is sent to MGCP devices when creating connections. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to delete a supported codec from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get the ordered list of supported codecs in the system. + The ordered list of codecs is sent to MGCP devices when creating connections. + The response is either a SystemCodecGetListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCodecGetListRequest. + + + + + + + + + + + + + + + Add a Communication Barring Alternate Call Indicator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a Communication Barring Alternate Call Indicator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get all the Communication Barring Alternate Call Indicator defined + in the system. The response is either a SystemCommunicationBarringAlternateCallIndicatorGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemCommunicationBarringAlternateCallIndicatorGetListRequest. Contains a table with one row per Communication Barring Alternate Call Indicator. The table column headings are: "Alternate Call Indicator" and "Network Server Alternate Call Indicator". + + + + + + + + + + + + + + + Modify a Communication Barring Alternate Call Indicator. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a Communication Barring Call Type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a Communication Barring Call Type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get all the Communication Barring Call Types defined in the system. + The response is either a SystemCommunicationBarringCallTypeGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemCommunicationBarringCallTypeGetListRequest. Contains a table with one row per Communication Barring Call Type. The table column headings are: "Call Type" and "Network Server Call Type". + + + + + + + + + + + + + + + Modify a Communication Barring Call Type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a new Communication Barring Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete an existing Communication Barring Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get an existing Communication Barring Criteria. + The response is either a + SystemCommunicationBarringCriteriaGetResponse19sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringCriteriaGetRequest19sp1. + The response contains the Communication Barring Criteria information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the list of all Communication Barring Criteria. + The response is either a + SystemCommunicationBarringCriteriaGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemCommunicationBarringCriteriaGetListRequest. + The response contains a table of all Communication Barring Criteria + in the system. The column headings are "Name" and "Description". + + + + + + + + + + + + + + + Modify an existing Communication Barring Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a new Communication Barring Digit Pattern Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete an existing Communication Barring Digit Pattern Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of all Digit Pattern Criteria defined at the system level. + The response is either a SystemCommunicationBarringDigitPatternCriteriaGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemCommunicationBarringDigitPatternCriteriaGetListRequest. + The response contains a table of all Digit Pattern Criteria defined at the system level. The column headings are "Name" and "Description" + + + + + + + + + + + + + + + Get an existing Digit Pattern Criteria. + The response is either a SystemCommunicationBarringDigitPatternCriteriaGetPatternListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringDigitPatternCriteriaGetPatternListRequest. + The response contains the Digit Pattern Criteria information. + + + + + + + + + + + + + + + Get an existing Communication Barring Digit Pattern Criteria. + The response is either a SystemCommunicationBarringDigitPatternCriteriaGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + The response to a SystemCommunicationBarringDigitPatternCriteriaGetRequest. + + + + + + + + + + + + + + + + Modify an existing Communication Barring Digit Pattern Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Add a new Communication Barring Incoming Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Delete an existing Communication Barring Incoming Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get an existing Communication Barring Incoming Criteria. + The response is either a + SystemCommunicationBarringIncomingCriteriaGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemCommunicationBarringIncomingCriteriaGetRequest. + The response contains the Communication Barring Incoming Criteria information. + + + + + + + + + + + + + + + + + + true + false + + + Get the list of all Communication Barring Incoming Criteria. + The response is either a + SystemCommunicationBarringIncomingCriteriaGetListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemCommunicationBarringIncomingCriteriaGetListRequest. + The response contains a table of all Communication Barring Incoming Criteria + in the system. The column headings are "Name" and "Description". + + + + + + + + + + + + + + + true + false + + + Modify an existing Communication Barring Incoming Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Communication Barring. + The response is either a SystemCommunicationBarringGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemCommunicationBarringGetRequest. + + + + + + + + + + + + + + + Modify the system level data associated with Communication Barring. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Add a new Communication Barring Profile. + The priorities for IncomingRules are requantized to consecutive integers as part of the add. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + callMeNowDefaultAction, use value "Block" in HSS data mode + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers, use value "false" in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete an existing Communication Barring Profile. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of Communication Barring Proifles that uses a specific + Communication Barring criteria. + The response is either a SystemCommunicationBarringProfileGetCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetCriteriaUsageListRequest. + The response contains a table of system Communication Barring Profiles that + use the specific Communication Barring Criteria. The column headings + are "Name" and "Description" + + + + + + + + + + + + + + + true + false + + + Get the list of Communication Barring Proifles that uses a specific + Communication Barring Incoming criteria. + The response is either a SystemCommunicationBarringProfileGetIncomingCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemCommunicationBarringProfileGetIncomingCriteriaUsageListRequest. + The response contains a table of system Communication Barring Profiles that + use the specific Communication Barring Incoming Criteria. The column headings + are "Name" and "Description" + + + + + + + + + + + + + + + Get the list of Profiles that use a specific Digit Pattern Criteria. + The response is either a + SystemCommunicationBarringProfileGetDigitPatternCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetDigitPatternCriteriaUsageListRequest. + The response contains a table of all Profiles that use the specific Digit Pattern Criteria. The column headings are "Name" and "Description" + + + + + + + + + + + + + + + Get the list of all Communication Barring Profiles. + The response is either a + SystemCommunicationBarringProfileGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetListRequest. + The response contains a table of all Communication Barring Profiles + in the system. The column headings are "Name" and "Description" + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a SystemCommunicationBarringProfileGetResponse19sp1 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetRequest19sp1. + The response contains the Communication Barring Profile information. + The incoming rules are returned in ascending priority order. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get an existing Communication Barring Profile. + The response is either a SystemCommunicationBarringProfileGetResponse19sp1V2 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringProfileGetRequest19sp1V2. + The response contains the Communication Barring Profile information. + The incoming rules are returned in ascending priority order. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify an existing Communication Barring Profile. + When the originatingDefaultAction is not Treatment, originatingDefaultTreatmentId + will be automatically cleared. Also when the action of originatingRule is not Treatment, + treatmentId will be automatically cleared for the rule. + The priorities for IncomingRules are requantized to consecutive integers as part of the modify. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + callMeNowDefaultAction + callMeNowDefaultCallTimeout + callMeNowRule + applyToAttendedCallTransfers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the list of Service Providers that use a specific + Communication Barring Criteria. + The response is either a SystemCommunicationBarringServiceProviderGetCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemCommunicationBarringServiceProviderGetCriteriaUsageListRequest. + The response contains a table of all Service Providers that use the specific Communication Barring criteria. The column headings are "Service Provider Id", "Service Provider Name" and "Is Enterprise" + + + + + + + + + + + + + + + true + false + + + Get the list of Service Providers that use a specific + Communication Barring Incoming Criteria. + The response is either a SystemCommunicationBarringServiceProviderGetIncomingCriteriaUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemCommunicationBarringServiceProviderGetIncomingCriteriaUsageListRequest. + The response contains a table of all Service Providers that use the specific Communication Barring Incoming criteria. The column headings are "Service Provider Id", "Service Provider Name" and "Is Enterprise" + + + + + + + + + + + + + + + Request to get the File System parameters. + The response is either SystemConfigurableFileSystemGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemConfigurableFileSystemGetRequest. + Contains the File System parameters. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify File System parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a configurable treatment. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a configurable treatment. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of configurable treatments. + The response is either a SystemConfigurableTreatmentGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemConfigurableTreatmentGetListRequest. Contains a table with one row per treatment. + The table columns are: "Treatment Id", "Description". + + + + + + + + + + + + + + + Get all the attributes of a configurable treatment. + The response is either a SystemConfigurableTreatmentGetResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemConfigurableTreatmentGetRequest16. + The response contains the treatment configurable information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the fields for a configurable treatment. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Gets the system level attributes of the Cr Interface. + The response is either a SystemCrInterfaceGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemCrInterfaceGetRequest. + + + + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Cr Interface. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Add an Access SIP Status Code Mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete an Access SIP Status Code mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests a table of all the existing Access Side SIP Status Code Mappings in the system. + The response is either an SystemTreatmentMappingAccessSIPStatusGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemTreatmentMappingAccessSIPStatusGetListRequest. Contains a table with one row per mapping. + The table columns are: "SIP Status Code", "Treatment Id". + + + + + + + + + + + + + + + Modify the fields for an Access SIP Status Code mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a Call Blocking Service mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a Call Blocking Service mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests a table of all the existing Call Blocking Service Mappings in the system. + The response is either a SystemTreatmentMappingCallBlockingServicesGetListResponse19sp1 + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemTreatmentMappingCallBlockingServiceGetListRequest19sp1. Contains a table with one row per mapping. + The table columns are: "Service", "Treatment Id". + + + + + + + + + + + + + + + Modify the fields for a Call Blocking Service mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add an Internal Release Cause mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete an Internal Release Cause mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests a table of all the Internal Release Cause mappings in the system. + The response is either a SystemTreatmentMappingInternalReleaseCauseGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemTreatmentMappingInternalReleaseCauseGetListRequest. Contains a table with one row per mapping. + The table columns are: "Internal Release Cause", "Treatment Id". + + + + + + + + + + + + + + + Modify the fields for an Internal Release Cause mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a Network Server Treatment mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a NS Treatment mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests a table of all the existing NS Treatment Mappings in the system. + The response is either a SystemTreatmentMappingNetworkServerTreatmentGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemTreatmentMappingNetworkServerTreatmentGetListRequest. Contains a table with one row per mapping. + The table columns are: "NS Treatment", "Treatment Id". + + + + + + + + + + + + + + + Modify the fields for a Network Server Treatment mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a Network SIP Status Code mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a Network SIP Status Code mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests a table of all the existing Network SIP Status Code Mappings in the system. + The response is either an SystemTreatmentMappingNetworkSIPStatusCodeGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemTreatmentMappingNetworkSIPStatusGetListRequest. Contains a table with one row per mapping. + The table columns are: "SIP Status Code", "Treatment Id". + + + + + + + + + + + + + + + Modify the fields for a Network SIP Status Code mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a Q850 Cause Value mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a Q850 Cause Value mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests a table of all the existing Q850 Cause Value Mappings in the system. + The response is either a SystemTreatmentMappingQ850CauseGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemTreatmentMappingQ850CauseGetListRequest. Contains a table with one row per mapping. + The table columns are: "Q850 Cause Value", "Treatment Id". + + + + + + + + + + + + + + + Modify the fields for a Q850CauseValue mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Represents a Verify Translation and Routing request which can be either a request containing + parameters or a request containing a SIP message. Returns a SystemVerifyTranslationAndRoutingResponse. + + + + + + + + + + + + + + + + true + false + + + Represents a Verify Translation and Routing Test Call Result. + + + + + + + + + The Verify Translation and Routing log created by the request. + + + + + + + + + + + + Add a country code to the system. + If ringPeriodMilliseconds is not specified, a default of 6000 milliseconds is assumed. + If offHookWarningTimerSeconds is not specified, a default of 30 seconds is assumed. + If enableNationalPrefix is not specified, a default of false is assumed. + If nationalPrefix is not specified, a default of null string is assumed. + If disableNationalPrefixForOffNetCalls is not specified, a default of false is assumed. + The following elements are only used in AS data mode: + disableNationalPrefixForOffNetCalls. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Delete a country code from the system. + A country code cannot be deleted if it is the default country code or + if any carriers or call type mappings are defined against it. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request data for all country codes. + The response is either a SystemCountryCodeGetListResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to a SystemCountryCodeGetListRequest. Contains the default country code + and a table with one row per country code. The table columns are + "Country Code", "Country Name", "Off Hook Warning Seconds", + "Ring Period Milliseconds", "National Prefix", "Use Prefix", + "Maximum Call Waiting Tones", "Time Between Call Waiting Tones Milliseconds" + and "Disable National Prefix for OffNet Calls". + + + + + + + + + + + + + + + + Modify the attributes of a country code. + If becomeDefaultCountryCode is true, the country code + in this request becomes the default country code for the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Add a system call type mapping. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Delete a system call type mapping. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get a list of system call types. + The response is either SystemCallTypeGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemCallTypeGetListRequest. + + + + + + + + + + + + + + + Get a list of system call type mappings. + The response is either SystemCallTypeGetMappingListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemCallTypeGetMappingListRequest. The table columns are: + "Country Code", "Digit Map" and "Call Type". + + + + + + + + + + + + + + + Add a device CPE config file server. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a device CPE config file server. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Requests the list of device CPE config file servers. + The response is either SystemCPEConfigGetFileServerListResponse14sp6 or ErrorResponse. + + + + + + + + + + + + + Response to SystemCPEConfigGetFileServerListRequest14sp6. The table columns are: + "Device Type", "File Repository Name", "Directory", "Extended File Repository Name". + + The following columns are only used in AS data mode: + "Extended File Repository Name" + + + + + + + + + + + + + + + Modify a device CPE config file server. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of CPE Config system parameters. + The response is either SystemCPEConfigParametersGetResponse21 or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCPEConfigParametersGetListRequest21. + Contains a list of system CPE Config parameters. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify CPE Config system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Rebuild the system default config file for the specified device type. + If the device type is not specified, all files for all device types in the system are rebuilt. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Rebuild the config file for a specified device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Reset a specific system device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Reset all the devices of the specified device type in the system. + If the device type is not specified, all device in the system are reset. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Reorder the lines of a System device. You can not add or delete line ports, only + re-ordering the list is allowed. The ordered list of line ports can be obtained + with the SystemAccessDeviceGetRequest16 command. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to set a new system default configuration file for a device type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request the list of OCI request prefixes including if they trigger DM + automatic rebuild event or not. + The response is either a SystemDeviceManagementAutoRebuildConfigGetListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemDeviceManagementAutoRebuildConfigGetListRequest. + Contains a table with column headings: "OCI Request Prefix", "Auto Rebuild Enabled". + "OCI Request Prefix" is the prefix of the OCI request name. It does + not include the request's version '17.sp4, 18...' since the disabled + flag applies to the whole series of requests, independent of the + version. + "Auto Rebuild Enabled": 'True' if the request prefix triggers DM events + automatically. Otherwise, automatic DM events are not generated. + + + + + + + + + + + + + + + true + false + + + Request to enable or disable automatic trigger of DM events for + OCI request prefixes, regardless of the request's + version. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request device management's events for a specific queue. + It is possible to restrict the number of rows returned using + responseSizeLimit. + If eventQueueType is not specified, the events from all the + event queues are returned. + The response is either a SystemDeviceManagementEventGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemDeviceManagementEventGetListRequest. + Contains a table with column headings: "Event Id", "Status", "Action", + "Level", "Type", "Additional Info", "Is Local", "Completion %", + "Pushed/ Same Hash/ Not Pushed", "Login Id", "Start Time", + "Process Time". + "Event Id" is a unique identifer for the event. + "Status" can be: Pending, Queued, In Progress, + Process On Other Host, Stale, Completed, Canceled. + "Action" can be: Delete, Download, Rebuild, Reset, Upload. + "Level" can be: Device, Device Type, Device Type Group, Group, User. + "Type" can be: Automatic, Manual. + "Additional Info" includes the affected device type, device or group. + It depends on the level of the event: + Device Profile: "Device Name" "Service Provider Id" "Group Id" + Device Type: "Device Type Name" + Device Type Group: "Service Provider Id" "Group Id" "Device Type Name" + Group: "Service Provider Id" "Group Id" + User: "User Id" + "Is Local" is set to "yes" if the event is processed on the server + who received the request, "no" otherwise meaning that the event is + processed on another server. + "Completion %" provides an estimate of the completion of the event. + A percentage is given, the current number of completed expanded event, + and the total number of expanded event. + "Pushed/ Same Hash/ Not Pushed" gives the total number of files that + were pushed, not pushed because of same hash, and not pushed when + processing the event. + "LoginId" is the user or admin id who triggered the event. + "Start Time" is the date when the event was started. The display + shows the month, days, hours, and minutes (MM-dd hh:mm). + "Process Time" is the time taken to process the event in hours, + minutes, seconds, and milliseconds (hhhh:mm:ss.SSS). + Each row represents an event sorted by priority of processing. The + first row in the table is an event that has an associated expanded + event currently being processed or next in line to be processed. + + + + + + + + + + + + + + + true + false + + + Request the number of access device of a particular device type or all + device types if deviceType is not specified. + If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset. + Devices are counted only if their device type supports Device Management. + An error is returned if deviceType is specified but does not support device management. + The response is either SystemDeviceManagementGetAccessDeviceCountForDeviceTypeResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest. + + + + + + + + + + + + + + + true + false + + + Request a summary table of the number of events in state 'Pending', + 'Queued Internally', and 'Completed' in the system per action. + One row is returned per action. + Actions are as per the DeviceManagementEventActionType (ex: Delete, Download, Rebuild, Reset, Upload). + The state 'Queued Internally' includes total for events with status + equal to 'Queued' and 'In Progress' as per DeviceManagementEventStatus. + The response is either SystemDeviceManagementGetEventStatusSummaryCountResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemDeviceManagementGetEventStatusSummaryCountRequest. + The column headings are "Action, "Pending", "Queued Internally", and "Completed" + + + + + + + + + + + + + + + true + false + + + Cancel pending and in progress events. Either all events, multiple + events, or a list of specified events can be canceled. + When specifying multiple events, an event must meet all specified + criteria to be canceled. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a static configuration tag. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to delete static configuration tags. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to get the list of custom configuration tags managed by the Device Management System. + The response is either SystemDeviceManagementTagGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Response to SystemDeviceManagementTagGetListRequest. + Contains a table of custom configuration tags managed by the Device Management System. + The column headings are: "Tag Name", "Tag Value". + + + + + + + + + + + + + + + Request to modify a static configuration tag. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to add a static configuration tag set. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to modify a static configuration tag set. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to delete a static configuration tag set. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get the list of custom configuration tag sets managed by the Device Management System. + The response is either SystemDeviceManagementTagSetGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemDeviceManagementTagSetGetListRequest. + The response includes an array of tag set names defined in the system. + The system default tag set name is not part of this response. + + + + + + + + + + + + + + + true + true + + + Request to get device password authentication lockout data in the system. + The response is either a SystemDeviceProfileAuthenticationLockoutGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + true + + + Response to SystemDeviceProfileAuthenticationLockoutGetRequest. + The column headings for the lockoutTable are: "Organization Id", "Organization Type", "Group Id", "Identity/Device Profile Name", " Identity/Device Profile Type", "Lockout Started", "Lockout Expires", "Lockout Count". Lockout times are shown in the system GMT time. When a permanent lockout is shown, the "Lockout Expires" column is empty and the "Lockout Count" column contains the word Permanent. + + + + + + + + + + + + + + + true + true + + + Request to clear device profile authentication lockouts in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Request to clear all device password authentication lockouts in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + true + true + + + Request to get the system level device profile authentication password rule settings. + The response is either a SystemDeviceProfileAuthenticationPasswordRulesGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + true + + + Response to SystemDeviceProfileAuthenticationPasswordRulesGetRequest. + Contains the device profile authentication password rules for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify the system level device profile authentication password rule settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to export an existing Device Type to a Device Type Archive File (DTAF). + The response is either a SystemDeviceTypeExportResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemDeviceTypeExportRequest. + + + + + + + + + + + + + + + Request to import a Device Type Archive File (DTAF) as a new Device Type. The URL supports the HTTP and the FILE protocols. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Requests a list of non-obsolete Identity/device profile types defined in the system. It is possible + to get either all conference device types or all non-conferernce types. This command is similar + to the SystemSIPDeviceTypeGetListRequest and SystemMGCPDeviceTypeGetListRequest + but gets both SIP and MGCP types. + The response is either SystemDeviceTypeGetlAvailableListResponse19 or ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetAvailableListRequest19. + + Note: element numberOfPorts is only used by devices types with static line ordering enabled + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the information about the specified device type without regard to whether the + type is SIP or MGCP. + The response is either SystemDeviceTypeGetResponse19 or ErrorResponse. + Note: The elements deviceTypeConfigurationOption and staticLineOrdering apply to SIP device types only. Therefore, only present in the response when the device type is SIP. + + + + + + + + + + + + + + + Response to SystemDeviceTypeGetRequest19. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a new Dialable Caller ID Criteria. Criteria are added at the bottom of the list with the lowest priority. The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a Dialable Caller ID Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get an existing Dialable Caller ID Criteria. + The response is either a + SystemDialableCallerIDCriteriaGetRequest or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemDialableCallerIDCriteriaGetRequest. + The response contains the Dialable Caller ID Criteria information. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify a Dialable Caller ID Criteria. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the system level Dialable Caller ID criteria list. + The response is either a + SystemDialableCallerIDGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemDialableCallerIDGetRequest. + The criteria table?s column headings are ?Active?, "Name", "Description", ?Prefix Digits?, and ?Priority?. + + + + + + + + + + + + + + + true + false + + + Modify the system level Dialable Caller ID criteria list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request the system level data associated with Dial Plan Policy. + The response is either a SystemDialPlanPolicyGetResponse17 or an + ErrorResponse. + + + + + + + + + + + Response to SystemDialPlanPolicyGetRequest17 + + + + + + + + + + + + + + + + + + + Modify the system level data associated with Dial Plan Policy. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request the system level Access Codes data associated with Dial Plan Policy. + The response is either a SystemDialPlanPolicyGetAccessCodeListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to SystemDialPlanPolicyGetAccessCodeListRequest. + Contains a table with column headings: "Access Code", "Enable Secondary Dial Tone", "Description" + + + + + + + + + + + + + + + Request access code data associated with system level Dial Plan Policy access codes. + The response is either a SystemDialPlanPolicyGetAccessCodeResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemDialPlanPolicyGetAccessCodeRequest + + + + + + + + + + + + + + + + + + Request to add a system-level Dial Plan Access Code and its all attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to delete a system-level Dial Plan Access Code and its all attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to modify a system-level Dial Plan Access Code and its attribues. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Request the system's digit collection attributes. + The response is either a SystemDigitCollectionGetResponse13mp4 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemDigitCollectionGetRequest13mp4. + + + + + + + + + + + + + + + + + Modifies the system's digit collection attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request a summary table of all DNs in the system. + The response is either SystemDnGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemDnGetSummaryListRequest. + The column headings are "Phone Numbers, "Service Provider Id" and "Is Enterprise" + + + + + + + + + + + + + + + Request a list of DN utilizations by service providers. + The response is either SystemDnUtilizationGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemDnUtilizationGetListRequest. + The table columns are: "Service Provider Id", "Phone Numbers", "Assigned to Groups", + "Percentage Assigned", "Is Enterprise" and "Activated on Groups". + + + + + + + + + + + + + + + Get the utilization of a single DN. + The response is either + SystemDnGetUtilizationResponse14sp3 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemDnGetUtilizationRequest14sp3. + The isActivated element is only included when the DN is + assigned to a user. + + + + + + + + + + + + + + + + + + + + Add a system domain to the system. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Delete a system domain from the system. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request a list of service providers that have a given domain assigned. + The response is either SystemDomainGetAssignedServiceProviderListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemDomainGetAssignedServiceProviderListRequest. + The table columns are: "Service Provider Id", "Service Provider Name" and "Is Enterprise". + + + + + + + + + + + + + + + Requests the list of all system-level domain names. + The response is either SystemDomainGetListResponse or ErrorResponse. + + + + + + + + + + + + + Contains a simple list of all system-level domain names. + + + + + + + + + + + + + + + + Request to get the list of system Domain parameters. + The response is either SystemDomainParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemDomainParametersGetRequest. + Contains the system Domain parameters. + + + + + + + + + + + + + + + + Request to modify system Domain parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the system DTMF transmission configurations. + The response is either SystemDTMFTransmissionGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to the SystemDTMFTransmissionGetRequest. + + + + + + + + + + + + + + + + Modify the DTMF transmission settings. + The response is either SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to search endpoints in the system. + The response is either SystemEndpointGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemEndpointGetListRequest. + The column headings for the endpointTable are: "Organization Id", "Organization Type", "Group Id", "Line/Port", "Last Name","First Name", "User Id", "User Type", "Phone Number", "Extension", "Device Type", "Device Name", "Net Address", "MAC Address", "Department", "Email Address". + Possible values for User Type are ‘User’, ‘CCBasic’, ‘CCStandard’, ‘CCPremium’, ‘RP’, ‘MOH’, ‘MOHVideo’. + + + + + + + + + + + + + + + Request to get the expensive call notification service parameters. + The response is either a SystemExpensiveCallNotificationGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemExpensiveCallNotificationGetRequest. + + + + + + + + + + + + + + + + Modify the expensive call notification service parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Add an alternate call indicator to the list of expensive alternate call indicators. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete an alternate call indicator from the list of expensive alternate call indicators. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get the list of expensive alternate call indicators in the system. + The response is either a SystemExpensiveCallTypeGetListResponse16sp1 + or an ErrorResponse. + + + + + + + + + + + + + Response to SystemExpensiveCallTypeGetListRequest16sp1. + The column headings are: + "Alternate Call Indicator", "Treatment Audio File". + + + + + + + + + + + + + + + Modify an existing call indicator in the list of expensive alternate call indicators. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request to export Application Server addressing data, such as DNs, extensions, alias and user ids + to a file so they can be uploaded to a Network Server. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to export all users that have BroadCloud services, such as + user profile information and BroadCloud services related information for that user + to a file so they can be uploaded to a Messaging Server. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request the system's extension range. + The response is either a SystemExtensionLengthGetResponse or an ErrorResponse. + + + + + + + + + + + Response to SystemExtensionLengthGetRequest. + + + + + + + + + + + + + + + + Modify the group's extension length range. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add an entry to the external authentication access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete an entry from the external authentication access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the external authentication access control list. + The response is either SystemExternalAuthenticationGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemExternalAuthenticationGetACLListRequest. The table columns are: + "Net Address" and "Description". + + + + + + + + + + + + + + + Modify an entry from the external authentication access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of External Emergency Routing system parameters. + The response is either SystemExternalEmergencyRoutingParametersGetResponse13mp13 or ErrorResponse. + + + + + + + + + + + + + Response to SystemExternalEmergencyRoutingParametersGetRequest13mp13. + Contains a list of system External Emergency Routing parameters. + + + + + + + + + + + + + + + + + + + Request to modify Call External Emergency Routing system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Request to get list of default Feature Access Codes defined on system + level. + The response is either SystemFeatureAccessCodeGetListResponse20 or + ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + true + false + + + Response to the SystemFeatureAccessCodeGetListRequest21. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + true + false + + + Modify default Feature Access Codes. + The response is either a SuccessResponse or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording - Start". + + + + + + + + + + + + + + + Requests the contents of a file. + The response is either a SystemFileGetContentResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to a SystemFileGetContentRequest. The fileContent length returned is limited to 128KBytes. + + + + + + + + + + + + + + + true + false + + + Add a new file repository. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a file repository. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Modify a file repository. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the file repository information. The response is either SystemFileRepositoryDeviceGetResponse20 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemFileRepositoryDeviceGetRequest20. + + + + + + + + + + + + + + + + + + + + Request the list of file repositories in the system. + The response is either a SystemFileRepositoryDeviceGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemFileRepositoryDeviceGetListRequest. + Contains a table with column headings : "Name","Protocol", "Root Directory" in a row for each file repository. + + + + + + + + + + + + + + + Add a new file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Modify a file repository user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request a user of a file repository in the system. + The response is either a SystemFileRepositoryDeviceUserGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemFileRepositoryDeviceUserGetRequest. + + + + + + + + + + + + + + + + + Request the list of users for a file repository in the system. + The response is either a SystemFileRepositoryDeviceUserGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemFileRepositoryDeviceUserGetListRequest. + Contains a table with column headings : "User Name","Allow Get","Allow Delete","Allow Put" in a row for each file repository user. + + + + + + + + + + + + + + + Request to get the list of Peer SIP Connection system parameters + The response is a SystemGeographicRedundancyPeerSipConnectionMonitoringGetResponse. + + + + + + + + + + + + + Response to SystemGeographicRedundancyPeerSipConnectionMonitoringGetRequest. + Contains a list of Peer SIP Connection Monitoring system parameters. + + + + + + + + + + + + + + + + + Modify the list of Peer SIP Connection Monitoring system parameters + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of Geographic Redundancy Proxy system parameters + The response is a SystemGeographicRedundancyProxyGetResponse. + + + + + + + + + + + + + Response to SystemGeographicRedundancyProxyGetRequest. + Contains a list of Geographic Redundancy Proxy system parameters. + + + + + + + + + + + + + + + Modify the list of Geographic Redundancy Proxysystem parameters + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of users that are unreachable from the primary application server. + The response is a SystemGeographicRedundancyUnreachableFromPrimaryGetUserListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemGeographicRedundancyUnreachableFromPrimaryGetUserListRequest. The Unreachable From Primary User table column + headings are: "User ID", "Lineport". + + + + + + + + + + + + + + + true + false + + + Get the list of registration contacts. + This request handles all levels of administration privileges. The content of the response will only contain items within the scope of the requester's login id. At the system level any of the choice parameters may be specified to filter the registrations listed. At the service provider level the serviceProviderId must be specified for the service provider and group options. When using the userId or linePort options the specified value must be valid for that service provider login. At the group level the servicProviderId and the groupId must be specified for the group option. When using the userId or linePort options the specified value must be valid for that group login. The serviceProviderId option is not valid at the group level. At the user level when using the userId or linePort options the specified value must be valid for that user login. The serviceProviderId and groupId options are not valid at the user level. + The response is either SystemGetRegistrationContactListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemGetRegistrationContactListRequest. The table columns are: "Service Provider Id", "Group Id", "User Id", "Line/Port", "Endpoint Type", "Order", "URI", "Expiration", "Contact", "Device Level", "Device Name", "Public Net Address", "Public Port", "Private Net Address", "Private Port", "User Agent". + + + + + + + + + + + + + + + Add a Home Network. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Delete a Home Network. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of all Home Networks. + The response is either a SystemHomeNetworkGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the SystemHomeNetworkGetListRequest. + + + + + + + + + + + + + + + Request to add a language to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete a language from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request the defined languages in the system. + The response is either a SystemLanguageGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemLanguageGetListRequest. + The language table column headings are: "Language", "Locale" and "Encoding". + + + + + + + + + + + + + + + + Request to modify a language properties in the system. + If the becomeDefaultLanguage element is present, the language in this request becomes + the default language for the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get all the licensing information. + The response is either SystemLicensingGetResponse14sp3 or ErrorResponse. + + + + + + + + + + + + + Response to SystemLicensingGetRequest14sp3. The subscriber license table columns are: "Name", "Licensed", "Used" and "Available". + The group service license table columns are: "Name", "Licensed", "Used" and "Available". + The virtual service license table columns are: "Name", "Licensed", "Used" and "Available". + The user service license table columns are: "Name", "Licensed", "Used", "Used By Hosted Users", "Used By Trunk Users", "Available" and "Expiration Date". + The system param license table columns are: "Name", "Licensed", "Used", Available". + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of system licenses in the system. + The response is either a SystemLicensingGetSystemLicenseListResponse21 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemLicensingGetSystemLicenseListRequest21. + + + + + + + + + + + + + + + Modify the log configuration file. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get the list of Mail system parameters. + The response is either SystemMailParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemMailParametersGetListRequest. + Contains a list of system Mail parameters. + + + + + + + + + + + + + + + + + + + Request to modify Mail system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to add a Media to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to delete a Media from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of media in the system. + The response is either a SystemMediaGetListResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemMediaGetListRequest. The column headings are + "Media Name", "Codec", "Media Type", "Bandwidth Enforcement Type" and "Bandwidth". + + + + + + + + + + + + + + + Request to modify a media. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to add a Media Server to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to delete a Media Server from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of Media Servers defined in the system. + The response is either a SystemMediaServerGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemMediaServerGetListRequest. The Media Server table column + headings are: "Net Address", "Port", "Transport", "Description". + + + + + + + + + + + + + + + Request to modify a Media Server in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to get the list of Media Server system parameters. + The response is either SystemMediaServerParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemMediaServerParametersGetListRequest. + Contains a list of system Media Server parameters. + + + + + + + + + + + + + + + + + Request to modify Media Server system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to add a Media Set. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to delete a Media Set. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get the list of Media Sets in the system. + The response is either a SystemMediaSetGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemMediaSetGetRequest. + + + + + + + + + + + + + + + Request to get a Media Set. + The response is either a SystemMediaSetGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemMediaSetGetRequest. + Returns a list of media names in the set. + + + + + + + + + + + + + + + Request to modify a Media Set. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of mgcp device types in the system. + See Also: SystemDeviceTypeGetAvailableListRequest14sp3. + The response is either SystemMGCPDeviceTypeGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemMGCPDeviceTypeGetListRequest. + Contains a table of identity/ device profile types configured in the system. + The column headings are: "Device Type", "Profile", "Is Obsolete". + + + + + + + + + + + + + + + Request to get a mgcp device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemMGCPDeviceTypeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemMGCPDeviceTypeGetRequest. + + + + + + + + + + + + + + + + + + Request to modify a mgcp device type. In release 14, this is limited to changing the obsolete flag. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get a list of migrated users. + The response is either SystemLicensingGetResponse14sp3 or ErrorResponse. + + + + + + + + + + + + + Response to SystemMigratedUsersGetListRequest. + + + + + + + + + + + + + + + Request the system level data associated with Multimedia Policy. + The response is either a SystemMultimediaPolicyGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemMultimediaPolicyGetRequest + + + + + + + + + + + + + + + Modify the system level data associated with Multimedia Policy. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Add a new Network Class of Service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a Network Class of Service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get an existing Network Class of Service. + The response is either a SystemNetworkClassOfServiceGetResponse19sp1 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemNetworkClassOfServiceGetRequest19sp1. + The response contains the Network Class of Service information. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request a list of service providers that have a given Network Class + of Service assigned. + The response is either a + SystemNetworkClassOfServiceGetAssignedServiceProviderListResponse or + ErrorResponse. + + + + + + + + + + + + + + + Response to the + SystemNetworkClassOfServiceGetAssignedServiceProviderListRequest. + The response contains a table of all Service Providers that have + the given Network Class of Service assigned. The column headings are + "Service Provider Id", "Service Provider Name" and "Is Enterprise". + + + + + + + + + + + + + + + Get the list of Network Classes of Service that contain a specific + Communication Barring Profile. + The response is either a SystemNetworkClassOfServiceGetCommunicationBarringProfileUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemNetworkClassOfServiceGetCommunicationBarringProfileUsageListRequest. + The response contains a table of all Network Classes of Service that + contain the specific Communication Barring Profile. The column headings + are "Name" and "Description" + + + + + + + + + + + + + + + Get the list of all Network Classes of Service. + The response is either a SystemNetworkClassOfServiceGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemNetworkClassOfServiceGetListRequest. + The response contains a table of all Network Classes of Service + in the system. The column headings are "Name" and "Description" + + + + + + + + + + + + + + + Modify an existing Network Class of Service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of Network Device Polling system parameters. + The response is either SystemNetworkDeviceMonitorParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemNetworkDeviceMonitorParametersGetListRequest. + Contains a list of system Network Device Polling parameters. + + + + + + + + + + + + + + + + Request to modify Network Device Polling system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request the system level data associated with network progression. + The response is either a SystemNetworkProgressionGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemNetworkProgressionGetRequest. + + + + + + + + + + + + + + + + Modify the system level data associated with network progression. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to add a routing Network Server to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to delete a routing Network Server from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of routing Network Servers defined in the system. + The response is either a SystemNetworkRoutingServerGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemNetworkRoutingServerGetListRequest. The routing Network Server table column + headings are: "Net Address", "Port", "Transport", "Poll", "OpState", "Description". + + + + + + + + + + + + + + + Request to modify a routing Network Server in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to get the list of Network Server Sync system parameters. + The response is either SystemNetworkServerSyncParametersGetResponse17sp4 or ErrorResponse. + + + + + + + + + + + + + Response to SystemNetworkServerSyncParametersGetRequest17sp4. + Contains a list of system Network Server Sync parameters. + The following elements are only used in AS data mode: + syncTrunkGroups + + + + + + + + + + + + + + + + + + Request to modify Network Server Sync system parameters. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + syncTrunkGroups + + + + + + + + + + + + + + + + + + Request to add a Network Server to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete a Network Server from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of Network Servers defined in the system. + The response is either a SystemNetworkSynchingServerGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemNetworkSynchingServerGetListRequest. The Network Server table column + headings are: "Net Address", "Port", "Description". + + + + + + + + + + + + + + + + Request to modify a Network Server in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to get the number activation state and enterprise trunk number range activation status. + The response is either SystemNumberActivationGetResponse21 or ErrorResponse. + + + + + + + + + + + + + Response to SystemNumberActivationGetRequest21. + Contains the system number activation and enterprise trunk number range activation setting. + + + + + + + + + + + + + + + + Request to modify system number activation and enterprise trunk number range activation setting. + The response is either SuccessResponse or ErrorResponse. + + The following element values are only applicable in AS data mode: + numberActivationMode = Group And User Activation Enabled will raise + an error in HSS data mode. + + + + + + + + + + + + + + + + true + false + + + Request to add a System Number Portability Query Status Digit Pattern mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to delete a list of System Number Portability Status Digit Pattern mappings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get a System Number Portability Status Digit Pattern mapping. + The response is either a SystemNumberPortabilityQueryDigitPatternGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemNumberPortabilityQueryDigitPatternGetRequest. + + + + + + + + + + + + + + + true + false + + + Request to get the System Number Portability Query Digit Pattern List information. + The response is either a SystemNumberPortabilityQueryDigitPatternGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to the SystemNumberPortabilityQueryDigitPatternGetListRequest. + Contains a table with column headings: + "Digit Pattern", "Status". + + + + + + + + + + + + + + + true + false + + + Request to modify a System Number Portability Status Digit Pattern mapping. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get a list system Number Portability Query Statuses. + The response is either SystemNumberPortabilityQueryStatusGetListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemNumberPortabilityQueryStatusGetListRequest. + Contains a table with column headings: + "Status and Treatment File Name". + + + + + + + + + + + + + + + true + false + + + Delete a list of system number portability query statuses. + The number of status entries is limited to 100. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Add a system number portability status information. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get information for a system Number Portability Query Status. + The response is either SystemNumberPortabilityQueryStatusGetResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemNumberPortabilityQueryStatusGetRequest. + + + + + + + + + + + + + + + true + false + + + Modify the system number portability status information. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get system Number Portability Query Parameters. + The response is either SystemNumberPortabilityQueryGetResponse or ErrorResponse. + + + + + + + + + + + true + false + + + Response to the SystemNumberPortabilityQueryGetRequest. + Returns system Number Portability Query Parameters. + + + + + + + + + + + + + + + + true + false + + + Modify system Number Portability Query Parameters. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add an entry to the OCI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete an entry from the OCI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the OCI access control list. + The response is either SystemOCIGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemOCIGetACLListRequest. + Returns a 2 coulmn table with column headings: + "Net Address" and "Description". + + + + + + + + + + + + + + + Modify an entry in the OCI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Add an entry to the OCI call control access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete an entry from the OCI call control access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the OCI call control access control list. + The response is either SystemOCICallControlGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemOCICallControlGetACLListRequest. The table columns are: + "Net Address" and "Description". + + + + + + + + + + + + + + + Modify an entry from the call control access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Add an application to the OCI call control application list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Delete an entry from the OCI call control application list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the OCI call control application list. + The response is either SystemOCICallControlApplicationGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemOCICallControlApplicationGetListRequest. The table columns are: + "Application Id", "Enabled System Wide", "Description" "Notification Timeout Seconds" and "Max Event Channels Per Set". + + + + + + + + + + + + + + + Modify an application from the OCI call control application list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Add an entry to the OCI call control application access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Delete an entry from the OCI call control application access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the OCI call control access control list. + The response is either SystemOCICallControlApplicationGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemOCICallControlApplicationGetACLListRequest. The table columns are: + "Net Address" and "Description". + + + + + + + + + + + + + + + Modify an entry from the call control access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Add an entry to the OCI Reporting Access Control List. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Add a list of reported messages for a host in the OCI Reporting + Access Control List. The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + Delete an entry from the OCI Reporting Access Control List. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Delete a list of reported messages from a host in the OCI Reporting + Access Control List. The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + Get the OCI Reporting Access Control List. + The response is either a SystemOCIReportingACLListGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemOCIReportingACLListGetRequest. + Contains a table with one row per access control list entry. + The table columns are "Net Address", "Description" and "Restrict Messages". + + + + + + + + + + + + + + + Get a list of restricted messages from a host in the OCI Reporting + Access Control List. The response is either a + SystemOCIReportingGetMessageNameListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemOCIReportingGetMessageNameListRequest. + + + + + + + + + + + + + + + Modify the description on an entry in the OCI Reporting Access Control List. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of OCIReporting system parameters. + The response is either SystemOCIReportingParametersGetResponse14sp1 or + ErrorResponse. + + + + + + + + + + + + + Response to SystemOCIReportingParametersGetRequest14sp1. + Contains a list of system OCI Reporting parameters. + + + + + + + + + + + + + + + + + + + Request to modify OCI Reporting system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Add a new Office Zone. The zoneList is an ordered list with the first member being of the highest priority. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Delete an Office Zone. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get an existing Office Zone. + The response is either a SystemOfficeZoneGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemOfficeZoneGetRequest. + The response contains the Office Zone information. + + + + + + + + + + + + + + + + + true + false + + + Request a list of service providers that have a given Office Zone assigned. The response is either a SystemOfficeZoneGetAssignedServiceProviderListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the + SystemOfficeZoneGetAssignedServiceProviderListRequest. + The response contains a table of all Service Providers that have the given Office Zone assigned. The column headings are + "Service Provider Id", "Service Provider Name" and "Is Enterprise". + + + + + + + + + + + + + + + true + false + + + Get the list of all Office Zones. + The response is either a SystemOfficeZoneGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemOfficeZoneGetListRequest. + The response contains a table of all Office Zones + in the system. The column headings are "Name" and "Description" + + + + + + + + + + + + + + + true + false + + + Get the list of Office Zones that contain a specific + Zone. + The response is either a SystemOfficeZoneGetZoneUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemOfficeZoneGetZoneUsageListRequest. + The response contains a table of all Office Zones that + contain the specific Zone. The column headings + are "Name" and "Description" + + + + + + + + + + + + + + + true + false + + + Modify an existing Office Zone. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Requests the system's password rules setting applicable to + System administrator, Provisioning Administrator, + and/or Service Provider Administrator, Group Administrator, Department Administrator, user. + The response is either SystemPasswordRulesGetResponse16 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPasswordRulesGetRequest16. + Contains the password rules for System administrator, Provisioning Administrator, + and/or Service Provider Administrator, Group Administrator, Department Administrator, user. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the system providers password rule + setting applicable to System Adminstrator, Provisioning Administrator, + and/or Service Provider Administrator, Group Administrator, Department Administrator, User. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a performance measurements reporting ftp server. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a performance measurements reporting ftp server. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Generate a performance measurements report. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + Requests the list performance measurements reporting ftp servers. + The response is either SystemPerformanceMeasurementReportingGetFileServerListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemPerformanceMeasurementReportingGetFileServerListRequest. The table columns are: + "FTP Host Net Address", "FTP User Id", "Passive FTP". + + + + + + + + + + + + + + + Requests the performance measurements reporting settings. + The response is either SystemPerformanceMeasurementReportingGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemPerformanceMeasurementReportingGetRequest. + + + + + + + + + + + + + + + + + + + + Modify a performance measurements reporting ftp server. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Modify the performance measurements reporting settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + true + + + Requests the system's default policy settings. + The response is either SystemPolicyGetDefaultResponse20 or ErrorResponse. + + + + + + + + + + + + + true + true + + + Response to SystemPolicyGetDefaultRequest20. + Contains the default policy settings for the system. + The following elements are only used in AS data mode: + GroupAdminDialableCallerIDAccess + ServiceProviderAdminDialableCallerIDAccess + GroupAdminCommunicationBarringUserProfileAccess (This element is only used for groups in an Enterprise) + GroupAdminVerifyTranslationAndRoutingAccess + ServiceProviderAdminVerifyTranslationAndRoutingAccess + The following elements are only used in HSS data mode: + serviceProviderAdminCommunicationBarringAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify the system's default policy settings. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + GroupAdminDialableCallerIDAccess + ServiceProviderAdminDialableCallerIDAccess + GroupAdminCommunicationBarringUserProfileAccess (This element is only used for groups in an Enterprise) + GroupAdminVerifyTranslationAndRoutingAccess + ServiceProviderVerifyTranslationAndRoutingAccess + The following elements are only used in HSS data mode: + serviceProviderAdminCommunicationBarringAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add an entry to the Portal API access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete an entry from the Portal API access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the Portal API access control list. + The response is either SystemPortalAPIGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemPortalAPIGetACLListRequest. + Returns a table with column headings: + "Net Address" and "Description". + + + + + + + + + + + + + + + Modify an entry within the Portal API access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Requests the system passcode rules setting. + The response is either SystemPortalPasscodeRulesGetResponse19 or ErrorResponse. + + + + + + + + + + + + + Response to SystemPortalPasscodeRulesGetRequest. + Contains the system passcode rules setting. + + The following elements are only used in AS data mode: + numberOfRepeatedDigits + disallowRepeatedPatterns + disallowContiguousSequences + numberOfAscendingDigits + numberOfDescendingDigits + numberOfPreviousPasscodes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the system passcode rules setting. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + numberOfRepeatedDigits + disallowRepeatedPatterns + disallowContiguousSequences + numberOfAscendingDigits + numberOfDescendingDigits + numberOfPreviousPasscodes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the system's provisioning validation attributes. + The response is either a SystemProvisioningValidationGetResponse14sp2 or ErrorResponse. + + + + + + + + + + + + + Response to the SystemProvisioningValidationGetRequest14sp2. + + + + + + + + + + + + + + + + + Request to modify the system's provisioning validation attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of Redundancy system parameters. + The response is either SystemRedundancyParametersGetResponse16sp2 or ErrorResponse. + + + + + + + + + + + + + Response to SystemRedundancyParametersGetRequest16sp2. + Contains a list of system Redundancy parameters. + + + + + + + + + + + + + + + + Request to modify Redundancy system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Add a Roaming Network. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a Roaming Network. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of all Roaming Networks. + The response is either a SystemRoamingNetworkGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the SystemRoamingNetworkGetListRequest. + Contains a table with columns: "MSC Address", "Network Translation Index". + + + + + + + + + + + + + + + Modify a Roaming Network. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add an Route Point External System, which is a cluster of Application + Controllers. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete an Route Point External System. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of Route Point External Systems that are configured for the system. + The response is either SystemRoutePointExternalSystemGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to the SystemRoutePointExternalSystemGetListRequest. + + Contains a table with column headings: + "External System", "Description". + + + + + + + + + + + + + + + Modify an Route Point External System. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of Route Points that are using the specified Route Point External System. + The response is either a SystemRoutePointExternalSystemGetRoutePointListResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemRoutePointExternalSystemGetRoutePointListRequest. + + + + + + + + + + + + + + + Add an application controller to Route Point External System. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete an application controller for Route Point External System. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a list of Application Controllers assigned to the Route Point External Systems specified. + The response is either SystemRoutePointExternalSystemApplicationControllerGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the SystemRoutePointExternalSystemApplicationControllerGetRequest. + + + + + + + + + + + + + + + true + false + + + Request to add a routing device to a route. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Request to add a route to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to add a digit routing table entry to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to delete a routing device from a route. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to delete a route from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to delete a digit routing table entry from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request the system's general routing attributes. + The response is either a SystemRoutingGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemRoutingGetRequest. + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get a list of devices for a route. + The response is either a SystemRoutingGetRouteDeviceListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemRoutingGetRouteDeviceListRequest. The column headings are "Net Address", + "Port", "Transport" and "Description". + + + + + + + + + + + + + + + true + false + + + Request to get a list of routes in the system. + The response is either a SystemRoutingGetRouteListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemRoutingGetRouteListRequest. + + + + + + + + + + + + + + + true + false + + + Request to get the system digit routing table. + The response is either a SystemRoutingGetTranslationListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemRoutingGetTranslationListRequest. The column headings are "Routing Digits" + and "Route". + + + + + + + + + + + + + + + true + false + + + Modifies the system's general routing attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a routing device. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a digit routing table entry in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get the list of system routing profiles. + The response is either a SystemRoutingProfileGetListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemRoutingProfileGetListRequest. + Returns a list of routing profiles defined in the system. + + + + + + + + + + + + + + + Add an event to system schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + Add a system schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a list of events from a system schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a list of system schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of events of a system schedule. + The response is either a SystemScheduleGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemScheduleGetEventListRequest. + The response contains a list of events. + + + + + + + + + + + + + + + Get an event from a system schedule. + The response is either a SystemScheduleGetEventResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemScheduleGetEventRequest. + The response contains the event of the system schedulable. + + + + + + + + + + + + + + + + + + + + + + + + Get the list of a system schedules. The list can be filtered by schedule type. + The response is either a SystemScheduleGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemScheduleGetListRequest. + The response contains a list of system schedules. + + + + + + + + + + + + + + + + Modify an event of a system schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a system schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of Server Addresses. + The response is either SystemServerAddressesGetResponse or ErrorResponse. + See also: + PrimaryInfoGetRequest + PublicClusterGetFullyQualifiedDomainNameRequest + + + + + + + + + + + + + Response to SystemServerAddressesGetRequest. + Contains a list of system Server Addresses. + See also: + PrimaryInfoGetResponse + PublicClusterGetFullyQualifiedDomainNameResponse + ServingInfoGetResponse + + + + + + + + + + + + + + + + + + + Request to modify Server Addresses. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Get the Service Activation Access Code system parameters. + The response is either a SystemServiceActivationAccessCodeGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemServiceActivationAccessCodeGetRequest. + Contains Service Activation Access Code system parameters. + + + + + + + + + + + + + + + + + + Request to modify Service Activation Access Code system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request to add a service code for the purpose of providing free format routable strings for dialing + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to delete a service code for the purpose of providing free format routable strings for dialing + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to get all service codes that have been defined in the system. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either SystemServiceCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to SystemServiceCodeGetListRequest. + Contains a table of defined service codes + The column headings are: "Service Code", and "Description". + + + + + + + + + + + + + + + Request to modify service code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of Service Control system parameters. + The response is either SystemServiceControlParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemServiceControlParametersGetListRequest. + Contains a list of system Service Control parameters. + + + + + + + + + + + + + + + + Request to modify Service Control system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get system level Service Pack Migration parameters. + The response is either a SystemServicePackMigrationGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemServicePackMigrationGetRequest. + The response contains the Service Pack Migration system level settings. + + + + + + + + + + + + + + + Modify system level settings for Service Pack Migration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Lookup if the given number is defined in the specified service in the system. + The response is SystemServicePhoneNumberLookupResponse. + + + + + + + + + + + + + + + + true + true + + + Response to the SystemServicePhoneNumberLookupRequest. + The column headings for the userTable are: "Service Provider Id", "Is Enterprise", "Group Id", "User Id", + "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number" and "Extension". + + + + + + + + + + + + + + + true + false + + + Get the session admission control settings for the system. + The response is either a SystemSessionAdmissionControlGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemSessionAdmissionControlGetRequest. + The response contains the session admission control settings for the system. + + + + + + + + + + + + + + + + + true + false + + + Modify the session admission control settings for the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the system level data associated with session audit. + The response is either a SystemSessionAuditGetResponse17sp3 or + an ErrorResponse. + + + + + + + + + + + + + Response to SystemSessionAuditGetRequest17sp3. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with session audit. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Retrieves the Sh Interface system parameters. + The response is either a SystemShInterfaceParametersGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemShInterfaceParametersGetRequest. Contains the Sh Interface system parameters. + + + + + + + + + + + + + + + + Modifies the Sh Interface system parameters. This request must be submitted on both nodes in the redundant Application Server cluster in order for the changes to take effect on each node without requiring a restart. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Dispatches the system refresh task on the local Application Server node. At most one instance of the system refresh task may run on an Application Server node at a given point in time. If the system refresh task is already running when this request is made, an ErrorResponse is returned. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + Retrieves the status of the system refresh task on the local Application Server node. + The response is either a SystemShInterfaceRefreshTaskGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemShInterfaceRefreshTaskGetRequest. Provides the status of the system refresh task. If isRunning is false, numberPublicIdentityRefreshStarted and numberPublicIdentities are omitted. If isRunning is true, numberPublicIdentities indicates the total number of public identities in the system that will be refreshed by the system refresh task; numberPublicIdentityRefreshesStarted indicates the total number of public identities for which a refresh has been started. + + + + + + + + + + + + + + + + + Terminates the system refresh task in progress on the local Application Server node. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + Add an entry to the SIP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Add a content type for the SIP interface. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to clear all sip authentication lockouts (both endpoint and trunk group) in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Request to clear sip authentication endpoint lockouts in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get sip authentication endpoint lockout data in the system. + The response is either a SystemSIPAuthenticationEndpointLockoutGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemSIPAuthenticationEndpointLockoutGetRequest. + The column headings for the lockoutTable are: + "Organization Id", "Organization Type", "Group Id", "Line/Port", "User ID", "First Name", "Last Name", "Lockout Started", "Lockout Expires", "Lockout Count". Lockout times are shown in the system GMT time. When a permanent lockout is shown, the "Lockout Expires" column is empty and the "Lockout Count" column contains the word Permanent. + + + + + + + + + + + + + + + true + false + + + Request to get sip authentication trunk group lockout data in the system. + The response is either a SystemSIPAuthenticationTrunkGroupLockoutGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemSIPAuthenticationTrunkGroupLockoutGetRequest. + The column headings for the lockoutTable are: + "Organization Id", "Organization Type", "Group Id", "Trunk Group Name", "Lockout Started", "Lockout Expires", "Lockout Count". Lockout times are shown in the system GMT time. When a permanent lockout is shown, the "Lockout Expires" column is empty and the "Lockout Count" column contains the word Permanent. + + + + + + + + + + + + + + + true + false + + + Request to clear sip authentication trunk group lockouts in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get the system level SIP authentication password rule settings. + The response is either a SystemSIPAuthenticationPasswordRulesGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSIPAuthenticationPasswordRulesGetRequest. + Contains the SIP authentication password rules for the system. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify the system level SIP authentication password rule settings + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete an entry from the SIP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Delete a content type for the SIP interface. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to apply an extended file capture value to all the profile instances associated to a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + true + + + Request to add a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in HSS data mode: + enhancedForICS, use value "false" in AS data mode + supports3G4GContinuity, use value "false" in AS data mode + publishesOwnPresence, use value "false" in AS data mode + + The following elements are only used in AS data mode: + holdAnnouncementMethod, use value "useInactive" in HSS data mode + supportRFC3398, use value "false" in HSS data mode + supportClientSessionInfo, use value "false" in HSS data mode + supportCallInfoConferenceSubscriptionURI, use value "false" in HSS data mode + supportRemotePartyInfo, use value "false" in HSS data mode + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + The following elements are only used in AS data mode and ignored in + HSS data mode: + supportCauseParameter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to add a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to delete a sip device type. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to get the list of sip device types in the system. + See Also: SystemDeviceTypeGetAvailableListRequest14sp3. + The response is either SystemSIPDeviceTypeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeGetListRequest. + Contains a table of identity/ device profile types configured in the system. + The column headings are: "Device Type", "Profile", "Is Obsolete". + + + + + + + + + + + + + + + true + true + + + Request to get a sip device type. + See Also: SystemDeviceTypeGetRequest + The response is either SystemSIPDeviceTypeGetResponse21 or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to SystemSIPDeviceTypeGetRequest21. + The following elements are only used in AS data mode: + holdAnnouncementMethod + supportRFC3398 + supportClientSessionInfo + supportCallInfoConferenceSubscriptionURI + supportRemotePartyInfo + + The following elements are only used in HSS data mode: + enhancedForICS – value false is returned in AS data mode + enable3G4GContinuity - value false is returned in AS data mode + publishesOwnPresence - value false is returned in AS data mode + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold + + The following elements are only used in AS data mode: + supportCauseParameter – value false is returned in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Request to modify a sip device type. + The response is either SuccessResponse or ErrorResponse. + + The following elements are not changeable: + numberOfPorts + SignalingAddressType + isConferenceDevice + isMusicOnHoldDevice + isMobilityManagerDevice + deviceTypeConfigurationOption + staticLineOrdering + + The following elements are only used in AS data mode: + holdAnnouncementMethod + supportRFC3398 + supportClientSessionInfo + supportCallInfoConferenceSubscriptionURI + supportRemotePartyInfo + + The following element values are only applicable in AS data mode: + holdNormalization=useRfc3264Hold will raise an error in HSS data mode + + The following elements are only used in AS data mode and ignored in + HSS data mode: + supportCauseParameter + + The following elements are only used in HSS data mode and ignored in AS mode: + enhancedForICS + supports3G4GContinuity + publishesOwnPresence + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the SIP access control list. + The response is either SystemSIPGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemSIPGetACLListRequest. The table columns are: + "Net Address", "Transport" and "Description". + + + + + + + + + + + + + + + true + false + + + Get the content type list for the SIP interface. + The response is either SystemSIPGetContentTypeListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSIPGetContentTypeListRequest. + Returns a 2 column table with column headings: + "Content Type" and "Supported Interface". + + + + + + + + + + + + + + + Modify an entry from the SIP access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Modify an content type for the SIP interface. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Add an entry to the SMDI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete an entry from the SMDI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get the SMDI access control list. + The response is either SystemSMDIGetACLListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSMDIGetACLListRequest. The table columns are: + "Net Address" and "Description". + + + + + + + + + + + + + + + true + false + + + Modify an entry from the SMDI access control list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get the list of SMDI system parameters. + The response is either SystemSMDIParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSMDIParametersGetListRequest. + Contains a list of system SMDI parameters. + + + + + + + + + + + + + + + + + true + false + + + Request to modify SMDI system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request the system level data associated with SMPP external interface. + The response is either a SystemSMPPGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemSMPPGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the system level data associated with the SMPP external interface. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the software version of the Application Server. + The response is either SystemSoftwareVersionGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to the SystemSoftwareVersionGetRequest. + + + + + + + + + + + + + + + Requests the list of state and province names. + The response is either SystemStateOrProvinceGetListResponse or ErrorResponse. + + + + + + + + + + + + + Contains a 2 column table with column headings 'Key' and 'Display Name' and a row + for each state or province. + + + + + + + + + + + + + + + Get the system login configuration for all subscribers. + The response is either a SystemSubscriberGetLoginParametersResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemSubscriberGetLoginParametersRequest. + + + + + + + + + + + + + + + + Modify the system login configuration for all subscribers + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Modify the system call processing configuration for all subscribers. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the system call processing configuration for all subscribers + The response is either a SystemSubscriberGetCallProcessingParametersResponse18sp1 + or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemSubscriberGetCallProcessingParametersRequest18sp1. + + + + + + + + + + + + + + + + + + + + + + + Request the data associated with Call Processing Policy for system service instances. + The response is either SystemSystemServiceCallProcessingPoliciesGetResponse or ErrorResponse. + + + + + + + + + + + Response to SystemSystemServiceCallProcessingPoliciesGetRequest. + + + + + + + + + + + + + + + + + + + + + + Request the data associated with Call Processing Policy for system service instances. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Adds system service Dns. It is possible to add either: a single DN, + a list of DNs a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Deletes system service DNs. It is possible to delete either: + a single DN, + a list of DNs, a range of DNs, or any combination thereof. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request a list of system service DNs not yet in use. + The response is either SystemSystemServiceDnGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + true + false + + + Response to SystemSystemServiceDnGetAvailableListRequest. + Contains a list of available DNs not yet assigned to any instance of system service. + + + + + + + + + + + + + + + true + false + + + Request a summary table of all System Service DNs. + The response is either SystemSystemServiceDnGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSystemServiceDnGetSummaryListRequest. + The column headings are "Phone Numbers" and "Assigned". + The possible values for "Assigned" are true, false. + + + + + + + + + + + + + + + true + false + + + Request a list of System Service DN utilization. + The response is either SystemSystemServiceDnGetUsageListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSystemServiceDnGetUsageListRequest. + The table columns are: "Phone Number", "Id", + "Name", and "System Service". + The possible values for "System Service" is "System Voice Portal". + + + + + + + + + + + + + + + true + false + + + Request to add a system voice portal instance. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in IMS mode: + publicUserIdentity, ignored in standalone mode if provided. + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to delete a system voice portal instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get the list of the system voice portals. + The response is either SystemSystemVoicePortalGetListResponce or ErrorResponse. + + + + + + + + + + + true + false + + + Response to SystemSystemVoicePortalGetListRequest. + The column headings are "Default", "System Voice Portal Id", "Name", "Network Voice Portal Number", "System Voice Portal Number" and "Language". + The possible values for "Default" are true, false. + + + + + + + + + + + + + + + Request to get a system voice portal instance. + The response is either SystemSystemVoicePortalGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSystemVoicePortalGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to update a System Voice portal instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the system provisioning configuration for all subscribers. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get the system provisioning configuration for all subscribers + The response is either a SystemSubscriberGetProvisioningParametersResponse + or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemSubscriberGetProvisioningParametersRequest. + + + + + + + + + + + + + + + true + true + + + Requests the configured time zone of the server processing the request and the list of time zone names. + The response is either SystemTimeZoneGetListResponse20 or ErrorResponse. + + + + + + + + + + + + + true + true + + + Response to SystemTimeZoneGetListRequest20. + Contains the configured time zone of the server processing the request and + contains a 2 column table with column headings 'Key' and 'Display Name' and a row + for each time zone. + + + + + + + + + + + + + + + + Request to modify the device language name that is mapped to a BroadWorks language name. The request can be used to map many languages. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of device language names mapped to BroadWorks language names, per-device type. + The response is either SystemSIPDeviceTypeLanguageMappingGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeLanguageMappingGetListRequest. + Contains a table of device type languages mapped to equivalent BroadWorks languages. + The column headings are: "BroadWorks Language", "Device Language". + + + + + + + + + + + + + + + Request to delete a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to modify a sip device type file. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + defaultExtendedFileCaptureMode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of device files managed by the Device Management System, on a per-device type basis. + The response is either SystemSIPDeviceTypeFileGetListResponse14sp8 or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeFileGetListRequest14sp8. + Contains a table of device files managed by the Device Management System on a per-device type basis. + The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL". + + + + + + + + + + + + + + + true + false + + + Request to get a sip device type file. + The response is either SystemSIPDeviceTypeFileGetResponse20 or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to SystemSIPDeviceTypeFileGetRequest20. + Take note: + + 1. accessUrl may have undefined content. + When it is the case, undefined content is put between []. + It may also be set to "Error Access FQDN Not Provisioned" when the access FQDN is not set, + or "Error Access Context Name Not Provisioned" when the context name is not set. + + 2. repositoryUrl may be set to "DEVICE_CONFIGURATION_FILE_REPOSITORY_MISSING", if there is no file repository defined. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to set the level of integration that a device type has in relation to BroadWorks services. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of BroadWorks services that can be integrated to a device type and the level of integration for this device type. + The response is either SystemSIPDeviceTypeServiceGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemSIPDeviceTypeServiceGetRequest. + Contains the list of device type services integrated to BroadWorks. + + + + + + + + + + + + + + + true + false + + + Request to get the list of SIP Diversion Cause values. + The response is either a SystemSIPDiversionReasonGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemSIPDiversionReasonGetRequest. + Contains a table containing a list of diversion reasons and associated cause values. + The column headings are: "Diversion Reaon", "Cause Value". + + + + + + + + + + + + + + + true + false + + + Request to modify the SIP cause value for a given diversion reason. + The response is either a SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to add a video server to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to delete a video server from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get a list of video servers defined in the system. + The response is either a SystemVideoServerGetListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemVideoServerGetListRequest. The Video Server table column + headings are: "Net Address", "Port", "Transport", "Description". + Transport types: udp, tcp, unspecified + + + + + + + + + + + + + + + true + false + + + Request to modify a video server in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of video server system parameters. + The response is either SystemVideoServerParametersGetResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemVideoServerParametersGetRequest. + Contains a list of system video server parameters. + + + + + + + + + + + + + + + + + true + false + + + Request to modify video server system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Add a Zone and optional Net Addresses and Physical Locations. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Delete a Zone. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of all Zones. + The response is either a SystemZoneGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemZoneGetListRequest. + + + + + + + + + + + + + + + Returns a zone calling physical location for a given zone. + Response is SystemZoneCallingZonePhysicalLocationGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemZoneCallingZonePhysicalLocationGetRequest. + + + + + + + + + + + + + + + Modifies a zone calling physical location for a given zone. + Response is a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Adds a list of physical locations to a zone + The response is SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Deletes a list of physical addresses from a zone + The response is SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Gets a list of physical locations assigned to a zone. + Response is SystemZoneLocationBasedPhysicalLocationGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to SystemZoneLocationBasedPhysicalLocationGetListRequest. + + + + + + + + + + + + + + + Adds a list of IP addresses to a zone + The response is SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Deletes a list of IP addresses from a zone + The response is SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Gets a list of IP Addresses and/or Ranges assigned to a zone. + Response is SystemZoneNetAddressGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to SystemZoneNetAddressGetListRequest. + + + + + + + + + + + + + + + + Access code for Service Activation Access Code System Parameters. + + + + + + + + + + + + Polling interval in minutes. + Setting the monitoring interval to zero will turn it off. + + + + + + + + + + + + The application controller name. + + + + + + + + + + + Maximum number of transmissions. + + + + + + + + + + Retransmission timer + + + + + + + + + + + Choices for locally supported Diameter Application Ids. + + + + + + + + + + + + + + The maximum number of concurrent outstanding transactions allowed on a single peer connection. + + + + + + + + + + + + Idle time allowed for a dynamic entry (either Realm Routing Table entry or Peer Table entry) before it is removed. + + + + + + + + + + + + The application Id advertised for billing (Ro or Rf) during the Diameter Capability Exchange. + When base is selected, Acct-Application-Id=3 is advertised for offline billing and Auth-Application-Id=4 for online billing. + When 3gpp is selected, Vendor-Specific-Application-Id(Acct-Application-Id=3; Vendor-Id=10415) is advertised for offline billing and Vendor-Specific-Application-Id(Auth-Application-Id=4; Vendor-Id=10415) for online billing. + + + + + + + + + + + + The diameter peer instance type for an entry in the Peer Table. + + + + + + + + + + + + The priority of a peer against other routing peers associated to the same Realm Routing Table entry. + + + + + + + + + + + + Time after which the Diameter stack reports a timeout to applications and removes the request from its requests queue. + + + + + + + + + + + + Delay afer which the Diameter stack attempts to reconnect to a peer after detecting a connection failure. + + + + + + + + + + + + Timer that controls the frequency of Device-Watchdog messages (when no other messages are exchanged on the peer connection) and is used in the connection failure detection algorithm. + + + + + + + + + + + + The weight used for ordering peers having the same priority. + + + + + + + + + + + + Possible types of Call Blocking Services. + The following enumeration values are only used in AS Data mode: + PTT + SAC + BroadWorks Mobility Deny Originations + BroadWorks Mobility Deny Terminations + Enterprise Trunk Route Exhaust + Call Park + Number Portability + The following types are only used in HSS data mode: + Incoming Communication Barring + Hierarchical Communication Barring + Incoming Hierarchical Communication Barring + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Number of client connections. + + + + + + + + + + + + Connection ping interval in minutes + + + + + + + + + + + + CCC2 to number of client connections. + + + + + + + + + + + The string value for termination cause + + + + + + + + + + + The channel set id. + + + + + + + + + + + + Possible values for Charge Indicator. + + + + + + + + + + + + ChargingFunctionElementServer description. + + + + + + + + + + + + ChargingFunctionElement Server types. + + + + + + + + + + + + Client session (web and CLI) inactivity timeout in minutes. + + + + + + + + + + + + Codec. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Codec name + + + + + + + + + + + + Communication Barring Criteria description + + + + + + + + + + + + Communication Barring Originating Rule + + + + + + + + + + + + + + + Communication Barring Redirecting Rule + + + + + + + + + + + + + Communication Barring Call Me Now Rule + + + + + + + + + + + + + Audio/Video File Directory location. + + + + + + + + + + + + Configurable Treatment Description. + + + + + + + + + + + + Country code off hook warning timer seconds. + + + + + + + + + + + + The maximum number of call waiting tones per call. + + + + + + + + + + + + Country code ring period milliseconds. + + + + + + + + + + + + The amount of quiet time between call waiting tones. + + + + + + + + + + + + Contains one automatic rebuild configuration list entry. + + + + + + + + + + + + The value in milliseconds specifying how often the Media Cr Keep-ALIVE request is sent. + + + + + + + + + + + + OCI request prefix. + + + + + + + + + + + + Size of the device management event queue. + + + + + + + + + + + + Number of times device management file operations(create folder, get, put, and delete) are retried. + + + + + + + + + + + + Minimum time gap between two consecutive reset sent in milliseconds. + + + + + + + + + + + + The value in milliseconds specifying how long to wait for Media Cr Keep-ALIVE response. + + + + + + + + + + + + The value in milliseconds specifying how long to wait for the SIP INVITE to + the Media Server, that sets up the Cr control channel connection to + respond. + + + + + + + + + + + + Choices for the mode of a Diameter Peer. + + + + + + + + + + + + Choices for the action of a Diameter Route. + + + + + + + + + + + + Choices for locally supported Diameter Application Ids. + + + + + + + + + + + + + The DTMF transmission method. + + + + + + + + + + + + The signaling content type. + + + + + + + + + + + + + Early Media Support types. This is typically used to configure the ringback tone delivery mode. + When there is no early media, the call originator typically supplies ringback tone locally. + RTP - Early Session refers to RFC 3959. + + + + + + + + + + + + + Duration of emergency call before BroadWorks sends an SNMP notification. + + + + + + + + + + + + Duration of emergency call before BroadWorks releases all internal resources. + + + + + + + + + + + + Additional grace period after the expensive call notification announcement before call setup continues. + + + + + + + + + + + + Connection Timer seconds. + + + + + + + + + + + + The Route Point External System's description. + + + + + + + + + + + + File repository protocol. + + + + + + + + + + + + Attributes of the FTP protocol when the file repository interface is using FTP. + + + + + + + + + + + + + Attributes of the WebDav protocol when the file repository interface is using WebDav. + + + + + + + + + + + + Attributes of the WebDav protocol when the file repository interface is using WebDav. + + + + + + + + + + + + + The max number of users in a group that will consume a group license. + This number has to be greater than 0. For example, if the number is 300, + then the first 300 users in a group will consume one group license and + the #301 user will consume the second group license. + + + + + + + + + + + Choices for SIP Hold Announcement Method option + + + + + + + + + + + + Possible values for the protocol-neutral internal release cause. + + + + + + + + + + + + + + + + + + + + + + Something that has been licensed. + + + + + + + + + + + License type. + + + + + + + + + + + + Identifies the location zone criteria to be matched. + + + + + + + + + + + + + + + Bandwidth for a Media. + + + + + + + + + + + + Types of bandwidth enforcement. + + + + + + + + + + + + + Media name + + + + + + + + + + + + Media server description. + + + + + + + + + + + + Media Server timer length. + + + + + + + + + + + + Media Server selection route timer length. + + + + + + + + + + + + Audio or video treatment file name. + + + + + + + + + + + + Media type + + + + + + + + + + + + This is a net address or can contain a string that includes additional items + such as protocols and transports. + + + + + + + + + + + + The description for the entry in the network access control list. + + + + + + + + + + + + Network Device polling interval in minutes. + + + + + + + + + + + + Network Device failed polling interval in minutes. + + + + + + + + + + + + Network progression wait period in seconds. + + + + + + + + + + + + Network Server Alternate Call Indicator. + + + + + + + + + + + + Network Server Call Type. + + + + + + + + + + + + Network Server description. + + + + + + + + + + + + Possible string value for Network Server Treatment. + + + + + + + + + + + + Network Server types. + + + + + + + + + + + + + Network Translation Index for selecting Enterprise and Public dial plans. + + + + + + + + + + + + The timeout value for OCI Call Application notifications. + + + + + + + + + + + + The description for the entry in the OCI call control application list. + + + + + + + + + + + + OCI Request name. + + + + + + + + + + + + Office Zone description. + + + + + + + + + + + + Performance Measurement Reporting Interval Minutes. + + + + + + + + + + + + The timeout value in seconds for provisioning validation. + + + + + + + + + + + + The possible range values for Q850 Cause Value. + + + + + + + + + + + + A text parameter appended to the Reason header to explain the Q850 cause value + + + + + + + + + + + + Radius Server description. + + + + + + + + + + + + Redundancy rollback timer in minutes. + + + + + + + + + + + + A list of Communication Barring CallMeNow Rules that replaces a + previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + + A list of Communication Barring Originating Rules that replaces a + previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + + A list of Communication Barring Redirecting Rules that replaces a + previously configured list. By convention, an element of this type + may be set nill to clear the list. + + + + + + + + + + + A list of media that replaces a previously configured list. + + + + + + + + + + + Contains an ordered list of zones to use to replace the current list of zones in an Office Zone. + + + + + + + + + + + Identifies the roaming criteria to be matched. + + + + + + + + + + + + + Route device description. + + + + + + + + + + + + Route name. + + + + + + + + + + + + Route timer seconds. + + + + + + + + + + + + Digit pattern used to route a call -- a 3 to 6 digit number. + If the digit pattern does not include a wildcard, it must be 6 digits. + + + + + + + + + + + + Policy for choosing an address from the results of a DNS lookup. + + + + + + + + + + + + + Routing max addresses. + + + + + + + + + + + + Routing stateful expiration minutes. + + + + + + + + + + + + Uniquely identifies the server computer hardware. + + + + + + + + + + + Maximum allowed number of service control client connections. + + + + + + + + + + + + Session Audit interval seconds. + + + + + + + + + + + + Session Audit timeout period seconds. + + + + + + + + + + + + Choices for Preferred Session Timer Refresher. + + + + + + + + + + + + The rate at which a system refresh dispatches constituent Public Identity refresh procedures. + + + + + + + + + + + + The amount of time to wait for a response to an Sh Interface request. + + + + + + + + + + + + The amount of time to wait after a Public Identity has been added before dispatching the Public Identity refresh procedure. A value of 0 indicates no delay. + + + + + + + + + + + + SIP ACL Network Transport Protocol. + + + + + + + + + + + + + The possible range values for SIP failure status codes. + + + + + + + + + + + + Corresponds to the SIP Max-SE header. + + + + + + + + + + + + Corresponds to the SIP Min-SE header. + + + + + + + + + + + + Corresponds to the SIP Session-Expires header. + + + + + + + + + + + + A text parameter appended to the SIP status line. + + + + + + + + + + + + Maximum Number of SMDI connections. + + + + + + + + + + + + SMPP Password. + + + + + + + + + + + + SMPP System Id. + + + + + + + + + + + + + + + + + + + + The SMPP Protocol Version. + + + + + + + + + + + + + SMTP from address. + + + + + + + + + + + + SMTP subject. + + + + + + + + + + + + System Call Type + + + + + + + + + + + + System License type. + + + + + + + + + + + + + + + + + + + + + + + + + + Maximum Login Attempts. + + + + + + + + + + + + Minimum Login Id Length. + + + + + + + + + + + + User types for which the System Password Rules apply. + The rules could apply to the + (1) System, Provisioning Administrator + (2) System, Provisioning, Service Provider Administrator + (3) Administrator (System, Provisioning, Service Provider, Group and Department) and Users. + + + + + + + + + + + + + SIP content type. + + + + + + + + + + + + Network Server types. + + + + + + + + + + + + + Trunk Group licensed call capacity. + + + + + + + + + Trunk Mode Options + + + + + + + + + + + + + Unscreened Presentation Identity Policy Options + + + + + + + + + + + + + WebDAV login password. + + + + + + + + + + + + WebDAV login user name. + + + + + + + + + + + + true + false + + + Schedule Combination. + + + + + + + + + + + + true + false + + + Request the system level data associated with Selective Services. + The response is either a SystemSelectiveServicesGetResponse18sp1 or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemSelectiveServicesGetRequest18sp1. + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with SystemSelectiveServicesRequest. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Session Admission Control handling for Music On Hold types. + + + + + + + + + + + + Name for Calling Line Id Display. + + + + + + + + + + + + Maximum Call Time for Answered Calls + + + + + + + + + + + + Maximum Number of Concurrent Redirected Calls + + + + + + + + + + + + Maximum Number of Simultaneous Calls + + + + + + + + + + + + Display name. + + + + + + + + + + + + Peer SIP Connection Monitoring heartbeat interval in milliseconds + + + + + + + + + + + + Peer SIP Connection Monitoring heartbeat timeout in milliseconds + + + + + + + + + + + + The maximum number of simultaneously running migration tasks. + + + + + + + + + + + + Sip Diversion Reasons. + + + + + + + + + + + + + + + + + + + + + + + + + + + + 3 digit SIP Cause values. + + + + + + + + + + + Video Server description. + + + + + + + + + + + + Video Server timer length. + + + + + + + + + + + + Video Server selection route timer length. + + + + + + + + + diff --git a/share/OCISchemaAS/OCISchemaUser.xsd b/share/OCISchemaAS/OCISchemaUser.xsd new file mode 100644 index 0000000..b3a0261 --- /dev/null +++ b/share/OCISchemaAS/OCISchemaUser.xsd @@ -0,0 +1,3043 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of Device Management user modifiable files. + The response is either UserAccessDeviceFileGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to UserAccessDeviceFileGetListRequest. + Contains a table of user modifiable Device Management files. + The column headings are: "File Format", "Template URL". + + + + + + + + + + + + + + + Request to get a user modifiable file. + The response is either UserAccessDeviceFileGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to UserAccessDeviceFileGetRequest. + + + + + + + + + + + + + + + Request to modify a user modifiable access device file. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Reset a specific user SIP device that supports the reset operation. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get all the device tag names and values for a specific device. The resolved tags are returned only if the device is the main device for this user. + The response is either a UserAccessDeviceTagsGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserAccessDeviceTagsGetRequest. + The response contains a table with columns: "Tag Name", and "Tag Value". + + + + + + + + + + + + + + + Request to add a user. + The domain is required in the userId. + The password is not required if external authentication is enabled. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add an announcement to the user announcement repository + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete one or more announcements from the user announcement repository + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the list of announcement names with associated media type and filesize for a User and + given Announcement Repository Type + The response is either a UserAnnouncementFileGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to UserAnnouncementFileGetListRequest. + When requested, the response contains a table with columns: "Name", "Media Type", "File Size". + The "Name" column contains the name of the announcement file. + The "Media Type" column contains the media type of the announcement file with the possible values: + WMA - Windows Media Audio file + WAV - A WAV file + 3GP - A 3GP file + MOV - A MOV file using a H.263 or H.264 codec. + The "File Size" column contains the file size in kB of the announcement file. + The response also contains the current total file size (KB) for the user across + all media types and the maximum total file size (MB) allowed for the user. + + + + + + + + + + + + + + + + + Get the list of available announcement files for a User from the Announcement Repository, + for Virtual subscribers the list will also include the announcements for it's group. + + + + + + + + + + + + + + + + Response to UserAnnouncementFileGetAvailableListRequest. + The response contains a table with columns: "Name", "Media Type", "File Size" and "Repository Type". + The "Name" column contains the name of the announcement file. + The "Media Type" column contains the media type of the announcement file with the possible values: + WMA - Windows Media Audio file + WAV - A WAV file + 3GP - A 3GP file + MOV - A MOV file using a H.263 or H.264 codec. + The "File Size" is in Kilobytes. + The "Repository Type" column contains the type of repository for the announcement file such as "User" or "Group" + The "File Size" column contains the file size in kB of the announcement file. + + + + + + + + + + + + + + + Request to get the announcement repository file information. + The response is either UserAnnouncementFileGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to UserAnnouncementFileGetRequest. + The response contains the file size (KB), uploaded timestamp, description and usage for + an announcement file in the user announcement repository. + The usage table has columns "Service Name", "Criteria Name" + The "Service Name"" values correspond to string values of the UserService data types. + With the exception of the string "Voice Portal" which is returned when the announcement is being used by Voice Portal Personalized Name. + For Call Center and Route Point users the "Instance Name" column contains the instance id and + when the announcement is being used by a DNIS, "Intance Name" column contans the instance id and the DNIS id. + For Auto Attendants with submenus and the announcement is used by a submenu the "Instance Name" column will contain the submenu name + + + + + + + + + + + + + + + + + + This command is used to change the name of the file or upload a new announcement file for + an existing announcement in the user repository. + When modifying the file type the command will fail if the media type of the new file changes + the announcement from audio to video (or vice versa). + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get the list of assigned User and Group Services for the specified user. + The response is either an UserAssignedServicesGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserAssignedServicesGetListRequest. + A user can have both user services and group services because of music on hold. + + + + + + + + + + + + + + + + Request to delete a user. The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of DNs associated with a user and their activation state. + The response is either UserDnGetActivationListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to UserDnGetActivationListRequest. + The response contains a table with columns: "Phone Number", and "Activated". + The "Phone Number" column contains a single DN. + The "Activated" column indicates if the phone number is activated or not. + + + + + + + + + + + + + + + Request to get the user information. The response is either + UserGetResponse21 or ErrorResponse. + + + + + + + + + + + + + + + Response to UserGetRequest21. + It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. + The following data elements are only used in AS data mode: + contact[2]-contact[5] + The following data elements are only used in IMS data mode: + alternateTrunkIdentityDomain + + The country code (countryCode) included is the user's phone number country code when the user has a phone number assigned, or the + user's Group associated country code when the user does not have a phone number assigned, or the system default country code when the + user's Group does not have an associated country code. + + The nationalPrefix in this response is the one associated to the included countryCode. + + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get a list of registrations for a user. + The response is either a UserGetRegistrationListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserGetRegistrationListRequest. + The registrationTable table column headings are: + "Device Level", "Device Name", "Order", "URI", "Expiration", "Line/Port", "Endpoint Type"", "Public Net Address", "Public Port", "Private Net Address", "Private Port", "User Agent", "Lockout Started", "Lockout Expires", "Lockout Count". + The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. + The "Line/Port" column in IMS mode can be any Public User Identity which can be either a + SIPURI or a TELURI. + The expiration column will be empty when the registration is static. + The Endpoint Type column contains one of the enumerated EndpointType values. + The Endpoint Type is empty when the registration is against a TELURI. + The table is sorted by: telURI (after SIPURI), Line/Port, static (after dynamic), order. + Lockout times are shown in GMT offset. When a permanent lockout is shown, the "Lockout Expires" column is empty and the "Lockout Count" column contains the word Permanent. + + + + + + + + + + + + + + + Request to modify a user. + When oldPassword is specified, all password rule applies. If oldPassword in not specified, + any password rule related to old password does not apply. + The request will fail if officeZoneName or primaryZoneName is present but the Location-Based Calling Restrictions service is not assigned to the user. + The response is either SuccessResponse or ErrorResponse. + The following data elements are only used in AS data mode: + contact[2]-contact[5] + The impId and impPassword are accepted when the Third-Party IMP service is assigned to the user; + when Integrated IMP service is assigned to the user and active, only the impPassword is accepted; + all other cases, the request fails if either field is changed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clear a user's call logs associated with Basic Call Logs and Enhanced + Call Logs features. The calls logs are deleted from both Basic Call Logs + and Enhanced Call Logs if both features are assigned. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Policies. + The response is either a UserCallPoliciesGetResponse19sp1 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallPoliciesGetRequest19sp1. + + + + + + + + + + + + + + + + + Modify the user level data associated with Call Policies. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Processing Policy. + The response is either a UserCallProcessingGetPolicyResponse19sp1 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallProcessingGetPolicyRequest19sp1. + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + The following elements are only used in AS data mode: + useUserDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + allowDepartmentCLIDNameOverride + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the user level data associated with Call Procesing Policy. + The response is either a SuccessResponse or an ErrorResponse. + + The useUserCLIDSetting attribute controls the CLID settings + (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride) + + The useUserMediaSetting attribute controls the Media settings + (medisPolicySelection, supportedMediaSetName) + + The useUserCallLimitsSetting attribute controls the Call Limits setting + (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) + + The useUserDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) + + The following elements are only used in AS data mode: + useUserDCLIDSetting + enableDialableCallerID + allowConfigurableCLIDForRedirectingIdentity + allowDepartmentCLIDNameOverride + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Gets the Communication Barring settings for a user. + The response is either a UserCommunicationBarringGetResponse or an ErrorResponse. + This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider. + + + + + + + + + + + + + + + Response to UserCommunicationBarringGetRequest. + This command only applies to users in an Enterprise. + + + + + + + + + + + + + + + + Modify the Communication Barring settings for a user. If useDefaultServiceProviderProfile is set to false, a profile name must be present. + The response is either a SuccessResponse or an ErrorResponse. + This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider. + + + + + + + + + + + + + + + + + Add a list of Communication Barring Authorization codes to a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a list of Communication Barring Authorization codes from a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a list of Communication Barring Authorization Code for a user. + The response is either a UserCommunicationBarringAuthorizationCodeGetListResponse + or an ErorResponse. + + + + + + + + + + + + + + + Response to UserCommunicationBarringAuthorizationCodeGetListRequest. + Contains a list of Communication Barring Authorization Codes + assigned to the user. + + + + + + + + + + + + + + + true + false + + + Request the user level data associated with Device Policy. + The response is either a UserDevicePoliciesGetResponse21 or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserDevicePoliciesGetRequest21. enableDeviceFeatureSynchronization is ignored by the application server in Multiple User Shared mode. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the user level data associated with Device Policy. enableDeviceFeatureSynchronization can be configured regardless of lineMode, but is ignored by the application server in Multiple User Shared mode. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get an enterprise's common phone list for a user. + The response is either a UserEnterpriseCommonPhoneListGetPagedSortedListResponse + or an ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one + criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the + results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results + in an ErrorResponse. + The sort can be done on the name or the number in the common phone list. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserEnterpriseCommonPhoneListGetPagedSortedListRequest. The response + contains the enterprise's common phone list. The response contains a + table with column headings: "Name" and "Phone Number". + + + + + + + + + + + + + + + + Get the list of feature access codes for a user. + The response is either a UserFeatureAccessCodeGetListResponse20 or an ErrorResponse. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording Start". + + + + + + + + + + + + + + + Response to the UserFeatureAccessCodeGetListRequest21. + + In release 20 the "Call Recording" FAC name is changed to + "Call Recording Start". + + + + + + + + + + + + + + + Enable or disable a list of feature access codes for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the list of users in a group. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a UserGetListInGroupResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to UserGetListInGroupRequest. + Contains a table with column headings : "User Id", + "Last Name", "First Name", "Department", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension" + in a row for each user. + + + + + + + + + + + + + + + Request the list of users in a service provider or enterprise. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a UserGetListInServiceProviderResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to UserGetListInServiceProviderRequest. + Contains a table with column headings : "User Id", "Group Id", + "Last Name", "First Name", "Department", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension" + in a row for each user. + + + + + + + + + + + + + + + Request the list of users in the system. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a UserGetListInSystemResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to UserGetListInSystemRequest. + Contains a table with column headings : "User Id", "Group Id", "Service Provider Id" + "Last Name", "First Name", "Department", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension" + in a row for each user. + + + + + + + + + + + + + + + true + false + + + Request the list of Service Instances in a service provider or an enterprise. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. searchCriteriaExactUserDepartment criteria is only applicable for an enterprise and is ignored if set for a service provider. + The response is either a UserGetServiceInstanceListInServiceProviderResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserGetServiceInstanceListInServiceProviderRequest. + Contains a table with column headings : "User Id", "Group Id", "Service Type", + "Name", "Phone Number", "Extension", "Department" in a row for each Service Instance. Possible values for Service Type column are ServiceType enums. + + + + + + + + + + + + + + + true + false + + + Request the list of Service Instances in the system. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a UserGetServiceInstanceListInSystemResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserGetServiceInstanceListInSystemRequest. + Contains a table with column headings : "User Id", "Group Id", "Serive Provider Id", "Service Type", "Name", "Phone Number", + "Extension" in a row for each Service Instance. Possible values for Service Type column are ServiceType enums. + + + + + + + + + + + + + + + true + false + + + Get a user's group's common phone list. + The response is either a UserGroupCommonPhoneListGetPagedSortedListResponse or an + ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one + criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the + results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results + in an ErrorResponse. + The sort can be done on the name or the number in the common phone list. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserGroupCommonPhoneListGetPagedSortedListRequest. + The response contains the group's common phone list. The response + contains a table with column headings: "Name" and "Phone Number". + + + + + + + + + + + + + + + + true + false + + + Gets a Custom Contact Directory in a group. + The response is either UserGroupCustomContactDirectoryGetPagedSortedListResponse + or ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one + criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the + results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results + in an ErrorResponse. + The sort can be done on the user last name, first name, or department. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserGroupCustomContactDirectoryGetPagedSortedListRequest. + + Returns the number of entries that would be returned if the response + Was not page size restricted. + + The response contains all the contacts in the group's given custom + contact directory. Contains a table with column headings: "User Id", + "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Virtual On-Net Phone Number", "Group Id", + "Is Virtual On-Net User", "Department", "Phone Number", "Extension", + "Mobile", "Email Address", "Yahoo Id", "Title", "IMP Id". + If the entry represents a Virtual On-Net user then "User Id" is blank, + the "Virtual On-Net Phone Number" contains the phone Number of the + Virtual On-Net user, the "Group Id" contains the Virtual On-Net + user's + group and the "Is Virtual On-Net User" contains true. + If the entry represents a BroadWorks user then the "User Id" contains + his BroadWorks userId, the "Virtual On-Net Phone Number" and + "Group Id" fields are field is blank and the "Is Virtual On-Net User" + contains false. + + + + + + + + + + + + + + + + Request to get all user's configured line ports. + + + + + + + + + + + + + + + Response to UserLinePortGetListRequest. + Contains a table of line ports configured for a user + The column headings are: "Line Port", "Line Port Type", "In Trunk Group", + "Contact", "Contact2", "Contact3", "Contact4", "Contact5", " Authentication Mode ", + and "Auto-Config Soft Client". + + + + + + + + + + + + + + + Modify the user id of a real or virtual user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the Network-Based Conferencing data for a specified user. + The response is either a UserNetworkConferencingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserNetworkConferencingGetRequest. + + + + + + + + + + + + + + + + Get the OCI call control application list that can be used by the user. + The response is either UserOCICallControlApplicationGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to UserOCICallControlApplicationGetListRequest. + + + + + + + + + + + + + + + Modify which OCI Call Control Applications are enabled on a user + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request the user's Web password information. + The response is either a UserPasswordInfoGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserPasswordInfoGetRequest. + + + + + + + + + + + + + + + + + + + true + false + + + Get a user's personal phone list. + The response is either a UserPersonalPhoneListGetPagedSortedListResponse or an + ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one + criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the + results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results + in an ErrorResponse. + The sort can done by the personal phone list number or name. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserPersonalPhoneListGetPagedSortedListRequest. + The response contains a user's personal phone list. The response + contains a table with column headings: "Name" and "Phone Number". + + + + + + + + + + + + + + + + Add one or more entries to a user's personal phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete one or more entries from a user's personal phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a user's personal phone list. + The response is either a UserPersonalPhoneListGetListResponse or an ErrorResponse. + The search can be done using multiple criterion. + If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. + Otherwise, only results matching all the search criterion are included in the results. + If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. + In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an + ErrorResponse is returned. + + + + + + + + + + + + + + + + + + + Response to the UserPersonalPhoneListGetListRequest. + The response contains a user's personal phone list. + + + + + + + + + + + + + + + Modify an entry in a user's personal phone list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request a table containing the phone directory for a user. + Setting isEnterpriseRequested to true will return enterprise directory + members in the response if the user is in an enterprise. Otherwise, + just the group directory members for a user are returned in the + response. The response is either + UserPhoneDirectoryGetPagedSortedListResponse or ErrorResponse. + The search can be done using multiple criterias. If the + searchCriteriaModeOr is present, any result matching any one + criteria is included in the results. Otherwise, only results matching all + the search criterias are included in the results. If no search criteria is + specified, all results are returned. Specifying searchCriteriaModeOr + without any search criteria results in an ErrorResponse. The sort can be + performed on user last name, first name, or department. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserPhoneDirectoryGetPagedSortedListRequest. + Returns the number of entries that would be returned if the response + Was not page size restricted. + The "My Room Room Id" and "My Room Bridge Id" are only populated for + users assigned the "Collaborate-Audio" service. + Contains a table with a row for each user and column headings: + "User Id", "CLID First Name", "CLID Last Name", "First Name", + "Last Name", "Hiragana First Name", "Hiragana Last Name", + "Title", "Phone Number", "Extension", "Mobile", "Pager", + "Email Address", "Yahoo Id", "Department", "Group Id", "Location", + "Address Line 1", "Address Line 2", "City", "State", "Zip", + "Country", "IMP Id", "Location Code", "My Room Room Id", + "My Room Bridge Id". + + + + + + + + + + + + + + + + true + true + + + Request a table containing the phone directory for a user's group. + If the user's group is part of an enterprise, the directory includes all users in the enterprise + and all entries in the enterprise common phone list and the common phone list of the specified + group (if includeCommonPhoneList is set to true). + If the user's group is part of a service provider, the directory includes all users in the group + and all entries in the common phone list (if includeCommonPhoneList is set to true) of the + specified group. + The response is either UserPhoneDirectoryGetListResponse or ErrorResponse. + If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only + results matching all the search criterias are included in the results. + If no search criteria is specified, all results are returned. + In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an + ErrorResponse is returned. + Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Response to UserPhoneDirectoryGetListRequest. + The "My Room Room Id" and "My Room Bridge Id" are only populated for users assigned the "Collaborate-Audio" service. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", "Department", "First Name", "Last Name", + "User Id", "Title", "IMP Id", "My Room Room Id", "My Room Bridge Id". + + + + + + + + + + + + + + + true + true + + + Request a table containing the phone directory for a user. + Setting isEnterpriseRequested to true will return enterprise directory + members in the response if the user is in an enterprise. Otherwise, + just the group directory members for a user are returned in the response. + The response is either UserPhoneDirectoryGetPagedListResponse or + ErrorResponse. + The search can be done using multiple criterias. + If the searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterias are included in the results. + If no search criteria is specified, all results are returned. + In all cases, if a responseSizeLimit is specified and the number of matching results is more than + this limit, then an ErrorResponse is returned. + Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. + The boolean sortByFirstName is optional. If it is not specified, the response is + sorted by Last Name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Response to UserPhoneDirectoryGetPagedListRequest21. + Returns the number of entries that would be returned if the response + Was not page size restricted. + The "My Room Room Id" and "My Room Bridge Id" are only populated for + users assigned the "Collaborate-Audio" service. + Contains a table with a row for each user and column headings: + "User Id", "First Name", "Last Name", "First Name Unicode", + "Last Name Unicode", "Hiragana First Name", "Hiragana Last Name", + "Title", "Phone Number", "Extension", "Mobile", "Pager", + "Email Address", "Yahoo Id", "Department", "Group Id", "Location", + "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country", + "IMP Id", "Location Code", "My Room Room Id", "My Room Bridge Id". + The response entries are sorted by "Last Name Unicode" first and + "First Name unicode" secondarily. + + + + + + + + + + + + + + + + true + false + + + Request a table containing the phone directory for a user. + If the specified user is part of an enterprise, the directory includes all users in the enterprise + and all entries in the enterprise common phone list and the common phone list of the specified user's group. + If the specified user is part of a service provider, the directory includes all users in the user's group + and all entries in the common phone list of the specified user's group. + It is possible to search the directory for names containing a specified search string. The search includes + matches on first name or last name or common phone list names. + The response is either UserPhoneDirectoryGetSearchedListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserPhoneDirectoryGetSearchedListRequest. + The "My Room Room Id" and "My Room Bridge Id" are only populated for + users assigned the "Collaborate-Audio" service. + Contains a table with a row for each phone number and column headings : + "Name", "Number", "Extension", "Mobile", "Email Address", "Department", + "Hiragana Name", "Group Id", "Yahoo Id", "User Id", "IMP Id", "First Name", "Last Name", + "My Room Room Id", "My Room Bridge Id". + + + + + + + + + + + + + + + Request the user's portal passcode information. + The response is either a UserPortalPasscodeGetInfoResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserPortalPasscodeGetInfoRequest. + + + + + + + + + + + + + + + + + + + + Modify the user's Portal passcode + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the Users Primary Endpoint setting. + The response is either a UserPrimaryEndpointAdvancedSettingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserPrimaryEndpointAdvancedSettingGetRequest. + + + + + + + + + + + + + + + + Modify the Users Primary Endpoint line control settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Add an event to user schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a user schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a list of events from a user schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a list of user schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the list of events of a user schedule. + The response is either a UserScheduleGetEventListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserScheduleGetEventListRequest. + The response contains a list of events. + + + + + + + + + + + + + + + Get an event from a user schedule. + The response is either a UserScheduleGetEventResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to UserScheduleGetEventRequest. + The response contains the event of the user schedule. + + + + + + + + + + + + + + + + + + + + + + + + Get the list of schedules viewable by a User. The list can be filtered by schedule type. + The response is either a UserScheduleGetListResponse17sp1 or an ErrorResponse. + This command is authorized to user who is Executive-Assistant of the Executive. + + + + + + + + + + + + + + + + Response to UserScheduleGetListRequest17sp1. + The response contains a list of schedules viewable by the user. It contains the schedules + defined for the user and the group the user belongs to. If the user belongs to an enterprise, + the list also contains the schedules defined for the enterprise. + + + + + + + + + + + + + + + Modify an event of a user schedule. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. + The endDate element is set to the sum of the adjusted starDate element value and the event duration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a user schedule. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to assign the user services and service packs for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Requests the user's service and service pack assignment list with status. + The response is either UserServiceGetAssignmentListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to UserServiceGetAssignmentListRequest. + Contains two tables, one for the service packs, and one for the user services. + The user table has the column headings: "Service Name", "Assigned", + The service pack table's column headings are: "Service Pack Name", "Assigned", "Description". + The "Assigned" column has either a true or false value + + + + + + + + + + + + + + + + Request to determine if a UserService or service pack is assigned to the user. + + + + + + + + + + + + + + + + + + + Returns true if the UserService or service pack is assigned, otherwise false. + + + + + + + + + + + + + + + Requests to unassign the user services and service packs for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI + or TEL URI). + The response is either a UserShInterfaceGetPublicIdDataResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserShInterfaceGetPublicIdDataRequest. + The response contains the Sh non-transparent data for the specified Public User Identity. + The data also includes a userId, userType, and endpointType. + + + + + + + + + + + + + + + + + + + Returns the Sh non-transparent data stored against a userId. + The response is either a UserShInterfaceGetUserIdDataResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserShInterfaceGetUserIdDataRequest. + The response contains the Sh non-transparent data for the specified userId. + The data also includes a userType, publicUserIdentity and endpointType. + + + + + + + + + + + + + + + Modifies the Sh Interface non-transparent data associated with a Public User Identity. + The response is a SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Dispatches a Public Identity refresh task on the local Application Server node for the specified public identity. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Access device end point that can have multiple contacts. + The endpoint is identified by its linePort (public Identity) and possibly a private Identity. + Port numbers are only used by devices with static line ordering. + The following elements are only used in HSS data mode and not returned in AS data mode: + privateIdentity + The following elements are only used in AS data mode and a value false is returned in the HSS mode: + supportVisualDeviceManagement + + + + + + + + + + + + + + + + + + Call type choices for sending call being forward response on Redirected Calls + + + + + + + + + + + + Phone Directory Name Search String. + + + + + + + + + + A list of applicationIds that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + ShInterface User Id Data Entry. + + + + + + + + + + + + + + + Trunk group endpoint that can have multiple contacts. + alternateTrunkIdentityDomain is only used in IMS mode. + Both alternateTrunkIdentity and AlternateTrunkIdentityDomain should be set at the same time if one is set in IMS mode. + + + + + + + + + + + + + + Trunk group endpoint that can have multiple contacts. + alternateTrunkIdentityDomainName is only used in IMS mode. + Setting alternateTrunkIdentity or alternateTrunkIdentityDomain to nil in IMS mode, the other one paremter should be set to nil at the same time. + + + + + + + + + + + + + + Trunk group endpoint that can have multiple contacts. + alternateTrunkIdentityDomain is only used in IMS mode. + The following elements are only used in AS data mode and ignored in HSS data mode: + alternateTrunkIdentityDomain + + + + + + + + + + + + + + Trunk group device endpoint used in the context of modify that can have multiple contacts. + + + + + + + + + + + + + Trunk group device endpoint used in the context of modify that can have multiple contacts. + + + + + + + + + + + + + Trunk group device endpoint that can have multiple contacts. + + + + + + + + + + + + + + + + Request the list of schedules viewable by a User. The list can be filtered by schedule type. + The response is either a UserScheduleGetEventListForGroupResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserScheduleGetEventRequest. + The response contains collection of event details of a requested schedule. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaService3G4GContinuity.xsd b/share/OCISchemaAS/Services/OCISchemaService3G4GContinuity.xsd new file mode 100644 index 0000000..1d61f43 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaService3G4GContinuity.xsd @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAccountAuthorizationCodes.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAccountAuthorizationCodes.xsd new file mode 100644 index 0000000..b210589 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAccountAuthorizationCodes.xsd @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a list of account/authorization codes to a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a list of account/authorization codes from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of non restricted users for the account/authorization codes service. + The response is either GroupAccountAuthorizationCodesGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupAccountAuthorizationCodesGetAvailableUserListRequest. + The column headings are: "User Id", "Last Name", "First Name", "Hiragana Last Name" and + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request the list of account/authorization codes for a group. + The response is either a GroupAccountAuthorizationCodesGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupAccountAuthorizationCodesGetListRequest. + + + + + + + + + + + + + + + Request the group's account/authorization codes setting. + The response is either a GroupAccountAuthorizationCodesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupAccountAuthorizationCodesGetRequest. + The tables has the following column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + + + + Change the group's account/authorization codes setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Account/Authorization Code. + + + + + + + + + + + + Account/Authorization Code Description. + + + + + + + + + + + + Account/Authorization Code. + + + + + + + + + + + + Account/Authorization Code Type. + + + + + + + + + + + + + Number of Account/Authorization Code Digits. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAdviceOfCharge.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAdviceOfCharge.xsd new file mode 100644 index 0000000..2aab707 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAdviceOfCharge.xsd @@ -0,0 +1,452 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of Advice of Charge system parameters. + The response is either SystemAdviceOfChargeGetResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemAdviceOfChargeGetRequest. + Contains a list of system Advice of Charge parameters. + + + + + + + + + + + + + + + + + + true + false + + + Request to modify Advice of Charge system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Add a cost information source. The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete a cost information source. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get a list of cost information sources. + The response is either SystemAdviceOfChargeCostInformationSourceGetListResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemAdviceOfChargeCostInformationSourceGetListRequest. + Contains a table with column headings: "PeerIdentity", "Priority" + + + + + + + + + + + + + + + true + false + + + Modify a cost information source. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request the user level data associated with Advice Of Charge. + The response is either a UserAdviceOfChargeGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get the list of Advice of Charge service provider parameters. + The response is either ServiceProviderAdviceOfChargeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderAdviceOfChargeGetRequest. + Contains a list of Advice of Charge service provider parameters. + + + + + + + + + + + + + + + + true + false + + + Modify the service provider level Advice Of Charge service provider settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of Advice of Charge group parameters. + The response is either GroupAdviceOfChargeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupAdviceOfChargeGetRequest. + Contains a list of Advice of Charge group parameters. + + + + + + + + + + + + + + + + true + false + + + Modify the service provider level Advice Of Charge group settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to UserAdviceOfChargeGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Advice of Charge. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + The time in seconds used for the interval for sending AoC-D information to the caller. + + + + + + + + + + + + Choices for method of how the Advice of Charge is processed by the Application Server. + + + + + + + + + + + + Choices for Advice of Charge Type. + + + + + + + + + + + + Choices for type of OCS enquiry that Advice Of Charge Services sends to OCS. + + + + + + + + + + + + The priority of the OCS in configurations with multiple cost informations. + The lower the value the higher the priority. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAlternateNumbers.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAlternateNumbers.xsd new file mode 100644 index 0000000..d22218f --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAlternateNumbers.xsd @@ -0,0 +1,107 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with alternate numbers. + The response is either a UserAlternateNumbersGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserAlternateNumbersGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + Modify the user level data associated with Alternate Numbers. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAnonymousCallRejection.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAnonymousCallRejection.xsd new file mode 100644 index 0000000..9d575bb --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAnonymousCallRejection.xsd @@ -0,0 +1,140 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Anonymous Call Rejection. + The response is either a UserAnonymousCallRejectionGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserAnonymousCallRejectionGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Anonymous Call Rejection. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get Anonymous Call Rejection system parameters. + The response is either a SystemAnonymousCallRejectionGetResponse or + an ErrorResponse. + + + + + + + + + + + + + Response to the SystemAnonymousCallRejectionGetRequest. + The response contains the anonymous call rejection system.". + + + + + + + + + + + + + + + + Modify a system Anonymous Call Rejection parameter. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAttendantConsole.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAttendantConsole.xsd new file mode 100644 index 0000000..c9b300c --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAttendantConsole.xsd @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of Attendant Console parameters. + The response is either SystemAttendantConsoleGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemAttendantConsoleGetRequest. + Contains a list of Attendant Console parameters. + + + + + + + + + + + + + + + Modify Attendant Console settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Add users to the Attendant Console monitored users list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Remove users from the Attendant Console monitored users list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a list of available users for the Attendant Console service. + The response is either UserAttendantConsoleGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Response to UserAttendantConsoleGetAvailableUserListRequest. + Returns a 10 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + Request user's attendant console settings. + The response is either a UserAttendantConsoleGetResponse14sp2 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserAttendantConsoleGetRequest14sp2. + Returns a 9 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + + + + + Modify user's attendant console settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Attendant Console Display Columns. + + + + + + + + + + + + + + + + + + + + A list of attendant console display columns that replaces a previously configured list. + By convention, an element of this type may be set nil to clear the list. + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAuthentication.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAuthentication.xsd new file mode 100644 index 0000000..9d57899 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAuthentication.xsd @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's authentication service information. + The response is either a UserAuthenticationGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserAuthenticationGetRequest. + + + + + + + + + + + + + + + Modify the user's authentication service information. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAutoAttendant.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAutoAttendant.xsd new file mode 100644 index 0000000..7a7df33 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAutoAttendant.xsd @@ -0,0 +1,648 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Auto Attendant instance to a group. + The domain is required in the serviceUserId. + Only Group and Enterprise level schedules are accepted. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + type, use AutoAttendantType.BASIC in HSS mode. + holidayMenu. + The following elements are only valid for Standard Auto + Attendants: + holidayMenu + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a Auto Attendant instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Get a list of Auto Attendant instances within a group. + The response is either GroupAutoAttendantGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + true + true + + + Response to the GroupAutoAttendantGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active", "Type". + The column values for "Video" and "Is Active" can either be true, or false. + The column values for "Type" can either be Basic or Standard. + + In HSS Mode the value for the "Type" column will always be populated with Basic. + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Auto Attendant instance. + The response is either GroupAutoAttendantGetInstanceResponse20 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupAutoAttendantGetInstanceRequest20. + Contains the service profile information. + + + The following elements are only used in AS data mode: + type, use AutoAttendantType.BASIC in HSS mode. + holidayMenu. + The following elements are only valid for Standard Auto + Attendants: + holidayMenu + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to set the active status of Auto Attendant instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Request to modify an Auto Attendant instance. + Only Group and Enterprise level schedules are accepted. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + holidayMenu. + The following elements are only valid for Standard Auto + Attendants: + holidayMenu + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a list of Auto Attendant Submenus. + The response is either GroupAutoAttendantSubmenuGetListResponse or ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + true + false + + + Response to the GroupAutoAttendantSubmenuGetListRequest. + Contains a table with column headings: + "Submenu Id" "Is Used". + The column values for "Is Used" can either be true, or false. + + + + + + + + + + + + + + + true + false + + + Get a list of Auto Attendant Business Hours Menu,After Hours Menu,Holiday Menu and Submenus that use this submenu. + The response is either GroupAutoAttendantSubmenuGetUsageListResponse or ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + + Response to the GroupAutoAttendantSubmenuGetUsageListRequest. + Contains a table with column headings: + "Type" and "Submenu ID". + + The "Type" Column will contain one of the following: Business Hours Menu, + After Hours Menu, Holiday Menu or Submenu. + + The "Submenu ID" Column will be left blank when the "Type" Column contains one + of the base menu types (Business Hours Menu, After Hours Menu or Holiday Menu), + and will contain the Submenu ID when the "Type" Column contains type Submenu. + + + + + + + + + + + + + + + true + false + + + Request to get an Auto Attendant submenu instance. + The response is either GroupAutoAttendantSubmenuGetResponse20 or ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + + true + false + + + Response to GroupAutoAttendantSubmenuGetRequest20. + Contains AutoAttendant submenu information. + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify an Auto Attendant submenu instance. + The response is either SuccessResponse or ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to add an Auto Attendant submenu instance. + The response is either SuccessResponse or ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a submenu form an auto attendant. + The response is either SuccessResponse or ErrorResponse. + This request is only valid for Standard auto attendants. + + + + + + + + + + + + + + + + The configuration of a key for Auto Attendant. + + + + + + + + + + + + The modify configuration of a key for Auto Attendant. + + + + + + + + + + + + The read configuration of a key for Auto Attendant. + + + + + + + + + + + + The configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: + audioFile + videoFile + submenuId + The following data elements are only valid for Standard Auto + Attendants: + submenuId + + + + + + + + + + + + + + + + The modify configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: + audioFile + videoFile + submenuId + The following data elements are only valid for Standard Auto + Attendants: + submenuId + + + + + + + + + + + + + + + + The read configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: + submenuId + The following data elements are only valid for Standard Auto + Attendants: + submenuId + + + + + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during after business hours. + + + + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during business hours. + It is used when modifying an Auto Attendant group. + + + + + + + + + + + + + + + The configuration of the automated receptionist greeting + prompt and dialing menu to be used during after business hours. + + + + + + + + + + + + + + + Auto Attendant type. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAutomaticCallback.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAutomaticCallback.xsd new file mode 100644 index 0000000..1f12cf5 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAutomaticCallback.xsd @@ -0,0 +1,328 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system's automatic callback attributes. + The response is either a SystemAutomaticCallbackGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemAutomaticCallbackGetRequest17. + + + + + + + + + + + + + + + + + + + + + + Modifies the system's automatic callback attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Request the system's automatic callback attributes. + The response is either a SystemAutomaticCallbackGetReleaseCauseListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemAutomaticCallbackGetReleaseCauseListRequest. + + + + + + + + + + + + + + + Adds automatic callback release cause to the releaseCause attribute. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Deletes automatic callback release causes from the release cause attribute. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request the user level data associated with Automatic Callback. + The response is either a UserAutomaticCallbackGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserAutomaticCallbackGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Automatic Callback. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Automatic Callback methods. + + + + + + + + + + + + Maximum callback rings. + + + + + + + + + + + + Maximum monitors per originator. + + + + + + + + + + + + Maximum monitors per terminator. + + + + + + + + + + + + Automatic Callback monitor minutes. + + + + + + + + + + + + Polling interval seconds. + + + + + + + + + + + + Idle guard timer seconds. + + + + + + + + + + + + Callback Activation Digit. + + + + + + + + + + + + Callback Release Cause. + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceAutomaticHoldRetrieve.xsd b/share/OCISchemaAS/Services/OCISchemaServiceAutomaticHoldRetrieve.xsd new file mode 100644 index 0000000..fcb71a1 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceAutomaticHoldRetrieve.xsd @@ -0,0 +1,103 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Automatic Hold/Retrieve. + The response is either a UserAutomaticHoldRetrieveGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserAutomaticHoldRetrieveGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Automatic Hold/Retrieve. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Call Timer + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceBargeInExempt.xsd b/share/OCISchemaAS/Services/OCISchemaServiceBargeInExempt.xsd new file mode 100644 index 0000000..a892075 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceBargeInExempt.xsd @@ -0,0 +1,88 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Barge In Exempt. + The response is either a UserBargeInExemptGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserBargeInExemptGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Barge In Exempt. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceBasicCallLogs.xsd b/share/OCISchemaAS/Services/OCISchemaServiceBasicCallLogs.xsd new file mode 100644 index 0000000..aacc8c6 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceBasicCallLogs.xsd @@ -0,0 +1,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request user's call logs. + If the callLogType is not specified, all types of calls are returned. + The response is either a UserBasicCallLogsGetListResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserBasicCallLogsGetListRequest14sp4. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceBroadWorksAnywhere.xsd b/share/OCISchemaAS/Services/OCISchemaServiceBroadWorksAnywhere.xsd new file mode 100644 index 0000000..62a9877 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceBroadWorksAnywhere.xsd @@ -0,0 +1,549 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a BroadWorks Anywhere instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Delete a BroadWorks Anywhere instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get a list of BroadWorks Anywhere instances within a group. + The response is either GroupBroadWorksAnywhereGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + Response to the GroupBroadWorksAnywhereGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active". + The column value for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + Request to get all the information of a BroadWorks Anywhere instance. + The response is either GroupBroadWorksAnywhereGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupBroadWorksAnywhereGetInstanceRequest19sp1. + Contains the service profile information. + + + + + + + + + + + + + + + + + + + + Request to set the active status of BroadWorks Anywhere instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to modify a BroadWorks Anywhere instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Add a broadworks Anywhere phone number. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's BroadWorks Anywhere phone number. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Delete a broadworks anywhere phone number. Also deletes all the selective criteria for the phone number. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a criteria from the user's BroadWorks Anywhere phone number. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of all the available BroadWorks Anywhere portal instances for a specific user + The response is either UserBroadWorksAnywhereGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserBroadWorksAnywhereGetAvailablePortalListRequest. + Contains a table with column headings: "Portal Name", "Phone Number", "Extension", "Language". + + + + + + + + + + + + + + + Get a broadworks anywhere phone number + The response is UserBroadWorksAnywhereGetPhoneNumberResponse. + + + + + + + + + + + + + + + + Response to the UserBroadWorksAnywhereGetPhoneNumberRequest. + The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", + "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a caombination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no exension is available a blank space is provided instead. + + + + + + + + + + + + + + + + + + + + + Get the list of all the BroadWorks Anywhere phone numbers for the user. + The response is either a UserBroadWorksAnywhereGetResponse16sp2 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserBroadWorksAnywhereGetRequest16sp2. + The phoneNumberTable contains columns: "Phone Number", "Description" + + + + + + + + + + + + + + + + + Get a criteria for the user's BroadWorks Anywhere phone number. + The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to the UserBroadWorksAnywhereGetSelectiveCriteriaRequest21. + + + + + + + + + + + + + + + + + + + Modify a BroadWorks Anywhere phone number + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the user-level settings for the BroadWorks Anywhere service for a specified user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Modify selective criteria for the user's BroadWorks Anywhere phone number. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + BroadWorks Anywhere Prompt for CLID options. + + + + + + + + + + + + + BroadWorks Anywhere Phone Number Description. + + + + + + + + + + + + Controls which users may use the BroadWorks Anywhere portal. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceBroadWorksMobility.xsd b/share/OCISchemaAS/Services/OCISchemaServiceBroadWorksMobility.xsd new file mode 100644 index 0000000..5d00482 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceBroadWorksMobility.xsd @@ -0,0 +1,1528 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Adds BroadWorks Mobility IMRN numbers to the system. It is possible to add either: + a single number, a list of numbers, or a range of numbers, or any combination thereof. + The response is either a SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Adds BroadWorks Mobility IMRN numbers to a Mobile Network. It is possible to add either: + a single number, a list of numbers, or a range of numbers, or any combination thereof. + The response is either a SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Removes a BroadWorks Mobility IMRN number from the system. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Remove BroadWorks Mobility IMRN numbers from a Mobile Network. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get the list of BroadWorks Mobility IMRN numbers defined in the system. + The response is either a SystemBroadWorksMobilityGetIMRNListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemBroadWorksMobilityDnGetListRequest. + + + + + + + + + + + + + + + Get a list of BroadWorks Mobility IMRN numbers from a Mobile Network. + The response is either a SystemBroadWorksMobilityGetMobileNetworkIMRNListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemBroadWorksMobilityGetMobileNetworkIMRNListRequest. + + + + + + + + + + + + + + + Add a Mobile Network. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Modify a Mobile Network. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Get a Mobile Network. + The response is either SystemBroadWorksMobilityMobileNetworkGetResponse or ErrorResponse. + + + + + + + + + + + + + + + The response to a SystemBroadWorksMobilityMobileNetworkGetRequest. + + + + + + + + + + + + + + + + + + + + + Get the list of Mobile Networks. + The response is either SystemBroadWorksMobilityMobileNetworkGetListResponse or ErrorResponse. + + + + + + + + + + + + + The response to a SystemBroadWorksMobilityMobileNetworkGetListRequest. + Contains a table with column headings: "Name", "SCF Signaling Net Address", "SCF Signaling Port" + + + + + + + + + + + + + + + Delete a Mobile Network. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Add a Service Access Code list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Modify a Service Access Code list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete a Service Access Code list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the list of Service Access Code lists. + The response is either SystemBroadWorksMobilityServiceAccessCodeListGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemBroadWorksMobilityServiceAccessCodeListGetListRequest. + + + + + + + + + + + + + + + Get all the Mobile Networks using a given Service Access Code list. + The response is either SystemBroadWorksMobilityServiceAccessCodeListUsageGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemBroadWorksMobilityServiceAccessCodeListUsageGetRequest. + + + + + + + + + + + + + + + true + false + + + Get a list of system service access codes. + The response is either SystemBroadWorksMobilityServiceAccessCodeGetListResponse21 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemBroadWorksMobilityServiceAccessCodeGetListRequest21. + Contains a table with column headings: "Country Code", "Service Access Code", "Description" + + + + + + + + + + + + + + + true + false + + + Add a service access code to a list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Delete a service access code from a list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Modify a service access code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Get the broadworks mobility system parameters. + The response is either a SystemBroadWorksMobilityGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + true + false + + + The response to a SystemBroadWorksMobilityGetRequest21. + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the BroadWorks Mobility system parameters. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Request a summary table of all Mobile Subscriber Directory Numbers in a system. + The response is either SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest. + The response contains a table with columns: "Mobile Number", "Mobile Network", "Service Provider Id", "Is Enterprise", "Group Id", "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number" and "Extension". + + + + + + + + + + + + + + + true + false + + + Get the service provider BroadWorks Mobility service settings. + The response is either a ServiceProviderBroadWorksMobilityGetResponse19sp1 or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + The response to a ServiceProviderBroadWorksMobilityGetRequest19sp1. + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the service provider level BroadWorks Mobility service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Adds Mobile Subscriber Directory Numbers to a service provider-mobile network combination. It is possible to add a single DN, + or a list of DNs. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Deletes Mobile Subscriber Directory Numbers from a service provider. It is possible to delete either: a single number, + or a list of numbers. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any group. This command is applicable only for service providers and will fail for enterprises. + The response is either ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest. + Contains a list of available Mobile Subscriber Directory Numbers not yet assigned to any group. + + + + + + + + + + + + + + + true + false + + + Request a summary table of all Mobile Subscriber Directory Numbers in a service provider. This command is applicable only for service providers and will fail for enterprises. + The response is either ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest. + The column headings are "Phone Number", "Group Id" and "Mobile Network". + + + + + + + + + + + + + + + true + false + + + Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user. + The response is either EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest. + Contains a list of available Mobile Subscriber Directory Numbers not yet assigned to any user. + + + + + + + + + + + + + + + true + false + + + Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. + The response is either EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListRequest. + The response contains a table with columns: "Mobile Number", "User Id", + "Last Name", "First Name","Phone Number","Extension", "Group Id", "Department" and "Mobile Network". + The "Mobile Number" column contains a single DN. + The "User Id", "Last Name" and "First Name" columns contains the corresponding attributes of the user possessing the DN(s). + The "Phone Number" column contains a single DN. + The "Group Id" column contains the Group Id of the user. + The "Department" column contains the department of the user if it is part of a department. + The "Mobile Network" column contains the Mobile Network the number belongs to. + + + + + + + + + + + + + + + true + false + + + Get the group's BroadWorks Mobility settings. + The response is either a GroupBroadWorksMobilityGetResponse19sp1 or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + The response to a GroupBroadWorksMobilityGetRequest19sp1. + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the group level broadworks mobility service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Assign Mobile Subscriber Directory Numbers to a group. It is possible to + add a single DN,or a list of DNs. +. This command is applicable only for group in a service provider and will fail for a group in an enterprise. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get the list of assigned and unassigned Mobile Subscriber Directory Numbers in a group. Each DN can be assigned to a user. +. This command is applicable only for group in a service provider and will fail for a group in an enterprise. + The response is either a GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentListRequest. + The response contains a table with columns: "Mobile Number", "User Id", + "Last Name", "First Name","Phone Number", "Extension", "Department",. + The "Mobile Number" column contains a single DN. + The "User Id", "Last Name" and "First Name" columns contains the corresponding attributes of the user possessing the DN(s). + The "Phone Number" column contains a single DN. + The "Department" column contains the department of the user if it is part of a department. + + + + + + + + + + + + + + + true + false + + + Request a list of available Mobile Subscriber Directory Numbers not yet assigned to any user. +. This command is applicable only for group in a service provider and will fail for a group in an enterprise. + The response is either GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailableListRequest. + Contains a list of available Mobile Subscriber Directory Numbers not yet assigned to any user. + + + + + + + + + + + + + + + true + false + + + Unassign Mobile Subscriber Directory Numbers from a group. It is possible to unassign either: a single DN, or a list of DNs. +. This command is applicable only for group in a service provider and will fail for a group in an enterprise. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get the user's BroadWorks Mobility service settings. + The response is either a UserBroadWorksMobilityGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to a UserBroadWorksMobilityGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the user's BroadWorks Mobility service settings. + The response is either a SuccessResponse or an ErrorResponse. + + The isActive, useMobileIdentityCallAnchoring, and preventCallsToOwnMobiles parameters can be modified by users with Group Authorization Level and above. + The mobileIdentity, profileIdentityDevicesToRing, rofileIdentityIncludeSharedCallAppearance, profileIdentityIncludeBroadworksAnywhere mobileIdentity and profileIdentityMobilityNumbersAlerted parameters can be modified by users with User Authorization Level and above when the BroadWorks Mobility service is turned on. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a mobile identity to the user's list of mobile identities. + The response is either a SuccessResponse or an ErrorResponse. + + The request fails when the devicesToRing is set to Mobile and the mobileNumberAlerted list is empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a mobile identity from the user's list of mobile identities. + The response is either a SuccessResponse or an ErrorResponse. + When a delete request is attempted on the primary mobile identity, the delete will fail unless it is the last mobile identity in the user’s list. + + + + + + + + + + + + + + + + true + false + + + Get the settings for a user's specified mobile identity. + The response is either a UserBroadWorksMobilityMobileIdentityGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to a UserBroadWorksMobilityMobileIdentityGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the settings for one of the user's BroadWorks Mobility mobile Identities. + The response is either a SuccessResponse or an ErrorResponse. + The request fails when enableAlerting or timeSchedule or holidaySchedule are included in the request when the user’s use mobile identity call anchoring controls is disabled. + + The description, enableAlerting, alertAgentCalls, alertClickToDialCalls, alertGroupPagingCalls, useMobilityCallingLineID, enableDiversionInhibitor, requireAnswerConfirmation, broadworksCallControl, devicesToRing, includeSharedCallAppearance, includeBroadworksAnywhere, includeExecutiveAssistance, mobileNumberAlerted, enableCallAnchoring, timeSchedule and holidaySchedule parameters require an authorization level of User for modification when the BroadWorks Mobility service is on. + The isPrimary, useSettingLevel, denyCallOrigination, and denyCallTerminiations parameters require an authorization level of Group for modification. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Name of a Service Access Code list. + + + + + + + + + + + + Mobile Identity description. + + + + + + + + + + + + User's Mobile Identity Read Entry + + + + + + + + + + + + + + User's Mobile Identity Modify Entry + + + + + + + + + + + + + + A list of Mobile Numbers to be alerted. + By convention, an element of this type may be set nil to clear the list. + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceBusyLampField.xsd b/share/OCISchemaAS/Services/OCISchemaServiceBusyLampField.xsd new file mode 100644 index 0000000..9b76fcc --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceBusyLampField.xsd @@ -0,0 +1,196 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with the Busy Lamp + Field service. The response is either a + SystemBusyLampFieldGetResponse18 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemBusyLampFieldGetRequest18. + + The following elements are only used in AS data mode: + forceUseOfTCP + + + + + + + + + + + + + + + + Modify the system level data associated with the Busy Lamp Field + Service. The response is either a SuccessResponse or an + ErrorResponse. + + The following elements are only used in AS data mode: + forceUseOfTCP + + + + + + + + + + + + + + + + Get a list of available users for the busy lamp field service. + The response is either UserBusyLampFieldGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the BusyLampFieldGetAvailableUserListRequest. + Returns a table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + Request the settings for the busy lamp field service. + The response is either a UserBusyLampFieldGetResponse16sp2 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserBusyLampFieldGetRequest16sp2. + The table has column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + + + Modify the settings for the busy lamp field service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallCapacityManagement.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallCapacityManagement.xsd new file mode 100644 index 0000000..1311799 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallCapacityManagement.xsd @@ -0,0 +1,279 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds a Call Capacity Management group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Deletes one or more Call Capacity Management groups. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of users that can be assigned to a Call Capacity Management group. + The available user list for a new Call Capacity Management group can be obtained + by not setting the name. + The response is either GroupCallCapacityManagementGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallCapacityManagementGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request to get a list of Call Capacity Management instances within a group. + The response is either GroupCallCapacityManagementGetInstanceListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallCapacityManagementGetInstanceListRequest. + Contains a table with column headings: "Name", "Is Default", "Maximum Calls", "Maximum Incoming Calls", "Maximum Outgoing Calls". + + + + + + + + + + + + + + + Gets a Call Capacity Management group. + The response is either GroupCallCapacityManagementGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallCapacityManagementGetInstanceRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + + + + + Modifies a Call Capacity Management group. Replaces the entire list of users in the group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Adds one or more users to a Call Capacity Management group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Deletes one or more users from a Call Capacity Management group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Range of values for the call capacity of a capacity group. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallCenter.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallCenter.xsd new file mode 100644 index 0000000..7350020 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallCenter.xsd @@ -0,0 +1,8201 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Gets an existing default Call Center Agent Threshold Profile in an Enterprise. + If includeAgentsTable is set to true, a table with the list of agents assigned to + the profile is included in the response. The search criteria is used to filter the + list of agents to be included in the table. + The response is either a EnterpriseCallCenterAgentThresholdDefaultProfileGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the EnterpriseCallCenterAgentThresholdDefaultProfileGetRequest. + The agent table contains the agents assigned to the profile and + has column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address"; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add agent(s) to a Agent Threshold Profile. + When an agent is assigned (added) to a profile, it is automatically unassigned (deleted) from the previous profile it was assigned to. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Add a new Call Center Agent Threshold Profile in an Enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete agent(s) from a Agent Threshold Profile. + Agents cannot be unassigned (deleted) directly from the default profile, they need to be assigned (added) to a different profile. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Deletes an existing Call Center Agent Threshold Profile in an Enterprise. + The default profile cannot be deleted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get the list of all Agents in the Enterprise that can be assigned to a given Call Center Agent Threshold Profile in an Enterprise. + An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent + and the agent is not yet assigned to the profile. + The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName. + When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search + criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name. + The response is either a EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "Agent Threshold Profile"; + + + + + + + + + + + + + + + true + false + + + Get the list of Call Center Agent Threshold Profiles in the Enterprise. + The response is either EnterpriseCallCenterAgentThresholdProfileGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the EnterpriseCallCenterAgentThresholdProfileGetListRequest. + Contains a table with all the Call Center Agent Threshold Profiles in the Enterprise. + The column headings are: "Default", "Name", "Description". + + + + + + + + + + + + + + + true + false + + + Gets an existing non-default Call Center Agent Threshold Profile in an Enterprise. + The response is either a EnterpriseCallCenterAgentThresholdProfileGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the EnterpriseCallCenterAgentThresholdProfileGetRequest. + The agentTable contains the agents assigned to the profile and has the column headings: + "User Id", "Group Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address"; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modifies an existing Call Center Agent Threshold Profile in the Enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Call Center Agent Unavailable Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a Call Center Agent Unavailable Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the list of Call Center Agent Unavailable Codes. + The response is either EnterpriseCallCenterAgentUnavailableCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterAgentUnavailableCodeGetListRequest. + Contains a table with column headings: "Is Active", "Code", "Description". + + + + + + + + + + + + + + + Get a Call Center Agent Unavailable Code. + The response is either EnterpriseCallCenterAgentUnavailableCodeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterAgentUnavailableCodeGetRequest + + + + + + + + + + + + + + + + Modify a Call Center Agent Unavailable Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request the enterprise level data associated with Call Center Agents Unavailable Code Settings. + The response is either an EnterpriseCallCenterAgentUnavailableCodeSettingsGetResponse17sp4 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseCallCenterAgentUnavailableCodeSettingsGetRequest17sp4. + + + + + + + + + + + + + + + + + + + + + Modify the enterprise level data associated with Call Center Agents Unavailable Code Settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Add a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the list of Call Center Call Disposition Codes. + The response is either EnterpriseCallCenterCallDispositionCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterCallDispositionCodeGetListRequest. + Contains a table with column headings: "Is Active", "Code", "Description". + + + + + + + + + + + + + + + Get a Call Center Call Disposition Code. + The response is either EnterpriseCallCenterCallDispositionCodeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterCallDispositionCodeGetRequest + + + + + + + + + + + + + + + + Get the list of Call Centers and Route Points using the specified disposition code. + The response is either EnterpriseCallCenterCallDispositionCodeGetUsageListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterCallDispositionCodeGetUsageListRequest. + The Type column contains either "Call Center" or "Route Point". + Contains a table with column headings: "Group Id", "Id", "Name" and "Type". + + + + + + + + + + + + + + + Modify a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request to set the active status of Call Center Call Disposition Codes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to all the current and past agents in the enterprise. + The searchCriteriaExactUserGroup does not apply to past agents. + The response is either EnterpriseCallCenterCurrentAndPastAgentGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterCurrentAndPastAgentGetListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + Request to get all the current and past call centers for the enterprise. + The searchCriteriaExactUserGroup does not apply to past call centers. + The response is either EnterpriseCallCenterCurrentAndPastCallCenterGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterCurrentAndPastCallCenterGetListRequest. + + + + + + + + + + + + + + + + Request to get all the past and current DNIS for the Call Center for the enterprise. + The response is either EnterpriseCallCenterCurrentAndPastDNISGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterCurrentAndPastDNISGetListRequest. + + + + + + + + + + + + + + + + Request to get the enterprise branding information. + The response is either EnterpriseCallCenterEnhancedReportingBrandingGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the EnterpriseCallCenterEnhancedReportingBrandingGetRequest. + + + + + + + + + + + + + + + + Request to modify the enterprise branding configuration. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request to get all enabled call center report template for an enterprise. + The response is either an EnterpriseCallCenterEnhancedReportingGetAvailableReportTemplateListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingGetAvailableReportTemplateListRequest. + Contains a table with column headings: "Name", "Description" and "Level", "Is Agent Required", + "Is Call Center Required", "Is Call Center Dnis Required", "Is Real Time Report", "Is Sampling Period Required", + "Call Completion Threshold Parameter", "Short Duration Threshold Parameter", + "Service Level Threshold Parameter", "Service Level Inclusions Parameter", "Service Level Objective Threshold Parameter", + "Abandoned Call Threshold Parameter", "Service Level Threshold Parameter Number", + "Abandoned Call Threshold Parameter Number" and "Scope". + The possible values for "Level" are "System" and "Enterprise". + The possible values for "Is Agent Required", "Is Call Center Required", "Is Call Center Dnis Required", "Is Real Time Report" and + "Is Sampling Period Required" are "true" and "false". + The possible values for "Call Completion Threshold Parameter", "Short Duration Threshold Parameter", + "Service Level Threshold Parameter", "Service Level Inclusions Parameter", "Service Level Objective Threshold Parameter" + and "Abandoned Call Threshold Parameter" are "Required", "Hidden" and "Does Not Apply". + The possible values for "Scope" are "Supervisor Only" and "Supervisor and Agent". + + + + + + + + + + + + + + + true + false + + + Request to get an enterprise level call center enhanced reporting setting. + The response is either an EnterpriseCallCenterEnhancedReportingGetResponse19 or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to EnterpriseCallCenterEnhancedReportingGetRequest19. + + + + + + + + + + + + + + + true + false + + + Request to modify enterprise level call center enhanced reporting settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to add an Enterprise level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to delete an enterprise level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get enterprise level call center report template list. + The response is either an EnterpriseCallCenterEnhancedReportingReportTemplateGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingReportTemplateGetListRequest. + Contains a table with column headings: "Name", "Description", "Type" and "Enabled". + + + + + + + + + + + + + + + Request to get an enterprise level call center report template. + The response is either an EnterpriseCallCenterEnhancedReportingReportTemplateGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingReportTemplateGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify an enterprise level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Request to add an enterprise level call center reporting scheduled report. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after startDate. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to delete an enterprise level call center reporting scheduled report. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get a list of active enterprise level call center reporting scheduled reports. + The response is either an EnterpriseCallCenterEnhancedReportingScheduledReportGetActiveListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingScheduledReportGetActiveListRequest. + Contains a table with column headings : "Schedule Name", "Description", "Created By", + "Is Supervisor Report", "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Level" are "System" and "Enterprise". + + + + + + + + + + + + + + + Request to get a list of completed enterprise level call center reporting scheduled reports. + The response is either an EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest + Contains a table with column headings : "Schedule Name", "Description", "Created By", + "Is Supervisor Report", "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Level" are "System" and "Enterprise". + + + + + + + + + + + + + + + Request to get a list of enterprise level call center reporting scheduled reports. + The response is either an EnterpriseCallCenterEnhancedReportingScheduledReportGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingScheduledReportGetListRequest. + Contains a table with column headings : "Schedule Name", "Description", "Created By", + "Is Supervisor Report", "Status", "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Status" are "Active", and "Completed". + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Level" are "System" and "Enterprise". + + + + + + + + + + + + + + + Request to get an enterprise level call center reporting scheduled report. + The response is either an EnterpriseCallCenterEnhancedReportingScheduledReportGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingScheduledReportGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the call center reporting scheduled report in an enterprise that uses a given enterprise level report template. + The response is either a EnterpriseCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to EnterpriseCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListRequest. + Contains a table with column headings: "Schedule Name", "Created By", "Created By Supervisor", and + "Is Active". + The "Created By" can be either "Administrator" or user id if created by supervisor. + + + + + + + + + + + + + + + Request to modify an enterprise level call center reporting scheduled report. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after startDate. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the enterprise level data associated with Call Center. + The response is either an EnterpriseCallCenterGetResponse17sp4 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseCallCenterGetRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + + Request the enterprise call center routing policy. + The response is either an EnterpriseCallCenterGetRoutingPolicyResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseCallCenterGetRoutingPolicyRequest. + Contains a table with column headings: "Service User Id", "Name" and + "Priority". + + + + + + + + + + + + + + + + Modify the enterprise level data associated with Call Center + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Modify the enterprise call center routing policy. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Add agent(s) to a call center. + The response is either SuccessResponse or ErrorResponse. + If the skill level is not present for skill based premium call centers, the users will be set to skill level 1. + + + + + + + + + + + + + + + + + + + true + false + + + Add a Call Center instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Call Center DNIS + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Add supervisor(s) to a call center. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Gets an existing default Call Center Agent Threshold Profile in a Group. + If includeAgentsTable is set to true, a table with the list of agents assigned to + the profile is included in the response. The search criteria is used to filter the + list of agents to be included in the table. + The response is either a GroupCallCenterAgentThresholdDefaultProfileGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupCallCenterAgentThresholdDefaultProfileGetRequest. + The agent table contains the agents assigned to the profile and + has column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address"; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add agent(s) to a Agent Threshold Profile. + When an agent is assigned (added )to a profile, it is automatically unassigned (deleted) from the previous profile it was assigned to. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Add a new Call Center Agent Threshold Profile in a Group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete agent(s) from a Agent Threshold Profile. + Agents cannot be unassigned (deleted) directly from the default profile, they need to be assigned (added) to a different profile. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Deletes an existing Call Center Agent Threshold Profile in a Group. + The default profile cannot be deleted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get the list of all Agents in the Group that can be assigned to a given Call Center Agent Threshold Profile in a Group. + An agent is available to be assigned to a given Agent Threshold Profile if it is a Call Center Standard or Call Center Premium agent + and the agent is not yet assigned to the profile. + The available agent list for a new Call Center Agent Threshold profile can be obtained by not setting the excludeAgentsAssignedToProfileName. + When the excludeAgentsAssignedToProfileName is specified, all agents already assigned to the specified profile are not included in the response, even if the search + criterion element searchCriteriaAgentThresholdProfile is specified using the same profile name. + The response is either a GroupCallCenterAgentThresholdProfileGetAvailableAgentListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupCallCenterAgentThresholdProfileGetAvailableAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "Agent Threshold Profile"; + + + + + + + + + + + + + + + true + false + + + Get the list of Call Center Agent Threshold Profiles in the Group. + The response is either GroupCallCenterAgentThresholdProfileGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the GroupCallCenterAgentThresholdProfileGetListRequest. + Contains a table with all the Call Center Agent Threshold Profiles in the Group. + The column headings are: "Default", "Name", "Description". + + + + + + + + + + + + + + + true + false + + + Gets an existing non-default Call Center Agent Threshold Profile in a Group. + The response is either a GroupCallCenterAgentThresholdProfileGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupCallCenterAgentThresholdProfileGetRequest. + The agentTable contains the agents assigned to the profile and has the column headings: + "User Id", "Group Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address"; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modifies an existing Call Center Agent Threshold Profile in the Group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Call Center Agent Unavailable Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Delete a Call Center Agent Unavailable Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Get the list of Call Center Agent Unavailable Codes. + The response is either GroupCallCenterAgentUnavailableCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallCenterAgentUnavailableCodeGetListRequest. + Contains a table with column headings: "Is Active", "Code", "Description". + + + + + + + + + + + + + + + Get a Call Center Agent Unavailable Code. + The response is either GroupCallCenterAgentUnavailableCodeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallCenterAgentUnavailableCodeGetRequest + + + + + + + + + + + + + + + + Modify a Call Center Agent Unavailable Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Request the group level data associated with Call Center Agents Unavailable Code Settings. + The response is either a GroupCallCenterAgentUnavailableCodeSettingsGetResponse17sp4 or an + ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallCenterAgentUnavailableCodeSettingsGetRequest17sp4. + + + + + + + + + + + + + + + + + + + + + Modify the group level data associated with Call Center Agents Unavailable Code Settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a call center's bounced call settings. + The response is either a GroupCallCenterBouncedCallGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the GroupCallCenterBouncedCallGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's bounced call settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Add a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Delete a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Get the list of Call Center Call Disposition Codes. + The response is either GroupCallCenterCallDispositionCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallCenterCallDispositionCodeGetListRequest. + Contains a table with column headings: "Is Active", "Code", "Description". + + + + + + + + + + + + + + + Get a Call Center Call Disposition Code. + The response is either GroupCallCenterCallDispositionCodeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallCenterCallDispositionCodeGetRequest + + + + + + + + + + + + + + + + Get the list of Call Centers and Route Points using the specified disposition code. + The response is either GroupCallCenterCallDispositionCodeGetUsageListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallCenterCallDispositionCodeGetUsageListRequest. + The Type column contains either "Call Center" or "Route Point". + Contains a table with column headings: "Id", "Name" and "Type". + + + + + + + + + + + + + + + Modify a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to set the active status of Call Center Call Disposition Codes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get a call center's comfort message bypass settings. + The response is either a GroupCallCenterComfortMessageBypassGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterComfortMessageBypassGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's comfort message bypass settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Request to get all the current and past agents for the group. + The response is either GroupCallCenterCurrentAndPastAgentGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallCenterCurrentAndPastAgentGetListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + Request to get all the current and past call centers for the group. + The response is either GroupCallCenterCurrentAndPastCallCenterGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to the GroupCallCenterCurrentAndPastCallCenterGetListRequest. + + + + + + + + + + + + + + + + Request to get all the past and current DNIS for the Call Center for the group. + The response is either GroupCallCenterCurrentAndPastDNISGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallCenterCurrentAndPastDNISGetListRequest. + + + + + + + + + + + + + + + + Delete agent(s) from a call center. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete a call center's DNIS. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Delete a Call Center instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Delete supervisor(s) from a call center. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the distinctive ringing configuration values for call center. + The response is either a GroupCallCenterDistinctiveRingingGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterDistinctiveRingingGetRequest. + + + + + + + + + + + + + + + + + Modify the distinctive ringing configuration values for call center. + + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to get the group branding information. + The response is either GroupCallCenterEnhancedReportingBrandingGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallCenterEnhancedReportingBrandingGetRequest. + + + + + + + + + + + + + + + + Request to modify the group branding configuration. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request to get all enabled call center report template for a group. + The response is either a GroupCallCenterEnhancedReportingGetAvailableReportTemplateListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingGetAvailableReportTemplateListRequest. + Contains a table with column headings: "Name", "Description" and "Level", "Is Agent Required", + "Is Call Center Required", "Is Call Center Dnis Required","Is Real Time Report", "Is Sampling Period Required", + "Call Completion Threshold Parameter", "Short Duration Threshold Parameter", + "Service Level Threshold Parameter", "Service Level Inclusions Parameter", "Service Level Objective Threshold Parameter", + "Abandoned Call Threshold Parameter", "Service Level Threshold Parameter Number", + and "Abandoned Call Threshold Parameter Number". + The possible values for "Level" are "System" and "Group". + The possible values for "Is Agent Required", "Is Call Center Required", "Is Call Center Dnis Required", + "Is Real Time Report" and "Is Sampling Period Required" are "true" and "false". + The possible values for "Call Completion Threshold Parameter", "Short Duration Threshold Parameter", + "Service Level Threshold Parameter", "Service Level Inclusions Parameter","Service Level Objective Threshold Parameter" + and "Abandoned Call Threshold Parameter" are "Required", "Hidden" and "Does Not Apply". + + + + + + + + + + + + + + + true + false + + + Request to get a group level call center enhanced reporting setting. + The response is either a GroupCallCenterEnhancedReportingGetResponse19 or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupCallCenterEnhancedReportingGetRequest19. + + + + + + + + + + + + + + + true + false + + + Request to modify group level call center enhanced reporting settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to add a group level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to delete a group level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get group level call center report template list. + The response is either a GroupCallCenterEnhancedReportingReportTemplateGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingReportTemplateGetListRequest. + Contains a table with column headings: "Name", "Description", "Type" and "Enabled" + + + + + + + + + + + + + + + Request to get a group level call center report template. + The response is either a GroupCallCenterEnhancedReportingReportTemplateGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingReportTemplateGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a group level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a group level call center reporting scheduled report. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after startDate. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to delete a group level call center reporting scheduled report. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get a list of active group level call center reporting scheduled reports. + The response is either a GroupCallCenterEnhancedReportingScheduledReportGetActiveListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest + Contains a table with column headings : "Schedule Name", "Description", "Created By", + "Is Supervisor Report", "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Template Level" are "System" and "Group". + + + + + + + + + + + + + + + Request to get a list of completed group level call center reporting scheduled reports. + The response is either a GroupCallCenterEnhancedReportingScheduledReportGetCompletedListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingScheduledReportGetCompletedListRequest + Contains a table with column headings : "Schedule Name", "Description", "Created By", + "Is Supervisor Report", "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Template Level" are "System" and "Group". + + + + + + + + + + + + + + + Request to get a list of group level call center reporting scheduled reports. + The response is either a GroupCallCenterEnhancedReportingScheduledReportGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingScheduledReportGetListRequest. + Contains a table with column headings : "Schedule Name", "Description", "Created By", + "Is Supervisor Report", "Status", "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Status" are "Active", and "Completed". + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Template Level" are "System" and "Group". + + + + + + + + + + + + + + + Request to get all the call center reporting scheduled report in a group that uses a given group level report template. + The response is either a GroupCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListRequest. + Contains a table with column headings: "Schedule Name", "Created By", "Created By Supervisor", + and "Is Active". + The "Created By" can be either "Administrator" or user id if created by supervisor. + + + + + + + + + + + + + + + Request to get a group level call center reporting scheduled report. + The response is either a GroupCallCenterEnhancedReportingScheduledReportGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupCallCenterEnhancedReportingScheduledReportGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a group level call center reporting scheduled report. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after startDate. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's forced forwarding settings. + The response is either a GroupCallCenterForcedForwardingGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterForcedForwardingGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's forced forwarding settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of agents assigned to a call center. + The response is either a + GroupCallCenterGetAgentListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Weight", + "Phone Number", "Extension", "Department", "Email Address", "Skill Level". + + + + + + + + + + + + + + + Get a call center's announcement settings. + The response is either a GroupCallCenterGetAnnouncementResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAnnouncementRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of users that can be assigned as agents to a given type of Call Center. + Searching for users by group only makes sense when the call center is part of an Enterprise. + The response is either GroupCallCenterGetAvailableAgentListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAvailableAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a list of users that can be assigned as supervisors to a Call Center. + Searching for users by group only makes sense when the call center is part of an Enterprise. + The response is either GroupCallCenterGetAvailableSupervisorListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallCenterGetAvailableSupervisorListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a list of agent who selected the DNIS as the outgoing call. + The response is either GroupCallCenterGetDNISAgentListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDNISAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a call center's DNIS Announcements + The response is either a GroupCallCenterGetDNISAnnouncementRequest20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDNISAnnouncementRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of DNIS that are configured for a Call Center. + The response is either GroupCallCenterGetDNISListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDNISListResponse. + Contains a table with column headings: "Name", "Phone Number", "Extension", "Priority", "Is Primary DNIS". + + + + + + + + + + + + + + + + + + + + + + + Get a call center's DNIS. + The response is either a GroupCallCenterGetDNISRequest or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDNISResponse. + + + + + + + + + + + + + + + + + + + + + + + Get a list of Call Center instances within a group. + The response is either GroupCallCenterGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + Response to the GroupCallCenterGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active", "Policy", "Type". + The column values for "Video" and "Is Active" can either be true, or false. + The column values for "Type" can be "Basic", "Standard" or "Premium". + NOTE: prior to release 14, the policy column did not match the HuntPolicy enumerated type. + + + + + + + + + + + + + + + Get the distinctive ringing configuration values for call center. + The response is either a GroupCallCenterGetDistinctiveRingingResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetDistinctiveRingingRequest. + + + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Call Center instance. + The response is either GroupCallCenterGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupCallCenterGetInstanceRequest19sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the call center statistics reporting settings. + The response is either GroupCallCenterGetInstanceStatisticsReportingResponse17sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupCallCenterGetInstanceStatisticsReportingRequest17sp1. + Contains Call Center statistics reporting settings. + + + + + + + + + + + + + + + + + + + Get Call Center queue and agent statistics. + The response is either GroupCallCenterGetInstanceStatisticsResponse14sp9 or ErrorResponse. + + + + + + + + + + + + + + + + Contains Call Center statistics. + + + + + + + + + + + + + + + + + Get Call Center queue status. + The response is either GroupCallCenterGetInstanceQueueStatusResponse or ErrorResponse. + + + + + + + + + + + + + + + Contains Call Center queue status and a table with column headings: + "User Id", "First Name", "Last Name", "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + Request the Group level data associated with Call Center. + The response is either a GroupCallCenterGetResponse17sp4 or an + ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallCenterGetRequest17sp4. + + + + + + + + + + + + + + + + + + + + + + + Request the group call center routing policy. + The response is either a GroupCallCenterGetRoutingPolicyResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallCenterGetRoutingPolicyRequest. + Contains a table with column headings: "Service User Id", "Name" and + "Priority". + + + + + + + + + + + + + + + + Get a list of supervisors assigned to a call center. + The response is either a + GroupCallCenterGetSupervisorListResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterGetSupervisorListRequest16. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a list of unlicensed users who are preventing the Call Center from upgrading to another type. + The response is either GroupCallCenterGetUnlicensedAgentListRequest or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallCenterGetUnlicensedAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Group Id", + "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a call center's holiday service settings. + The response is either a GroupCallCenterHolidayServiceGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterHolidayServiceGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's holiday service settings. + Only Group and Enterprise level schedules are accepted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Request to set the active status of Call Center instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to modify the agent list for a call center. + The response is either SuccessResponse or ErrorResponse. + If the agentUserIdList is used for Skill Based Premium call centers, + the agents will be set to skill level 1. + + + + + + + + + + + + + + + + + + + Modify a call center's announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center DNIS announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the distinctive ringing configuration values for call center. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Modify the setting that are configured for all the DNIS in a Call Center. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's DNIS settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a Call Center instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the Call Center statistics reporting frequency and destination. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to modify the weighted call distribution of a Call Center instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Modify the group level data associated with Call Center and + the active status of Call Center instances. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group call center routing policy. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to modify the supervisor list for a call center. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get a call center's night service settings. + The response is either a GroupCallCenterNightServiceGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterNightServiceGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's night service settings. + Only Group and Enterprise level schedules are accepted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's overflow settings. + The response is either a GroupCallCenterOverflowGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterOverflowGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's overflow settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Get the status configuration for a given call center. + The response is either a GroupCallCenterQueueStatusNotificationGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterQueueStatusNotificationGetRequest. + The response contains the call center status configuration information. + + + + + + + + + + + + + + + + + + + Set the status configuration for a given call center. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Add a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the list of Call Center Level and Organization Level Call Disposition Codes. + The response is either GroupCallCenterQueueCallDispositionCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterQueueCallDispositionCodeGetListRequest. + Contains a table with column headings: "Is Active", "Code", "Description" and "Level". + Level column can be any of the values in the data type CallDispositionCodeLevel. + + + + + + + + + + + + + + + Get a Call Center Call Disposition Code. + The response is either GroupCallCenterQueueCallDispositionCodeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallCenterQueueCallDispositionCodeGetRequest + + + + + + + + + + + + + + + + Modify a Call Center Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Center Call Disposition Code Settings. + The response is either a GroupCallCenterQueueCallDispositionCodeSettingsGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to GroupCallCenterQueueCallDispositionCodeSettingsGetRequest. + + + + + + + + + + + + + + + + + + Modify the enterprise level data associated with Call Center Agents Unavailable Code Settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Get a call center's queue Thresholds settings. + The response is either a GroupCallCenterQueueThresholdsGetRequest or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the GroupCallCenterQueueThresholdsGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify a call center's queue Thresholds settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a call center's stranded call settings. + The response is either a GroupCallCenterStrandedCallGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterStrandedCallGetRequest20. + + + + + + + + + + + + + + + + + + + + + + Modify a call center's stranded call settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Get a call center's stranded calls - unavailable settings. + The response is either a GroupCallCenterStrandedCallUnavailableGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupCallCenterStrandedCallUnavailableGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + Modify a call center's stranded calls - unavailable settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the system branding information. + The response is either SystemCallCenterEnhancedReportingBrandingGetResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemCallCenterEnhancedReportingBrandingGetRequest. + + + + + + + + + + + + + + + + true + false + + + Request to modify the system branding configuration. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get the list of data template and the corresponding information in the system. + The response is either a SystemCallCenterEnhancedReportingDataTemplateGetListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingDataTemplateGetListRequest. + + + + + + + + + + + + + + + true + false + + + Request to get the call center enhanced reporting system settings. + The response is either a SystemCallCenterEnhancedReportingGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingGetRequest. + + + + + + + + + + + + + + + + + true + false + + + Modify the system settings for call center enhanced reporting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request to add a system level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to delete a system level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get system level call center report template list. + The response is either a SystemCallCenterEnhancedReportingReportTemplateGetListResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingReportTemplateGetListRequest. + Contains a table with column headings: "Name", "Description", "Is Custom", "Type" and "Enabled" + + + + + + + + + + + + + + + true + false + + + Request to get a system level call center report template. + The response is either a SystemCallCenterEnhancedReportingReportTemplateGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingReportTemplateGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a system level call center report template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the list of all active call center reporting scheduled reports in the system. + The response is either a SystemCallCenterEnhancedReportingScheduledReportGetActiveListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingScheduledReportGetActiveListRequest + Contains a table with column headings : "Scheduled Report Name", "Description", + "Service Provider Id", "Is Enterprise", "Group Id", "Created By", "Is Supervisor Report", + "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Template Level" are "System", "Enterprise" and "Group". + For the rows with "Is Enterprise" column value "true", the "Group Id" column will be empty. + + + + + + + + + + + + + + + true + false + + + Request to get the list of all completed call center reporting scheduled reports in the system. + The response is either a SystemCallCenterEnhancedReportingScheduledReportGetCompletedListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingScheduledReportGetCompletedListRequest + Contains a table with column headings : "Scheduled Report Name", "Description", + "Service Provider Id", "Is Enterprise", "Group Id", "Created By", "Is Supervisor Report", + "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Template Level" are "System", "Enterprise" and "Group". + For the rows with "Is Enterprise" column value "true", the "Group Id" column will be empty. + + + + + + + + + + + + + + + true + false + + + Request to get the list of all call center reporting scheduled reports in the system. + The response is either an SystemCallCenterEnhancedReportingScheduledReportGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingScheduledReportGetListRequest. + Contains a table with column headings : "Scheduled Report Name", "Description", + "Service Provider Id", "Is Enterprise", "Group Id", "Created By", "Is Supervisor Report", "Status", + "Report Template Name", "Report Template Level" and "Recurring". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Status" are "Active", and "Completed". + The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". + The possible values for "Report Template Level" are "System", "Enterprise" and "Group". + For the rows with "Is Enterprise" column value "true", the "Group Id" column will be empty. + + + + + + + + + + + + + + + true + false + + + Request to get all the call center reporting scheduled report in the system that uses a + given system level report template. + The response is either a SystemCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingScheduledReportGetReportTemplateUsageListRequest. + Contains a table with column headings: "Schedule Name", "Organization Type", "Service Provider Id", + "Group Id", "Created By", "Created By Supervisor", and "Is Active". + The "Organization Type" is either "Service Provider" or "Enterprise". + The "Created By" can be either "Administrator" or user id if created by supervisor. + The possible values for "Created By Supervisor" are "true" and "false". + + + + + + + + + + + + + + + true + false + + + Request to get the system settings for the call center enhanced reporting scheduling tasks. + The response is either a SystemCallCenterEnhancedReportingScheduledTaskParametersGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterEnhancedReportingScheduledTaskParametersGetRequest + + + + + + + + + + + + + + + + + true + false + + + Modify the system settings for the call center enhanced reporting scheduling tasks. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Call Center. + The response is either a SystemCallCenterGetResponse21 or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallCenterGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Call Center. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Assign agent(s) to a call center supervisor. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + This request signs-out a call center agent. Administrator, supervisor and agent itself can sign-out an agent. + An empty OCI table in OCI-P response indicates success and the agent has been signed out. This sign-out + command will fail if the agent is the last signed-in agent of any standard or premium call center to + which she is currently joined. If the sign-out fails, the OCI-P response will contain a list of + Call Centers for which the agent is the last signed-in agent. + If this special logic is not needed, UserCallCenterModifyRequest19 can still be used to change + the agents ACD state without checking if the agent is the last signed-in agent. + The response is either a UserCallCenterAgentSignOutResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallCenterAgentSignOutRequest. + It contains a list of call centers for which the agent is the last signed-in agent. + Contains a table with column headings: "Service User Id" and "Call Center Name". + + + + + + + + + + + + + + + Request to get the detail information of a Call Center Agent. Administrator, supervisor and agent + itself can send this command. + The response is either UserCallCenterAgentDetailsGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallCenterAgentDetailsGetRequest. + Contains the detail information for a Call Center Agent. + + + + + + + + + + + + + + + + + Get the list of available Call Center Call Disposition Codes to be used by a client. + The response is either UserCallCenterCallDispositionCodeGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallCenterCallDispositionCodeGetAvailableListRequest. + This list may include Group/Enterprise level codes in addition to the Call Center level codes, + depending on the call center disposition codes settings. + Only active codes are included in the list. + Contains a table with column headings: "Code", "Description" and "Level". + Level column can be any of the values in the data type CallDispositionCodeLevel. + + + + + + + + + + + + + + + Delete agent(s) from a call center supervisor. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the input parameter info for a call center report template. + The response is either a UserCallCenterEnhancedReportingReportTemplateParamInfoGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallCenterEnhancedReportingReportTemplateParamInfoGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to delete a call center reporting scheduled report created by a supervisor. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get a call center reporting scheduled report created by supervisor. + The response is either a UserCallCenterEnhancedReportingScheduledReportGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserCallCenterEnhancedReportingScheduledReportGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify a call center reporting scheduled report created by a supervisor. + The response is either a SuccessResponse or an ErrorResponse. + The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after startDate. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a list of supervisors for an agent on a given call center. + The response is either a UserCallCenterGetAgentSupervisorListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the UserCallCenterGetAgentSupervisorListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id", + "Location Code". + + + + + + + + + + + + + + + This request gets a list of all call centers which the user can be assigned to as an agent. + Some of the call centers may already have the user as an agent. It is the clients + responsibility to discard the call centers that the user is already an agent of. + The response is either a UserCallCenterGetAvailableCallCenterListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallCenterGetAvailableCallCenterListRequest. + Contains a table with column heading: "Service User Id". + + + + + + + + + + + + + + + Request a list of available DNIS for agent to select. + The response is either UserCallCenterGetAvailableDNISListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallCenterGetAvailableDNISListRequest. + Contains a list of available DNIS for agent to select. + + + + + + + + + + + + + + + true + false + + + Get the user's call center settings and the list of call centers the specified user belongs to. + The response is either a UserCallCenterGetResponse19 or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserCallCenterGetRequest19. + Contains the user's call center settings. + Indicates whether the agent is current available (logged in) to each call center in the list. + Contains a table with column headings: "Service User Id", "Phone Number", "Extension", "Available", "Logoff Allowed", "Type", + "Priority","Routing Policy" and "Skill Level". + The valid "Routing Type" values are "Priority Based" and "Skill Based". This column is only populated for Premium Call Centers. + The valid "Skill Level" values are of from 1-20. This column is only populated for Premium Skill Based Call Centers. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a list of agents supervised by a supervisor on a given call + center. + The response is either a UserCallCenterGetSupervisedAgentListResponse + or an ErrorResponse. + The search can be done using multiple criterias. + If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only + results matching all the search criterias are included in the results. + If no search criteria is specified, all results are returned. + In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an + ErrorResponse is returned. + Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserCallCenterGetSupervisedAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address", "IMP Id", "Location Code". + + + + + + + + + + + + + + + Get a list of call centers the user is assigned to as a supervisor. + The response is either a UserCallCenterGetSupervisorCallCenterListResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallCenterGetSupervisorCallCenterListRequest. + Contains a table with column headings: "Service User Id", "Phone Number", + "Extension", "Type" and "Priority". + + + + + + + + + + + + + + + Request to modify the call center list for an agent. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Modifies the agents call center settings and the availability for an agent in one or more Call Centers. + Contains a list specifying the desired availability status of one or more call centers. + A default unavailable code will be used if the parameter agentUnavailableCode is not active, included or is invalid. + Changing the agentACDState from unavailable to any other state will automatically clear the unavailable code. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modifies a list of users to be supervised by a supervisor on a call center. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Agent Automatic Call Distribution (ACD) State. + + + + + + + + + + + + + + + Contains Call Center Agent statistics for a given time frame. + + + + + + + + + + + + + + + Timer to alert CallCenter calls on hold + + + + + + + + + + + + Timer to bounce CallCenter calls on hold + + + + + + + + + + + + Specifies an agent's login state (availability) for a particular Call Center. + + + + + + + + + + + + + + + + Specifies an agent's settings for a particular Call Center. + The skillLevel only applies to Premium agents. + + + + + + + + + + + + + + + + + Contains Call Center statistics for a specified agent. + + + + + + + + + + + + + + Call Center Agent Threshold Profile description. + + + + + + + + + + + + List of email addresses to which the Agent Threshold Profile email is sent. The list replaces a previously configured list. + + + + + + + + + + + Call Center Agent Threshold for Current Call State Idle time. + + + + + + + + + + + + Call Center Agent Threshold for Current Call State On-Call time. + + + + + + + + + + + + Call Center Agent Threshold for Current Agent State Unavailable time. + + + + + + + + + + + + Call Center Agent Threshold for Average Busy In time. + + + + + + + + + + + + Call Center Agent Threshold for Average Busy Out time. + + + + + + + + + + + + Call Center Agent Threshold for Average Wrap-Up time. + + + + + + + + + + + + Call Center Agent Unavailable Code Description. + + + + + + + + + + + + Contains a Call Center Agent Unavailable Code and its active state + + + + + + + + + + + + Call Center Announcement Selection. + + + + + + + + + + + + Call center comfort message bypass threshold. This is the maximum estimated wait time to allow + bypassing the comfort message. + + + + + + + + + + + + Call center maximum number of consecutive bounced calls allowed before forcing agent to become unavailable. + + + + + + + + + + + + The number of days after a scheduled report is completed. + + + + + + + + + + + + Call Center Routing type for distributing calls within a call center. + + + + + + + + + + + + The timer determines how long the system will wait before routing a call to a free agent. + + + + + + + + + + + + Maximum number of call center scheduled report can be processed per report search interval. + + + + + + + + + + + + Call Center Queue Threshold for Current calls in queue. + + + + + + + + + + + + Call Center Queue Threshold for Current longest waiting call. + + + + + + + + + + + + Call Center Queue Threshold for Estimated wait time. + + + + + + + + + + + + Call Center Queue Threshold for Average Handling Time. + + + + + + + + + + + + Call Center Queue Threshold for Average speed of answer. + + + + + + + + + + + + List of email addresses to which the Call Center Queue Threshold email is sent. The list replaces a previously configured list. + + + + + + + + + + + Call center ring time before playing comfort message bypass announcement. + + + + + + + + + + + + Call center routing policy. + + + + + + + + + + + + Call center routing priority. + + + + + + + + + + + + Call center routing order + + + + + + + + + + + + Contains Call Center Queue statistics. + + + + + + + + + + + + + + + + + + + Statistics reporting interval in minutes. + + + + + + + + + + + + + Call center stranded call processing action. + + + + + + + + + + + + + + + + The number of unavailable agents used to condition the Call Center stranded calls - unavailable routing policy. + + + + + + + + + + + + Call center stranded calls - unavailable routing policy processing action. + + + + + + + + + + + + + + + + The time determines how long the system waits and prevents notification emails being + generated as a statistic swings back and forth across a threshold. + + + + + + + + + + + + The interval in seconds between each repetition of the comfort message played to queued users. + + + + + + + + + + + + Statistics Range + + + + + + + + + + + + Call Center statistics sampling period. + + + + + + + + + + + + The call center statistics source. + + + + + + + + + + + + + Call center type. + + + + + + + + + + + + + Call Center emergency call CLID prefix. + + + + + + + + + + + + Number of calls in queue before notification to agents devices. + + + + + + + + + + + + Waiting time for a given call before notification to agents devices. + + + + + + + + + + + + Call Center Call Disposition Code Value. + + + + + + + + + + + + Contains a Call Center Call Disposition Code and its active state + + + + + + + + + + + + Call Center Call Disposition Code Description. + + + + + + + + + + + + Identifies at which level in the system an call center call disposition code is created. + + + + + + + + + + + + + Contains a Call Center Call Disposition Code and its Level + + + + + + + + + + + + Choices for DNIS priority. + + + + + + + + + + + + + + Timer to upgrade the priority for a DNIS number + + + + + + + + + + + + Call Center Uniform Call Distribution Policy Scope. + + + + + + + + + + + + The default number of call handling minutes. + + + + + + + + + + + + The type of estimated wait message that is played. + + + + + + + + + + + + The number of position for which the estimated wait is played. + + + + + + + + + + + + The number of minutes for which the estimated wait is played. + + + + + + + + + + + + Estimated Wait Message Options + + + + + + + + + + + + + + + + + + + Estimated Wait Message Options + + + + + + + + + + + + + + + + + + + The interval in seconds between each repetition of the estimated wait time/location message played to queued users. + + + + + + + + + + + + The moving average period used to calculate the call handling time. + + + + + + + + + + + + The minimum number of entries for the call handling time moving average to be valid. + + + + + + + + + + + + A list of agents for a particular skill Level. + + + + + + + + + + + + A list of agents grouped by skill levels. + + + + + + + + + + + + The call center enhanced reporting report current interval, for example, current week. + + + + + + + + + + + The call center enhanced reporting system level branding choice. + + + + + + + + + + + + The call center enhanced reporting Enterprise or Group level branding choice. + + + + + + + + + + + + The call center enhanced reporting abadoned calls possible values for service level thresholds + + + + + + + + + + + + + + A list of call center reporting abandoned call threshold seconds that replaces a previously configured list. + + + + + + + + + + + Call center reporting data template info. + + + + + + + + + + + + + + + + + + + + + + + Options for call center enhanced reporting data template input parameters. + + + + + + + + + + + + The call center enhanced reporting data template name. + + + + + + + + + + + + A list of call center reporting data template query filter values that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + Date format for a call center enhanced reporting report. + + + + + + + + + + + + Time format for a call center enhanced reporting report. + + + + + + + + + + + + Call center enhanced reporting report file format. + + + + + + + + + + + + Options for call center enhanced reporting input parameters. + + + + + + + + + + + + Report interval for call center enhanced reporting scheduled reports. + + + + + + + + + + + + + The call center enhanced reporting report interval, using dates. + + + + + + + + + + + + + + The call center enhanced reporting report interval time number, to be used with the + CallCenterReportIntervalTimeUnit. + + + + + + + + + + + + The call center enhanced reporting report interval time unit. + + + + + + + + + + + + + + + The call center enhanced reporting report past interval, for example, last 24 month. + + + + + + + + + + + + A list of call center reporting email addresses that replaces a previously configured list. + + + + + + + + + + + The call center enhanced reporting sampling period. + + + + + + + + + + + + + + + + A schedule for call center enhanced reporting scheduled report. It can either be a fixed time schedule + or recurring schedule + + + + + + + + + + + + A recurring schedule for call center enhanced reporting scheduled report. + + + + + + + + + + + + + + A scheduled time for call center enhanced reporting scheduled report. + + + + + + + + + + + + + Call center report server choice. + + + + + + + + + + + + The call center enhanced reporting report service level objective percentage. + + + + + + + + + + + + A list of call center reporting service level threshold seconds that replaces a previously configured list. + + + + + + + + + + + The call center enhanced reporting template access option. + + + + + + + + + + + + The call center enhanced reporting report template description. + + + + + + + + + + + + The call center enhanced reporting report threshold. + + + + + + + + + + + + The call center enhanced reporting type. + + + + + + + + + + + + + Either all agents or list of agents. + + + + + + + + + + + + Either all agents or list of agents. + The agent table has the following column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name" and "Hiragana First Name". + + + + + + + + + + + + Either all agents or 2 list of agents: one for current and one for past (deleted) agents. + This is used when an admin reads a Scheduled Report. + Each agent table has the following column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name" and "Hiragana First Name". + + + + + + + + + + + + + + + User for admin read. Either all call centers or 2 lists of call centers: one for current and one for deleted call centers. + + + + + + + + + + + + + + + Either all call centers or list of call centers. + + + + + + + + + + + + The call center enhanced reporting scheduled report description. + + + + + + + + + + + + Either all DNIS under the specified Call Center or list of DNIS. + + + + + + + + + + + + + + + Either all DNIS under the specified Call Center or 2 lists of DNIS, one for current one for past (deleted). + + + + + + + + + + + + + + + + + + + Indicates how often we search for a scheduled report to process. + + + + + + + + + + + + The call center enhanced reporting scheduled report inclusions related to the Service Level thresholds + + + + + + + + + + + + + + The call center enhanced reporting scheduled report modified inclusions related to the Service Level thresholds + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallCenterMonitoring.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallCenterMonitoring.xsd new file mode 100644 index 0000000..ea51dbe --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallCenterMonitoring.xsd @@ -0,0 +1,88 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user's Call Center Monitoring settings. + The response is either a UserCallCenterMonitoringGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallCenterMonitoringGetRequest. + + + + + + + + + + + + + + + Modify the user's Call Center Monitoring settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingAlways.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingAlways.xsd new file mode 100644 index 0000000..ae5c1b1 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingAlways.xsd @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Forwarding Always. + The response is either a UserCallForwardingAlwaysGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallForwardingAlwaysGetRequest. + + + + + + + + + + + + + + + + + Modify the user level data associated with Call Forwarding Always. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingBusy.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingBusy.xsd new file mode 100644 index 0000000..7242a1b --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingBusy.xsd @@ -0,0 +1,92 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Forwarding Busy. + The response is either a UserCallForwardingBusyGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallForwardingBusyGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Call Forwarding Busy. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNoAnswer.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNoAnswer.xsd new file mode 100644 index 0000000..8f76606 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNoAnswer.xsd @@ -0,0 +1,124 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Forwarding No Answer. + The response is either a UserCallForwardingNoAnswerGetResponse13mp16 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallForwardingNoAnswerGetRequest13mp16. + + + + + + + + + + + + + + + + + Modify the user level data associated with Call Forwarding No Answer. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + + + + Number of Rings until call is redirected. + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNotReachable.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNotReachable.xsd new file mode 100644 index 0000000..20b5a82 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingNotReachable.xsd @@ -0,0 +1,93 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Forwarding Not Reachable. + The response is either a UserCallForwardingNotReachableGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallForwardingNotReachableGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Call Forwarding Not Reachable. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingSelective.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingSelective.xsd new file mode 100644 index 0000000..ba07990 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallForwardingSelective.xsd @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's call forwarding selective service. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's call forwarding selective service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a criteria for the user's call forwarding selective service. + The response is either a UserCallForwardingSelectiveGetCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserCallForwardingSelectiveGetCriteriaRequest21. + + + + + + + + + + + + + + + + + + + + Get the user's call forwarding selective service setting. + The response is either a UserCallForwardingSelectiveGetResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallForwardingSelectiveGetRequest16. The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Forward To", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + + + + Modify a criteria for the user's call forwarding selective service. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Modify the user's call forwarding selective service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Forward to Number Selection. + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallMeNow.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallMeNow.xsd new file mode 100644 index 0000000..e809f1c --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallMeNow.xsd @@ -0,0 +1,313 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Call Me Now service. + The response is either a SystemCallMeNowGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallMeNowGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Call me now service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a criterion to the user's call me now service. The criterion added is automatically active. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's call me now service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a criteria for the user's call me now service. + The response is either a UserCallMeNowGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserCallMeNowGetCriteriaRequest. + + + + + + + + + + + + + + + + + + Get the user's call me now service setting. + The response is either a UserCallMeNowGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallMeNowGetRequest. The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule", "Call To", "Reject Call" and "Holiday Schedule". + + + + + + + + + + + + + + + + + Modify a criteria for the user's call me now service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modify the user's call me now service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Possible type of answer confirmation for Call Me Now. + + + + + + + + + + + + + Maximum number of characters for Call Me Now passcode. + + + + + + + + + + + + Timeout in seconds for call me now passcode validation. + + + + + + + + + + + + The To dn criteria used on the call me now external number. + + + + + + + + + + + + The To dn criteria used on the call me now external number to be modified. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallNotify.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallNotify.xsd new file mode 100644 index 0000000..8d60fb4 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallNotify.xsd @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Call Notify. + The response is either a SystemCallNotifyGetResponse or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallNotifyGetRequest. + + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Call Notify. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Add a criteria to the user's call notify service. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Get a criteria for the user's call notify service. + The response is either a UserCallNotifyGetCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserCallNotifyGetCriteriaRequest21. + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's call notify service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a criteria for the user's call notify service. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Get the user's call notify service setting. + The response is either a UserCallNotifyGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallNotifyGetRequest. The criteria table's column headings are: "Is Active", + "Criteria Name", "Time Schedule", "Calls From", "Blacklisted" ,"Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + + Modify the user's call notify service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallPark.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallPark.xsd new file mode 100644 index 0000000..667430d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallPark.xsd @@ -0,0 +1,428 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds a Call Park group. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + recallAlternateUserId + recallTo, use value "Parking User Only" in HSS data mode + + + + + + + + + + + + + + + + + + + + Deletes a Call Park group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get a list of hunt groups that are available to select as an alternate recall user. + The response is either GroupCallParkGetAvailableAlternateRecallUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupCallParkGetAvailableAlternateRecallUserListResponse. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". + + + + + + + + + + + + + + + Get a list of users that can be assigned to a Call Park group. + The available user list for a new Call Park group can be obtained + by not setting the name. + The response is either GroupCallParkGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallParkGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request to get a list of Call Park group instances within a group. + The response is either GroupCallParkGetInstanceListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallParkGetInstanceListRequest. + + + + + + + + + + + + + + + Gets a Call Park group. + The response is either GroupCallParkGetInstanceResponse16sp2 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallParkGetInstanceRequest16sp2. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". + The users are in the table are in the order they will try to be parked on. + + The following elements are only used in AS data mode: + recallAlternateUserId + recallTo + + + + + + + + + + + + + + + + + Gets the Call Park Group settings. + The response is either GroupCallParkGetResponse16sp2 or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallParkGetRequest16sp2. + Contains the settings that apply to the whole group for Call Park. + + The following elements are only used in AS data mode: + recallAlternateUserId + recallRingPattern + recallTo + alternateUserRecallTimerSeconds + + + + + + + + + + + + + + + + + + + + + Modifies a Call Park group. Replaces the entire list of users in the group. + The users are in the list are in the order they will try to be parked on. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + recallAlternateUserId + recallTo + + + + + + + + + + + + + + + + + + + + + Modifies the Group's Call Park settings. + The response is either SuccessResponse or ErrorResponse. + + The following elements are only used in AS data mode: + recallAlternateUserId + recallRingPattern + recallTo + alternateUserRecallTimerSeconds + + + + + + + + + + + + + + + + + + + + + + + Identifies which Call Park group the user belongs to if any and the list of users in the group. + The response is either UserCallParkGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallParkGetRequest. + Identifies which Call Park group the user belongs to and the list of users in the group. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name". The users are in the table in the order they will try to be parked on. + + + + + + + + + + + + + + + + The timer determines how long the extension/DN of the parked against user is displayed. + + + + + + + + + + + + The timer determines how long a call can be parked before the parker is recalled. + + + + + + + + + + + + Call Park recall user options + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallPickup.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallPickup.xsd new file mode 100644 index 0000000..d259edf --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallPickup.xsd @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds a Call Pickup group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Deletes a Call Pickup group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of users that can be assigned to a Call Pickup group. + The available user list for a new Call Pickup group can be obtained + by not setting the name. + The response is either GroupCallPickupGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupCallPickupGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request to get a list of Call Pickup instances within a group. + The response is either GroupCallPickupGetInstanceListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallPickupGetInstanceListRequest. + + + + + + + + + + + + + + + Gets a Call Pickup group. + The response is either GroupCallPickupGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupCallPickupGetInstanceRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Modifies a Call Pickup group. Replaces the entire list of users in the group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Gets the details of the Call Pickup group that a user belongs to (if any). + Any user can only belong to one Call Pickup group. + The response is either UserCallPickupGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCallPickupGetRequest. + Identifies which Call Pickup group the user belongs to and the list of users in the group. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Department", "Phone Number", "Extension", "Email Address". + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallRecording.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallRecording.xsd new file mode 100644 index 0000000..afb22f5 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallRecording.xsd @@ -0,0 +1,504 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the Call Recording platform for a group. + The response is either a GroupCallRecordingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCallRecordingGetRequest. + The response contains the group's Call Recording platform information. + + + + + + + + + + + + + + + Modify the Call Recording platform assignment for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Add a Call Recording platform. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a Call Recording platform. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get list of Call Recording platforms. + The response is either SystemCallRecordingGetPlatformListResponse or ErrorResponse. + + The possible values for "Support Video Rec" can be either true or false. + Schema version values include: 1.0, 2.0, 3.0 + + + + + + + + + + + true + false + + + Response to SystemCallRecordingGetPlatformListRequest. + Contains the default system Call Recording platform and a table with columns headings "Name", "Net Address", "Port", "Transport Type", "Media Stream", "Description", "Schema Version", "Support Video Rec". + The system default recording platform also appears in the table with the other platforms. + + The possible values for "Support Video Rec" can be either true or false. + Schema version values include: 1.0, 2.0, 3.0 + + + + + + + + + + + + + + + + true + false + + + Get the list of groups currently associated to the specified Call Recording platform. + The response is either SystemCallRecordingGetPlatformUsageResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemCallRecordingGetPlatformUsageRequest. + The response contains a table with columns headings "Service Provider Id", "Group Id". + + + + + + + + + + + + + + + true + false + + + Modify the specified Call Recording platform. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Call Recording. + The response is either a SystemCallRecordingGetResponse or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallRecordingGetRequest. + + + + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Call Recording. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Get the Call Recording attributes for a user. + The response is either a UserCallRecordingGetResponse20 or an ErrorResponse. + + The following parameters are not returned for service instance: + - pauseResumeNotification + - enableCallRecordingAnnouncement + - enableRecordCallRepeatWarningTone + - recordCallRepeatWarningToneTimerSeconds + + + + + + + + + + + + + + + true + false + + + Response to the UserCallRecordingGetRequest20. + The response contains the user's Call Recording option information. + + The following parameters are not returned for service instance: + - pauseResumeNotification + - enableCallRecordingAnnouncement + - enableRecordCallRepeatWarningTone + - recordCallRepeatWarningToneTimerSeconds + + The enableVoiceMailRecording parameter is only returned if the Voice + Messaging User service is assigned to the user. This applies to both + users and service instances. + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the Call Recording attributes for a user. The recording options + "Always with Pause/Resume", "On Demand", and "On Demand with User + Initiated Start" are not accepted for service instances. + + The response is either a SuccessResponse or an ErrorResponse. + + The following parameters are not accepted for service + instance: + - pauseResumeNotification + - enableCallRecordingAnnouncement + - enableRecordCallRepeatWarningTone + - recordCallRepeatWarningToneTimerSeconds + + The enableVoiceMailRecording parameter is only applicable + if the Voice Messaging User service is assigned to the user. + This applies to both users and service instances. + + + + + + + + + + + + + + + + + + + + + The value in seconds specifying how often the end user + receives the warning tone that call is being recorded. + + + + + + + + + + + + Recording Service Configuration option. The Always with Pause/Resume, + On Demand, and On Demand with User Initiated Start option are not + applicable for Service Users. + + + + + + + + + + + + + + + Recording Service Play Resume Notidication Type. + + + + + + + + + + + + + The number of failure detections it takes to mark a server out of service. + + + + + + + + + + + + The value in milliseconds specifying how long to wait for a response from a server. + + + + + + + + + + + + The value in seconds specifying how long to wait before retrying a failed server. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallReturn.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallReturn.xsd new file mode 100644 index 0000000..3f15fd1 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallReturn.xsd @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Call Return. + The response is either a SystemCallReturnGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCallReturnGetRequest. + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with Call Return. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallTransfer.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallTransfer.xsd new file mode 100644 index 0000000..9b4e187 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallTransfer.xsd @@ -0,0 +1,122 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Transfer. + The response is either a UserCallTransferGetResponse14sp4 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallTransferGetRequest14sp4. + + + + + + + + + + + + + + + + + + + + Modify the user level data associated with Call Transfer. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Number of Rings until a transferred call is recalled. + + + + + + + + + + + + The allotted time for a call to camp on on busy transefer call. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallWaiting.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallWaiting.xsd new file mode 100644 index 0000000..31705ea --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallWaiting.xsd @@ -0,0 +1,156 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Call Waiting. + The response is either a UserCallWaitingGetResponse17sp4 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallWaitingGetRequest17sp4. + + The following elements are only used in AS data mode: + disableCallingLineIdDelivery + + + + + + + + + + + + + + + + Modify the user level data associated with Call Waiting. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + disableCallingLineIdDelivery + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Call Waiting. + The response is either a SystemCallWaitingGetResponse or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallWaitingGetRequest. + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Call Waiting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDBlockingOverride.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDBlockingOverride.xsd new file mode 100644 index 0000000..5db2a98 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDBlockingOverride.xsd @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Calling Line ID Blocking Override. + The response is either a UserCallingLineIDBlockingOverrideGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallingLineIDBlockingOverrideGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Calling Line ID Blocking Override. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDDeliveryBlocking.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDDeliveryBlocking.xsd new file mode 100644 index 0000000..51ca7bf --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallingLineIDDeliveryBlocking.xsd @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Calling Line ID Delivery Blocking. + The response is either a UserCallingLineIDDeliveryBlockingGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallingLineIDDeliveryBlockingGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Calling Line ID Delivery Blocking. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallingNameDelivery.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallingNameDelivery.xsd new file mode 100644 index 0000000..e5e5947 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallingNameDelivery.xsd @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Calling + Name Delivery. The response is either a + UserCallingNameDeliveryGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallingNameDeliveryGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Calling Name Delivery. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallingNameRetrieval.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallingNameRetrieval.xsd new file mode 100644 index 0000000..3cf5668 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallingNameRetrieval.xsd @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system's calling name retrieval attributes. + The response is either a SystemCallingNameRetrievalGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCallingNameRetrievalGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + + + Modifies the system's calling name retrieval attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Calling Name Retrieval. + The response is either a UserCallingNameRetrievalGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallingNameRetrievalGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Calling Name Retrieval. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Query Protocol. + + + + + + + + + + + + Query time out milli-seconds. + + + + + + + + + + + + Query Protocol. + + + + + + + + + + + + Seconds to wait before querying a failed CNAM server. + + + + + + + + + + + + Route Advance Query time out milli-seconds. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallingNumberDelivery.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallingNumberDelivery.xsd new file mode 100644 index 0000000..4501576 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallingNumberDelivery.xsd @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Calling + Name Delivery. The response is either a + UserCallingNumberDeliveryGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallingNumberDeliveryGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Calling Number Delivery. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallingPartyCategory.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallingPartyCategory.xsd new file mode 100644 index 0000000..f8d1bc6 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallingPartyCategory.xsd @@ -0,0 +1,279 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Calling Party Category to system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Delete a Calling Party Category from system. The category cannot be deleted if it is the default or is in use by any users. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of all Calling Party Category in system. + The response is either a SystemCallingPartyCategoryGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemCallingPartyCategoryGetListRequest. + Contains a table of Calling Party Category defined in system. + The column headings are: "Category Name", "User Category", "Collect Call", "Default" and "Web Display Key". + + + + + + + + + + + + + + + Get an existing Calling Party Category in system. + The response is either a SystemCallingPartyCategoryGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to SystemCallingPartyCategoryGetRequest. + Contains information of a Calling Party Category defined in system. + + + + + + + + + + + + + + + + + + + + + + + Modify a Calling Party Category in system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Calling Party Category. + The response is either a UserCallingPartyCategoryGetResponse16 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCallingPartyCategoryGetRequest16. + + + + + + + + + + + + + + + Modify the user level data associated with Calling Party Category. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Name for the Calling Party Category. + + + + + + + + + + + + Value for the Calling Party Category used in signaling. + + + + + + + + + + + + ISDN generic transparency descriptor OLI value for the Calling Party Category. + + + + + + + + + + + + ISDN user part originating line information value for the Calling Party Category. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCallingPlan.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCallingPlan.xsd new file mode 100644 index 0000000..b516404 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCallingPlan.xsd @@ -0,0 +1,145 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a new calling plan digit string. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete one or more calling plan digit strings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the list of calling plan digit strings for a group. + The response is either a GroupCallingPlanGetDigitPatternListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCallingPlanGetDigitPatternListRequest. + Contains a table with column headings: "Name", "Digit Pattern". + + + + + + + + + + + + + + + Modify a calling plan digit string. The name is a key; it cannot be changed. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Digit patterns that are used to restrict calls in the Incoming Calling Plan and Outgoing Calling Plan. + The digit pattern may contain digits 0-9,+,?, and trailing * digit. + Starting in Rel.14.sp4 digit patterns can also contain '#', and '*' digits anywhere in the string. To distinguish between a '*' as a digit from '*' as a wildcard character, a back-slash character shall be used as an escape in front of '*' being a digit. Note that '*' as a wildcard is still only allowed at the end of string. + Starting in Rel.17.sp3, the range syntax [n1-n2] is also supported, where n1 and n2 denotes a digit in the range 0 to 9. Also the maximum length is increased to 160. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceChargeNumber.xsd b/share/OCISchemaAS/Services/OCISchemaServiceChargeNumber.xsd new file mode 100644 index 0000000..075d2f3 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceChargeNumber.xsd @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Charge Number. + The response is either a UserChargeNumberGetResponse14sp9 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserChargeNumberGetRequest14sp9. + + + + + + + + + + + + + + + + + Modify the user level data associated with Charge Number. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceClassMark.xsd b/share/OCISchemaAS/Services/OCISchemaServiceClassMark.xsd new file mode 100644 index 0000000..3b29f14 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceClassMark.xsd @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Class Mark to system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a Class Mark from system. It cannot be deleted if it is in use by any users. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of all Class Mark in system. + The response is either a SystemClassmarkGetListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemClassmarkGetListRequest. + Contains a table of with the column headings: "Class Mark", "Value" and "Web Display Key". + + + + + + + + + + + + + + + Modify a Class Mark in system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the list of all users associated with a Class Mark in system. It is possible to search by various criteria. + Multiple search criteria are logically ANDed together. + The response is either a SystemClassmarkGetUtilizationListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Response to SystemClassmarkGetUtilizationListRequest. + Contains a table with the column headings: "User Id", "Group Id", "Service Provider Id", + "Last Name", "First Name", and "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request the Class Mark data associated with User. + The response is either a UserClassmarkGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserClassmarkGetRequest. + Contains the Class Mark data + + + + + + + + + + + + + + + Modify the user level data associated with Class Mark. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Name for the Class Mark. + + + + + + + + + + + + Value for the Class Mark used in signaling. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCollaborate.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCollaborate.xsd new file mode 100644 index 0000000..9238224 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCollaborate.xsd @@ -0,0 +1,1092 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a collaborate bridge to a group. + The domain is required in the serviceUserId. + The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a collaborate bridge from a group. + The request fails when attempting to delete the default collaborate bridge. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get a list of users with the Collaborate – Audio service assigned that can be assigned to a collaborate bridge. For an Enterprise Group this will include all users in the group’s enterprise. + The SearchCriteriaExactUserGroup parameter is only applicable for enterprise groups. + The response is either GroupCollaborateBridgeGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupCollaborateBridgeGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + true + false + + + Get a list of collaborate bridges within a group. + The response is either GroupCollaborateBridgeGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupCollaborateBridgeGetInstanceListRequest. + Contains a table with column headings: "Service User Id", "Name", "Phone Number", "Extension", "Department", "Participants", and "Is Default". + The column values for "Is default" can either be true, or false. + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a collaborate bridge. + The response is either GroupCollaborateBridgeGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupCollaborateBridgeGetInstanceRequest. + The system-level collaborate supportOutdial setting is returned in the response when the system-level collaborate + supportOutdial setting is disabled. + Contains the service profile information and a table of assigned owners. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", Phone Number", "Extension", "Department", "Email Address". + Collaborate bridge maximum participant’s choices unlimited or a quantified number of participants. + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a Collaborate bridge. + The request fails when the collaborateOwnerUserIdList is included in the request for the default collaborate bridge. + The request fails when the supportOutdial is included in the request and the system-level collaborate supportOutdial setting is disabled. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with collaborate services. + The response is either a SystemCollaborateGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemCollaborateGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with collaborate services. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the collaborate bridged assigned to the user. The user can only be assigned to one collaborate bridge at any given time. + The response is either UserCollaborateBridgeGetResponse or + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + The system-level collaborate supportOutdial setting is returned in the response when the system-level collaborate supportOutdial setting is disabled. + Response to UserCollaborateBridgeGetRequest. + + + + + + + + + + + + + + + + + + + + + true + false + + + Request collaborate instant room settings. + The response is either UserCollaborateInstantRoomParametersGetResponse or + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateInstantRoomParametersGetRequest. + + + + + + + + + + + + + + + + + true + false + + + Request to modify collaborate instant room settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to add collaborate project room. + The response is either a UserCollaborateProjectRoomAddResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateProjectRoomAddRequest. + + + + + + + + + + + + + + + true + false + + + Request to add collaborate instant room. + The response is either a UserCollaborateInstantRoomAddResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateInstantRoomAddRequest. + + + + + + + + + + + + + + + true + false + + + Request to delete a collaborate room. The request only applies to project rooms and instant rooms. + The request fails when deleting a collaborate My Room. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request collaborate room settings for MyRoom. + The response is either UserCollaboratMyRoomGetResponse or + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateMyRoomGetRequest. + + + + + + + + + + + + + + + + + + + true + false + + + Request collaborate room settings for a project room. + The request fails when requesting collaborate room settings for instant rooms or My Room. + The response is either UserCollaboratProjectRoomGetResponse or + ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateProjectRoomGetRequest. + + + + + + + + + + + + + + + + + + + true + false + + + Request the collaborate room settings for an instant room. + The request fails when requesting collaborate room settings for My Room or project rooms. + The response is either UserCollaboratInstantRoomGetResponse or + ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateInstantRoomGetRequest. + + + + + + + + + + + + + + + + + true + false + + + Request to modify collaborate room settings for MyRoom. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify collaborate room settings for a project room. + The request fails when modifying collaborate room settings for instant rooms or My Room. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to regenerate collaborate room id for MyRoom and project room. + The request fails when requesting to regenerate room ID for an instant room. + The response is either a UserCollaborateRoomIDRegenerateResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateRoomIDRegenerateRequest. + + + + + + + + + + + + + + + true + false + + + Request the list of collaborate room instances for this specific user. + The response is either a UserCollaborateRoomListGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserCollaborateRoomListGetRequest. + Contains a table with column headings : "Room Type", "Name", "Room Id", + in a row for each collaborate room instance. + Possible values for Room Type column are MyRoom, Project Room and + Instant Room. + + + + + + + + + + + + + + + The Interval in seconds at which, the UVS will refresh and notify active talker details.. + + + + + + + + + + + + Maximum number of Collaborate bridge participants. Can either be unlimited or limited to a value between 3 and 999999. + + + + + + + + + + + + + + + + + + + + Collaborate bridge name. + + + + + + + + + + + + Collaborate grace period duration. + + + + + + + + + + + + Collaborate grace period duration minutes. + + + + + + + + + + + The expiration period in seconds for an instant room to exist. + + + + + + + + + + + + The time in seconds the instant room lives without a participant, the wait + time for the first participant to join and the wait time after the last + participant leaves the collaborate room. + + + + + + + + + + + + Length of the collaborate room Id. + + + + + + + + + + + + Choices for the notification when attendees join or leave the collaborate room session. + + + + + + + + + + + + Collaborate room id. + + + + + + + + + + + + Maximum number of collaborate room participants. + + + + + + + + + + + + Collaborate room name. + + + + + + + + + + + + Collaborate room schedule. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Collaborate room schedule duration. + + + + + + + + + + + + Collaborate room schedule duration minutes. + + + + + + + + + + + Choices for collaborate room type + + + + + + + + + + + + + The time in minutes of the maximum duration of the collaborate room session. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCommPilotCallManager.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCommPilotCallManager.xsd new file mode 100644 index 0000000..f36cd43 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCommPilotCallManager.xsd @@ -0,0 +1,155 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with CommPilot Call Manager. + The response is either a GroupCommPilotCallManagerGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupCommPilotCallManagerGetRequest. + + + + + + + + + + + + + + + Modify the group level data associated with CommPilot Call Manager. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the user level data associated with CommPilot Call Manager. + The response is either a UserCommPilotCallManagerGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserCommPilotCallManagerGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with CommPilot Call Manager. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Choices for commPilot call manager group directory display. + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpress.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpress.xsd new file mode 100644 index 0000000..b5e942c --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpress.xsd @@ -0,0 +1,314 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's commPilot express service setting. + The response is either a UserCommPilotExpressGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCommPilotExpressGetRequest. + + + + + + + + + + + + + + + + + + + Modify the user's commPilot express service setting. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + + + + + + CommPilot Express Available In Office Settings. + + + + + + + + + + + + + CommPilot Express Available In Office Settings. + + + + + + + + + + + + + CommPilot Express Available Out Of Office Configuration used in the context of a get. + + + + + + + + + + + + CommPilot Express Available Out Of Office Configuration used in the context of a modify. + + + + + + + + + + + + CommPilot Express Available In Office Configuration used in the context of a get. + + + + + + + + + + + + CommPilot Express Available In Office Configuration used in the context of a modify. + + + + + + + + + + + + CommPilot Express Unavailable Configuration used in the context of a get. + + + + + + + + + + + + CommPilot Express Unavailable Configuration used in the context of a modify. + + + + + + + + + + + + CommPilot Express Email Notify configuration used in the context of a get. + + + + + + + + + + + + CommPilot Express Email Notify configuration used in the context of a modify. + + + + + + + + + + + + CommPilot Express Profile Type. + + + + + + + + + + + + + + CommPilot Express Voice Messaging Greeting Choices. + + + + + + + + + + + + CommPilot Express Transfer or Forward Options. + + + + + + + + + + + + CommPilot Express type to transfer to voice Mail or forward to a number + used in the context of a get. + + + + + + + + + + + + CommPilot Express type to transfer to voice Mail or forward to a number + used in the context of a modify. + + + + + + + + + + + + CommPilot Express type to transfer to voice mail or forward to a number + with certain exceptions used in the context of a get. + + + + + + + + + + + + + + + CommPilot Express type to transfer to voice mail or forward to a number + with certain exceptions used in the context of a modify. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpressSR.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpressSR.xsd new file mode 100644 index 0000000..065b59d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpressSR.xsd @@ -0,0 +1,365 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's commPilot express SR service setting. + The response is either a UserCommPilotExpressSRGetResponse13mp16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCommPilotExpressSRGetRequest13mp16. + + + + + + + + + + + + + + + + + + + Modify the user's commPilot express SR service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + CommPilot Express SR Available In Office Settings used in the context of a get. + + + + + + + + + + + + + CommPilot Express SR Available In Office Settings used in the context of a modify. + + + + + + + + + + + + + CommPilot Express SR Available Out Of Office Configuration used in the context of a get. + + + + + + + + + + + + + CommPilot Express SR Available Out Of Office Configuration used in the context of a modify. + + + + + + + + + + + + + CommPilot Express SR Available In Office Configuration used in the context of a get. + + + + + + + + + + + + CommPilot Express SR Available In Office Configuration used in the context of a modify. + + + + + + + + + + + + CommPilot Express SR Unavailable Configuration used in the context of a get. + + + + + + + + + + + + CommPilot Express SR Unavailable Configuration used in the context of a modify. + + + + + + + + + + + + CommPilot Express SR Email Notify configuration used in the context of a get. + + + + + + + + + + + + CommPilot Express SR Email Notify configuration used in the context of a modify. + + + + + + + + + + + + CommPilot Express SR No Answer Settings used in the context of a get. + + + + + + + + + + + + + CommPilot Express SR No Answer Settings used in the context of a modify. + + + + + + + + + + + + + CommPilot Express SR Number Of Rings. + + + + + + + + + + + + CommPilot Express SR Profile Type. + + + + + + + + + + + + + + CommPilot Express SR Transfer or Forward Options. + + + + + + + + + + + + CommPilot Express SR type to transfer to voice Mail or forward to a number + used in the context of a get. + + + + + + + + + + + + CommPilot Express SR type to transfer to voice Mail or forward to a number + used in the context of a modify. + + + + + + + + + + + + CommPilot Express SR type to transfer to voice mail or forward to a number + with certain exceptions used in the context of a get. + + + + + + + + + + + + + + + CommPilot Express SR type to transfer to voice mail or forward to a number + with certain exceptions used in the context of a modify. + + + + + + + + + + + + + + + CommPilot Express SR Forward Number Entry with number of times to ring. + + + + + + + + + + + + CommPilot Express SR Forward Numbers with number of times to ring. + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCommunicationBarringUserControl.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCommunicationBarringUserControl.xsd new file mode 100644 index 0000000..b9c275e --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCommunicationBarringUserControl.xsd @@ -0,0 +1,182 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the Communication Barring system level settings. + The response is either SystemCommunicationBarringUserControlGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to the SystemCommunicationBarringUserControlGetRequest. + Contains the settings to whole system for Communication Barring User-Control + + + + + + + + + + + + + + + + + Modifies the system's Communication Barring User-Control settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Lists the Communication Barring profiles available to a user and + indicates which profile if any is currently active for the user.. + The response is either UserCommunicationBarringUserControlGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCommunicationBarringUserControlGetRequest. + Identifies the profiles available to the user and which one if any + is active as well as the lockout status. + Contains a table with column headings: "Name", "Code", "Activated" and "Primary". + + + + + + + + + + + + + + + + Enabling a profile automatically disables the currently active profile. + Also allows the passcode for the service to be modified and the lockout to be reset. + Admins only need to populate the newPasscode field when changing the passcode. + Users must populate both the oldPasscode and new Passcode fields when changing the passcode. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Communication Barring User-Control lockout time in minutes. + + + + + + + + + + Communication Barring User-Control number of attempts to get pin code correct. + + + + + + + + + + Communication Barring Profile code identifying a profile within a Network Class of Service. + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCommunicator.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCommunicator.xsd new file mode 100644 index 0000000..336260d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCommunicator.xsd @@ -0,0 +1,118 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get Configuration Server for a specified service + provider. The response is either a ServiceProviderBroadWorksCommunicatorGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderBroadWorksCommunicatorGetRequest. + + + + + + + + + + + + + + + Request to modify the Configuration URL. The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to get the Configuration Server for a specified user. + The response is either a UserBroadWorksCommunicatorGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserBroadWorksCommunicatorGetRequest. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationPresentation.xsd b/share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationPresentation.xsd new file mode 100644 index 0000000..c32ee66 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationPresentation.xsd @@ -0,0 +1,88 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with the COLP service. + The response is either a + SystemConnectedLineIdentificationPresentationGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemConnectedLineIdentificationPresentationGetRequest. + + + + + + + + + + + + + + + Modify the system level data associated with the COLP Service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationRestriction.xsd b/share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationRestriction.xsd new file mode 100644 index 0000000..6ca50e2 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceConnectedLineIdentificationRestriction.xsd @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Connected Line ID Restriction. + The response is either a UserConnectedLineIdentificationRestrictionGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserConnectedLineIdentificationRestrictionGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Connected Line ID Restriction. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCustomRingback.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCustomRingback.xsd new file mode 100644 index 0000000..db21196 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCustomRingback.xsd @@ -0,0 +1,294 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the group's custom ring back service settings. + The response is either a GroupCustomRingbackGroupGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupCustomRingbackGroupGetRequest20. + + + + + + + + + + + + + + + + + + + + + Modify the group's custom ring back service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's custom ringback service. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's custom ringback service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the user's custom ringback service criteria listing. + The response is either a UserCustomRingbackUserGetCriteriaListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserCustomRingbackUserGetCriteriaListRequest. + The criteria table's column headings are: "Is Active", "Criteria Name", + "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + Get a criteria for the user's custom ringback service. + The response is either a UserCustomRingbackUserGetCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserCustomRingbackUserGetCriteriaRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the user's custom ringback service criteria's active setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a criteria for the user's custom ringback service. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceCustomerOriginatedTrace.xsd b/share/OCISchemaAS/Services/OCISchemaServiceCustomerOriginatedTrace.xsd new file mode 100644 index 0000000..86179e5 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceCustomerOriginatedTrace.xsd @@ -0,0 +1,86 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Customer Originated Trace. + The response is either a SystemCustomerOriginatedTraceGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemCustomerOriginatedTraceGetRequest. + + + + + + + + + + + + + + + Modify the system level data associated with Customer Originated Trace. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceDirectedCallPickupWithBargeIn.xsd b/share/OCISchemaAS/Services/OCISchemaServiceDirectedCallPickupWithBargeIn.xsd new file mode 100644 index 0000000..76dad6d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceDirectedCallPickupWithBargeIn.xsd @@ -0,0 +1,92 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Directed Call Pickup With Barge In. + The response is either a UserDirectedCallPickupWithBargeInGetResponse14sp7 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserDirectedCallPickupWithBargeInGetRequest14sp7. + + + + + + + + + + + + + + + + Modify the user level data associated with Directed Call Pickup With Barge In. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceDirectoryNumberHunting.xsd b/share/OCISchemaAS/Services/OCISchemaServiceDirectoryNumberHunting.xsd new file mode 100644 index 0000000..f7d7d24 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceDirectoryNumberHunting.xsd @@ -0,0 +1,136 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the agents of a call center or hunt group that are available + to be assigned to a directory number hunting group. They are agents that + are not already assigned to any other directory number hunting group. + The response is either + GroupDirectoryNumberHuntingGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupDirectoryNumberHuntingGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request to get the properties of the DNH service for a specified serviceUserId. + It gets the agents of a call center or hunt group that are members + of a directory number hunting group. They are agents that are not already + assigned to any other directory number hunting group. + The response is either GroupDirectoryNumberHuntingGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupDirectoryNumberHuntingGetRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + + Replaces a list of users as agents for a directory number hunting group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceDoNotDisturb.xsd b/share/OCISchemaAS/Services/OCISchemaServiceDoNotDisturb.xsd new file mode 100644 index 0000000..6b3987d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceDoNotDisturb.xsd @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Do Not Disturb. + The response is either a UserDoNotDisturbGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserDoNotDisturbGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Do Not Disturb. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceDualModeVCC.xsd b/share/OCISchemaAS/Services/OCISchemaServiceDualModeVCC.xsd new file mode 100644 index 0000000..a0bde6f --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceDualModeVCC.xsd @@ -0,0 +1,100 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the user level Dual Mode VCC service attributes + Response is either UserDualModeVCCGetResponse or ErrorResponse + + + + + + + + + + + + + + + Response to UserDualModeVCCGetRequest + + + + + + + + + + + + + + + Request to modify the user level IN Integration service attributes + Response is either UserINIntegrationGetResponse or ErrorResponse + + + + + + + + + + + + + + + + + Dual Mode VCC Service subscriber user name + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceEmergencyZones.xsd b/share/OCISchemaAS/Services/OCISchemaServiceEmergencyZones.xsd new file mode 100644 index 0000000..f806f6b --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceEmergencyZones.xsd @@ -0,0 +1,278 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a list of home zones and/or home zone ranges to the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a list of home zones and/or home zone ranges to the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the group level data associated with Emergency Zones. + The response is either a GroupEmergencyZonesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupEmergencyZonesGetHomeZoneListRequest. + + + + + + + + + + + + + + + + Request the group level data associated with Emergency Zones. + The response is either a GroupEmergencyZonesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupEmergencyZonesGetRequest. + + + + + + + + + + + + + + + + + + Modify a list of home zones and/or home zone ranges. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group level data associated with Emergency Zones. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Emergency Zones. + The response is either a SystemEmergencyZonesGetResponse or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemEmergencyZonesGetRequest. + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Emergency Zones. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Emergency zone policy to specify what kind of calls will be prohibited by the service when + originated from outside the home zone. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceEnhancedCallLogs.xsd b/share/OCISchemaAS/Services/OCISchemaServiceEnhancedCallLogs.xsd new file mode 100644 index 0000000..e7eca49 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceEnhancedCallLogs.xsd @@ -0,0 +1,946 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request users' call logs within an enterprise + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either an EnterpriseEnhancedCallLogsGetListResponse21 or an ErrorResponse. + The following elements are only used in AS data mode and ignored in HSS data mode: + callAuthorizationCodeFilter + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterpriseEnhancedCallLogsGetListRequest21. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the EnterpriseEnhancedCallLogsGetListRequest21, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry21 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The result is sorted by date/time of the call. + + + + + + + + + + + + + + + + Request users' call logs within a group + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + It is possible to restrict the number of rows returned using responsePagingControl.If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a GroupEnhancedCallLogsGetListResponse21 or an ErrorResponse. + The following elements are only used in AS data mode and ignored in HSS data mode: + callAuthorizationCodeFilter + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupEnhancedCallLogsGetListRequest21. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the GroupEnhancedCallLogsGetListRequest21, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of ExtendedMixedCallLogsEntry21 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned. + The logs are sorted by date/time of the call. + + + + + + + + + + + + + + + + Get the service provider's enhanced call log settings. + The response is either a ServiceProviderEnhancedCallLogsGetResponse17sp4 or an ErrorResponse. + This command will return an ErrorResponse if DBS is used as the call log server. + + + + + + + + + + + + + + + Response to ServiceProviderEnhancedCallLogsGetRequest17sp4. + + + + + + + + + + + + + + + + Modify the Service Provider level data associated with Enhanced Call Logs. + Configures the maximum number of logged calls and maximum age of your user's call logs. + Log entries are deleted when either of the two limits is reached. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the system level data associated with Enhanced Call Logs. The response is either a + SystemEnhancedCallLogsGetResponse20sp1 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemEnhancedCallLogsGetRequest20sp1. + The following elements are only used in AS data mode: + isSendEnabled + server1NetAddress + server1SendPort + server1RetrievePort + server2NetAddress + server2SendPort + server2RetrievePort + sharedSecret + retransmissionDelayMilliSeconds + maxTransmissions + soapTimeoutSeconds + useDBS + eclQueryApplicationURL + eclQueryDataRepositoryURL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with Enhanced Call Logs. + The response is either a SuccessResponse or an ErrorResponse. + The following elements are only used in AS data mode: + isSendEnabled + server1NetAddress + server1SendPort + server1RetrievePort + server2NetAddress + server2SendPort + server2RetrievePort + sharedSecret + retransmissionDelayMilliSeconds + maxTransmissions + soapTimeoutSeconds + useDBS + eclQueryApplicationURL + eclQueryDataRepositoryURL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to SystemEnhancedCallLogsSchemaInstanceGetListRequest. + Contains a table with column headings: "Instance Name", "Actual Users", "Potential Users". + + + + + + + + + + + + + + + Request user's call logs. + If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. + The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When + "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including + placed will be returned. + It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl + is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control + the maximum number of call logs can be returned. + The response is either a UserEnhancedCallLogsGetListResponse21 or an ErrorResponse. + The following elements are only used in AS data mode and ignored in HSS data mode: + callAuthorizationCodeFilter + + + + + + + + + + + + + + + + + + + + + + + Response to UserEnhancedCallLogsGetListRequest21. + Total numbers of rows is: + - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest21, + if a call log type was specified in the request. + - the total number of retrievable logs, if no call log type was specified in the request. + A list of MixedCallLogsEntry will be returned if the call logs are stored on CDS + A list of ExtendedMixedCallLogsEntry21 will be returned if the call logs are stored on DBS + The logs are sorted by date/time of the call. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The maximum length of time the system will store logged calls. + + + + + + + + + + + + Sets the maximum number of logged calls that can be stored. + + + + + + + + + + + + Maximum transmissions. + + + + + + + + + + + + The maximum number of call log entries to return when paging information is + not specified in the request. + + + + + + + + + + + + Filter criteria based on the called number or number called. + + + + + + + + + + + + + + + + + + + Outgoing call center dnis name. In the format of call center id + ":" + DNIS name. + + + + + + + + + + + + Filter criteria based on the transferred/forwarded number. + + + + + + + + + + + + + + + + + + + Redirected call selection. + When " redirectedCall " is set to true, all call logs with redirected call are returned. When it + set to false, all call logs without redirected call are returned. + The redirected call can be defined by including a subset of Service Invocation Disposition here. + If none included, any call has a ServiceInvocationDisposition value defined in ServiceInvocationDisposition + is considered as a redirected call. + + + + + + + + + + + + Filter criteria based on the account code. + When "callsWithCodes" is set to true, all call logs with account/authorization codes are returned. + When it set to false, all call logs without account/authorization codes are returned. + + + + + + + + + + + + + + Filter criteria based on call authorization code. Note that this code + filter is different than EnhancedCallLogsAccountAuthorizationCodeFilter, + which applies strictly to codes entered using the account/authorization + code service. + When "callsWithCodes" is set to true, all call logs with authorization + codes are returned. + When it set to false, all call logs without authorization codes are + returned. + If "authorizationCode" is set, all call logs matching that specific + authorization code are returned. + + + + + + + + + + + + + + Retransmission delay in milli-seconds. + + + + + + + + + + + Shared Secret. + + + + + + + + + + + Timeout when retrieving enhanced call logs through the SOAP interface. + + + + + + + + + + + + Time range used to filter call logs. + + + + + + + + + + + + Extended Call Log entry describing a placed, received, or missed call. + "countryCode" is the user's country code + The following time elements are represented as timestamp, i.e., the number of milliseconds + since January 1, 1970, 00:00:00 GMT. + "startTime" represents the time when the system sends out a call invitation message (e.g. for + placed calls) or receives a call invitation message (e.g. for missed/received calls). + "answerTime" represents the time when the call is answered by the terminating party. + "detachedTime" represents the time when the call is successfully redirected by the system. + "releaseTime" represents the time when the call is released. This time corresponds to the + moment the call is released by the system, and not necessarily when one party hangs up, since this + does not always mean the call is released (e.g. Emergency/911 calls). + The elements "userGroupId", "userId","userPrimaryDn" and "userPrimaryExtension" + are only returned when the enterprise or group level requests are used. + The following elements are only used in AS data mode: + callAuthorizationCode + securityClassification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The call Id of a call associated a this call log entry + + + + + + + + + + + + Identifies the source of the number used in the Calling Presentation Number field + + + + + + + + + + + + + + + + + Presentation Indicator + + + + + + + + + + + + + + + + Connected Number Type + + + + + + + + + + + + + + The Type of Network for the call provided in the most significant contact from the NS + + + + + + + + + + + + The Call Category for the call provided in the most significant contact from the NS + + + + + + + + + + + + + + + + + + The basic call type for the origination + + + + + + + + + + + + + + + + Indicates the type of service invocation that caused the call to be detached. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The presentation indicator for the last redirecting party + + + + + + + + + + + + + + The reason for the redirection by the last redirecting party + + + + + + + + + + + + Maximum number of rows to return in response to a paging request for enhanced call logs + + + + + + + + + + + + Used in enhanced call logs group and enterprise queries to restrict the set of result + rows when making a request that can result in a large dataset. The client specifies the + starting row and the number of rows requested. + The server only provides those rows in results, if available. + + + + + + + + + + + + Subscriber type + + + + + + + + + + + + + + + + + + + Call Log type used by enhanced call logs requests + + + + + + + + + + + + + + Calling Name. + + + + + + + + + + + + Criteria for searching for a phone number or SIPURI. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceExecutive.xsd b/share/OCISchemaAS/Services/OCISchemaServiceExecutive.xsd new file mode 100644 index 0000000..a11df68 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceExecutive.xsd @@ -0,0 +1,705 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the Executive system parameters. + The response is either SystemExecutiveGetResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemExecutiveGetRequest. + + + + + + + + + + + + + + + true + false + + + Request to modify the Executive system parameters. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Add a filtering criteria to an executive user. + Both executive and the executive assistant can run this command. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a filtering criteria from an executive user. + Both executive and the executive assistant can run this command. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get a list of users that can be assigned to an executive. + Searching for users by group only makes sense when the executive user is part of an Enterprise. + The response is either UserExecutiveGetAvailableAssistantListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserExecutiveGetAvailableAssistantListResponse. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department" and "Email Address". + + + + + + + + + + + + + + + true + false + + + Get the assistant setting and the list of assistants assigned to an executive. + The response is either UserExecutiveGetAssistantsResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserExecutiveGetAssistantsRequest. + Contains the assistant setting and a table of assigned assistants. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address" and "Opt-in". + The possible values for "Opt-in" column are "true" and "false". + + + + + + + + + + + + + + + + true + false + + + Get the filtering setting and the list of filtering criteria defined for an executive user. + Both executive and the executive assistant can run this command. + The response is either UserExecutiveGetFilteringResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserExecutiveGetFilteringRequest. + Contains the filtering setting and a table of filtering criteria. + The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", + "Filter", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The "Filter" column can contain "true" or "false". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + + + + true + false + + + Get a filtering criteria for an executive user. + Both executive and the executive assistant can run this command. + The response is either UserExecutiveGetSelectiveCriteriaResponse21 or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the UserExecutiveGetFilteringSelectiveCriteriaRequest21. + + + + + + + + + + + + + + + + + + + true + false + + + Get the screening and alerting setting of an executive. Both executive and the executive assistant can run this command. + The response is either UserExecutiveGetScreeningAlertingResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserExecutiveGetScreeningAlertingRequest. + Contains the screening and alerting settings for an executive. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify the assistant setting and the list of assistants assigned to an executive user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Modify the filtering setting for an executive user. + Both executive and the executive assistant can run this command. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Modify a filtering selective criteria for an executive. + Both executive and the executive assistant can run this command. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the screening and alerting setting of an executive. + Both executive and the executive assistant can run this command. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Executive alerting calling line Id name mode. + + + + + + + + + + + + + + + Executive alerting calling line Id phone number mode. + + + + + + + + + + + + + Executive alerting custom calling line Id name. + + + + + + + + + + + + Executive alerting mode. + + + + + + + + + + + + Eecutive call filtering criteria selection for a dn. + + + + + + + + + + + + + + The from dn criteria used within an executive call filtering criteria add/get request. + + + + + + + + + + + + + + The from dn criteria used within an executive call filtering criteria modify request. + + + + + + + + + + + + + + Executive call filtering mode. + + + + + + + + + + + + Executive call filtering filter type in simple filtering mode. + + + + + + + + + + + + + Number of rings to wait before starting the call push recall. + + + + + + + + + + + + Number of rings to wait before advancing to next assistant. + + + + + + + + + + + + Executive rollover action. + + + + + + + + + + + + + Number of seconds to wait before rollover to next assistant. + + + + + + + + + + + + Executive screening alert type. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceExecutiveAssistant.xsd b/share/OCISchemaAS/Services/OCISchemaServiceExecutiveAssistant.xsd new file mode 100644 index 0000000..d4014de --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceExecutiveAssistant.xsd @@ -0,0 +1,121 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the setting of an executive assistant. + The response is either UserExecutiveAssistantGetResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserExecutiveAssistantGetRequest. + Contains the executive assistant setting and a table of executives this assistant has been assigned to. + The criteria table's column headings are: "User Id", "Last Name", "First Name", ", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", + "Assistant Opt-in Status" and "Executive Allow Opt-in". + The possible values for "Assistant Opt-in Status" and "Executive Allow Opt-in" columns are "true" and "false". + + + + + + + + + + + + + + + + + true + false + + + Modify the setting for executive assistant. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Executive assistant Opt-in status with executive. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceExternalCallingLineIDDelivery.xsd b/share/OCISchemaAS/Services/OCISchemaServiceExternalCallingLineIDDelivery.xsd new file mode 100644 index 0000000..7e3b9e9 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceExternalCallingLineIDDelivery.xsd @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with External Calling Line ID Delivery. + The response is either a UserExternalCallingLineIDDeliveryGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserExternalCallingLineIDDeliveryGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with External Calling Line ID Delivery. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceExternalCustomRingback.xsd b/share/OCISchemaAS/Services/OCISchemaServiceExternalCustomRingback.xsd new file mode 100644 index 0000000..9ce2e96 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceExternalCustomRingback.xsd @@ -0,0 +1,191 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with External Custom Ringback. + The response is either a ServiceProviderExternalCustomRingbackGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderExternalCustomRingbackGetRequest. + + + + + + + + + + + + + + + + + + Modify the service provider level data associated with External Custom Ringback. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request the user level data associated with External Custom Ringback. + The response is either a UserExternalCustomRingbackGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserExternalCustomRingbackGetRequest. + + + + + + + + + + + + + + + + + Modify the user level data associated with External Custom Ringback. + The user SIP URI, when selected, it replaces the SP address, port and prefix. + The user SIP URI, if selected, is the Request URI of the SIP INVITE sent + to the external server. When the service provider data is used instead, + the Request URI is constructed using the prefix, address, port and the user DN. + The timeout value is the only SP configuration used when the user SIP URI is selected. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Prefix digits prepended to the address to reach the external ringback server. + + + + + + + + + + + + Choices for the External Custom Ringback feature to decide which type of settings to use. + + + + + + + + + + + + Time to wait for any External Media Server to reply with custom ringback. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceFaxMessaging.xsd b/share/OCISchemaAS/Services/OCISchemaServiceFaxMessaging.xsd new file mode 100644 index 0000000..778d6ab --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceFaxMessaging.xsd @@ -0,0 +1,93 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Fax Messaging. + The response is either a UserFaxMessagingGetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserFaxMessagingGetRequest17sp1. + + + + + + + + + + + + + + + + + + Modify the user level data associated with Fax Messaging. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceFindMeFollowMe.xsd b/share/OCISchemaAS/Services/OCISchemaServiceFindMeFollowMe.xsd new file mode 100644 index 0000000..503305b --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceFindMeFollowMe.xsd @@ -0,0 +1,560 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add an alerting group to a Find-me/Follow-me instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the Find-me/Follow-me alerting group. + For the callToNumber, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Add a Find-me/Follow-me instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Get a list of users that can be assigned to a Find-me/Follow-me alerting group. + The response is either GroupFindMeFollowMeAlertingGroupGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupFindMeFollowMeAlertingGroupGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Delete an alerting group from a Find-me/Follow-me instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete a criteria from the Find-me/Follow-me alerting group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Delete a Find-me/Follow-me instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get a list of Find-me/Follow-me alerting groups within a group. + The response is either GroupFindMeFollowMeGetAlertingGroupListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupFindMeFollowMeGetAlertingGroupListRequest. + Contains a table with column headings: + "Name", "Priority". + + + + + + + + + + + + + + + Request to get all the information of a Find-me/Follow-me alerting group. + The response is either GroupFindMeFollowMeGetAlertingGroupResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupFindMeFollowMeGetAlertingGroupRequest. + Contains the alerting group information. + The user table’s column headings are: "User Id", "Last Name", "First Name", "Hiragana Last Name" and "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". + The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule"", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + + + + + + + Request to get all the information of a specific Find-me/Follow-me alerting group selective criteria. + The response is either GroupFindMeFollowMeGetAlertingGroupResponse21 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest21. + Contains the alerting group selective criteria information. + + + + + + + + + + + + + + + + + + + Get a list of Find-me/Follow-me instances within a group. + The response is either GroupFindMeFollowMeGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + Response to the GroupFindMeFollowMeGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active". + The column value for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + Request to get all the information of a Find-me/Follow-me instance. + The response is either GroupFindMeFollowMeGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupFindMeFollowMeGetInstanceRequest19sp1. + Contains the service profile information. + + + + + + + + + + + + + + + + Request to set the active status of Find-me/Follow-me instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Modify the priorities assigned to alerting groups + The response is either a SuccessResponse or an ErrorResponse. + NOTE: The command fails if all the alerting groups defined for the user are not provided. + + + + + + + + + + + + + + + + Modify a Find-me/Follow-me alerting group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Modify a Find-me/Follow-me alerting group criteria. + For the callToNumbers in the callToNumberList, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Request to modify a Find-me/Follow-me instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Find-me/Follow-me alerting group description. + + + + + + + + + + + + Find-me/Follow-me alerting group name. + + + + + + + + + + + + Number of rings to wait for the current alerting group to answer before attempting the next alerting group. + + + + + + + + + + + + A list of phone numbers/sipuris or user ids that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceFlexibleSeatingGuest.xsd b/share/OCISchemaAS/Services/OCISchemaServiceFlexibleSeatingGuest.xsd new file mode 100644 index 0000000..23dc723 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceFlexibleSeatingGuest.xsd @@ -0,0 +1,632 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the list of access devices available for assignment to a flexible + seating host or guest. The list includes devices created at the system, service + provider, and group levels that support device management. + The response is either GroupFlexibleSeatingAccessDeviceGetListResponse or + ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupFlexibleSeatingAccessDeviceGetListRequest + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a list of flexible seating host instances within a group. + The response is either GroupFlexibleSeatingHostGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupFlexibleSeatingHostGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active". + The column value for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + true + false + + + Request to set the active status of flexible seating host instances. Host cannot be disabled when a flexible seating guest is associated. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Add a flexible seating host instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a flexible seating host instance from a group. Host cannot be deleted when a guest is associated to a host. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a flexible seating host instance. + The response is either GroupFlexibleSeatingHostGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupFlexibleSeatingHostGetInstanceRequest. + Contains the service profile and access device information. + + + + + + + + + + + + + + + + + + true + false + + + Request to modify a flexible seating host instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Get a flexible seating host’s routing policies + The response is either a GroupFlexibleSeatingHostRoutingPoliciesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the GroupFlexibleSeatingHostRoutingPoliciesGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify a flexible seating host’s routing policies + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request the flexible seating host guest association details. + The response is either a GroupFlexibleSeatingHostGuestAssociationGetResponse or an ErrorResponse. +accessLevel is always set to Group for a Service Provider + + + + + + + + + + + + + + + true + false + + + Response to GroupFlexibleSeatingHostGuestAssociationGetRequest. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the flexible seating host’s guest association attributes. + The request fails if enforceAssociationLimit or associationLimitHours are changed when the host is associated to a guest. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + true + false + + + Get a list of hosts that can be assigned to flexible seating guests. + The response is either UserFlexibleSeatingGuestGetAvailableUserListResponse or ErrorResponse. The response will include active hosts based on the following criteria. +- host that has the equivalent device type as the guest, host already assigned to another guest and for a guest in a Service Provider host in the user’s group and for a user in an Enterprise a host within the user’s group and host in the user’s enterprise that has the accessLevel set to Enterprise. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserFlexibleSeatingGuestGetAvailableHostListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "Association Limit Hours", "Enable Association Limit", + + + + + + + + + + + + + + + true + false + + + Request the user level data associated with flexible seating guest. + The response is either a UserFlexibleSeatingGuestGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserFlexibleSeatingGuestGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the user level data associated with flexible seating guest. + accessDeviceEndpoint can only be configured by group or a higher level administrator. + The request fails if isActive is set to false and the guest is associated to a host. + The request fails when enableAssociationLimit, associationLimitHours, unlockPhonePINCode are changed when the guest is associated to a host. + The request fails when accessDeviceEndpoint is set in the request when the guest is associated to a host. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Access level of a flexible seating host + + + + + + + + + + + + Maximum time limit for flexible seating guest association to flexible seating host + + + + + + + + + + + + Flexible seating guest unlock phone PIN code + + + + + + + + + + + + Service Profile Information for a flexible seating host. + + + + + + + + + + + + + + + + + + + + + + Service Profile Information for a flexible seating host + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceGroupNightForwarding.xsd b/share/OCISchemaAS/Services/OCISchemaServiceGroupNightForwarding.xsd new file mode 100644 index 0000000..65c84d5 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceGroupNightForwarding.xsd @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to get the Group Night Forwarding system parameters. + The response is either SystemGroupNightForwardingGetResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemGroupNightForwardingGetRequest. + + + + + + + + + + + + + + + true + false + + + Request to modify the Group Night Forwarding system parameters. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get the Group Night Forwarding group parameters. + The response is either GroupGroupNightForwardingGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupGroupNightForwardingGetRequest. + + + + + + + + + + + + + + + + + + Request to modify the Group Night Forwarding group parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to get the Group Night Forwarding user parameters. + The response is either UserGroupNightForwardingGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to UserGroupNightForwardingGetRequest. + businessHours and holidaySchedule are returned in the response only when groupNightForwarding is ‘Auto On’. + + + + + + + + + + + + + + + + + + Request to modify the Group Night Forwarding user parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Choices for the Group Night Forwarding Service Activation for a group. + + + + + + + + + + + + + Choices for the Group Night Forwarding Service Activation for a user. + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceGroupPaging.xsd b/share/OCISchemaAS/Services/OCISchemaServiceGroupPaging.xsd new file mode 100644 index 0000000..eea85c8 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceGroupPaging.xsd @@ -0,0 +1,757 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Group Paging instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add originator(s) to a paging group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Add target(s) to a paging group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete a Group Paging instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Delete originator(s) from a paging group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete target(s) from a paging group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get a list of users that can be assigned as originators to a given paging group. + Searching for users by group only makes sense when the paging group is part of an Enterprise. + The response is either GroupGroupPagingGetAvailableOriginatorListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupGroupPagingGetAvailableOriginatorListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name" and "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + true + false + + + Get a list of users that can be assigned as targets to a given paging group. + Searching for users by group only makes sense when the paging group is part of an Enterprise. + The response is either GroupGroupPagingGetAvailableTargetListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupGroupPagingGetAvailableTargetListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name" and "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + true + false + + + Get a list of Paging Groups instances within a group. + The response is either GroupGroupPagingGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupGroupPagingGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active". + The column value for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Group Paging instance. + The response is either GroupGroupPagingGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupGroupPagingGetInstanceRequest19sp1. + Contains the service profile information. + + + + + + + + + + + + + + + + + + + true + false + + + Get a list of originators assigned to a paging group. + The response is either a + GroupGroupPagingGetOriginatorListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the GroupGroupPagingGetOriginatorListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + true + false + + + Get a list of targets assigned to a paging group. + The response is either a + GroupGroupPagingGetTargetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the GroupGroupPagingGetTargetListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + true + false + + + Request to set the active status of Group Paging instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to modify a Group Paging instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify the originator list for a paging group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to modify the target list for a paging group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request the maximum number of target users per paging group configured for a group. + The response is either a GroupGroupPagingTargetsCapacityGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupGroupPagingTargetsCapacityGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the maximum number of target users per paging group configured for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request the maximum number of target users per paging group configured for a service provider. + The response is either a ServiceProviderGroupPagingTargetsCapacityGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderGroupPagingTargetsCapacityGetRequest. + + + + + + + + + + + + + + + true + false + + + Modify the maximum number of target users per paging group configured for a service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get the list of all the Paging Groups a user was assigned as an originator. + The response is either a UserGroupPagingGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserGroupPagingGetListRequest. + The groupPagingTable contains columns: "Name", "Phone Number", "Extension" and "Is Active" + The column value for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + Maximum time to wait after the first answer is received from a target before + sending back the confirmation tone to the originator. + + + + + + + + + + + + Maximum number of targets per Paging Group + + + + + + + + + + + + Prefix for Calling Line Id Display. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceHotelingGuest.xsd b/share/OCISchemaAS/Services/OCISchemaServiceHotelingGuest.xsd new file mode 100644 index 0000000..c1e364f --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceHotelingGuest.xsd @@ -0,0 +1,141 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of users that can be assigned as Hoteling Guests. + The response is either UserHotelingGuestGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to the UserHotelingGuestGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Association Limit Hours", "Enable Association Limit", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request the user level data associated with Hoteling Guest. + The response is either a UserHotelingGuestGetResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserHotelingGuestGetRequest14sp4 + + + + + + + + + + + + + + + + + + + + + + + Modify the user level data associated with Hoteling Guest. + Provisioning error will be given when setting hostUserId to not nil value while Hoteling Guest feature is not active. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceHotelingHost.xsd b/share/OCISchemaAS/Services/OCISchemaServiceHotelingHost.xsd new file mode 100644 index 0000000..c3daeb5 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceHotelingHost.xsd @@ -0,0 +1,112 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Hoteling Host. + The response is either a UserHotelingHostGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserHotelingHostGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + Modify the user level data associated with Hoteling Host. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Access level of the Hoteling Host Service + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceHuntGroup.xsd b/share/OCISchemaAS/Services/OCISchemaServiceHuntGroup.xsd new file mode 100644 index 0000000..9726be3 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceHuntGroup.xsd @@ -0,0 +1,391 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Add a Hunt Group instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting, use value "true" in HSS data mode + includeHuntGroupNameInCLID, use value "true" in HSS data mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a Hunt Group instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get a list of users that can be assigned to a Hunt Group group. + Searching for users by group only makes sense when the hunt group is part of an Enterprise. + The response is either GroupHuntGroupGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupHuntGroupGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a list of Hunt Group instances within a group. + The response is either GroupHuntGroupGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + Response to the GroupHuntGroupGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active", "Policy". + The column values for "Is Active" can either be true, or false. + NOTE: prior to release 14, the policy column did not match the HuntPolicy enumerated type. + + + + + + + + + + + + + + + true + true + + + Request to get all the information of a Hunt Group instance. + The response is either GroupHuntGroupGetInstanceResponse20 or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Response to GroupHuntGroupGetInstanceRequest20. + Contains the service profile information and a table of assigned users. + The table has column headings: "User Id", "Last Name", "First Name", + "Hiragana Last Name", "Hiragana First Name", "Weight", "Phone Number", + "Extension", "Department", "Email Address". + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting + includeHuntGroupNameInCLID + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to set the active status of Hunt Group instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + true + + + Request to modify a Hunt Group instance. + The response is either SuccessResponse or ErrorResponse. + The following elements are only used in AS data mode: + useSystemHuntGroupCLIDSetting + includeHuntGroupNameInCLID + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the weighted call distribution of a Hunt Group instance. + The response is either SuccessResponse or ErrorResponse. + NOTE: Prior to release 14, any agents who were not in the list kept their + existing weight setting. In release 14, any agents who are not in the list + will have their weight set to 0. + + + + + + + + + + + + + + + + Request the system level data associated with Hunt Group. + The response is either a SystemHuntGroupGetResponse21 or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemHuntGroupGetRequest21. + + + + + + + + + + + + + + + + + Modify the system level data associated with Hunt Group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Hunt group Uniform Call Distribution Policy Scope. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceINIntegration.xsd b/share/OCISchemaAS/Services/OCISchemaServiceINIntegration.xsd new file mode 100644 index 0000000..01565ae --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceINIntegration.xsd @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the user level IN Integration service attributes + Response is either UserINIntegrationGetResponse or ErrorResponse + + + + + + + + + + + + + + + Response to UserINIntegrationGetRequest + + + + + + + + + + + + + + + + Request to modify the user level IN Integration service attributes + Response is either SuccessResponse or ErrorResponse + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceInCallServiceActivation.xsd b/share/OCISchemaAS/Services/OCISchemaServiceInCallServiceActivation.xsd new file mode 100644 index 0000000..5767d71 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceInCallServiceActivation.xsd @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with In-Call Service Activation. + The response is either a UserInCallServiceActivationGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserInCallServiceActivationGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with In-Call Service Activation. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the service provider's DTMF based in-call service activation trigger attributes.The response is either a ServiceProviderInCallServiceActivationGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderInCallServiceActivationGetRequest17. + + + + + + + + + + + + + + + + Modifies the service provider's DTMF based in-call service activation trigger attributes.The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the system's DTMF based in-call service activation trigger attributes. The response is either a SystemInCallServiceActivationGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemInCallServiceActivationGetRequest17. + + + + + + + + + + + + + + + + Modifies the system's DTMF based in-call service activation trigger attributes.The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceIncomingCallingPlan.xsd b/share/OCISchemaAS/Services/OCISchemaServiceIncomingCallingPlan.xsd new file mode 100644 index 0000000..c3233b9 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceIncomingCallingPlan.xsd @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group's incoming calling plan settings. + The response is either a GroupIncomingCallingPlanGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupIncomingCallingPlanGetListRequest. + + + + + + + + + + + + + + + + Change the group's incoming calling plan settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the user's incoming calling plan settings. + The response is either a UserIncomingCallingPlanGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserIncomingCallingPlanGetRequest. + + + + + + + + + + + + + + + + Change the user's incoming calling plan settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Allows or disallows various types of incoming calls for a specified department. + + + + + + + + + + + + + + + + Allows or disallows various types of incoming calls for a specified department. + For use when modifing settings. + + + + + + + + + + + + + + + Indicates whether calls from specified digit patterns are permitted. + + + + + + + + + + + + Indicates whether incoming outside calls are permitted. + + + + + + + + + + + + + Allows or disallows various types of incoming calls for a user or group -- not any particular department. + + + + + + + + + + + + + + Allows or disallows various types of incoming calls for a user or group -- not any particular department. + For use when modifing settings. + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceInstantGroupCall.xsd b/share/OCISchemaAS/Services/OCISchemaServiceInstantGroupCall.xsd new file mode 100644 index 0000000..076d022 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceInstantGroupCall.xsd @@ -0,0 +1,205 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add an Instant Group Call service instance to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Request to delete an Instant Group Call service instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of Instant Group Call service instances within a group. + The response is either GroupInstantGroupCallGetInstanceListResponse or ErrorResponse. + It is possible to get the service instances within a specified department. + + + + + + + + + + + + + + + + + Response to the GroupInstantGroupCallGetInstanceListRequest. + Contains a 6 column table with column headings: + "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active". + The column values for Is Active can either be true, or false. + + + + + + + + + + + + + + + Request to get all the information of an Instant Group Call service instance. + The response is either GroupInstantGroupCallGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupInstantGroupCallGetInstanceRequest19sp1. + Contains the service profile information and a list of phone numbers. + + + + + + + + + + + + + + + + + + + Request to set the active status of Instant Group Call service instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to modify an Instant Group Call service instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + The maximum duration for unanswered call. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceIntegratedIMP.xsd b/share/OCISchemaAS/Services/OCISchemaServiceIntegratedIMP.xsd new file mode 100644 index 0000000..6eab69c --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceIntegratedIMP.xsd @@ -0,0 +1,292 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the Integrated IMP service attributes for the group. + The response is either GroupIntegratedIMPGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupIntegratedIMPGetRequest. + The response contains the group Integrated IMP service attributes. + + + + + + + + + + + + + + + + true + false + + + Modify the Integrated IMP service attributes for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get the Integrated IMP service attributes for the service provider. + The response is either ServiceProviderIntegratedIMPGetResponse21 or ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderIntegratedIMPGetRequest21. + The response contains the service provider Integrated IMP service attributes. + + + + + + + + + + + + + + + + + + + + + Modify the Integrated IMP service attributes for the service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Get the system Integrated IMP service attributes. + The response is either SystemIntegratedIMPGetResponse19 or ErrorResponse. + + + + + + + + + + + Response to the SystemIntegratedIMPGetRequest21. + The response contains the system Integrated IMP service attributes. + + The following elements are only used in AS data mode: + boshURL + + + + + + + + + + + + + + + + + + + Modify the system Integrated IMP service attributes. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + boshURL + + + + + + + + + + + + + + + + + + + Get the Integrated IMP specific service attribute for the user. + The response is either UserIMPGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserIntegratedIMPGetRequest. + The response contains the Integrated IMP specific service attributes for the user. + + + + + + + + + + + + + + + Modifies the Integrated IMP specific service attribute for the user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Generate a new IMP password for the user. The new generated password is synchronized to the service Messaging Server. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceIntelligentNetworkServiceControl.xsd b/share/OCISchemaAS/Services/OCISchemaServiceIntelligentNetworkServiceControl.xsd new file mode 100644 index 0000000..00d0e46 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceIntelligentNetworkServiceControl.xsd @@ -0,0 +1,168 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Intelligent Network Service Control. + The response is either a SystemIntelligentNetworkServiceControlGetResponse14 + or an ErrorResponse. + + + + + + + + + + + + + Response to SystemIntelligentNetworkServiceControlGetRequest14. + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with Intelligent Network Service Control. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Intelligent Network Service Control. + The response is either a UserIntelligentNetworkServiceControlGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserIntelligentNetworkServiceControlGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Intelligent Network Service Control. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Pre-answer action timeout seconds. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceIntercept.xsd b/share/OCISchemaAS/Services/OCISchemaServiceIntercept.xsd new file mode 100644 index 0000000..b48fc9c --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceIntercept.xsd @@ -0,0 +1,399 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the group's intercept group service settings. + The response is either a GroupInterceptGroupGetResponse16sp1 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupInterceptGroupGetRequest16sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group's intercept group service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to add an Intercept User number(s) to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to delete an Intercept User number(s) from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get a list of Intercept User dns defined in the system. + The response is either a SystemInterceptUserGetDnListResponse + or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemInterceptUserGetDnListRequest. + The Intercept User DN List. + + + + + + + + + + + + + + + true + false + + + Get the system-level intercept user service settings. + The response is either a SystemInterceptUserGetResponse or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemInterceptUserGetRequest. + + + + + + + + + + + + + + + true + false + + + Request to modify a Intercept User number's description in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Modify the system-level intercept user service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the user's intercept user service settings. + The response is either a UserInterceptUserGetResponse16sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserInterceptUserGetRequest16sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + + + Modify the user's intercept user service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The type of inbound calls to Intercept or allow. + + + + + + + + + + + + + Intercept User phone number’s Description. + + + + + + + + + + + + Intercept User Entry containing the phone number and a Description. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceInternalCallingLineIDDelivery.xsd b/share/OCISchemaAS/Services/OCISchemaServiceInternalCallingLineIDDelivery.xsd new file mode 100644 index 0000000..82e4d98 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceInternalCallingLineIDDelivery.xsd @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Internal Calling Line ID Delivery. + The response is either a UserInternalCallingLineIDDeliveryGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserInternalCallingLineIDDeliveryGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Internal Calling Line ID Delivery. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceInventoryReport.xsd b/share/OCISchemaAS/Services/OCISchemaServiceInventoryReport.xsd new file mode 100644 index 0000000..015473c --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceInventoryReport.xsd @@ -0,0 +1,124 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group's inventory report. + The response is either a GroupInventoryReportGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to GroupInventoryReportGetRequest. + + + + + + + + + + + + + + + Request the system level data associated with Inventory Report. + The response is either a SystemInventoryReportGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemInventoryReportGetRequest. + + + + + + + + + + + + + + + Modify the system level data associated with Inventory Report. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceLDAPIntegration.xsd b/share/OCISchemaAS/Services/OCISchemaServiceLDAPIntegration.xsd new file mode 100644 index 0000000..20045e0 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceLDAPIntegration.xsd @@ -0,0 +1,574 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the LDAP directory attributes for a group. + The response is either a GroupLDAPIntegrationGetDirectoryResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupLDAPIntegrationGetDirectoryRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the LDAP directory attributes for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with LDAP Integration. + The response is either a GroupLDAPIntegrationGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupLDAPIntegrationGetRequest. + + + + + + + + + + + + + + + Modify the group level data associated with LDAP Integration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the LDAP directory attributes for a service provider. + The response is either a ServiceProviderLDAPIntegrationGetDirectoryResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderLDAPIntegrationGetDirectoryRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the LDAP directory attributes for a service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with LDAP Integration. + The response is either a SystemLDAPIntegrationGetDirectoryResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemLDAPIntegrationGetDirectoryRequest. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with LDAP Integration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the LDAP entry lists for a user. + The response is either a UserLDAPIntegrationGetDirectoryListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to UserLDAPIntegrationGetDirectoryListRequest. The table is a 4 column table. + The column headings are defined by the group's LDAP settings. + + + + + + + + + + + + + + + + + + Request one LDAP entry for a user. + The response is either a UserLDAPIntegrationGetDirectoryEntryResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserLDAPIntegrationGetDirectoryEntryRequest. + + + + + + + + + + + + + + + Choices for the group LDAP directory settings to decide which type of settings to use. + + + + + + + + + + + + LDAP Search Base. + + + + + + + + + + LDAP Authenticated DN. + + + + + + + + + + LDAP Authenticated Password. + + + + + + + + + + LDAP column attribute name. + + + + + + + + + + LDAP column attribute value. + + + + + + + + + LDAP column label. + + + + + + + + + + + One name value pair for a LDAP entry. + + + + + + + + + + + LDAP Entry Name. + + + + + + + + + + Type to retrieve a particular page or the last page. + + + + + + + + + + + LDAP Page Number + + + + + + + + + + Indicates the column whose attribute is chosen to be included in + the search filter. + + + + + + + + + + + + + LDAP Search Filter. + + + + + + + + + + LDAP Search Key. + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceLegacyAutomaticCallback.xsd b/share/OCISchemaAS/Services/OCISchemaServiceLegacyAutomaticCallback.xsd new file mode 100644 index 0000000..0edc7d3 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceLegacyAutomaticCallback.xsd @@ -0,0 +1,376 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the system's legacy automatic callback line type settings. + The response is either a SystemLegacyAutomaticCallbackGetTypeLineListResponse or + an ErrorResponse. + + + + + + + + + + + + + Response to SystemLegacyAutomaticCallbackGetLineTypeListRequest. Returns a 3 column + table with column headings: "Line Type", "Match" and "No Match". The possible values + for the "Match" and "No Match" columns are "Accept" and "Deny". + + + + + + + + + + + + + + + Request the system's legacy automatic callback attributes. + The response is either a SystemLegacyAutomaticCallbackGetResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemLegacyAutomaticCallbackGetRequest. + + + + + + + + + + + + + + + + + + + + + + + + + Modifies the system's legacy automatic callback line type attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Modifies the system's legacy automatic callback attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Legacy Automatic Callback. + The response is either a UserLegacyAutomaticCallbackGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserLegacyAutomaticCallbackGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Legacy Automatic Callback. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Legacy Automatic Callback line type. + + + + + + + + + + + + + + + + + + + + + + + + Legacy Automatic Callback line type match action. + + + + + + + + + + + + Maximum monitors per originator. + + + + + + + + + + + + Maximum monitors per terminator. + + + + + + + + + + + + Legacy Automatic Callback T10_O timer in minutes. + + + + + + + + + + + + Legacy Automatic Callback T10_T timer in minutes. + + + + + + + + + + + + Legacy Automatic Callback T2 timer in minutes. + + + + + + + + + + + + Legacy Automatic Callback T4 timer in seconds. + + + + + + + + + + + + Legacy Automatic Callback T5 timer in seconds. + + + + + + + + + + + + Legacy Automatic Callback T6 timer in minutes. + + + + + + + + + + + + Legacy Automatic Callback T7 timer in minutes. + + + + + + + + + + + + Legacy Automatic Callback T8 timer in seconds. + + + + + + + + + + + + Legacy Automatic Callback TRing timer in seconds. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceLocationBasedCallingRestrictions.xsd b/share/OCISchemaAS/Services/OCISchemaServiceLocationBasedCallingRestrictions.xsd new file mode 100644 index 0000000..04b4289 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceLocationBasedCallingRestrictions.xsd @@ -0,0 +1,109 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets system level the Location Based Calling Restrictions attributes. + The response is either a SystemLocationBasedCallingRestrictionsGetResponse17sp3 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemLocationBasedCallingRestrictionsGetRequest17sp3. + + + + + + + + + + + + + + + + + + Modifies the system level Location Based Calling Restriction attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Choices for how to extract the physical location from the P-Camel-CellDorLAI or P-Access-Network-Info header. + CI indicates that the physical location comes from the Cell Identification (CI) field (5 digits) of the P-Camel-CellDorLAI header (5 digits). + LAC-CI indicates that the physical location comes from the Location Area Code + Cell Identification (LAC+CI) fields of the P CAMEL CellIDorLAI header (10 digits). + PANI indicates that the physical location comes from the P Network Address Info (PANI) header. See RFC 3455. + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceMWIDeliveryToMobileEndpoint.xsd b/share/OCISchemaAS/Services/OCISchemaServiceMWIDeliveryToMobileEndpoint.xsd new file mode 100644 index 0000000..67fc72e --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceMWIDeliveryToMobileEndpoint.xsd @@ -0,0 +1,491 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests group MWI custom notifications settings. + The response is either a GroupMWIDeliveryToMobileEndpointGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupMWIDeliveryToMobileEndpointGetRequest. + + The templateActivationTable contains the list of templates defined for the group. + The column headings are "Enable", "Language", "Type". + + + + + + + + + + + + + + + + + Modify the group level MWI custom notifications settings. + The response is either a SuccessResponse or an ErrorResponse. + + If the request is executed by a group administrator and modifies the useSettingLevel, the request is rejected. + + + + + + + + + + + + + + + + + + + Create a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a GroupMWIDeliveryToMobileEndpointCustomTemplateGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to the GroupMWIDeliveryToMobileEndpointCustomTemplateGetRequest. + + + + + + + + + + + + + + + + Modify a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request the service provider level data associated with MWI Delivery to Mobile Endpoint service. + The response is either a ServiceProviderMWIDeliveryToMobileEndpointGetResponse or an ErrorResponse. + + + + + + + + + + + + + + Response to ServiceProviderMWIDeliveryToMobileEndpointGetRequest. + + The templateActivationTable contains the list of templates defined for the service provider. + The column headings are "Enable", "Language", "Type". + + + + + + + + + + + + + + + Modify the service provider level MWI custom notifications settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Create a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Delete a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to the ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetRequest. + + + + + + + + + + + + + + + + Modify a MWI Delivery to Mobile Endpoint Custom Template. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request the user level data associated with MWI Delivery to Mobile Endpoint service. + The response is either a UserMWIDeliveryToMobileEndpointGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserMWIDeliveryToMobileEndpointGetRequest. + + + + + + + + + + + + + + + + Request to modify the user level data associated with MWI Delivery to Mobile Endpoint service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + MWI Delivery To Mobile Endpoint setting for the group level. + + + + + + + + + + + + MWI Delivery To Mobile Endpoint enabled status indicator + + + + + + + + + + + + + MWI Delivery To Mobile Endpoint template body. + + + + + + + + + + + MWI Delivery To Mobile Endpoint template section associated with a specific tag. + + + + + + + + + + + + + MWI Delivery To Mobile Endpoint template message body portion. + + + + + + + + + + + + + MWI Delivery To Mobile Endpoint template tag. + + + + + + + + + + + + + + + MWI Delivery To Mobile Endpoint template types. + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceMaliciousCallTrace.xsd b/share/OCISchemaAS/Services/OCISchemaServiceMaliciousCallTrace.xsd new file mode 100644 index 0000000..bbbecc0 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceMaliciousCallTrace.xsd @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the service provider's Malicious Call Trace settings. + The response is either a ServiceProviderMaliciousCallTraceGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderMaliciousCallTraceGetRequest. + The response contains the service provider Malicious Call Trace + settings. + + + + + + + + + + + + + + + + Modify the service provider's Malicious Call Trace settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get Malicious Call Trace system parameters and the list of users that use the + Malicious Call Trace feature. + The response is either a SystemMaliciousCallTraceGetResponse or + an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to the SystemMaliciousCallTraceGetRequest. + The response contains the Malicious Call Trace system parameters and the list of users + that use the Malicious Call Trace feature. + + The column headings are "Service Provider Id", + "Group Id", "User Id", "Last Name", "First Name", "Phone Number", "Trace Type", "Status", + "Hiragana Last Name" and "Hiragana First Name", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + true + false + + + Modify a Malicious Call Trace system parameter. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request the user level data associated with Malicious Call Trace. + The response is either a UserMaliciousCallTraceGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserMaliciousCallTraceGetRequest. + + + + + + + + + + + + + + + + + + Modify the user level data associated with Malicious Call Trace. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Call Types that are traced for malicious calls + + + + + + + + + + + + + Modify the user level data associated with Malicious Call Trace. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceMeetMeConferencing.xsd b/share/OCISchemaAS/Services/OCISchemaServiceMeetMeConferencing.xsd new file mode 100644 index 0000000..8a77c34 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceMeetMeConferencing.xsd @@ -0,0 +1,1289 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Meet-Me Conferencing bridge to a group. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Delete a Meet-Me Conferencing bridge from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get a list of users that can be assigned to a Meet-Me Conferencing bridge. + Searching for users by group only makes sense when the Meet-Me Conferencing is part of an Enterprise. + The response is either GroupMeetMeConferencingGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupMeetMeConferencingGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + true + false + + + Get a list of Meet-Me Conferencing instances within a group. + The response is either GroupMeetMeConferencingGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + true + false + + + Response to the GroupMeetMeConferencingGetInstanceListRequest. + Contains a table with column headings: "Service User Id", "Name", "Phone Number", "Extension", "Department", "Ports", and "Is Active". + The column values for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + true + false + + + Request to get all the information of a Meet-Me Conferencing bridge. + The response is either GroupMeetMeConferencingGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupMeetMeConferencingGetInstanceRequest19sp1. + Contains the service profile information and a table of assigned hosts. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the group level data associated with Meet-Me Conferencing functions. + The response is either a GroupMeetMeConferencingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupMeetMeConferencingGetRequest. + + + + + + + + + + + + + + + + true + false + + + Request to set the active status of Meet-Me Conferencing instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to modify a Meet-Me Conferencing bridge. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the group level data associated with Meet-Me Conferencing functions. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request the service provider/enterprise level data associated with Meet-Me Conferencing functions. + The response is either a ServiceProviderMeetMeConferencingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to ServiceProviderMeetMeConferencingGetRequest. + + + + + + + + + + + + + + + true + false + + + Modify the service provider/enterprise level data associated with Meet-Me Conferencing functions. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Meet-Me Conferencing functions. + The response is either a SystemMeetMeConferencingGetResponse19 or an ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemMeetMeConferencingGetRequest19. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Meet-Me Conferencing. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Meet-Me conference. + The response is either UserMeetMeConferencingAddConferenceResponse19 or ErrorResponse. + The startTime element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startTime. + The startTime, endTime and recurrence information for a conferenceSchedule element will be adjusted to the user Host time zone. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingAddConferenceRequest19. + Contains the information of a conference. + + + + + + + + + + + + + + + + + true + false + + + Request to delete one or more conferences which are owned by the user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to delete one or more conference recordings owned by the user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get a list of users that can be assigned as a delegate to a Meet-Me Conference. + Searching for users, who are host on a Meet-Me Conferencing bridge. + The response is either UserMeetMeConferencingGetAvailableDelegateListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingGetAvailableDelegateListRequest. + Contains all hosts assigned on a bridge. + The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department" and "Email Address". + + + + + + + + + + + + + + + true + false + + + Get the list of Meet-Me Conferencing bridges for which the user is a host. + The response is either UserMeetMeConferencingGetBridgeListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserMeetMeConferencingGetBridgeListRequest. + Contains a table with column headings: "Bridge Id", "Name", "Phone Number", "Extension", "Ports", and "Is Active" + The column values for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + true + false + + + Get the conference delegates for this conference. + The response is either UserMeetMeConferencingGetConferenceDelegateListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingGetConferenceDelegateListRequest. + Contains a table with table heading:"User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name","Phone Number", "Extension", "Department" and "Email Address". + + + + + + + + + + + + + + + true + false + + + Get the list of all conferences for which user is a host or a delegate. + The response is either UserMeetMeConferencingGetConferenceListResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to the UserMeetMeConferencingGetConferenceListRequest. + Contains a table with column headings: "Bridge Id", "Conference Id", "Title", "Bridge Name", "Status", "Type", "Start Time", "Last Name", "First Name" and "Host Id". + The column values for "Status" can be Active, Inactive, or Expired. + The column values for "Type" can be Reservationless, One Time, Recurring Daily, Recurring Weekly, Recurring Monthly, or Recurring Yearly. + Start Time is in the format "yyyy-MM-dd'T'HH:mm:ss:SSSZ". Example: 2010-10-01T09:30:00:000-0400. + + + + + + + + + + + + + + + true + false + + + Get the list of recordings of the conferences owned by the host. + The response is either UserMeetMeConferencingGetConferenceRecordingListResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserMeetMeConferencingGetConferenceRecordingListRequest. + Contains a table with column headings: "Bridge Id", "Conference Id", "Conference Title", "Bridge Name", "Start Time", "File Size", and "URL". + Start Time is in the format "yyyy-MM-dd'T'HH:mm:ss:SSSZ". Example: 2010-10-01T09:30:00:000-0400. + + + + + + + + + + + + + + + true + false + + + Get the information of a conference owned by the user. + The response is either UserMeetMeConferencingGetConferenceResponse20 or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingGetConferenceRequest20. + Contains the information of a conference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify an existing conference. + The response is either SuccessResponse or ErrorResponse. + The startTime element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startTime. + The startTime, endTime and recurrence information for a conferenceSchedule element will be adjusted to the user Host time zone. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the existing conference delegates list. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get the information of a conference custom greeting. + The response is either UserMeetMeConferencingGetConferenceGreetingResponse20 or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to UserMeetMeConferencingGetConferenceGreetingRequest20. + Contains the information of a conference custom greeting. + + + + + + + + + + + + + + + + true + false + + + Modify an existing custom greeting audio file. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Conference account code. + + + + + + + + + + + + Choices for the notification when attendees join or leave the conferecne. + + + + + + + + + + + + + Conference duration. + + + + + + + + + + + + Conference duration minutes. + + + + + + + + + + + Restricts conference end date to the given number of months from the start date. + + + + + + + + + + + + Warning prompt before conference end in minutes. + + + + + + + + + + + + Length of conference Id and moderator pin. + + + + + + + + + + + + Number of conference ports. Can either be unlimited or limited to a value between 0 and 999999. + + + + + + + + + + + + + + + + + + + + Conference recording file format. + + + + + + + + + + + + Identifier for conference recording. startTime is the recording start timestamp. + + + + + + + + + + + + + Conference schedule. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Conference title. + + + + + + + + + + + + Hold period for expired conferences, in days. + + + + + + + + + + + + + + + + + + + + Number of participants in a conference. + + + + + + + + + + + + Early entry into the conference before the conference start in minutes + + + + + + + + + + + + Security pin for Meet-Me Conference. + + + + + + + + + + + + Length of security pin for Meet-Me Conference. + + + + + + + + + + + + Interval in seconds at which, the MS will refresh and notify active talker details. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceMusicOnHold.xsd b/share/OCISchemaAS/Services/OCISchemaServiceMusicOnHold.xsd new file mode 100644 index 0000000..0ddce83 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceMusicOnHold.xsd @@ -0,0 +1,551 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Music on Hold Instance to a department. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Delete a Music On Hold department instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Get a Music On Hold data for a group or department instance. + The response is either GroupMusicOnHoldGetInstanceResponse21 or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetInstanceRequest21. + + + + + + + + + + + + + + + + + + + + + + Returns a list of all departments that have a Music On Hold instance. + The response is either GroupMusicOnHoldGetDepartmentListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + Response to the GroupMusicOnHoldGetDepartmentListRequest. + + + + + + + + + + + + + + + + + Modify data for a group or department Music On Hold Instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Request the system level data associated with Music On Hold. + The response is either a SystemMusicOnHoldGetResponse or an + ErrorResponse. + + + + + + + + + + + + + Response to SystemMusicOnHoldGetRequest. + + + + + + + + + + + + + + + Modify the system level data associated with Music On Hold. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request the user level data associated with Music On Hold. + The response is either a UserMusicOnHoldGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserMusicOnHoldGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Music On Hold. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the user level data associated with Music On Hold User. + The response is either a UserMusicOnHoldUserGetResponse16 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserMusicOnHoldUserGetRequest20. + + + + + + + + + + + + + + + + + + Modify data for Music On Hold User. + The response is either a SuccessResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + Delay in milliseconds. + + + + + + + + + + + + Music On Hold Message Selection. + + + + + + + + + + + + + Contains the music on hold source configuration. + The following elements are only used in HSS data mode and ignored in AS data mode: + labeledMediaFiles + The following elements are only used in AS data mode and ignored in HSS data mode: + announcementMediaFiles + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + The following elements are only used in HSS data mode and not returned in AS data mode: + labeledCustomSourceMediaFiles + The following elements are only used in AS data mode and not returned in HSS data mode: + announcementMediaFiles + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the music on hold source configuration. + The following elements are only used in HSS data mode and ignored in AS data mode: + labeledMediaFiles + The following elements are only used in AS data mode and ignored in HSS data mode: + announcementMediaFiles + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Music On Hold User Message Selection. + + + + + + + + + + + + Contains the music on hold user source configuration. + + + + + + + + + + + + + + + + + + + + Contains the music on hold user source configuration. + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceNumberPortabilityAnnouncement.xsd b/share/OCISchemaAS/Services/OCISchemaServiceNumberPortabilityAnnouncement.xsd new file mode 100644 index 0000000..5832d6c --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceNumberPortabilityAnnouncement.xsd @@ -0,0 +1,102 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get the Number Portability Announcement attributes for the user. + The response is either UserNumberPortabilityAnnouncementGetResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserNumberPortabilityAnnouncementGetRequest. + The response contains the user Number Portability attributes. + + + + + + + + + + + + + + + true + false + + + Modify the Number Portability Announcement attributes for the user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceOMAPresence.xsd b/share/OCISchemaAS/Services/OCISchemaServiceOMAPresence.xsd new file mode 100644 index 0000000..4c9b080 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceOMAPresence.xsd @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceOutgoingCallingPlan.xsd b/share/OCISchemaAS/Services/OCISchemaServiceOutgoingCallingPlan.xsd new file mode 100644 index 0000000..668f7a2 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceOutgoingCallingPlan.xsd @@ -0,0 +1,2550 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the list of authorization codes for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanAuthorizationCodeGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanAuthorizationCodeGetListRequest. + + + + + + + + + + + + + + + + Request the Call Me Now call permissions for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanCallMeNowGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanCallMeNowGetListRequest. + + + + + + + + + + + + + + + + Modify the Call Me Now call permissions for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Add a list of authorization codes to the group's default or a department. When department is not + specified, it is for the group default. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a list of authorization codes from the group's default or a department. When department is not + specified, it is for the group default. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the list of authorization codes for a group default or a department. When department is not + specified, it is for the group default. + The response is either a GroupOutgoingCallingPlanDepartmentAuthorizationCodeGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanDepartmentAuthorizationCodeGetListRequest. + + + + + + + + + + + + + + + Request the Call Me Now call permissions for digit patterns for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanDigitPlanCallMeNowGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanDigitPlanCallMeNowGetListRequest. + + + + + + + + + + + + + + + + Modify the Call Me Now call permissions for digit patterns for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the originating permissions for digit patterns for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanDigitPlanOriginatingGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanDigitPlanOriginatingGetListRequest. + + + + + + + + + + + + + + + + Modify the originating permissions for digit patterns for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the redirecting permissions for digit patterns for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanDigitPlanRedirectingGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanDigitPlanRedirectingGetListRequest. + + + + + + + + + + + + + + + + Modify the redirecting permissions for digit patterns for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the originating permissions for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanOriginatingGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanOriginatingGetListRequest. + + + + + + + + + + + + + + + + Modify the originating permissions for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Add a new calling plan Pinhole digit string. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Delete one or more calling plan Pinhole digit strings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get the list of calling plan Pinhole digit strings for a group. + The response is either a GroupOutgoingCallingPlanPinholeDigitPatternGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupOutgoingCallingPlanPinholeDigitPatternGetListRequest. + Contains a table with column headings: "Name", "Digit Pattern". + + + + + + + + + + + + + + + true + false + + + Modify a calling plan Pinhole digit string. The name is a key; it cannot be changed. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request the Call Me Now permissions for Pinhole digit patterns for a group default and its departments. + The response is either a GroupOutgoingCallingPlanPinholeDigitPlanCallMeNowGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupOutgoingCallingPlanPinholeDigitPlanCallMeNowGetListRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the Call Me Now permissions for Pinhole digit patterns for a group default and its departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request the originating permissions for Pinhole digit patterns for a group default and its departments. + The response is either a GroupOutgoingCallingPlanPinholeDigitPlanOriginatingGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupOutgoingCallingPlanPinholeDigitPlanOriginatingGetListRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the originating permissions for Pinhole digit patterns for a group default and its departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request the redirecting permissions for Pinhole digit patterns for a group default and its departments. + The response is either a GroupOutgoingCallingPlanPinholeDigitPlanRedirectingGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Response to GroupOutgoingCallingPlanPinholeDigitPlanRedirectingGetListRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the redirecting permissions for Pinhole digit patterns for a group default and its departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the initiating call forwards/transfer permissions for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanRedirectingGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanRedirectingGetListRequest. + + + + + + + + + + + + + + + + Modify the initiating call forwards/transfer permissions for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the call forwarded/transferred permissions for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanRedirectedGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanRedirectedGetListRequest. + + + + + + + + + + + + + + + + Modify the call forwarded/transferred permissions for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request the list of transfer numbers for a group default and it's departments. + The response is either a GroupOutgoingCallingPlanTransferNumbersGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupOutgoingCallingPlanTransferNumbersGetListRequest. + + + + + + + + + + + + + + + + Modify the list of transfer numbers for a group default and it's departments. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Add a system outgoing calling plan call type mapping. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Delete a system outgoing calling plan call type mapping. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request to get the list of call types of outgoing calling plan + Response is SystemOutgoingCallingPlanCallTypeGetListRequest or ErrorResponse. + + + + + + + + + + + + + Response to SystemOutgoingCallingPlanCallTypeGetListRequest. + + + + + + + + + + + + + + + Get a list of system outgoing calling plan call type mappings. + The response is either SystemOutgoingCallingPlanCallTypeGetMappingListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to SystemOutgoingCallingPlanCallTypeGetMappingListRequest. The table columns are: + "Country Code", "Digit Map" and "Call Type". + + + + + + + + + + + + + + + Request the system level data associated with Outgoing Calling Plan. + The response is either a SystemOutgoingCallingPlanGetResponse17sp3 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemOutgoingCallingPlanGetRequest17sp3. + + + + + + + + + + + + + + + + Modify the system level data associated with Outgoing Calling Plan. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a list of authorization codes to a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a list of authorization codes from a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the list of authorization codes for a user. + The response is either a UserOutgoingCallingPlanAuthorizationCodeGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanAuthorizationCodeGetListRequest. + + + + + + + + + + + + + + + Request the authorization code setting for a user. + The response is either a UserOutgoingCallingPlanAuthorizationCodeGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanAuthorizationCodeGetRequest. + + + + + + + + + + + + + + + Modify the authorization setting for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the Call Me Now call permissions for a user. + The response is either a UserOutgoingCallingPlanCallMeNowGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanCallMeNowGetRequest. + + + + + + + + + + + + + + + + Modify the Call Me Now call permissions for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the Call Me Now call permissions for digit patterns for a user. + The response is either a UserOutgoingCallingPlanDigitPlanCallMeNowGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanDigitPlanCallMeNowGetRequest. + + + + + + + + + + + + + + + + Modify the Call Me Now call permissions for digit patterns for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the originating permissions for digit patterns for a user. + The response is either a UserOutgoingCallingPlanDigitPlanOriginatingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanDigitPlanOriginatingGetRequest. + + + + + + + + + + + + + + + + Modify the originating permissions for digit patterns for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the redirecting permissions for digit patterns for a user. + The response is either a UserOutgoingCallingPlanDigitPlanRedirectingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanDigitPlanRedirectingGetRequest. + + + + + + + + + + + + + + + + Modify the redirecting permissions for digit patterns for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the originating permissions for a user. + The response is either a UserOutgoingCallingPlanOriginatingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanOriginatingGetRequest. + + + + + + + + + + + + + + + + Modify the originating permissions for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request the Call Me Now permissions for Pinhole digit patterns for a user. + The response is either a UserOutgoingCallingPlanPinholeDigitPlanCallMeNowgGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserOutgoingCallingPlanPinholeDigitPlanCallMeNowGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the Call Me Now permissions for Pinhole digit patterns for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request the originating permissions for Pinhole digit patterns for a user. + The response is either a UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the originating permissions for Pinhole digit patterns for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Request the redirecting permissions for Pinhole digit patterns for a user. + The response is either a UserOutgoingCallingPlanPinholeDigitPlanRedirectingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to UserOutgoingCallingPlanPinholeDigitPlanRedirectingGetRequest. + + + + + + + + + + + + + + + + true + false + + + Modify the redirecting permissions for Pinhole digit patterns for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the initiating call forwards/transfer permissions for a user. + The response is either a UserOutgoingCallingPlanRedirectingGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanRedirectingGetRequest. + + + + + + + + + + + + + + + + Modify the initiating call forwards/transfer permissions for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the call forwarded/transferred permissions for a user. + The response is either a UserOutgoingCallingPlanRedirectedGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanRedirectedGetRequest. + + + + + + + + + + + + + + + + Modify the call forwarded/transferred permissions for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the sustained authorization code setting for a user. + The response is either a UserOutgoingCallingPlanSustainedAuthorizationCodeGetResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanAuthorizationCodeGetRequest. + + + + + + + + + + + + + + + Modify or clear the sustained authorization code for a user. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + + Request the transfer numbers for a user. + The response is either a UserOutgoingCallingPlanTransferNumbersGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutgoingCallingPlanTransferNumbersGetRequest. + + + + + + + + + + + + + + + + Modify the transfer numbers for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Outgoing Calling Plan Authorization Code Description. + + + + + + + + + + + + Outgoing Calling Plan Authorization Code. + + + + + + + + + + + + Outgoing Calling Plan for Call Me Now call permissions for a department. + + + + + + + + + + + + + Modify outgoing Calling Plan for Call Me Now call permissions for a department. + + + + + + + + + + + + Outgoing Calling Plan for Call Me Now call permissions. + + + + + + + + + + + + + + + + + + + + + + + + Modify outgoing Calling Plan for Call Me Now call permissions. + + + + + + + + + + + + + + + + + + + + + + + + Outgoing Calling Plan Call Type + + + + + + + + + + + + + + + + + + + + + Outgoing Calling Plan Authorization Code for a department. + + + + + + + + + + + + + Outgoing Calling Plan transfer numbers for a department. + + + + + + + + + + + + + Outgoing Calling Plan transfer numbers for a department. + + + + + + + + + + + + Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. + + + + + + + + + + + + + Modify outgoing Calling Plan Call Me Now call permissions for specified digit patterns. + + + + + + + + + + + + Indicates whether Call Me Now calls using specified digit patterns are permitted. + + + + + + + + + + + + Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. + + + + + + + + + + + Outgoing Calling Plan originating call permissions for specified digit patterns. + + + + + + + + + + + + + Modify outgoing Calling Plan originating call permissions for specified digit patterns. + + + + + + + + + + + + Indicates whether originating calls using specified digit patterns are permitted. + + + + + + + + + + + + Outgoing Calling Plan originating call permissions for specified digit patterns. + + + + + + + + + + + Outgoing Calling Plan redirecting call permissions for specified digit patterns. + + + + + + + + + + + + + Modify outgoing Calling Plan redirecting call permissions for specified digit patterns. + + + + + + + + + + + + Indicates whether redirecting calls using specified digit patterns are permitted. + + + + + + + + + + + + Outgoing Calling Plan redirecting call permissions for specified digit patterns. + + + + + + + + + + + Outgoing Calling Plan Authorization Code for the group default. + + + + + + + + + + + Outgoing Calling Plan originating call permissions for a department. + + + + + + + + + + + + + Outgoing Calling Plan originating call permissions for a department. + + + + + + + + + + + + Choices indicates how originating calls are permitted. + + + + + + + + + + + + + + + + Outgoing Calling Plan originating call permissions. + + + + + + + + + + + + + + + + + + + + + + + + Outgoing Calling Plan originating call permissions. + + + + + + + + + + + + + + + + + + + + + + + + Outgoing Calling Plan being forwarded/transferred permissions for a department. + + + + + + + + + + + + + Outgoing Calling Plan being forwarded/transferred permissions for a department. + + + + + + + + + + + + Outgoing Calling Plan being forwarded/transferred permissions. + + + + + + + + + + + Outgoing Calling Plan being forwarded/transferred permissions. + + + + + + + + + + + Outgoing Calling Plan initiating call forwards/transfer permissions for a department. + + + + + + + + + + + + + Outgoing Calling Plan initiating call forwards/transfer permissions for a department. + + + + + + + + + + + + Outgoing Calling Plan initiating call forwards/transfer permissions. + + + + + + + + + + + + + + + + + + + + + + + + Outgoing Calling Plan initiating call forwards/transfer permissions. + + + + + + + + + + + + + + + + + + + + + + + + Outgoing Calling Plan transfer numbers. + + + + + + + + + + + + + Outgoing Calling Plan transfer numbers. + + + + + + + + + + + + + Outgoing Pinhole Digit Plan Call Me Now call permissions for a department. + + + + + + + + + + + + + Modify Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit patterns. + + + + + + + + + + + + Indicates whether Call Me Now calls using specified Pinhole digit patterns are permitted. + + + + + + + + + + + + Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit patterns. + + + + + + + + + + + Permission choices for Pinhole digit patterns on Call Me Now calls. + + + + + + + + + + + + Outgoing Pinhole Digit Plan department originating call permissions for specified digit patterns. + + + + + + + + + + + + + Modify Outgoing Pinhole Digit Plan originating call permissions for specified digit patterns. + + + + + + + + + + + + Indicates whether originating calls using specified Pinhole digit patterns are permitted. + + + + + + + + + + + + Outgoing Pinhole Digit Plan originating call permissions for specified digit patterns. + + + + + + + + + + + Outgoing Pinhole Digit Plan initiating call forwards/transfer permissions for a department. + + + + + + + + + + + + + Modify Outgoing Pinhole Digit Plan redirecting call permissions for specified digit patterns. + + + + + + + + + + + + Indicates whether redirecting calls using specified Pinhole digit patterns are permitted. + + + + + + + + + + + + Outgoing Pinhole Digit Plan redirecting call permissions for specified digit patterns. + + + + + + + + + + + Permission choices for Pinhole digit patterns on originating calls. + + + + + + + + + + + + + + + + Permission choices for Pinhole digit patterns on redirecting calls. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceOutlookIntegration.xsd b/share/OCISchemaAS/Services/OCISchemaServiceOutlookIntegration.xsd new file mode 100644 index 0000000..5b7517d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceOutlookIntegration.xsd @@ -0,0 +1,103 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Outlook Integration. + The response is either a UserOutlookIntegrationGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserOutlookIntegrationGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Outlook Integration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Microsoft Outlook contact database search option. + Controls which contacts are retrieved from outlook. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePersonalAssistant.xsd b/share/OCISchemaAS/Services/OCISchemaServicePersonalAssistant.xsd new file mode 100644 index 0000000..0fc920f --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePersonalAssistant.xsd @@ -0,0 +1,439 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get system Personal Assistant Parameters. + The response is either SystemPersonalAssistantGetResponse or ErrorResponse. + + + + + + + + + + + true + false + + + Response to the SystemPersonalAssistantGetRequest. + Returns system Personal Assistant Parameters. + + + + + + + + + + + + + + + + true + false + + + Modify system Personal Assistant Parameters. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to get the User Personal Assistant information. + The response is either a UserPersonalAssistantGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserPersonalAssistantGetRequest. + The response contains the user Personal Assistant information". + + + + + + + + + + + + + + + + + + + + true + false + + + Modify the User Personal Assistant information. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a User Personal Assistant Exclusion Number. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Modify an existing User Personal Assistant Exclusion Number description. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Delete a list of User Personal Assistant Exclusion Number. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a Personal Assistant Exclusion Number. + The response is either UserPersonalAssistantExclusionNumberGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserPersonalAssistantExclusionNumberGetRequest + + + + + + + + + + + + + + + true + false + + + Request to get the User Personal Assistant Exclusion Number List information. + The response is either a userPersonalAssistantExclusionNumberGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Response to the UserPersonalAssistantExclusionNumberGetListRequest. + Contains a table with column headings: + "Number", "Description". + + + + + + + + + + + + + + + true + false + + + Request to get the user available Call to Number List information. The response is either a UserCallToNumberGetAvailableListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserCallToNumberGetAvailableListRequest. + Contains a list of the user available Call to Numbers". + + + + + + + + + + + + + + + true + false + + + Request to get the user assigned Call to Number List information. The response is either a UserPersonalAssistantCallToNumberGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserPersonalAssistantCallToNumberGetListRequest. + Contains a list of assigned Call to Numbers". + + + + + + + + + + + + + + + true + false + + + Request to modify the user assigned Call to Number List information. + The response is either a SuccessResponse or an ErrorResponse. + For the callToNumbers in the callToNumberList, the extension element + is not used and the number element is only used when the type is BroadWorks Mobility. + + + + + + + + + + + + + + + Personal Assistant Presence. + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePhysicalLocation.xsd b/share/OCISchemaAS/Services/OCISchemaServicePhysicalLocation.xsd new file mode 100644 index 0000000..9ef9933 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePhysicalLocation.xsd @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of Physical Location system parameters. + The response is either SystemPhysicalLocationGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemPhysicalLocationGetRequest. + Contains a list of system Physical Location parameters. + + + + + + + + + + + + + + + Request to modify Physical Location system parameters. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request the user level data associated with Physical Location. + The response is either a UserPhysicalLocationGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserPhysicalLocationGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Physical Location. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePolycomPhoneServices.xsd b/share/OCISchemaAS/Services/OCISchemaServicePolycomPhoneServices.xsd new file mode 100644 index 0000000..7f23ebc --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePolycomPhoneServices.xsd @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the group's Polycom Phone Services attributes. + The response is either a GroupPolycomPhoneServicesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupPolycomPhoneServicesGetRequest. + + + + + + + + + + + + + + + + + Modify the group's Polycom Phone Services attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request the user's Polycom Phone Services attributes. + The response is either a UserPolycomPhoneServicesGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to UserPolycomPhoneServicesGetRequest. + + + + + + + + + + + + + + + + + + Modify the user's Polycom Phone Services attributes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request the user's list of device profiles on which the user is the primary user. + The response is either a UserPolycomPhoneServicesGetPrimaryEndpointListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserPolycomPhoneServicesGetPrimaryEndpointListRequest. + The column headings for the deviceUserTable are: "Device Level", "Device Name", "Line/Port", "Private Identity". + The Private Identity column is empty is AS mode. + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePreAlertingAnnouncement.xsd b/share/OCISchemaAS/Services/OCISchemaServicePreAlertingAnnouncement.xsd new file mode 100644 index 0000000..272cddd --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePreAlertingAnnouncement.xsd @@ -0,0 +1,371 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the Enterprise pre-alerting service settings. + The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the Enterprise level pre-alerting service settings. + The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Modify the enterprise level pre-alerting service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Get the group’s PreAlertingservice settings. + The response is either a GroupPreAlertingAnnouncementGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to a GroupPreAlertingAnnouncementGetResponse20. + + + + + + + + + + + + + + + + + + + + + + Modify the group level pre-alerting service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Get the user's pre-alerting service setting. + The response is either a UserPreAlertingAnnouncementGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to a UserPreAlertingAnnouncementGetRequest20. + The criteria table's column headings are: "Is Active", "Criteria Name", "Blacklisted", "Calls From", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + + + + + + + + Modify the user's pre-alerting service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's pre-alerting service. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modify a criteria for the user's pre-alerting service. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's pre-alerting service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a criteria for the user's pre-alerting service. + The response is either a UserPreAlertingAnnouncementGetCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserPreAlertingAnnouncementGetCriteriaRequest21. + + + + + + + + + + + + + + + + + + + Pre-alerting Announcement interrupt type. + + + + + + + + + + + + + Pre-alerting Announcement Interrupt digit sequence. + The Interrupt digit sequence may contain digits 0-9, *, and #. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePreferredCarrier.xsd b/share/OCISchemaAS/Services/OCISchemaServicePreferredCarrier.xsd new file mode 100644 index 0000000..1b4e6af --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePreferredCarrier.xsd @@ -0,0 +1,659 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the currently configured carriers for a group. + The response is either a GroupPreferredCarrierGroupGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to a GroupPreferredCarrierGroupGetRequest. + + + + + + + + + + + + + + + + + Modifies the currently configured carriers for a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Add the country code preferred carriers for a service provider or enterprise. For each + combination of service provider and country code, you can assign an intra-lata, inter-lata, + and international carrier. Each of the three types of carriers is optional. + The response is either a SuccessResponse or an ErrorResponse. + Note: At the system level, more than one carrier may be assigned to each country code. + At the service provider level, you must choose from the carriers assigned at the system level. + + + + + + + + + + + + + + + + + + + Delete the country code preferred carriers for a service provider or enterprise. + Note that this is different from unassigning all 3 types of carriers with + the ServiceProviderPreferredCarrierModifyRequest. + The response is either a SuccessResponse or an ErrorResponse. + An ErrorResponse will be returned if the country code preferred carriers were never added or + were already deleted. + + + + + + + + + + + + + + + + Requests the default country code and the list of unused country codes for a service provider / enterprise. + The response is either a ServiceProviderPreferredCarrierGetAvailableCountryCodeListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to a ServiceProviderPreferredCarrierGetAvailableCountryCodeListRequest. + Contains the default country code and the list of unused country codes for a service provider / enterprise. + + + + + + + + + + + + + + + + Requests the lists of carriers for a specified country code for a service provider / enterprise. + The response is either a ServiceProviderPreferredCarrierGetCarrierListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to a ServiceProviderPreferredCarrierGetCarrierListRequest. + Contains the lists of carriers for a specified country code for a service provider / enterprise. + + + + + + + + + + + + + + + + + Requests a table of all the carriers defined in a specified service provider or enterprise. + The response is either a ServiceProviderPreferredCarrierGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to a ServiceProviderPreferredCarrierGetListRequest. Contains a table with one row per carrier. + The table columns are: "Country Code", "Intra-Lata PIC", "Inter-Lata PIC", "International PIC". + + + + + + + + + + + + + + + Requests the currently configured carriers for a specified country code for a service provider / enterprise. + The response is either a ServiceProviderPreferredCarrierGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to a ServiceProviderPreferredCarrierGetRequest. + Contains the currently configured carriers for a specified country code for a service provider / enterprise. + + + + + + + + + + + + + + + + + Modify the country code preferred carriers for a service provider or enterprise. For each + combination of service provider and country code, you can assign an intra-lata, inter-lata, + and international carrier. Each of the 3 types of carriers is optional. + If an optional carrier is not specified, the assignment will not change. + To clear a preferred carrier, set the value to an empty string. + The response is either a SuccessResponse or an ErrorResponse. + Note: At the system level, more than one carrier may be assigned to each country code. + At the service provider level, you must choose from the carriers assigned at the system level. + + + + + + + + + + + + + + + + + + + Add a carrier to the system. + More than one carrier may be assigned to each country code. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a carrier from the system. + The response is either a SuccessResponse or an ErrorResponse. + An ErrorResponse is returned if the carrier is in use, or if the carrier didn't exist prior to deletion.. + + + + + + + + + + + + + + + Requests a list of groups using the specified carrier. It is possible to restrict the + number of rows returned by specifying various search criteria. Multiple search criteria + are logically ANDed together. + The response is either a SystemPreferredCarrierGetGroupListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Response to a SystemPreferredCarrierGetGroupListRequest. + Contains a table with one row per group. + The table columns are: "Group Id", "Group Name", "Organization Id", "Organization Type". + The "Organization Id" column is populated with either a service provider Id or an enterprise Id. + The "Organization Type" column is populated with one of the enumerated strings defined in the + OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType. + + + + + + + + + + + + + + + Requests a table of all the carriers defined in the system. + The response is either a SystemPreferredCarrierGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to a SystemPreferredCarrierGetListRequest. Contains a table with one row per carrier. + The table columns are: "Carrier", "Country Code", "CIC", "Is Intra-Lata", "Is Inter-Lata", "Is International". + The value in the "Is Intra-Lata", "Is Inter-Lata", and "Is International" columns is one of "true" or "false". + + + + + + + + + + + + + + + Requests the attributes of carrier. + The response is either a SystemPreferreredCarrierGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to a SystemPreferredCarrierGetRequest. + Contains the attributes of a carrier. + + + + + + + + + + + + + + + + + + + Requests a list of users using the specified carrier. It is possible to restrict the + number of rows returned by specifying various search criteria. Multiple search criteria + are logically ANDed together. + The response is either a SystemPreferreredCarrierGetUserListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to a SystemPreferredCarrierGetUserListRequest. + Contains a table with one row per user. + The table columns are: "User Id", "Service Provider Id", "Group Id", "Last Name", "First Name", "Phone Number", "Email Address", + "Hiragana Last Name", and "Hiragana First Name", "Extension", "Department". + + + + + + + + + + + + + + + Modify the attributes of a carrier. + The response is either a SuccessResponse or an ErrorResponse. + An ErrorResponse is returned if countryCode modification is attempted while the carrier is assigned to a service provider. + An ErrorResponse is returned if an attempt to set isIntraLata to false is made while the carrier is used as an intra-LATA carrier. + An ErrorResponse is returned if an attempt to set isInternational to false is made while the carrier is used as an international carrier. + + + + + + + + + + + + + + + + + + + + Requests the currently configured preferred carriers for a user. + The response is either a UserPreferredCarrierUserGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to a UserPreferredCarrierUserGetRequest. + + + + + + + + + + + + + + + + + Modifies the currently configured preferred carriers for a user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Group can either use it's service provider/enterprise's preferred carrier or use it's own. + The group carrier name is exposed if it was previously configured. + + + + + + + + + + + + Group can either use it's service provider/enterprise's preferred carrier or use it's own. + You can use the Service Provider preferred carrier without clearing the group + carrier name -- in this case, the group carrier name is retained. + + + + + + + + + + + A digit code used by network signaling to identifiy a carrier. + + + + + + + + + + Uniquely identifies a carrier. + + + + + + + + + + + User can either use it's group's preferred carrier or use it's own. + The user carrier name is exposed if it was previously configured. + + + + + + + + + + + + User can either use it's group's preferred carrier or use it's own. + You can use the group's preferred carrier without clearing the user carrier name -- + in this case, the user carrier name is retained. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePrepaid.xsd b/share/OCISchemaAS/Services/OCISchemaServicePrepaid.xsd new file mode 100644 index 0000000..227d878 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePrepaid.xsd @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Prepaid. + The response is either a UserPrepaidGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserPrepaidGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Prepaid. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePriorityAlert.xsd b/share/OCISchemaAS/Services/OCISchemaServicePriorityAlert.xsd new file mode 100644 index 0000000..d2a5ca1 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePriorityAlert.xsd @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's priority alert service. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's priority alert service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the user's priority alert criteria listing. + The response is either a UserPriorityAlertGetCriteriaListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserPriorityAlertGetCriteriaListRequest. The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + Get a criteria for the user's priority alert service. + The response is either a UserPriorityAlertGetCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserPriorityAlertGetCriteriaRequest21. + + + + + + + + + + + + + + + + + + + Activate the user's priority alert criteria list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a criteria for the user's priority alert service. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + The from dn criteria used within an add/get request. + + + + + + + + + + + + + + The from dn criteria used within a modify request. + + + + + + + + + + + + + + Selection criteria for a from dn. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePrivacy.xsd b/share/OCISchemaAS/Services/OCISchemaServicePrivacy.xsd new file mode 100644 index 0000000..e3f742d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePrivacy.xsd @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the data associated with Privacy for a service instance. + The response is either a GroupServiceInstancePrivacyGetResponse17sp4 + or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to GroupServiceInstancePrivacyGetRequest17sp4. + + + + + + + + + + + + + + + + + true + false + + + Modify the data associated with Privacy for a service instance. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Retrieves a list of users in the enterprise or group available + for phone status monitoring the user specified in the userId + element. The response is either + UserPrivacyGetAvailableMonitorsUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the UserPrivacyGetAvailableMonitorsUserListRequest. + Returns a 10 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + Request the user level data associated with Privacy. + This command is supported for regular users only. + The response is either a UserPrivacyGetResponse13mp17 + or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserPrivacyGetRequest13mp17. The + permittedMonitorUserIdTable contains the members of + the enterprise or group allowed to monitor the phone + status of the user specified in the request. Members + of this table are allowed to monitor the user even if + enablePhoneStatusPrivacy is set to true. The table + contains column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + + + + + Modify the user level data associated with Privacy. + This command is supported for regular users only. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServicePushToTalk.xsd b/share/OCISchemaAS/Services/OCISchemaServicePushToTalk.xsd new file mode 100644 index 0000000..88bc15a --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServicePushToTalk.xsd @@ -0,0 +1,165 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of available users for the push to talk service. + The response is either UserPushToTalkGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the UserPushToTalkGetAvailableUserListRequest. + Returns a 10 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + Request the push to talk service setting. + The response is either a UserPushToTalkGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserPushToTalkGetRequest. It returns the service settings and a + 9 column selected user table with the following column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", "IMP Id". + + + + + + + + + + + + + + + + + + Change the push to talk service settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Push to talk outgoing connection type. + + + + + + + + + + + + Push to talk access list. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceReceptionistEnterprise.xsd b/share/OCISchemaAS/Services/OCISchemaServiceReceptionistEnterprise.xsd new file mode 100644 index 0000000..2fa88b7 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceReceptionistEnterprise.xsd @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to get the list of BroadWorks Receptionist - Enterprise parameters. + The response is either SystemBroadWorksReceptionistEnterpriseGetResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemBroadWorksReceptionistEnterpriseGetRequest. + Contains a list of BroadWorks Receptionist - Enterprise parameters. + + + + + + + + + + + + + + + Request to modify BroadWorks Receptionist - Enterprise settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Add users to the BroadWorks Receptionist - Enterprise monitored user list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Remove selected users from the BroadWorks Receptionist - Enterprise monitored user list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a list of available users for BroadWorks Receptionist - Enterprise monitoring. + The response is either UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest. + Returns a 12 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id". + + + + + + + + + + + + + + + Request the monitored users list for the BroadWorks Receptionist - Enterprise service. + The response is either a UserBroadWorksReceptionistEnterpriseGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserBroadWorksReceptionistEnterpriseGetRequest. + Returns a 12 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id". + + + + + + + + + + + + + + + Replace the BroadWorks Receptionist - Enterprise monitored user list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceReceptionistOffice.xsd b/share/OCISchemaAS/Services/OCISchemaServiceReceptionistOffice.xsd new file mode 100644 index 0000000..60f773b --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceReceptionistOffice.xsd @@ -0,0 +1,134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the Receptionist Office available user list. + The response is either UserBroadWorksReceptionistOfficeGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Response to the UserBroadWorksReceptionistOfficeGetAvailableUserListRequest. + Returns a 12 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id". + + + + + + + + + + + + + + + Request the Receptionist Office parameters. + The response is either a UserBroadWorksReceptionistOfficeGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserBroadWorksReceptionistOfficeGetRequest. + Returns a 11 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id". + + + + + + + + + + + + + + + Replace the Receptionist Office monitored user list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceReceptionistSmallBusiness.xsd b/share/OCISchemaAS/Services/OCISchemaServiceReceptionistSmallBusiness.xsd new file mode 100644 index 0000000..2cab6f5 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceReceptionistSmallBusiness.xsd @@ -0,0 +1,136 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of available users for the Receptionist Small Business service. + The response is either UserBroadWorksReceptionistSmallBusinessGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the UserBroadWorksReceptionistSmallBusinessGetAvailableUserListRequest. + Returns a 11 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id". + + + + + + + + + + + + + + + Request the Receptionist Small Business parameters. + The response is either a UserBroadWorksReceptionistSmallBusinessGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserBroadWorksReceptionistSmallBusinessGetRequest. + Returns a 12 column table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id". + + + + + + + + + + + + + + + Replace the Receptionist Small Business monitored user list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceRemoteOffice.xsd b/share/OCISchemaAS/Services/OCISchemaServiceRemoteOffice.xsd new file mode 100644 index 0000000..c8d2d5b --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceRemoteOffice.xsd @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Remote Office. + The response is either a UserRemoteOfficeGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserRemoteOfficeGetRequest. + + + + + + + + + + + + + + + + Modify the user level data associated with Remote Office. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceRouteList.xsd b/share/OCISchemaAS/Services/OCISchemaServiceRouteList.xsd new file mode 100644 index 0000000..73ee205 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceRouteList.xsd @@ -0,0 +1,468 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request a summary table of all enterprise trunk number ranges in the system. + The response is either SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + Response to SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest. + The column headings are "Number Range Start", "Number Range End", "Service Provider Id", "Is Enterprise", "User Id", "Enterprise Trunk" and "Is Active". + + + + + + + + + + + + + + + Request a summary table of all enterprise trunk number ranges in the service provider. + The response is either ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest. + The column headings are "Number Range Start", "Number Range End", "Group Id" and "Is Active". + + + + + + + + + + + + + + + Request a summary table of all enterprise trunk number ranges in the enterprise. + The response is either EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest. + The response contains a table with columns: "Number Range Start", "Number Range End", "Group Id", "User Id", + "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", + "Email Address", "Enterprise Trunk" and "Is Active". + The "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department" and "Email Address" columns contains the corresponding attributes of the user possessing the number range. + The "Enterprise Trunk" column contains the enterprise trunk the user possessing the number range belongs to. + The "Is Active" column indicates if the number range has been activated. + + + + + + + + + + + + + + + Add number ranges to a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Delete number ranges from a service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Activate number ranges in a service provider. + It is not an error to activate an already activated number range. + The command fails if executed when system level enterprise trunk number range activation is disabled. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Deactivate number ranges in a service provider. + It is not an error to deactivate an already deactivated number range. + The command fails if executed when system level enterprise trunk number range activation is disabled. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Request a list of available number ranges not yet assigned to any group. + The response is either ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest. Contains a list of available number ranges not yet assigned to any group. + The column headings are "Number Range Start", "Number Range End" and "Is Active". + + + + + + + + + + + + + + + Request a list of number ranges that are assigned to an enterprise and still available for assignment to users within the enterprise. + The response is either EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest. + Contains a list of number ranges that are assigned to an enterprise and still available for assignment to users within the enterprise. + The column headings are "Number Range Start", "Number Range End" and "Is Active". + + + + + + + + + + + + + + + Get the list of assigned and unassigned enterprise trunknumber ranges in a group. + The response is either GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest. + The response contains a table with columns: "Number Range Start", "Number Range End", "User Id", + "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address", "Enterprise Trunk" and "Is Active". + The "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department" and "Email Address" columns contains the corresponding attributes of the user possessing the number range. + The "Enterprise Trunk" column contains the enterprise trunk the user possessing the number range belongs to. + The "Is Active" column indicates if the number range has been activated. + + + + + + + + + + + + + + + Assign a list of service provider number ranges to a group. + The number ranges must have previously been added to the service provider. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Unassign a list of service provider number ranges from a group. The number ranges then become available for assignment to other groups. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Request a list of number ranges that are assigned to a group and still available for assignment to users within the group. + The response is either GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest. + Contains a list of number ranges that are assigned to a group and still available for assignment to users within the group. + The column headings are "Number Range Start", "Number Range End" and "Is Active". + + + + + + + + + + + + + + + Get the route list setting and the list of number ranges assigned to a user. + The response is either UserRouteListGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to UserRouteListGetRequest. + Contains the route list setting and a list of assigned number ranges. + The column headings for assignedNumberRangeTable are "Number Range Start", "Number Range End" and "Is Active". + + + + + + + + + + + + + + + + + + Modify the route list setting and the list of number ranges assigned to a user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + A list of dns that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceRoutePoint.xsd b/share/OCISchemaAS/Services/OCISchemaServiceRoutePoint.xsd new file mode 100644 index 0000000..24792a7 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceRoutePoint.xsd @@ -0,0 +1,1330 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Route Point DNIS. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Add a Route Point instance to a group. + The Route Point is a Call Center queue that performs the same function but + allows an external system to perform the distribution of calls instead of making + those decisions itself. + The domain is required in the serviceUserId. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's bounced call settings. + The response is either a GroupRoutePointBouncedCallGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointBouncedCallGetRequest. + + + + + + + + + + + + + + + + + + + Modify a route point's bounced call settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a route point's DNIS. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Delete a Route Point instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get the distinctive ringing configuration values for route point. + The response is either a GroupRoutePointDistinctiveRingingGetResponse + or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointDistinctiveRingingGetRequest. + + + + + + + + + + + + + + + + + Modify the distinctive ringing configuration values for route point. + + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Get a route point's announcement settings. + The response is either a GroupRoutePointGetAnnouncementResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetAnnouncementRequest20. + + + + + + + + + + + + + + + Get a list of agent who selected the DNIS as the outgoing call. + The response is either GroupRoutePointGetDNISAgentListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetDNISAgentListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a route point's DNIS Announcements + The response is either a GroupRoutePointGetDNISAnnouncementResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetDNISAnnouncementRequest20. + + + + + + + + + + + + + + + Get a list of DNIS that are configured for a Route Point. + The response is either GroupRoutePointGetDNISListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetDNISListRequest. + Contains a table with column headings: "Name", "Phone Number", "Extension". + + + + + + + + + + + + + + + + + Get a route point's DNIS. + The response is either a GroupRoutePointGetDNISResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetDNISRequest. + + + + + + + + + + + + + + + + + + + + + + Get the route point failover policy. + The response is either a GroupRoutePointGetFailoverPolicyResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointGetFailoverPolicyRequest. + + + + + + + + + + + + + + + + + + + + + + Get a list of Route Point instances within a group. + It is possible to search by various criteria to restrict the number of rows returned. + The response is either GroupRoutePointGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + + + Response to the GroupRoutePointGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active". + The column values for "Video" and "Is Active" can either be true, or false. + + + + + + + + + + + + + + + Request to get all the information of a Route Point instance. + The response is either GroupRoutePointGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupRoutePointGetInstanceRequest19sp1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's forced forwarding settings. + The response is either a GroupRoutePointForcedForwardingGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointForcedForwardingGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's forced forwarding settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's holiday service settings. + The response is either a GroupRoutePointHolidayServiceGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointHolidayServiceGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's holiday service settings. + Only Group and Enterprise level schedules are accepted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Request to set the active status of Route Point instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Modify a route point's announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a route point DNIS announcement settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify the setting that are configured for all the DNIS in a Route Point. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Modify a route point's DNIS settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Initiate manual failover for the Route Point. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Modify the route point failover policy. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Request to modify a Route Point instance. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's night service settings. + The response is either a GroupRoutePointNightServiceGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointNightServiceGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's night service settings. + Only Group and Enterprise level schedules are accepted. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a route point's overflow settings. + The response is either a GroupRoutePointOverflowGetResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointOverflowGetRequest20. + + + + + + + + + + + + + + + + + + + + + + + + + Modify a route point's overflow settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Add a Route Point Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Delete a Route Point Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the list of Route Point Level and Organization Level Call Disposition Codes. + The response is either GroupRoutePointQueueCallDispositionCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the GroupRoutePointQueueCallDispositionCodeGetListRequest. + Contains a table with column headings: "Is Active", "Code", "Description" and "Level". + Level column can be any of the values in the data type CallDispositionCodeLevel. + + + + + + + + + + + + + + + Get a Route Point Call Disposition Code. + The response is either GroupRoutePointQueueCallDispositionCodeGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupRoutePointQueueCallDispositionCodeGetRequest + + + + + + + + + + + + + + + + Modify a Route Point Call Disposition Code. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Request the queue level data associated with Route Point Call Disposition Code Settings. + The response is either an GroupRoutePointQueueCallDispositionCodeSettingsGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to GroupRoutePointQueueCallDispositionCodeSettingsGetRequest. + + + + + + + + + + + + + + + + + + Modify the queue level data associated with Route Point Agents Unavailable Code Settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Get the list of available Route Point Call Disposition Codes to be used by a client. + The response is either UserRoutePointCallDispositionCodeGetAvailableListResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserRoutePointCallDispositionCodeGetAvailableListRequest. + This list may include Group/Enterprise level codes in addition to the Route Point level codes, + depending on the call center disposition codes settings. + Only active codes are included in the list. + Contains a table with column headings: "Code", "Description" and "Level". + Level column can be any of the values in the data type CallDispositionCodeLevel. + + + + + + + + + + + + + + + true + false + + + Get a list of Route Point supervisors assigned to a user. + The response is either a + UserRoutePointSupervisorGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the UserRoutePointSupervisorGetListRequest. + Contains a table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address", + "Location Code". + + + + + + + + + + + + + + + Request to modify the Route Point supervisor list for a user. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Number of rings to wait before timeout the outgoing call. + + + + + + + + + + + + The call failure timeout. + + + + + + + + + + + + The Route Point failover status. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSMDIMessageDesk.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSMDIMessageDesk.xsd new file mode 100644 index 0000000..a713e88 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSMDIMessageDesk.xsd @@ -0,0 +1,389 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add a SMDI Server to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to delete a SMDI Server from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of SMDI Servers defined in the system. + The response is either a SystemSMDIMessageDeskGetServerListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemMediaServerGetListRequest. The SMDI Server table column + headings are: "Device Name", "Net Address", "Port" and "Description". + + + + + + + + + + + + + + + Request to modify a SMDI Server in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to add a SMDI Server route to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to delete a SMDI Server route from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of SMDI Servers routes in the system. + The response is either a SystemSMDIMessageDeskGetServerRouteListResponse or an ErrorResponse. + + + + + + + + + + + + + Response to SystemSMDIMessageDeskGetServerRouteListRequest. + The SMDI Server route table column headings are: "Destination" and "SMDI Servers". + + + + + + + + + + + + + + + Replace the list of devices associated with a SMDI server route destination. + There must be at least one device in the list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Request to add a SMDI Server for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to delete a list of SMDI Servers for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the user's SMDI Message Desk service personal setting. + The response is either a UserSMDIMessageDeskGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSMDIMessageDeskGetRequest. + + + + + + + + + + + + + + + + Request to get a list of SMDI Servers defined for a user. + The response is either a UserSMDIMessageDeskGetServerListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSMDIMessageDeskGetServerListRequest. + The SMDI Server table column headings are: "Device Name", "Net Address", "Port". + + + + + + + + + + + + + + + Modify the user's SMDI Message Desk service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + SMDI device name. + + + + + + + + + + + + SMDI Message Desk number. + + + + + + + + + + + + SMDI server description. + + + + + + + + + + + + SMDI server route destination, a 3 to 10 digits number + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSecurityClassification.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSecurityClassification.xsd new file mode 100644 index 0000000..5c1b25d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSecurityClassification.xsd @@ -0,0 +1,417 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Get a trunk group's Security Classifications configuration. + The response is either GroupTrunkGroupSecurityClassificationGetResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the GroupTrunkGroupSecurityClassificationGetRequest. + + + + + + + + + + + + + + + true + false + + + Modify a trunk group's Security Classification configuration + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get a system Security Classification. + The response is either SystemSecurityClassificationGetClassificationResponse or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to the SystemSecurityClassificationGetClassificationRequest. + + + + + + + + + + + + + + + + true + false + + + Add a new Security Classification + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Delete a System Security Classification + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Get system Security Classifications parameters. + The response is either SystemSecurityClassificationGetResponse21 or ErrorResponse. + + + + + + + + + + + true + false + + + Response to the SystemSecurityClassificationGetRequest21. + Contains a table with column headings: + "Name", "Priority". + + + + + + + + + + + + + + + + + true + false + + + Modify security classification parameters. + The response is either a SuccessResponse or an ErrorResponse. + NOTE: The security classifications must be specified in order of priority. The command fails if all the security classifications defined for the system are not provided. + + + + + + + + + + + + + + + + + true + false + + + Modify a Security Classification + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get a user's Security Classifications configuration. + The response is either UserSecurityClassificationGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSecurityClassificationGetRequest. + + + + + + + + + + + + + + + true + false + + + Modify a user's Security Classification configuration + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Get a list of users that currently have the specified Security Classification assigned. + The response is either SystemSecurityClassificationGetClassificationUserUsageListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Response to the SystemSecurityClassificationGetClassificationUserUsageListRequest. + Contains a table with column headings: + "User ID", "Last Name", "First Name", "Phone Number", "Extension", "Service Provider Id", "Group Id". + + + + + + + + + + + + + + + true + false + + + Get a list of users that currently have the specified Security Classification assigned. + The response is either SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Response to the SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest. + Contains a table with column headings: + "Trunk Group Name","Group ID","Organization ID" and "Organization Type" + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallAcceptance.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallAcceptance.xsd new file mode 100644 index 0000000..9a3a4bb --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallAcceptance.xsd @@ -0,0 +1,205 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's selective call acceptance service. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's selective call acceptance service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the user's selective call acceptance criteria listing. + The response is either a UserSelectiveCallAcceptanceGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSelectiveCallAcceptanceGetCriteriaListRequest. + The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + Get a criteria for the user's selective call acceptance service. + The response is either a UserSelectiveCallAcceptanceGetCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSelectiveCallAcceptanceGetCriteriaRequest21. + + + + + + + + + + + + + + + + + + + Activate the user's selective call acceptance criteria list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a criteria for the user's selective call acceptance service. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallRejection.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallRejection.xsd new file mode 100644 index 0000000..9e115f8 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSelectiveCallRejection.xsd @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's selective call rejection service. + For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's selective call rejection service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the user's selective call rejection criteria listing. + The response is either a UserSelectiveCallRejectionGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSelectiveCallRejectionGetCriteriaListRequest. + The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". + The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: + - Primary + - Alternate X (where x is a number between 1 and 10) + - Mobility + The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: + - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. + - When no number is available a blank space is provided instead. + The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: + - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. + - For Mobility Calls To Type, this is always blank. + - When no extension is available a blank space is provided instead. + + + + + + + + + + + + + + + Get a criteria for the user's selective call rejection service. + The response is either a UserSelectiveCallRejectionGetCriteriaResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSelectiveCallRejectionGetCriteriaRequest21. + Private Phone Numbers are omitted from the fromDnCriteria. + + + + + + + + + + + + + + + + + + + + Activate the user's selective call rejection criteria list. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Modify a criteria for the user's selective call rejection service. + For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + The call type criteria used within an add/get request. + + + + + + + + + + + + + + The call type criteria used within a modify request. + + + + + + + + + + + + + + Selection criteria for a call type. + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSequentialRing.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSequentialRing.xsd new file mode 100644 index 0000000..ae63b82 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSequentialRing.xsd @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's sequential ring service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's sequential ring service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a criteria for the user's sequential ring service. + The response is either a UserSequentialRingGetCriteriaResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSequentialRingGetCriteriaRequest16. + + + + + + + + + + + + + + + + + + Get the user's sequential ring service setting. + The response is either a UserSequentialRingGetResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSequentialRingGetRequest14sp4. The criteria table's column headings are: + "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted" and "Holiday Schedule". + + + + + + + + + + + + + + + + + + + + + + + + Modify a criteria for the user's sequential ring service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modify the user's sequential ring service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Sequential Ring Location. + + + + + + + + + + + + + Sequential Ring Location. + + + + + + + + + + + + + Number of Rings until call is redirected to next location in sequence. + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSeriesCompletion.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSeriesCompletion.xsd new file mode 100644 index 0000000..e3f1f92 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSeriesCompletion.xsd @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds a Series Completion group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + Deletes a Series Completion group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Get a list of users that can be assigned to a Series Completion group. + The available user list for a new Series Completion group can be obtained + by not setting the name. + The response is either GroupSeriesCompletionGetAvailableUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + Response to the GroupSeriesCompletionGetAvailableUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request to get a list of Series Completion instances within a group. + The response is either GroupSeriesCompletionGetInstanceListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupSeriesCompletionGetInstanceListRequest. + + + + + + + + + + + + + + + Gets a Series Completion group. + The response is either GroupSeriesCompletionGetInstanceResponse or ErrorResponse. + + + + + + + + + + + + + + + + + Response to the GroupSeriesCompletionGetInstanceRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Modifies a Series Completion group. Replaces the entire list of users in the group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + Gets the details of the Series Completion group that a user belongs to (if any). + Any user can only belong to one Series Completion group. + The response is either UserSeriesCompletionGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSeriesCompletionGetRequest. + Identifies which Series Completion group the user belongs to and the list of users in the group. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Department", "Phone Number", "Extension", "Email Address". + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceServiceScripts.xsd b/share/OCISchemaAS/Services/OCISchemaServiceServiceScripts.xsd new file mode 100644 index 0000000..ea665b4 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceServiceScripts.xsd @@ -0,0 +1,287 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clear the Service Script Group Log. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request the group level data associated with Service Scripts Group Log. + The response is either a GroupServiceScriptsGroupGetLogResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupServiceScriptsGroupGetLogRequest. + + + + + + + + + + + + + + + Request the group level data associated with Service Scripts Group Configuration. + The response is either a GroupServiceScriptsGroupGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupServiceScriptsGroupGetRequest. + + + + + + + + + + + + + + + + + Modify the group level data associated with Service Scripts Configuration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Clear the Service Script User Log. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request the user level data associated Service Scripts User Log. + The response is either a UserServiceScriptsGetUserLogResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserServiceScriptsUserGetLogRequest. + + + + + + + + + + + + + + + Request the user level data associated with Service Scripts User Configuration. + The response is either a UserServiceScriptsUserGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserServiceScriptsUserGetRequest. + + + + + + + + + + + + + + + + + Modify the user level data associated with Service Scripts User Configuration. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Service Script supported provisioning mode. + + + + + + + + + + + + Service Script name. + + + + + + + + + + + + Service Scripts File Resource for uploading file content. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSharedCallAppearance.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSharedCallAppearance.xsd new file mode 100644 index 0000000..8cdd96f --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSharedCallAppearance.xsd @@ -0,0 +1,208 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Associate an access device instance to the user's Shared Call Appearance. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Disassociate one or more of a user's Shared Call Appearance endpoints. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the user's Shared Call Appearance endpoint setting. + The response is either a UserSharedCallAppearanceGetEndpointResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSharedCallAppearanceGetEndpointRequest. + + + + + + + + + + + + + + + + + Get the user's Shared Call Appearance service setting. + The response is either a UserSharedCallAppearanceGetResponse16sp2 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSharedCallAppearanceGetRequest16sp2. + The endpointTable contains columns: + "Device Level", "Device Name", "Device Type", "Line/Port", "SIP Contact", "Port Number", "Device Support Visual Device Management". + The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. + Port numbers are only used by devices with static line ordering. + + The following elements are only used in AS data mode: + enableCallParkNotification + + + + + + + + + + + + + + + + + + + + + + + + Associate/Disassociate an access device instance to the user's Shared Call Appearance. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Modify the user's Shared Call Appearance service setting. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + enableCallParkNotification + + + + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingFamily.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingFamily.xsd new file mode 100644 index 0000000..dd17737 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingFamily.xsd @@ -0,0 +1,194 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's simultaneous ring family service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's simultaneous ring family service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a criteria for the user's simultaneous ring family service. + The response is either a UserSimultaneousRingFamilyGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSimultaneousRingFamilyGetCriteriaRequest. + + + + + + + + + + + + + + + + + + Get the user's simultaneous ring family service setting. + The response is either a UserSimultaneousRingFamilyGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSimultaneousRingFamilyGetRequest17. + Contains a criteria table wich column heading: "Is Active", "Criteria Name", "Time Schedule", "Holiday Schedule", "Calls From" and "Blacklisted". + + + + + + + + + + + + + + + + + + Modify a criteria for the user's simultaneous ring family service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modify the user's simultaneous ring family service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingPersonal.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingPersonal.xsd new file mode 100644 index 0000000..8503998 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSimultaneousRingPersonal.xsd @@ -0,0 +1,194 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a criteria to the user's simultaneous ring personal service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a criteria from the user's simultaneous ring personal service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get a criteria for the user's simultaneous ring personal service. + The response is either a UserSimultaneousRingPersonalGetCriteriaResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSimultaneousRingPersonalGetCriteriaRequest. + + + + + + + + + + + + + + + + + + Get the user's simultaneous ring personal service setting. + The response is either a UserSimultaneousRingPersonalGetResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSimultaneousRingPersonalGetRequest17. + Contains a criteria table with column heading: "Is Active", "Criteria Name", "Time Schedule", "Holiday Schedule", "Calls From" and "Blacklisted". + + + + + + + + + + + + + + + + + + Modify a criteria for the user's simultaneous ring personal service. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modify the user's simultaneous ring personal service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSpeedDial100.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSpeedDial100.xsd new file mode 100644 index 0000000..360759d --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSpeedDial100.xsd @@ -0,0 +1,298 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the speed dial 100 service settings for a group. + The response is either a GroupSpeedDial100GetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupSpeedDial100GetRequest17sp1. + + + + + + + + + + + + + + + Modify the speed dial 100 prefix setting for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Get the speed dial 100 system-wide default setting. + The response is either a SystemSpeedDial100GetResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + Response to the SystemSpeedDial100GetRequest17sp1. + + + + + + + + + + + + + + + Modify the speed dial 100 system-wide default prefix setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Add one or more speed dial 100 settings for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete one or more speed dial 100 settings for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the speed dial 100 settings for a user. + The response is either a UserSpeedDial100GetListResponse17sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSpeedDial100GetListRequest17sp1. + + + + + + + + + + + + + + + + Get speed dial 100 settings for a speed code. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the UserSpeedDial100GetRequest. + + + + + + + + + + + + + + + + Modify the speed dial 100 settings for a user. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + + Modify the speed dial 100 prefix setting for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + Modify the speed dial 100 prefix setting for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + Speed Dial 100 codes. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceSpeedDial8.xsd b/share/OCISchemaAS/Services/OCISchemaServiceSpeedDial8.xsd new file mode 100644 index 0000000..c173b57 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceSpeedDial8.xsd @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the speed dial 8 settings for a user. + The response is either a UserSpeedDial8GetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserSpeedDial8GetListRequest. + + + + + + + + + + + + + + + Modify the speed dial 8 settings for a user. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + + Modify the speed dial 8 prefix setting for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + Speed Dial 8 codes. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceThirdPartyIMP.xsd b/share/OCISchemaAS/Services/OCISchemaServiceThirdPartyIMP.xsd new file mode 100644 index 0000000..b8bdab5 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceThirdPartyIMP.xsd @@ -0,0 +1,93 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the system Third-Party IMP service attributes. + The response is either SystemThirdPartyIMPGetResponse19 or ErrorResponse. + + + + + + + + + + + Response to the SystemThirdPartyIMPGetRequest19. + The response contains the system Third-Party IMP service attributes. + + The following elements are only used in AS data mode: + boshURL + + + + + + + + + + + + + + + + + Modify the system Third-Party IMP service attributes. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + boshURL + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceThirdPartyVoiceMailSupport.xsd b/share/OCISchemaAS/Services/OCISchemaServiceThirdPartyVoiceMailSupport.xsd new file mode 100644 index 0000000..f236132 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceThirdPartyVoiceMailSupport.xsd @@ -0,0 +1,412 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Third-Party Voice Mail Support. + The response is either a UserThirdPartyVoiceMailSupportGetResponse17 or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserThirdPartyVoiceMailSupportGetRequest17. + + + + + + + + + + + + + + + + + + + + + + + + Modify the Third Party Voice Mail Support settings for a user. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Request the group level data associated with Third-Party Voice Mail Support. + The response is either a GroupThirdPartyVoiceMailSupportGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupThirdPartyVoiceMailSupportGetRequest. + + + + + + + + + + + + + + + + Modify the Third Party Voice Mail Support settings for a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + true + false + + + Request to add a ThirdPartyVoiceMailSupport User DN to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Request to delete a ThirdPartyVoiceMailSupport User DN from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Request to get a list of ThirdPartyVoiceMailSupport User DN's defined in the system. + The response is either a SystemThirdPartyVoiceMailSupportGetDnListResponse or an ErrorResponse. + The search can be done using multiple criterion. + + + + + + + + + + + + + + + + true + false + + + Response to SystemThirdPartyVoiceMailSupportGetDnListRequest. + Contains a table with a row for each ThirdPartyVoiceMailSupport User DN and column headings: + "Phone Number", "Description" + + + + + + + + + + + + + + + true + false + + + Request to modify a ThirdPartyVoiceMailSupport User DN and description in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Third Party Voice Mail user-level voice mail server choices. + + + + + + + + + + + + Mailbox Id type on Third Party Voice Mail platform. + + + + + + + + + + + + Uniquely identifies an external voice mail server. + + + + + + + + + + + + Number of Rings until call is redirected to voice mail. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request the system level data associated with Third-party Voice Mail Support. + The response is either a SystemThirdPartyVoiceMailSupportGetResponse17sp4 or an + ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemThirdPartyVoiceMailSupportGetRequest17sp4. + + + + + + + + + + + + + + + + Modify the system level data associated with Third-party Voice Mail Support. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + stripDiversionOnVMDestinationRetrieval + + + + + + + + + + + + + + + + ThirdPartyVoiceMailSupport User DN's Description. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceTrunkGroup.xsd b/share/OCISchemaAS/Services/OCISchemaServiceTrunkGroup.xsd new file mode 100644 index 0000000..fa5ad0e --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceTrunkGroup.xsd @@ -0,0 +1,2228 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add an enterprise trunk in an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add users to an enterprise trunk in an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete an enterprise trunk in an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to delete users from an enterprise trunk in an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to add users to an enterprise trunk in an enterprise. If the user is already assigned to another enterprise trunk, + it will be unassigned from the old enterprise trunk and assigned to the new enterprise trunk specified in this request. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to get the list of all available trunk groups defined in an enterprise. It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest. + + + + + + + + + + + + + + Request the list of users that are available to be added to an enterprise trunk. This list contains users in the enterprise that are trunk users and not already assigned to an enterprise trunk. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either an EnterpriseEnterpriseTrunkGetAvailableUserListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterpriseEnterpriseTrunkGetAvailableUserListRequest. + The column headings for the enterpriseTrunkUserTable are: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request to get the list of all enterprise trunks defined in an enterprise. + The response is either a EnterpriseEnterpriseTrunkGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to EnterpriseEnterpriseTrunkGetListRequest. + Contains a table of enterprise trunks defined in the enterprise + The column headings are: "Enterprise Trunk Name", "Routing Type" + + + + + + + + + + + + + + + Request to get an enterprise trunk + The response is either an EnterpriseEnterpriseTrunkGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to EnterpriseEnterpriseTrunkGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the list of users in an enterprise trunk. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a EnterpriseEnterpriseTrunkGetUserListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to EnterpriseEnterpriseTrunkGetUserListRequest. + The column headings for the enterpriseTrunkUserTable are: "Group Id", "User Id", "Last Name", "First Name", "Phone Number", "Alternate Trunk Identity", "Hiragana Last Name", "Hiragana First Name", + "Extension", "Department", "Email Address" and "Route List Assigned". + + + + + + + + + + + + + + + Request to modify an enterprise trunk in an enterprise. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add an enterprise trunk in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request to add users to an enterprise trunk in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to delete an enterprise trunk in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to delete users from an enterprise trunk in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to add users to an enterprise trunk in a group. If the user is already assigned to another enterprise trunk, + it will be unassigned from the old enterprise trunk and assigned to the new enterprise trunk specified in this request. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Request to get the list of all available trunk groups defined in a group. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Response to GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest. + + + + + + + + + + + + + + + Request the list of users that are available to be added to an enterprise trunk. This list contains users in the group that are trunk users and not already assigned to an enterprise trunk. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a GroupEnterpriseTrunkGetAvailableUserListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupEnterpriseTrunkGetAvailableUserListRequest. + The column headings for the enterpriseTrunkUserTable are: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Request to get the list of all enterprise trunks defined in a group. + The response is either a GroupEnterpriseTrunkGetListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupEnterpriseTrunkGetListRequest. + Contains a table of enterprise trunks defined in the enterprise + The column headings are: "Enterprise Trunk Name", "Routing Type" + + + + + + + + + + + + + + + Request to get an enterprise trunk + The response is either an GroupEnterpriseTrunkGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupEnterpriseTrunkGetRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the list of users in an enterprise trunk. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a GroupEnterpriseTrunkGetUserListResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Response to GroupEnterpriseTrunkGetUserListRequest. + The column headings for the enterpriseTrunkUserTable are: "User Id", "Last Name", "First Name", "Phone Number", "Alternate Trunk Identity", "Hiragana Last Name", "Hiragana First Name", + "Extension", "Department", "Email Address" and "Route List Assigned". + + + + + + + + + + + + + + + Request to modify an enterprise trunk in a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Add a Trunk Group instance to a group. + The command will fail if enableNetworkAddressIdentity is set to + true and administrator is not System/Provisioning level administrator. + The response is either a SuccessResponse or an ErrorResponse. + Following attributes are only used in IMS mode: + implicitRegistrationSetSupportPolicy + useSystemImplicitRegistrationSetSupportPolicy + sipIdentityForPilotAndProxyTrunkModesPolicy + useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a Trunk Group Instance from a group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get a list of Trunk Groups for the group or enterprise. + It is possible to restrict the results to a particular department, or expand the list to the entire enterprise. + The response is either a GroupTrunkGroupGetInstanceListResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceListRequest14sp4. + Contains a table with column headings "Name", "Department", "Device Name", "Device Level", + "Group Id". + The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. + + + + + + + + + + + + + + + true + false + + + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse21 or an ErrorResponse. + The response contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", + "Department", "Email Address". + + + + + + + + + + + + + + + true + false + + + Response to GroupTrunkGroupGetInstanceRequest21. + Returns the profile information for the Trunk Group. + Contains a hosted user table with column headings: "User Id", "Last Name", + "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", + "Extension", "Department", "Email Address". + Following attributes are only used in IMS mode: + implicitRegistrationSetSupportPolicy + useSystemImplicitRegistrationSetSupportPolicy + sipIdentityForPilotAndProxyTrunkModesPolicy + useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a list of hosted users that can be assigned to a Trunk Group. + The response is either GroupTrunkGroupGetAvailableHostedUserListResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to the GroupTrunkGroupGetAvailableHostedUserListRequest. + Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". + + + + + + + + + + + + + + + Get a list of user's on a Trunk Group Instance. + The response is either a GroupTrunkGroupGetInstanceUserListResponse14sp4 or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to GroupTrunkGroupGetInstanceUserListRequest14sp4. + The response contains a 9 column table with column headings "User Id", "Last Name", + "First Name", "Department", "Phone Number", "Hiragana Last Name", "Hiragana First Name", + "Extension", "Email Address". + + + + + + + + + + + + + + + Get the maximum and bursting maximum permissible active trunk group calls for the group. + The response is either a GroupTrunkGroupGetResponse14sp9 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupTrunkGroupGetRequest14sp9. + The response contains the maximum and bursting maximum permissible active trunk group calls for the group. + + + + + + + + + + + + + + + + + + true + false + + + Modify a Trunk Group Instance in a group. + The access device cannot be modified or cleared if there are any users assigned to the Trunk Group. + The command will fail if enableNetworkAddressIdentity is set and + administrator is not System/Provisioning level administrator. + Following attributes are only used in IMS mode: + implicitRegistrationSetSupportPolicy + useSystemImplicitRegistrationSetSupportPolicy + sipIdentityForPilotAndProxyTrunkModesPolicy + useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the maximum and bursting maximum permissible active Trunk Group calls for the group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Add a list of trunk group level successful SIP OPTIONS message respoonse status codes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Add a user creation task for a trunk group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete a user creation task for a trunk group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + Get the list of user creation tasks for a trunk group. + The response is either GroupTrunkGroupUserCreationTaskGetListResponse14sp4 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupTrunkGroupUserCreationTaskGetListRequest14sp4. + Contains a table with a row for each user creation task and column headings : + "Name", "Status", "Users Created", "Total Users To Create", "Error Count". + + + + + + + + + + + + + + + Request the details of a specified user creation task for a trunk group. + The response is either GroupTrunkGroupUserCreationTaskGetResponse14sp4 or ErrorResponse. + + + + + + + + + + + + + + + + Response to a GroupTrunkGroupUserCreationTaskGetRequest14sp4. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the maximum and bursting maximum permissible active Trunk Group calls for the service provider. + The response is either a ServiceProviderTrunkGroupGetResponse14sp1 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderTrunkGroupGetRequest14sp1. + The response contains the maximum and bursting maximum permissible active trunk group calls for the service provider. + + + + + + + + + + + + + + + + Modify the maximum and bursting maximum permissible active Trunk Group calls for the service provider. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + true + false + + + Get the list of user creation tasks in the system. + The response is either SystemTrunkGroupUserCreationTaskGetListResponse14sp4 or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemTrunkGroupUserCreationTaskGetListRequest14sp4. + Contains a table with a row for each user creation task and column headings : + "Trunk Group Name", "Group Id", "Organization Id", "Organization Type", "Name", "Status", "Users Created", "Total Users To Create", "Error Count". + The "Organization Id" column is populated with either a service provider Id or an enterprise Id. + The "Organization Type" column is populated with one of the enumerated strings defined in the + OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType. + + + + + + + + + + + + + + + Request the system level data associated with the Trunk Group service. + The response is either SystemTrunkGroupGetResponse21 or ErrorResponse. + + + + + + + + + + + + + Response to SystemTrunkGroupGetRequest21. + Following attributes are only used in IMS mode: + implicitRegistrationSetSupportPolicy + sipIdentityForPilotAndProxyTrunkModesPolicy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with the Trunk Group Service. + Following attributes are only used in IMS mode. The values are saved if specified not in IMS mode: + implicitRegistrationSetSupportPolicy + sipIdentityForPilotAndProxyTrunkModesPolicy + + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a list of system level successful SIP OPTIONS message respoonse status codes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Delete a list of system level successful SIP OPTIONS message respoonse status codes. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list of system level successful SIP OPTIONS message respoonse status codes. + The response is either SystemTrunkGroupOptionsMessageResponseStatusCodeGetListResponse or ErrorResponse. + + + + + + + + + + + + + Response to the SystemTrunkGroupOptionsMessageResponseStatusCodeGetListRequest. + The response contains of the list of system level successful SIP OPTIONS message respoonse status codes. + + + + + + + + + + + + + + + Trunk group details (order and weight) for each trunk group + + + + + + + + + + + + + Determines the maximum number of reroute attempts within an enterprise trunk. + + + + + + + + + + + + Enterprise Trunk Ordering Algorithm for an Enterprise Trunk + + + + + + + + + + + + + + Trunk group details (order and weight) for each trunk group + + + + + + + + + + + + + Enterprise Trunk Route Exhaustion Action + + + + + + + + + + + + Identifies a trunk group within an Enterprise Trunk where the service provider id is already known. + + + + + + + + + + + + Trunk Group priority. + Identifies the priority of a set of trunkgroup in an Enterprise Trunk + + + + + + + + + + + + Trunk Group weight. + Identifies the weight of each trunkgroup in an Enterprise Trunk + + + + + + + + + + + + Trunk group details (order and weight) for each trunk group + + + + + + + + + + + + + Otg Dtg Identity + + + + + + + + + + + + A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + A list of enterprise trunk priority weighted trunk groups that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + A list of Group Trunk Krunk Group Names that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + A list of enterprise trunk priority weighted trunk groups in a group that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + A list of Group Trunk Krunk Group Names that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. + + + + + + + + + + + Trunk Group call forwarding always action. + + + + + + + + + + + + Failure threshold time window in seconds. + + + + + + + + + + + + Interval at which trunk group continuous OPTIONS messages are sent. + + + + + + + + + + + + Interval at which trunk group failure OPTIONS messages are sent. + + + + + + + + + + + + Trunk Group Implicit Registration Set Support policy. + + + + + + + + + + + + Numeric digit string prefix to be inserted to R-URI based on destination trunk group. + + + + + + + + + + + + State of a trunk group. + + + + + + + + + + + + Trunk Group SIP identity for pilot and proxy trunk modes policy. + + + + + + + + + + + + Number of failure or success events to trigger a status change for trunk group. + + + + + + + + + + + + Trunk Group unreachable destination action. + + + + + + + + + + + + The name of a Trunk Group User Creation Task. + + + + + + + + + + + + SIP URI format for Trunk Group User Creation. + + + + + + + + + + + + + + Trunk Group user creation task status. + + + + + + + + + + + + + + Trunk Group user creation mode. + + + + + + + + + + + + User Id format for Trunk Group User Creation. + + + + + + + + + + + + + Trunk Group Pilot User Charge Number policy + + + + + + + + + + + + + Trunk Group Pilot User Calling Line Identity policy + + + + + + + + + + + + + Trunk Group Pilot User Call Optimization Policy + + + + + + + + + + + + Options to handle the trunk group INVITEs with an unscreened redirecting identity. + + + + + + + + + + + + + + Trunk Group CLID Source for Screened Trunk Calls Policy. + "Profile Name Profile Number" indicates CLID uses name and number from screened user profile. + "Received Name Profile Number" indicates CLID uses name in FROM header and number from screened user profile. + "Received Name Received Number" indicates CLID uses name and number in FROM header. + + + + + + + + + + + + + Trunk Group User Lookup Policy in performing the trunk group user screening process for a trunk call. + "Basic" indicates the lookup is performed using FROM header only. + "Extended" indicates the lookup is performed in the precedence order of P-Preferred-Identity header, + P-Asserted-Identity header, Remote-Party-ID header, and FROM header. + + + + + + + + + + + + Choices for Support Connected Identity Policy + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceTwoStageDialing.xsd b/share/OCISchemaAS/Services/OCISchemaServiceTwoStageDialing.xsd new file mode 100644 index 0000000..765e1d4 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceTwoStageDialing.xsd @@ -0,0 +1,191 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Two Stage Dialing. + The response is either a UserTwoStageDialingGetResponse13Mp20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserTwoStageDialingGetRequest13Mp20. + + + + + + + + + + + + + + + + Modify the user level data associated with Two Stage Dialing. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request to add Two Stage Dialing number to the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Request to delete a Two Stage Dialing number from the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Request to get a list of Two Stage Dialing dns defined in the system. + The response is either a SystemTwoStageDialingGetDnListResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + Response to SystemTwoStageDialingGetDnListRequest. + The Two Stage Dialing DN List table column + headings are: "Phone Number", "Description". + + + + + + + + + + + + + + + Request to modify a Two Stage Dialing number's description in the system. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Two Stage Dialing phone number's description. + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceVideoAddOn.xsd b/share/OCISchemaAS/Services/OCISchemaServiceVideoAddOn.xsd new file mode 100644 index 0000000..7349f73 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceVideoAddOn.xsd @@ -0,0 +1,104 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's Video Add-On service setting. + The response is either a UserVideoAddOnGetResponse19 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserVideoAddOnGetRequest19. + + + + + + + + + + + + + + + + + Modify the user's Video Add-On service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Maximum Originating Call Delay. + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceVirtualOnNetEnterpriseExtensions.xsd b/share/OCISchemaAS/Services/OCISchemaServiceVirtualOnNetEnterpriseExtensions.xsd new file mode 100644 index 0000000..9193028 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceVirtualOnNetEnterpriseExtensions.xsd @@ -0,0 +1,362 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the list of Virtual On-Net users in an Enterprise. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse or + an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest. + Contains a table with column headings : "Group Id", "Last Name", "First Name", "Phone Number", "Extension", + "Virtual On-Net Call Type" in a row for each user. + + + + + + + + + + + + + + + Adds Virtual On-Net users to a Group. It is possible to add + either: a single user, or a list of users, or a range of users, + or any combination thereof. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Delete an existing Virtual On-Net user from a Group. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the list of Virtual On-Net users in a Group. + It is possible to search by various criteria to restrict the number + of rows returned. + Multiple search criteria are logically ANDed together. + The response is either a + GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse or an + ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + Response to GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest. + Contains a table with column headings: "Last Name", + "First Name", "Phone Number", "Extension", + "Virtual On-Net Call Type Name" + in a row for each user. + + + + + + + + + + + + + + + Get an existing Virtual On-Net user from a Group. + The response is either a + GroupVirtualOnNetEnterpriseExtensionsGetUserResponse + or an ErrorResponse. + + + + + + + + + + + + + + + + + Response to GroupVirtualOnNetEnterpriseExtensionsGetUserRequest. + + + + + + + + + + + + + + + + + + + + Modify an existing Virtual On-Net user of a Group. + The serviceProviderId, groupId and phoneNumber combination uniquely + identifies a Virtual On-Net User. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + Add a Virtual On-Net Call Type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete a Virtual On-Net Call Type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + Get the list Virtual On-Net Call Types in the system. + The response is either a SystemVirtualOnNetCallTypeGetListResponse + or an ErrorResponse. + + + + + + + + + + + + + Response to SystemVirtualOnNetCallTypeGetListRequest. + Contains a table with column headings: + "Virtual On-Net Call Type Name", "Virtual On-Net Call Type CDR Value" + in a row for each Virtual On-Net Call Type. + + + + + + + + + + + + + + + Modify a Virtual On-Net Call Type. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Virtual On-Net User. + + + + + + + + + + + + + + + + + Virtual On-Net User Range. + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceVoiceMessaging.xsd b/share/OCISchemaAS/Services/OCISchemaServiceVoiceMessaging.xsd new file mode 100644 index 0000000..d410f13 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceVoiceMessaging.xsd @@ -0,0 +1,2305 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the group's Voice Messaging settings. + The response is either GroupVoiceMessagingGroupGetResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to GroupVoiceMessagingGroupGetRequest. + Contains the group's voice messaging settings. + + + + + + + + + + + + + + + + + + + + + + + + Get the group's voice portal branding settings. + The response is either a GroupVoiceMessagingGroupGetVoicePortalBrandingResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalBrandingRequest20. + + + + + + + + + + + + + + + + + + Request to get the group voice portal information for a voice messaging group. + The response is either GroupVoiceMessagingGroupGetVoicePortalResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + + Response to the GroupVoiceMessagingGroupGetVoicePortalRequest19sp1. + + The following elements are only used in HSS data mode: + enableExtendedScope + + + + + + + + + + + + + + + + + + + + + + + + + Request to modify the group's voice messaging settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the group's voice portal branding settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + Request to modify the group voice portal information for a voice messaging group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + Requests the service provider's or enterprise's voice messaging settings. + The response is either ServiceProviderVoiceMessagingGroupGetResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderVoiceMessagingGroupGetRequest. + Contains the service provider's or enterprise's voice messaging settings. + + + + + + + + + + + + + + + + + + + + Get the service provider's voice portal branding settings. + The response is either a ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingResponse16 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the ServiceProviderVoiceMessagingGroupGetVoicePortalBrandingRequest16. + + + + + + + + + + + + + + + + + + + + Requests the service provider's or enterprise's voice portal settings. + The response is either ServiceProviderVoiceMessagingGroupGetVoicePortalResponse or ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderVoiceMessagingGroupGetVoicePortalRequest. + + + + + + + + + + + + + + + Request to modify a service provider's or enterprise's voice messaging settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + Modify the service provider's voice portal branding settings. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Request to change the service provider's or enterprise's voice portal settings. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + true + false + + + Requests system voice mail message summary update parameter settings. + The response is either SystemVoiceMessageSummaryUpdateGetResponse or ErrorResponse. + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessageSummaryUpdateGetRequest. + + + + + + + + + + + + + + + + + true + false + + + Modify the system level data associated with Voice Messaging. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Request the system level data associated with Voice Messaging. + The response is either a SystemVoiceMessagingGroupGetResponse21 or an ErrorResponse. + + + + + + + + + + + + + Response to SystemVoiceMessagingGroupGetRequest21. + + The following elements are only used in AS data mode: + realDeleteForImap + useDnInMailBody + useShortSubjectLine + maxMessageLengthMinutes + maxMailboxLengthMinutes + doesMessageAge + holdPeriodDays + mailServerNetAddress + mailServerProtocol + defaultDeliveryFromAddress + defaultNotificationFromAddress + useOutgoingMWIOnSMDI + mwiDelayInSeconds + voicePortalScope + enterpriseVoicePortalLicensed + networkWideMessaging + useExternalRouting + defaultExternalRoutingAddress + vmOnlySystem + clientInitiatedMailServerSessionTimeoutMinutes + recordingAudioFileFormat + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Requests the system voice portal Menus setting. + The response is either SystemVoiceMessagingGroupGetVoicePortalMenusResponse21 or ErrorResponse. + + + + + + + + + + + + + + + true + false + + + Response to SystemVoiceMessagingGroupGetVoicePortalMenusRequest21. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the system level data associated with Voice Messaging. + The response is either a SuccessResponse or an ErrorResponse. + + The following elements are only used in AS data mode: + realDeleteForImap + useDnInMailBody + useShortSubjectLine + maxMessageLengthMinutes + maxMailboxLengthMinutes + doesMessageAge + holdPeriodDays + mailServerNetAddress + mailServerProtocol + defaultDeliveryFromAddress + defaultNotificationFromAddress + useOutgoingMWIOnSMDI + mwiDelayInSeconds + voicePortalScope + enterpriseVoicePortalLicensed + networkWideMessaging + useExternalRouting + defaultExternalRoutingAddress + vmOnlySystem + clientInitiatedMailServerSessionTimeoutMinutes + recordingAudioFileFormat + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + false + + + Request to modify the system voice portal menus setting. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add one or more voice mail aliases to a users voice message. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Delete one or more voice mail aliases from a users voice message. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + Get the user's voice messaging advanced voice management service setting. + The response is either a UserVoiceMessagingUserGetAdvancedVoiceManagementResponse14sp3 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserVoiceMessagingUserGetAdvancedVoiceManagementRequest14sp3. + + + + + + + + + + + + + + + + + + + + + + + + + + Get the voice mail aliases for a users voice message. + The response is either a UserVoiceMessagingUserGetAliasListResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetAliasListRequest. + + + + + + + + + + + + + + + Get a voice mail distribution list for a users voice message. + The response is either UserVoiceMessagingUserGetDistributionListResponse or ErrorResponse. + + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetDistributionListRequest. + + + + + + + + + + + + + + + + Get the user's voice messaging greeting information. + The response is either a UserVoiceMessagingUserGetGreetingResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetGreetingRequest18sp1. + Contains the greeting configuration for a user's voice messaging. + The following elements are only used in AS data mode: + disableMessageDeposit + disableMessageDepositAction + greetingOnlyForwardDestination + extendedAwayEnabled + extendedAwayDisableMessageDeposit + extendedAwayAudioFile + extendedAwayAudioMediaType + extendedAwayVideoFile + extendedAwayVideoMediaTyp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's voice messaging outgoing SMDI message waiting indicator service setting. + The response is either a UserVoiceMessagingUserGetOutgoingSMDIMWIResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserVoiceMessagingUserGetOutgoingSMDIMWIRequest. + + + + + + + + + + + + + + + + Get the user's voice messaging voice management service settings. + The response is either a UserVoiceMessagingUserGetVoiceManagementResponse17 or an ErrorResponse. + + + + + + + + + + + + + + + Response to the UserVoiceMessagingUserGetVoiceManagementRequest17. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the user's voice messaging voice portal settings. + The response is either a UserVoiceMessagingUserGetVoicePortalResponse20 or an ErrorResponse. + + + + + + + + + + + + + + + Response to UserVoiceMessagingUserGetVoicePortalRequest20. + + + + + + + + + + + + + + + + + Modify the user's voice messaging advanced voice management service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify a voice mail distribution list for a users voice message. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + Modify the user's voice messaging greeting. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + The following elements are only used in AS data mode: + disableMessageDeposit + disableMessageDepositAction + greetingOnlyForwardDestination + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the user's voice messaging outgoing message waiting indicator service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + Modify the user's voice messaging voice management service setting. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modify the user's voice messaging voice portal settings. + The response is either a SuccessResponse or an ErrorResponse. + Engineering Note: This command is used internally by Call Processing. + + + + + + + + + + + + + + + + + + Voice Portal Scope. + The Service Provider option allows users to log in to their voice portal using the voice portal + of any group that is both hosted on the same application server and within the same service provider + or enterprise. + The Group option keeps groups completely independent. Users can only log in to their voice portal + using the access number for their group. + + + + + + + + + + + + Voice Portal Scope. + When set to System, users can call any group voice portal hosted on the same Application Server + as themselves rather than only the voice portal of their own group to initiate the login process. + When set to Service Providers, the voice portal scope is configured within the Service Provider. + + + + + + + + + + + + The configuration of a alternate no answer greeting. + It is used when modifying a user's voice messaging greeting. + + + + + + + + + + + + + The configuration of a alternate no answer greeting. + It is used when geting a user's voice messaging greeting. + + + + + + + + + + + + + Distribution List Description. + + + + + + + + + + + + Distribution List Id. + + + + + + + + + + + + Voice Messaging group-level mail server choices. + + + + + + + + + + + + Mailbox length for voice messages + + + + + + + + + + + + + + + + + + + + + + + + + + + + Hold period for voice messages + + + + + + + + + + + + + + + + + + + + + Protocol used by mail server holding voice messages + + + + + + + + + + + + User Id for a mail server. + + + + + + + + + + + + Maximum length of message in minutes. + + + + + + + + + + + + The media type of a voice message. + WAV - A WAV file + MP3 - an MP3 file + + + + + + + + + + + + Choices to handle a voice message. + + + + + + + + + + + + Message Waiting Indicator delay in seconds. + + + + + + + + + + + + Voice Messaging user-level mail server choices. + + + + + + + + + + + + A sequence of digits used by the voice portal. + + + + + + + + + + + + + Choices for the voice portal's external routing to decide which settings to use. + + + + + + + + + + + + Duration of XSI session timeout period for Voice Messaging + service. + + + + + + + + + + + + Minimum time interval between message summary update notifications in seconds. + This parameter is used to avoid SIP signaling overload due to frequent device registration. + Broadworks sends the message-summary only if the minimum time interval has elapsed. + Configuring a value of zero causes the message-summary to be sent on every incoming registration (thus disabling the throttling mechanism). + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceVoicePortalCalling.xsd b/share/OCISchemaAS/Services/OCISchemaServiceVoicePortalCalling.xsd new file mode 100644 index 0000000..b0005dd --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceVoicePortalCalling.xsd @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request the user level data associated with Voice Portal Calling. + The response is either a UserVoicePortalCallingGetResponse or an + ErrorResponse. + + + + + + + + + + + + + + + Response to UserVoicePortalCallingGetRequest. + + + + + + + + + + + + + + + Modify the user level data associated with Voice Portal Calling. + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceVoiceXml.xsd b/share/OCISchemaAS/Services/OCISchemaServiceVoiceXml.xsd new file mode 100644 index 0000000..375ced3 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceVoiceXml.xsd @@ -0,0 +1,190 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add a VoiceXML instance to a group. + The domain is required in the serviceUserId. For a valid voiceXml instance to work properly, + a device with Static Registration is expected with a valid contact. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + + + + + + Delete a VoiceXML instance from a group. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Get a list of VoiceXML instances within a group. + The response is either GroupVoiceXmlGetInstanceListResponse or ErrorResponse. + It is possible to get the instances within a specified department. + + + + + + + + + + + + + + + + + Response to the GroupVoiceXmlGetInstanceListRequest. + Contains a table with column headings: + "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active". + The column values for "Is Active" can either be true, or false. + + + + + + + + + + + + + + + Request to get all the information of a VoiceXML instance. + The response is either GroupVoiceXmlGetInstanceResponse19sp1 or ErrorResponse. + + + + + + + + + + + + + + + Response to GroupVoiceXmlGetInstanceRequest19sp1. + Contains the service profile information and possibly access device information. + + + + + + + + + + + + + + + + + Request to set the active status of VoiceXML instances. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + Request to modify a VoiceXML instance. For a valid voiceXml instance to work properly, + a device with Static Registration is expected with a valid contact. + The response is either SuccessResponse or ErrorResponse. + + + + + + + + + + + + + + + diff --git a/share/OCISchemaAS/Services/OCISchemaServiceZoneCallingRestrictions.xsd b/share/OCISchemaAS/Services/OCISchemaServiceZoneCallingRestrictions.xsd new file mode 100644 index 0000000..fc992b4 --- /dev/null +++ b/share/OCISchemaAS/Services/OCISchemaServiceZoneCallingRestrictions.xsd @@ -0,0 +1,146 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the Service Provider/Enterprise level Zone Calling Restrictions Policies. + The response is ServiceProviderZoneCallingRestrictionsGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Response to ServiceProviderZoneCallingRestrictionsGetRequest + + + + + + + + + + + + + + + + + + Modifies the Service Provider/Enterprise level Zone Calling Restrictions Policies. + The response is SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + + + + + + + Gets the home zone for a user + The response is either a UserZoneCallingRestrictionsGetResponse or an ErrorResponse. + + + + + + + + + + + + + + + Gets the home zone for a user + Response to a UserZoneCallingRestrictionsGetRequest + + + + + + + + + + + + + + + Modify the home zone for a user + The response is either a SuccessResponse or an ErrorResponse. + + + + + + + + + + + + + diff --git a/share/OCISchemaBASE/OCISchemaBASE.xsd b/share/OCISchemaBASE/OCISchemaBASE.xsd new file mode 100644 index 0000000..1d41e38 --- /dev/null +++ b/share/OCISchemaBASE/OCISchemaBASE.xsd @@ -0,0 +1,207 @@ + + + + + + + + + + + + + + + + + Every Message starts with a BroadsoftDocument tag. + + + + + + A message contains a list of requests or responses. The server processes all the requests + and returns a message with a corresponding list of responses. + + + + + + + + The session id identifies a logged-in user. The client is responsible to ensure the uniqueness of the session id. + + + + + + + The user id identifies a preauthenticated user performing a session-less OCI request. The source of the request + must be in the external authentication access control list. + + + + + + + The phone number identifies a preauthenticated user performing a session-less OCI request. The source of the request + must be in the external authentication access control list. + The phone number must be in E.164 format. Any DN associated with the user may be used. + BroadSoft recommends only using this element in the rare case when the userId is not known. + + + + + + + List of requests or responses. + + + + + + + + + + + + + + + + + The OCICommand is an abstract type from which all requests and responses are derived. + + + + + + + The client can send the echo attribute in any request and the server will return the echo attribute in the response. + + + + + + + + The OCIRequest is an abstract type from which all requests are derived. + + + + + + + + + + + + The OCIResponse is an abstract type from which all responses are derived. + + + + + + + + + Used during software development only. Will never be used in a production system. + + + + + + + + + + The OCIDataResponse is an abstract base type for all responses containing some sort of data other than + merely a success or failure indication. + + + + + + + + + + + + The SuccessResponse is concrete response sent whenever a transaction is successful and does not return any data. + + + + + + + + + + + + The ErrorResponse is concrete response sent whenever a transaction fails and does not return any data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The OCITable type is used in responses only, never in requests. + The table consists of rows and columns of strings. Each column has a column + heading. Clients should search the column headings to find a particular + column. Clients should not assume any particular column order as future + revisions of the protocol may move or add columns. + + + + + + + + + + + The OCITableRow type is used in responses only, never in requests. It occurs + inside the OCITable type. The OCITableRow consists columns of strings. + Clients should not assume any particular column order as future + revisions of the protocol may move or add columns. See the OCITable data type + for more information. + + + + + + + diff --git a/t/00-load.t b/t/00-load.t new file mode 100644 index 0000000..2d6bcbd --- /dev/null +++ b/t/00-load.t @@ -0,0 +1,13 @@ +#!perl -T +use 5.006; +use strict; +use warnings FATAL => 'all'; +use Test::More; + +plan tests => 1; + +BEGIN { + use_ok( 'BroadWorks::OCI' ) || print "Bail out!\n"; +} + +diag( "Testing BroadWorks::OCI $BroadWorks::OCI::VERSION, Perl $], $^X" ); diff --git a/t/boilerplate.t b/t/boilerplate.t new file mode 100644 index 0000000..65d0938 --- /dev/null +++ b/t/boilerplate.t @@ -0,0 +1,57 @@ +#!perl -T +use 5.006; +use strict; +use warnings FATAL => 'all'; +use Test::More; + +plan tests => 3; + +sub not_in_file_ok { + my ($filename, %regex) = @_; + open( my $fh, '<', $filename ) + or die "couldn't open $filename for reading: $!"; + + my %violated; + + while (my $line = <$fh>) { + while (my ($desc, $regex) = each %regex) { + if ($line =~ $regex) { + push @{$violated{$desc}||=[]}, $.; + } + } + } + + if (%violated) { + fail("$filename contains boilerplate text"); + diag "$_ appears on lines @{$violated{$_}}" for keys %violated; + } else { + pass("$filename contains no boilerplate text"); + } +} + +sub module_boilerplate_ok { + my ($module) = @_; + not_in_file_ok($module => + 'the great new $MODULENAME' => qr/ - The great new /, + 'boilerplate description' => qr/Quick summary of what the module/, + 'stub function definition' => qr/function[12]/, + ); +} + +TODO: { + local $TODO = "Need to replace the boilerplate text"; + + not_in_file_ok(README => + "The README is used..." => qr/The README is used/, + "'version information here'" => qr/to provide version information/, + ); + + not_in_file_ok(Changes => + "placeholder date/time" => qr(Date/time) + ); + + module_boilerplate_ok('lib/BroadWorks/OCI.pm'); + + +} + diff --git a/t/manifest.t b/t/manifest.t new file mode 100644 index 0000000..6ddfe36 --- /dev/null +++ b/t/manifest.t @@ -0,0 +1,15 @@ +#!perl -T +use 5.006; +use strict; +use warnings FATAL => 'all'; +use Test::More; + +unless ( $ENV{RELEASE_TESTING} ) { + plan( skip_all => "Author tests not required for installation" ); +} + +my $min_tcm = 0.9; +eval "use Test::CheckManifest $min_tcm"; +plan skip_all => "Test::CheckManifest $min_tcm required" if $@; + +ok_manifest(); diff --git a/t/pod-coverage.t b/t/pod-coverage.t new file mode 100644 index 0000000..866fac2 --- /dev/null +++ b/t/pod-coverage.t @@ -0,0 +1,20 @@ +#!perl -T +use 5.006; +use strict; +use warnings FATAL => 'all'; +use Test::More; + +# Ensure a recent version of Test::Pod::Coverage +my $min_tpc = 1.08; +eval "use Test::Pod::Coverage $min_tpc"; +plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage" + if $@; + +# Test::Pod::Coverage doesn't require a minimum Pod::Coverage version, +# but older versions don't recognize some common documentation styles +my $min_pc = 0.18; +eval "use Pod::Coverage $min_pc"; +plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage" + if $@; + +all_pod_coverage_ok(); diff --git a/t/pod.t b/t/pod.t new file mode 100644 index 0000000..a0054e9 --- /dev/null +++ b/t/pod.t @@ -0,0 +1,12 @@ +#!perl -T +use 5.006; +use strict; +use warnings FATAL => 'all'; +use Test::More; + +# Ensure a recent version of Test::Pod +my $min_tp = 1.22; +eval "use Test::Pod $min_tp"; +plan skip_all => "Test::Pod $min_tp required for testing POD" if $@; + +all_pod_files_ok(); -- 2.11.0