TCF IPMS Technical Specification Document
Total Page:16
File Type:pdf, Size:1020Kb
Technical Specification for Industry Portability Management System Telecommunications Carriers' Forum Prepared by: Ken Julian & Allister Georgeson Application Services Global Delivery Jade Software Corporation 5 Sir Gil Simpson Drive, Burnside Christchurch 8053 Ph: +64 3 365 2500 Date Prepared: 24 Oct 2017 Technical Specification Project ID No.: NZ1-00232 Document Information Project Name: Industry Portability Management System Project Manager: Peter Smith (Jade) Document Version No: 4.19 Document Version Date: 21 February 2020 Prepared By: Edmond Tso (Jade) Preparation Date: 21 February 2020 Reviewed By: Denise Spiers (Jade) Review Date: Distribution Lists From Date Phone Application Services Global Delivery 29 August 2012 03 962 5700 To Action* Due Date Phone/Fax Rob Clarke – TCF PSWP Review * Action Types: Approve, Review, Inform, File, Action Required, Attend Meeting, Other (please specify) Version History Ver. No. Ver. Date Revised By Description Filename 0.1 26 Nov 2004 Rex Neville, Tony Verdellen Initial version for discussion at TCF IPMS Technical Technical Specification workshop Specification 0_1.doc 2/12/04 0.2 15 Dec 2004 Rex Neville, Tony Verdellen Updated version after discussion at TCF IPMS Technical Technical Specification workshop Specification 0_2.doc 2/12/04 0.3 11 Jan 2005 Rex Neville, Tony Verdellen Draft version including Web browser TCF IPMS Technical screens Specification 0_3.doc 1.0 01 Feb 2005 Rex Neville, Tony Verdellen First full version of specification TCF IPMS Technical Specification 1_0.doc 1.5 11 Mar 2005 Rex Neville, Tony Verdellen, Interim release – no HP internal TCF IPMS Technical Ralph Edinger quality review Specification 1_5.doc 2.0 15 Mar 2005 Rex Neville, Tony Verdellen, Second full version of specification TCF IPMS Technical Ralph Edinger Specification 2_0.doc 3.0 04 Apr 2005 Rex Neville, Tony Verdellen, Third full version of specification TCF IPMS Technical Ralph Edinger Specification 3_0.doc 4.0 07 Dec 2005 Rex Neville Updated for Change Request TCF IPMS Technical CR0003 - multiple Gaining Carriers Specification 4_0.doc and/or Losing Carriers per Port. 4.1 17 Feb 2006 Rex Neville Corrections after review of v4.0. TCF IPMS Technical Includes clarifications not related to Sepecification 4_1.doc CR0003 4.2 15 May 2006 Alan Monnox Updated to reflect changes in API TCF IPMS Technical WSDL. Specification 4_2.doc 4.2.1 12 Jun 2006 Alan Monnox Tech. Spec unchanged, document- NA wrapper version of WSDL released. 4.2.2 22 Jun 2006 Alan Monnox Version 4.2 accepted with wording TCF IPMS Technical change from TCF Specification 4_2.doc 4.3 16 Jul 2006 Tony Verdellen Changes for PCR004, PCR005, TCF IPMS Technical PCR009. Also correct minor Specification 4_3.doc specification errors identified during software development 4.3.1 28 Jul 2006 Alan Monnox Guidelines for API usage. Minor TCF IPMS Technical specification corrections. Specification 4_3.1.doc Page 2 of 237 Template (Version 1/25-Feb-2003) TCF IPMS Technical Specification 4_20 (002) Last changed: 21 February 2020 at 08:53 Technical Specification Project ID No.: NZ1-00232 Ver. No. Ver. Date Revised By Description Filename 4.3.2 21 Aug 2006 Rex Neville Minor specification corrections. TCF IPMS Technical Specification 4_3_2.doc 4.3.3 27 Sep 2006 Rex Neville Remove “urn:tcf:” from web service TCF IPMS Technical names. Minor specification Specification 4_3_3.doc corrections. 4.3.4 20 Oct 2006 Rex Neville Very small changes TCF IPMS Technical Specification 4_3_4.doc 4.4 29 Jan 2007 Aimee Hills, Rex Neville Changes for PCRs 11 and 12. TCF IPMS Technical Includes new web service API for Specification 4_4.doc downloading reports. Corrections for defects 678 882, 1763, 1774 4.5 24 May 2007 Mark Golebniak, Changes for PCRs 13, 15 and 17. TCF IPMS Technical Nick Foote, Also additional minor specification Specification 4_5.doc Rex Neville clarifications 4.6 20 July 2007 Mark Golebniak Changes for PCR 14 and 20 TCF IPMS Technical Specification 4_6.doc 4.7 21 Nov 2007 Andrew Doney Changes for PCR 26 TCF IPMS Technical Specification 4_7.doc 4.8 20 Feb 2008 Rex Neville PCR 31: Add Audit Details extract TCF IPMS Technical Specification 4_8.doc 4.9 23 Oct 2008 Andrew Doney Changes for PCR 36B TCF IPMS Technical Specification 4_9.doc 4.10 19 May 2009 Andrew Doney Changes for PCR 30 TCF IPMS Technical Specification 4_10.doc 4.11 13 Jan 2010 Ken Julian Changes for PCR 42 TCF IPMS Technical Specification 4_11.doc 4.12 20 Apr 2010 Ken Julian Changes for PCR35 & 43 TCF IPMS Technical Specification 4_12.doc 4.13 1 Sept 2011 Ken Julian Changes for PCR49 TCF IPMS Technical Specification 4_13.doc 4.14 29 Aug 2012 Ken Julian / Allister Changes for PCR50 TCF IPMS Technical Georgeson Specification 4_14.doc Ver. No. Ver. Date Revised By Description Release version 4.15 28 Feb 2017 Edmond Tso (Jade) IPMS-318 2.9.219 Adding validation rule to 4.6.11 ( Gaining carrier id is required ) 4.16 15 Mar 2017 Edmond Tso (Jade) IPMS-263 3.0.1 Adding validation rules to 4.6.11 and 4.6.25 IPMS-293 Page 52: An error was added to General Errors for the OVERRIDE_UNAUTHORISED Page 56: An error was added to the requestPort section for the OVERRIDE_UNAUTHORISED Page 76: Errors were added to the requestApprovedPortChange section for the OVERRIDE_UNAUTHORISED and RFS_NOTICE_PERIOD Page 3 of 237 Template (Version 1/25-Feb-2003) TCF IPMS Technical Specification 4_20 (002) Last changed: 21 February 2020 at 08:53 Technical Specification Project ID No.: NZ1-00232 Ver. No. Ver. Date Revised By Description Release version Page 102: New errors were added to the Application Security section for LSP Override Allowed and Fast Port Allowed Page 182 and 183: New images were added for the updated User Profiles page. Page 219: New error was added to the API Errors section for OVERRIDE_UNAUTHORISED. 4.17 07 Sep 2017 Anton Mather (Jade) IPMS-261 3.1.1 4.9. Emergency Return Request Access noted as disabled. 4.6.30: Emergency Return Request API call noted as disabled. 4.17 24 Oct 2017 Mo Yakubu (Jade) IPMS-192 Upgrade from Axis to 3.1.1 Jax-WS 3.5.26. Added a new entry to the system parameter table for rfsToDateDefault. Added another new entry to the system parameter table for enableQBNRChecking. 3.5.3. Added “Active” column to Company table, its purpose and impact. 3.5.4. Added “Active” column to ServiceProvider table, its purpose and impact. 4.6.1. Added report to the list of available web services. 4.6.11. Updated requestPort API call to indicate indicate that it should return an error if a disabled LSP is used for port request. 4.6.2. Updated the service versioninig section with the details of the newly added Apache CXF Jax-WS package. 4.6.12. Added additional parameters to the getRequestedPorts. 4.6.17. Added additional parameters to the getApprovedPorts api call. Page 4 of 237 Template (Version 1/25-Feb-2003) TCF IPMS Technical Specification 4_20 (002) Last changed: 21 February 2020 at 08:53 Technical Specification Project ID No.: NZ1-00232 Ver. No. Ver. Date Revised By Description Release version 4.6.23. Added additional parameters to the getNetworkUpdates api call. 4.6.26. Added additional parameters to the getApprovedPortChangeRequest api call. 4.6.34. Added a new API call for sOMStatusEnquiry. 4.9. Added a new entry to the access table for SOM Status Enquiry. 6.3.1. Updated the online login help page section to describe change to the list of companies. 6.4.1. Updated the GSP PortRequest page section to describe the change to the list of service providers. 6.6.6 Updated the User Maintenance section of the help documentation. 9. In Appendix A, a new entry was added to the IPMS API Errors table for error code SOM_TYPE_INVALID. 4.17 03 Nov 2017 Edmond Tso (Jade) IPMS-428 3.1.1 4.6.11 Added a new rule to the requestPort, some fields in the requestPort will be trimmed if they are over-length in the Jax-WS implementation. Add handset referenece validations , padding and trimming logic to the API call 4.6.13 Added the trimming rule for over- length fields, which is only applicable to the Jax-WS version. 4.6.25 Add handset referenece validations , padding and trimming logic to the API call 4.17 26 Dec 2017 Mo Yakubu (Jade) 4.6.36 3.1.1 Page 5 of 237 Template (Version 1/25-Feb-2003) TCF IPMS Technical Specification 4_20 (002) Last changed: 21 February 2020 at 08:53 Technical Specification Project ID No.: NZ1-00232 Ver. No. Ver. Date Revised By Description Release version Added emailAddress field format validation error. 4.17 16 Jan 2018 Edmond Tso (Jade) 7.3.16 3.1.1 Added extra fields for SLA network update report. 4.18 28 May 2018 Edmond Tso (Jade) 3.5.26 3.1.7 Add extra system parameter 2.2 Physical Design Specifications updates 4.18 6 Jun 2018 Edmond Tso (Jade) 4.6.14 3.1.7 Change description on the validation rules for field ‘gspRFSDateTimeStart’ 3.5.30 Add section 3.5.30 for new audit table. 4.19 20 Aug 2018 Callum Gubb (Jade) 3.5.5 3.1.8 Added “ACTIVE” column to the Carrier table and described its purpose. Retrospectively added an entry for the addition of the “LEFTMOSTSTANDARDSIM” column. 4.19 28 Aug 2018 Callum Gubb (Jade) 9 3.1.8 Added new “NUMBER_RANGE_PORTING” error into the table along with its description. 4.6.40 Updated error table to include the condition for the new NUMBER_RANGE_PORTING error 4.20 16 Jan 2019 Callum Gubb (Jade) 9 3.1.17 Added new “NUMBER_LENGTH_INVALID” error into the table along with its description.