API 851 RefGuide 2011-09-12

API
Reference Guide
Copyright This document contains proprietary information of Artilium N.V. Any reproduction, use, appropriation, or disclosure of this information, in whole or in part, without the specific prior written authorization of Artilium is strictly prohibited. Failure to observe this notice may result in legal proceedings or liability for resulting damage or loss. 2005-201 Artilium N.V. All rights reserved. 1 Trademarks Artilium and Arta are trademarks of Artilium N.V. Other product and company names mentioned in this document may be the trademarks of their respective owners. Disclaimer Every effort has been made to ensure the accuracy of this document. However, due to ongoing product improvements and revisions, Artilium cannot guarantee the accuracy of the information contained in this document after the date of release nor can it accept responsibility for errors or omissions. Feedback If you have any comments or suggestions regarding this document, please send an e-mail to the following address: documentation@artilium.com Version info September 12, 201 1
API . Reference Guide
Contents
Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Revision history. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 Chapter 2: ContactType1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 AddContactType1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 DeleteContactType1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 GetContactType1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 GetContactType1List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 GetContactType1Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 GetParametersContactType1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 UpdateContactType1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 UpdateParametersContactType1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 ValidateLogonContactType1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Chapter 3: ContactType2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 AddContactType2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 DeleteContactType2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 GetContactType2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 GetContactType2List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 GetContactType2Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 GetFilteredListOfNumbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 GetParametersContactType2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 UpdateContactType2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 UpdateParametersContactType2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 ValidateLogonContactType2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Chapter 4: ContactType3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 AddContactType3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 ChangeContactType3ToContactType2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 DeleteContactType3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 GetContactType3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 GetContactType3List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 GetContactType3Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 GetParametersContactType3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 UpdateContactType3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 UpdateParametersContactType3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 ValidateLogonContactType3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Chapter 5: Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 AddCreditsSecondsMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 AddMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 DeleteMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 GetMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 GetMasterProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 GetParametersMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 ReduceUsedCreditsSecondsMaster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 UpdateMaster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 UpdateParametersMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 ValidateLogonMaster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Contents
Chapter 6: Pin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 AddCreditsSecondsPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 AddPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 DeletePin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 GetParametersPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 GetPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 GetPinProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 ReduceUsedCreditsSecondsPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 UpdateParametersPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 UpdatePin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 ValidateLogonPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Chapter 7: CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 AddCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 AddCreditsExternalTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 AddCreditsSecondsCLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 DeleteCLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 GetCLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 GetCLIProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 GetParametersCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 GetSpecificCLIInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 MoveCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 ReduceUsedCreditsSecondsCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 SplitCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 SwapMsisdn..........................................................................................................................................................................................................................................................181 SwapSim..................................................................................................................................................................................................................................................................182 GetAvailableProvisioningSims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 UpdateCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 UpdateParametersCLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 ValidateLogonCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Chapter 8: ReferringCLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 AddReferringCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 DeleteReferringCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 GetParametersReferringCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 GetReferringCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 GetReferringCLIProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 UpdateParametersReferringCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 UpdateReferringCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 Chapter 9: VoucherPin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 AddCreditsViaVoucherPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 AddCreditsVoucherPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 AddVoucherPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 DeleteVoucherPin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 GetParametersVoucherPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 GetVoucherPin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 GetVoucherPinProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 UpdateParametersVoucherPin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 UpdateVoucherPin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Contents
Chapter 10: CDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 GetCDRList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 GetCDRList2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 GetCDRListWithDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 GetCDRListWithDetails2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 GetFullCDRList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 GetFullCDRListWithDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 Chapter 11: Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 GetInvoiceList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 GetPdfInvoice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Chapter 12: Commission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 GetCommissionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 GetPdfCommission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Chapter 13: ReloadHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 GetReloadHistoryList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 Chapter 14: PlaceCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 CreateNewCallGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 GetAllCallGroupsFromSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 GetAllCallsInCallGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 InsertCallInCallGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 UpdateAllCallsInCallGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271 UpdateCallGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 UpdateCallInCallGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 Chapter 15: Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275 AddUpdateDestinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 AddUpdateShortcodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 DeleteDestinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 DeleteShortcodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 GetDestinationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 GetShortcodeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 GetDestinationReferenceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 GetShortcodeReferenceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Contents
Chapter 16: Price management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 AddCustomerProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293 AddPriceVariation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295 AddProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 AddProductCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 AddProductPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302 ChangePriceVariationSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306 ChangeProductConditionSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 CheckProductCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308 DeleteCustomerProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309 DeletePriceVariation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310 DeleteProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 DeleteProductCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 DeleteProductPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 GetContacttype2ProductPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 GetCustomerProduct. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316 GetCustomerProductInfoFromSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318 GetCustomerProductList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320 GetPriceModifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322 GetPriceModifierList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324 GetPriceVariation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 GetPriceVariationList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328 GetPriceVariationListByPricePlanChangeSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331 GetProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334 GetProductCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336 GetProductConditionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338 GetProductList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340 GetProductListByPricePlanChangeSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 GetProductPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344 GetProductPriceList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346 GetProductPriceListByPricePlanChangeSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 UpdateCustomerProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350 UpdatePriceVariation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351 UpdateProduct. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 UpdateProductCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 UpdateProductModifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 UpdateProductPrice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 Chapter 17: PricePlanChangeSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360 AddPricePlanChangeSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361 DeletePricePlanChangeSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363 GetPricePlanChangeSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364 GetPricePlanChangeSetList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366 GetPricePlanChangeSetDetailList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368 UpdatePricePlanChangeSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Contents
Chapter 18: Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 ChangePackageForContactType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373 ChangePackageForSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 GetListAvailablePackagesForContactType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 GetListAvailablePackagesForSN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 GetListPackageOptionsForContactType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 GetListPackageOptionsForSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381 GetPackageInfoContactType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383 GetPackageInfoFromSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385 GetPackageList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 GetPackageListByPricePlanChangeSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389 UpdatePackageOptionsForSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391 Chapter 19: RegionDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393 GetRegionDefinitionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394 GetRegionDefinitionListByPricePlanChangeSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Contents
Chapter 20: Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398 AddBundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400 AddBundleAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402 AddBundleAssignCondition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404 AddBundleCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406 AddBundleCustDestination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408 AddBundleDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410 AddBundleThresholdEventDefinitionToBundleDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412 AddBundleThresholdEventDefinitionToOverallBundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414 AddEmailNotificationForBundleThresholdEventDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415 AddEmailNotificationForBundleUsageSetEventDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416 AddSmsNotificationForBundleThresholdEventDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417 AddSmsNotificationForBundleUsageSetEventDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418 ChangeBundleAssignConditionSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419 ChangeBundlePriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420 CheckBundleAssignCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421 DeleteBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422 DeleteBundleAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423 DeleteBundleAssignCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424 DeleteBundleCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425 DeleteBundleCustDestination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426 DeleteBundleDefinition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427 DeleteBundleThresholdEventDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428 DeleteMessageNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429 GetBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430 GetBundleAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432 GetBundleAssignCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434 GetBundleAssignConditionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436 GetBundleAssignList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438 GetBundleCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440 GetBundleCallList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442 GetBundleCustDestination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444 GetBundleCustDestinationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446 GetBundleDefinition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 GetBundleDefinitionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450 GetBundleList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452 GetBundleThresholdEventDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454 GetBundleThresholdEventDefinitionListOfBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 GetBundleThresholdEventDefinitionListOfBundleDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 GetBundleThresholdMessageNotificationList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 GetBundleUsage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459 GetBundleUsageList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461 GetBundleUsageSetEventDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 GetBundleUsageSetMessageNotificationList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 IsBundleReadonly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 SetBundleUsageSetEventDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467 UpdateBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468 UpdateBundleAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470 UpdateBundleAssignCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472 UpdateBundleAvailability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474 UpdateBundleCall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 UpdateBundleCustDestination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 UpdateBundleDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 UpdateBundleThresholdEventDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Contents
UpdateEmailNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 UpdateSmsNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 Chapter 21: SMS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 AddSMSSent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 GetSMSReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487 GetSMSReceivedList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489 GetSMSSent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491 GetSMSSentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493 UpdateSMSReceived. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 Chapter 22: Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 AddIMSI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497 AddIMSIMSISDN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 AddMSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500 AddSIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502 DeleteIMSI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504 DeleteIMSIMSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 DeleteMSISDN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506 DeleteSIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507 DetachMSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508 GetIMSI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509 GetIMSIList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 GetIMSIMSISDNList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513 GetMSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 GetMSISDNList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516 GetSIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518 GetSIMList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520 UpdateIMSI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522 UpdateMSISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523 UpdateSIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525 Chapter 23: NumberPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527 AddNumberPort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528 DeleteNumberPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 GetNumberPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531 GetNumberPortList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532 UpdateNumberPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534 Chapter 24: ResellerMobileNumberPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535 PortInRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536 Cancel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538 GetPendingPorts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539 GetRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541 GetGroupDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 Accept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545 Reject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
10
Contents
Chapter 25: Base tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548 GetCallModeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 GetConversionCodeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551 GetCountryList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553 GetCountryPrefixesList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555 GetCurrencyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557 GetLanguageList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559 GetOperatorList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561 GetRegionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563 GetTimeZoneList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564 GetTrafficList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
1 1
Contents
Chapter 26: General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567 GetAccountTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569 GetActivationCPSList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571 GetCommissionPlanList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573 GetCountryList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574 GetCurrencyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576 GetCustomer1ClassificationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578 GetCustomer1PrintingDispatchList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579 GetCustomer2ClassificationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581 GetCustomer2PrintingDispatchList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583 GetDiscountTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585 GetDistributorList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587 GetFeeAmountList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588 GetFeeExclusionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590 GetFeePeriodicityList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592 GetFMCCategoryList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593 GetFMCLocationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594 GetGenderList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596 GetInitiatorList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598 GetLanguageList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600 GetMessagesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602 GetMinCarrierQualityList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603 GetNumberCategoryList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605 GetOperatorList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607 GetPaymentMethodList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608 GetPaymentTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610 GetPinOnInvoiceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612 GetPrintGraphList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 GetPrintingAddresseeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616 GetProfileCLIPinList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618 GetReloadSubTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619 GetReloadTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621 GetRequestCPSList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623 GetSalesPointList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625 GetRoundingList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626 GetSolvencyStatusList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627 GetStatusList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629 GetTableKeyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631 GetTaxationMethodLegAList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634 GetTaxationMethodLegBList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636 GetTitleList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638 GetTrafficTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640 GetTypeList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642 GetUseAlternativeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644 GetVATFrequencyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646 GetVATRateList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648 Chapter 27: Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650 AddLogging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651 GetLoggingList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652 Chapter 28: System setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654 GetSystemSetting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
12
Contents
Chapter 29: LCMPinInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657 AddLCMPinInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658 DeleteLCMPinInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659 GetLCMPinInfobySN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660 UpdateLCMPinInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661 Chapter 30: External Billing Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662 GetExternalBillingReferenceById . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663 GetExternalBillingReferenceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665 Chapter 31: DocText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667 GetDocumentText. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668 GetDocumentTextList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669 AddDocumentText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670 DeleteDocumentText. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671 UpdateDocumentText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672 Chapter 32: Porting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673 PortInRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674 GetAvailablePortInMsisdns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676 GetPendingPortIns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678 CancelPortIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680 GetPendingPortOuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681 AcceptPortOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683 RejectPortOut. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684 Appendix A: Field lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686 Contact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687 CLI/PIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
13
Revision history
Revision history
8.51
Porting (new service!) Added support for porting numbers in or out in accordance with the Dutch porting workflow. To use the Belgian number porting workflow, use the APIs of the ResellerMobileNumberPort service. CLI Changed methods: SwapMsisdn: supports workflow where the new MSISDNs are provided by the network or by the reseller SwapSim: supports workflow where the new SIMs are SIMs from a pool of swap cards or SIMs of pre-provisioned numbers
8.50
Bundle Added support for revised bundle definitions
8.30
Bundle Added support for bundle threshold and usage set event definitions and notifications via SMS and email. DocText (new service!) Methods to add/update/delete/retrieve document texts, which are used to build notifications, for example.
8.20
CDR Added methods (Associated Bundles): GetFullCDRList GetFullCDRListWithDetails Bundle Added support (i.e. return value) for read-only bundles to the Update and Delete methods Added methods (Associated Bundles): UpdateBundleAvailability IsBundleReadonly Changed methods: GetBundle - Added ReadOnly property
7.51
External Billing Reference (new service!)
7.50
WSDL Service contracts have changed since 7.47 and must be downloaded. CDR Added methods (VAT-TAX premium charging): GetCDRList2
14
Revision history
GetCDRListWithDetails GetCDRListWithDetails2 CLI Changed methods: AddCLI - Changed input field Country Renamed to CountryId Data type changed from String to Int32 Became mandatory GetCLI - Different output type (int) for Country UpdateCLI - Changed input field Country (see AddCLI) Added methods: SplitCLI SwapMsisdn SwapSim LCMPinInfo (new service!) Added methods (lifecycle management): AddLCMPinInfo DeleteLCMPinInfo GetLCMPinInfoBySN UpdateLCMPinInfo Master Changed methods: AddMaster - Changed input field Country (see AddCLI) GetMaster - Different output type (int) for Country UpdateMaster - Changed input field Country (see AddCLI) Packages Added method (4-Eyes): GetPackageListByPricePlanChangeSet Changed methods (lifecycle management): GetPackageList - Added UseForGrace field Pin Changed methods: AddPin - Changed input field Country (see AddCLI) GetPin - Different output type (int) for Country UpdatePin - Changed input field Country (see AddCLI) Price management Changed methods (4-Eyes): AddPriceVariation - Added required input field PricePlanChangeSetId AddProduct - Added required input fields ValidFrom, ValidUntil, PricePlanChangeSetId AddProductPrice - Added required input field PricePlanChangeSetId DeletePriceVariation - Added required input field PricePlanChangeSetId DeleteProduct - Added required input field PricePlanChangeSetId DeleteProductPrice - Added required input field PricePlanChangeSetId GetPriceVariation(List) - Added output fields StatusChangeSet and PricePlanChangeSetId GetProduct(List) - Added output fields StatusChangeSet and PricePlanChangeSetId GetProductPrice(List) - Added output fields StatusChangeSet and PricePlanChangeSetId
15
Revision history
UpdatePriceVariation - Added required input field PricePlanChangeSetId UpdateProduct - Added required input fields ValidFrom, ValidUntil, PricePlanChangeSetId UpdateProductModifier - Added required input field PricePlanChangeSetId UpdateProductPrice - Added required input field PricePlanChangeSetId Added methods: GetPriceVariationListByPricePlanChangeSet GetProductListByPricePlanChangeSet GetProductPriceListByPricePlanChangeSet PricePlanChangeSet (new service!) Added methods (4-Eyes): AddPricePlanChangeSet DeletePricePlanChangeSet GetPricePlanChangeSet GetPricePlanChangeSetDetailList GetPricePlanChangeSetList UpdatePricePlanChangeSet RegionDefinition (new service!) Added methods (4-Eyes): GetRegionDefinitionList GetRegionDefinitionListByPricePlanChangeSet ResellerMobileNumberPort (new service!) Added methods: Accept Cancel GetGroupDetails GetPendingPorts GetRequest PortInRequest Reject
16
About this guide
About this guide

Welcome to the API Reference Guide.
Prerequisites
Before you can start provisioning your reseller database with the APIs, there are some prerequisites. APIs do not cover every function of the Switch Administrator. Therefore, it is necessary that some basic data is already available in the reseller database. You will have to use the Switch Administrator to: Load pre-provisioned CLIs with related MSISDNs, IMSIs and SIMs Create profiles for new Customers and new Master CLIs, if required Create your service catalog (traffic types, call modes, ...) Create products with product prices Create packages with call modes & products Create bundles with bundle definition entries
Services & methods

Every web service has its own chapter in which you will find a detailed description of every method contained in that web service. A web method description always contains the following sections: Input An overview of all attributes and elements that either must or can be passed to the method in the SOAP request. Output An overview of the data that is returned by the method in the SOAP response: Table data, Return codes, ...
17
About this guide
General concept
In essence, the Artilium XML WebService APIs allow data to be exchanged between a client application (web interface or Win32) and an Artilium platform database in XML format using the SOAP protocol. These client applications can be either supplied by Artilium, or made by the customers themselves. Diagram The following diagram depicts the concept of data exchange through Artilium XML WebService APIs. It clearly shows a two-tier connection setup: the web servers connect to the Artilium WebService, which on its turn connects to the Artilium platform database.
18
About this guide
Client/WebService communication This is how a client connects to the Artilium WebService:
Client connects to Reseller The client can be either a web browser or a Win32 application. A web browser will connect to a web site, while a Win32 application will connect to a web service. Reseller connects to Artilium WebService The reseller web site or web service will connect to the Artilium WebService. Thanks to the Login and Password, passed on as mandatory attributes in the SOAP request, the Artilium WebService is able to identify the reseller. Artilium WebService connects to Artilium database server After having identified the reseller based on the logon credentials received in the SOAP request, the Artilium WebService will execute the requested SQL command against the database of that particular reseller, which is hosted on the Artilium database server.
19
About this guide
SOAP request syntax

Add methods Omitting an element = Take the field value from the profile Profiles must be created in the Switch Administrator. See the SDP Manual for more information.
Obviously, this is only the case for methods in which a profile ID can be specified. If no profile ID can be specified, all fields will have to be passed to the method. In other words, all fields will be mandatory.
ProfileId passed to method If you do not pass an element to an Add method, the method will fetch that elements default value from the profile specified in the ProfileId element. If the specified profile, however, is not of the right type, an error will be returned. If, for example, you specify a profile referring to a voucher PIN in the AddCLI method, an error will be returned. The profile ID passed to the AddCLI method has to refer to a CLI/PIN profile for CLIs/PINs of type CLI. ProfileId not passed to method If you do not pass the ProfileId element, then the method will fetch all necessary default values from the default profile. But which default profile? There are two types of profiles: contact profiles and CLI/PIN profiles. For every type of profile, one default profile can be set. So, basically you can have one default contact profile and one default CLI/PIN profile. However, a problem arises when the default profile is incompatible with the type of CLI/PIN an add method is trying to create. The AddVoucherPin method, for example, cannot use the default CLI/PIN profile if it is a profile for CLIs/PINs of a type other than Voucher PIN. In that case, the method will take the VoucherPIN CLI/PIN profile with the lowest ID.
If a method trying to add ... a contact of type 1 finds out the default profile is ... a contact profile for contacts of type 2,
then it will take ... the contact profile for contacts of type 1 with the lowest ID. the contact profile for contacts of type 2 with the lowest ID. the CLI/PIN profile for CLIs/PINs of type CLI with the lowest ID. the CLI/PIN profile for CLIs/PINs of type PIN with the lowest ID. the CLI/PIN profile for CLIs/PINs of type ReferrringCLI with the lowest ID. the CLI/PIN profile for CLIs/PINs of type VoucherPIN with the lowest ID.
a contact of type 2
a contact profile for contacts of type 1,
a CLI
a CLI/PIN profile for CLIs/PINs of a type other than CLI, a CLI/PIN profile for CLIs/PINs of a type other than PIN, a CLI/PIN profile for CLIs/PINs of a type other than ReferringCLI, a CLI/PIN profile for CLIs/PINs of a type other than VoucherPIN,
a PIN
a Referring CLI
a Voucher PIN
Update methods Passing an empty element of type string = Clear the field If you pass an empty element of type string, i.e. an element without a value, to an Update method, then the method will replace the contents of the corresponding field by an empty string. In other words, it will delete the existing field contents. If you pass an empty Name element to the UpdateContactType2 method, after the update operation, the Name field of the ContactType2 record that was updated will have been emptied. Omitting an element = Do not update the field If you do not pass an element to an Update method, the existing contents of the corresponding field will not be changed. If you do not pass the LastName element to the UpdateContactType2 method, after the update operation, the method will not have changed the contents of the LastName field of the ContactType2 record.
20
About this guide
List methods Passing an empty filter element of type string = Filter out records with empty field If you pass an empty filter element of type string, i.e. an element without a value, to a List method, then the method will return records of which the corresponding field is empty. If you pass an empty Name element to the GetContactType2List method, then the method will return only ContactType2 records in which the Name field is empty. Omitting a filter element = Do not include in the filter If you do not pass a filter element to a List method, then the method will exclude that element from the record filter it will apply. If you do not pass the City element to the GetContactType2List method, then the method will not include the City element in its record filter. The % wildcard character In most filter elements of type string, you can include the % wildcard character. If you pass B% in the Name element of the GetContactType2List method, then the method will return all contacts of type 2 of whom the name starts with a B. If you pass %son in the Name element of the GetContactType2List method, then the method will return all contacts of type 2 of whom the name ends with son. If you pass %artilium% in the Email element of the GetContactType2List method, then the method will return all contacts of type 2 of whom the email address contains artilium.
Resources
Web Services Description Language (WSDL) 1.1 http://www.w3.org/TR/wsdl
21
ContactType1
Chapter 2:
ContactType1
In this chapter, you will find a detailed description of all methods contained in the ContactType1 web service. This web service allows you to manage contacts of type 1 (agents or sales representatives).
Web method AddContactType1 DeleteContactType1 GetContactType1 GetContactType1List GetContactType1Profiles GetParametersContactType1 UpdateContactType1 UpdateParametersContactType1 ValidateLogonContactType1 Page 22 25 27 30 32 33 34 37 39
22
AddContactType1
AddContactType1
This method adds a contact of type 1 (agent).
Input
The following data has to be passed to the method. Attributes
Name Login Password Type string string Mandatory Yes Yes
Elements
Name ProfileId Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Email Gender ZIPCode Number LanguageId Title RecruitedByParent InvoiceOnParent CurrencyId GetCurrencyList GetLanguageList GetConversionCodeList (TitleContact) GetConversionCodeList (Gender) GetCountryList Description GetContactType1Profiles Type int string(80) int dateTime dateTime string(20) string(32) dateTime string(50) string(80) string(80) string(80) int string(32) string(32) string(127) string(33) string(80) int string(10) string(10) int int boolean boolean int Mandatory No No No No No No No No No No No No No No No No No No No No No No No No No No
23
AddContactType1
Name VATRate VATNumber Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee CommissionPlanId UserId Password MailingList Classification DateOfBirth PaymentMethod PaymentNumber PaymentName PaymentCardExpiration SolvencyStatus SolvencyLimit SolvencyGranted UserCreated LastUpdateIP Logging AccountType (int) Account (string(66))
Description GetConversionCodeList (VAT)
Type int string(32)
Mandatory No No No No No No No No No No No No No No No No No No No No No No No No No
GetConversionCodeList (FactureTiming)
int int int int string(10)
GetConversionCodeList (Dispatch) GetConversionCodeList (PrintAddressee)
int int int string(50) string(50) string(50)
GetConversionCodeList (Classification)
int dateTime
GetConversionCodeList (PaymentMethod)
int string(80) string(80) string(6)
GetConversionCodeList (Solvency)
int decimal(20,6) dateTime string(30) string(20) complex
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the contact that was added. If Result contains an integer other than 0, then NewItemId will be empty.
24
AddContactType1
Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -90 -91 Description OK UserId already exists Parent does not exists Wrong profile id or no addressPorfile found Invalid VAT number Wrong Type A contact of type 1 cannot have a parent contact of type 2 Wrong countryid value Wrong languageid value Wrong currencyid value Wrong Gender value Wrong Title value Wrong VAT rate value Wrong FactureTiming value Wrong Printing Dispatch value Wrong Printing Addressee value Wrong CommissionPlan value Wrong Payment method value Wrong Solvency status value Wrong Classification value Wrong Operator value Wrong Discount value Wrong Invoice value Wrong graph value Wrong fee amount value Wrong fee exclusion value Wrong fee periodicity value Wrong DefaultCLIPinProfile value Wrong DefaultMasterProfile value Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
25
DeleteContactType1
DeleteContactType1
This method deletes a contact of type 1.
Input
Elements
Name ContactType1Id DeleteType (see below) Logging AccountType (int) Account (string(66)) Type int enum complex Mandatory Yes Yes No
DeleteType has four possible values:

If you set DeleteType to ... DeleteAllNumbersFromThisContactOrChildren then ... all CLIs/PINs linked to the contact or to one of the subcontacts will be deleted. all CLIs/PINs linked to the contact or to one of the subcontacts will be moved to the Orphan CLIs/PIns folder. In other words, the ParentId of all those CLIs/PINs will be set to -1. all CLIs/PINs linked to the contact or to one of the subcontacts will be linked to the contacts parent. an error code will be returned if subcontacts and/or CLIs/PINs are linked to the contact.
MoveAllNumbersToOrphanFromThisContactOrChildren
MoveAllNumbersToParentFromThisContactOrChildren
ReturnErrorIfNumbersOrChildContactsExistsForThisContact
Output
The method will return an integer called Result. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 Description OK ID does not exist, or ID does not refer to a contact of type 1 The contact cannot be deleted because subcontacts are linked to it. The contact cannot be deleted because CLIs/PINs are linked to it. An error occurred while trying to delete a sub-contact.
26
DeleteContactType1
Code -5 -6 -7
Description An error occurred while trying to delete a PIN linked to this contact or to a sub-contact. Invalid DeleteType Unable to move to parent. Parent does not exist, or Incorrect contact type. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
27
GetContactType1
GetContactType1
This method retrieves a ContactType1 record.
Input
Elements
Name ContactType1Id Type int Mandatory Yes
Output
The method will return a complex type called ResultGetItem, containing a dataset called ItemInfo, and an integer called Result. ItemInfo If Result contains 0, then ItemInfo will contain a table with the following columns:
Name AddressId Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Type int string int dateTime dateTime string string dateTime string string string string int string string string string
28
GetContactType1
Name Email Gender ZIPCode Number LanguageId Title RecruitedByParent InvoiceOnParent CurrencyId VATRate VATNumber Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee CommissionPlanId UserId Password MailingList TotalVisits LastVisit TotalVisitsLastOddMonth LastVisitOddMonth TotalVisitsLastEvenMonth LastVisitEvenMonth LastVisitIP LastUpdateIP Classification DateofBirth PaymentMethod PaymentNumber PaymentName PaymentCardExpiration SolvencyStatus SolvencyLimit
Type string int string string int int int short int int string short short short short string int int int string string string int dateTime int dateTime int dateTime string string int dateTime short string string string int decimal
29
GetContactType1
Name SolvencyGranted UserCreated
Type dateTime string
If Result contains an integer other than 0, then ItemInfo will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -90 -91 Description OK Specified ContactType1 ID does not exist or has the wrong type. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
30
GetContactType1List
GetContactType1List
This method returns a (filtered) list of contacts of type 1.
Input
Elements The elements below are optional filter criteria. However, you should pass at least one of them to the method. Otherwise, a code -1 will be returned. In each of these elements, except ParentId, you can use the % wildcard character.
Name Name Street City Email Reference ParentId UserId Type string(80) string(80) string(80) string(80) string(20) int string(50) Mandatory No No No No No No No
Output
The method will return a complex type called ResultGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain a table with the following columns:
Name ContactType1Id Name Street City Reference UserId ParentId Email Type int string string string string string int string
31
GetContactType1List
If Result contains an integer other than 0, then ListInfo will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -90 -91 Description OK Please, specify at least one element Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
TotalItems The integer TotalItems will contain the total number of records in the ListInfo dataset.
32
GetContactType1Profiles
This method returns the list of ContactType1 profiles.
Input
Elements None.
Output
Name ContactType1ProfileId ContactType1ProfileDescription Type int string
Code 0 -90 -91 Description OK Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
33
GetParametersContactType1
This method retrieves the parameters linked to a contact of type 1.
Input
Elements
Output
The method will return a complex type called GetParameterListResult, containing an array called Parameters, and an integer called Result. Parameters If Result contains 0, then Parameters will contain an element for every parameter linked to the specified contact of type 1, and every such element will, on its turn, contain the following sub-elements:
Name ParameterId ParameterValue ParameterDeleted Type int string boolean
If Result contains an integer other than 0, then Parameters will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -90 -91 Description OK Invalid Pin or Invalid Contact Invalid type: 0=Pin, 2=Contact Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
34
UpdateContactType1
UpdateContactType1
This method updates a ContactType1 record.
Input
Elements
Name ContactType1Id Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Email Gender ZIPCode Number LanguageId Title RecruitedByParent InvoiceOnParent CurrencyId GetCurrencyList GetLanguageList GetConversionCodeList (TitleContact) GetConversionCodeList (Gender) GetCountryList Description Type int string(80) int dateTime dateTime string(20) string(32) dateTime string(50) string(80) string(80) string(80) int string(32) string(32) string(127) string(33) string(80) int string(10) string(10) int int boolean boolean int Mandatory Yes No No No No No No No No No No No No No No No No No No No No No No No No No
35
UpdateContactType1
Name VATRate VATNumber Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee CommissionPlanId UserId Password MailingList Classification DateOfBirth PaymentMethod PaymentNumber PaymentName PaymentCardExpiration SolvencyStatus SolvencyLimit SolvencyGranted UserCreated LastUpdateIP Logging AccountType (int) Account (string(66))
Description GetConversionCodeList (VAT)
Type int string(32)
int int int string(50) string(50) string(50)
int dateTime
int decimal(20,6) dateTime string(30) string(20) complex
Output
Code 0 -1 -2 -3 -4 Description OK Specified ContactType1Id does not exist or has the wrong type UserId already exists ParentId does not exist Invalid VAT number
36
UpdateContactType1
Code -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -90 -91
Description A contact of type 1 cannot have a parent contact of type 2 Wrong CountryId Wrong LanguageId Wrong CurrencyId Wrong Gender Wrong Title Wrong VAT rate Wrong FactureTiming Wrong Printing Dispatch Wrong Printing Addressee Wrong CommissionPlan Wrong Payment method Wrong Solvency status Wrong Classification Wrong Operator Wrong Discount Wrong Invoice Wrong graph Wrong fee amount Wrong fee exclusion Wrong fee periodicity Wrong DefaultCLIPinProfile Wrong DefaultMasterProfile Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
37
UpdateParametersContactType1
This method adds, updates, and/or deletes one or more parameters linked to a contact of type 1.
Input
Elements
Name ContactType1Id ParameterList Parameters (array) Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes Yes
complex
No
Parameters array In the Parameters array, add a Parameter element for every parameter you want to add, update, or delete. Every array element should contain the following sub-elements:
Name ParameterId ParameterValue ParameterDeleted Type int string(256) boolean Mandatory Yes No Yes
Add, update, or delete? Depending on whether or not the parameter exists, and whether the ParameterDeleted element contains True or False, the method will add, update, or delete the parameter. See the table below.
Situation Parameter does not exist ParameterDeleted True False Parameter exists True False Action ADD DELETE UPDATE
Output
The method will return a complex type called UpdateParameterResult containing an integer called Result, and an array called Unsuccessful.
38
Code 0 -1 -2 -3 -4 -90 -91 Description All updates OK Invalid Pin or Invalid Contact Invalid type: 0=Pin, 2=Contact Some updates failed (Wrong parameter ID, ...) Parameters array is empty (No parameters passed to method) Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
Unsuccessful If the method was unable to add/update/delete some of the parameters that were passed to it, the Unsuccessful array will contain an element for every parameter that could not be added/updated/deleted. Such an element will contain the following sub-elements:
Name ParameterId ErrorCode Type int int
ErrorCode For the list of possible error codes, see the table below.
ErrorCode -1 -2 -4 -5 -6 -7 -8 -9 -10 -91 Description Delete failed. Parameter does not exist Insert failed. Parameter definition does not exist Text or password too long (Un)signed int: Value not between min. and max. value (Un)signed int: Value is not of type integer (Un)signed decimal: Value not between min. and max. value (Un)signed decimal: Value is not of type decimal DateTime not in valid datetime interval DateTime is not of type datetime. Parameter value too long (Exceeds 256 characters)
39
ValidateLogonContactType1
This method checks the logon credentials of a contact of type 1.
Input
Elements
Name LogonType LogonValue Password UpdateStatistics LastVisitIP Type enum string(50) string(50) boolean string(20) Mandatory Yes No Yes Yes No
LogonType has two possible values:

If you set LogonType to ... LogonUserIdPassword LogonEmailPassword then, in LogonValue, enter ... the user ID of the contact. the email address of the contact.
Output
The method will return a complex type called ResultValidateContactTypeLogon, containing two integers: one called ItemId, and one called Result. ItemId If Result contains 0, then ItemId will contain the ContactType1Id of the validated contact. If Result contains an integer other than 0, then ItemId will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -90 Description OK UserId was not specified (UserId=Null) Wrong Type UserId not found for this type UserId/Type valid, but wrong password Authentication failed
40
Code -91
Description Field overflow Too many characters, Date out of range, ... Unspecified error
-100
41
ContactType2
Chapter 3:
ContactType2
In this chapter, you will find a detailed description of all methods contained in the ContactType2 web service. This web service allows you to manage contacts of type 2 (customers).
Web method AddContactType2 DeleteContactType2 GetContactType2 GetContactType2List GetContactType2Profiles GetFilteredListOfNumbers GetParametersContactType2 UpdateContactType2 UpdateParametersContactType2 ValidateLogonContactType2 Page 42 46 48 51 53 54 56 57 61 63
42
AddContactType2
AddContactType2
This method adds a contact of type 2 (customer).
Input
Elements
Name ProfileId Description Specify profile to use a pre-defined set of default customer properties. Profiles are created in the Switch Administrator. GetContactType2Profiles If unspecified or -1, no master CLI is created. GetMasterProfiles Type int Mandatory No
MasterProfileId
int
No
Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Email Gender ZIPCode Number LanguageId Title GetLanguageList GetConversionCodeList (TitleContact) GetConversionCodeList (Gender) GetCountryList Reference to external billing system Specify Id of parent customer to create child customer
string(80) int dateTime dateTime string(20) string(32) dateTime string(50) string(80) string(80) string(80) int string(32) string(32) string(127) string(33) string(80) int string(10) string(10) int int
Yes No No No No No No No No No No No No No No No No No No No No No
43
AddContactType2
Name RecruitedByParent OperatorId CurrencyId InvoiceOnParent VATRate VATNumber DiscountPct Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee DiscountType SeperateInvoicePeriod NoInvoiceBelow AlwaysInvoiceAbove IdOnInvoice Graph DaysGraph PrintCallDetailsList Supplement VATRatePct FeeType Periodicity Exclusion FeeAmount VATPct ExclAmount ExtraComPct UserId Password MailingList Classification DateOfBirth PaymentMethod PaymentNumber
Description
Type boolean
Mandatory No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No
GetOperatorList GetCurrencyList
int int boolean
GetConversionCodeList (VAT)
int string(32) decimal(15,2)
int int int boolean decimal(15,2) decimal(15,2)
GetConversionCodeList (PinOnInvoice)
int int int boolean decimal(20,6) decimal(15,2) int
GetConversionCodeList (Periodicity)
int int decimal(20,6) decimal(15,2) decimal(20,6) decimal(15,2) string(50) string(50) string(50)
int dateTime
int string(80)
44
AddContactType2
Name PaymentName PaymentCardExpiration SolvencyStatus SolvencyLimit SolvencyGranted DefaultCLIPINProfile EnforceCLIPIN DefaultMasterProfile EnforceMaster UserCreated LastUpdateIP Logging AccountType (int) Account (string(66))
Description
Type string(80) string(6)
Mandatory No No No No No No No No No No No No
int decimal(20,6) dateTime
GetPinProfiles
int boolean
GetMasterProfiles
int boolean string(30) string(20) complex
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the contact that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 Description OK UserId already exists Parent does not exists Wrong profile id or no addressProfile found Invalid VAT number Wrong Type You can not add a salesrep under a customer Wrong countryid value Wrong languageid value Wrong currencyid value Wrong Gender value Wrong Title value Wrong VAT rate value Wrong FactureTiming value
45
AddContactType2
Code -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -90 -91
Description Wrong Printing Dispatch value Wrong Printing Addressee value Wrong CommissionPlan value Wrong Payment method value Wrong Solvency status value Wrong Classification value Wrong Operator value Wrong Discount value Wrong Invoice value Wrong graph value Wrong fee amount value Wrong fee exclusion value Wrong fee periodicity value Wrong DefaultCLIPinProfile value Wrong DefaultMasterProfile value Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
46
DeleteContactType2
DeleteContactType2
Input
Elements
Name ContactType2Id DeleteType Logging AccountType (int) Account (string(66)) Type int enum complex Mandatory Yes Yes No
DeleteType has four possible values: DeleteAllNumbersFromThisContactOrChildren MoveAllNumbersToOrphanFromThisContactOrChildren MoveAllNumbersToParentFromThisContactOrChildren ReturnErrorIfNumbersOrChildContactsExistsForThisContact

Output
Code 0 -1 Description OK ID does not exist, or ID does not refer to a contact of type 2
47
DeleteContactType2
Code -2 -3 -4 -5 -6 -7
Description The contact cannot be deleted because subcontacts are linked to it. The contact cannot be deleted because CLIs/PINs are linked to it. An error occurred while trying to delete a sub-contact. An error occurred while trying to delete a PIN linked to this contact or to a sub-contact. Invalid DeleteType Unable to move to parent. Parent does not exist, or Incorrect contact type. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
48
GetContactType2
GetContactType2
Input
Elements
Output
49
GetContactType2
Name Email Gender ZIPCode Number LanguageId Title RecruitedByParent OperatorId InvoiceOnParent CurrencyId VATRate VATNumber DiscountPct Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee DiscountType SeperateInvoicePeriod NoInvoiceBelow AlwaysInvoiceAbove IdOnInvoice Graph DaysGraph PrintCallDetailsList Supplement VATRatePct FeeType Periodicity Exclusion FeeAmount VATPct ExclAmount ExtraComPct UserId
Type string int string string int int int int short int int string decimal short short short short string int int int int decimal decimal int int int short decimal decimal int int int decimal decimal decimal decimal string
50
GetContactType2
Name Password MailingList TotalVisits LastVisit TotalVisitsLastOddMonth LastVisitOddMonth TotalVisitsLastEvenMonth LastVisitEvenMonth LastVisitIP LastUpdateIP Classification DateofBirth PaymentMethod PaymentNumber PaymentName PaymentCardExpiration SolvencyStatus SolvencyLimit SolvencyGranted DefaultCLIPINProfile EnforceCLIPIN MasterProfile EnforceMaster RecordCreated RecordLastUpdate UserCreated
Type string string int dateTime int dateTime int dateTime string string int dateTime short string string string int decimal dateTime int int int int dateTime dateTime string
-100
51
GetContactType2List
GetContactType2List
Input
Output
52
GetContactType2List
-100
53
Input
Elements None.
Output
-100
54
GetFilteredListOfNumbers
This method returns a (filtered) list of CLI/PINs. This method should be used with great care. Setting the filter too wide can cause a database server overload.
Input
Elements The elements below that have a No in the Mandatory column, are optional filter criteria. In the elements of type string, except UserId, you can use the % wildcard character.
Name ContactType2Id Number Description -1 for orphan CLIs cannot be used MasterNumber CompleteNumber (CLI) PIN ReferringCLI VoucherPIN Type int string(32) Mandatory No No
SN NumberCategory NumberStatus Master CustomerName UserId PageIndex PageSize SortBy SortOrder 0=ASC, 1=DESC 0=Page 1, 1=Page 2, ... GetNumberCategoryList GetStatusList
string(32) int int string(32) string(32) string(32) int int int int
No No No No No No Yes Yes Yes Yes
55
Output
Name SN NumberCategory CustomerName Number CSC Master NumberStatus DateRangeFrom DateRangeUntil ContactType2Id Type MaxTotalCredits TotalUsedCredits ReservedCredits Type string int string string string string short dateTime dateTime int short decimal decimal decimal
Code 0 -1 -2 -90 -91 Description OK InValid ContactType2Id ContactType2Id or SN or PinOrClip or UserName or CustomerName or Master is mandatory Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
56
Input
Elements
Output
-100
57
UpdateContactType2
UpdateContactType2
Input
Elements
Name ContactType2Id Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Email Gender ZIPCode Number LanguageId Title RecruitedByParent OperatorId CurrencyId GetOperatorList GetCurrencyList GetLanguageList GetConversionCodeList (TitleContact) GetConversionCodeList (Gender) GetCountryList Description Type int string(80) int dateTime dateTime string(20) string(32) dateTime string(50) string(80) string(80) string(80) int string(32) string(32) string(127) string(33) string(80) int string(10) string(10) int int boolean int int Mandatory Yes No No No No No No No No No No No No No No No No No No No No No No No No No
58
UpdateContactType2
Name InvoiceOnParent VATRate VATNumber DiscountPct Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee DiscountType SeperateInvoicePeriod NoInvoiceBelow AlwaysInvoiceAbove IdOnInvoice Graph DaysGraph PrintCallDetailsList Supplement VATRatePct FeeType Periodicity Exclusion FeeAmount VATPct ExclAmount ExtraComPct UserId Password MailingList Classification DateOfBirth PaymentMethod PaymentNumber PaymentName PaymentCardExpiration SolvencyStatus
Description
Type boolean
int dateTime
int
59
UpdateContactType2
Name SolvencyLimit SolvencyGranted DefaultCLIPINProfile EnforceCLIPIN DefaultMasterProfile EnforceMaster UserCreated LastUpdateIP Logging AccountType (int) Account (string(66))
Description
Type decimal(20,6) dateTime
Mandatory No No No No No No No No No
GetPinProfiles
int boolean
GetMasterProfiles
Output
Code 0 -1 -2 -3 -4 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 Description OK Specified ContactType2Id does not exist or has the wrong type UserId already exists ParentId does not exist Invalid VAT number A contact of type 1 cannot have a parent contact of type 2 Wrong CountryId Wrong LanguageId Wrong CurrencyId Wrong Gender Wrong Title Wrong VAT rate Wrong FactureTiming Wrong Printing Dispatch Wrong Printing Addressee Wrong CommissionPlan Wrong Payment method Wrong Solvency status Wrong Classification Wrong Operator Wrong Discount
60
UpdateContactType2
Code -22 -23 -24 -25 -26 -27 -28 -90 -91
Description Wrong Invoice Wrong graph Wrong fee amount Wrong fee exclusion Wrong fee periodicity Wrong DefaultCLIPinProfile Wrong DefaultMasterProfile Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
61
Input
Elements
complex
No
Output
62
-100
63
Input
Elements
LogonType has three possible values:

If you set LogonType to ... LogonUserIdPassword LogonEmailPassword LogonReferringCLIPassword then, in LogonValue, enter ... the user ID of the contact. the email address of the contact. the referring CLI of the contact.
Output
Code 0 -1 -2 -3 -4 Description OK UserId was not specified (UserId=Null) Wrong Type UserId not found for this type UserId/Type valid, but wrong password
64
Code -90 -91
Description Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
65
ContactType3
Chapter 4:
ContactType3
In this chapter, you will find a detailed description of all methods contained in the ContactType3 web service. This web service allows you to manage contacts of type 3 (prospects).
Web method AddContactType3 ChangeContactType3ToContactType2 DeleteContactType3 GetContactType3 GetContactType3List GetContactType3Profiles GetParametersContactType3 UpdateContactType3 UpdateParametersContactType3 ValidateLogonContactType3 Page 66 70 71 73 76 78 79 80 84 86
66
AddContactType3
AddContactType3
This method adds a contact of type 3 (prospect).
Input
Elements
Name ProfileId Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Email Gender ZIPCode Number LanguageId Title RecruitedByParent OperatorId CurrencyId GetOperatorList GetCurrencyList GetLanguageList GetConversionCodeList (TitleContact) GetConversionCodeList (Gender) GetCountryList Description GetContactType3Profiles Type int string(80) int dateTime dateTime string(20) string(32) dateTime string(50) string(80) string(80) string(80) int string(32) string(32) string(127) string(33) string(80) int string(10) string(10) int int boolean int int Mandatory No No No No No No No No No No No No No No No No No No No No No No No No No No
67
AddContactType3
Description
Type boolean
int dateTime
int
68
AddContactType3
Description
GetPinProfiles
int boolean
GetMasterProfiles
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the contact that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 Description OK UserId already exists Parent does not exists Wrong profile id or no addressPorfile found Invalid VAT number Wrong Type You can not add a salesrep under a customer Wrong countryid value Wrong languageid value Wrong currencyid value Wrong Gender value Wrong Title value Wrong VAT rate value Wrong FactureTiming value Wrong Printing Dispatch value Wrong Printing Addressee value Wrong CommissionPlan value
69
AddContactType3
Code -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -90 -91
Description Wrong Payment method value Wrong Solvency status value Wrong Classification value Wrong Operator value Wrong Discount value Wrong Invoice value Wrong graph value Wrong fee amount value Wrong fee exclusion value Wrong fee periodicity value Wrong DefaultCLIPinProfile value Wrong DefaultMasterProfile value Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
70
ChangeContactType3ToContactType2
ChangeContactType3ToContactType2
This method changes a contact of type 3 into a contact of type 2.
Input
Elements
Name ContactType3Id Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -90 -91 Description OK ContactType3Id does not exist, or it does not refer to a contact of type 3. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
71
DeleteContactType3
DeleteContactType3
Input
Elements
Name ContactType3Id DeleteType Logging AccountType (int) Account (string(66)) Type int enum complex Mandatory Yes Yes No
DeleteType has four possible values: DeleteAllNumbersFromThisContactOrChildren MoveAllNumbersToOrphanFromThisContactOrChildren MoveAllNumbersToParentFromThisContactOrChildren ReturnErrorIfNumbersOrChildContactsExistsForThisContact

Output
Code 0 -1 Description OK ID does not exist, or ID does not refer to a contact of type 3
72
DeleteContactType3
Code -2 -3 -4 -5 -6 -7
Description The contact cannot be deleted because subcontacts are linked to it. The contact cannot be deleted because CLIs/PINs are linked to it. An error occurred while trying to delete a sub-contact. An error occurred while trying to delete a PIN linked to this contact or to a sub-contact. Invalid DeleteType Unable to move to parent. Parent does not exist, or Incorrect contact type. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
73
GetContactType3
GetContactType3
Input
Elements
Output
74
GetContactType3
Name Email Gender ZIPCode Number LanguageId Title RecruitedByParent OperatorId InvoiceOnParent CurrencyId VATRate VATNumber DiscountPct Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee DiscountType SeperateInvoicePeriod NoInvoiceBelow AlwaysInvoiceAbove IdOnInvoice Graph DaysGraph PrintCallDetailsList Supplement VATRatePct FeeType Periodicity Exclusion FeeAmount VATPct ExclAmount ExtraComPct UserId
Type string int string string int int int int short int int string decimal short short short short string int int int int decimal decimal int int int short decimal decimal int int int decimal decimal decimal decimal string
75
GetContactType3
Name Password MailingList TotalVisits LastVisit TotalVisitsLastOddMonth LastVisitOddMonth TotalVisitsLastEvenMonth LastVisitEvenMonth LastVisitIP LastUpdateIP Classification DateofBirth PaymentMethod PaymentNumber PaymentName PaymentCardExpiration SolvencyStatus SolvencyLimit SolvencyGranted DefaultCLIPINProfile EnforceCLIPIN MasterProfile EnforceMaster RecordCreated RecordLastUpdate UserCreated
Type string string int dateTime int dateTime int dateTime string string int dateTime short string string string int decimal dateTime int int int int dateTime dateTime string
-100
76
GetContactType3List
GetContactType3List
Input
Output
77
GetContactType3List
-100
78
Input
Elements None.
Output
-100
79
Input
Elements
Output
-100
80
UpdateContactType3
UpdateContactType3
Input
Elements
Name ContactType3Id Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Email Gender ZIPCode Number LanguageId Title RecruitedByParent OperatorId CurrencyId GetOperatorList GetCurrencyList GetLanguageList GetConversionCodeList (TitleContact) GetConversionCodeList (Gender) GetCountryList Description Type int string(80) int dateTime dateTime string(20) string(32) dateTime string(50) string(80) string(80) string(80) int string(32) string(32) string(127) string(33) string(80) int string(10) string(10) int int boolean int int Mandatory Yes No No No No No No No No No No No No No No No No No No No No No No No No No
81
UpdateContactType3
Description
Type boolean
int dateTime
int
82
UpdateContactType3
Description
GetPinProfiles
int boolean
GetMasterProfiles
Output
Code 0 -1 -2 -3 -4 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 Description OK Specified ContactType3Id does not exist or has the wrong type UserId already exists ParentId does not exist Invalid VAT number A contact of type 1 cannot have a parent contact of type 2 Wrong CountryId Wrong LanguageId Wrong CurrencyId Wrong Gender Wrong Title Wrong VAT rate Wrong FactureTiming Wrong Printing Dispatch Wrong Printing Addressee Wrong CommissionPlan Wrong Payment method Wrong Solvency status Wrong Classification Wrong Operator Wrong Discount
83
UpdateContactType3
Code -22 -23 -24 -25 -26 -27 -28 -90 -91
Description Wrong Invoice Wrong graph Wrong fee amount Wrong fee exclusion Wrong fee periodicity Wrong DefaultCLIPinProfile Wrong DefaultMasterProfile Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
84
Input
Elements
complex
No
Output
85
-100
86
Input
Elements
LogonType has three possible values:

If you set LogonType to ... LogonUserIdPassword LogonEmailPassword LogonReferringCLIPassword then, in LogonValue, enter ... the user ID of the contact. the email address of the contact. the referring CLI of the contact.
Output
Code 0 -1 -2 -3 -4 Description OK UserId was not specified (UserId=Null) Wrong Type UserId not found for this type UserId/Type valid, but wrong password
87
Code -90 -91
-100
88
Master
Chapter 5:
Master
In this chapter, you will find a detailed description of all methods contained in the Master web service. This web service allows you to manage CLIs/PINs of category Master.
Web method AddCreditsSecondsMaster AddMaster DeleteMaster GetMaster GetMasterProfiles GetParametersMaster ReduceUsedCreditsSecondsMaster UpdateMaster UpdateParametersMaster ValidateLogonMaster Page 89 91 98 100 106 107 108 109 1 16 1 18
89
AddCreditsSecondsMaster
This method updates the credit settings (currency, seconds) of a master CLI/PIN. It also adds a ReloadHistory record if the AddCredits element in the SOAP request contains a number of credits greater than 0 (=zero).
Input
Elements
Name SN AddCredits AddCreditsPerDay AddCreditsPerWeek AddCreditsPerMonth AddTotalSeconds AddTotalSecondsPerDay AddTotalSecondsPerWeek AddTotalSecondsPerMonth CheckSetting304 UpdateRecordHistory UpdateFirstTimeUsed UpdateManualRecharges CheckManualRecharges Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) - GetConversionCodeList (ReloadType) ReloadSubType (int) - GetConversionCodeList (ReloadSubType) Description (string(160)) SMSText (string(160)) InitiatorType (int) - GetConversionCodeList (InitiatorType) Initiator (string(50)) PaymentType (int) - GetConversionCodeList (PaymentType) Payment (string(50)) OrderId (string(20)) ContactType2Id (int) Type string(32) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int boolean boolean boolean boolean boolean complex Mandatory Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
complex
No
90
Output
Code 0 -1 -2 -3 -4 Description OK Invalid SN, or SN not found. Invalid Type. SN does not refer to a CLI/PIN of type Master. Too many manual recharges A negative amount in AddCredits would result in a negative CreditsLeft amount. You cannot add credits to a postpaid master CLI/PIN. Incorrect CurrencyId Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-5 -6 -90 -91
-100
91
AddMaster
AddMaster
This method adds a master CLI/PIN to a contact of type 2.
Input
Elements
Name ProfileId CustomerName Status GetStatusList 0 = Blocked 1 = Active 3 = Suspended Description GetMasterProfiles Type int string(31) short Mandatory No No No
SecretCode Master BatchNumber ContactType2Id DivisionId Type CallBackNumber OutgoingCLI ActivationCPS GetConversionCodeList (ActivationCPS) 0 = NotActivated 1 = Activated 2 = WaitForPRF 3 = PortedOut GetConversionCodeList (RequestCPS) 0 = NoCPS 1 = RequestIncomplete 2 = RequestComplete 3 = RequestPending 4 = PreselectPartiallyInstalled 5 = PreselectFullyInstalled 6 = PreselectCancelled
string(16) string(32) string(16) int int short string(32) string(32) int
No No No Yes No No No No No
StatusCPS
int
No
DateCPSStatus DateCPSSigned Address1 Address2
dateTime dateTime string(31) string(31)
No No No No
92
AddMaster
Name ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm
Description
Type string(15) string(31) int
Mandatory No No Yes No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No
int string(31) string(15) string(15) string(31) string(31) string(31) string(50)
GetConversionCodeList (Gender)
int dateTime string(50)
GetDistributorList GetSalesPointList
int int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int int int int int int int int int int
93
AddMaster
Name FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone
Description
Type int int int string(50) string(50) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int decimal(20,6) short short boolean string(31) boolean string(63) int int int int string(33) short int short int string(16) string(16) int boolean boolean boolean boolean boolean boolean
94
AddMaster
Name EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup
Description
Type boolean decimal(20,6) boolean short string(16) short short string(32) short
GetTrafficList
int int short short
GetCurrencyList
short boolean short boolean short short boolean short string(32) short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(16) string(16) string(15) string(17) short short
95
AddMaster
Name SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge NameUserLastUpdate Logging AccountType (int) Account (string(66))
Description
Type decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int int boolean boolean boolean string(15) complex
Mandatory No No No No No No No No No No No No No No No No No No No No No No
Output
The method will return a complex type called ResultInsertNumber, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the number of the master CLI/PIN that was added. If Result contains an integer other than 0, then SN will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 Description OK Invalid Type or invalid CLI Invalid CustomerId Invalid OperatorId
96
AddMaster
Code -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42
Description CLi with this Operator already exists in the database Invalid ProfileId Invalid MasterPincode userid already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method
97
AddMaster
Code -43
Description Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -90 -91
-100
98
DeleteMaster
DeleteMaster
This method deletes a master CLI/PIN.
Input
Elements
Name SN DeleteMasterType Logging AccountType (int) Account (string(66)) Type string(32) enum complex Mandatory Yes Yes No
DeleteMasterType has three possible values: DeleteAllNumbersFromThisMaster MoveAllNumbersToCustomerlevelFromThisMaster ReturnErrorIfNumbersExistsForThisMaster

If you set DeleteMasterType to ... DeleteAllNumbersFromThisMaster MoveAllNumbersToCustomerlevelFromThisMaster then ... all CLIs/PINs linked to the master CLI/PIN will be deleted. all CLIs/PINs linked to the master CLI/PIN will be moved to the contact. an error code will be returned if CLIs/PINs are linked to the master CLI/PIN.
ReturnErrorIfNumbersExistsForThisMaster
Output
Code 0 -1 -2 -3 -4 -5 Description OK SN cannot be found SN does not refer to a master CLI/PIN. The master CLI/PIN cannot be deleted. There are still CLIs/PINs linked to it. Default master CLI/PIN (Master_00) cannot be deleted. An error occurred while trying to delete a CLI/PIN (of type CLI, PIN, Referring CLI or Voucher PIN) linked to this master.
99
DeleteMaster
Code -90 -91
-100
100
GetMaster
GetMaster
This method retrieves all relevant data of a master CLI/PIN.
Input
Elements
Name SN Type string(32) Mandatory Yes
Output
Name SN MasterNumber CustomerName Status 0 = Blocked 1 = Active 2 = Suspended SecretCode Master BatchNumber ContactType2Id DivisionId Type CallBackNumber OutgoingCLI ActivationCPS 0 = NotActivated 1 = Activated 2 = WaitForPRF 3 = PortedOut Type string string string short
string string string int int short string string int
101
GetMaster
Name StatusCPS 0 = NoCPS 1 = RequestIncomplete 2 = RequestComplete 3 = RequestPending 4 = PreselectPartiallyInstalled 5 = PreselectFullyInstalled 6 = PreselectCancelled DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm
Type int
dateTime dateTime string string string string int int string string string string string string string int dateTime string int int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean short short
102
GetMaster
Name WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall NumberOfUsers MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents
Type short short short short short short short short short short short short string string decimal decimal decimal decimal int int int int decimal short short short boolean string boolean string int int int int string short int short
103
GetMaster
Name AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect CostTableLegA MasterTableLegA CostTableLegB MasterTableLegB TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds UsedFreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges
Type int string string int boolean boolean boolean boolean boolean boolean boolean decimal boolean short string short short short short short short string short short int int short short short boolean short boolean short short boolean short string short
104
GetMaster
Name FreeRechargeAmount FreeRechargeIsPercentage ActualNumFreeRecharges MaxNumManualRecharges ActualNumManualRecharges LastManualRechargeValue LastManualRechargeTime AutoTopupAmount MaxNumAutoTopup ActualNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup LastHiddenChargeTime SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction
Type decimal boolean short short short decimal dateTime decimal short short decimal boolean short boolean string string string string short short dateTime decimal decimal decimal decimal decimal decimal decimal decimal decimal decimal decimal decimal int int int int int
105
GetMaster
Name AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge TotalCalls TotalOutgoingCalls TotalLostSeconds TotalAnsweredCalls FirstTimeUsed LastTimeUsed LastDestination RecordAdded LastUpdate NameUserLastUpdate TotalUsedCredits TotalUsedCreditsToday TotalUsedCreditsThisWeek TotalUsedCreditsThisMonth TotalUsedSeconds TotalUsedSecondsToday TotalUsedSecondsThisWeek TotalUsedSecondsThisMonth ReservedCredits
Type boolean boolean boolean int int int int dateTime dateTime string dateTime dateTime string decimal decimal decimal decimal int int int int decimal
Code 0 -1 -90 -91 Description OK Specified SN does not exist or has the wrong type. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
106
GetMasterProfiles
GetMasterProfiles
This method returns the list of CLI/PIN profiles for master CLIs/PINs.
Input
Elements None.
Output
Name MasterProfileId MasterProfileDescription Type int string
-100
107
GetParametersMaster
GetParametersMaster
This method retrieves the parameters linked to a master CLI/PIN.
Input
Elements
Output
The method will return a complex type called GetParameterListResult, containing an array called Parameters, and an integer called Result. Parameters If Result contains 0, then Parameters will contain an element for every parameter linked to the specified master CLI/ PIN, and every such element will, on its turn, contain the following sub-elements:
Code 0 -1 -90 -91 Description OK SN not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
108
ReduceUsedCreditsSecondsMaster
ReduceUsedCreditsSecondsMaster
This method resets the credit settings (currency, seconds) of a master CLI/PIN to zero.
Input
Elements
Name SN ReduceTotalCredits ReduceTotalCreditsPerDay ReduceTotalCreditsPerWeek ReduceTotalCreditsPerMonth ReduceTotalSeconds ReduceTotalTotalSecondsPerDay ReduceTotalTotalSecondsPerWeek ReduceTotalTotalSecondsPerMonth Logging AccountType (int) Account (string(66)) Type string(32) boolean boolean boolean boolean boolean boolean boolean boolean complex Mandatory Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Output
Code 0 -1 -2 -3 -90 -91 Description OK Invalid SN, or SN not found. Invalid Type. SN does not refer to a CLI/PIN of type Master. All update parameters are FALSE. At least one of them has to be TRUE. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
109
UpdateMaster
UpdateMaster
This method updates a master CLI/PIN.
Input
Elements
Name SN CustomerName Status SecretCode BatchNumber DivisionId Type CallBackNumber OutgoingCLI ActivationCPS StatusCPS DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email GetConversionCodeList (PaymentMethod) GetConversionCodeList (ActivationCPS) GetConversionCodeList (RequestCPS) GetStatusList Description Type string(32) string(31) short string(16) string(16) int short string(32) string(32) int int dateTime dateTime string(31) string(31) string(15) string(31) int int string(31) string(15) string(15) string(31) string(31) string(31) string(50) Mandatory Yes No No No No No No No No No No No No No No No No Yes No No No No No No No No
1 10
UpdateMaster
Name Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay
Description
Type int dateTime string(50)
int int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int int int int int int int int int int int int int string(50) string(50) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int
11 1
UpdateMaster
Name MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds TrafficTypeId MinCarrierQuality
Description
Type int int decimal(20,6) short short boolean string(31) boolean string(63) int int int int string(33) short int short int string(16) string(16) int boolean boolean boolean boolean boolean boolean boolean decimal(20,6) boolean short string(16) short short string(32) short
GetTrafficList
int int
1 12
UpdateMaster
Name Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy
Description
Type short short
GetCurrencyList
short boolean short boolean short short boolean short string(32) short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(16) string(16) string(15) string(17) short short decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6)
1 13
UpdateMaster
Name ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge NameUserLastUpdate Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int)
Description
Type decimal(20,6) int int int int int boolean boolean boolean string(15) complex
Mandatory No No No No No No No No No No No
complex
No
1 14
UpdateMaster
Output
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 -30 -31 -32 -33 -34 Description OK Invalid SN, or SN does not exist Invalid Type Invalid OperatorId Specified CLI/PIN already exists in the database in combination with this operator Invalid CLI Invalid MasterPincode UserId already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm
1 15
UpdateMaster
Code -35 -36 -37 -38 -39 -40 -41 -42 -43
Description Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -90 -91
-100
1 16
UpdateParametersMaster
This method adds, updates, and/or deletes one or more parameters linked to a master CLI/PIN.
Input
Elements
Name SN ParameterList Parameters (array) Logging AccountType (int) Account (string(66)) Type string(32) complex Mandatory Yes Yes
complex
No
Name ParameterId ParameterValue ParameterDeleted Type int string boolean Mandatory Yes No Yes
Output
1 17
-100
1 18
ValidateLogonMaster
ValidateLogonMaster
This method checks the logon credentials of a master CLI/PIN.
Input
Elements

If you set LogonType to ... LogonUserIdPassword LogonEmailPassword then, in LogonValue, enter ... the user ID of the master CLI/PIN. the email address of the master CLI/PIN.
Output
The method will return a complex type called ResultValidateSubscriptionLogon, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the SN of the validated master CLI/PIN. If Result contains an integer other than 0, then SN will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -90 Description OK UserId was not specified Wrong Type UserId not found for this type UserId/Type valid, but wrong password Authentication failed
1 19
ValidateLogonMaster
Code -91
-100
120
Pin
Chapter 6:
Pin
In this chapter, you will find a detailed description of all methods contained in the Pin web service. This web service allows you to manage CLIs/PINs of category PIN.
Web method AddCreditsSecondsPin AddPin DeletePin GetParametersPin GetPin GetPinProfiles ReduceUsedCreditsSecondsPin UpdateParametersPin UpdatePin ValidateLogonPin Page 121 123 130 131 132 138 139 140 142 149
121
AddCreditsSecondsPin
This method updates the credit settings (currency, seconds) of a CLI/PIN of type PIN. It also adds a ReloadHistory record if the AddCredits element in the SOAP request contains a number of credits greater than 0 (=zero).
Input
Elements
Name SN AddCredits AddCreditsPerDay AddCreditsPerWeek AddCreditsPerMonth AddTotalSeconds AddTotalSecondsPerDay AddTotalSecondsPerWeek AddTotalSecondsPerMonth CheckSetting304 UpdateRecordHistory UpdateFirstTimeUsed UpdateManualRecharges CheckManualRecharges Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) - GetConversionCodeList (ReloadType) ReloadSubType (int) - GetConversionCodeList (ReloadSubType) Description (string(160)) SMSText (string(160)) InitiatorType (int) - GetConversionCodeList (InitiatorType) Initiator (string(50)) PaymentType (int) - GetConversionCodeList (PaymentType) Payment (string(50)) OrderId (string(20)) ContactType2Id (int) Type string(32) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int boolean boolean boolean boolean boolean complex Mandatory Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
complex
No
122
Output
Code 0 -1 -2 -3 -4 Description OK Invalid SN, or SN not found. Invalid Type. SN does not refer to a CLI/PIN of type PIN. Too many manual recharges A negative amount in AddCredits would result in a negative CreditsLeft amount. You cannot add credits to a postpaid PIN. Incorrect CurrencyId Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-5 -6 -90 -91
-100
123
AddPin
AddPin
This method adds a CLI/PIN of type PIN.
Input
Elements
Name ProfileId CustomerName Pin PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the default PinCLIAttached value will be taken from the CLI/PIN profile. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the added PIN will be empty. GetStatusList 0 = Blocked 1 = Active 4 = Inactive Description GetPinProfiles Type int string(31) string(16) string(32) Mandatory No No No No
Status
short
No
SecretCode Master BatchNumber ContactType2Id DivisionId Type CallBackNumber OutgoingCLI ActivationCPS StatusCPS DateCPSStatus DateCPSSigned Address1 Address2 ZipCode GetConversionCodeList (ActivationCPS) GetConversionCodeList (RequestCPS)
string(16) string(32) string(16) int int short string(32) string(32) int int dateTime dateTime string(31) string(31) string(15)
No No No Yes No No No No No No No No No No No
124
AddPin
Name City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm
Description
Type string(31) int
Mandatory No Yes No No No No No No No No No No Yes No No No No No No No No No No No No No No No No No No No No Yes No No No No
int int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int int int int int int int int int int int
125
AddPin
Name SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk
Description
Type int int string(50) string(50) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int decimal(20,6) short short boolean string(31) boolean string(63) int int int int string(33) short int short int string(16) string(16) int boolean boolean boolean boolean boolean boolean boolean
Mandatory No No No No No No No No No No No No No No No No Yes No No No No No No No No No No No No No No No No No No No No Yes
126
AddPin
Name HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup SpecialChargeWeekly
Description
Type decimal(20,6) boolean short string(16) short short string(32) short
Mandatory No No No No No No No No No No No No No No No No No No No No Yes No No No No No No No No No No No No No No No No No
GetTrafficList
int int short short
GetCurrencyList
short boolean short boolean short short boolean short string(32) short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(16) string(16) string(15) string(17) short short decimal(20,6)
127
AddPin
Name SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge NameUserLastUpdate Logging AccountType (int) Account (string(66))
Description
Type decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int int boolean boolean boolean string(15) complex
Mandatory No No No Yes No No No No No No No No No No No No No No No No No
128
AddPin
Output
The method will return a complex type called ResultInsertNumber, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the serial number of the PIN that was added. If Result contains an integer other than 0, then SN will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 Description OK Invalid Type or invalid CLI Invalid CustomerId Invalid operatorId Specified CLI/PIN already exists in the database in combination with this operator Invalid ProfileId Invalid MasterPincode Userid already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm
129
AddPin
Code -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43
Description Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -90 -91
-100
130
DeletePin
DeletePin
This method deletes a CLI/PIN of type PIN.
Input
Elements
Name SN Logging AccountType (int) Account (string(66)) Type string(32) complex Mandatory Yes No
Output
Code 0 -1 -2 -3 -5 -90 -91 Description OK SN cannot be found SN does not refer to a CLI/PIN of type PIN. The master CLI/PIN cannot be deleted. There are still CLIs/PINs linked to it. An error occurred while trying to delete a PIN linked to this master. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
131
GetParametersPin
GetParametersPin
This method retrieves the parameters linked to a CLI/PIN of type PIN.
Input
Elements
Output
The method will return a complex type called GetParameterListResult, containing an array called Parameters, and an integer called Result. Parameters If Result contains 0, then Parameters will contain an element for every parameter linked to the specified CLI/PIN of type PIN, and every such element will, on its turn, contain the following sub-elements:
-100
132
GetPin
GetPin
This method retrieves all relevant data of a CLI/PIN of type PIN.
Input
Elements
Output
Name SN CustomerName Pin PinCLIAttached Status 0 = Blocked 1 = Active 3 = Suspended 4 = Inactive 5 = Grace 6 = Pre-suspended SecretCode Master BatchNumber ContactType2Id DivisionId Type CallBackNumber OutgoingCLI Type string string string string short
string string string int int short string string
133
GetPin
Name ActivationCPS 0 = NotActivated 1 = Activated 2 = WaitForPRF 3 = PortedOut StatusCPS 0 = NoCPS 1 = RequestIncomplete 2 = RequestComplete 3 = RequestPending 4 = PreselectPartiallyInstalled 5 = PreselectFullyInstalled 6 = PreselectCancelled DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday
Type int
int
dateTime dateTime string string string string int int string string string string string string string int dateTime string int int dateTime dateTime short int boolean boolean boolean boolean boolean
134
GetPin
Name Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall NumberOfUsers MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4
Type boolean boolean short short short short short short short short short short short short short short string string decimal decimal decimal decimal int int int int decimal short short short boolean string boolean string int int int int
135
GetPin
Name PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect CostTableLegA MasterTableLegA CostTableLegB MasterTableLegB TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds UsedFreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall
Type string short int short int string string int boolean boolean boolean boolean boolean boolean boolean decimal boolean short string short short short short short short string short short int int short short short boolean short boolean short short
136
GetPin
Name DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage ActualNumFreeRecharges MaxNumManualRecharges ActualNumManualRecharges LastManualRechargeValue LastManualRechargeTime AutoTopupAmount MaxNumAutoTopup ActualNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup LastHiddenChargeTime SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges
Type boolean short string short decimal boolean short short short decimal dateTime decimal short short decimal boolean short boolean string string string string short short dateTime decimal decimal decimal decimal decimal decimal decimal decimal decimal decimal decimal decimal int
137
GetPin
Name MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge TotalCalls TotalOutgoingCalls TotalLostSeconds TotalAnsweredCalls FirstTimeUsed LastTimeUsed LastDestination RecordAdded LastUpdate NameUserLastUpdate TotalUsedCredits TotalUsedCreditsToday TotalUsedCreditsThisWeek TotalUsedCreditsThisMonth TotalUsedSeconds TotalUsedSecondsToday TotalUsedSecondsThisWeek TotalUsedSecondsThisMonth ReservedCredits
Type int int int int boolean boolean boolean int int int int dateTime dateTime string dateTime dateTime string decimal decimal decimal decimal int int int int decimal
-100
138
GetPinProfiles
GetPinProfiles
This method returns the list of CLI/PIN profiles for CLIs/PINs of type PIN.
Input
Elements None.
Output
Name PinProfileId PinProfileDescription Type int string
-100
139
ReduceUsedCreditsSecondsPin
ReduceUsedCreditsSecondsPin
This method resets the credit settings (currency, seconds) of a PIN to zero.
Input
Elements
Output
Code 0 -1 -2 -3 -90 -91 Description OK Invalid SN, or SN not found. Invalid Type. SN does not refer to a CLI/PIN of type PIN. All update parameters are FALSE. At least one of them has to be TRUE. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
140
UpdateParametersPin
UpdateParametersPin
This method adds, updates, and/or deletes one or more parameters linked to a CLI/PIN of type PIN.
Input
Elements
complex
No
Output
141
UpdateParametersPin
-100
142
UpdatePin
UpdatePin
This method updates a CLI/PIN of type PIN.
Input
Elements
Name SN CustomerName Pin PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the PinCLIAttached field will not be updated. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the updated PIN will be empty. Description Type string(32) string(31) string(16) string(32) Mandatory Yes No No No
Status SecretCode BatchNumber DivisionId Type CallBackNumber OutgoingCLI ActivationCPS StatusCPS DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode GetConversionCodeList (PaymentMethod) GetConversionCodeList (ActivationCPS) GetConversionCodeList (RequestCPS)
short string(16) string(16) int short string(32) string(32) int int dateTime dateTime string(31) string(31) string(15) string(31) int int string(31) string(15)
No No No No No No No No No No No No No No No Yes No No No
143
UpdatePin
Name PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits
Description
Type string(15) string(31) string(31) string(31) string(50)
int int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int int int int int int int int int int int int int string(50) string(50) decimal(20,6)
144
UpdatePin
Name MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect TaxationMethodLegA
Description
Type decimal(20,6) decimal(20,6) decimal(20,6) int int int int decimal(20,6) short short boolean string(31) boolean string(63) int int int int string(33) short int short int string(16) string(16) int boolean boolean boolean boolean boolean boolean boolean decimal(20,6) boolean short string(16) short
145
UpdatePin
Name TaxationMethodLegB FreeDestination FreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday
Description
Type short string(32) short
GetTrafficList
int int short short
GetCurrencyList
short boolean short boolean short short boolean short string(32) short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(16) string(16) string(15) string(17) short short decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6)
146
UpdatePin
Name SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge NameUserLastUpdate Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int)
Description
Type decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int int boolean boolean boolean string(15) complex
Mandatory No No No No No No No No No No No No No No No No
complex GetConversionCodeList (ReloadType) GetConversionCodeList (ReloadSubType)
No
GetConversionCodeList (InitiatorType) GetConversionCodeList (PaymentType)
147
UpdatePin
Output
148
UpdatePin
Code -35 -36 -37 -38 -39 -40 -41 -42 -43
Description Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Unable to update a PIN that has been repatriated or ported out. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -51 -90 -91
-100
149
ValidateLogonPin
ValidateLogonPin
This method checks the logon credentials of a CLI/PIN of type PIN.
Input
Elements
LogonType has two possible values: LogonUserIdPassword LogonEmailPassword

If you set LogonType to ... LogonUserIdPassword LogonEmailPassword then, in LogonValue, enter ... the user ID of the CLI/PIN. the email address of the CLI/PIN.
Output
The method will return a complex type called ResultValidateSubscriptionLogon, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the SN of the validated CLI/PIN. If Result contains an integer other than 0, then SN will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 Description OK UserId was not specified Wrong Type UserId not found for this type
150
ValidateLogonPin
Code -4 -90 -91
Description UserId/Type valid, but wrong password Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
151
CLI
Chapter 7:
CLI
In this chapter, you will find a detailed description of all methods contained in the CLI web service. This web service allows you to manage CLIs/PINs of category CLI.
Web method AddCLI AddCreditsExternalTransaction AddCreditsSecondsCLI DeleteCLI GetCLI GetCLIProfiles GetParametersCLI GetSpecificCLIInfo MoveCLI ReduceUsedCreditsSecondsCLI SplitCLI SwapMsisdn SwapSim GetAvailableProvisioningSims UpdateCLI UpdateParametersCLI ValidateLogonCLI Page 152 159 161 163 164 171 172 173 175 176 177 181 182 184 186 193 195
You can retrieve the pre-provisioned and pre-activated numbers with API GetAvailablePortInMsisdns in the Porting service.
152
AddCLI
AddCLI
This method adds a CLI/PIN of type CLI.
Input
Elements
Name ProfileId CustomerName CLI NationalId PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the default PinCLIAttached value will be taken from the CLI/PIN profile. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the added CLI will be empty. GetStatusList 0 = Blocked 1 = Active 4 = Inactive Description GetCLIProfiles Type int string(31) string(16) string(32) string(32) Mandatory No No Yes No No
Status
short
No
SecretCode Master BatchNumber ContactType2Id DivisionId Type CallBackNumber OutgoingCLI OperatorId ActivationCPS GetOperatorList GetConversionCodeList (ActivationCPS) 0 = Not Activated 1 = Activated 2 = Wait for PRF 3 = Ported out GetConversionCodeList (RequestCPS) GetTypeList
string(16) string(32) string(16) int int short string(32) string(32) int int
No No No Yes No No No No No No
StatusCPS
int
No
153
AddCLI
Name DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm
Description
Type dateTime dateTime string(31) string(31) string(15) string(31) int
Mandatory No No No No No No Yes No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No
int int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int int int int int int
154
AddCLI
Name MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall
Description
Type int int int int int int int string(50) string(50) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int decimal(20,6) short short boolean string(31) boolean string(63) int int int int string(33) short int short int string(16) string(16) int boolean boolean
155
AddCLI
Name OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference
Description
Type boolean boolean boolean boolean boolean decimal(20,6) boolean short string(16) short short string(32) short
GetTrafficList
int int short short
GetCurrencyList
short boolean short boolean short short boolean short string(32) short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(16) string(16)
156
AddCLI
Name DIDReference InvoiceReference RouteGroup CountryGroup SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge NameUserLastUpdate Logging AccountType (int) Account (string(66))
Description
Type string(15) string(17) short short decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int int boolean boolean boolean string(15) complex
Mandatory No No No No No No No No No No No No No No No No No No No No No No No No No No
157
AddCLI
Output
The method will return a complex type called ResultInsertNumber, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the serial number of the CLI that was added. If Result contains an integer other than 0, then SN will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 Description OK Invalid Type or invalid CLI Invalid CustomerId Invalid OperatorId Specified CLI/PIN already exists in the database in combination with this operator Invalid ProfileId Invalid MasterPincode Userid already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm
158
AddCLI
Code -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43
Description Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a positive number. CountryId does not exist Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -51 -90 -91
-100
159
AddCreditsExternalTransaction
This method has to be used to top up the credits of a CLI after the top-up has been paid through a third-party payment platform. It also adds a ReloadHistory record if the AddCredits element in the SOAP request contains a number of credits greater than 0 (=zero). Procedure in case of a top-up involving a third-party payment platform In case of a top-up involving a third-party payment platform, you should proceed as follows: 1 2 3 4 Execute the AddExternalTransaction method in order to create an external transaction record. Make the payment using the third-party payment platform. Execute the UpdateExternalTransaction method in order to update certain data in the external transaction record (payment status received from payment platform, ...). Execute the AddCreditsExternalTransaction method in order to update the credits in the CLI record.
Input
Elements
Name SN AddCredits CurrencyId ErrorStatus GetCurrencyList 0 = OK 1 = Error 2 = Pending Description Type string(32) decimal(20,6) int int Mandatory Yes Yes Yes Yes
CheckTransActionId CheckSetting304 UpdateRecordHistory UpdateFirstTimeUsed UpdateManualRecharges CheckManualRecharges
int boolean boolean boolean boolean boolean
Yes Yes Yes Yes Yes Yes
160
Name Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int)
Description
Type complex
Mandatory No
No
Output
-100
161
AddCreditsSecondsCLI
This method updates the credit settings (currency, seconds) of a CLI/PIN of type CLI. It also adds a ReloadHistory record if the AddCredits element in the SOAP request contains a number of credits greater than 0 (=zero).
Input
Elements
Name SN AddCredits AddCreditsPerDay AddCreditsPerWeek AddCreditsPerMonth AddTotalSeconds AddTotalSecondsPerDay AddTotalSecondsPerWeek AddTotalSecondsPerMonth CheckSetting304 UpdateRecordHistory UpdateFirstTimeUsed UpdateManualRecharges CheckManualRecharges Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int) Description Type string(32) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int boolean boolean boolean boolean boolean complex Mandatory Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
No
162
Output
Code 0 -1 -2 -3 -4 Description OK Invalid SN, or SN not found. Invalid Type. SN does not refer to a CLI/PIN of type CLI. Too many manual recharges A negative amount in AddCredits would result in a negative CreditsLeft amount. You cannot add credits to a postpaid CLI. Incorrect CurrencyId Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-5 -6 -90 -91
-100
163
DeleteCLI
DeleteCLI
This method deletes a CLI/PIN of type CLI.
Input
Elements
Output
Code 0 -1 -2 -3 -5 -90 -91 Description OK SN cannot be found SN does not refer to a CLI/PIN of type CLI. The master CLI/PIN cannot be deleted. There are still CLIs/PINs linked to it. An error occurred while trying to delete a PIN linked to this master. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
164
GetCLI
GetCLI
This method retrieves all relevant data of a CLI/PIN of type CLI.
Input
Elements
Output
Name SN CompleteNumber CustomerName CLI NationalId PinCLIAttached PinIsClip 48 = PIN 49 = CLI 50 = Voucher PIN 51 = Master 52 = Referring CLI Status 0 = Blocked 1 = Active 3 = Suspended 4 = Inactive 5 = Grace 6 = Pre-suspended SecretCode Master Type string string string string string string short
short
string string
165
GetCLI
Name BatchNumber ContactType2Id DivisionId Type CallBackNumber OutgoingCLI OperatorId CSC ActivationCPS 0 = NotActivated 1 = Activated 2 = WaitForPRF 3 = PortedOut 4 = Repatriated StatusCPS DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday
Type string int int short string string int string int
int dateTime dateTime string string string string int int string string string string string string string int dateTime string int int dateTime dateTime short int boolean
166
GetCLI
Name Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits* MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall NumberOfUsers MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted
Type boolean boolean boolean boolean boolean boolean short short short short short short short short short short short short short short string string decimal decimal decimal decimal int int int int decimal short short short boolean string boolean string
167
GetCLI
Name Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect CostTableLegA MasterTableLegA CostTableLegB MasterTableLegB TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds UsedFreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration
Type int int int int string short int short int string string int boolean boolean boolean boolean boolean boolean boolean decimal boolean short string short short short short short short string short short int int short short short boolean
168
GetCLI
Name RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage ActualNumFreeRecharges MaxNumManualRecharges ActualNumManualRecharges LastManualRechargeValue LastManualRechargeTime AutoTopupAmount MaxNumAutoTopup ActualNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup LastHiddenChargeTime SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday
Type short boolean short short boolean short string short decimal boolean short short short decimal dateTime decimal short short decimal boolean short boolean string string string string short short dateTime decimal decimal decimal decimal decimal decimal decimal decimal decimal
169
GetCLI
Name ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge TotalCalls TotalOutgoingCalls TotalLostSeconds TotalAnsweredCalls FirstTimeUsed LastTimeUsed LastDestination RecordAdded LastUpdate NameUserLastUpdate TotalUsedCredits* (Comprises ReservedCredits!) TotalUsedCreditsToday TotalUsedCreditsThisWeek TotalUsedCreditsThisMonth TotalUsedSeconds TotalUsedSecondsToday TotalUsedSecondsThisWeek TotalUsedSecondsThisMonth ReservedCredits*
Type decimal decimal decimal int int int int int boolean boolean boolean int int int int dateTime dateTime string dateTime dateTime string decimal decimal decimal decimal int int int int decimal
(*) To return the CLIs correct balance, do MaxTotalCredits - TotalUsedCredits + ReservedCredits If Result contains an integer other than 0, then ItemInfo will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 Description OK Specified SN does not exist or has the wrong type.
170
GetCLI
Code -90 -91
-100
171
GetCLIProfiles
GetCLIProfiles
This method returns the list of CLI/PIN profiles for CLIs/PINs of type CLI.
Input
Elements None.
Output
Name CLIProfileId CLIProfileDescription Type int string
-100
172
GetParametersCLI
GetParametersCLI
This method retrieves the parameters linked to a CLI/PIN of type CLI.
Input
Elements
Output
The method will return a complex type called GetParameterListResult, containing an array called Parameters, and an integer called Result. Parameters If Result contains 0, then Parameters will contain an element for every parameter linked to the specified CLI/PIN of type CLI, and every such element will, on its turn, contain the following sub-elements:
-100
173
GetSpecificCLIInfo
GetSpecificCLIInfo
This method returns essential information about a specific CLI/PIN: current provisioning status, current balance, and, in case of a mobile number, the active MSISDN, IMSI, and SIM numbers linked to that CLI/PIN.
Input
Elements
Name SN Type string Mandatory Yes
Output
Name SN SubscriptionStatus -1 = Undefined 0 = Orphan 1 = WaitPRF 2 = Create 3 = Active 4 = Blocked 5 = PreSuspended 6 = Repatriated 7 = PortedOut 8 = Split Balance (incl. any reserved credits) Prepaid CurrencyId Expiration MsisdnNr Type string int
decimal int short dateTime string
174
GetSpecificCLIInfo
Name MSISDNStatus 0 = Undefined 1 = Available 2 = Webreserved 3 = Assigned 4 = External MNP 5 = First call active 6 = Active 7 = MNP 8 = Deactivated 9 = Portout 10 = ChangePool IMSINr IMSIStatus 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated SIMNr SIMStatus 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive 9 = SIMSwapRejected cTypeSIM
Type int
string int
string int
int
Code 0 -1 -90 -91 Description OK szSN not valid Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
175
MoveCLI
MoveCLI
This method moves a CLI/PIN of type CLI to another master CLI/PIN or contact.
Input
Elements
Name SN ContactType2Id SNMaster Logging AccountType (int) Account (string(66)) Type int int string complex Mandatory Yes No Yes No
Output
Code 0 -1 -2 -3 -4 -90 -91 Description OK szSN not found (must be cPinIsClip must be of type CLI) Please fill in a CompanyId or SNMaster Invalid CompanyId Invalid Master Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
176
ReduceUsedCreditsSecondsCLI
ReduceUsedCreditsSecondsCLI
This method resets the credit settings (currency, seconds) of a CLI to zero.
Input
Elements
Output
Code 0 -1 -2 -3 -90 -91 Description OK Invalid SN, or SN not found. Invalid Type. SN does not refer to a CLI/PIN of type CLI. All update parameters are FALSE. At least one of them has to be TRUE. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
177
SplitCLI
SplitCLI
This method splits a CLI in two: an existing CLI, valid until the split date, and a new CLI, valid from the split date onwards. Split date The SplitCLI API allows to specify the date at which the existing CLI must be terminated and the new CLI created:
If ... a future FromDate is passed to the method, no or a FromDate in the past is passed to the method, then the split date will be ... the datetime specified in the FromDate element. the current datetime.
CDRs If you split a CLI using this API method, all CDRs linked to the existing CLI will stay linked to that CLI.
Input
Elements
Name SN ContactType2Id Description The serial number of the CLI to be split. The ID of the contact to whom the new CLI has to be linked. Note: If you do not pass this element to the method, the new CLI will be linked to the same contact as the existing CLI. The datetime at which the existing CLI has to be split. Note: If you do not pass a date to the method or a date in the past, the current datetime is used. GetTypeList The type of the new CLI: Normal (0) Prepaid (1) Debit (2) Personal (3) Postpaid (4) Note: If you do not pass this element to the method, the type of the new CLI will be the same as the type of the existing CLI. The maximum number of manual recharges of the new CLI. Note: If the type of the new CLI is Normal or Postpaid, then this value will be set to -1. If TRUE, the packages linked to the existing CLI will also be linked to the new CLI. The list of IDs of all packages to be linked to the new CLI. Type string(32) int Mandatory Yes No
FromDate
datetime
No
Type
int
No
MaxNumManualRecharges
int
No
CopyCurrentPackages
boolean
No
NewPackages
array(int)
No
178
SplitCLI
Name CopyCurrentPriceVariations
Description If TRUE, the price variations linked to the existing CLI will also be linked to the new CLI. If TRUE, the services linked to the existing CLI will also be linked to the new CLI. Note: Only if CopyCurrentPackages is set to TRUE.
Type boolean
Mandatory No
CopyCurrentServices
boolean
No
Logging AccountType (int) Account (string(66))
complex
No
Output
The method returns a complex type called ResultInsertNumber, containing a string called SN an integer called Result. SN The string called SN is an empty string because SplitCLI jobs are handled asynchronously. The new SN cannot be returned immediately as it is created only when the Job Executor Service executes the split. Proceed as follows to retrieve the new SN:
Service Method Criteria ContactType2 GetFilteredListOfNumbers Number ContactType2Id PageIndex PageSize SortBy SortOrder CLI that was split. Add % wildcard to use LIKE. ID of target contact of new CLI Use 0 to show first page Use 10, i.e. number of records per page Use 0 Use 0
Polling at regular intervals is required because, even in case the split is executed immediately, there may be delay due to the load on the job queue of the Job Executor Service. Scenario 1 Number and SN are identical. Split execution date: 06/07/2009 at 1 1:30:25 Number that was split: 32486500925 The method returns the following data:
SN 32486500925 32486500925-1 Number 32486500925-S* 32486500925** ... ... ... 2009-07-06T1 1:30:26 DateRangeFrom DateRangeUntil 2009-07-06T1 1:30:25
* The number of the split CLI/PIN gets the -S suffix. The related SN remains unchanged. ** The number of the new CLI/PIN uses the original number. The SN gets the -1 suffix, or -2, -3, -4, as needed.
179
SplitCLI
Scenario 2 CLI/PIN and SN are not identical: the number was ported-in. Split execution date: 06/07/2009 at 1 1:30:25 Number that was split: 32486600200 The method returns the following data:
SN 32475345800 32486600200 Number 32486600200-S* 32486600200** ... ... ... 2009-07-06T1 1:30:26 DateRangeFrom DateRangeUntil 2009-07-06T1 1:30:25
* The number of the split CLI/PIN gets the -S suffix. The related SN remains unchanged (= the ported number). ** The number of the new CLI/PIN uses the original number. The SN is identical. Result The integer called Result contains one of the following return codes:
Code 0 -1 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 Description OK Invalid SN Error - Get parameters Error - Get MSISDN of this SN Error - Get customer products of this SN Error - Get packages of the customer products Error - Get package definitions of the packages Error - Get the price variations of this SN Invalid package IDs in NewPackages element Invalid contact ID in ContactType2Id element Invalid type ID in Type element PIN is not active (network status) PIN is port out (parameter 20512 is present and is different from status 20 or 12) Already a SplitCLI scheduled MaxNumManualRecharges not in range 0 - 99999999 There must be at least one packageId or the existing packages should be copied Error - Update existing CLI Error - Add new CLI Error - Copy parameters Error - Update MSISDN Error - Update SIM Error - Add customer products Error - Add packages Error - Add package definitions Error - Add price variations Status of CLI/PIN must be Active (1) or Inactive (4) FromDate must be earlier than the date of DateRangeUntil of the CLI/PIN
180
SplitCLI
Code -90 -100
Description Invalid Login and/or Password Unknown error
181
SwapMsisdn
SwapMsisdn
This method changes the active MSISDN that is linked to a CLI/PIN. Depending on the operators workflow, the new MSISDN can be provided by the network, or by the reseller. Check the standard procedures for MSISDN swaps of the involved operator. If the network provides the new MSISDN, then no NewMsisdnId should be sent in the SwapMsisdn request. If the reseller provides the new MSISDN, then NewMsisdnId should be specified in the SwapMsisdn request. It can be selected from the pool of valid MSISDNs for MSISDN swaps. The valid MSISDNs can be retrieved from the pool with API GetMSISDNList in the Mobile Service.
Input
Elements
Name SN NewMsisdnId Only required in case the reseller provides the new MSISDN. Description Type string integer Mandatory Yes No
Output
The method returns an integer called Result with the following return codes:
Code 0 -1 -2 -3 Description OK Invalid SN Invalid MSISDN ID [MSISDN provided by reseller] New MSISDN already active [MSISDN provided by network] Invalid CPS Activation status Subscriber has no MSISDN to swap (no active MSISDN/SIM/IMSI combination linked to SN) Configuration error in reseller database (missing system setting 224) New MSISDN is already linked to another CLI/PIN CLI/PIN has inactive Network status Invalid port-in status Authentication failed Field overflow (too many characters, date out of range, ...) Unspecified error
-4 -5 -6 -7 -8 -90 -91 -100
182
SwapSim
SwapSim
This method links another SIM card (SIM/IMSI pair) to an MSISDN. Operators may provision new SIM cards for swapping SIMs differently: The SIMs for swapping may be provisioned in a dedicated pool of swap cards. Retrieve NewSimNr with the API GetSIMList in the Mobile service. The SIMs of pre-provisioned CLI/PINs may be used to swap SIM cards. Retrieve NewSimNr with the API GetAvailableProvisioningSims in the CLI service. Check the swap SIM procedures of the involved operator.
Input
Elements
Name MsisdnId NewSimNr Type integer string Mandatory Yes Yes
Output
The method returns an integer called Result with the following return codes:
Code 0 -1 -2 -3 Description OK Source MSISDN invalid Source IMSI/SIM invalid [in case of dedicated pool of swap cards] New SIM already linked to another MSISDN. [in case of pre-provisioned SIMs] Invalid CPS Activation status [in case of dedicated pool of swap cards] SIM is not of type SwapCard [in case of pre-provisioned SIMs] no active MSISDN/SIM/IMSI combination linked to SN [in case of dedicated pool of swap cards] No active SIM found for MSISDN Source CLI/PIN has inactive Network status Another SIM swap is already in progress Source IMSI invalid Destination IMSI has invalid or no attached MSISDN, SIM, or PIN Destination IMSI, MSISDN, SIM, or PIN has invalid status Invalid port-in state. Port-in in progress Invalid SIM type Authentication failed
-4
-5 -6 -7 -8 -9 -10 -1 1 -12 -90
183
SwapSim
Code -91 -100
Description Field overflow (too many characters, date out of range, ...) Unspecified error
184
GetAvailableProvisioningSims
This method returns (max. 100) SIM/IMSI pairs of pre-provisioned CLI/PINs which can be used to swap SIMs (see SwapSim). The following SIM/IMSI pairs are returned:
Level CLI/PIN Property Network status CPS Activation Until date Parameter 20515 (port-in status) Category MSISDN IMSI SIM Status Status Status Value Created (1) Not Activated (0) Blank or future expiration date Blank, or Port in Canceled (3) CLI (49) Warehouse (1), or SalesRep (4)
Input
Elements
Name SimNumber MaxResultSet Description Full number or prefix to filter list of returned SIMs Max. number of SIMs to be returned. Max. 100. Type string int Mandatory No No
185
Output
The method will return a complex type called ResultGetList, containing an integer called Result, a dataset called ProvisioningSimData, and an integer called TotalItems. Result The integer Result will contain one of the following return codes:
Code 0 -90 -91 -100 Description OK Authentication failed Field overflow (too many characters, date out of range) Unspecified error
ProvisioningSimData If Result contains 0, then ProvisioningSimData will contain the valid SIMs, each with the following data:
Name SimNr TypeSim 0 = SwapCard 1 = Pre-provisioned card Technical Puk1 Puk2 SimStatus 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive 9 = SwapSimRejected DateRange (activation - termination date) IntegratedCircuitCardId AuthenticationKey Imsi Type string int
int string string enum
date/time string string string
If Result contains an integer other than 0, then ProvisioningSimData will contain NULL. TotalItems The integer TotalItems will contain the total number of records in the ProvisioningSimData dataset.
186
UpdateCLI
UpdateCLI
This method updates a CLI/PIN of type CLI.
Input
Elements
Name SN CustomerName CLI NationalId PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the PinCLIAttached field will not be updated. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the updated CLI will be empty. GetStatusList 0 = Blocked 1 = Active 3 = Suspended 4 = Inactive 5 = Grace 6 = Pre-suspended Description Type string(32) string(31) string(16) string(32) string(32) Mandatory Yes No No No No
Status
short
No
SecretCode BatchNumber DivisionId Type CallBackNumber OutgoingCLI OperatorId ActivationCPS GetOperatorList GetConversionCodeList (ActivationCPS) 0 = Not Activated 1 = Activated 2 = Wait for PRF 3 = Ported out 4 = Repatriated GetConversionCodeList (RequestCPS) GetTypeList
string(16) string(16) int short string(32) string(32) int int
No No No No No No No No
StatusCPS
int
No
187
UpdateCLI
Name DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City CountryId PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm
Description
Type dateTime dateTime string(31) string(31) string(15) string(31) int
int int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int int int int int int
188
UpdateCLI
Name MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall
Description
Type int int int int int int int string(50) string(50) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int decimal(20,6) short short boolean string(31) boolean string(63) int int int int string(33) short int short int string(16) string(16) int boolean boolean
189
UpdateCLI
Name OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference
Description
Type boolean boolean boolean boolean boolean decimal(20,6) boolean short string(16) short short string(32) short
GetTrafficList
int int short short
GetCurrencyList
short boolean short boolean short short boolean short string(32) short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(16) string(16)
190
UpdateCLI
Name DIDReference InvoiceReference RouteGroup CountryGroup SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge NameUserLastUpdate Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int)
Description
Type string(15) string(17) short short decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int int boolean boolean boolean string(15) complex
Mandatory No No No No No No No No No No No No No No No No No No No No No No No No No No
No
191
UpdateCLI
Output
192
UpdateCLI
Code -35 -36 -37 -38 -39 -40 -41 -42 -43
Description Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Unable to update a CLI that has been repatriated or ported out. You can only set status Suspended (3) when previous status was Pre-Suspended (6) You cannot update DateRangeUntil when it already contains date in the past (status = Pre-suspended). You cannot update Type when NetworkStatus is different from Created and SplitCli wizard is enabled Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -51 -52 -53 -54 -90 -91
-100
193
UpdateParametersCLI
UpdateParametersCLI
This method adds, updates, and/or deletes one or more parameters linked to a CLI/PIN of type CLI.
Input
Elements
complex
No
194
UpdateParametersCLI
Output
The method will return a complex type called UpdateParameterResult containing an integer called Result, and an array called Unsuccessful. Result The integer Result will contain one of the following return codes:
-100
195
ValidateLogonCLI
ValidateLogonCLI
This method checks the logon credentials of a CLI/PIN of type CLI.
Input
Elements

If you set LogonType to ... LogonUserIdPassword LogonEmailPassword then, in LogonValue, enter ... the user ID of the CLI/PIN. the email address of the CLI/PIN.
Output
The method will return a complex type called ResultValidateSubscriptionLogon, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the SN of the validated CLI/PIN. If Result contains an integer other than 0, then SN will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -90 Description OK UserId was not specified Wrong Type UserId not found for this type UserId/Type valid, but wrong password Authentication failed
196
ValidateLogonCLI
Code -91
-100
197
ReferringCLI
Chapter 8:
ReferringCLI
In this chapter, you will find a detailed description of all methods contained in the ReferringCLI web service. This web service allows you to manage CLIs/PINs of category Referring CLI.
Web method AddReferringCLI DeleteReferringCLI GetParametersReferringCLI GetReferringCLI GetReferringCLIProfiles UpdateParametersReferringCLI UpdateReferringCLI Page 198 201 202 203 205 206 208
198
AddReferringCLI
AddReferringCLI
This method adds a CLI/PIN of type referring CLI.
Input
Elements
Name ProfileId ReferringCLI PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the default PinCLIAttached value will be taken from the CLI/PIN profile. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the added ReferringCLI will be empty. GetStatusList 0 = Blocked 1 = Active 3 = Suspended Description GetReferringCLIProfiles Type int string(16) string(32) Mandatory No Yes No
Status
short
No
Master BatchNumber ContactType2Id NameUserLastUpdate Logging AccountType (int) Account (string(66))
string(32) string(16) int string(15) complex
No No Yes No No
Output
The method will return a complex type called ResultInsertNumber, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the serial number of the referring CLI that was added. If Result contains an integer other than 0, then SN will be empty.
199
AddReferringCLI
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 -30 -31 -32 -33 -34 -35 -36 Description OK Invalid Type or invalid CLI Invalid CustomerId Invalid OperatorId Specified CLI/PIN already exists in the database in combination with this operator Invalid ProfileId Invalid MasterPincode Userid already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm
200
AddReferringCLI
Code -37 -38 -39 -40 -41 -42 -43
Description Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -90 -91
-100
201
DeleteReferringCLI
DeleteReferringCLI
This method deletes a CLI/PIN of type Referring CLI.
Input
Elements
Output
Code 0 -1 -2 -3 -5 -90 -91 Description OK SN cannot be found SN does not refer to a CLI/PIN of type Referring CLI. The master CLI/PIN cannot be deleted. There are still CLIs/PINs linked to it. An error occurred while trying to delete a PIN linked to this master. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
202
GetParametersReferringCLI
GetParametersReferringCLI
This method retrieves the parameters linked to a CLI/PIN of type Referring CLI.
Input
Elements
Output
The method will return a complex type called GetParameterListResult, containing an array called Parameters, and an integer called Result. Parameters If Result contains 0, then Parameters will contain an element for every parameter linked to the specified CLI/PIN of type Referring CLI, and every such element will, on its turn, contain the following sub-elements:
-100
203
GetReferringCLI
GetReferringCLI
This method retrieves all relevant data of a CLI/PIN of type Referring CLI.
Input
Elements
Output
Name SN ReferringCLI PinCLIAttached Status 0 = Blocked 1 = Active 2 = Suspended Master BatchNumber ContactType2Id RecordAdded LastUpdate NameUserLastUpdate Type string string string short
string string int dateTime dateTime string
If Result contains an integer other than 0, then ItemInfo will contain NULL.
204
GetReferringCLI
-100
205
GetReferringCLIProfiles
GetReferringCLIProfiles
This method returns the list of CLI/PIN profiles for CLIs/PINs of type Referring CLI.
Input
Elements None.
Output
Name ReferringCLIProfileId ReferringCLIProfileDescription Type int string
-100
206
UpdateParametersReferringCLI
This method adds, updates, and/or deletes one or more parameters linked to a CLI/PIN of type Referring CLI.
Input
Elements
complex
No
Output
207
-100
208
UpdateReferringCLI
UpdateReferringCLI
This method updates a CLI/PIN of type referring CLI.
Input
Elements
Name SN ReferringCLI PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the PinCLIAttached field will not be updated. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the updated ReferringCLI will be empty. GetStatusList 0 = Blocked 1 = Active 3 = Suspended Description Type string(32) string(16) string(32) Mandatory Yes No No
Status
short
No
BatchNumber NameUserLastUpdate Logging AccountType (int) Account (string(66))
string(16) string(15) complex
No No No
Output
Code 0 -1 -2 -3 -4 Description OK Invalid SN, or SN does not exists in the database Invalid Type Invalid OperatorId CLI already exists in the database in combination with operator
209
UpdateReferringCLI
Code -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42
Description Invalid CLI Invalid MasterPincode UserId already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method
210
UpdateReferringCLI
Code -43
Description Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Unable to update a referring CLI that has been repatriated or ported out. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -51 -90 -91
-100
21 1
VoucherPin
Chapter 9:
VoucherPin
In this chapter, you will find a detailed description of all methods contained in the VoucherPin web service. This web service allows you to manage CLIs/PINs of category Voucher PIN.
Web method AddCreditsViaVoucherPin AddCreditsVoucherPin AddVoucherPin DeleteVoucherPin GetParametersVoucherPin GetVoucherPin GetVoucherPinProfiles UpdateParametersVoucherPin UpdateVoucherPin Page
212 214 216 220 221 222 225 226 228
212
AddCreditsViaVoucherPin
This method transfers the credits from a CLI/PIN of type voucher PIN to a CLI/PIN of type CLI.
Input
Elements
Name VoucherPin CLI IsMSISDN False = CLI is looked up in the PinInfo table True = CLI is looked up in the MSISDN table False = No entry is added to the ReloadHistoryLogging True = Entry is added to the ReloadHistoryLogging Description Type string string boolean Mandatory Yes Yes Yes
WriteLogging
boolean
Yes
ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int)
No
Output
Code 0 -1 -2 -90 -91 Description OK Specified CLI/PIN is invalid or does not exist. Invalid Type Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
213
214
AddCreditsVoucherPin
This method updates the credit settings of a CLI/PIN of type voucher PIN. It also adds a ReloadHistory record if the AddCredits element in the SOAP request contains a number of credits greater than 0 (=zero).
Input
Elements
Name SN AddCredits CheckSetting304 UpdateRecordHistory UpdateFirstTimeUsed UpdateManualRecharges CheckManualRecharges Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int) Type string(32) decimal(20,6) boolean boolean boolean boolean boolean complex Mandatory Yes Yes Yes Yes Yes Yes Yes No
No
Output
Code 0 -1 Description OK Specified CLI/PIN is invalid or does not exist.
215
Code -2 -3 -90 -91
Description Invalid Type Too many manual recharges Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
216
AddVoucherPin
AddVoucherPin
This method adds a CLI/PIN of type voucher PIN.
Input
Elements
Name ProfileId VoucherPin PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the default PinCLIAttached value will be taken from the CLI/PIN profile. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the added voucher PIN will be empty. Description GetVoucherPinProfiles Type int string(16) string(32) Mandatory No Yes No
Status Master BatchNumber ContactType2Id DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm
short string(32) string(16) int dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int
No No No Yes No No No No No No No No No No No No No
217
AddVoucherPin
Name WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm MaxTotalCredits MinCreditToStartCall TaxationMethodLegA TaxationMethodLegB CurrencyId MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification NameUserLastUpdate Logging AccountType (int) Account (string(66)) ReloadHistoryLogging ReloadType (int) ReloadSubType (int) Description (string(160)) SMSText (string(160)) InitiatorType (int) Initiator (string(50)) PaymentType (int) Payment (string(50)) OrderId (string(20)) ContactType2Id (int)
Description
Type int int int int int int int int int int int int decimal(20,6) decimal(20,6) short short
Mandatory No No No No No No No No No No No No No No No No No No No No No No No No No No No No No
GetCurrencyList
short short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(15) complex
No
218
AddVoucherPin
Output
The method will return a complex type called ResultInsertNumber, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the serial number of the voucher PIN that was added. If Result contains an integer other than 0, then SN will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 Description OK Invalid Type or invalid CLI Invalid CustomerId Invalid OperatorId Specified CLI/PIN already exists in the database in combination with this operator Invalid ProfileId Invalid MasterPincode Userid already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm
219
AddVoucherPin
Code -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43
Description Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -90 -91
-100
220
DeleteVoucherPin
DeleteVoucherPin
This method deletes a CLI/PIN of type voucher PIN.
Input
Elements
Output
Code 0 -1 -2 -3 -5 -90 -91 Description OK SN cannot be found SN does not refer to a CLI/PIN of type Voucher PIN. The master CLI/PIN cannot be deleted. There are still CLIs/PINs linked to it. An error occurred while trying to delete a PIN linked to this master. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
221
GetParametersVoucherPin
GetParametersVoucherPin
This method retrieves the parameters linked to a CLI/PIN of type voucher PIN.
Input
Elements
Output
The method will return a complex type called GetParameterListResult, containing an array called Parameters, and an integer called Result. Parameters If Result contains 0, then Parameters will contain an element for every parameter linked to the specified CLI/PIN of type voucher PIN, and every such element will, on its turn, contain the following sub-elements:
-100
222
GetVoucherPin
GetVoucherPin
This method retrieves all relevant data of a CLI/PIN of type voucher PIN.
Input
Elements
Output
Name SN VoucherPin PinCLIAttached Status Master BatchNumber ContactType2Id DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Type string string string short string string int dateTime dateTime short int boolean boolean boolean boolean boolean boolean
223
GetVoucherPin
Name Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm MaxTotalCredits MinCreditToStartCall CostTableLegA MasterTableLegA CostTableLegB MasterTableLegB TaxationMethodLegA TaxationMethodLegB CurrencyId MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification FirstTimeUsed LastTimeUsed RecordAdded LastUpdate
Type boolean short short short short short short short short short short short short short short decimal decimal short short short short short short short short decimal boolean short decimal short decimal boolean short boolean dateTime dateTime dateTime dateTime
224
GetVoucherPin
Name NameUserLastUpdate TotalUsedCredits
Type string decimal
-100
225
GetVoucherPinProfiles
GetVoucherPinProfiles
This method returns the list of CLI/PIN profiles for CLIs/PINs of type voucher PIN.
Input
Elements None.
Output
Name VoucherPinProfileId VoucherPinProfileDescription Type int string
-100
226
UpdateParametersVoucherPin
This method adds, updates, and/or deletes one or more parameters linked to a CLI/PIN of type voucher PIN.
Input
Elements
complex
No
Output
227
-100
228
UpdateVoucherPin
UpdateVoucherPin
This method updates a CLI/PIN of type voucher PIN.
Input
Elements
Name SN VoucherPin PinCLIAttached Value must be a valid CLI/PIN serial number (SN) If this element is not passed to the method, then the PinCLIAttached field will not be updated. If this element is passed to the method, but its value is left blank, then the PinCLIAttached field of the updated voucher PIN will be empty. Description Type string(32) string(16) string(32) Mandatory Yes No No
Status BatchNumber DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm FriFromDayhhmm SatFromDayhhmm
short string(16) dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean int int int int int int
No No No No No No No No No No No No No No No No No No No
229
UpdateVoucherPin
Name SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm MaxTotalCredits MinCreditToStartCall TaxationMethodLegA TaxationMethodLegB CurrencyId MaxNumFreeRecharges FreeRechargeAmount FreeRechargeIsPercentage MaxNumManualRecharges AutoTopupAmount MaxNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification NameUserLastUpdate Logging AccountType (int) Account (string(66))
Description
Type int int int int int int int int decimal(20,6) decimal(20,6) short short
GetCurrencyList
short short decimal(20,6) boolean short decimal(20,6) short decimal(20,6) boolean short boolean string(15) complex
Output
Code 0 -1 -2 -3 -4 Description OK Invalid SN, or SN does not exists in the database Invalid Type Invalid OperatorId CLI already exists in the database in combination with operator
230
UpdateVoucherPin
Code -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42
Description Invalid CLI Invalid MasterPincode UserId already exists Invalid PinCLIAttached Invalid Status Invalid type Invalid ActivationCPS Invalid Requested CPS Invalid Gender Invalid DistributorId Invalid SalesPointId Invalid Message1Id Invalid Message2Id Invalid Message3Id Invalid Message4Id Invalid LanguageId Invalid TaxationMethodLegA Invalid TaxationMethodLegB Invalid TrafficId Invalid Minimum Carrier Quality Invalid Rounding Invalid Currency Invalid MonFromDayhhmm Invalid TueFromDayhhmm Invalid WedFromDayhhmm Invalid ThuFromDayhhmm Invalid FriFromDayhhmm Invalid SatFromDayhhmm Invalid SunFromDayhhmm Invalid MonUntilDayhhmm Invalid TueUntilDayhhmm Invalid WedUntilDayhhmm Invalid ThuUntilDayhhmm Invalid FriUntilDayhhmm Invalid SatUntilDayhhmm Invalid SunUntilDayhhmm Invalid Payment method
231
UpdateVoucherPin
Code -43
Description Invalid DestinationsAccepted Only DTMF digits, -, and * are allowed. Invalid DIDAccepted Only DTMF digits, -, and * are allowed. Invalid Birthday Date must be between 1/1/1900 and 31/12/2037 Invalid StartingDate Date must be between 1/1/1997 and 31/12/2037 Invalid ExpirationDate Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSRequest Date must be between 1/1/1997 and 31/12/2037 Invalid DateCPSSigned Date must be between 1/1/1997 and 31/12/2037 AutoTopupAmount must be a postive number. Unable to update a voucher PIN that has been repatriated or ported out. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-44
-45
-46
-47
-48
-49
-50 -51 -90 -91
-100
232
CDR
Chapter 10:
CDR
In this chapter, you will find a detailed description of all methods contained in the CDR web service. This web service allows you to retrieve CDRs and CDR Details from the database.
Web method GetCDRList GetCDRList2 GetCDRListWithDetails GetCDRListWithDetails2 GetFullCDRList GetFullCDRListWithDetails Page 233 236 237 241 242 247
233
GetCDRList
GetCDRList
This method returns a limited set of fields for a selection of CDRs.
This method ... should be used with great care. Setting the filter too wide can cause a database server overload. will only return CDRs of which the destination (prefix) is not found in the DestinationInvisible database table.
Input
Elements The elements below that have a No in the Mandatory column, are optional filter criteria. In the SN element, you can use the % wildcard character.
Name ContactType2Id SN From Till TrafficTypeId SpecialFilterOptions SpecialFilterOptions (int) PageIndex PageSize SortBy SortOrder MaxItemCount 0=ASC, 1=DESC Maximum number of CDR records that will be retrieved (= TOP X) GetTrafficTypeList See below Description Type int string(32) dateTime dateTime int array Mandatory No No No No No No
0=Page 1, 1=Page 2, ...
int int int int int
Yes Yes Yes Yes No
SpecialFilterOptions In the SpecialFilterOptions element, you can pass an array of integers, each of which represents a predefined filter:
Filter setting 1 2 3 4 5 Description No CDRs of which the destination number is an emergeny number (100 to 1 and 1 10, 12). No CDRs of roaming calls. No CDRs of RT SMS messages. No CDRs of RT SMS messages, except those to a 4-digit premium number. No CDRs of MT calls.
234
GetCDRList
Filter setting 6 7
Description No CDRs of MT SMS messages. No CDRs of MT SMS messages, except those to a 4-digit premium number.
Output
The method will return a complex type called ResultCDRGetList, containing a dataset called ListInfo, an integer called Result, and four additional summary fields. ListInfo If Result contains 0, then ListInfo will contain a table with the following columns:
Name CDRId Begintime SN CompleteNumber FinalDestination DurationNetwork DurationConnection DurationCall CurNumUnitsUsed CurNumUnitsLeft CurrencyId OrigOperator DestOperator TrafficTypeId Cause DestinationCountry: The country name of the most matching prefix in the countryprefix table DestinationCountry2: In case of a mobile number ( 3247, 3248, 3259, 003247, 003248, 003249) the operator will be returned, else the country name of the destination. MaskDestination: Transformed destination/CLIP TypeCallId RoamingCountry: The full country name of the VLR will be displayed. This is done by use of a match with the country (countryprefix) table. Destination Type int dateTime string string string int int int decimal decimal short string string int int string string
string int string
string
If Result contains an integer other than 0, then ListInfo will contain NULL.
235
GetCDRList
-100
Summary fields In ResultCDRGetList, apart from the ListInfo dataset and the Result integer, you will also find the following fields:
Name TotalUsedCurrencyId Description ID of the currency in which TotalUsedCredits is expressed See: GetCurrencyList (page 576) The sum of the Used Credits of all CDRs that were retrieved The sum of the Duration fields of all CDRs that were retrieved The total number of CDRs that were retrieved Important: TotalItems can never exceed MaxItemCount that was passed to the method. Type int
TotalUsedCredits TotalConnectedDuration TotalItems
decimal int int
236
GetCDRList2
GetCDRList2
This method returns the same as GetCDRList, but extended with a reference to the External Billing Reference table for CDRs of premium sessions. Use the method GetExternalBillingReferenceById (page 663) to retrieve the related premium content provider record from the External Billing Reference table.
Input
See GetCDRList (page 233).
Output
The method will return a complex type called ResultCDRGetList, containing a dataset called ListInfo, an integer called Result, and four additional summary fields. ListInfo ListInfo returned by GetCDRList2 contains an additional column if Result contains 0:
Name See columns in ListInfo (page 234) ExternalBillingReferenceId int Type
If Result contains an integer other than 0, then ListInfo will contain NULL. Result See Result (page 235) Summary fields See Summary fields (page 235)
237
GetCDRListWithDetails
This method returns a limited set of fields for a selection of CDRs, including the related CDR Details, if any. The platform configuration determines for which sessions CDR Details are created, e.g. for 2-leg roaming calls (leg A and leg B), premium calls/messages where content and delivery are charged separately, or in case a call is partially charged to a bundle.
Input
Name CDRId ContactType2Id SN From Till TrafficTypeId SpecialFilterOptions SpecialFilterOptions (int) PageIndex PageSize SortBy SortOrder MaxItemCount 0=ASC, 1=DESC Maximum number of CDR records that will be retrieved (= TOP X) GetTrafficTypeList See below Description Type int int string(32) dateTime dateTime int array Mandatory No No No No No No No
0=Page 1, 1=Page 2, ...
int int int int int
Yes Yes Yes Yes No
Filter setting 1 2 3 Description No CDRs of which the destination number is an emergeny number (100 to 1 and 1 10, 12). No CDRs of roaming calls. No CDRs of RT SMS messages.
238
Filter setting 4 5 6 7
Description No CDRs of RT SMS messages, except those to a 4-digit premium number. No CDRs of MT calls. No CDRs of MT SMS messages. No CDRs of MT SMS messages, except those to a 4-digit premium number.
Output
The method will return a complex type called ResultCDRGetList, containing a dataset called ListInfo, an integer called Result, and four additional summary fields. ListInfo If Result contains 0, then ListInfo will contain two tables: one with CDRs and one with CDR Details. If Result contains an integer other than 0, then ListInfo will contain NULL. CDR For the CDRs, the table has the following columns:
Name CDRId Begintime SN CompleteNumber FinalDestination DurationNetwork DurationConnection DurationCall CurNumUnitsUsed CurNumUnitsLeft CurrencyId OrigOperator DestOperator TrafficTypeId Cause DestinationCountry: The country name of the most matching prefix in the countryprefix table DestinationCountry2: In case of a mobile number ( 3247, 3248, 3259, 003247, 003248, 003249) the operator will be returned, else the country name of the destination. MaskDestination: Transformed destination/CLIP TypeCallId RoamingCountry: The full country name of the VLR will be displayed. This is done by use of a match with the country (countryprefix) table. Destination Type int dateTime string string string int int int decimal decimal short string string int int string string
string int string
string
239
CDR Detail For the CDR Details, the table has the following columns:
Name Id CallModeId Price TimeZoneId MinimumUnits BundleUsageId TypeBundleUsage Quantity Price ProductPriceId SetupUnit SetupCost NormalUnit NormalCost MinimumUnit MinimumCost DeductionPerc SurchargeCost ReductionPerc StartDateTime Comment Bundle Modify RatingUnitId TypeDetail Taxation CurRoundedDuration FullCLI Operator OperOrig OperDest RegionId PriceVariationId PriceExceptionId IndexId CDRId (-> link to CDR) string string int int int int int string dateTime int dateTime int int int Type int int
240
Name CurNumUnitsUsed TotalDuration
Type decimal int
-100
Summary fields In ResultCDRGetList, apart from the ListInfo dataset and the Result integer, you will also find the following fields:
Name TotalUsedCurrencyId Description ID of the currency in which TotalUsedCredits is expressed See: GetCurrencyList (page 576) The sum of the Used Credits of all CDRs that were retrieved The sum of the Duration fields of all CDRs that were retrieved The total number of CDRs that were retrieved Important: TotalItems can never exceed MaxItemCount that was passed to the method. Type int
TotalUsedCredits TotalConnectedDuration TotalItems
decimal int int
241
GetCDRListWithDetails2
GetCDRListWithDetails2
This method returns the same as GetCDRListWithDetails, but extended with a reference to the External Billing Reference table for CDRs of premium sessions. Use the method GetExternalBillingReferenceById (page 663) to retrieve the related premium content provider record from the External Billing Reference table.
Input
See GetCDRListWithDetails (page 237).
Output
The method will return a complex type called ResultCDRGetList, containing a dataset called ListInfo, an integer called Result, and four additional summary fields. ListInfo If Result contains 0, then ListInfo will contain two tables: one with CDRs and one with CDR Details. If Result contains an integer other than 0, then ListInfo will contain NULL. CDR For the CDRs, the table has an additional column compared to GetCDRListWithDetails:
Name See columns in ListInfo (page 238) ExternalBillingReferenceId int Type
CDR Detail For the CDR Details, the table has the same columns as GetCDRListWithDetails. See CDR Detail (page 239) Result See Result (page 240) Summary fields See Summary fields (page 240)
242
GetFullCDRList
GetFullCDRList
This method returns the full set of fields for a selection of CDRs.
Input
Name ContactType2Id SN From Till TrafficTypeId SpecialFilterOptions SpecialFilterOptions (int) PageIndex PageSize SortBy SortOrder MaxItemCount 0=ASC, 1=DESC Maximum number of CDR records that will be retrieved (= TOP X) GetTrafficTypeList See below Description Type int string(32) dateTime dateTime int array Mandatory No No No No No No
0=Page 1, 1=Page 2, ...
int int int int int
Yes Yes Yes Yes No
Filter setting 1 2 3 4 5 Description No CDRs of which the destination number is an emergeny number (100 to 1 and 1 10, 12). No CDRs of roaming calls. No CDRs of RT SMS messages. No CDRs of RT SMS messages, except those to a 4-digit premium number. No CDRs of MT calls.
243
GetFullCDRList
Filter setting 6 7
Description No CDRs of MT SMS messages. No CDRs of MT SMS messages, except those to a 4-digit premium number.
Output
The method will return a complex type called ResultCDRGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain a table with the following columns:
Name CDRId Clip DID DateTime PinCode TypeConnection Channel ChannelOut NumIsdnActive NumVoiceActive TrunkNameIn TrunkGroupNameIn TrunkNameOut TrunkGroupNameOut CrnIn CrnOut SetupTime CurRoundedDurationConnect NumCentiemPerMin DurInterval MinNumCentPerMin MinDurInterval DestinationCode PrefixUsedInCountry ComputerName OtherComputerName InvoiceReference Type int
244
GetFullCDRList
Name BatchNumber PinCliAttached CurNumberOfUsers CurNumUnitsLeftToday CurNumUnitsLeftThisWeek CurNumUnitsLeftThisMonth CostTable MasterPinCode HelpDesk HelpDeskCharge PayPhone PayPhoneCharge FileName DidSuffix CurNumUnitsUsedLegA NumCentiemPerMinLegA DurIntervalLegA MinNumCentiemPerMinLegA MinDurIntervalLegA CostTableLegA MilliSecondsBetweenAOC CurBuyingNumUnits CurBuyingNumUnitsLegA MethodTaxation CustomerID ExtraCharge ReductionCliPin Rounding FullCli Operator Qos DebugID RegionID RegionIDLegA TimeZoneID TimeZoneIDLegA LostSeconds FreeSeconds
Type
245
GetFullCDRList
Name ResellerBuyingNumUnits ResellerBuyingNumUnitsLegA TwoStageCall Reversed MainID PriceVariationID PriceVariationIDLegA PriceExceptionID PriceExceptionIDLegA OriginalClip CarrierIn CarrierOut TimeInQueue TimeBeforeAnswer QueueId NumCallsRouted NumCallsInQueue StatusQueue Reseller Group SubGroup Modify BundleID UserID RatingUnitID ExternalID PackageID ExportFileName ExportDateTime GeoTimeZoneID CountryID RateOfExchange BeginTime SN CompleteNumber FinalDestination DurationNetwork DurationConnection
Type
dateTime string string string int int
246
GetFullCDRList
Name DurationCall CurNumUnitsUsed CurNumUnitsLeft CurrencyId OrigOperator DestOperator TrafficTypeId Cause TypeCallId Destination ExternalBillingReferenceId RetailPackageId RetailBundleId RetailResellerId
Type int decimal decimal short string string int int int string int int int int
-100
247
GetFullCDRListWithDetails
This method returns the full set of fields for a selection of CDRs, including the related CDR Details, if any. The platform configuration determines for which sessions CDR Details are created, e.g. for 2-leg roaming calls (leg A and leg B), premium calls/messages where content and delivery are charged separately, or in case a call is partially charged to a bundle.
Input
Name CDRId ContactType2Id SN From Till TrafficTypeId SpecialFilterOptions SpecialFilterOptions (int) PageIndex PageSize SortBy SortOrder MaxItemCount 0=ASC, 1=DESC Maximum number of CDR records that will be retrieved (= TOP X) GetTrafficTypeList See below Description Type int int string(32) dateTime dateTime int array Mandatory No No No No No No No
0=Page 1, 1=Page 2, ...
int int int int int
Yes Yes Yes Yes No
Filter setting 1 2 3 Description No CDRs of which the destination number is an emergeny number (100 to 1 and 1 10, 12). No CDRs of roaming calls. No CDRs of RT SMS messages.
248
Filter setting 4 5 6 7
Description No CDRs of RT SMS messages, except those to a 4-digit premium number. No CDRs of MT calls. No CDRs of MT SMS messages. No CDRs of MT SMS messages, except those to a 4-digit premium number.
Output
The method will return a complex type called ResultCDRGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain two tables: one with CDRs and one with CDR Details. If Result contains an integer other than 0, then ListInfo will contain NULL. CDR For the CDRs, the table has the following columns:
Name CDRId Clip DID DateTime PinCode TypeConnection Channel ChannelOut NumIsdnActive NumVoiceActive TrunkNameIn TrunkGroupNameIn TrunkNameOut TrunkGroupNameOut CrnIn CrnOut SetupTime CurRoundedDurationConnect NumCentiemPerMin DurInterval MinNumCentPerMin MinDurInterval DestinationCode Type int
249
Name PrefixUsedInCountry ComputerName OtherComputerName InvoiceReference BatchNumber PinCliAttached CurNumberOfUsers CurNumUnitsLeftToday CurNumUnitsLeftThisWeek CurNumUnitsLeftThisMonth CostTable MasterPinCode HelpDesk HelpDeskCharge PayPhone PayPhoneCharge FileName DidSuffix CurNumUnitsUsedLegA NumCentiemPerMinLegA DurIntervalLegA MinNumCentiemPerMinLegA MinDurIntervalLegA CostTableLegA MilliSecondsBetweenAOC CurBuyingNumUnits CurBuyingNumUnitsLegA MethodTaxation CustomerID ExtraCharge ReductionCliPin Rounding FullCli Operator Qos DebugID RegionID RegionIDLegA
Type
250
Name TimeZoneID TimeZoneIDLegA LostSeconds FreeSeconds ResellerBuyingNumUnits ResellerBuyingNumUnitsLegA TwoStageCall Reversed MainID PriceVariationID PriceVariationIDLegA PriceExceptionID PriceExceptionIDLegA OriginalClip CarrierIn CarrierOut TimeInQueue TimeBeforeAnswer QueueId NumCallsRouted NumCallsInQueue StatusQueue Reseller Group SubGroup Modify BundleID UserID RatingUnitID ExternalID PackageID ExportFileName ExportDateTime GeoTimeZoneID CountryID RateOfExchange BeginTime SN
Type
dateTime string
251
Name CompleteNumber FinalDestination DurationNetwork DurationConnection DurationCall CurNumUnitsUsed CurNumUnitsLeft CurrencyId OrigOperator DestOperator TrafficTypeId Cause TypeCallId Destination ExternalBillingReferenceId RetailPackageId RetailBundleId RetailResellerId
Type string string int int int decimal decimal short string string int int int string int int int int
CDR Detail For the CDR Details, the table has the following columns:
Name Id CallModeId Price TimeZoneId MinimumUnits BundleUsageId TypeBundleUsage Quantity Price ProductPriceId SetupUnit SetupCost NormalUnit NormalCost MinimumUnit MinimumCost int int int Type int int
252
Name DeductionPerc SurchargeCost ReductionPerc StartDateTime Comment Bundle Modify RatingUnitId TypeDetail Taxation CurRoundedDuration FullCLI Operator OperOrig OperDest RegionId PriceVariationId PriceExceptionId IndexId CDRId (-> link to CDR)
Type
dateTime
dateTime int
string
string string int int int int int
-100
253
Invoice
Chapter 11:
Invoice
In this chapter, you will find a detailed description of all methods contained in the Invoice web service.
Web method GetInvoiceList GetPdfInvoice Page 254 256
254
GetInvoiceList
GetInvoiceList
This method returns a (filtered) list of invoices.
Input
Elements
Name ContactType2Id From Till InvoiceNumber ComparisonAccepted Accepted PageIndex 0=Page 1, 1=Page 2, ... PageSize SortBy SortOrder 0=ASC, 1=DESC Type int dateTime dateTime string(1 1) int int int Mandatory No No No No No No Yes
int int int
Yes Yes Yes
InvoiceNumber If an invoice number is passed to the method in the InvoiceNumber element, then the method will return invoices with a number smaller or equal to the number that was passed. ComparisonAccepted If you want to filter the invoice list based on Accepted value, enter an Accepted value in the Accepted element, and an operator in the ComparisonAccepted element.
ComparisonAccepted 0 1 2 3 4 5 Operator >= > <= < = <>
255
GetInvoiceList
Output
Name InvoiceId Accepted ContactType2Id InvoiceNumber InvoiceFrom InvoiceTill InvoiceValue InvoiceVAT InvoicePaid InvoiceDate InvoiceDueDate CurrencyId PdfFileExists 0 = PDF file does not exist 1 = PDF file exists Type int int int string dateTime dateTime decimal decimal decimal dateTime dateTime int int
-100
256
GetPdfInvoice
GetPdfInvoice
This method returns an invoice in PDF format.
Input
Elements
Name InvoiceId Type int Mandatory Yes
Output
The method will return a complex type called ResultGetFile, containing a byte array called ListInfo, an integer called Result, and ListInfo If Result contains 0, then ListInfo will contain an array of bytes that make up the invoice in PDF format. If Result contains an integer other than 0, then ListInfo will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -90 -91 Description OK Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error InvoiceId not found PDF file does not exist Cannot open PDF file
-100 -101 -102 -103
257
Commission
Chapter 12:
Commission
In this chapter, you will find a detailed description of all methods contained in the Commission web service.
Web method GetCommissionList GetPdfCommission Page 258 260
258
GetCommissionList
GetCommissionList
This method returns a (filtered) list of commission notes.
Input
Elements
Name ContactType1Id From Till CommissionNumber ComparisonAccepted Accepted PageIndex 0=Page 1, 1=Page 2, ... PageSize SortBy SortOrder 0=ASC, 1=DESC Type int dateTime dateTime string(1 1) int int int Mandatory No No No No No No Yes
int int int
Yes Yes Yes
CommissionNumber If a commission number is passed to the method in the CommissionNumber element, then the method will return commission notes with a number smaller or equal to the number that was passed. ComparisonAccepted If you want to filter the commission note list based on Accepted value, enter an Accepted value in the Accepted element, and an operator in the ComparisonAccepted element.
ComparisonAccepted 0 1 2 3 4 5 Operator >= > <= < = <>
259
GetCommissionList
Output
Name CommissionId Accepted ContactType1Id CommissionNumber CommissionFrom CommissionTill CommissionValue CommissionVAT CommissionPaid CommissionDate CommissionDueDate CurrencyId PdfFileExists 0 = PDF file does not exist 1 = PDF file exists Type int int int string dateTime dateTime decimal decimal decimal dateTime dateTime int int
-100
260
GetPdfCommission
GetPdfCommission
This method returns a commission note in PDF format.
Input
Elements
Name CommissionId Type int Mandatory Yes
Output
The method will return a complex type called ResultGetFile, containing a byte array called ListInfo, an integer called Result, and ListInfo If Result contains 0, then ListInfo will contain an array of bytes that make up the commission note in PDF format. If Result contains an integer other than 0, then ListInfo will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -90 -91 Description OK Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error CommissionId not found PDF file does not exist Cannot open PDF file
-100 -101 -102 -103
261
ReloadHistory
Chapter 13:
ReloadHistory
In this chapter, you will find a detailed description of all methods contained in the ReloadHistory web service. This web service allows you to retrieve reload history records from the database.
Web method GetReloadHistoryList Page 262
262
GetReloadHistoryList
This method returns a (filtered) list of reload history records.
This method should be used with great care. Setting the filter to wide can cause a database server overload.
Input
Name ContactType2Id SN From Till ReloadType InitiatorType PaymentType Error PageIndex 0=Page 1, 1=Page 2, ... PageSize SortBy SortOrder 0=ASC, 1=DESC GetConversionCodeList (ReloadType) GetConversionCodeList (InitiatorType) GetConversionCodeList (PaymentType) Type int string(32) dateTime dateTime int int int int int Mandatory No No No No No No No No Yes
int int int
Yes Yes Yes
Filtering on ContactType2Id and/or SN The following table shows the impact of the ContactType2Id and SN elements on the results returned by the web method. Note: The results mentioned in the table below are the results that will be returned if none of the other filter criteria (From, Till, ReloadType, InitiatorType, PaymentType, Error) have been passed.
then the GetReloadHistoryList method will return all reload history records ... of the CLI/PIN with the specified SN. However, if the specified SN does not refer to a CLI/PIN linked to the specified ContactType2, then no records will be returned at all. of all CLIs/PINs linked to the specified ContactType2.
If ContactType2Id is ... passed
and SN is ... passed
passed
not passed
263
If ContactType2Id is ... not passed not passed
and SN is ... passed not passed
then the GetReloadHistoryList method will return all reload history records ... of the CLI/PIN with the specified SN. whatever the ContactType2 or SN.
Output
Name ReloadId Date SN ReloadType ReloadSubType Description Comment OriginalCurrencyId OriginalValue NewCurrencyId NewValue InititiatorType Initiator PaymentType Payment OrderId SNPayment ContactType2Id Error Balance Type int dateTime string int int string string int decimal int decimal int string int string string string int int decimal
Code 0 -90 Description OK Authentication failed
264
Code -91
-100
265
PlaceCall
Chapter 14:
PlaceCall
In this chapter, you will find a detailed description of all methods contained in the PlaceCall web service. This web service allows you to set up and control a voice call involving two or more calling parties.
Web method CreateNewCallGroup GetAllCallGroupsFromSN GetAllCallsInCallGroup InsertCallInCallGroup UpdateAllCallsInCallGroup UpdateCallGroup UpdateCallInCallGroup Page 266 267 268 270 271 272 273
266
CreateNewCallGroup
CreateNewCallGroup
This method creates a new call group.
Input
Elements
Name SN Description Serial number of the CLI/PIN that will be charged for the call. Whether or not the participant who initiated the call will be automatically disconnected when all other participants have hung up. Type string(32) Mandatory Yes
HangUpIfAllOtherPartiesHungUp
boolean
Yes
PlatformId 1 = SIP call control 2 = ISUP/HMP tromboning 3 = IN call control
short
No
Output
The method will return a complex type called CreateNewCallGroupResult, containing: an integer called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the call group that was created. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -90 -91 Description OK Authentication failed Field overflow Too many characters, Date out of range, ... Error during retrieval of CLI/PIN record Error during creation of CallGroup Unspecified error during creation of CallGroup
-1 > -100 -101 -200
267
GetAllCallGroupsFromSN
GetAllCallGroupsFromSN
This method returns the list of call groups of a particular SN.
Input
Elements
Name SN Description Serial number of the CLI/PIN that will be charged for the call(s). Type string(32) Mandatory Yes
Output
The method will return a complex type called GetAllCallGroupsFromSNResult, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain a table with the following columns:
Name CallGroupId HangUpIfAllOtherPartiesHungUp Type int boolean
Code 0 -90 -91 Description OK Authentication failed Field overflow Too many characters, Date out of range, ... Error during retrieval of CLI/PIN record Unspecified error during retrieval of CallGroups
-1 > -100 -200
268
GetAllCallsInCallGroup
This method returns the list of participants in a particular call group.
Input
Elements
Name CallGroupId SortBy Description ID of the call group The field on which the list will be sorted: 0 = Name 2 = StartTime 4 = Status 5 = RequestedStatus 7 = Destination 8 = MemberId The order in which the list will be sorted: True = Ascending False = Descending Type int int Mandatory Yes Yes
SortOrder
boolean
Yes
Output
The method will return a complex type called GetAllCallsInCallGroupResult, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain a table with the following columns:
Name MemberId CallGroupId Destination Name Status 0 = Nothing 1 = Ringing 2= Speaking 3 = On hold 4 = Disconnected 5 = Disconnected + Recalled Type int int string string unsignedByte
269
Name RequestedStatus 0 = Nothing 1 = Set up call 2 = End call 3 = Put on hold 4 = Take back IsPinHolder Reason1 Reason2
Type unsignedByte
boolean int int
Code 0 -1 -90 -91 Description OK CallGroupId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
270
InsertCallInCallGroup
InsertCallInCallGroup
This method adds a participant to a particular call group.
Input
Elements
Name CallGroupId Destination Name IsPinHolder StartCall Description ID of the call group Telephone number of the participant Name of the participant Whether or not the participant is the call initiator. Whether or not the participant should be called immediately. Type int string(32) string(50) boolean boolean Mandatory Yes No No Yes Yes
Output
The method will return a complex type called InsertCallInCallGroupResult, containing: an integer called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the call group that was created. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -90 -91 Description OK When adding the first participant, IsPinHolder has to be True. When adding a participant other than the first, IsPinHolder has to be False. CallGroupId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
271
UpdateAllCallsInCallGroup
UpdateAllCallsInCallGroup
This method performs one of the following actions: delete all participants of a particular call group, disconnect all participants of a particular call group, or call all participants of a particular call group.
Input
Elements
Name CallGroupId UpdateAction Description ID of the call group The action to be performed: DeleteAllCalls Delete all participants who are not busy, i.e. of whom the current status is 0 (Nothing), 4 (Disconnected), or 5 (Disconnected + Recalled) Disconnect all participants who are busy by setting their RequestedStatus to 2 (EndCall) Call all participants of whom the current status is 0 (Nothing), or 4 (Disconnected). Type int enum Mandatory Yes Yes
HangUpAllCalls
CallAllCalls
Output
-100
272
UpdateCallGroup
UpdateCallGroup
This method updates the HangUpIfAllOtherPartiesHungUp property of a particular call group.
Input
Elements
Name CallGroupId HangUpIfAllOtherPartiesHungUp Description ID of the call group Whether or not the participant who initiated the call will be automatically disconnected when all other participants have hung up. Type int boolean Mandatory Yes Yes
Output
-100
273
UpdateCallInCallGroup
This method updates the RequestedStatus property of a participant in a particular call group. Note: Before trying to delete the call initiator (i.e. the Pin holder) from the call group, first delete all other members from the call group. If you delete the call initiator (i.e. the Pin holder), the call group will automatically be deleted as well.
Input
Elements
Name CallGroupId MemberId RequestedStatus Description ID of the call group ID of the call participant New requested call status: Nothing StartCall EndCall OnHold TakeBack Status does not have to be changed Call the participant Disconnect the participant Put the participant on hold Take back the participant (who was put on hold earlier) Call the participant again (who was disconnected earlier) Delete the participant Type int int enum Mandatory Yes Yes Yes
Recall
DeleteCall
Output
Code 0 -1 -2 -3 Description OK CallGroupId not found Invalid CallGroupId/MemberId combination Specified participant (member) cannot be deleted (Reason: Only participants with current status equal to Nothing (0), Disconnected (4), or Disconnected + Recalled (5) can be deleted)
274
Code -4 -5 -6 -7 -8 -9
Description Error during creation of new call (Recall) Invalid RequestedStatus The call initiator (i.e. PinHolder) cannot be recalled. Only participants with status Disconnected (4) can be recalled. Only participants with status Nothing (0) or Disconnected (4) can be called. The call initiator (i.e. PinHolder) cannot be deleted as long as there are other participants in the call group. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
275
Switching
Chapter 15:
Switching
In this chapter, you will find a detailed description of all methods contained in the Switching web service. This web service allows you to manage all switching data: accepted/rejected destinations, shortcodes, ...
Web method AddUpdateDestinations AddUpdateShortcodes DeleteDestinations DeleteShortcodes GetDestinationList GetDestinationReferenceList GetShortcodeList GetShortcodeReferenceList Page 276 278 280 282 284 287 286 289
276
AddUpdateDestinations
This method adds and/or updates one or more destinations in a specified destination library. Note: The name of a destination library is called destination reference.
Input
Elements
Name DestinationReference Destinations Destinations (array) Logging AccountType (int) Account (string(66)) Type string complex Mandatory No >= 1
complex
No
Destinations array In the Destination array, add a Destination element for every destination you want to add or update. Every array element should contain the following sub-elements:
Name Destination Rejected RouteTable SecondsToAdd RoudingSeconds TimeTable Type string boolean short int short short Mandatory No Yes Yes Yes Yes Yes
Add or update? Depending on whether or not the parameter exists, the method will either add or, update the destination. See the table below.
Situation Destination does not exist Destination exists Action ADD UPDATE
277
Output
The method will return a complex type called AddUpdateDestinationResult containing an integer called Result, and an array called Unsuccessful. Result The integer Result will contain one of the following return codes:
Code 0 -2 -1 -3 Description All updates OK No destinationReference was passed No destinations were passed Some additions/updates failed See: Unsuccessful Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
Unsuccessful If the method returns -3, indicating that it was unable to add/update some of the destinations that were passed to it, the Unsuccessful array will contain an element for every destination that could not be added/updated. Such an element will contain the following sub-elements:
Name Destination Rejected ErrorCode -1 = Destination is too long -2 = Destination is empty -3 = Invalid Rejected value -4 = Invalid RouteTable value -5 = Invalid RoundingSeconds value -6 = Invalid TimeTable value Type string boolean int
278
AddUpdateShortcodes
AddUpdateShortcodes
This method adds and/or updates one or more shortcodes in a specified shortcode library. Note: The name of a shortcode library is called shortcode reference.
Input
Elements
Name ShortcodeReference Codes Codes (array) Logging AccountType (int) Account (string(66)) Type string complex Mandatory No >= 1
complex
No
Codes array In the Codes array, add a Code element for every shortcode you want to add or update. Every array element should contain the following sub-elements:
Name Shortcode Number Type int string Mandatory No No
Add or update? Depending on whether or not the parameter exists, the method will either add or, update the shortcode. See the table below.
Situation Shortcode does not exist Shortcode exists Action ADD UPDATE
279
AddUpdateShortcodes
Output
The method will return a complex type called AddUpdateShortcodeResult containing an integer called Result, and an array called Unsuccessful. Result The integer Result will contain one of the following return codes:
Code 0 -1 -3 -90 -91 Description All updates OK No shortcodes in web method (Code error) Some additions/updates failed Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
Unsuccessful If the method returns -3, indicating that it was unable to add/update some of the shortcodes that were passed to it, the Unsuccessful array will contain an element for every shortcode that could not be added/updated. Such an element will contain the following sub-elements:
Name Shortcode Number ErrorCode -1 = Shortcode too long -2 = Number too long Type string string int
280
DeleteDestinations
DeleteDestinations
This method deletes one or more destinations in a specified destination library, or an entire destination library. Note: The name of a destination library is called destination reference.
Input
Elements
Name DestinationReference DeleteCompleteDestinationReference Destinations Destinations (string) Logging AccountType (int) Account (string(66)) Type string boolean array Mandatory No Yes No
complex
No
DeleteCompleteDestinationReference If the DeleteCompleteDestinationReference element contains True, then the method will delete the entire destination library. Destinations array In the Destinations array, add a Destinations element for every destination you want to delete.
Output
The method will return a complex type called DeleteDestinationResult containing an integer called Result, and an array called Unsuccessful. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -90 Description All deletions OK DestinationReference not found When DeleteCompleteDestinationReference is False, at least one destination has to be passed Some deletions failed Authentication failed
281
DeleteDestinations
Code -91
-100
Unsuccessful If the method returns -3, indicating that it was unable to delete some of the destinations that were passed to it, the Unsuccessful array will contain an element for every destination that could not be deleted. Such an element will contain the following sub-elements:
Name Destination ErrorCode -1 = Destination not found Type string int
282
DeleteShortcodes
DeleteShortcodes
This method deletes one or more shortcodes in a specified shortcode library, or an entire shortcode library. Note: The name of a shortcode library is called shortcode reference.
Input
Elements
Name ShortcodeReference DeleteCompleteShortcodeReference Shortcodes Shortcodes (string) Logging AccountType (int) Account (string(66)) Type string boolean array Mandatory No Yes No
complex
No
DeleteCompleteShortcodeReference If the DeleteCompleteShortcodeReference element contains True, then the method will delete the entire shortcode library. Shortcodes array In the Shortcodes array, add a Shortcodes element for every shortcode you want to delete.
Output
The method will return a complex type called DeleteShortcodeResult containing an integer called Result, and an array called Unsuccessful. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -90 Description All deletions OK Shortcode library not found When DeleteCompleteShortcodeReference is False, at least one shortcode has to be passed Some deletions failed Authentication failed
283
DeleteShortcodes
Code -91
-100
Unsuccessful If the method returns -3, indicating that it was unable to delete some of the shortcodes that were passed to it, the Unsuccessful array will contain an element for every shortcode that could not be deleted. Such an element will contain the following sub-elements:
Name Shortcode ErrorCode -1 = Shortcode not found Type string int
284
GetDestinationList
GetDestinationList
This method returns all destinations contained in a specified destination library. Note: The name of a destination library is called destination reference.
Input
Elements
Name DestinationReference Type string Mandatory No
Output
The method will return a complex type called ResultGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ItemInfo If Result contains 0, then ListInfo will contain a table with the following columns:
Name DestinationReference Destination Rejected RouteTable SecondsToAdd RoundingSeconds TimeTable Type string string boolean short int short short
Code 0 -1 -90 Description OK DestinationReference does not exists Authentication failed
285
GetDestinationList
Code -91
-100
286
GetShortcodeList
GetShortcodeList
This method returns all shortcodes contained in a specified shortcode library. Note: The name of a shortcode library is called shortcode reference.
Input
Elements
Name ShortcodeReference Type string Mandatory No
Output
Name Shortcode Number Type string string
Code 0 -1 -90 -91 Description OK ShortcodeReference does not exists Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
287
GetDestinationReferenceList
This method returns a (filtered) list of destination libraries. Note: The name of a destination library is called destination reference.
Input
Elements The DestinationReference element is an optional filter criterion. In this element, you can use the % wildcard character. If you do not pass it to the method (i.e. DestinationReference = Null), then you will receive a list of all destination libraries in the database.
Name DestinationReference PageIndex 0=Page 1, 1=Page 2, ... PageSize SortBy SortOrder 0=ASC, 1=DESC Type string int Mandatory No Yes
int int int
Yes Yes Yes
Output
Name DestinationReference Count Description Name of the destination library Number of destinations in the library Type string int
288
Code 0 -90 -91
Description OK Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
289
GetShortcodeReferenceList
This method returns a (filtered) list of shortcode libraries. Note: The name of a shortcode library is called shortcode reference.
Input
Elements The ShortcodeReference element is an optional filter criterion. In this element, you can use the % wildcard character. If you do not pass it to the method (i.e. ShortcodeReference = Null), then you will receive a list of all shortcode libraries in the database.
Name ShortcodeReference PageIndex 0=Page 1, 1=Page 2, ... PageSize SortBy SortOrder 0=ASC, 1=DESC Type string int Mandatory No Yes
int int int
Yes Yes Yes
Output
Name ShortcodeRef Count Description Name of the shortcode library Number of shortcodes in the library Type string int
290
Code 0 -90 -91
Description OK Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
291
Price management
Chapter 16:
Price management
In this chapter, you will find a detailed description of all methods contained in the PriceManagement web service. This web service allows you to manage all pricing data: Products Product prices Product price variations Product conditions ...
Web method AddCustomerProduct AddPriceVariation AddProduct AddProductCondition AddProductPrice ChangePriceVariationSequence ChangeProductConditionSequence CheckProductCondition DeleteCustomerProduct DeletePriceVariation DeleteProduct DeleteProductCondition DeleteProductPrice GetContacttype2ProductPrice GetCustomerProduct GetCustomerProductInfoFromSN GetCustomerProductList GetPriceModifier GetPriceModifierList GetPriceVariation GetPriceVariationList GetPriceVariationListByPricePlanChangeSet GetProduct GetProductCondition Page 293 295 299 301 302 306 307 308 309 310 31 1 312 313 314 316 318 320 322 324 326 328 331 334 336
292
Price management
Web method GetProductConditionList GetProductList GetProductListByPricePlanChangeSet GetProductPrice GetProductPriceList GetProductPriceListByPricePlanChangeSet UpdateCustomerProduct UpdatePriceVariation UpdateProduct UpdateProductCondition UpdateProductModifier UpdateProductPrice
Page 338 340 342 344 346 348 350 351 353 355 356 358
293
AddCustomerProduct
AddCustomerProduct
This method adds a customer product record in the database.
Input
Elements
Name ContactType2Id SN ProductId PackageId Quantity ValidFrom ValidUntil Reference Logging AccountType (int) Account (string(66)) Type int string int int decimal dateTime dateTime string complex Mandatory Yes No Yes Yes Yes Yes Yes No No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the customer product record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 Description OK Invalid ContactType2Id Invalid SN Invalid combination ContactType2Id-SN SN or ContactType2Id not specified
294
AddCustomerProduct
Code -5 -6 -7 -8
Description Package or product not specified Invalid product Invalid package The product exists but has status ToBeApproved. It needs to be Approved before you can link it to a customer. The package exists but has status ToBeApproved. It needs to be Approved before you can link it to a CLI or customer. Dates of customer-product link must lie within date range of the product. Dates of customer-package or CLI-package link must lie within date range of the package. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-9
-12 -13 -90 -91
-100
295
AddPriceVariation
AddPriceVariation
This method adds a price variation record in the database.
Input
Elements
Name ProductPriceId ContactType2Id SN PriceModifierId NewPriceModifier DID ProductId CallModeId OperatorId RegionId TimeZoneId CPCId Origin ValidFrom ValidUntil Destination ApplyOnChild DestinationOperatorId StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Logging AccountType (int) Account (string(66)) Type int int string int complex string int int int int int int string dateTime dateTime string boolean int int Mandatory Yes Yes No Yes Yes No Yes Yes Yes Yes Yes Yes No No No No Yes Yes Yes
int complex
Yes No
296
AddPriceVariation
Price modifier You can order the method to link to the price variation an existing price modifier (cannot be used in combination with 4-eyes / changeset-based tariff management), or a new price modifier.
In case of ... an existing price modifier, a new price modifier, in the element ... PriceModifierId, PriceModifierId, NewPriceModifier, pass to the method ... the ID of the existing modifier. the value -1, and all data necessary to create the new modifier.
In the complex NewPriceModifier element, you can pass the following price modifier record data:
Field Description CurrencyId MinimumDurationChange MinimumDurationOperatorId NormalDurationChange NormalDurationOperatorId MinimumCostChange MinimumCostOperatorId NormalCostChange NormalCostOperatorId MaxTimesMinimumCostChange MaxTimesMinimumCostOperatorId SetupTresholdChange SetupTresholdOperatorId SetupCostChange SetupCostOperatorId DeductionThresholdChange DeductionThresholdOperatorId SurchargeThresholdChange SurchargeThresholdOperatorId DeductionPercentageChange DeductionPercentageOperatorId SurchargeCostChange SurchargeCostOperatorId SurchargeTimesChange SurchargeTimesOperatorId SurchargeIntervalChange SurchargeIntervalOperatorId ReductionThresholdChange Type string int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal
297
AddPriceVariation
Field ReductionThresholdOperatorId ReductionPercentageChange ReductionPercentageOperatorId ReductionTimesChange ReductionTimesOperatorId ReductionIntervalChange ReductionIntervalOperatorId NameUserLastUpdate
Type int decimal int decimal int decimal int string
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the price variation record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -16 -17 -19 -60 Description OK Invalid PriceException (PriceVariationId) Invalid ProductPriceId Invalid SN Invalid CustomerId (ContactType2Id) Invalid PriceVariation (PriceModifierId) Invalid ProductId Invalid CallModeId Invalid OperatorId Invalid RegionId Invalid TimezoneId Invalid OperatorDestinationId Invalid PayPhone Cannot add PriceException(Variation) on this ProductPrice Invalid Destination (only DTMF allowed) PricePlanChangeSetId must be specified (system setting) PricePlanChangeSetId is not same as in parent record, here table ProductPrice PricePlanChangeSetId was specified but also a valid SN, so it's customer specific The PricePlanChangeSetId cannot be Null or Empty because of change set based tariff management restrictions
298
AddPriceVariation
Code -61 -62 -63 -64 -65 -68 -69 -90 -91
Description The PricePlanChangeSet with Id: {0} is not in ToBeApproved State The StatusChangeSet cannot be Value: {0}, it can be Null, 0= ToBeApproved or 2= Approved ValidFrom: {0} cannot be larger or equal to the ValidTill: {1} The PricePlanChangeSet with Id: {0} could not be found If 4-eyes is enabled, you must pass a valid new PriceModifier; the PriceModifierId must be -1. PriceModifier Description cannot be empty PriceModifier Currency does not exist Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error Unspecified error
-100 -200
299
AddProduct
AddProduct
This method adds a product record in the database.
Input
Elements
Name ProductCode Description BaseUnitsId FrequencyId VATPct TrafficId Accountancy Analytical FreeText ValidFrom ValidUntil StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Logging AccountType (int) Account (string(66)) Type string string int int decimal int string string string dateTime dateTime int Mandatory Yes No Yes Yes Yes Yes No No No Yes Yes Yes
int complex
Yes No
300
AddProduct
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the product record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -7 -60 -61 -62 -63 -64 -90 -91 Description OK Please enter a name The Productname already exists Enter a valid base unit Enter a valid traffic type Enter a valid frequency Enter a valid VAT percentage (between 0 and 100) The PricePlanChangeSetId cannot be Null or Empty because of change set based tariff management restrictions The PricePlanChangeSet with Id: {0} is not in ToBeApproved State The StatusChangeSet cannot be Value: {0}, it can be Null, 0= ToBeApproved or 2= Approved ValidFrom: {0} cannot be larger or equal to the ValidTill: {1} The PricePlanChangeSet with Id: {0} could not be found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
301
AddProductCondition
AddProductCondition
This method adds a product condition record in the database.
Input
Elements
Name ProductId ContactType2Id LogicaloperatorId BaseUnitsId RegionId OperatorId ConditionValue Logging AccountType (int) Account (string(66)) Type int int int int int int decimal complex Mandatory Yes Yes Yes Yes Yes Yes Yes No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the product condition record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
-100
302
AddProductPrice
AddProductPrice
This method adds a product price record in the database.
Input
Elements
Name Description ProductPriceMasterId ProductId ContactType2Id PriceModifierId (-1 with change set based tariff management active) NewPriceModifier CallModeId OperatorId RegionId TimeZoneId CurrencyId PriceTypeId ValidFrom ValidUntil MinimumQoSId NumMsBetweenPulses NameUserLastUpdate StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Logging AccountType (int) Account (string(66)) Type string int int int int complex int int int int int int dateTime dateTime int int string int Mandatory Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No No Yes Yes No Yes
int complex
Yes No
303
AddProductPrice
Price modifier You can order the method to link to the product price an existing price modifier (*), or a new price modifier.
In case of ... an existing price modifier, (*) a new price modifier, in the element ... PriceModifierId, PriceModifierId, NewPriceModifier, pass to the method ... the ID of the existing modifier. the value -1, and all data necessary to create the new modifier.
(*) With change set based tariff management active, you cannot link a product price to an already existing price modifier. In the complex NewPriceModifier element, you can pass the following price modifier record data:
Field Description CurrencyId MinimumDurationChange MinimumDurationOperatorId NormalDurationChange NormalDurationOperatorId MinimumCostChange MinimumCostOperatorId NormalCostChange NormalCostOperatorId MaxTimesMinimumCostChange MaxTimesMinimumCostOperatorId SetupTresholdChange SetupTresholdOperatorId SetupCostChange SetupCostOperatorId DeductionThresholdChange DeductionThresholdOperatorId SurchargeThresholdChange SurchargeThresholdOperatorId DeductionPercentageChange DeductionPercentageOperatorId SurchargeCostChange SurchargeCostOperatorId SurchargeTimesChange SurchargeTimesOperatorId SurchargeIntervalChange SurchargeIntervalOperatorId Type string int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int
304
AddProductPrice
Field ReductionThresholdChange ReductionThresholdOperatorId ReductionPercentageChange ReductionPercentageOperatorId ReductionTimesChange ReductionTimesOperatorId ReductionIntervalChange ReductionIntervalOperatorId NameUserLastUpdate
Type decimal int decimal int decimal int decimal int string
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the product price record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -16 -18 -19 -21 Description OK Please enter a description Enter a valid PriceMasterId Enter a valid Product Enter a valid CustomerId (ContactType2Id) Enter a valid PriceVariation Invalid CallMode Invalid Operator Invalid Region Invalid TimeZone Invalid Currency Invalid Price Invalid MinimumQoS Enter a positive NumMsBetweenPulses Duplicate key (in code) PricePlanChangeSetId must be specified (system setting) PricePlanChangeSetId does not exist PricePlanChangeSetId was specified but also a valid CustomerId, so it's customer-specific
305
AddProductPrice
Code -60 -61 -62 -63 -64 -65 -68 -69 -90 -91
Description The PricePlanChangeSetId cannot be Null or Empty because of change set based tariff management restrictions The PricePlanChangeSet with Id: {0} is not in ToBeApproved State The StatusChangeSet cannot be Value: {0}, it can be Null, 0= ToBeApproved or 2= Approved ValidFrom: {0} cannot be larger or equal to the ValidTill: {1} The PricePlanChangeSet with Id: {0} could not be found If 4-eyes is enabled, you must pass a valid new PriceModifier; the PriceModifierId must be -1. PriceModifier Description cannot be empty PriceModifier Currency does not exist Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-100
306
ChangePriceVariationSequence
ChangePriceVariationSequence
This method changes the list sequence of a price variation.
Input
Elements
Name PriceVariationId Sequence Up Down Logging AccountType (int) Account (string(66)) Type int enum Mandatory Yes Yes
complex
No
Output
-100
307
ChangeProductConditionSequence
ChangeProductConditionSequence
This method changes the list sequence of a product condition.
Input
Elements
Name ProductConditionId Sequence Up Down Logging AccountType (int) Account (string(66)) Type int enum Mandatory Yes Yes
complex
No
Output
-100
308
CheckProductCondition
CheckProductCondition
This method checks the syntax of a product condition.
Input
Elements
Name ProductId ContactType2Id Type int int Mandatory Yes No
Output
The method will return a complex type called ResultInfo, containing: a string called Info, and an integer called Result. Info If the syntax of the product condition is incorrect, then Info will contain a message explaining the syntax error. Result The integer Result will contain one of the following return codes:
-100
309
DeleteCustomerProduct
DeleteCustomerProduct
This method deletes a customer product.
Input
Elements
Name CustomerProductId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
-100
310
DeletePriceVariation
DeletePriceVariation
This method deletes a price variation.
Input
Elements
Name PriceVariationId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -4 -5 -6 -51 -52 -53 -56 Description OK lPriceExceptionId not found Unspecified error Error delete PriceVariation (modifier). There is a ProductPrice with this PriceVariation (modifier) Error delete PriceVariation (modifier). There is a PriceException (variation) with this PriceVariation (modifier) Unspecified error Linked PricePlanChangeSet status is Open and current status is Approved, cannot be deleted Cannot delete record with linked PricePlanChangeSet if ValidUntil is in the future Linked PricePlanChangeSet has status that is not Open or Approved The current record has no more linked PricePlanChangeSet, but the record is approved and the validuntil is in the future Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
31 1
DeleteProduct
DeleteProduct
This method deletes a product.
Input
Elements
Name ProductId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -3 -51 Description OK lProductId not found There are PackageDefinitions with this product There are CustomerProducts with this product Linked PricePlanChangeSet status is Open and current status is Approved with pending changes, cannot be deleted Cannot delete Approved record with linked PricePlanChangeSet if ValidUntil is in the future Linked PricePlanChangeSet has status that is not Open or Approved (can be rejected, posted, something else) Linked ProductPrice(s) has ChangeSet that is not Approved, linked to this Product Linked PriceException(s) has ChangeSet that is not Approved, linked to this Product The current record has no more linked PricePlanChangeSet, but the record is approved and the validuntil is in the future Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-52 -53 -54 -55 -56
-90 -91
-100
312
DeleteProductCondition
DeleteProductCondition
This method deletes a product condition.
Input
Elements
Name ProductConditionId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
-100
313
DeleteProductPrice
DeleteProductPrice
This method deletes a product price.
Input
Elements
Name ProductPriceId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -3 -4 -5 -6 -51 -52 -53 -56 Description OK lProductPriceId not found Unspecified error Unspecified error Error delete PriceVariation (modifier). There is a ProductPrice with this PriceVariation (modifier) Error delete PriceVariation (modifier). There is a PriceException (variation) with this PriceVariation (modifier) Error delete ProductPrice. There is a ProductPrice with this ProductPrice as master Linked PricePlanChangeSet status is Open and current status is Approved, cannot be deleted Cannot delete record with linked PricePlanChangeSet if ValidUntil is in the future Linked PricePlanChangeSet has status that is not Open or Approved (can be rejected, posted, something else) The current record has no more linked PricePlanChangeSet, but the record is approved and the validuntil is in the future Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
314
GetContacttype2ProductPrice
This method returns the price of a product based on a number of parameters (contacttype2, operator, region, pricetype, date, CLI, origin, destination, ...).
Input
Elements
Name ContactType2Id ProductId OperatorId RegionId TimeZoneId QoSId CurrencyId PriceTypeId From Quantity CLI Origin DestinationOperatorId Destination Type int int int int int int int int dateTime decimal string string int string Mandatory No Yes No No No No Yes Yes Yes Yes No No No No
315
Output
The method will return a complex type called ResultGetPrice, containing a decimal called Cost, and an integer called Result. Cost If Result contains 0, then Cost will contain the product price that was found based on the parameters passed to the method. If Result contains an integer other than 0, then Cost will contain 0. Result The integer Result will contain one of the following return codes:
-100
316
GetCustomerProduct
GetCustomerProduct
This method retrieves the details of a product linked to a contact of type 2.
Input
Elements
Name CustomerProductId Type int Mandatory Yes
Output
Name CustomerProductId ContactType2Id SN ProductId PackageId Quantity ValidFrom ValidUntil Invoice Reference Type int int string int int decimal dateTime dateTime string string
Code 0 -1 Description OK CustomerProductId not found
317
GetCustomerProduct
Code -90 -91
-100
318
GetCustomerProductInfoFromSN
This method retrieves the details of the first package in the list of packages linked to a specific CLI/PIN.
Input
Elements
Output
Name CustomerProductId ContactType2Id SN ProductId PackageId Quantity ValidFrom ValidUntil Invoice Reference Type int int string int int decimal dateTime dateTime string string
319
Code -91
-100
320
GetCustomerProductList
This method returns a (filtered) list of products linked to contacts of type 2.
Input
Elements The elements below are optional filter criteria.

Name ContactType2Id SN ProductId PackageId ValidFrom ValidUntil Type int string int int dateTime dateTime Mandatory No No No No No No
If no SN is passed to the method, then the method will return customer products that are not linked to an SN.
Output
Name CustomerProductId ContactType2Id SN ProductId PackageId Quantity ValidFrom ValidUntil Type int int string int int decimal dateTime dateTime
321
Name Invoice Reference
Type string string
-100
322
GetPriceModifier
GetPriceModifier
This method retrieves the details of a product price modifier.
Input
Elements
Name PriceModifierId Type int Mandatory Yes
Output
Name PriceModifierId CurrencyId Description MinimumDurationChange MinimumDurationOperatorId NormalDurationChange NormalDurationOperatorId MinimumCostChange MinimumCostOperatorId NormalCostChange NormalCostOperatorId MaxTimesMinimumCostChange MaxTimesMinimumCostOperatorId SetupTresholdChange SetupTresholdOperatorId SetupCostChange SetupCostOperatorId Type int int string decimal int decimal int decimal int decimal int decimal int decimal int decimal int
323
GetPriceModifier
Name DeductionThresholdChange DeductionThresholdOperatorId SurchargeThresholdChange SurchargeThresholdOperatorId DeductionPercentageChange DeductionPercentageOperatorId SurchargeCostChange SurchargeCostOperatorId SurchargeTimesChange SurchargeTimesOperatorId SurchargeIntervalChange SurchargeIntervalOperatorId ReductionThresholdChange ReductionThresholdOperatorId ReductionPercentageChange ReductionPercentageOperatorId ReductionTimesChange ReductionTimesOperatorId ReductionIntervalChange ReductionIntervalOperatorId Created NameUserLastUpdate LastUpdate
Type decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int dateTime string dateTime
Code 0 -1 -90 -91 Description OK PriceModifierId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
324
GetPriceModifierList
This method returns a (filtered) list of product price modifiers.
Input
Elements The elements below are optional filter criteria.

Name Description CurrencyId NormalCostChange NormalCostOperatorId MinimumCostChange MinimumCostOperatorId Type string int decimal int decimal int Mandatory No No No No No No
Output
Name PriceModifierId CurrencyId Description MinimumCostChange MinimumCostOperatorId NormalCostChange NormalCostOperatorId Created NameUserLastUpdate LastUpdate Type int int string decimal int decimal int dateTime string dateTime
325
-100
326
GetPriceVariation
GetPriceVariation
This method retrieves the details of a product price variation.
Input
Elements
Name PriceVariationId Type int Mandatory Yes
Output
Name PriceVariationId ProductPriceId ContactType2Id SN PriceModifierId DID ProductId CallModeId OperatorId RegionId TimeZoneId CPCId Origin ValidFrom ValidTill Destination ApplyOnChild Type int int int string int string int int int int int int string dateTime dateTime string boolean
327
GetPriceVariation
Name DestinationOperatorId Sequence StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId
Type int int int
int
Code 0 -1 -90 -91 Description OK PriceVariationId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
328
GetPriceVariationList
This method returns a (filtered) list of product price variations. Types of price variations
Type of variation Global variations Product price variations Customer-specific product price variations Product-level price variations Targeted product prices all product prices in the database. a price of a product, regardless of the customer to whom the product is linked. a price of a product that is linked to a specific customer. all prices of a product, regardless of the customer to whom the product is linked. all prices of a product that is linked to a specific customer. all prices of all products linked to a specific customer, regardless of the CLI/ PIN that customer is using. all prices of all products linked to a specific customer, but only if that customer uses a specific CLI/PIN.
Customer-specific product-level price variations Customer-level price variations
CLI/PIN-level price variations
Input
Elements The elements below are filter criteria.

Name ProductId ProductPriceId ContactType2Id SN Type int int int string Mandatory Yes Yes Yes No
How to retrieve the different types of price variations

ProductId -1 -1 -1 ProductPriceId -1 X X ContactType2Id -1 -1 X SN NULL NULL NULL Type of variation Global variations Product price variations Customer-specific product price variations Product-level price variations Customer-specific product-level price variations Customer-level price variations CLI/PIN-level price variations
X X
-1 -1
-1 X
NULL NULL
-1 -1
-1 -1
X X
NULL X
329
Output
Name PriceVariationId ProductPriceId ContactType2Id SN PriceModifierId DID ProductId CallModeId OperatorId RegionId TimeZoneId CPCId Origin ValidFrom ValidTill Destination ApplyOnChild DestinationOperatorId Sequence StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Type int int int string int string int int int int int int string dateTime dateTime string boolean int int int
int
Code 0 -1 -2 -3 Description OK ProductId not found ProductPriceId not found ContactType2Id not found
330
Code -4 -5 -90 -91
Description SN not found You cannot specify both a ProductId and a ProductPriceId Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
331
GetPriceVariationListByPricePlanChangeSet
This method returns a (filtered) list of product price variations that belong to a change set when change set based tariff management is active. Based on GetPriceVariationList. Types of price variations (Customer and CLI/PIN price variations are never linked to a change set):
Type of variation Global variations Product price variations Product-level price variations Targeted product prices all product prices in the database. a price of a product, regardless of the customer to whom the product is linked. all prices of a product, regardless of the customer to whom the product is linked.
Input

Name ProductId ProductPriceId ContactType2Id SN PricePlanChangeSetId Type int int int string int Mandatory Yes Yes Yes No Yes
How to retrieve the different types of price variations:

ProductId -1 -1 X ProductPriceId -1 X -1 ContactType2Id -1 -1 -1 SN NULL NULL NULL Type of variation Global variations Product price variations Product-level price variations
332
Output
Name PriceVariationId ProductPriceId ProductId ContactType2Id SN PriceModifierId DID CallModeId OperatorId RegionId TimeZoneId CPCId Origin ValidFrom ValidTill Destination ApplyOnChild DestinationOperatorId Sequence StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Type int int int int string int string int int int int int string dateTime dateTime string boolean int int int
int
Code 0 -1 -2 -3 Description OK ProductId not found ProductPriceId not found ContactType2Id not found
333
Code -4 -5 -64 -90 -91
Description SN not found You cannot specify both a ProductId and a ProductPriceId The PricePlanChangeSet with Id: {0} could not be found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
334
GetProduct
GetProduct
This method retrieves the details of a product.
Input
Elements
Name ProductId Type int Mandatory Yes
Output
Name ProductId ProductCode Description BaseUnitsId FrequencyId VATPct TrafficId Accountancy Analytical FreeText ValidFrom ValidUntil StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Type int string string int int decimal int string string string dateTime dateTime int
int
335
GetProduct
Code 0 -1 -90 -91 Description OK ProductId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
336
GetProductCondition
GetProductCondition
This method retrieves the details of a product condition.
Input
Elements
Name ProductConditionId Type int Mandatory Yes
Output
Name ProductConditionId ProductId ContactType2Id Sequence LogicaloperatorId BaseUnitsId RegionId OperatorId ConditionValue Type int int int int int int int int decimal
Code 0 -1 -90 Description OK ProductConditionId not found Authentication failed
337
GetProductCondition
Code -91
-100
338
GetProductConditionList
This method returns a (filtered) list of product conditions.
Input

Name ProductId ContactType2Id Type int int Mandatory Yes No
Output
Name ProductConditionId ProductId ContactType2Id Sequence LogicaloperatorId BaseUnitsId RegionId OperatorId ConditionValue Type int int int int int int int int decimal
339
Code 0 -1 -2 -90 -91 Description OK ProductId not found ContactType2Id not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
340
GetProductList
GetProductList
This method returns a (filtered) list of products.
Input
Elements In the ProductCode and FreeText elements, which can be used as filter criteria, you can use the % wildcard character.
Name ProductCode FreeText FrequencyId Type string string int Mandatory Yes No No
Output
Name ProductId ProductCode Description ValidFrom ValidUntil StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Type int string string dateTime dateTime int
int
341
GetProductList
-100
342
GetProductListByPricePlanChangeSet
This method returns a (filtered) list of products that belong to a change set when change set based tariff management is active. Based on GetProductList.
Input
Elements In the ProductCode and FreeText elements, which can be used as filter criteria, you can use the % wildcard character.
Name ProductCode FreeText FrequencyId PricePlanChangeSetId Type string string int int Mandatory Yes No Yes Yes
Output
Name ProductId ProductCode Description ValidFrom ValidUntil StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId Type int string string dateTime dateTime int
int
343
Code 0 -64 -90 -91 Description OK The PricePlanChangeSet with Id: {0} could not be found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
344
GetProductPrice
GetProductPrice
This method retrieves the details of a product price.
Input
Elements
Name ProductPriceId Type int Mandatory Yes
Output
Name ProductPriceId Description ProductPriceMasterId ProductId ContactType2Id PriceModifierId CallModeId OperatorId RegionId TimeZoneId CurrencyId PriceTypeId ValidFrom ValidUntil MinimumQoSId NumMsBetweenPulses NumMsPerUnit Type int string int int int int int int int int int int dateTime dateTime int int int
345
GetProductPrice
Name Created NameUserLastUpdate LastUpdate StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId
Type dateTime string dateTime int
int
Code 0 -1 -90 -91 Description OK ProductPriceId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
346
GetProductPriceList
GetProductPriceList
This method returns a (filtered) list of product prices.
Input

Name ProductId ValidFrom ValidUntil Type int dateTime dateTime Mandatory Yes No No
Output
Name ProductPriceId Description ProductPriceMasterId ProductId ContactType2Id PriceModifierId CallModeId OperatorId RegionId TimeZoneId CurrencyId PriceTypeId ValidFrom Type int string int int int int int int int int int int dateTime
347
GetProductPriceList
Name ValidUntil MinimumQoSId NumMsBetweenPulses NumMsPerUnit StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId
Type dateTime int int int int
int
Code 0 -1 -90 -91 Description OK ProductId null or not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
348
GetProductPriceListByPricePlanChangeSet
This method returns a (filtered) list of product prices that belong to a change set when change set based tariff management is active. Based on GetProductPriceList.
Input

Name ProductId ValidFrom ValidUntil PricePlanChangeSetId Type int dateTime dateTime int Mandatory Yes Yes Yes Yes
Output
Name ProductPriceId Description ProductPriceMasterId ProductId ContactType2Id PriceModifierId CallModeId OperatorId RegionId TimeZoneId CurrencyId PriceTypeId Type int string int int int int int int int int int int
349
Name ValidFrom ValidUntil MinimumQoSId NumMsBetweenPulses NumMsPerUnit StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId
Type dateTime dateTime int int int int
int
Code 0 -1 -64 -90 -91 Description OK ProductId null or not found The PricePlanChangeSet with Id: {0} could not be found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
350
UpdateCustomerProduct
UpdateCustomerProduct
This method updates a customer product record in the database.
Input
Elements
Name ContactType2Id ProductId PackageId Quantity ValidFrom ValidUntil Reference Logging AccountType (int) Account (string(66)) Type int int int decimal dateTime dateTime string complex Mandatory Yes Yes No No No No No No
Output
Code 0 -8 Description OK The product exists but has status ToBeApproved. It needs to be Approved before you can link it to a customer. The package exists but has status ToBeApproved. It needs to be Approved before you can link it to a CLI or customer. Dates of customer-product link must lie within date range of the product. Dates of customer-package or CLI-package link must lie within date range of the package. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-9
-12 -13 -90 -91
-100
351
UpdatePriceVariation
This method updates a price variation record in the database.
Input
Elements
Name PriceVariationId PriceModifierId NewPriceModifier DID CallModeId OperatorId RegionId TimeZoneId CPCId Origin ValidFrom ValidUntil Destination ApplyOnChild DestinationOperatorId PricePlanChangeSetId Logging AccountType (int) Account (string(66)) Type int int complex string int int int int int string dateTime dateTime string boolean int int complex Mandatory Yes Yes No No No No No No No No Yes Yes No Yes Yes Yes No
352
Output
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -40 -44 -45 Description OK Invalid PriceException (PriceVariationId) Invalid ProductPriceId Invalid SN Invalid CustomerId (ContactType2Id) Invalid PriceVariation (PriceModifierId) Invalid ProductId Invalid CallModeId Invalid OperatorId Invalid RegionId Invalid TimezoneId Invalid OperatorDestinationId Invalid PayPhone Cannot add PriceException(Variation) on this ProductPrice Invalid Destination (only DTMF allowed) Record is customer-specific and PricePlanChangeSet was not null Current PricePlanChangeSet in record has status that is not ToBeApproved Cannot update record that has a PricePlanChangeSet in the current record, with a null PricePlanChangeSet Cannot update record if current PricePlanChangeSet is not same as new PricePlanChangeSet and status current record is not Approved The PricePlanChangeSetId cannot be Null or Empty because of change set based tariff management restrictions The PricePlanChangeSet with Id: {0} is not in ToBeApproved State ValidFrom: {0} cannot be larger or equal to the ValidTill: {1} The PricePlanChangeSet with Id: {0} could not be found The current record is locked by another not approved PricePlanChangeSet Cannot update PriceModifier because of changeset-based tariff management restrictions PriceModifier Description cannot be empty PriceModifier Currency does not exist Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-60 -61 -63 -64 -66 -67 -68 -69 -90 -91
-100
353
UpdateProduct
UpdateProduct
This method updates a product record in the database.
Input
Elements
Name ProductId ProductCode Description BaseUnitsId FrequencyId VATPct TrafficId Accountancy Analytical FreeText ValidFrom ValidUntil PricePlanChangeSetId Logging AccountType (int) Account (string(66)) Type int string string int int decimal int string string string dateTime dateTime int complex Mandatory Yes No No Yes Yes Yes Yes No No No Yes Yes Yes No
354
UpdateProduct
Output
Code 0 -1 -2 -3 -4 -5 -6 -7 -40 -44 -45 Description OK ProductId not found Enter a name ProductName already exists Invalid typebase Invalid traffic Invalid frequency Invalid PctVAT (between 0 and 100) Current PricePlanChangeSet in record has status that is not ToBeApproved Cannot update record that has a PricePlanChangeSet in the current record, with a null PricePlanChangeSet Cannot update record if current PricePlanChangeSet is not same as new PricePlanChangeSet and status current record is not Approved The PricePlanChangeSetId cannot be Null or Empty because of change set based tariff management restrictions The PricePlanChangeSet with Id: {0} is not in ToBeApproved state ValidFrom: {0} cannot be larger or equal to the ValidTill: {1} The PricePlanChangeSet with Id: {0} could not be found The current record is locked by another not approved PricePlanChangeSet Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-60 -61 -63 -64 -66 -90 -91
-100
355
UpdateProductCondition
UpdateProductCondition
This method updates a product condition record in the database.
Input
Elements
Name ProducConditionId LogicaloperatorId BaseUnitsId RegionId OperatorId ConditionValue Logging AccountType (int) Account (string(66)) Type int int int int int decimal complex Mandatory Yes No No No No No No
Output
-100
356
UpdateProductModifier
This method updates a price modifier record in the database.
Input
Elements
Name PriceModifierId PriceModifier PricePlanChangeSetId Logging AccountType (int) Account (string(66)) Type int complex int complex Mandatory Yes Yes Yes No
Price modifier In the complex PriceModifier element, you can pass the following price modifier record data:
Field Description CurrencyId MinimumDurationChange MinimumDurationOperatorId NormalDurationChange NormalDurationOperatorId MinimumCostChange MinimumCostOperatorId NormalCostChange NormalCostOperatorId MaxTimesMinimumCostChange MaxTimesMinimumCostOperatorId SetupTresholdChange SetupTresholdOperatorId SetupCostChange SetupCostOperatorId DeductionThresholdChange Type string int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal
357
Field DeductionThresholdOperatorId SurchargeThresholdChange SurchargeThresholdOperatorId DeductionPercentageChange DeductionPercentageOperatorId SurchargeCostChange SurchargeCostOperatorId SurchargeTimesChange SurchargeTimesOperatorId SurchargeIntervalChange SurchargeIntervalOperatorId ReductionThresholdChange ReductionThresholdOperatorId ReductionPercentageChange ReductionPercentageOperatorId ReductionTimesChange ReductionTimesOperatorId ReductionIntervalChange ReductionIntervalOperatorId NameUserLastUpdate
Type int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int decimal int string
Output
Code 0 -21 -60 Description OK Linked ProductPrice has not the same PriceplanchangesetId The PricePlanChangeSetId cannot be Null or Empty because of changeset-based tariff management restrictions The PricePlanChangeSet with Id: {0} is not in ToBeApproved state Cannot update PriceModifier because of changeset-based tariff management restrictions Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-61 -67 -90 -91
-100
358
UpdateProductPrice
UpdateProductPrice
This method updates a product price record in the database.
Input
Elements
Name ProductPriceId Description ProductPriceMasterId PriceModifierId NewPriceModifier CallModeId OperatorId RegionId TimeZoneId CurrencyId PriceTypeId ValidFrom ValidUntil MinimumQoSId NumMsBetweenPulses NameUserLastUpdate PricePlanChangeSetId Logging AccountType (int) Account (string(66)) Type int string int int complex int int int int int int dateTime dateTime int int string int complex Mandatory Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No Yes No
359
UpdateProductPrice
Output
Code 0 -2 -3 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -16 -17 -43 -44 -45 Description OK Enter a description Enter a valid price master id Enter a valid PriceVariation Invalid CallModeId Invalid OperatorId Invalid RegionId Invalid TimezoneId Invalid CurrencyId Invalid Price Invalid MinimumQoS Enter a positive NumMsBetweenPulses Duplicate key Record is customer-specific and PricePlanChangeSet was not null The new PricePlanChangeSet has an invalid status, must be ToBeApproved Cannot update record that has a PricePlanChangeSet in the current record, with a null PricePlanChangeSet Cannot update record if current PricePlanChangeSet is not same as new PricePlanChangeSet and status current record is not Approved The PricePlanChangeSetId cannot be Null or Empty because of change set based tariff management restrictions The PricePlanChangeSet with Id: {0} is not in ToBeApproved State ValidFrom: {0} cannot be larger or equal to the ValidTill: {1} The PricePlanChangeSet with Id: {0} could not be found The current record is locked by another not approved PricePlanChangeSet Cannot update PriceModifier because of changeset-based tariff management restrictions PriceModifier Description cannot be empty PriceModifier Currency does not exist Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-60 -61 -63 -64 -66 -67 -68 -69 -90 -91
-100
360
PricePlanChangeSet
Chapter 17:
PricePlanChangeSet
In this chapter, you will find a detailed description of all methods contained in the PricePlanChangeSet web service.
Web method AddPricePlanChangeSet DeletePricePlanChangeSet GetPricePlanChangeSet GetPricePlanChangeSetList GetPricePlanChangeSetDetailList UpdatePricePlanChangeSet Page 361 363 364 366 368 370
Change set based tariff management Change set based tariff management can be enabled for resellers with system setting 412. When it is enabled, a PricePlanChangeSet must be set in the method call when changing products, prices, region and time zone definitions or packages. When the record is custom-specified, a PricePlanChangeSet is not allowed. Custom-specified means when for example a PriceException is inserted, and parameter SN or CustomerId is specified. Validation of PricePlanChangeSets The ServiceChangeSetValidator is a plug-in validator in the ArtiliumWebInterface. It validates the PricePlanChangeSet that is passed in related functions: the availability, the status, the date range. See SoapExtensions in the web.Config file to activate this plug-in: <soapExtensionTypes>  <add type="Arta7.Core.Reseller.ArtiliumInterface.SoapNHibernateTransactionExtension, Arta7.Core.Reseller.ArtiliumInterface" priority="2" group="0"/> </soapExtensionTypes>
361
AddPricePlanChangeSet
This method inserts a price plan change set in the database.
Input
Elements
Name PricePlanChangeSetName AccountIdCreator (-> lAccountID from Account) AccountIdApprover (-> lAccountID from Account) EmailCreator EmailApprover Type string int int string string Mandatory Yes Yes No No No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the change set record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -3 -4 -5 -13 -90 Description OK PricePlanChangeSet name cannot be Null or empty CreatorId is required for this state in PricePlanChangeSet Given CreatorId or ApproverId does not exist On Insert the PricePlanChangeSet Status has to be ToBeApproved Duplicate PricePlanChangeSetName Authentication failed / Invalid Login
362
Code -91
-100
363
DeletePricePlanChangeSet
DeletePricePlanChangeSet
This method deletes a price plan change set.
Input
Elements
Name PricePlanChangeSetId AccountIdCreator (-> lAccountID from Account) Type int int Mandatory Yes Yes
Output
Code 0 -3 -4 -6 -12 -18 -90 -91 Description OK CreatorId is required for this state in PricePlanChangeSet Given CreatorId or ApproverId does not exist PricePlanChangeSet with Id {0} could not be found You cannot delete a PricePlanChangeSet if status is Posted for approvel You can only delete a PricePlanChangeSet of which you are the owner Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-100
364
GetPricePlanChangeSet
This method retrieves the details of a price plan change set.
Input
Elements
Name PricePlanChangeSetId Type int Mandatory Yes
Output
Name AccountIdApprover AccountIdCreator CreationDate CreatorName EmailApprover EmailCreator PricePlanChangeSetId PricePlanChangeSetName Status 0 = ToBeApproved 1 = Posted 2 = Approved 3 = Rejected StatusDate Type int int dateTime string string string int string int
dateTime
365
Code 0 -6 -14 Description OK PricePlanChangeSet with Id {0} could not be found The PricePlanChangeSet status can only be: 0= ToBeApproved, 1= Posted, 2= Approved, 3= Rejected, not: {0} Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-90 -91
-100
366
GetPricePlanChangeSetList
This method retrieves a (filtered) list of price plan change sets.
Input
Elements
Name PricePlanChangeSetName AccountIdCreator AccountIdApprover CreatorName Status 0 = ToBeApproved 1 = Posted 2 = Approved 3 = Rejected Type string int int string int Mandatory No No No No No
Output
The method will return a complex type called ResultGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ItemInfo will contain a table with the following columns:
Name AccountIdApprover AccountIdCreator CreationDate CreatorName EmailApprover EmailCreator PricePlanChangeSetId PricePlanChangeSetName Type int int dateTime string string string int string
367
Name Status 0 = ToBeApproved 1 = Posted 2 = Approved 3 = Rejected StatusDate
Type int
dateTime
-100
368
GetPricePlanChangeSetDetailList
This method retrieves the items contained by a price plan change set.
Input
Elements
Name PricePlanChangeSetId Type int Mandatory Yes
Output
The method will return a complex type called ResultGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ItemInfo will contain a table with the following columns:
Name PricePlanChangeSetDetailId PricePlanChangeSetId StatusChangeSet 0 = ToBeApproved 2 = Approved TypeChange (i.e. kind of change that was made to TypeRecordId, e.g. Add, Delete, Update) TypeDetail (i.e. Name of table where TypeRecordId resides) TypeRecordId ValidFrom ValidUntil Type int int int
int string int dateTime dateTime
Code 0 -6 Description OK PricePlanChangeSet with Id {0} could not be found
369
Code -90 -91
-100
370
UpdatePricePlanChangeSet
This method updates an existing price plan change set in the database.
Input
Elements
Name PricePlanChangeSetId PricePlanChangeSetName Status 0 = ToBeApproved 1 = Posted 2 = Approved 3 = Rejected AccountIdCreator AccountIdApprover EmailCreator EmailApprover Type int string int Mandatory Yes Yes Yes
int int string string
No No No No
Output
Code 0 -3 -4 -6 -7 -8 -10 -13 -14 Description OK CreatorId and ApproverId are required for this state in PricePlanChangeSet Given CreatorId or ApproverId does not exist PricePlanChangeSet with Id {0} could not be found You can only reject PricePlanChangeSet with status 'Posted for Approval' when you are assigned as approver You can only approve PricePlanChangeSet with status 'Posted for Approval' when you are assigned as approver You cannot update a PricePlanChangeSet with Status 'Approved' PricePlanChangeSet with Id: {0} and Name: {1} is not unique The PricePlanChangeSet status can only be: 0= ToBeApproved, 1= Posted, 2= Approved, 3= Rejected, not: {0} You can only post PricePlanChangeSets with status 'Open' of which you are the owner
-15
371
Code -16 -17 -19 -90 -91
Description You can only recall PricePlanChangeSets with status 'Posted for Approval' of which you are the owner You can only unlock PricePlanChangeSets with status 'Rejected' of which you are the owner You can only update PricePlanChangeSets with status 'Open' of which you are the owner Authentication failed / Invalid Login Field overflow Too many characters, Date out of range, ... Unspecified error
-100
372
Packages
Chapter 18:
Packages
In this chapter, you will find a detailed description of all methods contained in the Packages web service.
Web method ChangePackageForContactType ChangePackageForSN GetListAvailablePackagesForContactType GetListAvailablePackagesForSN GetListPackageOptionsForContactType GetListPackageOptionsForSN GetPackageInfoContactType GetPackageInfoFromSN GetPackageList UpdatePackageOptionsForSN Page 373 374 375 377 379 381 383 385 387 391
373
ChangePackageForContactType
ChangePackageForContactType
This method links a specified package to a contact.
Input
Elements
Name ContactType CheckSelfCare CheckSalesRep PackageId Logging AccountType (int) Account (string(66)) Type int boolean boolean int complex Mandatory Yes Yes Yes Yes No
Output
Code 0 -1 -2 -3 -4 -5 -90 -91 Description OK ContactTypeId not found PackageId not found Number of days/month of current package not exceeded Cannot change to this package Linked package has invalid status. Package must have status Approved. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
374
ChangePackageForSN
ChangePackageForSN
This method links a specified package to a CLI/PIN.
Input
Elements
Name SN CheckSelfCare CheckSalesRep PackageId Logging AccountType (int) Account (string(66)) Type string boolean boolean int complex Mandatory Yes Yes Yes Yes No
Output
The method will returns an integer called Result. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 -5 -90 -91 Description OK SN not found PackageId not found Number of days/month of current package not exceeded Cannot change to this package Linked package has invalid status. Package must have status Approved. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
375
GetListAvailablePackagesForContactType
This method lists all packages to which can be migrated.
Input
Elements
Name ContactType CheckSelfCare CheckSalesRep CheckForPostpaid CheckForPrepaid Type int boolean boolean boolean boolean Mandatory No No No No No
Output
Name PackageId PackageCode PackageDescription Months Days Type int string string int int
Code 0 -1 -2 Description OK SN not found ContactTypeId not found
376
Code -90 -91
-100
377
GetListAvailablePackagesForSN
This method lists all packages to which can be migrated.
Input
Elements
Name SN CheckSelfCare CheckSalesRep CheckForPostpaid CheckForPrepaid Type string boolean boolean boolean boolean Mandatory No No No No No
Output
Name PackageId PackageCode PackageDescription Months Days Type int string string int int
Code 0 -1 -2 Description OK SN not found ContactTypeId not found
378
Code -90 -91
-100
379
GetListPackageOptionsForContactType
This method lists all services in a specific package (linked to a contact or not), or in all packages (linked to a contact or not).
Input
Elements
Name ContactType ActiveAndNonActive PackageId LanguageId Type int boolean int int Mandatory No Yes No No
Output
Name PackageDefinitionId PackageId Available Customizable TrafficDescription CallModeDescription CallModeId ProductId TrafficId ValidFrom ValidUntil Type int int int int string string int int int date/time date/time
380
Code 0 -1 -2 -90 -91 Description OK SN not found ContactTypeId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
381
GetListPackageOptionsForSN
This method lists all services in a specific package (linked to a CLI/PIN or not), or in all packages (linked to a CLI/PIN or not).
Input
Elements
Name SN ActiveAndNonActive PackageId LanguageId Type string boolean int int Mandatory No Yes No No
Output
Name PackageDefinitionId PackageId Available Customizable TrafficDescription CallModeDescription CallModeId ProductId TrafficId ValidFrom ValidUntil Type int int int int string string int int int date/time date/time
382
Code 0 -1 -2 -90 -91 Description OK SN not found ContactTypeId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
383
GetPackageInfoContactType
This method lists all packages linked to a specific contact.
Input
Elements
Name ContactType Type int Mandatory Yes
Output
Name PackageId PackageCode PackageDescription MinAmount MaxAmount ListAmounts ValidityDays RemoveDays UseForSelfCare UseForSalesRep UseForSWA UseForPrepaid UseForPostpaid UseForGrace ValidFrom Type int string string decimal(20,6) decimal(20,6) string int int boolean boolean boolean boolean boolean boolean datetime
384
Name ValidTill SeqNr
Type datetime int
Code 0 -1 -2 -3 -90 -91 Description OK SN not found No package found ContactTypeId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
385
GetPackageInfoFromSN
This method lists all packages linked to a specific CLI/PIN.
Input
Elements
Output
Name PackageId PackageCode PackageDescription MinAmount MaxAmount ListAmounts ValidityDays RemoveDays UseForSelfCare UseForSalesRep UseForSWA UseForPrepaid UseForPostpaid UseForGrace ValidFrom Type int string string decimal(20,6) decimal(20,6) string int int boolean boolean boolean boolean boolean boolean datetime
386
Name ValidTill SeqNr
Type datetime int
Code 0 -1 -2 -3 -90 -91 Description OK SN not found No package found ContactTypeId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
387
GetPackageList
GetPackageList
This method returns a list of packages.
Input
Elements
Name PackageCode ValidFrom ValidUntil UseForSelfCare UseForSalesRep UseForSWA UseForPrepaid UseForPostpaid UseForGrace Type string datetime datetime boolean boolean boolean boolean boolean boolean Mandatory No No No No No No No No No
Output
Name PackageId PackageCode PackageDescription MinAmount MaxAmount ListAmounts ValidityDays RemoveDays Type int string string decimal(20,6) decimal(20,6) string int int
388
GetPackageList
Name UseForSelfCare UseForSalesRep UseForSWA UseForPrepaid UseForPostpaid UseForGrace ValidFrom ValidTill SeqNr
Type boolean boolean boolean boolean boolean boolean datetime datetime int
-100
389
GetPackageListByPricePlanChangeSet
This method returns a list of packages included in a price plan change set.
Input
Elements
Name PackageCode ValidFrom ValidUntil UseForSelfCare UseForSalesRep UseForSWA UseForPrepaid UseForPostpaid UseForGrace PricePlanChangeSetId Type string datetime datetime boolean boolean boolean boolean boolean boolean int Mandatory Yes No No No No No No No No Yes
Output
Name PackageId PackageCode PackageDescription MinAmount MaxAmount ListAmounts ValidityDays Type int string string decimal(20,6) decimal(20,6) string int
390
Name RemoveDays UseForSelfCare UseForSalesRep UseForSWA UseForPrepaid UseForPostpaid UseForGrace ValidFrom ValidTill SeqNr
Type int boolean boolean boolean boolean boolean boolean datetime datetime int
-100
391
UpdatePackageOptionsForSN
This method updates services within a package linked to a specific CLI/PIN.
Input
Elements
Name SN PackageOptions PackageDefinitionId (int) Available (boolean) Logging AccountType (int) Account (string(66)) Type string complex Mandatory Yes Yes
complex
No
Output
The method will return a complex type called UpdatePackageOptionsForSNResult, containing a complex type called Unsuccessful, and an integer called Result. Unsuccessful If Result contains 0, then Unsuccessful will contain a table with the following columns:
Name PackageDefinitionId ErrorCode Type int int
If Result contains an integer other than 0, then Unsuccessful will contain NULL. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -90 Description OK SN not found No options to update Errors Authentication failed
392
Code -91
-100
393
RegionDefinition
Chapter 19:
RegionDefinition
In this chapter, you will find a detailed description of all methods contained in the RegionDefinition web service.
Web method GetRegionDefinitionList GetRegionDefinitionListByPricePlanChangeSet Page 394 396
394
GetRegionDefinitionList
This method returns a (filtered) list of region definitions.
Input
Elements
Name TrafficId CallModeId OriginatingOperatorId DestinationOperatorId Origin RegionId DestinationPrefix CountryId RatingUnitId Type int int int int string int string int int Mandatory No No No No No No No No No
Output
Name RegionDefinitionId TrafficId OriginatingOperatorId Origin DestinationOperatorId DestinationPrefix RegionId CallModeId Type int int int string int string int int
395
Name CountryId RatingUnitId ValidFrom ValidUntil StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId
Type int int dateTime dateTime int
int
-100
396
GetRegionDefinitionListByPricePlanChangeSet
This method returns a (filtered) list of region definitions that belong to a change set when change set based tariff management is active. Based on GetRegionDefinitionList.
Input
Elements
Name TrafficId CallModeId OriginatingOperatorId DestinationOperatorId Origin RegionId DestinationPrefix CountryId RatingUnitId PricePlanChangeSetId Type int int int int string int string int int int Mandatory No No No No No No No No No No
Output
Name RegionDefinitionId TrafficId OriginatingOperatorId Origin DestinationOperatorId DestinationPrefix RegionId Type int int int string int string int
397
Name CallModeId CountryId RatingUnitId ValidFrom ValidUntil StatusChangeSet 0 = ToBeApproved 2 = Approved PricePlanChangeSetId
Type int int int dateTime dateTime int
int
-100
398
Bundle
Chapter 20:
Bundle
In this chapter, you will find a detailed description of all methods contained in the Bundle web service. This web service allows you to manage all bundle data.
Web method AddBundle GetBundle GetBundleList IsBundleReadonly UpdateBundle UpdateBundleAvailability ChangeBundlePriority DeleteBundle Page 400 430 452 466 468 474 420 422
Bundle definitions AddBundleDefinition GetBundleDefinition GetBundleDefinitionList UpdateBundleDefinition DeleteBundleDefinition Rules of bundle definitions AddBundleCall GetBundleCall GetBundleCallList UpdateBundleCall DeleteBundleCall Destinations of bundle definitions AddBundleCustDestination GetBundleCustDestination GetBundleCustDestinationList UpdateBundleCustDestination DeleteBundleCustDestination 408 444 446 477 426 406 440 442 475 425 410 448 450 479 427
399
Bundle
Web method Bundle assignments and conditions AddBundleAssign GetBundleAssign GetBundleAssignList UpdateBundleAssign DeleteBundleAssign AddBundleAssignCondition CheckBundleAssignCondition GetBundleAssignCondition GetBundleAssignConditionList UpdateBundleAssignCondition ChangeBundleAssignConditionSequence DeleteBundleAssignCondition Bundle usages GetBundleUsage GetBundleUsageList Notifications for bundle thresholds AddBundleThresholdEventDefinitionToBundleDefinition AddBundleThresholdEventDefinitionToOverallBundle AddEmailNotificationForBundleThresholdEventDefinition AddSmsNotificationForBundleThresholdEventDefinition GetBundleThresholdEventDefinition GetBundleThresholdMessageNotificationList GetBundleThresholdEventDefinitionListOfBundleDefinition GetBundleThresholdEventDefinitionListOfBundle UpdateBundleThresholdEventDefinition DeleteBundleThresholdEventDefinition Notifications for bundle usage sets SetBundleUsageSetEventDefinitions AddEmailNotificationForBundleUsageSetEventDefinition AddSmsNotificationForBundleUsageSetEventDefinition GetBundleUsageSetEventDefinitions GetBundleUsageSetMessageNotificationList UpdateEmailNotification UpdateSmsNotification DeleteMessageNotification
Page
402 432 438 470 423 404 421 434 436 472 419 424
459 461
412 414 415 417 454 457 456 455 481 428
467 416 418 463 464 482 483 429
400
AddBundle
AddBundle
This method creates a bundle in the database (Type = 1, normal bundle).
Input
Elements
Name BundleCode Description ValidFrom ValidUntil StartingPoint Periodicity PeriodicityValue ValidPeriodType ValidPeriodNumber NumRecurrences MaxRollOverPeriods PackageId ProductId CurrencyId AvailableSelfCare AvailableSalesRep AvailableSMS AvailableIVR AvailablePrepaid AvailablePostpaid DisconnectNoBundleCreditLeft TotalAmount NameUserLastUpdate Logging AccountType (int) Account (string(66)) Type string string dateTime dateTime int int int int int int int int int int boolean boolean boolean boolean boolean boolean boolean decimal string complex Mandatory Yes Yes No No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No No
401
AddBundle
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the bundle record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -15 -90 -91 Description OK PackageId not found (-1 allowed) ProductId not found (-1 allowed) Currency not found MaxRollOverPeriod: Only positive values allowed. StartingPoint: StartDay not found Periodicity: StartPeriod not found ValidPeriodType: ValidType not found PeriodicityValue: Only positive StartRepeat allowed ValidPeriodNumber: Only positive values allowed Invalid BundleCode Invalid BundleDescription BundleName already exists Invalid TotalAmount. TotalAmount has to be a positive decimal number. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
402
AddBundleAssign
AddBundleAssign
This method adds a bundle assignment record in the database.
Input
Elements
Name BundleId ContactTypeId AvailableSubcustomer ContactLevelAssignment SN OperatorId PackageId ProductId CallModeId TrafficId ValidFrom ValidUntil NameUserLastUpdate Logging AccountType (int) Account (string(66)) Type int int boolean boolean string int int int int int dateTime dateTime string complex Mandatory Yes Yes Yes Yes No Yes Yes Yes Yes Yes Yes Yes No No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the bundle assignment record that was added. If Result contains an integer other than 0, then NewItemId will be empty.
403
AddBundleAssign
Code 0 -2 -3 Description OK BundleId not found ContactType2Id not found (For all contacts of type 2, enter -1) SN not valid (null or empty = no SN) SN does not belong to selected contact Invalid OperatorId (For all operators, enter -1) Invalid PackageId (For all packages, enter -1) Invalid ProductId (For all products, enter -1) Invalid CallModeId (For all call modes, enter -1) Invalid TrafficId (For all traffic types, enter -1) The PackageId in the bundle is not the same as the package Id supplied to create the bundle assignment The active package of the subscription (pin, contact) differs from the package ID supplied to create the bundle assignment The active package of the CLI/PIN differs from the package in the bundle The CLI/PIN has no active package, but the bundle has a package The active package of the contact differs from the package in the bundle Bundle with Id: {0} is not available for subscription with Id: {1}. Check Prepaid/Postpaid availability settings of Bundle. The buy limitations of this bundle have been exceeded The assignment conditions of this bundle are not valid The assignment parameters are not valid for the subscription The time of the assignment is not valid for this bundle The bundle package is not valid for the subscription The subscription with id {0} is invalid The subscriber has not enough credits left to buy bundle with Id: {0}. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-4 -5 -6
-7
-8
-9
-10
-1 1 -12
-13 -14 -15 -16
-17 -18 -19 -20 -21 -22 -23 -90 -91
-100
404
AddBundleAssignCondition
This method adds a bundle assignment condition element in the database.
Input
Elements
Name BundleAssignId LogicaloperatorId TableToCheckId FieldToCheckId OperatorId DestinationTable DestinationField Value Logging AccountType (int) Account (string(66)) Type int int int int int int int string complex Mandatory Yes Yes Yes Yes Yes Yes Yes No No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the condition element that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 Description OK BundleAssignId not found Invalid LogicalOperatorId Invalid TableToCheck Invalid FieldToCheck (TableToCheck -1 >>> FieldToCheck -1)
405
Code -6 -7 -8 -9 -90 -91
Description Invalid Comparison (TableToCheck <> -1 >>> Comparison <> -1) Invalid DestinationTable Invalid DestinationField DestinationTable, DestinationField, and Value are all NULL. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
406
AddBundleCall
AddBundleCall
This method adds a rule to a bundle definition.
Input
Elements
Name BundleDefinitionId CallModeId SystemOperatorId OriginatingOperatorId DestinationOperatorId RegionId TimeZoneId MinimumQoSId ValidFrom ValidUntil Logging AccountType (int) Account (string(66)) Type int int int int int int int int dateTime dateTime complex Mandatory Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the bundle rule that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 Description OK BundleDefinitionId not found Invalid CallModeId (-1 = All call modes)
407
AddBundleCall
Code -4 -5 -6 -7 -8 -9 -10 -90 -91
Description Invalid OperatorId (-1 = All operators) Invalid OperOrigId (-1 =All originating operators) Invalid OperDestId (-1 = All destination operators) Invalid RegionId (-1 = All regions) Invalid TimeZoneID (-1 = All time zones) Invalid MinimumQoS (-1 = All minimum QoS levels) Bundle is read-only Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
408
AddBundleCustDestination
This method adds a destination to a bundle definition.
Input
Elements
Name BundleDefinitionId ValidityContactTypeId ValiditySN ValidFrom ValidUntil DestinationContactTypeId DestinationSN DestinationPrefix Logging AccountType (int) Account (string(66)) Type int int string dateTime dateTime int string string complex Mandatory Yes Yes No Yes Yes Yes No No No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the destination record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 Description OK BundleDefinitionId not found Invalid ValidityContactTypeId (-1 allowed) Invalid ValiditySN (NULL, , and valid SNs allowed) Invalid DestinationContactTypeId (-1 allowed)
409
Code -6 -7
Description Invalid DestinationSN (NULL allowed) ValidityContactTypeId is NULL, DestinationSN is NULL, or DestinationPrefix is empty. ContactId, SN, or Prefix have to be specified. There is already a destination record with these specifications (in code). Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-8 -9 -90 -91
-100
410
AddBundleDefinition
AddBundleDefinition
This method adds a definition entry to a bundle.
Input
Elements
Name Description BundleId ProductId CallModeId TrafficId ValidFrom ValidUntil BenefitType BenefitValue RatingType 0 = Free 1 = Charged SpecialPrice Type string int int Int Int datetime datetime enum decimal int Mandatory No Yes No No Yes No No Yes No No
pricemodifier
No
Rating of used benefits depends on BenefitType and the combination of RatingType and SpecialPrice:
Bundle Definition Bundle BenefitType Normal Sessions Units (Seconds, Events, Bytes) Unlimited RatingType 0 1 1 Credits 0 0 1 1 Overall 0 0 SpecialPrice None None Specified None Specified None Specified None Specified Free Charged (standard price) Charged (special price) Free (standard price) Free (special price) Charged (standard price) Charged (special price) Free (standard price) Free (special price) Rating of used benefits
41 1
AddBundleDefinition
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the bundle definition record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -7 -8 -9 -10 -12 -13 -14 Description OK BundleId not found Invalid ProductId Invalid CallModeId Invalid TrafficType Invalid RatingType Invalid RatingUnit (entered via the BenefitType) Invalid BenefitType The bundle is read-only The ValidFrom should precede the ValidUntil Bundle Definitions with BenefitType Sessions are not supported for this traffic type This BenefitType is not supported for this traffic type When used benefits are free (subtracted from benefit balance in bundle usage only), SpecialPrice is not needed. If BenefitType = Credits, or bundle is overall bundle, a SpecialPrice can be specified to subtract usage from the benefit balance at a special price. Bundle Definitions with BenefitType Unlimited cannot have BenefitValue Bundle Definitions in overall bundles should have BenefitType Unlimited For overall bundles, RatingType cannot be 1 (= Charged) Negative values are not allowed Decimals are only allowed for Benefit Type Credits Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-15 -16 -17 -18 -20 -90 -91
-100
412
AddBundleThresholdEventDefinitionToBundleDefinition
This method adds a threshold event definition to a bundle definition.
Input
Elements
Name BundleDefinitionId Level Description Type int int string Mandatory Yes Yes Yes
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the bundle threshold event definition record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -7 -90 -91 Description OK BundleDefinitionId or bundle of this definition not found A bundle threshold event definition cannot be added at bundle definition level for overall bundles The level should range from 1 to 100 The bundle already has a bundle threshold event definition for this level The bundle cannot contain more than two bundle threshold event definitions A bundle threshold event definition cannot be added to a bundle definition with BenefitType Unlimited Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
413
414
AddBundleThresholdEventDefinitionToOverallBundle
AddBundleThresholdEventDefinitionToOverallBundle
This method adds a bundle threshold event definition to an overall bundle.
Input
Elements
Name BundleId Level Description Type int int string Mandatory Yes Yes Yes
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the bundle threshold event definition record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -90 -100 Description OK BundleId not found A bundle threshold event definition cannot be added on bundle level for a normal bundle The bundle threshold event definition must have a level between 1 and 100 The bundle already has a bundle threshold event definition for this level The bundle cannot contain more than two bundle threshold event definitions Authentication failed Unspecified error
415
AddEmailNotificationForBundleThresholdEventDefinition
AddEmailNotificationForBundleThresholdEventDefinition
This method adds an email notification to a bundle threshold event definition.
Input
Elements
Name BundleThresholdEventDefinitionId OriginAddress Subject Body Type int string string string Mandatory Yes No Yes Yes
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the email notification record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -90 -100 Description OK BundleThresholdEventDefinitionId is not found The bundle threshold event definition already has an email notification message No document text is configured for the email subject No document text is configured for the email body The document text of the subject or body is not valid Authentication failed Unspecified error
416
AddEmailNotificationForBundleUsageSetEventDefinition
AddEmailNotificationForBundleUsageSetEventDefinition
This method adds an email notification to a bundle usage set event definition.
Input
Elements
Name BundleUsageSetEventDefinitionId OriginAddress Subject Body Type int string string string Mandatory Yes No Yes Yes
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the email notification record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -90 -100 Description OK BundleUsageSetEventDefinitionId is not found The bundle usage set event definition already has an email notification message No document text is configured for the email subject No document text is configured for the email body The document text of the subject or body is not valid Authentication failed Unspecified error
417
AddSmsNotificationForBundleThresholdEventDefinition
AddSmsNotificationForBundleThresholdEventDefinition
This method adds an SMS notification to a bundle threshold event definition.
Input
Elements
Name BundleThresholdEventDefinitionId Message Type int string Mandatory Yes Yes
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the SMS notification record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -90 -100 Description OK BundleThresholdEventDefinitionId is not found The bundle threshold event definition already has an SMS notification message No document text is configured for the SMS message The document text of the message is not valid The maximum length of an SMS is 160 characters. Please modify the SMS text. Authentication failed Unspecified error
418
AddSmsNotificationForBundleUsageSetEventDefinition
AddSmsNotificationForBundleUsageSetEventDefinition
This method adds an SMS notification to a bundle usage set event definition.
Input
Elements
Name BundleUsageSetEventDefinitionId Message Type int string Mandatory Yes Yes
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the SMS notification record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -5 -6 -90 -100 Description OK BundleUsageSetEventDefinitionId is not found The bundle usage set event definition already has an SMS notification message No document text is configured for the SMS message The document text of the message is not valid The maximum length of an SMS is 160 characters. Please modify the SMS text. Authentication failed Unspecified error
419
ChangeBundleAssignConditionSequence
ChangeBundleAssignConditionSequence
This method changes the order sequence of a bundle assignment condition element.
Input
Elements
Name BundleAssignConditionId Sequence Logging AccountType (int) Account (string(66)) Type int enum complex Mandatory Yes Yes No
Sequence has two possible values: Down Up
Output
Code 0 -1 -2 -90 -91 Description OK BundleAssignConditionId not found No condition element found with lower/higher sequence. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
420
ChangeBundlePriority
ChangeBundlePriority
This method changes the priority of a bundle in the general bundle list.
Input
Elements
Name BundleId Change Logging AccountType (int) Account (string(66)) Type int enum complex Mandatory Yes Yes No
Change has two possible values: Down Up
Output
Code 0 -1 -2 -3 -90 -91 Description OK BundleId not found No bundle found with lower/higher sequence. Bundle is read-only Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
421
CheckBundleAssignCondition
CheckBundleAssignCondition
This method checks the syntax of a bundle assignment condition.
Input
Elements
Name BundleAssignId Type int Mandatory Yes
Output
The method will return a complex type called ResultInfo, containing: a string called Info, and an integer called Result. Info If the syntax of the condition is not correct, then Info will contain a text explaining the syntax error. Result The integer Result will contain one of the following return codes:
Code 0 -1 -5 -90 -91 Description OK BundleAssignId not found Error in BundleAssignConditions. See Info for more information. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
422
DeleteBundle
DeleteBundle
This method deletes a bundle.
Input
Elements
Name BundleId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -3 -4 -90 -91 Description OK BundleId not found Unable to delete Bundle: Marketing Unable to delete Bundle: BundleAssign with BundleUsage Bundle is read-only Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
423
DeleteBundleAssign
DeleteBundleAssign
This method deletes a bundle assignment.
Input
Elements
Name BundleAssignId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -90 -91 Description OK BundleAssignId not found Bundle assignment has bundle usages. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
424
DeleteBundleAssignCondition
DeleteBundleAssignCondition
This method deletes an element of a bundle assignment condition.
Input
Elements
Name BundleAssignConditionId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -90 -91 Description OK BundleAssignConditionId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
425
DeleteBundleCall
DeleteBundleCall
This method deletes a bundle definition rule.
Input
Elements
Name BundleCallId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -90 -91 Description OK BundleCallId not found Bundle is read-only Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
426
DeleteBundleCustDestination
DeleteBundleCustDestination
This method deletes a destination record linked to a bundle definition entry.
Input
Elements
Name BundleCustDestinationId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -90 -91 Description OK BundleCustDestinationId not found Bundle is read-only Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
427
DeleteBundleDefinition
DeleteBundleDefinition
This method deletes a bundle definition from a bundle.
Input
Elements
Name BundleDefinitionId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -2 -3 -4 -90 -100 Description OK BundleDefinitionId not found The bundle has a bundle assignment The bundle has a special price with external links to other entities Bundle is read-only Authentication failed Unspecified error
428
DeleteBundleThresholdEventDefinition
DeleteBundleThresholdEventDefinition
This method deletes a bundle threshold event definition.
Input
Elements
Name BundleThresholdEventDefinitionId Type int Mandatory Yes
Output
Code 0 -2 -90 -91 Description OK BundleThresholdEventDefinitionId is not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
429
DeleteMessageNotification
DeleteMessageNotification
This method deletes a message notification.
Input
Elements
Name MessageNotificationId Type int Mandatory Yes
Output
Code 0 -2 -90 -91 Description OK MessageNotificationId is not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
430
GetBundle
GetBundle
This method retrieves the details of a bundle.
Input
Elements
Name BundleId Type int Mandatory Yes
Output
Name BundleId BundleCode Description Priority ValidFrom ValidUntil StartingPoint Periodicity PeriodicityValue ValidPeriodType ValidPeriodNumber NumRecurrences MaxRollOverPeriods PackageId ProductId CurrencyId AvailableSelfCare Type int string string int dateTime dateTime int int int int int int int int int int boolean
431
GetBundle
Name AvailableSalesRep AvailableSMS AvailableIVR AvailablePrepaid AvailablePostpaid DisconnectNoBundleCreditLeft TotalAmount NameUserLastUpdate LastUpdate Read-only
Type boolean boolean boolean boolean boolean boolean decimal string dateTime boolean
Code 0 -1 -90 -91 Description OK BundleId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
432
GetBundleAssign
GetBundleAssign
This method retrieves a bundle assignment record.
Input
Elements
Output
Name BundleAssignId BundleId ContactTypeId AvailableSubcustomer ContactLevelAssignment SN OperatorId PackageId ProductId CallModeId TrafficId ValidFrom ValidUntil Condition NameUserLastUpdate LastUpdate Type int int int boolean boolean string int int int int int dateTime dateTime string string dateTime
433
GetBundleAssign
Code 0 -1 -90 -91 Description OK BundleAssignId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
434
GetBundleAssignCondition
This method retrieves the details of a bundle assignment condition element.
Input
Elements
Name BundleAssignConditionId Type int Mandatory Yes
Output
Name BundleAssignConditionId BundleAssignId Sequence LogicaloperatorId TableToCheckId FieldToCheckId OperatorId DestinationTable DestinationField Value LastUpdate Type int int int int int int int int int string dateTime
435
Code 0 -1 -90 -91 Description OK BundleAssignConditionId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
436
GetBundleAssignConditionList
This method retrieves all elements of the condition linked to a specific bundle assignment.
Input
Elements
Output
Name BundleAssignConditionId BundleAssignId Sequence LogicaloperatorId TableToCheckId FieldToCheckId OperatorId DestinationTable DestinationField Value Type int int int int int int int int int string
Code 0 -1 Description OK BundleAssignId not found
437
Code -90 -91
-100
438
GetBundleAssignList
GetBundleAssignList
This method returns a (filtered) list of bundle assignments.
If you pass to the method ... a BundleId an SN then the method returns ... all bundle assignments linked to the specified bundle. all bundle assignments linked to the specified SN all bundle assignments of which the SN is NULL, but of which the contact ID refers to the contact to whom the specified SN is linked all bundle assignments of which both the SN and the contact ID are NULL (i.e. bundles assigned to All Contacts) all bundle assignments linked to the specified contact all bundle assignments of which both the SN and the contact ID are NULL (i.e. bundles assigned to All Contacts) Important: The method will NOT return the bundles assigned to sub-contacts or to CLIs/PINs linked to the contact. It will ONLY return the bundles directly assigned to the specified contact. The method will NOT return the bundles assigned to the master contacts of the specified contact.
a ContactType2Id
If you pass a combination of input parameters to the method, the results as specified above will be filtered depending on the parameters that were passed.
Input
Elements
Name BundleId ValidFrom ValidUntil ContactType2Id SN Type int dateTime dateTime int string(32) Mandatory No No No No No
Output
439
GetBundleAssignList
Name BundleAssignId BundleId ContactTypeId AvailableSubcustomer ContactLevelAssignment SN OperatorId PackageId ProductId CallModeId TrafficId ValidFrom ValidUntil Condition NameUserLastUpdate
Type int int int boolean boolean string int int int int int dateTime dateTime string string
Code 0 -1 -2 -3 -4 -5 -90 -91 Description OK No input was provided BundleId not found ContactType2Id not found SN not found SN doesnt belong to the specified contact Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
440
GetBundleCall
GetBundleCall
This method retrieves the details of a rule linked to a bundle definition.
Input
Elements
Name BundleCallId Type int Mandatory Yes
Output
Name BundleCallId BundleDefinitionId CallModeId SystemOperatorId OriginatingOperatorId DestinationOperatorId RegionId TimeZoneId MinimumQoSId ValidFrom ValidUntil LastUpdate Type int int int int int int int int int dateTime dateTime dateTime
441
GetBundleCall
Code 0 -1 -10 -90 -91 Description OK BundleCallId not found Bundle is read-only Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
442
GetBundleCallList
GetBundleCallList
This method returns the (filtered) list of rules linked to a specific bundle definition entry.
Input
Elements
Name BundleDefinitionId ValidFrom ValidUntil Type int dateTime dateTime Mandatory Yes No No
Output
Name BundleCallId BundleDefinitionId CallModeId SystemOperatorId OriginatingOperatorId DestinationOperaotrId RegionId TimeZoneId MinimumQoSId ValidFrom ValidUntil Type int int int int int int int int int dateTime dateTime
443
GetBundleCallList
Code 0 -1 -90 -91 Description OK BundleDefinitionId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
444
GetBundleCustDestination
This method retrieves a destination record linked to a bundle definition.
Input
Elements
Name BundleCustDestinationId Type int Mandatory Yes
Output
Name BundleCustDefinitionId BundleDefinitionId ValidityContactTypeId ValiditySN ValidFrom ValidUntil DestinationContactTypeId DestinationSN DestinationPrefix LastUpdate Type int int int string dateTime dateTime int string string dateTime
Code 0 -1 Description OK BundleCustDestinationId not found
445
Code -90 -91
-100
446
GetBundleCustDestinationList
This method returns the (filtered) list of destinations linked to a specific bundle definition entry.
Input
Elements
Name BundleDefinitionId ValidFrom ValidUntil Type int dateTime dateTime Mandatory Yes No No
Output
Name BundleCustDefinitionId BundleDefinitionId ValidityContactTypeId ValiditySN ValidFrom ValidUntil DestinationContactTypeId DestinationSN DestinationPrefix Type int int int string dateTime dateTime int string string
447
Code 0 -1 -90 -91 Description OK BundleDefinitionId not found or NULL Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
448
GetBundleDefinition
GetBundleDefinition
This method retrieves a bundle definition record.
Input
Elements
Name BundleDefinitionId Type int Mandatory Yes
Output
Name Id Product TrafficType CallMode Validity Validity.BeginDate Validity.EndDate Bundle Description Priority RatingType SpecialPrice Benefit: BundleDefinitionRatingUnitValueData BundleDefinitionSessionValueData BundleDefinitionCurrencyValueData BundleDefinitionUnlimitedValueData Depending on type of benefit, Benefit.Value and Benefit.RatingUnit are provided. Type int int int int DateRangeData datetime datetime int string int int PriceModifierData Type of the benefit
449
GetBundleDefinition
Name Benefit.Value Benefit.RatingUnit
Type Decimal int
Code 0 -1 -90 -91 Description OK BundleDefinitionId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
450
GetBundleDefinitionList
This method returns the (filtered) list of definition entries of a specific bundle.
Input
Elements
Name BundleId ValidFrom ValidUntil Type int dateTime dateTime Mandatory Yes No No
Output
Name BundleDefinitionId BundleId ProductId CallModeId ValidFrom ValidUntil PromotionTypeId PromotionValue TrafficId Type int int int int dateTime dateTime int decimal int
451
Code 0 -1 -90 -91
Description OK BundleId not found or NULL Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
452
GetBundleList
GetBundleList
This method returns the (filtered) list of bundles.
Input
Elements
Name BundleCode ValidFrom ValidUntil Type string dateTime dateTime Mandatory No No No
BundleCode filtering
To get the list of ... all bundles, all bundles of which the code starts with XXX, all bundles of which the code ends with XXX, all bundles of which the code contains XXX, in BundleCode, specify ... % XXX% %XXX %XXX%
Output
Name BundleId BundleCode Description BundlePriority ValidFrom ValidUntil Type int string string int dateTime dateTime
453
GetBundleList
-100
454
GetBundleThresholdEventDefinition
GetBundleThresholdEventDefinition
This method retrieves a record from the BundleThresholdEventDefinition table.
Input
Elements
Output
Name Id Level Description Parent.Id Type int int string int
Code 0 -2 -90 -91 Description OK BundleThresholdEventDefinitionId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
455
GetBundleThresholdEventDefinitionListOfBundle
GetBundleThresholdEventDefinitionListOfBundle
This method returns the records from the BundleThresholdEventDefinition table that are linked to an overall bundle.
Input
Elements
Output
Name Id Parent.Id Level Description Type int int int string
Code 0 -2 -90 -100 Description OK BundleId not found Authentication failed Unspecified error
456
GetBundleThresholdEventDefinitionListOfBundleDefinition
GetBundleThresholdEventDefinitionListOfBundleDefinition
This method returns a list of records from the BundleThresholdEventDefinition table that are linked to a bundle definition.
Input
Elements
Name BundleDefinitionId Type int Mandatory Yes
Output
Name Id Parent.Id Level Description Type int int int string
Code 0 -2 -90 -100 Description OK BundleDefinitionId not found Authentication failed Unspecified error
457
GetBundleThresholdMessageNotificationList
This method returns a list of records from the NotificationMessage table that are linked to a bundle threshold event definition.
Input
Elements
Output
The method will return a complex type called ResultGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain a list of objects with the following parameters: For SMS notifications:
Name Id BodyDocTextKey Type int string
For email notifications:

Name Id Origin SubjectDocTextKey BodyDocTextKey Type int string string string
458
Code 0 -2 -90 -100 Description OK BundleThresholdEventDefinitionId not found Authentication failed Unspecified error
459
GetBundleUsage
GetBundleUsage
This method retrieves a bundle usage record.
Input
Elements
Name BundleUsageId Type int Mandatory Yes
Output
Name BundleUsageId BundleAssignId BundleMarketingIdId BundleDefinitionId ContactTypeId SN ValidFrom ValidUntil TimesApplied CurrentScope AssignedValue RolledOverValue UsedValue ReservedValue CurrencyId Information LastUpdate Type int int int int int string dateTime dateTime int decimal decimal decimal decimal decimal int string dateTime
460
GetBundleUsage
Code 0 -1 -90 -91 Description OK BundleUsageId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
461
GetBundleUsageList
GetBundleUsageList
This method returns the (filtered) list of bundle usage records.
Input
Elements
Name BundleId BundleAssignId BundleDefinitionId BundleMarketingId ContactType2Id SN ValidFrom ValidUntil ValidOn PageIndex 0=Page 1, 1=Page 2, ... PageSize SortBy SortOrder 0=ASC, 1=DESC Type int int int int int string dateTime dateTime dateTime int Mandatory No No No No No No No No No Yes
int int int
Yes Yes Yes
Output
Name BundleUsageId BundleAssignId BundleMarketingIdId Type int int int
462
GetBundleUsageList
Name BundleDefinitionId ContactTypeId SN ValidFrom ValidUntil TimesApplied CurrentScope AssignedValue RolledOverValue UsedValue ReservedValue CurrencyId
Type int int string dateTime dateTime int decimal decimal decimal decimal decimal int
-100
463
GetBundleUsageSetEventDefinitions
GetBundleUsageSetEventDefinitions
This method returns the settings of the BundleUsageSetEventDefinitions of a bundle (expiration, activation, no credits left).
Input
Elements
Output
Name Id Enabled Type int boolean
464
GetBundleUsageSetMessageNotificationList
This method returns a list of records from the NotificationMessage table that are linked to a bundle usage set event definition.
Input
Elements
Name BundleUsageSetEventDefinitionId Type int Mandatory Yes
Output
The method will return a complex type called ResultGetList, containing a dataset called ListInfo, an integer called Result, and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain a list of objects with the following parameters: For SMS notifications:
Name Id BodyDocTextKey Type int string
For email notifications:

Name Id Origin SubjectDocTextKey BodyDocTextKey Type int string string string
465
Code 0 -2 -90 -100 Description OK BundleUsageSetEventDefinitionId not found Authentication failed Unspecified error
466
IsBundleReadonly
IsBundleReadonly
This method returns whether a bundle is read-only or not (due to wholesale bundle mapping).
Input
Elements
Output
Name Read-only Type boolean
467
SetBundleUsageSetEventDefinitions
SetBundleUsageSetEventDefinitions
This method switches expiration, activation, and No credits left event triggers on or off for a bundle. It also allows to set the number of days that subscribers should be notified in advance that their bundle usage set with remaining credits expires.
Input
Elements
Name BundleId enableOnStartUsageSetEvent enableNoCreditsLeftUsageSetEvent enableOnExpiryUsageSetEvent daysBeforeOnExpiryUsageSetEvent Type int boolean boolean boolean int Mandatory Yes Yes Yes Yes Yes
Output
Code 0 -1 -2 -90 -91 Description OK BundleId does not exist Days before are not in range 0 - 100 Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
468
UpdateBundle
UpdateBundle
This method updates a bundle record.
Input
Elements
Name BundleId BundleCode Description ValidFrom ValidUntil StartingPoint Periodicity PeriodicityValue ValidPeriodType ValidPeriodNumber NumRecurrences MaxRollOverPeriods PackageId ProductId CurrencyId AvailableSelfCare AvailableSalesRep AvailableSMS AvailableIVR AvailablePrepaid AvailablePostpaid DisconnectNoBundleCreditLeft TotalAmount NameUserLastUpdate Logging AccountType (int) Account (string(66)) Type int string string dateTime dateTime int int int int int int int int int int boolean boolean boolean boolean boolean boolean boolean decimal string complex Yes No No Mandatory Yes No No No No No No No No No No No No No No No No No No No No
469
UpdateBundle
Output
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -17 -19 -20 -21 -22 -90 -91 Description OK BundleId not found PackageId not found (-1 allowed) ProductId not found (-1 allowed) Currency not found MaxRollOverPeriod: Only positive values allowed. StartingPoint: StartDay not found Periodicity: StartPeriod not found ValidPeriodType: ValidType not found PeriodicityValue: Only positive StartRepeat allowed ValidPeriodNumber: Only positive values allowed Invalid BundleCode Invalid BundleDescription BundleName already exists Update cannot be cascaded because more than one row has been affected (code error) Invalid TotalAmount. Enter a positive decimal number. You may not update bundles with bundle assignments when the package differs from the current package. Cannot update DisconnectNoBundleCreditLeft: Changeset does not have status 'To be approved' Bundle is read-only A bundle with bundle definitions cannot be changed from a normal bundle to an overall bundle A bundle with bundle definitions cannot be changed from an overall bundle to a normal bundle The overall value of an overall bundle cannot be updated when the bundle has bundle assignments Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
470
UpdateBundleAssign
UpdateBundleAssign
This method updates a bundle assignment record.
Input
Elements
Name BundleAssignId ContactTypeId AvailableSubcustomer ContactLevelAssignment SN OperatorId PackageId ProductId CallModeId TrafficId ValidFrom ValidUntil NameUserLastUpdate Logging AccountType (int) Account (string(66)) Type int int boolean boolean string int int int int int dateTime dateTime string complex Mandatory Yes No No No No No No No No No No No No No
Output
Code 0 -1 -3 Description OK BundleAssignId not found ContactType2Id not found (-1 = All contacts of type 2, Null = No update) SN not valid (Empty = No SN, Null = No update)
-4
471
UpdateBundleAssign
Code -5 -6 -7 -8 -9 -10 -1 1
Description SN does not belong to selected contact Invalid OperatorId (-1 = all operators allowed) Invalid PackageId (-1 = all packages allowed) Invalid ProductId (-1 = all products allowed) Invalid CallModeId (-1 = all call modes allowed) Invalid TrafficId (-1 = all traffic types allowed) If GroupPerCustomer(ContactLevelAssignment)=On -> CustomerId: <> -1, szSN: NULL or '' and OperatorId:=-1 The bundle <#1#> has not yet reached its 'Buy interval' limitation for subscriber <#2#>! The PackageId in the bundle is not the same as the package Id that is supplied to create the bundle assignment The PackageId in the bundle is null, so a valid package Id is required to create the bundle assignment Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-12 -13
-14 -90 -91
-100
472
UpdateBundleAssignCondition
This method updates a bundle assignment condition element.
Input
Elements
Name BundleAssignConditionId LogicaloperatorId TableToCheckId FieldToCheckId OperatorId DestinationTable DestinationField Value Logging AccountType (int) Account (string(66)) Type int int int int int int int string complex Mandatory Yes No No No No No No No No
Important If DestinationTable, DestinationField, and Value are not passed to the method, none of these three fields will be updated. If at least one of these three fields are passed to the method, all three will be updated.
Output
Code 0 -1 -3 -4 -5 -6 Description OK BundleAssignConditionId not found Invalid LogicalOperatorId Invalid TableToCheck Invalid FieldToCheck (TableToCheck -1 >>> FieldToCheck -1) Invalid Comparison (TableToCheck <> -1 >>> Comparison <> -1)
473
Code -7 -8 -9 -90 -91
Description Invalid DestinationTable Invalid DestinationField Update cannot be cascaded because more than one row has been affected. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
474
UpdateBundleAvailability
UpdateBundleAvailability
This method allows to update the availability properties of a bundle. These properties can always be updated, even when the (retail) bundle is read-only (e.g. due to an approved mapping between the bundle and a wholesale bundle in the first-level parent reseller database).
Input
Elements
Name BundleId ValidFrom ValidUntil AvailableSelfCare AvailableSalesRep AvailableSMS AvailableIVR AvailablePrepaid AvailablePostpaid Logging AccountType (int) Account (string(66)) Type int dateTime dateTime boolean boolean boolean boolean boolean boolean complex Mandatory Yes No No No No No No No No No
Output
Code 0 -1 -90 -91 Description OK BundleId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
475
UpdateBundleCall
UpdateBundleCall
This method updates a rule linked to a bundle definition.
Input
Elements
Name BundleCallId CallModeId SystemOperatorId OriginatingOperatorId DestinationOperatorId RegionId TimeZoneId MinimumQoSId ValidFrom ValidUntil Logging AccountType (int) Account (string(66)) Type int int int int int int int int dateTime dateTime complex Mandatory Yes No No No No No No No No No No
Output
Code 0 -2 -3 -4 -5 -6 -7 -8 Description OK BundleCallId not found Invalid CallModeId (-1 = All call modes) Invalid OperatorId (-1 = All operators) Invalid OperOrigId (-1 =All originating operators) Invalid OperDestId (-1 = All destination operators) Invalid RegionId (-1 = All regions) Invalid TimeZoneID (-1 = All time zones)
476
UpdateBundleCall
Code -9 -90 -91
Description Invalid MinimumQoS (-1 = All minimum QoS levels) Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
477
UpdateBundleCustDestination
This method updates a destination record linked to a bundle definition.
Input
Elements
Name BundleCustDestinationId ValidityContactTypeId ValiditySN ValidFrom ValidUntil DestinationContactTypeId DestinationSN DestinationPrefix Logging AccountType (int) Account (string(66)) Type int int string dateTime dateTime int string string complex Mandatory Yes No No No No No No No No
Important If DestinationContactTypeId, DestinationSN, and DestinationPrefix are not passed to the method, none of these three fields will be updated.
Output
Code 0 -2 -3 -4 -5 -6 Description OK BundleCustDefinitionId not found Invalid ValidityContactTypeId (-1 allowed) Invalid ValiditySN (NULL, , and valid SNs allowed) Invalid DestinationContactTypeId (-1 allowed) Invalid DestinationSN (NULL allowed)
478
Code -7
Description ValidityContactTypeId is NULL, DestinationSN is NULL, or DestinationPrefix is empty. ContactId, SN, or Prefix have to be specified. There is already a destination record with these specifications (in code). Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-8 -9 -90 -91
-100
479
UpdateBundleDefinition
This method updates a bundle definition.
Input
Elements
Name BundleDefinitionId Description ProductId CallModeId TrafficId ValidFrom ValidUntil BenefitType (*) BenefitValue RatingType (*) 0 = Free 1 = Charged SpecialPrice (*) Type int string int Int Int datetime datetime enum decimal int Mandatory Yes No No No Yes No No Yes No No
pricemodifier
No
(*) See AddBundleDefinition (page 410) to learn how the BenefitType and the combination of RatingType and SpecialPrice affects the rating and charging of used bundle benefits.
Output
Code 0 -1 -3 -4 -5 -6 Description OK BundleDefinitionId not found Invalid ProductId Invalid CallModeId Invalid TrafficType Invalid RatingType
480
Code -7 -8 -9 -10 -1 1 -12 -13 -14
Description Invalid RatingUnit (entered via the BenefitType) Invalid BenefitType Bundle is read-only The ValidFrom should precede the ValidUntil The bundle has assignments: traffic type, product, call mode and benefit properties are read-only. Bundle Definitions with BenefitType Sessions are not supported for this traffic type This BenefitType is not supported for this traffic type When used benefits are free (subtracted from benefit balance in bundle usage only), SpecialPrice is not needed. If BenefitType = Credits, or bundle is overall bundle, a SpecialPrice can be specified to subtract usage from the benefit balance at a special price. Bundle Definitions with BenefitType Unlimited cannot have BenefitValue Bundle Definitions in overall bundles should have BenefitType Unlimited For overall bundles, RatingType cannot be 1 (= Charged) Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-15 -16 -17 -90 -91
-100
481
UpdateBundleThresholdEventDefinition
UpdateBundleThresholdEventDefinition
This method updates a bundle threshold event definition record.
Input
Elements
Name BundleThresholdEventDefinitionId Level Description Type int int string Mandatory Yes Yes Yes
Output
Code 0 -2 -4 -5 -6 -90 -91 Description OK BundleThresholdEventDefinitionId or linked bundle/bundle definition not found The bundle threshold event definition must have a level between 1 and 100 The bundle already has a bundle threshold event definition for this level The bundle cannot contain more than two bundle threshold event definitions Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
482
UpdateEmailNotification
UpdateEmailNotification
This method updates an email notification record.
Input
Elements
Name NotificationId OriginAddress Subject Body Type int string string string Mandatory Yes Yes Yes Yes
Output
Code 0 -2 -4 -5 -6 -90 -91 Description OK MessageNotificationId not found No document text is configured for the email subject No document text is configured for the email body The document text of the subject or body is not valid Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
483
UpdateSmsNotification
UpdateSmsNotification
This method updates an SMS notification record.
Input
Elements
Name NotificationId Message Type int string Mandatory Yes Yes
Output
Code 0 -2 -4 -5 -6 -90 -91 Description OK MessageNotificationId not found No document text is configured for the SMS message The document text of the message is not valid The maximum length of an SMS is 160 characters. Please modify the SMS text. Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
484
SMS
Chapter 21:
SMS
In this chapter, you will find a detailed description of all methods contained in the SMS web service. This involves selfcare SMS that were sent by subscribers (stored in table SMSCReceived by SMPP Service), and replies that are returned by the SMS Handler to the subscribers (SMPP Service sends from table SMSCSent). See SMS Selfcare Reference Guide for more information. This web service allows you to manage all SMSSent and SMSReceived data.
Web method AddSMSSent GetSMSReceived GetSMSReceivedList GetSMSSent GetSMSSentList UpdateSMSReceived Page 485 487 489 491 493 495
485
AddSMSSent
AddSMSSent
This method adds a record in the SMSCSent table, causing an SMS message to be sent.
Input
Elements
Name SMSReceivedId UsedSN SentMessage SentMSISDN SentTon SentNpi Type int string string string(32) int int Mandatory No No Yes No No No
Default values If the SMSReceivedId refers to an existing SMSReceived record, then if SentMSISDN is not passed to the method, the system will take the MSISDN from the SMSReceived record. if SentTon is not passed to the method, the system will take the TON from the SMSReceived record. if SentNpi is not passed to the method, the system will take the NPI from the SMSReceived record.
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the SMSCSent record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -3 -4 Description OK No message SMSReceivedId not found Invalid TON Invalid NPI
486
AddSMSSent
Code -5 -6 -7
Description No MSISDN Invalid SN You have reached the maximum number replies. (setting 345) You are not allowed to send an SMS without an SMSReceivedId. (setting 346) Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-8
-90 -91
-100
487
GetSMSReceived
GetSMSReceived
This method retrieves an SMSCReceived record.
Input
Elements
Name SMSReceivedId Type int Mandatory Yes
Output
Name SMSReceivedId ReceivedTime ReceivedMessage ReceivedMSISDN ReceivedTon ReceivedNpi Result UsedSN LastProgressedTime ProgressCount Type int dateTime string string int int int string dateTime int
Code 0 -1 Description OK SMSReceivedId not found
488
GetSMSReceived
Code -90 -91
-100
489
GetSMSReceivedList
GetSMSReceivedList
This method returns a (filtered) list of SMSCReceived records.
Input

Name ReceivedFrom ReceivedUntil ReceivedMessage ReceivedMSISDN Result UsedSN PageIndex Number of the page to be returned 0=Page 1, 1=Page 2, ... Number of records per page Description Type dateTime dateTime string string int string int Mandatory No No No No No No Yes
PageSize SortBy SortOrder
int int
Yes Yes Yes
0=ASC, 1=DESC
int
Output
Name SMSReceivedId ReceivedTime ReceivedMessage ReceivedMSISDN ReceivedTon ReceivedNpi Type int dateTime string string int int
490
GetSMSReceivedList
Name Result UsedSN
Type int string
-100
491
GetSMSSent
GetSMSSent
This method retrieves an SMSCSent record.
Input
Elements
Name SMSSentId Type int Mandatory Yes
Output
Name SMSSentId SMSReceivedId SentTime SentMessage SentMSISDN SentTon SentNpi Result UsedSN LastProgressedTime ProgressCount Type int int dateTime string string int int int string dateTime int
492
GetSMSSent
Code 0 -1 -90 -91 Description OK SMSSentId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
493
GetSMSSentList
GetSMSSentList
This method returns a (filtered) list of SMSCSent records.
Input

Name SentFrom SentUntil SMSReceivedId SentMessage SentMSISDN Result UsedSN PageIndex Number of the page to be returned 0=Page 1, 1=Page 2, ... Number of records per page Description Type dateTime dateTime int string string int string int Mandatory No No No No No No No Yes
PageSize SortBy SortOrder
int int
Yes Yes Yes
0=ASC, 1=DESC
int
Output
Name SMSSentId SMSReceivedId SentTime SentMessage SentMSISDN Type int int dateTime string string
494
GetSMSSentList
Name SentTon SentNpi Result UsedSN
Type int int int string
-100
495
UpdateSMSReceived
UpdateSMSReceived
This method updates an SMSCReceived record.
Input
Elements
Name SMSReceivedId Result UsedSN LastProgressedTime ProgressCount Type int int string dateTime int Mandatory Yes No No No No
Output
Code 0 -1 -2 -90 -91 Description OK BundleDefinitionId not found SN not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
496
Mobile
Chapter 22:
Mobile
In this chapter, you will find a detailed description of all methods contained in the Mobile web service. This web service allows you to manage all mobile number data.
Web method AddIMSI AddIMSIMSISDN AddMSISDN AddSIM DeleteIMSI DeleteIMSIMSISDN DeleteMSISDN DeleteSIM DetachMSISDN GetIMSI GetIMSIList GetIMSIMSISDNList GetMSISDN GetMSISDNList GetSIM GetSIMList UpdateIMSI UpdateMSISDN UpdateSIM Page 497 499 500 502 504 505 506 507 508 509 51 1 513 514 516 518 520 522 523 525
497
AddIMSI
AddIMSI
This method links an IMSI to a SIM.
Input
Elements
Name IMSINr SIMNr Status GetConversionCodeList (IMSIStatus) 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive Description Type string string int Mandatory Yes Yes Yes
complex
No
Output
Code 0 -1 -2 -3 -90 -91 Description OK IMSI number already exists Invalid SIM number Invalid status Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
498
AddIMSI
499
AddIMSIMSISDN
AddIMSIMSISDN
This method links an MSISDN to an IMSI.
Input
Elements
Name MSISDNId IMSINr Logging AccountType (int) Account (string(66)) Type int string complex Mandatory Yes Yes No
Output
Code 0 -1 -2 -3 -90 -91 Description OK Invalid MSISDNId Invalid IMSI number MSISDN-IMSI link already exists Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
500
AddMSISDN
AddMSISDN
This method links an MSISDN to a CLI/PIN.
Input
Elements
Name SN MSISDNNr SIMNr Status GetConversionCodeList (MSISDNStatus) 0 = Undefined 1 = Available 2 = Webreserved 3 = Assigned 4 = External MNP 5 = First call active 6 = Active 7 = MNP 8 = Deactivated 9 = Portout 10 = ChangePool Description Type string string string int Mandatory Yes Yes No Yes
complex
No
Output
The method will return a complex type called "ResultInsertItem", containing: a string called "NewItemId", and an integer called "Result". NewItemId If Result contains 0, then NewItemId will contain the ID of the MSISDN that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 Description OK Invalid status
501
AddMSISDN
Code -2 -3 -4 -5 -6 -7 -90 -91
Description Active MSISDN number already exists Invalid SN MSISDN active: Invalid SN MSISDN already exists in Central Database Invalid MSISDN number Invalid SIM number Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
502
AddSIM
AddSIM
This method adds a SIM record in the database.
Input
Elements
Name SIMNr ContactType1Id DistributorId ContactType2Id TypeSIM Technical Copies PUK1 PUK2 ManufacturingOrderId WarehouseOrderId Status GetConversionCodeList (SIMStatus) 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive 9 = SwapSimRejected GetConversionCodeList (SIMType) GetConversionCodeList (SIMTechnical) GetDistributorList Description Type string int int int int int int string string int int int Mandatory Yes No No No Yes Yes Yes No No Yes Yes Yes
DeliveryType DeliveryDate DeliveryName DeliveryStreet DeliveryNumber DeliveryZipCode DeliveryCity DeliveryCountry
int dateTime string string string string string string
Yes No No No No No No No
503
AddSIM
Name DeliveryCompany Logging AccountType (int) Account (string(66))
Description
Type string complex
Mandatory No No
Output
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -90 -91 Description OK SIM number already exists Invalid Status Invalid TypeSIM Invalid Technical Invalid DeliveryType Invalid DistributorId Invalid ContactType1Id Invalid ContactType2Id Invalid ContactType2Id/ContactType1Id combination Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
504
DeleteIMSI
DeleteIMSI
This method deletes an IMSI record.
Input
Elements
Name IMSINr Logging AccountType (int) Account (string(66)) Type string complex Mandatory Yes No
Output
Code 0 -1 -90 -91 Description OK IMSI not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
505
DeleteIMSIMSISDN
DeleteIMSIMSISDN
This method deletes an IMSI/MSISDN link.
Input
Elements
Name MSISDNId IMSINr Logging AccountType (int) Account (string(66)) Type int string complex Mandatory Yes Yes No
Output
Code 0 -1 -90 -91 Description OK MSISDN/IMSI link not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
506
DeleteMSISDN
DeleteMSISDN
This method deletes an MSISDN record.
Input
Elements
Name MSISDNId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -90 -91 Description OK MSISDNId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
507
DeleteSIM
DeleteSIM
This method deletes a SIM record.
Input
Elements
Name SIMNr Logging AccountType (int) Account (string(66)) Type string complex Mandatory Yes No
Output
Code 0 -1 -90 -91 Description OK SIM number not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
508
DetachMSISDN
DetachMSISDN
This method detaches an MSISDN for the IMSI to which it is attached.
Input
Elements
Name MSISDNId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -90 -91 Description OK Invalid MSISDNId Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
509
GetIMSI
GetIMSI
This method retrieves an IMSI record.
Input
Elements
Name IMSINr Type string Mandatory Yes
Output
Name IMSINr SIMNr Status 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive DateActivation DateTermination Type string string int
dateTime dateTime
Code 0 -1 Description OK IMSINr not found
510
GetIMSI
Code -90 -91
-100
51 1
GetIMSIList
GetIMSIList
This method returns a (filtered) list of IMSIs.
Input
Elements
Name IMSINr SIMNr Type string string Mandatory No No
Output
Name IMSINr SIMNr Status 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated DateActivation DateTermination Type string string int
dateTime dateTime
512
GetIMSIList
-100
513
GetIMSIMSISDNList
GetIMSIMSISDNList
This method returns a (filtered) list of IMSI/MSISDN links.
Input
Elements
Name MSISDNId IMSINr Type int string Mandatory No No
Output
Name IMSINr MSISDNId Type string int
-100
514
GetMSISDN
GetMSISDN
This method retrieves an MSISDN record.
Input
Elements
Name MSISDNId Type int Mandatory Yes
Output
Name MSISDNId MSISDNNr SN Status 0 = Undefined 1 = Available 2 = Webreserved 3 = Assigned 4 = External MNP 5 = First call active 6 = Active 7 = MNP 8 = Deactivated 9 = Portout 10 = ChangePool DateStatusChanged DateActivation DateTermination Type int string string int
dateTime dateTime dateTime
515
GetMSISDN
Code 0 -1 -90 -91 Description OK MSISDNId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
516
GetMSISDNList
GetMSISDNList
This method returns a (filtered) list of MSISDN records.
Input
Elements
Name SN MSISDNNr Status GetConversionCodeList (MSISDNStatus) 0 = Undefined 1 = Available 2 = Webreserved 3 = Assigned 4 = External MNP 5 = First call active 6 = Active 7 = MNP 8 = Deactivated 9 = Portout 10 = ChangePool Description Type string string int Mandatory No No No
ShowOnlyNoAttachedToIMSI
boolean
No
Output
Name MSISDNId MSISDNNr SN Type int string string
517
GetMSISDNList
Name Status 0 = Undefined 1 = Available 2 = Webreserved 3 = Assigned 4 = External MNP 5 = First call active 6 = Active 7 = MNP 8 = Deactivated 9 = Portout 10 = ChangePool DateStatusChanged DateActivation DateTermination
Type int
dateTime dateTime dateTime
-100
518
GetSIM
GetSIM
This method retrieves a SIM record.
Input
Elements
Name SIMNr Type string Mandatory Yes
Output
Name SIMNr ContactType1Id DistributorId ContactType2Id TypeSIM Technical Copies PUK1 PUK2 ManufacturingOrderId WarehouseOrderId Status 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive Type string int int int int int int string string int int int
519
GetSIM
Name DateStatusChanged DeliveryType DeliveryDate DateActivation DateTermination DeliveryName DeliveryStreet DeliveryNumber DeliveryZipCode DeliveryCity DeliveryCountry DeliveryCompany
Type dateTime int dateTime dateTime dateTime string string string string string string string
Code 0 -1 -90 -91 Description OK SIMNr not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
520
GetSIMList
GetSIMList
This method returns a (filtered) list of SIMs.
Input
Elements
Name SIMNr ContactType1Id DistributorId ContactType2Id TypeSIM Id of the Customer GetConversionCodeList (SIMType): 0 = SwapCard 1 = Pre-provisioned card GetConversionCodeList (SIMTechnical) GetConversionCodeList (SIMStatus): 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive 9 = SwapSimRejected Id of the Sales Representative Description Type string int int int int Mandatory No No No No No
Technical Status
int int
No No
Output
Name SIMNr ContactType1Id DistributorId Type string int int
521
GetSIMList
Name ContactType2Id TypeSIM Technical Copies PUK1 PUK2 ManufacturingOrderId WarehouseOrderId Status DateStatusChanged DeliveryType DeliveryDate DateActivation DateTermination DeliveryName DeliveryStreet DeliveryNumber DeliveryZipCode DeliveryCity DeliveryCountry DeliveryCompany
Type int int int int string string int int int dateTime int dateTime dateTime dateTime string string string string string string string
-100
522
UpdateIMSI
UpdateIMSI
This method changes the status of an IMSI.
Input
Elements
Name IMSINr Status GetConversionCodeList (IMSIStatus) 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive Description Type string int Mandatory Yes Yes
complex
No
Output
Code 0 -1 -2 -90 -91 Description OK Invalid IMSI number Invalid status Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
523
UpdateMSISDN
UpdateMSISDN
This method updates a CLI/PIN-MSISDN link.
Input
Elements
Name MSISDNId SN Status GetConversionCodeList (MSISDNStatus) 0 = Undefined 1 = Available 2 = Webreserved 3 = Assigned 4 = External MNP 5 = First call active 6 = Active 7 = MNP 8 = Deactivated 9 = Portout 10 = ChangePool Description Type int string int Mandatory Yes No No
complex
No
Output
Code 0 -1 -2 -3 -4 -90 Description OK Invalid MSISDN number Invalid status Invalid SN Error update status deactivated/Portout: This MSISDN already exists Authentication failed
524
UpdateMSISDN
Code -91
-100
525
UpdateSIM
UpdateSIM
This method updates a SIM record.
Input
Elements
Name SIMNr ContactType1Id DistributorId ContactType2Id TypeSIM Technical Copies PUK1 PUK2 ManufacturingOrderId WarehouseOrderId Status GetConversionCodeList (SIMStatus) 0 = Undefined 1 = Warehouse 2 = Ordered 3 = Sent 4 = Salesrep 5 = Active 6 = Blocked 7 = Deactivated 8 = WaitSwapActive 9 = SwapSimRejected GetConversionCodeList (SIMType) GetConversionCodeList (SIMTechnical) GetDistributorList Description Type string int int int int int int string string int int int Mandatory Yes No No No No No No No No Yes Yes No
DeliveryType DeliveryDate DeliveryName DeliveryStreet DeliveryNumber DeliveryZipCode DeliveryCity DeliveryCountry
int dateTime string string string string string string
No No No No No No No No
526
UpdateSIM
Name DeliveryCompany Logging AccountType (int) Account (string(66))
Description
Type string complex
Mandatory No No
Output
Code 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -90 -91 Description OK Invalid SIM number Invalid Status Invalid TypeSIM Invalid Technical Invalid DeliveryType Wrong DistributorId Wrong ContactType1Id Wrong ContactType2Id Invalid ContactType2Id/ContactType1Id combination Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
527
NumberPort
Chapter 23:
NumberPort
In this chapter, you will find a detailed description of all methods contained in the NumberPort web service.
Web method AddNumberPort DeleteNumberPort GetNumberPort GetNumberPortList UpdateNumberPort Page 528 530 531 532 534
528
AddNumberPort
AddNumberPort
This method adds an entry in the Number Portability table.
Input
Elements
Name Prefix OperatorId ValidFrom Area RoutingInfo Logging AccountType (int) Account (string(66)) Type string int dateTime string string complex Mandatory Yes Yes No Yes Yes No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the table entry that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -90 Description OK Enter a valid prefix. Invalid OperatorId. There is already an entry in the Number Portability table for this Prefix and ValidFrom date. Authentication failed
529
AddNumberPort
Code -91
-100
530
DeleteNumberPort
DeleteNumberPort
This method deletes an entry from the Number Portability table.
Input
Elements
Name NumberPortId Logging AccountType (int) Account (string(66)) Type int complex Mandatory Yes No
Output
Code 0 -1 -90 -91 Description OK NumberPortId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
531
GetNumberPort
GetNumberPort
This method retrieves an entry from the Number Portability table.
Input
Elements
Name NumberPortId Type int Mandatory Yes
Output
Name NumberPortId Prefix OperatorId ValidFrom Area RoutingInfo Type int string int dateTime string string
Code 0 -1 -90 -91 Description OK NumberPortId not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
532
GetNumberPortList
GetNumberPortList
This method returns a (filtered) list of entries from the Number Portability table.
Input
Elements
Name Prefix OperatorId From Till Area RoutingInfo ShowBestMatch PageIndex 0=Page 1, 1=Page 2, ... PageSize SortBy SortOrder 0=ASC, 1=DESC Type string int dateTime dateTime string string boolean int Mandatory No No No No No No No Yes
int int int
Yes Yes Yes
Output
Name NumberPortId Prefix OperatorId ValidFrom Type int string int dateTime
533
GetNumberPortList
Name Area RoutingInfo
Type string string
-100
534
UpdateNumberPort
UpdateNumberPort
This method updates an entry in the Number Portability table.
Input
Elements
Name NumberPortId Prefix OperatorId ValidFrom Area RoutingInfo Logging AccountType (int) Account (string(66)) Type int string int dateTime string string complex Mandatory Yes No No No No No No
Output
Code 0 -1 -2 -3 -90 -91 Description OK NumberPortId not found Enter a valid prefix Invalid OperatorId Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
535
ResellerMobileNumberPort
Chapter 24:
ResellerMobileNumberPort
In this chapter, you will find a detailed description of all methods contained in the ResellerMobileNumberPort web service. Note that these APIs support the Belgian number porting workflow.
Web method PortInRequest Cancel GetPendingPorts GetRequest GetGroupDetails Accept Reject Page 536 538 539 541 543 545 546
536
PortInRequest
PortInRequest
This method initiates a new port-in request for a CLI, or retries a port-in request that has previously failed. A port-in request for a particular CLI/PIN can be re-initiated if the MNP Status Port In parameter (ID: 20515) linked to that CLI/PIN is set to one of the following values Port in Rejected, Port in Canceled or Ported in.
Input
Elements
Name PortRequest Type complex Mandatory Yes
Every PortRequest element should contain the following sub-elements:

Name OperationType RequestType Description PORT_IN The type of the port operation. PREPAY (Prepaid) POSTPAY_SIMPLE (Postpaid Domestic) POSTPAY_COMPLEX (Postpaid Business) The ID of the donor operator Base Proximus Mobistar The MSISDN to be ported in The SIM number The account number The customer name The company name The name of the authorized requestor The VAT number of the company Serial number of the CLI for which the port request is initiated (CLI must have network status Created with MSISDN status = Assigned) The date/time at which the port request has to be launched. If this element contains NULL or a datetime in the past, then the request will be launched as soon as possible. Type enum enum Mandatory Yes Yes
DonorOperator
string
Yes
MSISDN DonorSIM AccountNumber CustomerName CompanyName AuthorisedRequestorName VATNumber SN
string string string string string string string string
Yes Dependent on RequestType option See table below
Yes
ActionDate
datetime
No
537
PortInRequest
Depending on the type of port-in request, the following elements must either be specified or left empty. Refer to the COP documentation for details about port-in options.
Postpaid Domestic (Option 1) X X X X X X X X X Postpaid Domestic (Option 2) Postpaid Business (Option 1) Postpaid Business (Option 2)
Element
Prepaid
DonorSIM AccountNumber CustomerName CompanyName AuthorisedRequestorName VATNumber
Output
The method will return a complex type called OperationResponse, containing: a string called Operation, a string called Message, and an integer called Result. Operation This string contains the name of the method that returned the OperationResponse, i.e. PortInRequest Result/Message The following table gives an overview of all possible result codes and associated messages.
Result 0 100 200 Message Success AuthenticationFailure ValidationException Description Operation was successful. Reseller could not be authenticated using the credentials that were passed. Some of the data that was passed, could not be validated. Example: MSISDN contains a non-numeric character. MSISDN is assigned to the recipient operator. No porting operation in progress for this MSISDN. MSISDN is involved in another porting operation. A database error occurred. An unknown error occurred.
235 255 270 275 299
MsIsdnResidesAtRecipient NoPortingInProgress AlreadyBeingPorted DatabaseFailure Other
538
Cancel
Cancel
This method cancels a port-in request in progress. It sets the status of the request from port-in pending to port-in ready to cancel. The provisioning processor takes care of the rest.
Input
Elements
Name SN Description Serial number of the CLI/PIN for which the port-in request has to be canceled. Type string Mandatory Yes
Output
The method will return a complex type called OperationResponse, containing: a string called Operation, a string called Message, and an integer called Result. Operation This string contains the name of the method that returned the OperationResponse, i.e. Cancel Result/Message The following table gives an overview of all possible result codes and associated messages.
Result 0 100 200 235 255 270 275 299 Message Success AuthenticationFailure ValidationException MsIsdnResidesAtRecipient NoPortingInProgress AlreadyBeingPorted DatabaseFailure Other Description Operation was successful. Reseller could not be authenticated using the credentials that were passed. Some of the data that was passed, could not be validated. MSISDN is assigned to the recipient operator. No porting operation in progress for this MSISDN. MSISDN is involved in another porting operation. A database error occurred. An unknown error occurred.
539
GetPendingPorts
GetPendingPorts
This method returns the details of not yet completed port-in or port-out requests. Incomplete port-ins or port-outs are requests that have not yet been marked completed.
Input
Elements
Name PortInFilter Description Defines the port-in filter. Possible values: All None PendingAndRejected Pending Rejected Canceled Defines the port-out filter. Possibe values: None PendingAndRejected Pending Rejected Type enum Mandatory Yes
PortOutFilter
enum
Yes
Output
If not NULL (no port requests found), the method will return an array of complex types called PortRequest, each containing the details of a port-in or port-out request:
Name OperationType Description The direction of the port operation: PORT_IN PORT_OUT The type of the port operation. Possible values: PREPAY (Prepaid) POSTPAY_SIMPLE (Postpaid Domestic) POSTPAY_COMPLEX (Postpaid Business) The ID of the donor operator: Base Proximus Mobistar The MSISDN to be ported in. The SIM number The account number The customer name Type enum
RequestType
enum
DonorOperator
string
MSISDN DonorSIM AccountNumber CustomerName
string string string string
540
GetPendingPorts
Name CompanyName AuthorisedRequestorName VATNumber SN Status
Description The company name The name of the authorized requestor The VAT number of the company. Serial number of the CLI/PIN for which the port request is initiated. The current status of the port request. Possible values: IDLE WAITING_VALIDATION ACCEPTED REJECTED FAILED EXECUTING SUCCESS COMPLETED The date/time at which the port request has to be launched. The date/time at which the port request was received by the service instructed to process it (e.g. the Provisioning Processor Service).
Type string string string string enum
ActionDate EnteredDate
datetime datetime
541
GetRequest
GetRequest
This method returns the details of a specified port-in or port-out request.
Input
Elements
Name SN Description Serial number of the CLI/PIN for which the details of the port request have to be returned. Defines the port-in filter. Possible values: All None PendingAndRejected Pending Rejected Canceled Defines the port-out filter. Possibe values: None PendingAndRejected Pending Rejected Type string Mandatory Yes
PortInFilter
enum
Yes
PortOutFilter
enum
Yes
Output
If not NULL (no port requests found), the method will return a complex called PortRequest containing the details of the specified port-in or port-out request:
Name OperationType Description The direction of the port operation: PORT_IN PORT_OUT The type of the port operation. Possible values: PREPAY (Prepaid) POSTPAY_SIMPLE (Postpaid Domestic) POSTPAY_COMPLEX (Postpaid Business) The ID of the donor operator: Base Proximus Mobistar The MSISDN to be ported in. The SIM number The account number Type enum
RequestType
enum
DonorOperator
string
MSISDN DonorSIM AccountNumber
string string string
542
GetRequest
Name CustomerName CompanyName AuthorisedRequestorName VATNumber SN Status
Description The customer name The company name The name of the authorized requestor The VAT number of the company. Serial number of the CLI/PIN for which the port request is initiated. The current status of the port request. Possible values: IDLE WAITING_VALIDATION ACCEPTED REJECTED FAILED EXECUTING SUCCESS COMPLETED The date/time at which the port request has to be launched. The date/time at which the port request was received by the service instructed to process it (e.g. the Provisioning Processor Service).
Type string string string string string enum
datetime datetime
543
GetGroupDetails
GetGroupDetails
This method returns the details of port-out requests for multiple MSISDNs.
Input
Elements
Name LeadSN Description The SN of the first MSISDN listed in the multipleMSISDN port request. Type string Mandatory Yes
Output
The method will return an array of complex types called PortRequest, each containing the details of one of the MSISDNs in the port-out request:
Name OperationType Description The direction of the port operation: PORT_IN PORT_OUT The type of the port operation. Possible values: PREPAY (Prepaid) POSTPAY_SIMPLE (Postpaid Domestic) POSTPAY_COMPLEX (Postpaid Business) The ID of the donor operator: Base Proximus Mobistar The MSISDN to be ported in. The SIM number The account number The customer name The company name The name of the authorized requestor The VAT number of the company. Serial number of the CLI/PIN for which the port request is initiated. Type enum
RequestType
enum
DonorOperator
string
MSISDN DonorSIM AccountNumber CustomerName CompanyName AuthorisedRequestorName VATNumber SN
string string string string string string string string
544
GetGroupDetails
Name Status
Description The current status of the port request. Possible values: IDLE WAITING_VALIDATION ACCEPTED REJECTED FAILED EXECUTING SUCCESS COMPLETED The date/time at which the port request has to be launched. The date/time at which the port request was received by the service instructed to process it (e.g. the Provisioning Processor Service).
Type enum
datetime datetime
545
Accept
Accept
This method accepts a port-out request.
Input
Elements
Name SN Description Serial number of the CLI/PIN for which the port-out request has to be accepted. Type string Mandatory Yes
Output
The method will return a complex type called OperationResponse, containing: a string called Operation, a string called Message, and an integer called Result. Operation This string contains the name of the method that returned the OperationResponse, i.e. Accept Result/Message The following table gives an overview of all possible result codes and associated messages.
546
Reject
Reject
This method rejects a port-out request.
Input
Elements
Name SN Description Serial number of the CLI/PIN for which the port-out request has to be rejected. All details as to why the request is rejected. Type string Mandatory Yes
RejectInformation
complex
Yes
In the RejectInformation element, specify the following sub-elements:

Name Number RejectCode RejectComment Description The MSISDN for which the request was rejected. One of the reject codes from the table below. Additional information about the rejection Type string integer string Mandatory Yes Yes No
Reject codes The following table gives an overview of all possible reject codes.
RejectCode 100 105 RejectReason Not active BIPT exception Description The number isnt assigned to a customer. The MSISDN is an MSISDN for which the donor has received BIPT's permission to refuse porting as stipulated in the MNP legislation. The MSISDN is linked to an account held by the NAMNO (Number Block Allocated Mobile Network Operator, i.e. the operator to which the MSISDN was originally assigned by BIPT). There is a mismatch between MSISDN and SIM number. For requests of type Prepaid and Postpaid Domestic. There is a mismatch between MSISDN and account number. For requests of type Postpaid Domestic and Postpaid Business. There is a mismatch between MSISDN and customer name. For requests of type Postpaid Domestic. There is a mismatch between account number and customer name. For requests of type Postpaid Business. There is a mismatch between account number and authorized requestor. For requests of type Postpaid Business.
1 10
NAMNO owned
1 15
MSISDN / SIM card number mismatch
120
MSISDN / account number mismatch
125
MSISDN / customer name mismatch
135
Account number / customer name mismatch Account number / authorized requestor mismatch
140
547
Reject
RejectCode 145
RejectReason Account number / VAT number mismatch Service is prepaid
Description There is a mismatch between account number and VAT number. For requests of type Postpaid Business. In the donor operators system, the subscription is of type Prepaid. For requests of type Postpaid Business. In the donor operators system, the subscription is of type Postpaid Domestic. For requests of type Prepaid and Postpaid Business. In the donor operators system, the subscription is of type Postpaid Business. For requests of type Prepaid and Postpaid Domestic.
150
155
Account holder is a natural person
160
Account holder is a legal person
199
Other
Output
The method will return a complex type called OperationResponse, containing: a string called Operation, a string called Message, and an integer called Result. Operation This string contains the name of the method that returned the OperationResponse, i.e. Reject Result/Message The following table gives an overview of all possible result codes and associated messages.
548
Base tables
Chapter 25:
Base tables
In this chapter, you will find a detailed description of all auxiliary methods contained in the Base Tables web service.
Web method GetCallModeList GetConversionCodeList GetCountryList GetCountryPrefixesList GetCurrencyList GetLanguageList GetOperatorList GetRegionList GetTimeZoneList GetTrafficList Page 549 551 553 555 557 559 561 563 564 565
549
GetCallModeList
GetCallModeList
This method returns a (filtered) list of call modes.
Input
Elements
Name CallModeId TrafficDependent Type int boolean Mandatory No No
Output
Name CallModeId CallMode Description TrafficDependent Type int string string int
-100
550
GetCallModeList
Example
In case of a standard Artilium database, ListInfo will contain the following table.
CallModeId 1 2 3 1 1 12 13 1000 1010 1020 1030 1 100 CallMode O T F RO RT RF BLOCKALL PREMIUM INTERNAT ROAMING MNPBEEP Description Originating Terminating Forward Roaming Originating Roaming Terminating Roaming Forward Block All Premium Numbers International Numbers Roaming MNP Beep TrafficDependent 1 1 1 1 1 1 0 0 0 0 0
551
GetConversionCodeList
This method returns a (filtered) list of conversion code values.
Input
Elements
Name ConversionCode LanguageId 0 = English 1 = French Type enum int Mandatory Yes No
Output
Name CodeId Description LanguageId TypeLanguage Update Type int string int int int
552
Code -91
-100
553
GetCountryList
GetCountryList
This method returns a (filtered) list of countries.
Input
Elements
Name CountryId IsBase Type int boolean Mandatory No No
Output
Name CountryId Country IsBase CountryCode CountryCode2 Type int string int string string
-100
554
GetCountryList
Example
In case of a standard Artilium database, these will be the five first ListInfo table rows.
CountryId 4 8 12 16 20 CountryName Afghanistan Albania Algeria American Samoa Andorra IsBase 0 0 0 0 0 CountryCode AFG ALB DZA ASM AND CountryCode2 AF AL DZ AS AN
555
GetCountryPrefixesList
This method returns a (filtered) list of country prefixes.
Input
Elements
Name Prefix CountryId Origin Destination PayDirection Type Type string int boolean boolean boolean int Mandatory No No No No No No
In the Prefix element, you can use the % wildcard character. Examples: 003%, %5%, ...
Output
Name Prefix CountryPrefix CountryId Origin Destination PayDirection Type Modify Type string string int int int int int dateTime
556
-100
557
GetCurrencyList
GetCurrencyList
This method returns a (filtered) list of currencies.
Input
Elements
Name CurrencyId IsBase Type int boolean Mandatory No No
Output
Name CurrencyId Currency IsBase CurrencyCode Value NumberDecimalInvoiceDetail NumberDecimalInvoiceTotal Type short string unsignedByte string decimal int int
558
GetCurrencyList
Code -91
-100
559
GetLanguageList
GetLanguageList
This method returns a (filtered) list of languages.
Input
Elements
Name LanguageId IsBase Type int boolean Mandatory No No
Output
Name LanguageId Language IsBase Type int string int
-100
560
GetLanguageList
Example
LanguageId 1 2 3 4 LanguageName EN FR NL DE IsBase 1 0 0 0
561
GetOperatorList
GetOperatorList
This method returns a (filtered) list of operators.
Input
Elements
Name OperatorId SystemAllowed SystemDefault OriginAllowed OriginDefault DestinationAllowed DestinationDefault Type Type int boolean boolean boolean boolean boolean boolean int Mandatory No No No No No No No No
Output
Name OperatorId Operator Description CSC SystemAllowed SystemDefault OriginAllowed OriginDefault DestinationAllowed Type int string string string int int int int int
562
GetOperatorList
Name DestinationDefault Type
Type int int
-100
563
GetRegionList
GetRegionList
This method returns a (filtered) list of regions.
Input
Elements
Name RegionId Type int Mandatory No
Output
Name RegionId Region Description Type int string string
-100
564
GetTimeZoneList
GetTimeZoneList
This method returns a (filtered) list of time zones.
Input
Elements
Name TimeZoneId Type int Mandatory No
Output
Name TimeZoneId TimeZone Description Priority Type int string string int
-100
565
GetTrafficList
GetTrafficList
This method returns a (filtered) list of traffic types.
Input
Elements
Name TrafficId Type int Mandatory No
Output
Name TrafficId Traffic Description Unit Type int string string string
-100
566
GetTrafficList
Example
TrafficId 1 2 3 4 5 6 Traffic VOICE GPRS PLACE CONF SMS IM Description Voice phone calls General Packet Radio Service Place call Conferencing Short Messaging Service Instant Messaging Unit Seconds MBits Seconds Seconds Message Message
567
General
Chapter 26:
General
In this chapter, you will find a detailed description of all auxiliary methods contained in the General web service.
Web method GetAccountTypeList GetActivationCPSList GetCommissionPlanList GetCountryList GetCurrencyList GetCustomer1ClassificationList GetCustomer1PrintingDispatchList GetCustomer2ClassificationList GetCustomer2PrintingDispatchList GetDiscountTypeList GetDistributorList GetFeeAmountList GetFeeExclusionList GetFeePeriodicityList GetFMCCategoryList GetFMCLocationList GetFMCVoiceCompressionCodecList GetGenderList GetInitiatorList GetLanguageList GetMessagesList GetMinCarrierQualityList GetNumberCategoryList GetOperatorList GetPaymentMethodList GetPaymentTypeList GetPinOnInvoiceList GetPrintGraphList GetPrintingAddresseeList 596 598 600 602 603 605 607 608 610 612 614 616 Page 569 571 573 574 576 578 579 581 583 585 587 588 590 592 593 594
568
General
Web method GetProfileCLIPinList GetReloadSubTypeList GetReloadTypeList GetRequestCPSList GetRoundingList GetSalesPointList GetSolvencyStatusList GetStatusList GetTableKeyList GetTaxationMethodLegAList GetTaxationMethodLegBList GetTitleList GetTrafficTypeList GetTypeList GetUseAlternativeList GetVATFrequencyList GetVATRateList
Page 618 619 621 623 626 625 627 629 631 634 636 638 640 642 644 646 648
569
GetAccountTypeList
GetAccountTypeList
This method returns the list of available account types.
Input
Elements None.
Output
Name AccountTypeId AccountTypeDescription Type int string
-100
Example
In case of a standard Artilium database, ItemInfo will contain the following table.
StatusId -1 0 StatusDescription <All> NT user
570
GetAccountTypeList
StatusId 2 5 100
StatusDescription SQL user Web user System
571
GetActivationCPSList
This method returns the list of available CPS activation statuses.
Input
Elements
Name LanguageId Values 0 = English 1 = French Type int Mandatory No
Output
Name ActivationCPSId ActivationCPSDescription Type int string
-100
Example
In case of a standard Artilium database, if the LanguageId element is omitted from the SOAP request, then ItemInfo will contain the following table.
572
ActivationCPSId 0 1 2 3
ActivationCPSDescription Not activated Activated Wait for PRF Ported out
573
GetCommissionPlanList
GetCommissionPlanList
This method returns the list of available commission plans.
Input
Elements None.
Output
Name CommissionPlanId CommissionPlanDescription Type int string
-100
574
GetCountryList
GetCountryList
This method returns the list of available countries.
Input
Elements None.
Output
Name CountryId CountryName IsBase CountryCode CountryCode2 Type int string int string string
-100
575
GetCountryList
Example
In case of a standard Artilium database, these will be the five first ItemInfo table rows.
CountryId 4 8 12 16 20 CountryName Afghanistan Albania Algeria American Samoa Andorra IsBase 0 0 0 0 0 CountryCode AFG ALB DZA ASM AND CountryCode2 AF AL DZ AS AN
576
GetCurrencyList
GetCurrencyList
This method returns the list of available currencies.
Input
Elements None.
Output
Name CurrencyId CurrencyName IsBase CurrencyCode Type short string unsignedByte string
-100
577
GetCurrencyList
Example
CurrencyId 1 CurrencyName Euro IsBase 1 CurrencyCode EUR
578
GetCustomer1ClassificationList
This method returns the list of available ContactType1 classifications.
Input
Elements
Output
Name Customer1ClassificationId Customer1ClassificationName Type int string
-100
579
GetCustomer1PrintingDispatchList
This method returns the list of available commission note dispatch options for contacts of type 1.
Input
Elements
Output
Name Customer1PrintingDispatchId Customer1PrintingDispatchName Type int string
-100
580
Example
Customer1PrintingDispatchId 100 101 102 103 104 105 106 Customer1PrintingDispatchName All by Post All by Email All by PrintShop ComNt.Post, CstL&Str&Ltr Email ComNt.PrShop, CstL&Str&Ltr Email ComNt&Str&Ltr.Post, CstL.Email ComNt&Str&Ltr.PrShop, CstL.Email
581
This method returns the list of available ContactType2 classifications.
Input
Elements
Output
Name Customer2ClassificationId Customer2ClassificationName Type int string
-100
582
Example
Customer2ClassificitionId 0 10 15 20 30 35 40 45 50 55 60 Customer2ClassificationName Not defined Good payer VIP To follow Litigation Plan (of auditing) Legal settlement CPAS Lawyer Bankruptcy Doubtful debt (407)
583
This method returns the list of available invoice dispatch options for contacts of type 2.
Input
Elements
Output
Name Customer2PrintingDispatchId Customer2PrintingDispatchName Type int string
-100
584
Example
Customer2PrintingDispatchId 0 1 2 3 4 5 6 Customer2PrintingDispatchName All by Post All by Email All by PrintShop Inv.Post, Det&Gr&Ltr Email Inv.PrShop, Det&Gr&Ltr Email Inv&Gr&Ltr.Post, Det.Email Inv&Gr&Ltr.PrShop, Det.Email
585
GetDiscountTypeList
GetDiscountTypeList
This method returns the list of available discount types.
Input
Elements
Output
Name DiscountTypeId DiscountTypeName Type int string
-100
586
GetDiscountTypeList
Example
DiscountTypeId 0 1 DiscountTypeName Traffic only On all products
587
GetDistributorList
GetDistributorList
This method returns the list of available distributors.
Input
Elements None.
Output
Name DistributorId Name Type int string
-100
588
GetFeeAmountList
GetFeeAmountList
This method returns the list of available subscription fee types.
Input
Elements None.
Output
Name FeeAmountId FeeAmountDescription Type int string
-100
Example
FeeAmountId 0 FeeAmountDescription No fee
589
GetFeeAmountList
FeeAmountId 1 2
FeeAmountDescription Per account Per site
590
GetFeeExclusionList
GetFeeExclusionList
This method returns the list of available subscription fee exclusion options.
Input
Elements None.
Output
Name FeeExclusionId FeeExclusionName Type int string
-100
Example
FeeExclusionId 0 FeeExclusionDescription No exclusion
591
GetFeeExclusionList
FeeExclusionId 1 2
FeeExclusionDescription Covers call charges Waived if exceeds
592
GetFeePeriodicityList
GetFeePeriodicityList
This method returns the list of available subscription fee periodicity options.
Input
Elements None.
Output
Name FeePeriodicityId FeePeriodicityName Type int string
-100
Example
FeePeriodicityId 0 1 FeePeriodicityName Monthly Per invoice period
593
GetFMCCategoryList
GetFMCCategoryList
This method returns the list of available FMC contact categories.
Input
Elements None.
Output
Name CategoryId CategoryName Type int string
-100
594
GetFMCLocationList
GetFMCLocationList
This method returns the list of available FMC locations.
Input
Elements None.
Output
Name LocationId LocationName Type int string
-100
Example
LocationId 0 1 LocationName Mobile Company Phone
595
GetFMCLocationList
LocationId 2 3 4 5 6 7 8 9 10
LocationName Direct Phone Company Fax Direct Fax Home Phone Home Fax Custom Phone 1 Custom Phone 2 Custom Phone 3 Custom Phone 4
596
GetGenderList
GetGenderList
This method returns the list of available genders.
Input
Elements
Output
Name GenderId GenderName Type int string
-100
597
GetGenderList
Example
GenderId -1 0 1 GenderName Undefined Male Female
598
GetInitiatorList
GetInitiatorList
This method returns the list of available reload initiator options.
Input
Elements
Output
Name InitiatorId InitiatorDescription Type int string
-100
599
GetInitiatorList
Example
InitiatorId 0 2 5 9 10 15 20 21 InitiatorDescription NT User SQL User Web User RTM DEM CLI or Pin IP address MSISDN number
600
GetLanguageList
GetLanguageList
This method returns the list of available languages.
Input
Elements None.
Output
Name LanguageId LanguageName IsBase Type int string int
-100
601
GetLanguageList
Example
LanguageId 1 2 3 4 LanguageName EN FR NL DE IsBase 1 0 0 0
602
GetMessagesList
GetMessagesList
This method returns the list of available messages.
Input
Elements None.
Output
Name MessageId MessageDescription Type int string
-100
603
GetMinCarrierQualityList
This method returns the list of available minimum carrier quality options.
Input
Elements
Output
Name MinCarrierQualityId MinCarrierQualityDescription Type int string
-100
604
Example
MinCarrierQualityId 0 50 100 MinCarrierQualityDescription Normal Normal Premium
605
GetNumberCategoryList
This method returns the list of available CLI/PIN categories.
Input
Elements None.
Output
Name NumberCategoryId NumberCategoryDescription Type int string
-100
Example
NumberCategoryId 0 1 NumberCategoryDescription PIN CLI
606
NumberCategoryId 2 3 4
NumberCategoryDescription Voucher PIN Master Referring CLI
607
GetOperatorList
GetOperatorList
This method returns the list of available operators.
Input
Elements None.
Output
Name OperatorId OperatorName OperatorFullName CSC Default Type int string string string int
-100
608
GetPaymentMethodList
This method returns the list of available payment methods.
Input
Elements
Output
Name PaymentMethodId PaymentMethodName Type int string
-100
609
Example
PaymentMethodId 0 2 3 4 5 1 1 12 13 14 15 21 22 23 24 25 PaymentMethodName Bank Direct Debit D.D.not yet accepted Dir.Deb.refused D.D.Suspended Visa MasterCard American Express Diners Club EuroCard Visa refused MasterC.refused Am.Expr.refused Din.Club refused EuroCard refused
610
GetPaymentTypeList
GetPaymentTypeList
This method returns the list of available payment types.
Input
Elements
Output
Name PaymentTypeId PaymentTypeDescription Type int string
-100
61 1
GetPaymentTypeList
Example
PaymentTypeId 0 1 10 1 1 12 13 20 21 25 PaymentTypeDescription <Not defined> Voucher PIN Auto topup Free Auto topup Auto topup (AxisC3) Auto topup (EzGate) Ogone EZSwitch Initial load
612
GetPinOnInvoiceList
GetPinOnInvoiceList
This method returns the list of available contact-level ID on invoice options.
Input
Elements
Output
Name PinOnInvoiceId PinOnInvoiceName Type int string
-100
613
GetPinOnInvoiceList
Example
PinOnInvoiceId 0 1 2 3 4 5 PinOnInvoiceName None Serial no CLI/PIN Name Alternative National ID
614
GetPrintGraphList
GetPrintGraphList
This method returns the list of available graph printing options for invoices and commission notes.
Input
Elements None.
Output
Name PrintGraphId PrintGraphName Type int string
-100
Example
PrintGraphId 0 1 PrintGraphName No graph Calls of invoice
615
GetPrintGraphList
PrintGraphId 2 3
PrintGraphName All invoiced calls All calls
616
GetPrintingAddresseeList
This method returns the list of available addressee printing options for invoices and commission notes.
Input
Elements
Output
Name PrintAddresseeId PrintAddresseeName Type int string
-100
617
Example
PrintAddresseeId 0 1 2 PrintAddresseeName Contact only Name only Both
618
GetProfileCLIPinList
GetProfileCLIPinList
This method returns the list of available CLI/PIN profiles for CLIs/PINs of category Pin or VoucherPin.
Input
Elements None.
Output
Name PinVoucherPinProfileId PinVoucherPinProfileDescription Type int string
-100
619
GetReloadSubTypeList
This method returns the list of subtypes of a particular reload type.
Input
Elements
Name ReloadTypeId LanguageId Values GetReloadTypeList (page 621) 0 = English 1 = French Type int int Mandatory No No
Output
Name ReloadSubTypeId ReloadSubTypeDescription Type int string
-100
620
Example
In case of a standard Artilium database, if both the LanguageId element and the ReloadTypeId element are omitted from the SOAP request, then ItemInfo will contain the following table.
ReloadSubTypeId 0 100 101 102 103 104 105 106 200 201 400 401 402 500 501 502 600 ReloadSubTypeDescription <Not defined> Add Import (add) Update Import (update) Change credit Update mass Remove credit (Termination) Add Credit Remove credit (Termination) Add CLI Update CLI Remove credit (Termination) Add credit Add credit other Remove credit (Termination) Pre-provisioning
621
GetReloadTypeList
GetReloadTypeList
This method returns the list of available reload types.
Input
Elements
Output
Name ReloadTypeId ReloadTypeDescription Type int string
-100
622
GetReloadTypeList
Example
ReloadTypeId 0 1 2 3 4 5 6 ReloadTypeDescription <Not defined> Switch Administrator SMS Web service IVR Partner Card
623
GetRequestCPSList
GetRequestCPSList
This method returns the list of available CPS request statuses.
Input
Elements
Output
Name RequestCPSId RequestCPSDescription Type int string
-100
624
GetRequestCPSList
Example
RequestCPSId 0 1 2 3 4 5 6 RequestCPSDescription No CPS Request incomplete Req.complete, form OK Req.made, not yet activated Presel.partially installed Presel.fully installed Client cancelled preselection
625
GetSalesPointList
GetSalesPointList
This method returns the list of salespoints of a particular distributor.
Input
Elements
Name DistributorId Values GetDistributorList (page 587) Type int Mandatory Yes
Output
Name SalesPointId Name Type int string
-100
626
GetRoundingList
GetRoundingList
This method returns the list of available CLI/PIN rounding methods.
Input
Elements None.
Output
Name RoundingId RoundingDescription Type int string
Code 0 -90 -91 Description OK Authentication failed Field overflow Too many characters Date out of range Unspecified error
-100
Example
RoundingId 1 RoundingDescription <Money>
If the Rounding field of a Pin record is set to <Money>, then the duration of every call made using the CLI/PIN in question will be rounded according to system setting 92 (Call cost truncating).
627
GetSolvencyStatusList
This method returns the list of available solvency status options.
Input
Elements
Output
Name SolvencyStatusId SolvencyStatusName Type int string
-100
628
Example
SolvencyStatusId 0 1 2 SolvencyStatusName Undefined OK Not OK
629
GetStatusList
GetStatusList
This method returns the list of available CLI/PIN statuses.
Input
Elements None
Output
Name StatusId StatusDescription Type int string
-100
630
GetStatusList
Example
StatusId 0 1 3 StatusDescription Blocked Active Suspended
631
GetTableKeyList
GetTableKeyList
This method returns the list of available database table keys.
Input
Elements None.
Output
Name TableKeyId TableKeyDescription Type int string
-100
Example
TableKeyId 0 1 TableKeyDescription General CLI/PIN
632
GetTableKeyList
TableKeyId 2 3 4 5 6 7 10 1 1 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
TableKeyDescription Cost matrix Shortcode Commission plan Product Customer product Price modifier Number portability Destination DID/CLI DID Fraud Routing table Report definition Report runtime User account Import/export scheme Cost matrix profile Contact profile CLI/PIN profile Data exch. definition Data exch. runtime Voice message Currency Language Document text Country prefix Country ZIP code Parameter defintion Parameter set Operator Region Traffic type Timezone NTS base table Invoice Commission node Bonus
633
GetTableKeyList
TableKeyId 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
TableKeyDescription Contact Qualif. points System settings Bug tracing Conversion code Promotion Customer promotion Document template Contact document Pr. variat. - Product Pr. variat. - Pod. pr. Pr. variat. - Cust. pr. Pr. variat. - CLI/PIN Pr. variat. - Global Obvious PIN sequences Distributor CDR Pr. variat. - Customer Task MGC - IAD MGC - MGC Abbr. num. Company Abbr. num. Extension Abbr. num. Group Custom replication Mobile - SIM Mobile - IMSI Mobile - MSISDN Package Customer package CLI/PIN package External transaction Reload history Call mode Extension Rerating Bundle
634
GetTaxationMethodLegAList
This method returns the list of available A-leg taxation methods.
Input
Elements None.
Output
Name TaxationMethodLegAId TaxationMethodLegADescription Type int string
-100
Example
TaxationMethodLegAId 0 1 TaxationMethodLegADescription Conversation time PTT time if answer B
635
TaxationMethodLegAId 2 3 4
TaxationMethodLegADescription PTT time PTT time if answer B or no setup B PTT time if no setup B
636
GetTaxationMethodLegBList
This method returns the list of available B-leg taxation methods.
Input
Elements None.
Output
Name TaxationMethodLegBId TaxationMethodLegBDescription Type int string
-100
Example
TaxationMethodLegBId 0 TaxationMethodLegBDescription Conversation time
637
TaxationMethodLegBId 1 2
TaxationMethodLegBDescription Network time if answer B PTT time if answer B
638
GetTitleList
GetTitleList
This method returns the list of available contact titles.
Input
Elements
Name LanguageId Values GetLanguageList (page 600) Type int Mandatory No
Output
Name TitleContactId TitleContactName Type int string
-100
639
GetTitleList
Example
In case of a standard Artilium database, if the LanguageId element is set to 2 (i.e. French), then ItemInfo will contain the following table.
TitleContactId -1 0 1 TitleContactName --Monsieur Madame
640
GetTrafficTypeList
GetTrafficTypeList
This method returns the list of available traffic types.
Input
Elements None.
Output
Name TrafficId Description Traffic Type int string string
-100
641
GetTrafficTypeList
Example
TrafficId 1 2 3 4 5 6 Description Voice phone calls General Packet Radio Service Place call Conferencing Short Messaging Service Instant Messaging Traffic VOICE GPRS PLACE CONF SMS IM
642
GetTypeList
GetTypeList
This method returns the list of available CLI/PIN types.
Input
Elements None.
Output
Name TypeId TypeDescription Type int string
-100
Example
In case of a standard Artilium database, ItemInfo will contain the following dataset.
TypeId 0 1 TypeDescription Normal Prepaid
643
GetTypeList
TypeId 2 3 4
TypeDescription Debet Personal Postpaid
644
GetUseAlternativeList
This method returns the list of available CLI/PIN-level ID on invoice options.
Input
Elements
Output
Name UseAlternativeId UseAlternativeName Type int string
-100
645
Example
UseAlternativeId 0 1 2 3 4 5 UseAlternativeName Same as customer Serial no CLI/PIN Name Alternative code National ID
646
GetVATFrequencyList
GetVATFrequencyList
This method returns the list of available VAT frequency options.
Input
Elements
Output
Name FactureTimingId FactureTimingName Type int string
-100
647
GetVATFrequencyList
Example
VATFrequencyId 0 1 2 3 9 VATFrequencyName Daily Weekly Twice a month Monthly <Disabled>
648
GetVATRateList
GetVATRateList
This method returns the list of available VAT rate options.
Input
Elements
Output
Name VATRateId VATRateName Type int string
-100
649
GetVATRateList
Example
VATRateId 0 1 2 3 4 5 10 20 VATRateName Normal Co-contract IntraCom Export Not submitted Exempt Private Anonymous
650
Logging
Chapter 27:
Logging
In this chapter, you will find a detailed description of all methods contained in the Logging web service. This web service allows you to manage the user logs.
Web method AddLogging GetLoggingList Page 651 652
651
AddLogging
AddLogging
This method adds a log record.
Input
Elements
Name AccountType Account TableType TableKey Command Value ChangedValues GetTableKeyList Description GetAccountTypeList Type int string(64) int string(64) string(512) string(512) string(4096) Mandatory Yes Yes Yes No No No No
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the log record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
-100
652
GetLoggingList
GetLoggingList
This method returns a (filtered) list of log records.
Input
Elements In the table below, the elements marked with X in the Filter column are optional filter criteria. In the ones of type string, you can use the % wildcard character.
Name From Till AccountType Account TableType TableKey PageIndex PageSize SortBy SortOrder 0=ASC, 1=DESC 0=Page 1, 1=Page 2, ... GetTableKeyList GetAccountTypeList Description Filter X X X X X X Type dateTime dateTime int string(64) int string(64) int int int int Mandatory No No No No No No Yes Yes Yes Yes
Output
Name LogId Date AccountType Account TableType TableKey Type int dateTime unsignedByte string unsignedByte string
653
GetLoggingList
Name Command Value Changed
Type string string string
-100
654
System setting
Chapter 28:
System setting
In this chapter, you will find a detailed description of all methods contained in the System Setting web service.
Web method GetSystemSetting Page 655
655
GetSystemSetting
GetSystemSetting
This method retrieves a system setting.
Input
Elements
Name SystemSettingId Type int Mandatory Yes
Output
Name SettingId Description Value TextValue DefaultTextValue Mandatory SettingsType SettingsCategory Hint ComboQuery Type int string decimal string string int int int string string
Code 0 -1 Description OK SystemSettingId not found
656
GetSystemSetting
Code -90 -91
-100
657
LCMPinInfo
Chapter 29:
LCMPinInfo
In this chapter, you will find a detailed description of all methods contained in the LCMPinInfo web service. This web service allows you to manage the LCM data stored for a CLI/PIN in the LCMPinInfo table when Lifecycle Management is enabled (system setting 426).
Web method AddLCMPinInfo DeleteLCMPinInfo GetLCMPinInfobySN UpdateLCMPinInfo Page 658 659 660 661
658
AddLCMPinInfo
AddLCMPinInfo
This method adds an LCMPinInfo record in the database. These records store lifecycle data for existing CLI/PINs in the PinInfo table.
Input
Elements
Name SN (-> existing SN in PinInfo) ManualMovement DisableReactivation LastActivity Type string boolean boolean dateTime Mandatory Yes No No No
Output
The method will return a complex type called ResultInsertNumber, containing: a string called SN, and an integer called Result. SN If Result contains 0, then SN will contain the serial number of the LCMPinInfo that was added. If Result contains an integer other than 0, then SN will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -1 -2 -90 -91 Description OK Unique key exception SN does not exist in PinInfo Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
659
DeleteLCMPinInfo
DeleteLCMPinInfo
This method deletes an LCMPinInfo record from the database.
Input
Elements
Output
Code 0 -3 -90 -91 Description OK SN does not exist in LCMPinInfo Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
660
GetLCMPinInfobySN
GetLCMPinInfobySN
This method retrieves all relevant data of an LCMPinInfo record from the database.
Input
Elements
Name SN (-> existing SN in PinInfo) Type string(32) Mandatory Yes
Output
Name SN ManualMovement DisableReactivation LastActivity StatusModified Type string boolean boolean dateTime dateTime
-100
661
UpdateLCMPinInfo
UpdateLCMPinInfo
This method updates an LCMPinInfo record in the database.
Input
Elements
Name SN (-> existing SN in PinInfo) ManualMovement DisableReactivation LastActivity StatusModified Type string boolean boolean dateTime dateTime Mandatory Yes No No No No
Output
-100
662
External Billing Reference
Chapter 30:
External Billing Reference
In this chapter, you will find a detailed description of all methods contained in the ExternalBillingReference web service.
Web method GetExternalBillingReferenceById GetExternalBillingReferenceList Page 663 665
663
GetExternalBillingReferenceById
This method retrieves a record from the External Billing Reference table. This table is read-only and contains details about third-party service providers. The ReferenceId of the corresponding EBR record is included as a reference in the CDRs of premium sessions. See GetCDRList2 (page 236).
Input
Elements
Name Id Type long Mandatory Yes
Output
Name Id ExternalReferenceId Description Number Status Direction Traffic type SetupCost SetupThreshold MinimumCost MinimumDuration NormalCost NormalDuration Vat VatIncluded Type long string string string list complex complex decimal int decimal int decimal int decimal int
664
Name ReferenceDetails ContentProviderName CustomerCareContactDetail CustomerCareUrl StartDate EndDate
Type string string string string date/time date/time
Code 0 -1 -90 -91 Description OK ReferenceId does not exist Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
665
GetExternalBillingReferenceList
This method returns a list of records from the External Billing Reference table.
Input
Elements
Name ExternalBillingReferenceId Number Type string string Mandatory No No
Output
The method will return a complex type called ResultGetItem, containing a dataset called ItemInfo, an integer called Result and an integer called TotalItems. ItemInfo If Result contains 0, then ItemInfo will contain a table with the following columns:
Name Id ExternalReferenceId Description Number Status Direction Traffic type SetupCost SetupThreshold MinimumCost MinimumDuration NormalCost NormalDuration Vat VatIncluded Type long string string string list complex complex decimal int decimal int decimal int decimal int
666
Name ReferenceDetails ContentProviderName CustomerCareContactDetail CustomerCareUrl StartDate EndDate
Type string string string string date/time date/time
-100
667
DocText
Chapter 31:
DocText
In this chapter, you will find a detailed description of all methods contained in the DocText web service.
Web method GetDocumentText GetDocumentTextList AddDocumentText DeleteDocumentText UpdateDocumentText Page 668 669 670 671 672
668
GetDocumentText
GetDocumentText
This method retrieves a record from the DocText table in a specified language.
Input
Elements
Name Key LanguageId Type string int Mandatory Yes Yes
Output
Name Id Key LanguageId Text Type int string int string
Code 0 -2 -90 -91 Description OK Document text with specified key and language is not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
669
GetDocumentTextList
GetDocumentTextList
This method returns a list of records from the DocText table, that are linked to an overall bundle.
Input
Elements
Name Type Mandatory
Output
The method will return a complex type called ResultGetList, containing a dataset called ListInfo, an integer called Result and an integer called TotalItems. ListInfo If Result contains 0, then ListInfo will contain a table with the following columns:
Name Id Key LanguageId Text Type int string int string
-100
670
AddDocumentText
AddDocumentText
This method adds a document text record in the database.
Input
Elements
Name Key LanguageId Text Type string int string Mandatory Yes Yes Yes
Output
The method will return a complex type called ResultInsertItem, containing: a string called NewItemId, and an integer called Result. NewItemId If Result contains 0, then NewItemId will contain the ID of the document text record that was added. If Result contains an integer other than 0, then NewItemId will be empty. Result The integer Result will contain one of the following return codes:
Code 0 -2 -3 -4 -90 -91 Description OK LanguageId is not found No key or text is configured for the document text A document text with the specified key and languageId already exists Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
671
DeleteDocumentText
DeleteDocumentText
This method deletes a document text. Beware not to delete document texts related to bundle notifications, service usage monitoring or marketing actions.
Input
Elements
Name DocTextId Type int Mandatory Yes
Output
Code 0 -2 -90 -91 Description OK DocTextId is not found Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
672
UpdateDocumentText
UpdateDocumentText
This method updates a document text record.
Input
Elements
Name DocTextId Text Type int string Mandatory Yes Yes
Output
Code 0 -2 -3 -90 -91 Description OK DocTextId is not found No text is configured for the document text Authentication failed Field overflow Too many characters, Date out of range, ... Unspecified error
-100
673
Porting
Chapter 32:
Porting
In this chapter, you will find a detailed description of all methods in the Porting web service. Note that these APIs support the Dutch number porting workflow.
Web method PortInRequest GetAvailablePortInMsisdns GetPendingPortIns CancelPortIn GetPendingPortOuts AcceptPortOut RejectPortOut Page 674 676 678 680 681 683 684
674
PortInRequest
PortInRequest
This method initiates a new port-in request for a CLI, or restart a port-in request that has previously failed. A port-in request for a CLI/PIN can be re-initiated if the MNP Status Port In parameter (ID: 20515) of that CLI/PIN is Port in Rejected, Port in Canceled or Ported in.
Input
Elements
Name SN Description Serial number (not padded) of an existing CLI/PIN in the reseller database for which a port-in request is initiated. Get SNs of valid CLI/PINs via GetAvailablePortInMsisdns Code identifying the Network operator and Service operator of the number to be ported in. Use the service operator codes from parameter definition 20500, e.g. BEN-ARTA The SIM attached to the MSISDN to be ported in (8-19 digits) Contract type at the donor operator side: 0 = Prepaid 1 = Postpaid Only if CustomerType = 1, specify Account number The MSISDN to be ported in (1 digits) 1 Wish date (weekday, at least 5 business days in future) Type of customer at the donor operator side: 0 = Residential 1 = Business Type string Mandatory Yes
DonorOperator
string
Yes
SimCardNumber PortingType
string int
Yes Yes
AccountNumber MsisdnNumber PortInWishDate CustomerType
string string string int
Yes Yes Yes Yes
Output
The method will return an integer called Result:
Result 0 -1 -2 -3 -4 -5 Description Port-in request was initiated successfully. SN does not exist SN is required One or more mandatory parameters are missing.
675
PortInRequest
Result -6 -7 -8 -9 -10 -1 1 -12 -13 -14 -15 -16 -90 -91 -100
Description CustomerType invalid PortInWishDate invalid: should be a weekday, at least 5 business days in future PortingType invalid Network status of CLI/PIN not valid MsisdnNumber already exists in reseller database Port-out in progress for CLI/PIN Port-in in progress for CLI/PIN DonorOperator invalid MsisdnNumber invalid SimCardNumber invalid AccountNumber invalid Authentication failed Field overflow (too many characters, date out of range) Unspecified error
676
GetAvailablePortInMsisdns
This method returns the pre-provisioned or (pre-)activated CLI/PINs of a contact. The properties of these CLI/PINs are as follows:
Level CLI/PIN Property Network status CPS Activation Until date Parameter 20515 (port-in status) Parameter 20512 (port-out status) MSISDN IMSI SIM Status Status Status Pre-provisioned Created (1) Activated Activated (2)
Not Activated (0), Activated (1), or Wait for PRF (2) Blank or future expiration date Blank, Port in Canceled (3), Port in Exec Rejected (7), or Port in Rejected (8) Blank, Port out Canceled (20), Port out Exec Reject (16), or Port out Rejected (12) Assigned (3), or Active (6) Sent (3), or Active (5) Warehouse (1), or Active (5)
Depending on operator requirements, the CLI/PINs returned by this method can be used to initiate port-in requests (Porting service > PortInRequest).
Input
Elements
Name ContactId Description Id of contact for which to return valid CLI/PINs -1 = orphan CLI/PINs -2 = all contacts Full number or prefix to filter list of returned MSISDNs Wildcards not supported! Type of CLI/PINs to be returned: 0 = Activated and Pre-provisioned 1 = Activated 2 = Pre-provisioned Max. number of CLI/PINs to be returned Type int Mandatory Yes
MSISDNNr
string
No
Status
int
No
MaxResultSet
string
No
677
Output
The method will return a complex type called ResultGetList, containing an integer called Result, a dataset called ListInfo, and an integer called TotalItems. Result The integer Result will contain one of the following return codes:
Code 0 -1 -90 -91 -100 Description OK ContactId not found Authentication failed Field overflow (too many characters, date out of range) Unspecified error
ListInfo If Result contains 0, then ListInfo will contain the valid CLI/PINs of the contact, each with the following data:
Name PortSubscriber PinData SN CLI ContactData ContactId Name ParentId Reference IMSI SIM MSISDN Parameters ParameterId ParameterValue Type dataset dataset string string dataset int string string string string string string dataset int string
If Result contains an integer other than 0, then ListInfo will contain NULL. TotalItems The integer TotalItems will contain the total number of records in the ListInfo dataset.
678
GetPendingPortIns
GetPendingPortIns
This method returns the port-in requests that are in progress for the CLI/PINs of a contact. Port-ins in progress are requests that have not reached the state Ported In. The list that is returned includes the MNP parameter settings per CLI that is being ported in!
Input
Elements
Name ContactId MaxResultSet Description Id of contact for which to return port-ins Max. number of port-ins to be returned Type int string Mandatory Yes No
Output
679
GetPendingPortIns
ListInfo If Result contains 0, then ListInfo will contain the port-ins in progress for the CLIs of the specified contact, each with the following data:
Name PortingId PortSubscriberList PinData SN CLI ContactData ContactId Name ParentId Reference IMSI SIM MSISDN Parameters ParameterId ParameterValue Type string dataset dataset string string dataset int string string string string string string dataset int string
680
CancelPortIn
CancelPortIn
This method allows to cancel the port-in of a CLI/PIN. Only the port-in requests with status Port-in requested (4), Port-in pending (5) and Port-in accepted up to 4 days before the wish date (25) can be canceled. The status of a port-in request for a CLI/PIN is kept in parameter 20515.
Input
Elements
Name SN Description Serial number of the CLI/PIN for which the port-in request has to be canceled. Type string Mandatory Yes
Output
Result 0 -1 -2 -3 -4 -5 -6 -7 -90 -91 -100 Description Port-in request was canceled successfully. SN does not exist SN is required No port-in request found for this SN Port-in request status invalid Could not delete task and job for this Port-in request Handling of previous jobs failed because of invalid job count The request cannot be canceled. The wish date should at least be 4 days in the future. Authentication failed Field overflow (too many characters, date out of range) Unspecified error
681
GetPendingPortOuts
GetPendingPortOuts
This method returns the port-out requests that are in progress for the CLI/PINs of a contact. Port-outs in progress are requests that have not reached the state Ported Out. The list that is returned includes the MNP parameter settings per CLI that is being ported out!
Input
Elements
Name ContactId MaxResultSet Description Id of contact for which to return port-outs Max. number of port-outs to be returned Type int string Mandatory Yes No
Output
682
GetPendingPortOuts
ListInfo If Result contains 0, then ListInfo will contain the port-outs in progress for the CLIs of the specified contact, each with the following data:
Name PortingId PortSubscriberList PinData SN CLI ContactData ContactId Name ParentId Reference IMSI SIM MSISDN ParameterData ParameterId ParameterValue Type string dataset dataset string string dataset int string string string string string string dataset int string
683
AcceptPortOut
AcceptPortOut
This method accepts a port-out request.
Input
Elements
Name PortingId Description Unique NPR number of port-out request Stored in parameter 2051 1 Type string Mandatory Yes
Output
Result 0 -2 -3 -4 -5 -6 -90 -91 -100 Description Port-out request was accepted successfully. No Pins are found with this PortingId PortingId exists, but the status of request is not valid for accept Pin can not be null No PortOut in progress for this SN Parameter 20519 (Port Out lead CLI/PIN) not found Authentication failed Field overflow (too many characters, date out of range) Unspecified error
684
RejectPortOut
RejectPortOut
This method rejects a port-out request (single and multiple!).
Input
Elements
Name PortingId Description Unique NPR number of port-out request Stored in parameter 2051 1 SN with reason why port-out request should be rejected. This element may contain multiple items in case of port-out of multiple CLI/PINs of a contact! Type string Mandatory Yes
RejectPorting
complex
Yes
In the RejectPorting element, add an item for each CLI/PIN for which the port-out has to be rejected:
Name SN RejectId Description The SN for which the port-out request was rejected. One of the reject codes. See Network Provisioning User Guide. Specify reason in case RejectId is 99 (= Other) Specify new wish date in case RejectId is 61 or 63 Type string int Mandatory Yes Yes
Reason Extra
string string
No No
Output
Result 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 Description Port-out request was rejected successfully. At least one SN is required This RejectId is not supported This RejectId requires a wish date This RejectId requires a reason No Pins are found with this PortingId to reject The RejectItems could not be found for this PortingId No PortOut in progress for this SN Parameter Portout for SN has invalid state to reject The wish date is not valid
685
RejectPortOut
Result -90 -91 -100
Description Authentication failed Field overflow (too many characters, date out of range) Unspecified error
686
Field lists
Appendix A:
Field lists
In this chapter, you will find an overview of all database table fields of which the contents can be manipulated by means of the web service APIs described in this reference guide.
Section Contact CLI/PIN Page 687 690
687
Contact
Contact
Below, you will find an overview of all fields managed by the ContactType1 web service, and the ContactType2 web service.
Field overview
The following table lists all contact fields. It allows you to find out instantly which field is used in which web method. According to the column (CT1 or CT2) in which they are placed, the letters A, U, G, and L stand for: AddContactType1 or AddContactType2 UpdateContactType1 or UpdateContactType2 GetContactType1 or GetContactType2 GetContactType1List or GetContactType2List Example: In both the CT1 and CT2 columns of the field Reference, you notice AUGL. This means, that for both contacts of type 1 and contacts of type 2 you can add this field by means of the Add... method, update this field by means of the Update... method, retrieve this field by means of the Get... method, and filter on this field in the Get...List method.
Name ContactType1Id / ContactType2Id Name ParentId BillFrom BillUntil Reference ILECCLEC ILECCLECExpiration FirstName LastName Street City CountryId Phone Fax URL Mobile Email Gender ZIPCode Number LanguageId CT1 CT2 Type int string(80) int dateTime dateTime string(20) string(32) dateTime string(50) string(80) string(80) string(80) int string(32) string(32) string(127) string(33) string(80) int string(10) string(10) int
PRIMARY KEY AUGL AUGL AUG AUG AUGL AUG AUG AUG AUG AUGL AUGL AUG AUG AUG AUG AUG AUGL AUG AUG AUG AUG AUGL AUGL AUG AUG AUGL AUG AUG AUG AUG AUGL AUGL AUG AUG AUG AUG AUG AUGL AUG AUG AUG AUG
688
Contact
Name Title RecruitedByParent OperatorId InvoiceOnParent CurrencyId VATRate VATNumber DiscountPct Frequency FirstDay SecondDay TermsOfPayment PrintSortcode PrintDispatch PrintAdressee CommissionPlanId DiscountType SeperateInvoicePeriod NoInvoiceBelow AlwaysInvoiceAbove IdOnInvoice Graph DaysGraph PrintCallDetailsList Supplement VATRatePct FeeType Periodicity Exclusion FeeAmount VATPct ExclAmount ExtraComPct UserId Password MailingList TotalVisits LastVisit
CT1 AUG AUG
CT2 AUG AUG AUG
Type int int int short int int string(32) decimal(15,2) short short short short string(10) int int int
AUG AUG AUG AUG
AUG AUG AUG AUG AUG
AUG AUG AUG AUG AUG AUG AUG AUG
AUG AUG AUG AUG AUG AUG AUG
AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUGL AUG AUG G G AUGL AUG AUG G G
int int decimal(15,2) decimal(15,2) int int int short decimal(20,6) decimal(15,2) int int int decimal(20,6) decimal(15,2) decimal(20,6) decimal(15,2) string(50) string(50) string(50) int dateTime
689
Contact
Name TotalVisitsLastOddMonth LastVisitOddMonth TotalVisitsLastEvenMonth LastVisitEvenMonth LastVisitIP LastUpdateIP Classification DateofBirth PaymentMethod PaymentNumber PaymentName PaymentCardExpiration SolvencyStatus SolvencyLimit SolvencyGranted DefaultCLIPINProfile EnforceCLIPIN MasterProfile EnforceMaster RecordCreated RecordLastUpdate UserCreated
CT1 G G G G G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
CT2 G G G G G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G G
Type int dateTime int dateTime string(20) string(20) int dateTime short string(80) string(80) string(6) int decimal(20,6) dateTime int int int int dateTime dateTime string
AUG
AUG
690
CLI/PIN
CLI/PIN
Below, you will find an overview of all fields managed by the Master web service, the CLI web service, the ReferringCLI web service, the Pin web service, and the VoucherPin web service.
Field overview
The following table lists all CLI/PIN fields. It allows you to find out instantly which field is used in which web method. According to the column (Master, CLI, ReferringCLI, Pin, or VoucherPin) in which they are placed, the letters A, U, G, stand for: AddMaster, AddCLI, AddReferringCLI, AddPin, or AddVoucherPin UpdateMaster, UpdateCLI, UpdateReferringCLI, UpdatePin, or UpdateVoucherPin GetMaster, GetCLI, GetReferringCLI, GetPin, or GetVoucherPin Moreover, the GFLN column also shows you which fields are used as input or output in the method GetFilteredListOfNumbers of the ContactType2 web service.
Referring CLI Voucher Pin
Name SN MasterNumber (Cat=3) CLI (Cat=1) ReferringCLI (Cat=4) Pin (Cat=0) VoucherPin (Cat=2) CompleteNumber PinCLIAttached NationalId CustomerName Status SecretCode Master BatchNumber ContactType2Id DivisionId Type CallBackNumber OutgoingCLI OperatorId CSC
Master
CLI
Pin
GFLN In/Out In/Out
Type string(32) string(32) string(16)
PRIMARY KEY G AUG AUG AUG AUG G AUG AUG AUG AUG AUG AG AUG AG AUG AUG AUG AUG AUG AUG AUG AG AUG AG AUG AUG AUG AUG AUG G AG AUG AG AUG AUG AUG AUG AG AUG AG AUG AUG AUG AUG AG AUG AG AUG AUG AUG AUG
string(16) string(16) string(16) string(32) string(32) string(32) In/Out In/Out string(31) short string(16) In/Out string(32) string(16) In int int short string(32) string(32) int Out string(6)
691
CLI/PIN
Name ActivationCPS StatusCPS DateCPSStatus DateCPSSigned Address1 Address2 ZipCode City Country PaymentMethod PaymentNumber PaymentIssueCode PaymentCardExpiration ContactName ContactTelephone ContactFax Email Gender DateOfBirth MailingList DistributorId SalesPointId DateRangeFrom DateRangeUntil MaxValidityDays MaxValidityCalls Monday Tuesday Wednesday Thursday Friday Saturday Sunday MonFromDayhhmm TueFromDayhhmm WedFromDayhhmm ThuFromDayhhmm
Master AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
CLI AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Referring CLI
Pin AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Voucher Pin
GFLN
Type int int dateTime dateTime string(31) string(31) string(15) string(31) string(31) int string(31) string(15) string(15) string(31) string(31) string(31) string(50) int dateTime string(50) int int
AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Out Out
dateTime dateTime short int boolean boolean boolean boolean boolean boolean boolean short short short short
692
CLI/PIN
Name FriFromDayhhmm SatFromDayhhmm SunFromDayhhmm MonUntilDayhhmm TueUntilDayhhmm WedUntilDayhhmm ThuUntilDayhhmm FriUntilDayhhmm SatUntilDayhhmm SunUntilDayhhmm UserId Password MaxTotalCredits MaxTotalCreditsPerDay MaxTotalCreditsPerWeek MaxTotalCreditsPerMonth MaxTotalSeconds MaxTotalSecondsPerDay MaxNumSecondsPerWeek MaxTotalSecondsPerMonth MinCreditToStartCall MinSecsToStartCall NumberOfUsers MaxNumberOfUsers DIDAcceptedRejected DIDAccepted DestinationsAcceptedRejected DestinationsAccepted Message1 Message2 Message3 Message4 PublicityFile LanguageId AnnounceAvailableCreditsAmount AnnounceAvailableCreditsCents AnnounceAvailableCreditsMinutes
Master AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
CLI AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Referring CLI
Pin AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Voucher Pin AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
GFLN
Type short short short short short short short short short short string(50) string(50)
AUG
decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int
AUG
decimal(20,6) short short short boolean string(31) boolean string(63) int int int int string(33) short int short int
693
CLI/PIN
Name OffNetPrefix OnNetPrefix GivePulses SecondPinAllowedDuringCall RedialAllowedDuringCall OnlyCallBack CallBackForRoaming OnlyShortCode RingBackTone EnableHelpDesk HelpDeskAmountCharged PinChargeable PinDigitsChargeable DTMFConnect CostTableLegA MasterTableLegA CostTableLegB MasterTableLegB TaxationMethodLegA TaxationMethodLegB FreeDestination FreeSeconds UsedFreeSeconds TrafficTypeId MinCarrierQuality Reduction Rounding CurrencyId RoundDuration RoundDurationSeconds DisconnectCallUntilRoundedDur MinimumSecsCallToCharge MaxNumSecondsPerCall DetailOnInvoice IdOnInvoice AlternativeCode MaxNumFreeRecharges
Master AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G G G G AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
CLI AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G G G G AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Referring CLI
Pin AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G G G G AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Voucher Pin
GFLN
Type string(16) string(16) int boolean boolean boolean boolean boolean boolean boolean decimal(20,6) boolean short string(32)
G G G G AUG AUG
short short short short short short string short short int int short short
AUG
short boolean short boolean short short boolean short string(32)
AUG
short
694
CLI/PIN
Name FreeRechargeAmount FreeRechargeIsPercentage ActualNumFreeRecharges MaxNumManualRecharges ActualNumManualRecharges LastManualRechargeValue LastManualRechargeTime AutoTopupAmount MaxNumAutoTopup ActualNumAutoTopup AutoTopupPaylimit AutoTopupActive FreeTopupEveryXTimes BankVerification ShortcodeReference DestReference DIDReference InvoiceReference RouteGroup CountryGroup LastHiddenChargeTime SpecialChargeWeekly SpecialChargeMonthly SpecialChargeMonday SpecialChargeTuesday SpecialChargeWednesday SpecialChargeThursday SpecialChargeFriday SpecialChargeSaturday SpecialChargeSunday ExtraChargeDialin ExtraChargeNoAnswerBusy ExtraChargeAnswered MinimumCallsCLISpecialCharges MinimumCallsCLIReduction MinimumCallsCallSetupCost MinimumCallsCallSurcharge
Master AUG AUG G AUG G G G AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
CLI AUG AUG G AUG G G G AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Referring CLI
Pin AUG AUG G AUG G G G AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG G AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG AUG
Voucher Pin AUG AUG
GFLN
Type decimal(20,6) boolean short
AUG
short short decimal(20,6) dateTime
AUG AUG
decimal(20,6) short short
AUG AUG AUG AUG
decimal(20,6) boolean short boolean string(16) string(16) string(15) string(17) short short dateTime decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int
695
CLI/PIN
Name MinimumCallsCallReduction AdviceOfCharge CallCompletionOnBusy EnableConferenceBridge TotalCalls TotalOutgoingCalls TotalLostSeconds TotalAnsweredCalls FirstTimeUsed LastTimeUsed LastDestination RecordAdded LastUpdate NameUserLastUpdate TotalUsedCredits TotalUsedCreditsToday TotalUsedCreditsThisWeek TotalUsedCreditsThisMonth TotalUsedSeconds TotalUsedSecondsToday TotalUsedSecondsThisWeek TotalUsedSecondsThisMonth
Master AUG AUG AUG AUG G G G G G G G G G AUG G G G G G G G G
CLI AUG AUG AUG AUG G G G G G G G G G AUG G G G G G G G G
Referring CLI
Pin AUG AUG AUG AUG G G G G G G G
Voucher Pin
GFLN
Type int boolean boolean boolean int int int int
AUG AUG
dateTime dateTime string(32)
G G AUG
G G AUG G G G G G G G G
AUG AUG AUG G
dateTime dateTime string(15) decimal(20,6) decimal(20,6) decimal(20,6) decimal(20,6) int int int int

API 851 RefGuide 2011-09-12

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

API 851 RefGuide 2011-09-12

Uploaded by

Copyright:

Available Formats

API

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

About this guide

About this guide

Services & methods

API . Reference Guide

About this guide

API . Reference Guide

About this guide

Client/WebService communication This is how a client connects to the Artilium WebService:

API . Reference Guide

About this guide

SOAP request syntax

a contact profile for contacts of type 1,

API . Reference Guide

About this guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

Description GetConversionCodeList (VAT)

Type int string(32)

int int int int string(10)

GetConversionCodeList (Dispatch) GetConversionCodeList (PrintAddressee)

int int int string(50) string(50) string(50)

int string(80) string(80) string(6)

int decimal(20,6) dateTime string(30) string(20) complex

API . Reference Guide

API . Reference Guide

DeleteType has four possible values:

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

Name SolvencyGranted UserCreated

Type dateTime string

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

API . Reference Guide

Description GetConversionCodeList (VAT)

Type int string(32)

int int int int string(10)

GetConversionCodeList (Dispatch) GetConversionCodeList (PrintAddressee)

int int int string(50) string(50) string(50)

int string(80) string(80) string(6)

int decimal(20,6) dateTime string(30) string(20) complex

API . Reference Guide