Number Hosting
Reseller XML User Guide
Great Britain (GB/UK)
Version 0.9
Reseller XML user Guide UK v0.9 1 / 189
DOCUMENT HISTORY
Soft copies of this document are maintained under change control, but hard copies are not.
This may not be a printout of the latest version.
Revision history
Revision Date Description
0.1 14th Feb 2013 Draft version
0.2 19th June 2013SOAP requests included in section 2.2 Business
messages included in Appendix A
0.3 13th June 2014 Updated End Point URLs and bulk transaction limit
0.4 4th Feb 2016 Rectified descrepencies.
0.5 4th Dec 2016Updated to include functionalities for NH resellers
(sections 3.15 and 3.16)
0.6 24th May 2016
Rectified descrepencies and included the available
area codes in GB in Error: Reference source not
found
0.7 15th July 2016Updated note regarding message retriggering in
section 4.
0.8 May, 2017
Included additional functionality to validate Geo
Number using https and soap in section 16 and 13
respectively and new response codes while
validating geo numbers in section
0.9 June,2017Included new appendix: APPENDIX B regarding
allowed characters for placing NH transactions.
Colt Number Hosting XML User Guide GB v0.8 2 / 189
TABLE OF CONTENT
DOCUMENT HISTORY............................................................................................31 INTRODUCTION...........................................................................................61.1 OVERVIEW NH B2B INTERFACE...................................................................61.2 SCOPE.........................................................................................................71.3 DESCRIPTION.............................................................................................8
2 SYSTEMS ARCHITECTURE........................................................................92.1 HTTPS..........................................................................................................92.2 SOAP REQUESTS..........................................................................................13
3 HTTPS REQUEST SUBMISSION...............................................................323.1 OVERVIEW....................................................................................................323.2 XML PROCESS - SUBMIT REQUESTS.............................................................333.3 NUMBER ENQUIRY........................................................................................33
3.3.1 Number Enquiry Request.......................................................................343.3.2 Number Enquiry Response....................................................................42
3.4 NEW PORT IN...............................................................................................433.4.1 New Port In Request..............................................................................433.4.2 New Port In Response...........................................................................64
3.5 UPDATE PORT IN..........................................................................................643.5.1 Update port In Request..........................................................................653.5.2 Update Port In Response.......................................................................69
3.6 CANCEL PORT IN..........................................................................................703.6.1 Cancel Port In Request..........................................................................703.6.2 Cancel port In Response........................................................................75
3.7 NUMBER ACTIVATION....................................................................................763.7.1 Number Activation Request....................................................................763.7.2 Number Activation Response.................................................................91
3.8 NUMBER DEACTIVATION................................................................................913.8.1 Number Deactivation Request...............................................................923.8.2 Number Deactivation Response...........................................................103
3.9 NUMBER REACTIVATION..............................................................................1043.9.1 Number Reactivation Request.............................................................1043.9.2 Number reactivation Response............................................................119
3.10 GET TRANSACTION LIST..............................................................................120
Colt Number Hosting XML User Guide GB v0.8 3 / 189
3.10.1 Get Transaction List Request...............................................................1203.10.2 Get Transaction List Response............................................................124
3.11 GET TRANSACTION DETAILS........................................................................1243.11.1 Get Transaction Details Request.........................................................1253.11.2 Get Transaction Details Response.......................................................128
3.12 NUMBER RESERVATION...............................................................................1323.12.1 Number Reservation Request..............................................................1323.12.2 Number Reservation Response...........................................................136
3.13 EXTEND RESERVATION...............................................................................1373.13.1 Extend Reservation Request................................................................1373.13.2 Extend Reservation Response.............................................................141
3.14 CANCEL RESERVATION...............................................................................1423.14.1 Cancel Reservation Request................................................................1423.14.2 Cancel Reservation Response.............................................................146
3.15 UPDATE DIRECTORY SERVICES...................................................................1473.15.1 Update Directory Services Request.....................................................1473.15.2 Update Directory Services Response..................................................157
3.16 UPDATE ENDCUSTOMER ADDRESS..............................................................1573.16.1 Update EndCustomer Address Request..............................................1583.16.2 Update EndCustomer Address Response...........................................166
3.17 BULK UPLOAD TRANSACTION......................................................................1673.17.1 Bulk Upload Request............................................................................1673.17.2 Bulk Upload Response.........................................................................174
3.18 VALIDATE GEO NUMBER.............................................................................1753.18.1 Validate GeoNumber Request.............................................................1753.18.2 Validate GeoNumber Response...........................................................180
4. MAINTENANCE AND SUPPORT.............................................................1825 GLOSSARY...............................................................................................183APPENDIX A - RESPONSE CODES FROM NMTS, COCOM, GEO NUMBER VALIDATION AND WEBMETHODS...................................................................185APPENDIX B ALLOWED CHARACTERS FOR UK AS PER BRITISH TELECOM FOR NUMBER HOSTING REQUESTS........................................................................192
Colt Number Hosting XML User Guide GB v0.8 4 / 189
1 INTRODUCTION
1.1 OVERVIEW NH B2B interface
Number Hosting is a solution which enables infrastructure based Wholesale customers to
build their own new Voice/VoIP services to their end-customers with minimum investment. It
includes number management and regulatory services that are supported by a B2B gateway
between Colt and the customer, to support high-volume business.
B2B Gateway is a new middleware layer being introduced in COLT to enable the COLT
Partners (Referred as Resellers from here after) to exchange documents via well defined
interfaces.
The number hosting customers will be facilitated to initiate operational number management
transactions related to number hosting service in UK via webmethods using following
protocols:
o Web services
o XML
Other option which may be used by Resellers is to submit their requests to COLT via a Web
interface (Cocom Web Manager).
COLT Telecommunications (COLT) has provided you with an electronic interface to perform
below listed transactions for submitting XML requests.
o Number Enquiry
o Number reservation
o Cancellation of Number Reservation
o Extension of Number Reservation
Colt Number Hosting XML User Guide GB v0.8 5 / 189
o Number activation
o Number Deactivation
o Number Reactivation
o Number Port-in
o Get transaction list
o Get transaction details
o Update number Port-In
o Cancel number Port-In
o Update Telephone address
o Update directory services
o Bulk Upload
This document describes the necessary technical details and the processes that allow you to
set up your internal systems and processes and successfully submit and retrieve requests.
1.2 SCOPE
The Intended audiences of this document are Resellers and their System Architects/Analysts
who would like to make use of the new B2B Gateway interfaces to integrate their systems
with COLT.
This user guide is intended to help the Resellers technical teams understand the eXtensible
Markup Language (XML) Interface and how to set it up for use by operational staff.
Due to the nature of the XML Interface it is assumed that Resellers have a software
application that can produce the XML document which requires processing.
Colt Number Hosting XML User Guide GB v0.8 6 / 189
The Reseller software application generates the HTTPS requests, embeds the XML content
in it and then waits for the response, interprets it and acts appropriately.
This document does not describe how to create or configure such application software.
1.3 D ESCRIPTIO N
The diagram below shows an overview of how the resellers can use the B2B Gateway
interfaces via various protocols B2B Gateway exposes.
XML requests can only be exchanged via HTTPS. All the XML Interfaces are synchronous
and need to be invoked as and when required by the resellers.
Colt Number Hosting XML User Guide GB v0.8 7 / 189
2 SYSTEMS ARCHITECTURE
This section briefly describes how the resellers will communicate with B2B Gateway to send
XML requests via HTTPS.
2.1 HTTPS
HTTPS sample User Interfaces (UI) can be used to invoke the requests described in the
above section. The Resellers must note that HTTPS Request will be a synchronous request
that generates response for the request immediately. The Reseller must insert the XML
Document in a text parameter inside the HTTPS Request and then click on the submit
button.
Colt Number Hosting XML User Guide GB v0.8 8 / 189
1. UI to submit Number Enquiry request
2. UI to submit Number Reservation request
3. UI to submit Cancel Reservation request
4. UI to submit Extend Reservation request
5. UI to submit Number Activation request
6. UI to submit Number Deactivation request
7. UI to submit Number PortIn request
8. UI to submit Get Transaction List request
Colt Number Hosting XML User Guide GB v0.8 9 / 189
9. UI to submit Get Transaction Details request
10. UI to submit Update PortIn request
11. UI to submit Cancel PortIn request
12. UI to submit Update End Customer Address request
13. UI to submit Update Directory Services request
14. Number Reactivation
15. Bulk Upload
Colt Number Hosting XML User Guide GB v0.8 10 / 189
16. UI to Submit Validate Geo Number request
Please note that the htmls provided above are generic for all countries.For the fields applicable to GB, kindly refer to the interface details detailed in the following sections.
Authentication:
Authentication on incoming HTTPS requests will be basic user ID/Password authentication.
Usage Notes on Submitting HTTPS requests:
HTTP Method: Post
User: user User ID supplied by COLT
Password: password Password supplied by COLT
S.NO. FUNCTION NAME
END POINT URL
1 Number
Enquiry
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/numberEnquiry
2 New PortIn https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/portIn
3 Update
PortIn
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/updatePortIn
4 Cancel Port
In
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/cancelPortIn
5 Number
Activation
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/numberActivation
6 Number
Deactivation
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/numberDeactivation
7 Get
Transaction
List
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/getTransactionList
Colt Number Hosting XML User Guide GB v0.8 11 / 189
8 Get
Transaction
Details
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/getTransactionDetails
9 Number
Reservation
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/numberReservation
10 Extend
Reservation
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/extendReservation
11 Cancel
Reservation
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/cancelReservation
12 Update
Directory
Services
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/updateDirectoryServices
12 Update
EndCustome
r Address
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/
updateEndCustomerAddress
14 Number
Reactivation
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/numberReactivation
15 Bulk Upload
Transaction
https://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/bulkNhTransactions
16 Validate Geo
Numberhttps://wbmdmzis02.colt.net/invoke/ColtNumberHosting.common.http/validateGeoNumber
2.2 Soap Requests
HTTPS sample User Interfaces (UI) can be used to invoke the requests described in the
above section. The Resellers must note that HTTPS Request will be a synchronous request
that generates response for the request immediately. The Reseller must insert the XML
Document in a text parameter inside the HTTPS Request and then click on the submit
button.
Colt Number Hosting XML User Guide GB v0.8 12 / 189
Any soap client for example SOAP UI can be used to place a soap request.
Authentication:
Authentication on incoming SOAP request will be basic user ID/Password authentication.
Usage Notes on Submitting SOAP requests:
User: user User ID supplied by COLT
Password: password Password supplied by COLT
End Point URL:
http://WBMB2BIS02:6666/ws/ColtNumberHosting.common.webSvcProvider:numberHosting/
ColtNumberHosting_common_webSvcProvider_numberHosting_Port
1. Soap data to submit Number Enquiry request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:numberEnquiry>
<numberQueryRequest>
<v11:numberQueryRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:queryDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:customerRef></v12:customerRef>
Colt Number Hosting XML User Guide GB v0.8 13 / 189
<v12:cliStatus></v12:cliStatus>
<v12:geoblockDetails>
<v12:areaCode></v12:areaCode>
<v12:rangeStart></v12:rangeStart>
<v12:rangeEnd></v12:rangeEnd>
<v12:blockSize></v12:blockSize>
</v12:geoblockDetails>
<v12:nonGeoblockDetails>
<v12:rangeStart></v12:rangeStart>
<v12:rangeEnd></v12:rangeEnd>
<v12:blockSize></v12:blockSize>
</v12:nonGeoblockDetails>
<v12:cliDetails>
<v12:areaCode></v12:areaCode>
<v12:areaCodeExtn></v12:areaCodeExtn>
<v12:rangeStart></v12:rangeStart>
<v12:rangeEnd></v12:rangeEnd>
</v12:cliDetails>
<v12:transactionId>2013012524</v12:transactionId>
<v12:numberType></v12:numberType>
<v12:numberCategory></v12:numberCategory>
</v11:queryDetails>
</v11:numberQueryRequest>
</numberQueryRequest>
</v1:numberEnquiry>
</soapenv:Body>
</soapenv:Envelope>
2. Soap data to submit Number Reservation request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
Colt Number Hosting XML User Guide GB v0.8 14 / 189
<soapenv:Body>
<v1:numberReservation>
<numberReservationRequest>
<v11:numberReservationRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-08T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:reservationRequestDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:cliDetails>
<v12:areaCode>0121</v12:areaCode>
<v12:areaCodeExtn>434</v12:areaCodeExtn>
<v12:rangeStart>8989</v12:rangeStart>
<v12:rangeEnd>8989</v12:rangeEnd>
</v12:cliDetails>
<v12:customerRef></v12:customerRef>
<v12:userName>BSSROSS</v12:userName>
</v11:reservationRequestDetails>
</v11:numberReservationRequest>
</numberReservationRequest>
</v1:numberReservation>
</soapenv:Body>
</soapenv:Envelope>
3. Soap data to submit Cancel Reservation request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
Colt Number Hosting XML User Guide GB v0.8 15 / 189
<soapenv:Body>
<v1:cancelReservation>
<cancelReservationRequest>
<v11:cancelReservationRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:cancellationDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:cliDetails>
<v12:areaCode>0113</v12:areaCode>
<v12:areaCodeExtn>111</v12:areaCodeExtn>
<v12:rangeStart>1009</v12:rangeStart>
<v12:rangeEnd>1009</v12:rangeEnd>
</v12:cliDetails>
<v12:userName>BSSROSS</v12:userName>
</v11:cancellationDetails>
</v11:cancelReservationRequest>
</cancelReservationRequest>
</v1:cancelReservation>
</soapenv:Body>
</soapenv:Envelope>
4. Soap data to submit Extend Reservation request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
Colt Number Hosting XML User Guide GB v0.8 16 / 189
<v1:extendReservation>
<extendReservationRequest>
<v11:extendReservationRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:extensionDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:cliDetails>
<v12:areaCode>0113</v12:areaCode>
<v12:areaCodeExtn>111</v12:areaCodeExtn>
<v12:rangeStart>1009</v12:rangeStart>
<v12:rangeEnd>1009</v12:rangeEnd>
</v12:cliDetails>
<v12:userName>BSSROSS</v12:userName>
</v11:extensionDetails>
</v11:extendReservationRequest>
</extendReservationRequest>
</v1:extendReservation>
</soapenv:Body>
</soapenv:Envelope>
5. Soap data to submit Number Activation request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:numberActivation>
Colt Number Hosting XML User Guide GB v0.8 17 / 189
<numberActivationRequest>
<v11:numberActivationRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:activationDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:cliDetails>
<v12:areaCode>0113</v12:areaCode>
<v12:areaCodeExtn>111</v12:areaCodeExtn>
<v12:rangeStart>1009</v12:rangeStart>
<v12:rangeEnd>1009</v12:rangeEnd>
</v12:cliDetails>
<v12:newCustomerRef></v12:newCustomerRef>
<v12:endCustomerDetails>
<v12:endCustomerName>Jay</v12:endCustomerName>
<v12:endCustomerAddress>
<v12:floorSuite></v12:floorSuite>
<v12:buildingName>WOMENS HEALTH CARE</v12:buildingName>
<v12:departmentBranch></v12:departmentBranch>
<v12:premisesNumber></v12:premisesNumber>
<v12:streetName>MINDELSOHN WAY</v12:streetName>
<v12:cityTown>BIRMINGHAM</v12:cityTown>
<v12:state></v12:state>
<v12:postalZipCode>B15 2TG</v12:postalZipCode>
<v12:country></v12:country>
<v12:poBoxNumber></v12:poBoxNumber>
</v12:endCustomerAddress>
</v12:endCustomerDetails>
Colt Number Hosting XML User Guide GB v0.8 18 / 189
<v12:userName>BSSROSS</v12:userName>
</v11:activationDetails>
</v11:numberActivationRequest>
</numberActivationRequest>
</v1:numberActivation>
</soapenv:Body>
</soapenv:Envelope>
6. Soap data to submit Number Deactivation request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:numberDeactivation>
<numberDeactivationRequest>
<v11:numberDeactivationRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:deactivationDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:cliDetails>
<v12:areaCode>0113</v12:areaCode>
<v12:areaCodeExtn>000</v12:areaCodeExtn>
<v12:rangeStart>9801</v12:rangeStart>
<v12:rangeEnd>9900</v12:rangeEnd>
</v12:cliDetails>
<v12:userName>BSSROSS</v12:userName>
Colt Number Hosting XML User Guide GB v0.8 19 / 189
</v11:deactivationDetails>
</v11:numberDeactivationRequest>
</numberDeactivationRequest>
</v1:numberDeactivation>
</soapenv:Body>
</soapenv:Envelope>
7. Soap data to submit Number PortIn request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:portIn>
<newPortInRequest>
<v11:newPortInRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-02-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:portInDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:customerRef></v12:customerRef>
<v12:endCustomerDetails>
<v12:endCustomerName>Man</v12:endCustomerName>
<v12:endCustomerAddress>
<v12:floorSuite></v12:floorSuite>
<v12:buildingName>Birmingham Children's Hospital</v12:buildingName>
<v12:departmentBranch></v12:departmentBranch>
<v12:premisesNumber></v12:premisesNumber>
Colt Number Hosting XML User Guide GB v0.8 20 / 189
<v12:streetName>Steelhouse Lane</v12:streetName>
<v12:cityTown>Birmingham</v12:cityTown>
<v12:state></v12:state>
<v12:postalZipCode>B4 6NH</v12:postalZipCode>
<v12:country>GB</v12:country>
<v12:poBoxNumber></v12:poBoxNumber>
</v12:endCustomerAddress>
</v12:endCustomerDetails>
<v12:endCustomerContactName>Man</v12:endCustomerContactName>
<v12:endCustomerContactPhone>9999999999</v12:endCustomerContactPhone>
<v12:endCustomerContactEmail>[email protected]</v12:endCustomerContactEmail>
<v12:newCustomerAddress>
<v12:floorSuite></v12:floorSuite>
<v12:buildingName></v12:buildingName>
<v12:departmentBranch></v12:departmentBranch>
<v12:premisesNumber></v12:premisesNumber>
<v12:streetName></v12:streetName>
<v12:cityTown></v12:cityTown>
<v12:state></v12:state>
<v12:postalZipCode></v12:postalZipCode>
<v12:country></v12:country>
<v12:poBoxNumber></v12:poBoxNumber>
</v12:newCustomerAddress>
<v12:portInNumberDetails>
<v12:mainBillingNumber>123</v12:mainBillingNumber>
<v12:cliDetails>
<v12:areaCode>0114</v12:areaCode>
<v12:areaCodeExtn>234</v12:areaCodeExtn>
<v12:rangeStart>5678</v12:rangeStart>
<v12:rangeEnd>5678</v12:rangeEnd>
</v12:cliDetails>
<v12:currentOperator>BT</v12:currentOperator>
<v12:singleLine>S</v12:singleLine>
<v12:multiLine>M</v12:multiLine>
Colt Number Hosting XML User Guide GB v0.8 21 / 189
</v12:portInNumberDetails>
<v12:originalRangeHolder></v12:originalRangeHolder>
<v12:portInDate>2013-03-02Z</v12:portInDate>
<v12:portInWindow>0730-0900</v12:portInWindow>
<v12:switchMaintainer>
<v12:switchMaintainerName></v12:switchMaintainerName>
<v12:switchMaintainerCompany></v12:switchMaintainerCompany>
<v12:switchMaintainerPhone></v12:switchMaintainerPhone>
<v12:switchMaintainerMobile></v12:switchMaintainerMobile>
<v12:switchMaintainerEmail></v12:switchMaintainerEmail>
</v12:switchMaintainer>
<v12:directoryServicesDetails>
<v12:orderType></v12:orderType>
<v12:endCustomerName></v12:endCustomerName>
<v12:businesssuffix></v12:businesssuffix>
<v12:businessDescription></v12:businessDescription>
<v12:subHeader></v12:subHeader>
<v12:subSubHeader></v12:subSubHeader>
<v12:subSubSubHeader></v12:subSubSubHeader>
<v12:qualifier></v12:qualifier>
<v12:endCustomerAddress>
<v12:floorSuite></v12:floorSuite>
<v12:buildingName></v12:buildingName>
<v12:departmentBranch></v12:departmentBranch>
<v12:premisesNumber></v12:premisesNumber>
<v12:streetName></v12:streetName>
<v12:cityTown></v12:cityTown>
<v12:state></v12:state>
<v12:postalZipCode></v12:postalZipCode>
<v12:country></v12:country>
<v12:poBoxNumber></v12:poBoxNumber>
</v12:endCustomerAddress>
<v12:telephoneNumnber></v12:telephoneNumnber>
<v12:lineType></v12:lineType>
Colt Number Hosting XML User Guide GB v0.8 22 / 189
<v12:entryType></v12:entryType>
<v12:tariff></v12:tariff>
<v12:listingCategory></v12:listingCategory>
<v12:typeFace></v12:typeFace>
<v12:priority></v12:priority>
<v12:listingType></v12:listingType>
<v12:additionalIinstructions></v12:additionalIinstructions>
</v12:directoryServicesDetails>
<v12:portingAuthority>
<v12:letterOfAuthorityFileName></v12:letterOfAuthorityFileName>
<v12:letterOfAuthorityFileContent></v12:letterOfAuthorityFileContent>
</v12:portingAuthority>
<v12:userName>BSSROSS</v12:userName>
</v11:portInDetails>
</v11:newPortInRequest>
</newPortInRequest>
</v1:portIn>
</soapenv:Body>
</soapenv:Envelope>
8. Soap data to submit Get Transaction List request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:getTransactionList>
<getTransactionListRequest>
<v11:getTransactionListRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:transactionListDetails>
Colt Number Hosting XML User Guide GB v0.8 23 / 189
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:dateFrom>2013-01-08T12:07:00.000Z</v12:dateFrom>
<v12:dateTo>2013-01-21T12:07:00.000Z</v12:dateTo>
</v11:transactionListDetails>
</v11:getTransactionListRequest>
</getTransactionListRequest>
</v1:getTransactionList>
</soapenv:Body>
</soapenv:Envelope>
9. Soap data to submit Get Transaction Details request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:getTransactionDetails>
<getTransactionDetailsRequest>
<v11:getTransactionDetailsRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:transactionDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:transactionId>2013012524</v12:transactionId>
Colt Number Hosting XML User Guide GB v0.8 24 / 189
</v11:transactionDetails>
</v11:getTransactionDetailsRequest>
</getTransactionDetailsRequest>
</v1:getTransactionDetails>
</soapenv:Body>
</soapenv:Envelope>
10. Soap data to submit Update PortIn request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:updatePortIn>
<updatePortInRequest>
<v11:updatePortInRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-02-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:portInDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:portInTranxRef>2013021819</v12:portInTranxRef>
<v12:newPortInDate>2013-03-04Z</v12:newPortInDate>
<v12:newPortInWindow>0730-0900</v12:newPortInWindow>
<v12:userName>BSSROSS</v12:userName>
</v11:portInDetails>
</v11:updatePortInRequest>
</updatePortInRequest>
</v1:updatePortIn>
Colt Number Hosting XML User Guide GB v0.8 25 / 189
</soapenv:Body>
</soapenv:Envelope>
11. Soap data to submit Cancel PortIn request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:cancelPortIn>
<cancelPortInRequest>
<v11:cancelPortInRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-02-21T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:cancelPortInDetails>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:portInTranxRef>2013021821</v12:portInTranxRef>
<v12:userName>BSSROSS</v12:userName>
</v11:cancelPortInDetails>
</v11:cancelPortInRequest>
</cancelPortInRequest>
</v1:cancelPortIn>
</soapenv:Body>
</soapenv:Envelope>
12. Soap data to submit Update Directory Services request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1"
Colt Number Hosting XML User Guide GB v0.8 26 / 189
xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:updateDirectoryServices>
<updateDirectoryServicesRequest>
<v11:updateDirectoryServicesRequest>
<v11:serviceHeader>
<v12:senderSystem>Reseller</v12:senderSystem>
<v12:creationTime>2013-01-08T12:07:00.000Z</v12:creationTime>
</v11:serviceHeader>
<v11:directoryServices>
<v12:resellerProfile>
<v12:serviceProfile>AKJ</v12:serviceProfile>
<v12:productID>Geographic Number Hosting</v12:productID>
<v12:Country>GB</v12:Country>
</v12:resellerProfile>
<v12:directoryServicesDetails>
<v12:orderType>New</v12:orderType>
<v12:endCustomerName>Jay</v12:endCustomerName>
<v12:businesssuffix></v12:businesssuffix>
<v12:businessDescription></v12:businessDescription>
<v12:subHeader></v12:subHeader>
<v12:subSubHeader></v12:subSubHeader>
<v12:subSubSubHeader></v12:subSubSubHeader>
<v12:qualifier></v12:qualifier>
<v12:endCustomerAddress>
<v12:floorSuite></v12:floorSuite>
<v12:buildingName>WOMENS HEALTH CARE</v12:buildingName>
<v12:departmentBranch></v12:departmentBranch>
<v12:premisesNumber></v12:premisesNumber>
<v12:streetName>MINDELSOHN WAY</v12:streetName>
<v12:cityTown>BIRMINGHAM</v12:cityTown>
<v12:state></v12:state>
Colt Number Hosting XML User Guide GB v0.8 27 / 189
<v12:postalZipCode>B15 2TG</v12:postalZipCode>
<v12:country></v12:country>
<v12:poBoxNumber></v12:poBoxNumber>
</v12:endCustomerAddress>
<v12:telephoneNumnber>1234567891</v12:telephoneNumnber>
<v12:lineType>Normal</v12:lineType>
<v12:entryType>DQR</v12:entryType>
<v12:tariff>Business</v12:tariff>
<v12:listingCategory>Single</v12:listingCategory>
<v12:typeFace>Bold</v12:typeFace>
<v12:priority>A</v12:priority>
<v12:listingType>PB</v12:listingType>
<v12:additionalIinstructions></v12:additionalIinstructions>
</v12:directoryServicesDetails>
<v12:userName>BSSROSS</v12:userName>
</v11:directoryServices>
</v11:updateDirectoryServicesRequest>
</updateDirectoryServicesRequest>
</v1:updateDirectoryServices>
</soapenv:Body>
</soapenv:Envelope>
13. Soap data to submit Validate Geo Number request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.colt.net/numberHosting/v1" xmlns:v11="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:v12="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<soapenv:Header/>
<soapenv:Body>
<v1:validateGeoNumber>
<validateGeoNumberRequest>
<v11:validateGeoNumberRequest>
<v11:serviceHeader>
<!--Optional:-->
<v12:senderSystem>?</v12:senderSystem>
Colt Number Hosting XML User Guide GB v0.8 28 / 189
<!--Optional:-->
<v12:creationTime>?</v12:creationTime>
</v11:serviceHeader>
<v11:validateGeoNumberDetails>
<v12:address>
<!--Optional:-->
<v12:floorSuite>?</v12:floorSuite>
<!--Optional:-->
<v12:flatNumber>?</v12:flatNumber>
<!--Optional:-->
<v12:premisesNumber>?</v12:premisesNumber>
<!--Optional:-->
<v12:premisesNumberLetter>?</v12:premisesNumberLetter>
<!--Optional:-->
<v12:buildingName>?</v12:buildingName>
<!--Optional:-->
<v12:departmentBranch>?</v12:departmentBranch>
<!--Optional:-->
<v12:streetName>?</v12:streetName>
<!--Optional:-->
<v12:municipalityName>?</v12:municipalityName>
<v12:cityTown>?</v12:cityTown>
<!--Optional:-->
<v12:state>?</v12:state>
<v12:postalZipCode>?</v12:postalZipCode>
<!--Optional:-->
<v12:country>?</v12:country>
<!--Optional:-->
<v12:poBoxNumber>?</v12:poBoxNumber>
<!--Optional:-->
<v12:cifNIF>?</v12:cifNIF>
<!--Optional:-->
<v12:extensionNumber>?</v12:extensionNumber>
</v12:address>
Colt Number Hosting XML User Guide GB v0.8 29 / 189
<v12:numberRange>
<v12:areaCode>?</v12:areaCode>
<!--Optional:-->
<v12:areaCodeExtn>?</v12:areaCodeExtn>
<v12:rangeStart>?</v12:rangeStart>
<v12:rangeEnd>?</v12:rangeEnd>
</v12:numberRange>
</v11:validateGeoNumberDetails>
</v11:validateGeoNumberRequest>
</validateGeoNumberRequest>
</v1:validateGeoNumber>
</soapenv:Body>
</soapenv:Envelope>
Colt Number Hosting XML User Guide GB v0.8 30 / 189
3 HTTPS REQUEST SUBMISSION
3.1 Overview
Request template in a XML structured format will be available in the text box of the HTML
page, which is the format required by the XML Interface. This facilitates organising of
information in the document and enables simpler processing. Reseller needs to embed data
to be processed in this template. For each XML request an XML response is provided by the
XML Interface. The response varies depending on the type of XML request received.
NumberHosting Application Interface B2B
G
ateway
These processes are described in further detail in the following sections.
The XML schema consists of the following root elements:
Request: Service Header/Details
Response: Header/result
Each root element contains a group of elements, including elements and attributes1 as well
as sub-structured Child Elements.
3.2 XML Process - Submit Requests1 Attributes are marked with a prefix @ in the system.
Colt Number Hosting XML User Guide GB v0.8 31 / 189
XML Requests
XML Responses
Resellers can submit online HTTPS synchronous requests. The XML Requests over HTTPS
must match exactly to the schema (described later in this section) provided by COLT.
For each successful Reseller Request, B2B Gateway returns back an acknowledgement
with a reference number called transactionId here after in the document. Resellers can use
this number to query the status of the request using the list/query interfaces exposed by B2B
Gateway
3.3 Number Enquiry
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
Colt Number Hosting XML User Guide GB v0.8 32 / 189
3.3.1 Number Enquiry Request
The diagram below describes the integration scenario for number Enquiry. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and forwards the request to cocom to fetch the number details. B2B Gateway
responds back with an acknowledgement XML containing the number details of the request.
If not successful the response will contain Error messages.
Colt Number Hosting XML User Guide GB v0.8 33 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample number enquiry XML Request.
<?xml version="1.0"?>
<nh:numberQueryRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
Colt Number Hosting XML User Guide GB v0.8 34 / 189
</nh:serviceHeader>
<nh:queryDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>BAH</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:customerRef></nhm:customerRef>
<nhm:cliStatus></nhm:cliStatus>
<nhm:geoblockDetails>
<nhm:areaCode></nhm:areaCode>
<nhm:areaCodeExtn></nhm:areaCodeExtn>
<nhm:rangeStart></nhm:rangeStart>
<nhm:rangeEnd></nhm:rangeEnd>
<nhm:blockSize></nhm:blockSize>
</nhm:geoblockDetails>
<nhm:nonGeoblockDetails>
<nhm:rangeStart></nhm:rangeStart>
<nhm:rangeEnd></nhm:rangeEnd>
<nhm:blockSize></nhm:blockSize>
</nhm:nonGeoblockDetails>
<nhm:geoSingleNumbersDetails>
<nhm:areaCode></nhm:areaCode>
<nhm:quantity></nhm:quantity>
</nhm:geoSingleNumbersDetails>
<nhm:numberType></nhm:numberType>
<nhm:numberCategory></nhm:numberCategory>
<nhm:serviceType></nhm:serviceType>
<nhm:cliDetails>
<nhm:areaCode>0106</nhm:areaCode>
<nhm:areaCodeExtn>395</nhm:areaCodeExtn>
<nhm:rangeStart>2060</nhm:rangeStart>
Colt Number Hosting XML User Guide GB v0.8 35 / 189
<nhm:rangeEnd>2060</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:transactionId></nhm:transactionId>
<nhm:nonGeoSingleNumbersDetails>
<nhm:quantity></nhm:quantity>
</nhm:nonGeoSingleNumbersDetails>
</nh:queryDetails>
</nh:numberQueryRequest>
A.1
Data Structure:
Shown below is the way XML Schema for a request is organized. must be filled in by the
Reseller for each online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 36 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element name
Required
Optional Description
1 nh:serviceHeader Required
Colt Number Hosting XML User Guide GB v0.8 37 / 189
2
nh:serviceHeader/
nhm:senderSystem Optional “Xml” to be used
3
nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:queryDetails Required
5
nh:queryDetails/
nhm:resellerProfile Required
6
nh:queryDetails/
nhm:resellerProfile/
nhm:serviceProfile Required 3 character length profile ID
7
nh:queryDetails/
nhm:resellerProfile/
nhm:productID Required “Geographic Number Hosting” for this phase.
8
nh:queryDetails/
nhm:resellerProfile/
nhm:Country Required
GB
9
nh:queryDetails/
nhm:customerReference Optional
This is required for Customer Ref based search.
Customer Reference cannot be greater than 50 characters.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_,/\-\+\.'&" \w]*
10 nh:queryDetails/
nhm:cliStatus
Optional This is required for number status based search.
Value passed will be any from the below list:
Free
Reserved
Allocated
Reallocated
Activated
PortIn_Activated
Colt Number Hosting XML User Guide GB v0.8 38 / 189
PortIn_Allocated
PortIn_Reserved
PortOut
Returned
Quarantined
PortIn_Quarantined
Transferred
All
11
nh:queryDetails/
nhm:geoblockDetails Optional
In case of Free number, user can further search for Geographic
number or location independent number.
This is required for Geographic number based search.
12
nh:queryDetails/
nhm:geoblockDetails/
nhm:areaCode Required
Value to be passed if number type is ‘Geo’
Area Code can be 3 or 4 or 5 digits in length.
This fied is mandatory for number type ‘Geo’
13
nh:queryDetails/
nhm:geoblockDetails/
nhm:rangeStart Optional
Value to be passed if number type is ‘Geo’
Range Start is always 4 digits
14
nh:queryDetails/
nhm:geoblockDetails/
nhm:rangeEnd Optional
Value to be passed if number type is ‘Geo’
Range End is always 4 digits
15
nh:queryDetails/
nhm:geoblockDetails/
nhm:blockSize Required
Value to be passed if number type is ‘Geo’
This fied is mandatory for number type ‘Geo’
Max length allowed is 10 digits.
16
nh:queryDetails/
nhm:nonGeoblockDetails Optional This is required for location independent search.
17
nh:queryDetails/
nhm:nonGeoblockDetails/
nhm:rangeStart Optional
Value to be passed if number type is ‘Non Geo’
Range Start is always 4 digits
18 nh:queryDetails/ Optional Value to be passed if number type is ‘Non Geo’
Colt Number Hosting XML User Guide GB v0.8 39 / 189
nhm:nonGeoblockDetails/
nhm:rangeEnd
Range End is always 4 digits
A single number will be captured with Range Start and Range
End being the same
19
nh:queryDetails/
nhm:nonGeoblockDetails/
nhm:blockSize Required
Value to be passed if number type is ‘Non Geo’
This fied is mandatory for number type ‘Non Geo’
Max length allowed is 10 digits.
20
nh:queryDetails/
nhm:cliDetails Optional This is required for number range search.
21
nh:queryDetails/
nhm:cliDetails/
nhm:areaCode Required Area Code can be 3 or 4 or 5 digits in length
22
nh:queryDetails/
nhm:cliDetails/
nhm:areaCodeExtn Required
Main Number 2 digits if Local Area Code = 5 digit or 3 digits if
Local Area Code is 4 digits or 4 digits if Local Area Code is 3 digits
23
nh:queryDetails/
nhm:cliDetails/
nhm:rangeStart Required
Range Start is always 4 digits
24
nh:queryDetails/
nhm:cliDetails/
nhm:rangeEnd Required
Range End is always 4 digits
A single number will be captured with Range Start and Range
End being the same
25
nh:queryDetails/
nhm:transactionId Optional
This is required for transaction id based search.
ID to be not more than 25 character length.
26
nh:queryDetails/
nhm:numberType Optional
NumberType is mandatory when the cli status selected is Free.
Enum values:
Geo
Non Geo
27
nh:queryDetails/
nhm:numberCategory Optional
NA for GB.
Note: Geographic number and location independent search could be done only when the
number status is ‘Free’.
Colt Number Hosting XML User Guide GB v0.8 40 / 189
3.3.2 Number Enquiry Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as numberQueryResponse. The root element consists of elements make
up the acknowledgement. An optional Success/Error status Message is also included in the
response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
The number list is returned in the above format to the reseller as response.
3.4 New Port In
Colt Number Hosting XML User Guide GB v0.8 41 / 189
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.4.1 New Port In Request
The diagram below describes the integration scenario for new portIn. The Reseller sends an
XML Request to the COLT B2B Gateway interface. The B2B Gateway interface validates
and responds back with an acknowledgement XML containing transaction ID for the request.
If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Message Structure:
Colt Number Hosting XML User Guide GB v0.8 42 / 189
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample New Port In XML Request.
<?xml version="1.0"?>
<nh:newPortInRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
</nh:serviceHeader>
<nh:portInDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>BAH</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:customerRef></nhm:customerRef>
<nhm:endCustomerDetails>
<nhm:endCustomerName></nhm:endCustomerName>
<nhm:customerType></nhm:customerType>
<nhm:title></nhm:title>
<nhm:firstName></nhm:firstName>
<nhm:lastName></nhm:lastName>
<nhm:registeredName></nhm:registeredName>
<nhm:customerVATnumber></nhm:customerVATnumber>
Colt Number Hosting XML User Guide GB v0.8 43 / 189
<nhm:endCustomerDateOfBirth></nhm:endCustomerDateOfBirth>
<nhm:endCustomerLanguage></nhm:endCustomerLanguage>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber>2-12</nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName>HAYDNSTRASSE</nhm:streetName>
<nhm:cityTown>Wien</nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode>5020</nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
</nhm:endCustomerDetails>
<nhm:companyRegistrationNumber></nhm:companyRegistrationNumber>
<nhm:newCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber></nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName></nhm:streetName>
<nhm:cityTown></nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode></nhm:postalZipCode>
Colt Number Hosting XML User Guide GB v0.8 44 / 189
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:newCustomerAddress>
<nhm:portInNumberDetails>
<nhm:mainBillingNumber>123456789</nhm:mainBillingNumber>
<nhm:cliDetails>
<nhm:areaCode>0662</nhm:areaCode>
<nhm:areaCodeExtn>445</nhm:areaCodeExtn>
<nhm:rangeStart>5555</nhm:rangeStart>
<nhm:rangeEnd>5559</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:currentOperator>NTL</nhm:currentOperator>
<nhm:singleLine>S</nhm:singleLine>
<nhm:multiLine>M</nhm:multiLine>
</nhm:portInNumberDetails>
<nhm:originalRangeHolder></nhm:originalRangeHolder>
<nhm:portInDate>2014-04-23</nhm:portInDate>
<nhm:portInWindow>1200-1400</nhm:portInWindow>
<nhm:switchMaintainer>
<nhm:switchMaintainerFirstName></nhm:switchMaintainerFirstName>
<nhm:switchMaintainerLastName></nhm:switchMaintainerLastName>
<nhm:switchMaintainerPhone></nhm:switchMaintainerPhone>
<nhm:switchMaintainerMobile></nhm:switchMaintainerMobile>
<nhm:switchMaintainerEmail></nhm:switchMaintainerEmail>
<nhm:switchMaintainerFax></nhm:switchMaintainerFax>
<nhm:switchMaintainerName></nhm:switchMaintainerName>
Colt Number Hosting XML User Guide GB v0.8 45 / 189
<nhm:switchMaintainerCompany></nhm:switchMaintainerCompany>
</nhm:switchMaintainer>
<nhm:directoryServicesDetails>
<nhm:orderType></nhm:orderType>
<nhm:endCustomerName></nhm:endCustomerName>
<nhm:businesssuffix></nhm:businesssuffix>
<nhm:businessDescription></nhm:businessDescription>
<nhm:subHeader></nhm:subHeader>
<nhm:subSubHeader></nhm:subSubHeader>
<nhm:subSubSubHeader></nhm:subSubSubHeader>
<nhm:qualifier></nhm:qualifier>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber></nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName></nhm:streetName>
<nhm:cityTown></nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode></nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
<nhm:telephoneNumber>066244555550</nhm:telephoneNumber>
<nhm:lineType></nhm:lineType>
<nhm:entryType></nhm:entryType>
<nhm:tariff></nhm:tariff>
<nhm:listingCategory></nhm:listingCategory>
Colt Number Hosting XML User Guide GB v0.8 46 / 189
<nhm:typeFace></nhm:typeFace>
<nhm:priority></nhm:priority>
<nhm:listingType></nhm:listingType>
<nhm:additionalIinstructions></nhm:additionalIinstructions>
<nhm:companyRegistrationNumber></nhm:companyRegistrationNumber>
<nhm:companyEmailAddress></nhm:companyEmailAddress>
<nhm:codeAPE></nhm:codeAPE>
<nhm:usoWPStatusFlag></nhm:usoWPStatusFlag>
<nhm:otheMediaStatusFlag></nhm:otheMediaStatusFlag>
<nhm:usoDAStatusFlag></nhm:usoDAStatusFlag>
<nhm:salesFlag></nhm:salesFlag>
<nhm:reverseQueryFlag></nhm:reverseQueryFlag>
<nhm:serviceType></nhm:serviceType>
<nhm:deviceTypeId></nhm:deviceTypeId>
<nhm:listingLanguage></nhm:listingLanguage>
<nhm:areaCode></nhm:areaCode>
<nhm:areaCodeExtn></nhm:areaCodeExtn>
<nhm:rangeStart></nhm:rangeStart>
<nhm:rangeEnd></nhm:rangeEnd>
<nhm:changeType></nhm:changeType>
<nhm:newTelephoneNumber></nhm:newTelephoneNumber>
<nhm:firstName></nhm:firstName>
<nhm:middleName></nhm:middleName>
<nhm:lastName></nhm:lastName>
<nhm:addtionalInfo></nhm:addtionalInfo>
<nhm:publicationCode></nhm:publicationCode>
<nhm:propertyIndicator></nhm:propertyIndicator>
<nhm:HouseNumberAddition></nhm:HouseNumberAddition>
<nhm:usageType></nhm:usageType>
<nhm:networkType></nhm:networkType>
<nhm:directoryInfoNotes></nhm:directoryInfoNotes>
Colt Number Hosting XML User Guide GB v0.8 47 / 189
<nhm:telephoneNumnber></nhm:telephoneNumnber>
</nhm:directoryServicesDetails>
<nhm:portingAuthority>
<nhm:letterOfAuthorityFileName></nhm:letterOfAuthorityFileName>
<nhm:letterOfAuthorityFileContent></nhm:letterOfAuthorityFileContent
>
<nhm:invoiceDocumentFileName></nhm:invoiceDocumentFileName>
<nhm:invoicedocumentFileContent></nhm:invoicedocumentFileContent>
</nhm:portingAuthority>
<nhm:userName></nhm:userName>
<nhm:notes></nhm:notes>
<nhm:portType></nhm:portType>
</nh:portInDetails>
</nh:newPortInRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 48 / 189
Colt Number Hosting XML User Guide GB v0.8 49 / 189
Colt Number Hosting XML User Guide GB v0.8 50 / 189
Colt Number Hosting XML User Guide GB v0.8 51 / 189
Colt Number Hosting XML User Guide GB v0.8 52 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Required
2
nh:serviceHeader/
nhm:senderSystem Optional “Xml” to be used
3
nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:portInDetails Required
5
nh:portInDetails/
nhm:resellerProfile Required
6
nh:portInDetails/
nhm:resellerProfile/
nhm:serviceProfile Required 3 character length profile ID
7
nh:portInDetails/
nhm:resellerProfile/
nhm:productID Required “Geographic Number Hosting” for this phase.
8 nh:portInDetails/
nhm:resellerProfile/ nhm:Country
Required
GB
Colt Number Hosting XML User Guide GB v0.8 53 / 189
9
nh:portInDetails/
nhm:customerRef Optional
Customer Reference cannot be greater than 50 characters.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_,/\-\+\.'&" \w]*
10
nh:portInDetails/
nhm:endCustomerDetails Required
11
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerName Required
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9\w]+[A-Za-z0-9,/\-\+\.'&" \
w]*
12
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress Required
13
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
14
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
15
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
16 nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:premisesNumber
Optional Either one of building name and premises number must be
present.
The length of Building Number cannot be more than 20.
Colt Number Hosting XML User Guide GB v0.8 54 / 189
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*.
17
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:streetName Required
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
18
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:cityTown Required
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
19
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:state Optional
20
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Required Post Code should not be greater than 9 digits.
21
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:country Optional
22
nh:portInDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
26
nh:portInDetails/
nhm:newCustomerAddress Optional
27
nh:portInDetails/
nhm:newCustomerAddress/
nhm:floorSuite Optional
Colt Number Hosting XML User Guide GB v0.8 55 / 189
28
nh:portInDetails/
nhm:newCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
29
nh:portInDetails/
nhm:newCustomerAddress/
nhm:departmentBranch Optional
30
nh:portInDetails/
nhm:newCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and premises number must be
present.
The length of Building Number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
31
nh:portInDetails/
nhm:newCustomerAddress/
nhm:streetName Required
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
32
nh:portInDetails/
nhm:newCustomerAddress/
nhm:cityTown Required
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
33
nh:portInDetails/
nhm:newCustomerAddress/
nhm:state Optional
34
nh:portInDetails/
nhm:newCustomerAddress/
nhm:postalZipCode Required Post Code should not be greater than 9 digits.
35 nh:portInDetails/
nhm:newCustomerAddress/
Optional
Colt Number Hosting XML User Guide GB v0.8 56 / 189
nhm:country
36
nh:portInDetails/
nhm:newCustomerAddress/
nhm:poBoxNumber Optional
37
nh:portInDetails/
nhm:portInNumberDetails Required
38
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:mainBillingNumber Required
This is a list. At the max 5 values can be entered for Main
Billing Number. Only numeric values are allowed.
39
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:cliDetails Required
40
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:cliDetails/ nhm:areaCode Required Area Code could be of 3 or 4 or 5 digits.
41
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:cliDetails/
nhm:areaCodeExtn Required
Main Number 2 digits if Local Area Code = 5 digit or 3 digits if
Local Area Code is 4 digits or 4 digits if Local Area Code is 3
digits
42
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:cliDetails/ nhm:rangeStart Required Range start should be of 4 digits.
43
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:cliDetails/ nhm:rangeEnd Required Range end should be of 4 digits.
44
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:currentOperator Required
45
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:singleLine Optional
Enum value :
‘S’
Colt Number Hosting XML User Guide GB v0.8 57 / 189
46
nh:portInDetails/
nhm:portInNumberDetails[0]/
nhm:multiLine Optional
Enum value :
‘M’
47
nh:portInDetails/
nhm:originalRangeHolder Optional
48 nh:portInDetails/ nhm:portInDate Required
Porting Date can not be less than current date.
The Porting Date should be excluding Saturdays.
The Porting Date should be excluding Sundays.
The Porting Date needs to be at least seven weekdays from
the current date.
49
nh:portInDetails/
nhm:portInWindow Required
Allowed values:
0730-0900,0900-1100,1100-1300,1300-1500,1500-
1700,1700-1900
50
nh:portInDetails/
nhm:switchMaintainer Optional
51
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerFirstName Optional
Max length allowed is 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerLastName Optional
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
53
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerPhone Optional
Phone number must be greater than or equal to 10 digits.
Only numeric allowed.
54
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerMobile Optional
Mobile number must be greater than or equal to 10 digits.
Only numeric allowed.
Colt Number Hosting XML User Guide GB v0.8 58 / 189
55
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerEmail Optional
Values are allowed as per the below regex pattern:
^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerFax Optional
Fax number must be greater than or equal to 10 digits.
Only numeric allowed.
56
nh:portInDetails/
nhm:directoryServicesDetails Optional
57
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:orderType Required
New
58
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerName Required
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
59
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:businesssuffix Optional
60
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:businessDescription Optional
61
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:subHeader Optional
62
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:subSubHeader Optional
63
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:subSubSubHeader Optional
Colt Number Hosting XML User Guide GB v0.8 59 / 189
64
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:qualifier Optional
65
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress Required
66
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
67
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
68
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
69
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and premises number must be
present.
The length of Building Number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
70 nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:streetName
Required The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
Colt Number Hosting XML User Guide GB v0.8 60 / 189
71
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:cityTown Required
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
72
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:state Optional
73
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Required The length of post code should not be greater than 9.
74
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:country Optional
75
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
76
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:telephoneNumnber Required
Telephone Number should not be less than 10 digits.
Only numeric is allowed.
77
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:lineType Required
Enum value:
Normal
78 nh:portInDetails/
nhm:directoryServicesDetails/
nhm:entryType
Required Enum value:
DE
DQR
XD/NC
Colt Number Hosting XML User Guide GB v0.8 61 / 189
79
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:tariff Required
Enum value:
Business
80
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:listingCategory Required
Enum value:
Single
Group
81
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:typeFace Required
Enum value:
Ordinary
Bold
Superbold
82
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:priority Required
Enum value:
A
S
Z
83
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:listingType Required
Enum value:
DQMain
DQAdditional
PB
84
nh:portInDetails/
nhm:directoryServicesDetails/
nhm:additionalIinstructions Optional
85
nh:portInDetails/
nhm:portingAuthority Optional
86
nh:portInDetails/
nhm:portingAuthority/
nhm:letterOfAuthorityFileName Required
87
nh:portInDetails/
nhm:portingAuthority/
nhm:letterOfAuthorityFileContent Required
88 nh:portInDetails/ nhm:userName Optional
Colt Number Hosting XML User Guide GB v0.8 62 / 189
3.4.2 New Port In Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as newPortInResponse. The root element consists of elements make up
the acknowledgement from COLT. An optional Success/Error Message is also included in
the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
Please note the fields marked with green indicator are optional fields.
3.5 Update Port In
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.5.1 Update port In Request
Colt Number Hosting XML User Guide GB v0.8 63 / 189
The diagram below describes the integration scenario for update portIn. The Reseller sends
an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface validates
and responds back with an acknowledgement XML containing transaction ID for the request.
If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample update Port In XML Request.
<?xml version="1.0"?>
Colt Number Hosting XML User Guide GB v0.8 64 / 189
<nh:updatePortInRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime>2013-02-21T12:07:00.000Z</nhm:creationTime>
</nh:serviceHeader>
<nh:portInDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>AKJ</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:portInTranxRef>2013021819</nhm:portInTranxRef>
<nhm:newPortInDate>2013-03-04Z</nhm:newPortInDate>
<nhm:newPortInWindow>0730-0900</nhm:newPortInWindow>
<nhm:userName></nhm:userName>
</nh:portInDetails>
</nh:updatePortInRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 65 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Required
2 nh:serviceHeader/ nhm:senderSystem Optional ‘Xml’ to be used
3
nh:serviceHeader/ nhm:creationTime
Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:portInDetails Required
5 nh:portInDetails/ nhm:resellerProfile Required
6nh:portInDetails/ nhm:resellerProfile/
nhm:serviceProfileRequired 3 character length profile ID
Colt Number Hosting XML User Guide GB v0.8 66 / 189
7nh:portInDetails/ nhm:resellerProfile/
nhm:productIDRequired “Geographic Number Hosting” for this phase.
8nh:portInDetails/ nhm:resellerProfile/
nhm:CountryOptional
GB
9nh:portInDetails/ nhm:portInTranxRef
Required Transaction ID should not be greater than 25
characters.
10
nh:portInDetails/ nhm:newPortInDate
Required
Porting Date can not be less than current date.
The Porting Date should be excluding Saturdays.
The Porting Date should be excluding Sundays.
The Porting Date needs to be at least seven
weekdays from the current date.
nh:portInDetails/
nhm:newPortInWindow
Required
Allowed values are –
0730-0900,0900-1100,1100-1300,1300-
1500,1500-1700,1700-1900
11 nh:portInDetails/ nhm:userName Optional
nh:portInDetails/
nhm:switchMaintainerOptional
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerFirstName Required
Max length allowed is 50.
Values are allowed as per the below regex
pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerLastName Required
Max length allowed is 80.
Values are allowed as per the below regex
pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerPhone
Required Phone number must be greater than or equal to
10 digits.
Colt Number Hosting XML User Guide GB v0.8 67 / 189
Only numeric allowed.
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerMobile Optional
Mobile number must be greater than or equal
to 10 digits.
Only numeric allowed.
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerEmail Required
Values are allowed as per the below regex
pattern:
^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
nh:portInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerFax Optional
Fax number must be greater than or equal to 10
digits.
Only numeric allowed.
3.5.2 Update Port In Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as updatePortInResponse. The root element consists of elements make
up the acknowledgement from COLT. An optional Success/Error Message is also included in
the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
3.6 Cancel Port In
Colt Number Hosting XML User Guide GB v0.8 68 / 189
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.6.1 Cancel Port In Request
The diagram below describes the integration scenario for cancel portIn. The Reseller sends
an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface validates
and responds back with an acknowledgement XML containing transaction ID for the request.
If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Message Structure:
Colt Number Hosting XML User Guide GB v0.8 69 / 189
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample Cancel Port In XML Request.
<?xml version="1.0"?>
<nh:cancelPortInRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime>2013-02-21T12:07:00.000Z</nhm:creationTime>
</nh:serviceHeader>
<nh:cancelPortInDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>AKJ</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:portInTranxRef>2013021821</nhm:portInTranxRef>
<nhm:userName></nhm:userName>
</nh:cancelPortInDetails>
</nh:cancelPortInRequest>
Data Structure:
Colt Number Hosting XML User Guide GB v0.8 70 / 189
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Mandatory
2 nh:serviceHeader/ Optional ‘Xml’ to be used
Colt Number Hosting XML User Guide GB v0.8 71 / 189
nhm:senderSystem
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:cancelPortInDetails Mandatory
5nh:cancelPortInDetails/
nhm:resellerProfile Mandatory
6
nh:cancelPortInDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7
nh:cancelPortInDetails/
nhm:resellerProfile/
nhm:productID Mandatory
“Geographic Number Hosting” for this phase.
8
nh:cancelPortInDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:cancelPortInDetails/
nhm:portInTranxRef Mandatory
Transaction ID should not be greater than 25
characters
10nh:cancelPortInDetails/
nhm:userName Optional
nh:cancelPortInDetails/
nhm:reason Optional
nh:cancelPortInDetails/
nhm:notes Optional
nh:cancelPortInDetails
/nhm:switchMaintainerOptional
nh:cancelPortInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerFirstNam
e Required
Max length allowed is 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
Colt Number Hosting XML User Guide GB v0.8 72 / 189
nh:cancelPortInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerLastName Required
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
nh:cancelPortInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerPhone Required
Phone number must be greater than or equal to 10
digits.
Only numeric allowed.
nh:cancelPortInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerMobile Optional
Mobile number must be greater than or equal to
10 digits.
Only numeric allowed.
nh:cancelPortInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerEmail Required
Values are allowed as per the below regex pattern:
^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
nh:cancelPortInDetails/
nhm:switchMaintainer/
nhm:switchMaintainerFax Optional
Faxk number must be greater than or equal to 10
digits.
Only numeric allowed.
3.6.2 Cancel port In Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as cancelPortInResponse. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
Colt Number Hosting XML User Guide GB v0.8 73 / 189
3.7 Number Activation
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.7.1 Number Activation Request
The diagram below describes the integration scenario for number activation. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and responds back with an acknowledgement XML containing transaction ID for
the request. If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Colt Number Hosting XML User Guide GB v0.8 74 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample number Activation XML Request.
<?xml version="1.0"?>
<nh:numberActivationRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
Colt Number Hosting XML User Guide GB v0.8 75 / 189
</nh:serviceHeader>
<nh:activationDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>BAH</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:cliDetails>
<nhm:areaCode>0105</nhm:areaCode>
<nhm:areaCodeExtn>234</nhm:areaCodeExtn>
<nhm:rangeStart>4561</nhm:rangeStart>
<nhm:rangeEnd>4561</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:newCustomerRef></nhm:newCustomerRef>
<nhm:endCustomerDetails>
<nhm:endCustomerName>colt</nhm:endCustomerName>
<nhm:customerType></nhm:customerType>
<nhm:title></nhm:title>
<nhm:firstName></nhm:firstName>
<nhm:lastName></nhm:lastName>
<nhm:registeredName></nhm:registeredName>
<nhm:customerVATnumber></nhm:customerVATnumber>
<nhm:endCustomerDateOfBirth></nhm:endCustomerDateOfBirth>
<nhm:endCustomerLanguage></nhm:endCustomerLanguage>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber>6-12</nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
Colt Number Hosting XML User Guide GB v0.8 76 / 189
<nhm:streetName>ERNEST-THUN-STRASSE</nhm:streetName>
<nhm:cityTown>Salzburg</nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode>5020</nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
</nhm:endCustomerDetails>
<nhm:directoryServicesDetails>
<nhm:orderType></nhm:orderType>
<nhm:endCustomerName></nhm:endCustomerName>
<nhm:businesssuffix></nhm:businesssuffix>
<nhm:businessDescription></nhm:businessDescription>
<nhm:subHeader></nhm:subHeader>
<nhm:subSubHeader></nhm:subSubHeader>
<nhm:subSubSubHeader></nhm:subSubSubHeader>
<nhm:qualifier></nhm:qualifier>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber></nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName></nhm:streetName>
<nhm:cityTown></nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode></nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
Colt Number Hosting XML User Guide GB v0.8 77 / 189
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
<nhm:telephoneNumber></nhm:telephoneNumber>
<nhm:lineType></nhm:lineType>
<nhm:entryType></nhm:entryType>
<nhm:tariff></nhm:tariff>
<nhm:listingCategory></nhm:listingCategory>
<nhm:typeFace></nhm:typeFace>
<nhm:priority></nhm:priority>
<nhm:listingType></nhm:listingType>
<nhm:additionalIinstructions></nhm:additionalIinstructions>
<nhm:companyRegistrationNumber></nhm:companyRegistrationNumber>
<nhm:companyEmailAddress></nhm:companyEmailAddress>
<nhm:codeAPE></nhm:codeAPE>
<nhm:usoWPStatusFlag></nhm:usoWPStatusFlag>
<nhm:otheMediaStatusFlag></nhm:otheMediaStatusFlag>
<nhm:usoDAStatusFlag></nhm:usoDAStatusFlag>
<nhm:salesFlag></nhm:salesFlag>
<nhm:reverseQueryFlag></nhm:reverseQueryFlag>
<nhm:serviceType></nhm:serviceType>
<nhm:deviceTypeId></nhm:deviceTypeId>
<nhm:listingLanguage></nhm:listingLanguage>
<nhm:areaCode></nhm:areaCode>
<nhm:areaCodeExtn></nhm:areaCodeExtn>
<nhm:rangeStart></nhm:rangeStart>
<nhm:rangeEnd></nhm:rangeEnd>
<nhm:changeType></nhm:changeType>
<nhm:newTelephoneNumber></nhm:newTelephoneNumber>
<nhm:firstName></nhm:firstName>
<nhm:middleName></nhm:middleName>
<nhm:lastName></nhm:lastName>
Colt Number Hosting XML User Guide GB v0.8 78 / 189
<nhm:addtionalInfo></nhm:addtionalInfo>
<nhm:publicationCode></nhm:publicationCode>
<nhm:propertyIndicator></nhm:propertyIndicator>
<nhm:HouseNumberAddition></nhm:HouseNumberAddition>
<nhm:usageType></nhm:usageType>
<nhm:networkType></nhm:networkType>
<nhm:directoryInfoNotes></nhm:directoryInfoNotes>
<nhm:telephoneNumnber></nhm:telephoneNumnber>
</nhm:directoryServicesDetails>
<nhm:userName></nhm:userName>
</nh:activationDetails>
</nh:numberActivationRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 79 / 189
Colt Number Hosting XML User Guide GB v0.8 80 / 189
Colt Number Hosting XML User Guide GB v0.8 81 / 189
Colt Number Hosting XML User Guide GB v0.8 82 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Mandatory
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:activationDetails Mandatory
5nh:activationDetails/
nhm:resellerProfile Mandatory
6 nh:activationDetails/ Mandatory 3 character length profile ID
Colt Number Hosting XML User Guide GB v0.8 83 / 189
nhm:resellerProfile/
nhm:serviceProfile
7
nh:activationDetails/
nhm:resellerProfile/
nhm:productID Mandatory
“Geographic Number Hosting” for this phase.
8
nh:activationDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:activationDetails/
nhm:cliDetails Mandatory
10nh:activationDetails/
nhm:cliDetails/ nhm:areaCode Mandatory Area code be of 3 or 4 or 5 digits.
11
nh:activationDetails/
nhm:cliDetails/
nhm:areaCodeExtn Mandatory
Main Number 2 digits if Local Area Code = 5 digit or 3 digits if
Local Area Code is 4 digits or 4 digits if Local Area Code is 3
digits.
12nh:activationDetails/
nhm:cliDetails/ nhm:rangeStart Mandatory Range Start should always be 4 digits
13nh:activationDetails/
nhm:cliDetails/ nhm:rangeEnd Mandatory Range End should always be 4 digits
14
15nh:activationDetails/
nhm:newCustomerRef Optional
The length of Updated Customer Refrence cannot be more
than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_,/\-\+\.'&" \w]*
16nh:activationDetails/
nhm:endCustomerDetails Mandatory
17nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerName Mandatory
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9\w]+[A-Za-z0-9,/\-\+\.'&" \
w]*
Colt Number Hosting XML User Guide GB v0.8 84 / 189
18
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress Mandatory
19
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
20nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name of cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
21
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
22
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and premises number must be
present.
The length of Building Number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
23
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:streetName Mandatory
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
24
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:cityTown Mandatory
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
Colt Number Hosting XML User Guide GB v0.8 85 / 189
25
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:state Optional
26
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Mandatory
The length of post code should not be greater than 9
27
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:country Optional
28
nh:activationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
43
nh:activationDetails/
nhm:directoryServicesDetails Optional
44
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:orderType Mandatory New
45
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerName Mandatory
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
46
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:businesssuffix Optional
47
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:businessDescription Optional
Colt Number Hosting XML User Guide GB v0.8 86 / 189
48
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:subHeader Optional
49
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:subSubHeader Optional
50
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:subSubSubHeader Optional
51
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:qualifier Optional
52
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress Mandatory
53
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
54
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
55
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
Colt Number Hosting XML User Guide GB v0.8 87 / 189
56
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and premises number must be
present.
The length of Building number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
57
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:streetName Mandatory
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
58
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:cityTown Mandatory
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
59
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:state Optional
60
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Mandatory The length of post code should not be greater than 9.
61
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:country Optional
62
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
63nh:activationDetails/
nhm:directoryServicesDetails/ Mandatory Telephone Number should not be less than 10 digits.
Colt Number Hosting XML User Guide GB v0.8 88 / 189
nhm:telephoneNumnber Only numeric is allowed.
64
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:lineType Mandatory
Enum Value:
Normal
65
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:entryType Mandatory
Enum Values :
DE,DQR.XD/NC
66
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:tariff Mandatory
Enum Value:
Business
67
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:listingCategory Mandatory
Enum Values:
Single,Group
68
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:typeFace Mandatory
Enum Values:
Ordinary,Bold,Superbold
69
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:priority Mandatory
Enum Values:
A,S,Z
70
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:listingType Mandatory
Enum Values:
DQMain,DQAdditional,PB
71
nh:activationDetails/
nhm:directoryServicesDetails/
nhm:additionalIinstructions Optional
72
nh:activationDetails/
nhm:userName Optional
Colt Number Hosting XML User Guide GB v0.8 89 / 189
3.7.2 Number Activation Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as numberActivationResponse. The root element consists of elements
make up the acknowledgement from COLT. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
3.8 Number Deactivation
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.8.1 Number Deactivation Request
The diagram below describes the integration scenario for number Deactivation. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
Colt Number Hosting XML User Guide GB v0.8 90 / 189
validates and responds back with an acknowledgement XML containing transaction ID for
the request. If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample number Deactivation XML Request.
<?xml version="1.0"?>
Colt Number Hosting XML User Guide GB v0.8 91 / 189
<nh:numberDeactivationRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
</nh:serviceHeader>
<nh:deactivationDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>BAH</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:cliDetails>
<nhm:areaCode>0662</nhm:areaCode>
<nhm:areaCodeExtn>234</nhm:areaCodeExtn>
<nhm:rangeStart>4561</nhm:rangeStart>
<nhm:rangeEnd>4561</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:directoryServicesDetails>
<nhm:orderType></nhm:orderType>
<nhm:endCustomerName></nhm:endCustomerName>
<nhm:businesssuffix></nhm:businesssuffix>
<nhm:businessDescription></nhm:businessDescription>
<nhm:subHeader></nhm:subHeader>
<nhm:subSubHeader></nhm:subSubHeader>
<nhm:subSubSubHeader></nhm:subSubSubHeader>
<nhm:qualifier></nhm:qualifier>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber></nhm:premisesNumber>
Colt Number Hosting XML User Guide GB v0.8 92 / 189
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName></nhm:streetName>
<nhm:cityTown></nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode></nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
<nhm:telephoneNumber></nhm:telephoneNumber>
<nhm:lineType></nhm:lineType>
<nhm:entryType></nhm:entryType>
<nhm:tariff></nhm:tariff>
<nhm:listingCategory></nhm:listingCategory>
<nhm:typeFace></nhm:typeFace>
<nhm:priority></nhm:priority>
<nhm:listingType></nhm:listingType>
<nhm:additionalIinstructions></nhm:additionalIinstructions>
<nhm:companyRegistrationNumber></nhm:companyRegistrationNumber>
<nhm:companyEmailAddress></nhm:companyEmailAddress>
<nhm:codeAPE></nhm:codeAPE>
<nhm:usoWPStatusFlag></nhm:usoWPStatusFlag>
<nhm:otheMediaStatusFlag></nhm:otheMediaStatusFlag>
<nhm:usoDAStatusFlag></nhm:usoDAStatusFlag>
<nhm:salesFlag></nhm:salesFlag>
<nhm:reverseQueryFlag></nhm:reverseQueryFlag>
<nhm:serviceType></nhm:serviceType>
<nhm:deviceTypeId></nhm:deviceTypeId>
Colt Number Hosting XML User Guide GB v0.8 93 / 189
<nhm:listingLanguage></nhm:listingLanguage>
<nhm:areaCode></nhm:areaCode>
<nhm:areaCodeExtn></nhm:areaCodeExtn>
<nhm:rangeStart></nhm:rangeStart>
<nhm:rangeEnd></nhm:rangeEnd>
<nhm:changeType></nhm:changeType>
<nhm:newTelephoneNumber></nhm:newTelephoneNumber>
<nhm:firstName></nhm:firstName>
<nhm:middleName></nhm:middleName>
<nhm:lastName></nhm:lastName>
<nhm:addtionalInfo></nhm:addtionalInfo>
<nhm:publicationCode></nhm:publicationCode>
<nhm:propertyIndicator></nhm:propertyIndicator>
<nhm:HouseNumberAddition></nhm:HouseNumberAddition>
<nhm:usageType></nhm:usageType>
<nhm:networkType></nhm:networkType>
<nhm:directoryInfoNotes></nhm:directoryInfoNotes>
<nhm:telephoneNumnber></nhm:telephoneNumnber>
</nhm:directoryServicesDetails>
<nhm:userName></nhm:userName>
</nh:deactivationDetails>
</nh:numberDeactivationRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 94 / 189
Colt Number Hosting XML User Guide GB v0.8 95 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element name Required Description
Colt Number Hosting XML User Guide GB v0.8 96 / 189
Optional
1 nh:serviceHeader Mandatory
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:deactivationDetails Mandatory
5nh:deactivationDetails/
nhm:resellerProfile Mandatory
6
nh:deactivationDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7
nh:deactivationDetails/
nhm:resellerProfile/
nhm:productID Mandatory
“Geographic Number Hosting” for this phase.
8
nh:deactivationDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:deactivationDetails/
nhm:cliDetails Mandatory
10nh:deactivationDetails/
nhm:cliDetails/ nhm:areaCode Mandatory Area Code could be 3 or 4 or 5 digits.
11
nh:deactivationDetails/
nhm:cliDetails/
nhm:areaCodeExtn Mandatory
Main Number 2 digits if Local Area Code = 5 digit or 3 digits if
Local Area Code is 4 digits or 4 digits if Local Area Code is 3
digits
12nh:deactivationDetails/
nhm:cliDetails/ nhm:rangeStart Mandatory Range Start is always 4 digits
13nh:deactivationDetails/
nhm:cliDetails/ nhm:rangeEnd Mandatory Range End is always 4 digits
Colt Number Hosting XML User Guide GB v0.8 97 / 189
15nh:deactivationDetails/
nhm:directoryServicesDetails Optional
16
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:orderType Mandatory
Cease
17nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerName Mandatory
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
18
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:businesssuffix Optional
19
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:businessDescription Optional
20
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:subHeader Optional
21
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:subSubHeader Optional
22
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:subSubSubHeader Optional
23
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:qualifier Optional
24nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress Mandatory
Colt Number Hosting XML User Guide GB v0.8 98 / 189
25
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
26nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
27
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
28
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and premises number must be
present.
The length of Building number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
29
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:streetName Mandatory
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
30
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:cityTown Mandatory
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
31 nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
Optional
Colt Number Hosting XML User Guide GB v0.8 99 / 189
nhm:state
32
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Mandatory The length of post code should not be greater than 9
33
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:country Optional
34
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
35
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:telephoneNumnber Mandatory
Telephone Number should not be less than 10 digits
Only numeric is allowed.
36
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:lineType Mandatory
Enum Value:
Normal
37
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:entryType Mandatory
Enum Values:
DE,DQR.XD/NC
38
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:tariff Mandatory
Enum Value:
Business
39
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:listingCategory Mandatory
Enum Values:
Single,Group
Colt Number Hosting XML User Guide GB v0.8 100 / 189
40
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:typeFace Mandatory
Enum Values:
Ordinary,Bold,Superbold
41
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:priority Mandatory
Enum Values:
A,S,Z
42
nh:deactivationDetails/
nhm:directoryServicesDetails/
nhm:listingType Mandatory
Enum Value:
Normal
44
nh:deactivationDetails/
nhm:userName Optional
3.8.2 Number Deactivation Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as numberDeactivationResponse. The root element consists of elements
make up the acknowledgement from COLT. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway.
Colt Number Hosting XML User Guide GB v0.8 101 / 189
3.9 Number Reactivation
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.9.1 Number Reactivation Request
The diagram below describes the integration scenario for number reactivation. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and responds back with an acknowledgement XML containing transaction ID for
the request. If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Colt Number Hosting XML User Guide GB v0.8 102 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample number reactivation XML Request.
<?xml version="1.0"?>
<nh:numberReActivationRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
</nh:serviceHeader>
<nh:reactivationDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>BAH</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:cliDetails>
<nhm:areaCode>0106</nhm:areaCode>
<nhm:areaCodeExtn>398</nhm:areaCodeExtn>
<nhm:rangeStart>2060</nhm:rangeStart>
<nhm:rangeEnd>2060</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:newCustomerRef></nhm:newCustomerRef>
Colt Number Hosting XML User Guide GB v0.8 103 / 189
<nhm:endCustomerDetails>
<nhm:endCustomerName>colt</nhm:endCustomerName>
<nhm:customerType></nhm:customerType>
<nhm:title></nhm:title>
<nhm:firstName></nhm:firstName>
<nhm:lastName></nhm:lastName>
<nhm:registeredName></nhm:registeredName>
<nhm:customerVATnumber></nhm:customerVATnumber>
<nhm:endCustomerDateOfBirth></nhm:endCustomerDateOfBirth>
<nhm:endCustomerLanguage></nhm:endCustomerLanguage>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber>2-12</nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName>ERNEST-THUN-STRASSE</nhm:streetName>
<nhm:cityTown>Salzburg</nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode>502078988</nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
</nhm:endCustomerDetails>
<nhm:directoryServicesDetails>
<nhm:orderType></nhm:orderType>
<nhm:endCustomerName></nhm:endCustomerName>
<nhm:businesssuffix></nhm:businesssuffix>
<nhm:businessDescription></nhm:businessDescription>
Colt Number Hosting XML User Guide GB v0.8 104 / 189
<nhm:subHeader></nhm:subHeader>
<nhm:subSubHeader></nhm:subSubHeader>
<nhm:subSubSubHeader></nhm:subSubSubHeader>
<nhm:qualifier></nhm:qualifier>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber></nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName></nhm:streetName>
<nhm:cityTown></nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode></nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
<nhm:telephoneNumber>0662234561</nhm:telephoneNumber>
<nhm:lineType></nhm:lineType>
<nhm:entryType></nhm:entryType>
<nhm:tariff></nhm:tariff>
<nhm:listingCategory></nhm:listingCategory>
<nhm:typeFace></nhm:typeFace>
<nhm:priority></nhm:priority>
<nhm:listingType></nhm:listingType>
<nhm:additionalIinstructions></nhm:additionalIinstructions>
<nhm:companyRegistrationNumber></nhm:companyRegistrationNumber>
<nhm:companyEmailAddress></nhm:companyEmailAddress>
Colt Number Hosting XML User Guide GB v0.8 105 / 189
<nhm:codeAPE></nhm:codeAPE>
<nhm:usoWPStatusFlag></nhm:usoWPStatusFlag>
<nhm:otheMediaStatusFlag></nhm:otheMediaStatusFlag>
<nhm:usoDAStatusFlag></nhm:usoDAStatusFlag>
<nhm:salesFlag></nhm:salesFlag>
<nhm:reverseQueryFlag></nhm:reverseQueryFlag>
<nhm:serviceType></nhm:serviceType>
<nhm:deviceTypeId></nhm:deviceTypeId>
<nhm:listingLanguage></nhm:listingLanguage>
<nhm:areaCode></nhm:areaCode>
<nhm:areaCodeExtn></nhm:areaCodeExtn>
<nhm:rangeStart></nhm:rangeStart>
<nhm:rangeEnd></nhm:rangeEnd>
<nhm:changeType></nhm:changeType>
<nhm:newTelephoneNumber></nhm:newTelephoneNumber>
<nhm:firstName></nhm:firstName>
<nhm:middleName></nhm:middleName>
<nhm:lastName></nhm:lastName>
<nhm:addtionalInfo></nhm:addtionalInfo>
<nhm:publicationCode></nhm:publicationCode>
<nhm:propertyIndicator></nhm:propertyIndicator>
<nhm:HouseNumberAddition></nhm:HouseNumberAddition>
<nhm:usageType></nhm:usageType>
<nhm:networkType></nhm:networkType>
<nhm:directoryInfoNotes></nhm:directoryInfoNotes>
</nhm:directoryServicesDetails>
<nhm:userName></nhm:userName>
</nh:reactivationDetails>
</nh:numberReActivationRequest>
Data Structure:
Colt Number Hosting XML User Guide GB v0.8 106 / 189
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 107 / 189
Colt Number Hosting XML User Guide GB v0.8 108 / 189
Please note the fields marked with green indicator are optional fields.
Colt Number Hosting XML User Guide GB v0.8 109 / 189
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Mandatory
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:reactivationDetails Mandatory
5nh:reactivationDetails/
nhm:resellerProfile Mandatory
6
nh:reactivationDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7
nh:reactivationDetails/
nhm:resellerProfile/
nhm:productID Mandatory
“Geographic Number Hosting” for this phase.
8
nh:reactivationDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:reactivationDetails/
nhm:cliDetails Mandatory
10nh:reactivationDetails/
nhm:cliDetails/ nhm:areaCode Mandatory Area code be of 3 or 4 or 5 digits.
11
nh:reactivationDetails/
nhm:cliDetails/
nhm:areaCodeExtn Mandatory
Main Number 2 digits if Local Area Code = 5 digit or 3 digits if
Local Area Code is 4 digits or 4 digits if Local Area Code is 3
digits
12nh:reactivationDetails/
nhm:cliDetails/ nhm:rangeStart Mandatory Range Start should always be 4 digits
13 nh:reactivationDetails/ Mandatory Range End should always be 4 digits
Colt Number Hosting XML User Guide GB v0.8 110 / 189
nhm:cliDetails/ nhm:rangeEnd
14
15nh:reactivationDetails/
nhm:newCustomerRef Optional
The length of Updated Customer Refrence cannot be more
than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_,/\-\+\.'&" \w]*
16nh:reactivationDetails/
nhm:endCustomerDetails Mandatory
17nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerName Mandatory
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9\w]+[A-Za-z0-9,/\-\+\.'&" \
w]*
18
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress Mandatory
19
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
20nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
21
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
22 nh:reactivationDetails/
nhm:endCustomerDetails/ Optional Either one of building name and premises number must be
Colt Number Hosting XML User Guide GB v0.8 111 / 189
nhm:endCustomerAddress/
nhm:premisesNumber
present.
The length of Building number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
23
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:streetName Mandatory
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
24
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:cityTown Mandatory
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
25
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:state Optional
26
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Mandatory
The length of post code should not be greater than 9
27
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:country Optional
28
nh:reactivationDetails/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
43
nh:reactivationDetails/
nhm:directoryServicesDetails
Optional
44 nh:reactivationDetails/ Mandatory
Colt Number Hosting XML User Guide GB v0.8 112 / 189
nhm:directoryServicesDetails/
nhm:orderType New
45
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerName Mandatory
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
46
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:businesssuffix Optional
47
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:businessDescription Optional
48
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:subHeader Optional
49
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:subSubHeader Optional
50
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:subSubSubHeader Optional
51
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:qualifier Optional
52
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress Mandatory
53
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
Colt Number Hosting XML User Guide GB v0.8 113 / 189
54
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
55
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
56
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and premises number must be
present.
The length of Building number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
57
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:streetName Mandatory
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
58
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:cityTown Mandatory
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
59
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:state Optional
60
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Mandatory The length of post code should not be greater than 9.
Colt Number Hosting XML User Guide GB v0.8 114 / 189
61
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:country Optional
62
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
63
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:telephoneNumnber Mandatory
Telephone Number should not be less than 10 digits.
Only numeric is allowed.
64
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:lineType Mandatory
Enum Value:
Normal
65
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:entryType Mandatory
Enum Values :
DE,DQR.XD/NC
66
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:tariff Mandatory
Enum Value:
Business
67
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:listingCategory Mandatory
Enum Values:
Single,Group
68
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:typeFace Mandatory
Enum Values:
Ordinary,Bold,Superbold
69
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:priority Mandatory
Enum Values:
A,S,Z
Colt Number Hosting XML User Guide GB v0.8 115 / 189
70
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:listingType Mandatory
Enum Values:
DQMain,DQAdditional,PB
71
nh:reactivationDetails/
nhm:directoryServicesDetails/
nhm:additionalIinstructions Optional
72
nh:reactivationDetails/
nhm:userName Optional
3.9.2 Number reactivation Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as numberActivationResponse. The root element consists of elements
make up the acknowledgement from COLT. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
3.10 Get Transaction List
Colt Number Hosting XML User Guide GB v0.8 116 / 189
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.10.1 Get Transaction List Request
The diagram below describes the integration scenario for Get Transaction List. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and forwards the request to cocom to fetch the transaction list. B2B Gateway
responds back with an acknowledgement XML containing the list of transactions. If not
successful the response will contain Error messages.
Colt Number Hosting XML User Guide GB v0.8 117 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample Get Transaction List XML Request.
<?xml version="1.0"?>
<nh:getTransactionListRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime>2013-01-21T12:07:00.000Z</nhm:creationTime>
</nh:serviceHeader>
<nh:transactionListDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>AKJ</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:dateFrom>2013-01-08T12:07:00.000Z</nhm:dateFrom>
<nhm:dateTo>2013-01-21T12:07:00.000Z</nhm:dateTo>
</nh:transactionListDetails>
</nh:getTransactionListRequest>
Data Structure:
Colt Number Hosting XML User Guide GB v0.8 118 / 189
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Mandatory
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:transactionListDetails Mandatory
5nh:transactionListDetails/
nhm:resellerProfile Mandatory
6
nh:transactionListDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7 nh:transactionListDetails/
nhm:resellerProfile/ Mandatory“Geographic Number Hosting” for this phase.
Colt Number Hosting XML User Guide GB v0.8 119 / 189
nhm:productID
8
nh:transactionListDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:transactionListDetails/
nhm:dateFrom Mandatory
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
10
nh:transactionListDetails/
nhm:dateTo Mandatory
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
End date has to be greater than or equal to start date.
3.10.2 Get Transaction List Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as getTransactionListResponse. The root element consists of elements
make up the acknowledgement from COLT. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
Colt Number Hosting XML User Guide GB v0.8 120 / 189
3.11 Get Transaction Details
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.11.1 Get Transaction Details Request
The diagram below describes the integration scenario for Get Transaction Details. The
Reseller sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway
interface validates and forwards the request to cocom to fetch the transaction details. B2B
Gateway responds back with an acknowledgement XML containing the details of the
transactions. If not successful the response will contain Error messages.
Colt Number Hosting XML User Guide GB v0.8 121 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample Get Transaction Details XML Request.
<?xml version="1.0"?>
<nh:getTransactionDetailsRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
Colt Number Hosting XML User Guide GB v0.8 122 / 189
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime>2013-01-21T12:07:00.000Z</nhm:creationTime>
</nh:serviceHeader>
<nh:transactionDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>AKJ</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:transactionId>2013012524</nhm:transactionId>
</nh:transactionDetails>
</nh:getTransactionDetailsRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
Colt Number Hosting XML User Guide GB v0.8 123 / 189
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Mandatory
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:transactionDetails Mandatory
5nh:transactionDetails/
nhm:resellerProfile Mandatory
6
nh:transactionDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7
nh:transactionDetails/
nhm:resellerProfile/
nhm:productID Mandatory
“Geographic Number Hosting” for this phase.
8
nh:transactionDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:transactionDetails/
nhm:transactionId MandatoryMust be a valid transaction id.
3.11.2 Get Transaction Details Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as getTransactionDetailsResponse. The root element consists of
elements make up the acknowledgement from COLT. An optional Success/Error Message is
also included in the response.
Colt Number Hosting XML User Guide GB v0.8 124 / 189
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
Colt Number Hosting XML User Guide GB v0.8 125 / 189
Colt Number Hosting XML User Guide GB v0.8 126 / 189
Colt Number Hosting XML User Guide GB v0.8 127 / 189
3.12 Number Reservation
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.12.1 Number Reservation Request
The diagram below describes the integration scenario for number Reservation. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and responds back with an acknowledgement XML containing transaction ID for
the request. If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Colt Number Hosting XML User Guide GB v0.8 128 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample Number Reservation XML Request.
<?xml version="1.0"?>
<nh:numberReservationRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
Colt Number Hosting XML User Guide GB v0.8 129 / 189
<nhm:creationTime>2013-01-08T12:07:00.000Z</nhm:creationTime>
</nh:serviceHeader>
<nh:reservationRequestDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>AKJ</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:cliDetails>
<nhm:areaCode>0121</nhm:areaCode>
<nhm:areaCodeExtn>434</nhm:areaCodeExtn>
<nhm:rangeStart>8989</nhm:rangeStart>
<nhm:rangeEnd>8989</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:customerRef></nhm:customerRef>
<nhm:userName>NHttpUser</nhm:userName>
</nh:reservationRequestDetails>
</nh:numberReservationRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 130 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:reservationDetails Mandatory
5nh:reservationDetails/
nhm:resellerProfile Mandatory
6
nh:reservationDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
Colt Number Hosting XML User Guide GB v0.8 131 / 189
7
nh:reservationRequestDetails/
nhm:resellerProfile/
nhm:productID Mandatory
“Geographic Number Hosting” for this phase.
8
nh:reservationDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:reservationDetails/
nhm:cliDetails Mandatory
10nh:reservationDetails/
nhm:cliDetails/ nhm:areaCode Mandatory Area Code could be 3 or 4 or 5 digits.
11
nh:reservationDetails/
nhm:cliDetails/
nhm:areaCodeExtn Mandatory
Main Number 2 digits if Local Area Code = 5 digit or 3
digits if Local Area Code is 4 digits or 4 digits if Local
Area Code is 3 digits
12
nh:reservationDetails/
nhm:cliDetails/
nhm:rangeStart Mandatory
Range Start should always be 4 digits
13nh:reservationDetails/
nhm:cliDetails/ nhm:rangeEnd Mandatory Range End should always be 4 digits
14 nh:reservationDetails/
nhm:customerReference Optional
Max allowed 50 chars.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_,/\-\+\.'&" \w]*
15nh:reservationDetails/
nhm:userName Optional
3.12.2 Number Reservation Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as numberReservationResponse. The root element consists of elements
Colt Number Hosting XML User Guide GB v0.8 132 / 189
make up the acknowledgement from COLT. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
3.13 Extend Reservation
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.13.1 Extend Reservation Request
The diagram below describes the integration scenario for Extend Reservation. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and responds back with an acknowledgement XML containing transaction ID for
the request. If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Colt Number Hosting XML User Guide GB v0.8 133 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample Extend Reservation XML Request.
<?xml version="1.0"?>
<nh:extendReservationRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
Colt Number Hosting XML User Guide GB v0.8 134 / 189
<nhm:creationTime>2013-01-21T12:07:00.000Z</nhm:creationTime>
</nh:serviceHeader>
<nh:extensionDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>AKJ</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:cliDetails>
<nhm:areaCode>0113</nhm:areaCode>
<nhm:areaCodeExtn>111</nhm:areaCodeExtn>
<nhm:rangeStart>1009</nhm:rangeStart>
<nhm:rangeEnd>1009</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:userName>NHttpUser</nhm:userName>
</nh:extensionDetails>
</nh:extendReservationRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 135 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:extentionDetails Mandatory
5nh:extentionDetails/
nhm:resellerProfile Mandatory
6
nh:extentionDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7 nh:extensionDetails/ Mandatory “Geographic Number Hosting” for this phase.
Colt Number Hosting XML User Guide GB v0.8 136 / 189
nhm:resellerProfile/
nhm:productID
8
nh:extentionDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:extentionDetails/
nhm:cliDetails Mandatory
10nh:extentionDetails/
nhm:cliDetails/ nhm:areaCode Mandatory Area code should be 3 or 4 or 5 digits.
11
nh:extentionDetails/
nhm:cliDetails/
nhm:areaCodeExtn Mandatory
Main Number 2 digits if Local Area Code = 5 digit or 3 digits
if Local Area Code is 4 digits or 4 digits if Local Area Code is 3
digits
12nh:extentionDetails/
nhm:cliDetails/ nhm:rangeStart Mandatory Range Start should be 4 digits.
13nh:extentionDetails/
nhm:cliDetails/ nhm:rangeEnd Mandatory Range End should be 4 digits.
16nh:extentionDetails/
nhm:userName Optional
3.13.2 Extend Reservation Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as extendReservationResponse. The root element consists of elements
make up the acknowledgement from COLT. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway.
Colt Number Hosting XML User Guide GB v0.8 137 / 189
3.14 Cancel Reservation
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.14.1 Cancel Reservation Request
The diagram below describes the integration scenario for cancel Reservation. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and responds back with an acknowledgement XML containing transaction ID for
the request. If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Colt Number Hosting XML User Guide GB v0.8 138 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample Cancel Reservation XML Request.
<?xml version="1.0"?>
<nh:cancelReservationRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
Colt Number Hosting XML User Guide GB v0.8 139 / 189
<nhm:creationTime>2013-01-21T12:07:00.000Z</nhm:creationTime>
</nh:serviceHeader>
<nh:cancellationDetails>
<nhm:resellerProfile>
<nhm:serviceProfile>AKJ</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:cliDetails>
<nhm:areaCode>0113</nhm:areaCode>
<nhm:areaCodeExtn>111</nhm:areaCodeExtn>
<nhm:rangeStart>1009</nhm:rangeStart>
<nhm:rangeEnd>1009</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:userName>NHttpUser</nhm:userName>
</nh:cancellationDetails>
</nh:cancelReservationRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 140 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1nh:serviceHeader
Mandator
y
2nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4nh:cancellationDetails
Mandator
y
5nh:cancellationDetails/
nhm:resellerProfile
Mandator
y
6
nh:cancellationDetails/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7 nh:cancellationDetails/ Mandatory “Geographic Number Hosting” for this phase.
Colt Number Hosting XML User Guide GB v0.8 141 / 189
nhm:resellerProfile/
nhm:productID
8
nh:cancellationDetails/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:cancellationDetails/
nhm:cliDetails
Mandator
y
10nh:cancellationDetails/
nhm:cliDetails/ nhm:areaCode Mandatory Area code should be 3 or 4 or 5 digits.
11
nh:cancellationDetails/
nhm:cliDetails/
nhm:areaCodeExtn Mandatory
Main Number 2 digits if Local Area Code = 5 digit or 3 digits
if Local Area Code is 4 digits or 4 digits if Local Area Code is 3
digits
12nh:cancellationDetails/
nhm:cliDetails/ nhm:rangeStart Mandatory Range Start should always be 4 digits
13nh:cancellationDetails/
nhm:cliDetails/ nhm:rangeEnd Mandatory Range End should always be 4 digits
15nh:cancellationDetails/
nhm:userName Optional
3.14.2 Cancel Reservation Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as cancelReservationResponse. The root element consists of elements
make up the acknowledgement from COLT. An optional Success/Error Message is also
included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
Colt Number Hosting XML User Guide GB v0.8 142 / 189
3.15 Update Directory Services
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.15.1 Update Directory Services Request
The diagram below describes the integration scenario for updtae Directory Services. The
Reseller sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway
interface validates and responds back with an acknowledgement XML containing transaction
ID for the request. If not successful the response will contain Error messages.
The transaction ID should be stored by the reseller as reference for subsequent queries with
the B2B Gateway interface.
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
Colt Number Hosting XML User Guide GB v0.8 143 / 189
A Sample Update Directory Services XML Request.
<nh:updateDirectoryServicesRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
</nh:serviceHeader>
<nh:directoryServices>
<nhm:resellerProfile>
<nhm:serviceProfile>BAH</nhm:serviceProfile>
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:directoryServicesDetails>
<nhm:orderType>New</nhm:orderType>
<nhm:endCustomerName></nhm:endCustomerName>
<nhm:businesssuffix></nhm:businesssuffix>
<nhm:businessDescription></nhm:businessDescription>
<nhm:subHeader></nhm:subHeader>
<nhm:subSubHeader></nhm:subSubHeader>
<nhm:subSubSubHeader></nhm:subSubSubHeader>
<nhm:qualifier></nhm:qualifier>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber></nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
Colt Number Hosting XML User Guide GB v0.8 144 / 189
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName></nhm:streetName>
<nhm:cityTown></nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode></nhm:postalZipCode>
<nhm:country></nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
<nhm:telephoneNumber>0662234561</nhm:telephoneNumber>
<nhm:lineType></nhm:lineType>
<nhm:entryType></nhm:entryType>
<nhm:tariff></nhm:tariff>
<nhm:listingCategory></nhm:listingCategory>
<nhm:typeFace></nhm:typeFace>
<nhm:priority></nhm:priority>
<nhm:listingType></nhm:listingType>
<nhm:additionalIinstructions></nhm:additionalIinstructions>
<nhm:companyRegistrationNumber></nhm:companyRegistrationNumber>
<nhm:companyEmailAddress></nhm:companyEmailAddress>
<nhm:codeAPE></nhm:codeAPE>
<nhm:usoWPStatusFlag></nhm:usoWPStatusFlag>
<nhm:otheMediaStatusFlag></nhm:otheMediaStatusFlag>
<nhm:usoDAStatusFlag></nhm:usoDAStatusFlag>
<nhm:salesFlag></nhm:salesFlag>
<nhm:reverseQueryFlag></nhm:reverseQueryFlag>
<nhm:serviceType></nhm:serviceType>
<nhm:deviceTypeId></nhm:deviceTypeId>
<nhm:listingLanguage></nhm:listingLanguage>
Colt Number Hosting XML User Guide GB v0.8 145 / 189
<nhm:areaCode></nhm:areaCode>
<nhm:areaCodeExtn></nhm:areaCodeExtn>
<nhm:rangeStart></nhm:rangeStart>
<nhm:rangeEnd></nhm:rangeEnd>
<nhm:changeType></nhm:changeType>
<nhm:newTelephoneNumber></nhm:newTelephoneNumber>
<nhm:firstName></nhm:firstName>
<nhm:middleName></nhm:middleName>
<nhm:lastName></nhm:lastName>
<nhm:addtionalInfo></nhm:addtionalInfo>
<nhm:publicationCode></nhm:publicationCode>
<nhm:propertyIndicator></nhm:propertyIndicator>
<nhm:HouseNumberAddition></nhm:HouseNumberAddition>
<nhm:usageType></nhm:usageType>
<nhm:networkType></nhm:networkType>
<nhm:directoryInfoNotes>errtrtyyuu</nhm:directoryInfoNotes>
<nhm:telephoneNumnber></nhm:telephoneNumnber>
</nhm:directoryServicesDetails>
<nhm:userName></nhm:userName>
</nh:directoryServices>
</nh:updateDirectoryServicesRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 146 / 189
Colt Number Hosting XML User Guide GB v0.8 147 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired
OptionalDescription
1 nh:serviceHeader Mandatory
2 nh:serviceHeader/
nhm:senderSystem Optional ‘Xml’ to be used.
Colt Number Hosting XML User Guide GB v0.8 148 / 189
3 nh:serviceHeader/
nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4 nh:directoryServices Mandatory
5nh:directoryServices/
nhm:resellerProfile Mandatory
6
nh:directoryServices/
nhm:resellerProfile/
nhm:serviceProfile Mandatory
3 character length profile ID
7
nh:directoryServices/
nhm:resellerProfile/
nhm:productID Mandatory
“Geographic Number Hosting” for this phase.
8
nh:directoryServices/
nhm:resellerProfile/
nhm:Country Mandatory
GB
9nh:directoryServices/
nhm:directoryServicesDetails Mandatory
10
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:orderType Mandatory
Enum Values:
New,Cease,Amend
11nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerName Mandatory
Max length allowed is 80.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9_,/\-\
+\.'&" \w]*
12
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:businesssuffix Optional
13
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:businessDescription Optional
Colt Number Hosting XML User Guide GB v0.8 149 / 189
14
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:subHeader Optional
15
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:subSubHeader Optional
16
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:subSubSubHeader Optional
17
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:qualifier Optional
18
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress Mandatory
19
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:floorSuite Optional
20nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and premises number must be
present.
The length of Building Name cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
21
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
Colt Number Hosting XML User Guide GB v0.8 150 / 189
22
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and premises number must be
present.
The length of Building number cannot be more than 20.
Values are allowed as per the below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)
23
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:streetName Mandatory
The length of Street cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
24
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:cityTown Mandatory
The length of City/Town cannot be more than 50.
Values are allowed as per the below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
25
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:state Optional
26
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Mandatory
The length of post code should not be greater than 9.
27
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:country Optional
28
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
29nh:directoryServices/
nhm:directoryServicesDetails/ Mandatory Telephone Number should not be less than 10 digits.
Colt Number Hosting XML User Guide GB v0.8 151 / 189
nhm:telephoneNumnber Only numeric is allowed.
30
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:lineType Mandatory
Enum Value:
Normal
31
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:entryType Mandatory
Enum Values:
DE,DQR.XD/NC
32
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:tariff Mandatory
Enum Value:
Business
33
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:listingCategory Mandatory
Enum Values:
Single,Group
34
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:typeFace Mandatory
Enum Values:
Ordinary,Bold,Superbold
35
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:priority Mandatory
Enum Values:
A,S,Z
36
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:listingType Mandatory
Enum Values:
DQMain,DQAdditional,PB
37
nh:directoryServices/
nhm:directoryServicesDetails/
nhm:additionalIinstructions Optional
38
nh:directoryServices/
nhm:userName Optional
3.15.2 Update Directory Services Response
Data structure:
Colt Number Hosting XML User Guide GB v0.8 152 / 189
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as updateDirectoryServicesResponse. The root element consists of
elements make up the acknowledgement from COLT. An optional Success/Error Message is
also included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
3.16 Update EndCustomer Address
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
Colt Number Hosting XML User Guide GB v0.8 153 / 189
3.16.1 Update EndCustomer Address Request
The diagram below describes the integration scenario for update EndCustomer addess. The
reseller or NH customer sends an XML Request to the COLT B2B Gateway interface. The
B2B Gateway interface validates and responds back with an acknowledgement XML
containing transaction ID for the request. If not successful the response will contain Error
messages.
Colt Number Hosting XML User Guide GB v0.8 154 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample Update EndCustomer address Services XML Request.
<?xml version="1.0"?>
<nh:updateEndCustomerAddressRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
</nh:serviceHeader>
<nh:endCustomerAddressUpdateDetail>
<nhm:resellerProfile>
<nhm:serviceProfile>BAH</nhm:serviceProfile>
Colt Number Hosting XML User Guide GB v0.8 155 / 189
<nhm:productID>Geographic Number
Hosting</nhm:productID>
<nhm:Country>GB</nhm:Country>
</nhm:resellerProfile>
<nhm:cliDetails>
<nhm:areaCode>0105</nhm:areaCode>
<nhm:areaCodeExtn>396</nhm:areaCodeExtn>
<nhm:rangeStart>2062</nhm:rangeStart>
<nhm:rangeEnd>2062</nhm:rangeEnd>
</nhm:cliDetails>
<nhm:endCustomerDetails>
<nhm:endCustomerName>colt</nhm:endCustomerName>
<nhm:customerType>Business</nhm:customerType>
<nhm:title></nhm:title>
<nhm:firstName></nhm:firstName>
<nhm:lastName></nhm:lastName>
<nhm:registeredName></nhm:registeredName>
<nhm:customerVATnumber></nhm:customerVATnumber>
<nhm:endCustomerDateOfBirth></nhm:endCustomerDateOfBirth>
<nhm:endCustomerLanguage></nhm:endCustomerLanguage>
<nhm:endCustomerAddress>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber>2-12</nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName>ERNEST-THUN-STRASSE</nhm:streetName>
<nhm:cityTown>Salzburg</nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode>502089765</nhm:postalZipCode>
<nhm:country></nhm:country>
Colt Number Hosting XML User Guide GB v0.8 156 / 189
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:endCustomerAddress>
</nhm:endCustomerDetails>
<nhm:userName></nhm:userName>
</nh:endCustomerAddressUpdateDetail>
</nh:updateEndCustomerAddressRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. The root element contains
a group of attributes which are all required and must be filled in by the Reseller for each
online request via HTTPS
Colt Number Hosting XML User Guide GB v0.8 157 / 189
Root – Child Level Elements
#Element name
Required
/OptionalDescription
1. nh:updateEndCustomerAddressRequest/
nh:serviceHeader Required
2. nh:updateEndCustomerAddressRequest/
nh:serviceHeader/
nhm:senderSystem Optional
“Xml” to be passed.
3.
nh:updateEndCustomerAddressRequest/
nh:serviceHeader/nhm:creationTime Optional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
4. nh:updateEndCustomerAddressRequest
/nh:endCustomerAddressUpdateDetail Required
5. nh:updateEndCustomerAddressRequest
/nh:endCustomerAddressUpdateDetail/
nhm:resellerProfile Required
6.nh:updateEndCustomerAddressRequest
/nh:endCustomerAddressUpdateDetail/ Required3 char service profile ID
Colt Number Hosting XML User Guide GB v0.8 158 / 189
nhm:resellerProfile/nhm:serviceProfile
7. nh:updateEndCustomerAddressRequest
/nh:endCustomerAddressUpdateDetail/
nhm:resellerProfile/nhm:productID Required
Value must be “Geographic
Number Hosting “ for this phase.
8. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:resellerProfile/nhm:Country Required
GB
9. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:cliDetails Required
10. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:cliDetails/nhm:areaCode Required
Local Area Code should always be
between 3 or 4 to 5 digits.
11.
nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:cliDetails/nhm:areaCodeExtn Required
Main Number 2 digits if Local Area
Code = 5 digit or 3 digits if Local
Area Code is 4 digits or 4 digits if
Local Area Code is 3 digits
12. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:cliDetails/nhm:rangeStart Required
Range Start should always be 4
digits
13. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:cliDetails/nhm:rangeEnd Required
Range End should always be 4
digits
14. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails Required
15. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerName
Required Max length allowed is 80.
Values are allowed as per the
below regex pattern:
[A-Za-z0-9\w]+[A-Za-z0-9,/\-\
+\.'&" \
Colt Number Hosting XML User Guide GB v0.8 159 / 189
w]*
16. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress Required
17. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/nhm:floorSuite Optional
18.
nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:premisesNumber Optional
Either one of building name and
premises number must be
present.
The length of Building Name
cannot be more than 20.
Values are allowed as per the
below regex pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-
Za-z]*)*
19.
nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/nhm:streetName Required
The length of Street cannot be
more than 50.
Values are allowed as per the
below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\
+\.\
(\)'&" \
w]*
20. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/nhm:cityTown
Required The length of City/Town cannot be
more than 50.
Values are allowed as per the
below regex pattern:
Colt Number Hosting XML User Guide GB v0.8 160 / 189
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\
+\.\
(\)'&" \
w]*
21. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:postalZipCode Required
The length of post code should not
be greater than 9.
22. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:departmentBranch Optional
23.
nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:buildingName Optional
Either one of building name and
premises number must be
present.
The length of Building Name
cannot be more than 50.
Values are allowed as per the
below regex pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\
+\.\
(\)'&" \
w]*
24. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/nhm:state Optional
25. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/ Optional
Colt Number Hosting XML User Guide GB v0.8 161 / 189
nhm:endCustomerDetails/
nhm:endCustomerAddress/nhm:country
26. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:endCustomerDetails/
nhm:endCustomerAddress/
nhm:poBoxNumber Optional
27. nh:updateEndCustomerAddressRequest/
nh:endCustomerAddressUpdateDetail/
nhm:userName Optional
3.16.2 Update EndCustomer Address Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as updateEndCustomerAddressResponse. The root element consists of
elements make up the acknowledgement from COLT. An optional Success/Error Message is
also included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
3.17 Bulk Upload Transaction
Colt Number Hosting XML User Guide GB v0.8 162 / 189
User should be provided a functionality to send request in bulk for number activation and
port in through XML interface.
3.17.1 Bulk Upload Request
Customer can send numberActivation, numberPortIn and endCustomerAddressUpdate bulk requests using this functionality.
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
Note : A maximum of 200 transactions can be placed in a single request
Colt Number Hosting XML User Guide GB v0.8 163 / 189
Colt Number Hosting XML User Guide GB v0.8 164 / 189
Colt Number Hosting XML User Guide GB v0.8 165 / 189
Colt Number Hosting XML User Guide GB v0.8 166 / 189
Colt Number Hosting XML User Guide GB v0.8 167 / 189
Colt Number Hosting XML User Guide GB v0.8 168 / 189
Colt Number Hosting XML User Guide GB v0.8 169 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
Please refer NumberActivation , Port In,updateEndCustomerAddress In section (3.7 and
3.4,3.15) for description.
3.17.2 Bulk Upload Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as transactionDataUpdate Response. The root element consists of
elements make up the acknowledgement from COLT. An optional Success/Error Message is
also included in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
Colt Number Hosting XML User Guide GB v0.8 170 / 189
3.18 Validate Geo Number
Resellers can exchange data via HTTPS with COLT in the format defined by Colt XML
schema. Resellers have to exchange all XML data over HTTPS in a request and response
pattern, in other words, the reseller has to send an XML request and will be responded with
an Acknowledgement.
3.18.1 Validate GeoNumber Request
The diagram below describes the integration scenario for validate geo number. The Reseller
sends an XML Request to the COLT B2B Gateway interface. The B2B Gateway interface
validates and forwards the request to LAC system to validate the address and lac details.
B2B Gateway responds back with an response XML containing the validation result of the
request. If not successful the response will contain Error messages.
Colt Number Hosting XML User Guide GB v0.8 171 / 189
Message Structure:
The message structure format is XML and conforms to the schema attached below. The
validations on the fields are captured inside the schema. The XML Instance generated using
this schema should conform to the restrictions specified by the schema.
A Sample validateGeoNumber XML Request.
<?xml version="1.0"?>
<nh:validateGeoNumberRequest
xmlns:nh="http://www.colt.net/xml/ns/NumberHosting/v1.0"
xmlns:nhm="http://www.colt.net/xml/ns/cbe/nhm/v1.0">
<nh:serviceHeader>
<nhm:senderSystem>Xml</nhm:senderSystem>
<nhm:creationTime></nhm:creationTime>
</nh:serviceHeader>
<nh:validateGeoNumberDetails>
Colt Number Hosting XML User Guide GB v0.8 172 / 189
<nhm:address>
<nhm:floorSuite></nhm:floorSuite>
<nhm:flatNumber></nhm:flatNumber>
<nhm:premisesNumber>6-12</nhm:premisesNumber>
<nhm:premisesNumberLetter></nhm:premisesNumberLetter>
<nhm:buildingName></nhm:buildingName>
<nhm:departmentBranch></nhm:departmentBranch>
<nhm:streetName>ERNEST-THUN-STRASSE</nhm:streetName>
<nhm:municipalityName></nhm:municipalityName>
<nhm:cityTown>Salzburg</nhm:cityTown>
<nhm:state></nhm:state>
<nhm:postalZipCode>5020</nhm:postalZipCode>
<nhm:country>IE</nhm:country>
<nhm:poBoxNumber></nhm:poBoxNumber>
<nhm:cifNIF></nhm:cifNIF>
<nhm:extensionNumber></nhm:extensionNumber>
</nhm:address>
<nhm:numberRange>
<nhm:areaCode>0105</nhm:areaCode>
<nhm:areaCodeExtn>234</nhm:areaCodeExtn>
<nhm:rangeStart>4561</nhm:rangeStart>
<nhm:rangeEnd>4561</nhm:rangeEnd>
</nhm:numberRange>
</nh:validateGeoNumberDetails>
</nh:validateGeoNumberRequest>
Data Structure:
Shown below is the way XML Schema for a request is organized. must be filled in by the
Reseller for each online request via HTTPS.
Colt Number Hosting XML User Guide GB v0.8 173 / 189
Please note the fields marked with green indicator are optional fields.
Root – Child Level Elements
# Element nameRequired Optional
Description
1 nh:serviceHeader Mandatory
2nh:serviceHeader/
nhm:senderSystemOptional ‘Xml’ to be used.
3nh:serviceHeader/
nhm:creationTimeOptional
Format to be used is:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'
e.g.2016-02-03T12:00:00.152Z
Colt Number Hosting XML User Guide GB v0.8 174 / 189
4 nh:validateGeoNumberDetails/ nhm:address/ Mandatory
5 nh:validateGeoNumberDetails/ nhm:address/ nhm:floorSuite Optional
6
nh:validateGeoNumberDetails/
nhm:address/
nhm:buildingName
Optional
Either one of building name and premises
number must be present.
The length of Building Name of cannot be
more than 50.
Values are allowed as per the below regex
pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
7
nh:validateGeoNumberDetails/
nhm:address/
nhm:departmentBranch
Optional
8
nh:validateGeoNumberDetails/
nhm:address/
nhm:premisesNumber
Optional
Either one of building name and premises
number must be present.
The length of Building Number cannot be more
than 20.
Values are allowed as per the below regex
pattern:
[0-9]+[ ]?[A-Za-z]*([\- /][0-9]+[A-Za-z]*)*
9
nh:validateGeoNumberDetails/
nhm:address/
nhm:streetName
Mandatory
The length of Street cannot be more than 50.
Values are allowed as per the below regex
pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
10nh:validateGeoNumberDetails/
nhm:address/nhm:cityTownMandatory
The length of City/Town cannot be more than
50.
Values are allowed as per the below regex
pattern:
[A-Za-z0-9_\w]+[A-Za-z0-9:_,/\-\+\.\
(\)'&" \w]*
11nh:validateGeoNumberDetails/
nhm:address/nhm:stateOptional
Colt Number Hosting XML User Guide GB v0.8 175 / 189
12
nh:validateGeoNumberDetails/
nhm:address/
nhm:postalZipCode
MandatoryThe length of post code should not be greater
than 9
13nh:validateGeoNumberDetails/
nhm:address/nhm:countryMandatory Two digit country code. Here it would be GB
14
nh:validateGeoNumberDetails/
nhm:address/
nhm:poBoxNumber
Optional
15
nh:validateGeoNumberDetails/
nhm:numberRange/
nhm:areaCode
Mandatory Area code be of 3 or 4 or 5 digits.
16
nh:validateGeoNumberDetails/
nhm:numberRange/
nhm:areaCodeExtn
Mandatory
Main Number 2 digits if Local Area Code = 5
digit or 3 digits if Local Area Code is 4 digits or
4 digits if Local Area Code is 3 digits
17
nh:validateGeoNumberDetails/
nhm:numberRange/
nhm:rangeStart
Mandatory Range Start should always 4 digit.
18
nh:validateGeoNumberDetails/
nhm:numberRange/
nhm:rangeEnd
Mandatory Range End is always 4 digits
Note: For UK, LAC validation is disabled as of now.
3.18.2 Validate GeoNumber Response
Data structure:
Shown below is the way XML Schema is organized. The root element of Acknowledgement
response is named as validateGeoNumberResponse. The root element consists of elements
make up the acknowledgement. An optional Success/Error status Message is also included
in the response.
It must be clearly noted that the reseller has to make sure that their request messages are
valid. Invalid messages will be rejected by B2B gateway with Error status.
Colt Number Hosting XML User Guide GB v0.8 176 / 189
Colt Number Hosting XML User Guide GB v0.8 177 / 189
4.Maintenance and Support
The B2B Gateway Server is available 24 x 7 x 365.
Please refer to Support and maintenance section of Number Hosting Implementation guide
for further information.
Please do not retrigger or resubmit the transactions which are failing due to “Technical
Error”. Colt support team is responsible to resolve them.
Colt Number Hosting XML User Guide GB v0.8 178 / 189
5 Glossary
Term Description
B2B Business to Business:
typically takes the form of automated processes between trading partners and
is performed in much higher volumes than business-to-consumer (B2C)
applications.
CLI Calling Line Identifier. A term used within COLT to mean an end-customer
telephone number such as a Directory number.
CoCom COLT Communications server. Internal applications that provide a file level
interface allowing resellers to request bulk activation and deactivation,
reservation etc of CLIs.
IE Ireland
HTML Hyper Text Mark up Language:
is a markup language designed for the creation of web pages and other
information viewable in a browser. HTML is used to structure information -
denoting certain text as headings, paragraphs, lists etc.- and can be used to
define the semantics of a document
HTTP HyperText Transfer Protocol):
is the primary method used to convey information on the World Wide Web.
The original purpose was to provide a way to publish and receive HTML
pages. The default TCP port of HTTP is 80.
HTTPS HyperText Transfer Protocol Secure:
is the secure version of HTTP, the communication protocol of the World Wide
Web. It was invented by Netscape Communications Corporation to provide
authentication and encrypted communication and is used in electronic
commerce.
Instead of using plain text socket communication, HTTPS encrypts the session
data using either a version of the SSL (Secure Socket Layer) protocol or the
TLS (Transport Layer Security) protocol, thus ensuring reasonable protection
from eavesdroppers, and man in the middle attacks. The default TCP port of
HTTPS is 443.
Colt Number Hosting XML User Guide GB v0.8 179 / 189
Term Description
PTT Public Telegraph Telephony [operator]:
Any fixed-line network operator but typically the major incumbent operator
within the country. COLT deals with the following operators: France Telecom
(France), Deutsche Telekom (Germany), British Telecom (IE), Telia (Sweden),
KPN (Netherlands), Belgacom (Belgium), Austria Telekom (Austria), Telecom
Italia (Italy), Eircom (Ireland), Portugal PTT (Portugal), Telefonica (Spain),
Teledenmark (Denmark). Swisscom (Switzerland).
URL Uniform Resource Locator:
or Web address, is a standardized address name layout for resources (such as
documents or images) on the Internet (or elsewhere). First created by Tim
Berners-Lee for use on the World Wide Web, the currently used forms are
detailed by Internet standard RFC 1738.
WWW World Wide Web:
is an information space in which the items of interest, referred to as resources,
are identified by global identifiers called Uniform Resource Identifiers (URLs).
The term is often mistakenly used as a synonym for the Internet, but the Web
is actually a service that operates over the Internet.
XML eXtensible Mark up Language:
is a W3C-recommended general-purpose markup language for creating
special-purpose markup languages. It is a simplified subset of SGML, capable
of describing many different kinds of data. Its primary purpose is to facilitate
the sharing of data across different systems, particularly systems connected
via the Internet.
SGML Standard Generalized Markup Language:
is a meta-language in which one can define markup languages for documents.
Colt Number Hosting XML User Guide GB v0.8 180 / 189
APPENDIX A- Response codes from NMTS, Cocom, Geo Number Validation and webMethods
Response codes from NMTS
Error Code
System Description Business Message
0 Success
2
Numbers in Free status are not available
and an email will be sent to Phone
Number Manager
No search result found for your seacrh
criteria.
4Matching Hosted OCN does not exists in
NMTSYour request is in progress.
6 Data Base Error Your request is in progress.
8 Time Out Error Your request is in progress.
10 Input errors Your request is in progress.
14The number range is not in Allocated
Status
Unable to process your request due to
system error. Please contact
16Database error in performing the
transaction.Your request is in progress.
18Given Number range does not exists in
NMTS Wholesale Pool
Number range is not available. Please
search for another range and then try
again.
20 Given Range is not in Free status
Number range is reserved by another
customer. Please search for another
number range and try again.
22 Given action is not valid Your request is in progress.
24The number range is not in Activated
Status
Request failed as the number range is not
Active.
Colt Number Hosting XML User Guide GB v0.8 181 / 189
26The number range is not in Reserved
Status
Requested Number(s) are not in reserved
state.
40Error occurred while sending the email
notification
No search result found for your seacrh
criteria.
42Action is completed successfully whereas
error occurred while sending the mail.
Your request is processed successfully.
But, unable to send mail due to some
error.
44 Service ProfileYour request can not be processed as
service profile does not match with OCN.
46 OCN MatchRequest failed as the OCN does not
match with the number range..
48 StatusRequest failed as the number range is not
in active status.
52Given Number Range is not in
Reallocated Status.
Unable to process your request due to
system error. Please contact
[email protected]. Given
Number Range is not in Reallocated
Status.
54
The Entered End Customer Name does
not matches the actual End Customer
Name.
Request failed as the end customer name
does not match with the existing data.
58Given Number Range is not in
Quarantined Status
Request failed as the number is not in
Quarantine state.
82DirectoryListingRequired is Mandatory for
UpdateDirectoryListing Action
Unable to process your request due to
system error. Please contact
84DirectoryListingRequired values should
either be ‘Yes’ or ‘No’
Unable to process your request due to
system error. Please contact
86 Given block size is invalid. Given Block Size is invalid
88 Partial transaction not allowed
Partial number range transactions are not
allowed. Kindly use the complete number
range and submit your request again.
Colt Number Hosting XML User Guide GB v0.8 182 / 189
Response code from Cocom
Error Code System Description Business Message
NH_IV_0002 Input Parameter missing Your request is in progress.
NH_TX_FD_0001Record already exists for this
transactionIdYour request is in progress.
NH_SA_0002 Unable to insert into Database. Your request is in progress.
NH_UTD_IV_0004 Invalid country code Your request is in progress.
NH_UTD_IV_0003 Invalid Product id. Your request is in progress.
NH_UTD_IV_0002 Input Parameter missing Your request is in progress.
NH_UTD_SA_0001 Unable to update database. Your request is in progress.
NH_TD_0001 Transaction Id is required. Your request is in progress.
NH_TD_0002needESData can only be true or
false.Your request is in progress.
NH_TD_SA_0002 Unable to connect Database. Your request is in progress.
NH_TD_RNF_0001 No Record found in Database.The transaction ID is invalid. Please
retry with valid transaction ID
NH_TD_0003needDSData can only be true or
falseYour request is in progress.
NH_TL_0003Service Profile should be alpha
numeric.N/A
NH_TL_0002Service Profile cannot be greater
than 3 digits.N/A
NH_TL_0001 Service Profile is required. N/A
NH_TL_004 Invalid Date Format. Please enter a valid date
NH_TL_SA_0002 Unable to connect Database. Your request is under process.
NH_TL_RNF_0001 No Record found in Database.The transaction ID is invalid. Please
retry with valid transaction ID
NH_SPL_SA_0002 Unable to connect database Your request is in progress.
NH_SPL_SA_0002 Unable to excute the query Your request is in progress.
NH_SPL_SA_0001 No Data Found. Your request is in progress.
NH_SPL_SA_0002 Abnormal Exception occured Your request is in progress.
NH_SPL_IV_0002 Service Profile is required. N/A
NH_SPL_IV_0001 Service Profile should be alpha N/A
Colt Number Hosting XML User Guide GB v0.8 183 / 189
numeric.
NH_SPL_IV_0003 Service Profile should be 3 digits. N/A
Success response send from
process validation service as an
acknowledgement
N/A
Failure response send from
process validation service as an
acknowledgement
1. Technical Failure. Your request is
under process.
2. Business Failure (e.g. Number
already activated/deactivated).
Business message should be
displayed as per the given mapping
error codes (e.g cocom/switch)
15
(coltResponseCode)
It is retuned as a part of async
response send back to BPM in
case of Validation failure. The
response text may vary as
mentioned below.
1: Tranaction ID <" +
request.getExternalID()+ ">
already exists.
2:Reseller Profile <" +
request.getResellerProfile()+ "> is
not a valid user.
3:Ring fenced profile <"+
request.getResellerProfile() + ">
found
4:Profile <"+
request.getResellerProfile()+ "> is
locked
5:Profile <"+
request.getResellerProfile()+ "> is
ceased
6:Invalid Country
7:Range Start /Range end should
not be null
N/A
Colt Number Hosting XML User Guide GB v0.8 184 / 189
8:Range Start /Range end should
not be alphanumeric
9:Range Start /Range end should
be 4 digit long
10: Range Start should be less
than Range end
11:CLI Activity should either be
Activation or Deactivation
Success response send from
NHDMS service as an
acknowledgement
N/A
Failure response send from
NHDMS service as an
acknowledgement
1. Technical Failure. Your request is
under process.
2. Business Failure (e.g. Number
already activated/deactivated).
Business message should be
displayed as per the given mapping
error codes (e.g cocom/switch)
0(coltResponseCode)
It is send as a part of async
response when the request is
sucessfully processed on switch
N/A
1(coltResponseCode)
It is send as a part of async
response when the request is
failed to be processed on switch
along with response text "Unable
to process the request"
1. Technical Failure. Your request is
under process.
2. Business Failure (e.g. Number
already activated/deactivated).
Business message should be
displayed as per the given mapping
error codes (e.g cocom/switch)
15 1. CLI Validation Failure Response<Action Name> request failed due to
Invalid CLI or CLI range
12. Any other failure at switch with
response code: 1
Deactivation request failed. For
detail please contact colt reseller
support
Colt Number Hosting XML User Guide GB v0.8 185 / 189
101 Authentication failed Your request is under process.
4 Deactivation failed.
Deactivation request failed. For
detail please contact colt reseller
support.
Response codes while validating Geo Numbers
Error Code
System Description Business Message
00 Success
01 Post code not recognizedPost Code is incorrect. Please check and
resubmit the request.
02 Address Locality not recognizedCity is incorrect. Please check and
resubmit the request.
03 System Error
Unable to process your request. Please
submit again or contact
04LAC is not applicable to the given
address. Please input correct LAC.
LAC does not match the given address.
Please check and resubmit the request.
05 Invalid AddressLAC does not match the given address.
Please check and resubmit the request.
06 Valid Nomadic LACLAC does not match the given address.
Please check and resubmit the request.
07 Address not found for LACLAC does not match the given address.
Please check and resubmit the request
Response code form webmethods
Error Code Business Message
WM_01 Please enter valid data.
WM_02 Your request is in progress.
WM_03It is not possible to update the Port-In date with DTAG, please Cancel this request
and resubmit the porting request with the new date.
Colt Number Hosting XML User Guide GB v0.8 186 / 189
WM_05Transaction which has already been completed, failed, rejected or cancelled
cannot be updated.
WM_06Updating current status of original port-In/Port-Out request with same status is not
allowed
WM_07Current status of the original port-In/Port-Out request cannot be updated with the
requested status
WM_08 This port out request has been submitted earlier. Please do not submit again
WM_09Unable to process your request due to system error. Please try again later or
contact [email protected].
WM_10Unable to process your request due to system error. Please try again later or
contact [email protected].
WM_11User is not allowed to update the status of original number deactivation request to
Completed/Rejected.
WM_12User is not allowed to update the status of original port out request other than
Confirmed/Rejected.
WM_13 User is not allowed to update the status of the original port-in request.
WM_14Current status of the original Port Out request cannot be updated with Port Not
Initiated status
WM_15Current status of the original Port In/Port Out request cannot be updated with
Delayed status
WM_16 Request for this status should be made within 15 days of the original request
WM_17It is not possible to update/cancel the Port-In until the original transaction is in
Confirmed/Port Not Initiated status.
WM_18
User is not allowed to update the status to any status and port date of original port
out request as current status is "Customer Feedback Awaited". You can update
the status to Confirmed/Rejected only.
Colt Number Hosting XML User Guide GB v0.8 187 / 189
APPENDIX BAllowed characters for UK as per British Telecom for Number Hosting requests
Character Printer Graphic
Space Space
Full stop .
Left Parenthesis (
Ampersand &
Exclamation Mark !
Right Parenthesis )
Minus -
Virgule /
Comma ,
Colon :
Apostrophe ’
Back tick `
At @
Quotes ”
A to Z A to Z
a to z a to z
0 to 9 0 to 9
Colt Number Hosting XML User Guide GB v0.8 188 / 189
Colt Number Hosting XML User Guide GB v0.8 189 / 189