ADSL Create Order
ADSL Create Order XML Documentation Version 1.7
Publication Date: November 2010 For the latest version of this document please visit https://synergi.enta.net.
© Copyright Entanet International Ltd 2010
Contents
Introduction ............................................................................................................... 3 Use ........................................................................................................................... 3 Troubleshooting ...................................................................................................... 14 Changes.................................................................................................................. 16 Feedback ................................................................................................................ 17
ADSL Create Order XML Documentation Version 1.7
Page 2
Introduction This document details the XML interface developed for the ADSL Create Order service. Please refer to the 'General Partners XML Documentation' before reading this document. This service provides the reseller with the ability to create new ADSL orders or migration orders.
Use The XML file sent needs to use the template made available to you at the time your access is granted. The URL to send the requests to is: https://partners.enta.net/xml/CreateADSLOrder.php The number of fields within the XML file is quite extensive. These are shown below although many of these are self-explanatory. - This must be either 'ADSLOrder' or 'ADSLMigrationOrder'. This will create a new ADSL order or a migration order respectively. - All details that are specific to the ADSL connection are within the ADSLAccount element. - This is the reseller's own reference number for the account. This field is optional. - This is one of the codes from the table below and identifies the product that is being migrated to. This field is compulsory.
ADSL Create Order XML Documentation Version 1.7
Page 3
Product Name
XML Code
Family 1
FAM1
Family 3
FAM3
Family 30
FAM30
Family 60
FAM60
Family 90
FAM90
Family 120
FAM120
Business 15
BUS15
Business 45
BUS45
Business 90
BUS90
Business 135
BUS135
Business 180
BUS180
EWCS WBC Band 1 Tail
EWCS_WBC1
EWCS WBC Band 2 Tail
EWCS_WBC2
EWCS 20CN Home Tail
EWCS_HOME
EWCS 20CN Office Tail
EWCS_OFFICE
Please Note: The product should be the required product. If the line currently has a different product the product will be changed as part of the migration process. <Title> - This will be Mr, Mrs, Ms, Miss or Dr. This field is compulsory. - This will contain the first name of the account contact. This field is compulsory. <Surname> - This will contain the surname for the account contact. This field is compulsory. - This will contain the company name for the account. This field is optional. <Building> - This will contain the name, if any, of the building where the ADSL is installed. This field is optional. <Street> - This will contain the street address detail where the ADSL is installed. This field is compulsory.
ADSL Create Order XML Documentation Version 1.7
Page 4
- This will contain the town address detail where the ADSL is installed. This field is compulsory. - This will contain the county address detail where the ADSL is installed. This field is compulsory. - This will contain the postcode detail where the ADSL is installed. This field is compulsory. - This will contain the daytime contact phone number. This field is compulsory. -This will contain the evening contact phone number. This field is compulsory. - This will contain a fax number. This field is optional. <Email> - This will contain an existing and valid email address for the ADSL. This field is compulsory. - This will contain the telephone number of the ADSL line being migrated. This field is compulsory. - This will contain the requested migration date. The minimum date is 28 days from date of ordering. The format of the field is dd/mm/yy. E.g. 11/06/04. - This will be either Y, 8, 16 or D. The following table shows the NAT/No-NAT options available. This field is compulsory. Nat Option
XML Code
NAT – 1 Static IP Address
Y
NAT – 8 Static IP Addresses
8
NAT – 16 Static IP Addresses
16
NAT – Dynamic IP
D
Please Note: having 16 Static IP Addresses is a chargeable service. - This field should be set to N. <Username> - This should be set to the username required without the realm. This field is compulsory.
ADSL Create Order XML Documentation Version 1.7
Page 5
E.g. user1 - valid [email protected] – invalid <Password> - This should be set to the password required for the connection. This field is compulsory. - Sets the speed of the line. Value FIXED500 FIXED1000 FIXED2000 RA8 RA24
Line Speed 512Kbps 1024Kbps 2048Kbps Up to 8192Kbps Up to 24576Kbps
- This is what should happen if you reach your bandwidth cap. Value TOPUP
PAYG
Action Once the selected products bandwidth cap is reached then the account will be rate limited until either manual top-up is added to the account or the next month‟s usage is added. Internet access will continue as normal until the bandwidth cost used reaches the amount set in <MaxPAYGAmount>. If that amount is reached then the account is rate limited.
<MaxPAYGAmount> - This tag is only used if „PAYG‟ is used in the tag. Please see above for tag explanation. - This should be set to the name of the ISP from which the ADSL is being migrated away from. This field is optional. - This field describes the level of care BT will provide for this ADSL Account. The only valid responses are Enhanced or Standard. This field is compulsory. - This field describes the initial fee charged for Enhanced Care when specified. This field is optional. If it is not specified then the default values will be used.
ADSL Create Order XML Documentation Version 1.7
Page 6
- This field describes the ongoing fee charged for Enhanced Care. This field is optional. If it is not specified then the default values will be used. - This section deals with the payment options for the ADSL initial fees and ongoing fees. - This is your purchase order number for this migration request. This field is optional. - This field describes the billing frequency of the connection. The only valid responses are Monthly or Quarterly. This field is compulsory. - This field describes the length of the minimum contract term. Please note this field has implications on the amount charged each billing period. The only valid responses are shown in the table below. This field is compulsory. Value
Length of Term
1
1 Month
12
1 Year
Please Note: It is possible have set to Monthly and set to 1 on all products except on 'Fixed' Family products. - This field describes how the initial charges will be paid. The only valid responses are Account and DirectDebit. Please Note: The initial payer needs to have the relevant payment facility setup at the time of the request. This field is compulsory. - This field describes how the ongoing charges will be paid. The only valid responses are Account and DirectDebit. Please Note: The initial payer needs to have the relevant payment facility setup at the time of the request. This field is compulsory. <PaymentMethod> - This field describes who the initial and ongoing charges will be invoiced to. The table below describes the options available. Value
Payment Method
Initial and Ongoing Charges To Reseller 1 Initial and Ongoing Charges to End User 2 Initial Charges to Reseller, Ongoing to End User
ADSL Create Order XML Documentation Version 1.7
3
Page 7
If method 3 is selected, then the is not required. However, if method 2 is selected then both and are not required. If method 2 is selected must be set to DirectDebit. If method 2 or 3 are selected an email will be sent to the End User directing them to go to Entanet's E-Billing site to pay for the order by credit/debit card and set up a recurring payment method (either direct debit or card). The ADSL order will be put on hold and will not be sent to BT until it has been paid for by the End User. <MAC> - This field is the BT Migration Authorisation Code (MAC) that must be in the form of between 12 to 14 letters and numbers followed by a “/” followed by 2 letters then 2 numbers then 1 letter. This field is compulsory. - This is compulsory and must be set to “YES” - This is only required if you registered a realm with BT. - This field is optional and can only be used if support for realms has already been setup with Entanet. If not this field will be ignored. - This field sets the status of Interleaving on the line this must be either Auto, Yes or No. - This field states if the line is forced to use a lower speed. If this is set to Y then the field should be set to 512, 1024 or 2048. This is optional. - This field is only required if is set to Y. If so then this should be set to 512, 1024 or 2048. This field is optional. Please Note: By default if the line is on 20CN. We will provision the best possible speed that BT claim on the line. If this is on a 'fixed' product that will be 0.5Mbps, 1Mbps or 2Mbps. Alternatively, if this is on a 'Max' product we will provision up to 8Mbps. It is possible to determine if an account is on 20CN or 21CN by using our ADSL Line Checker (Please refer to the ADSL Line Checker XML documentation).
ADSL Create Order XML Documentation Version 1.7
Page 8
- This field describes the upstream speed of a line and is applicable only to WBC enabled exchanges. Valid options are listed below. If this field is omitted it will default to uncapped upstream. Value
Meaning
Uncapped
Standard uncapped
AnnexM
Enable Annex M
- This field describes the initial fee charged for the upstream service specified. This field is optional. If it is not specified then the default values will be used. - This field describes the ongoing fee charged for the upstream option specified. This field is optional. If it is not specified then the default values will be used. - This section deals with who is going to be billed for this connection on an ongoing basis. It DOES NOT refer to the initial charges for the account. Please Note: You should receive guidance from Entanet‟s Customer Services department on how to fill in this section based on which billing scheme you are on when you are XML enabled. - This tells us who is going to be billed on a regular basis. If it is a new end user then you will enter the word „New‟. If you are being billed directly then please contact Customer Services for guidance on what to enter here. - This field is only to be completed if equals 'New'. This will be Mr, Mrs, Miss or Dr. - This field is only to be completed if equals 'New'. This will contain the first name of the billing contact. - This field is only to be completed if equals 'New'. This will contain the surname of the billing contact. - This field is only to be completed if equals 'New'. This will contain the company name for the billing contact. This field is optional. - This field is only to be completed if equals 'New'. This will contain the building name for the billing contact. This field is optional.
ADSL Create Order XML Documentation Version 1.7
Page 9
- This field is only to be completed if equals 'New'. This will contain the street name for the billing contact. - This field is only to be completed if equals 'New'. This will contain the town name for the billing contact. - This field is only to be completed if equals 'New'. This will contain the county name for the billing contact. - This field is only to be completed if equals 'New'. This will contain the postcode for the billing contact. - This field is only to be completed if equals 'New'. This will contain the daytime telephone number for the billing contact. - This field is only to be completed if equals 'New'. This will contain the evening telephone number for the billing contact. - This field is only to be completed if equals 'New'. This will contain the fax number for the billing contact. This field is optional. - This field is only to be completed if equals 'New'. This will contain the email address for the billing contact. The XML file sent needs to use the template made available to you at the time your access is granted. A sample file is shown in Fig. 1. Fig.1 – an example template FAM1 <Title>Mr Jonathon <Surname>Farmer Entanet International Ltd <Building> <Street>Stafford Park 6 Telford Continued on next page>>
ADSL Create Order XML Documentation Version 1.7
Page 10
>> Continued from previous page Shropshire TF3 3AT 08707709669 08707709669 <Email>[email protected] 01952594345 20/07/04 Y N <Username>mytestuser <Password>mytestpassword Monthly 1 DirectDebit DirectDebit <PaymentMethod>1 ADSL123456 <MAC> Enhanced Continued on next page>> ADSL Create Order XML Documentation Version 1.7
Page 11
>> Continued from previous page Enhanced 12.99 12.99
Fig. 2 shows an example response for an error condition. Please contact support if mysubdomain you require any further information regarding error conditions. basedomain Auto Y YES 1024
Please Note: The element <ErrorDescription> can occur multiple times in a single response depending on how many errors are detected. Fig. 2 – an example response for an error condition. Please contact support if you require any further information regarding error conditions. Please Note: The element <ErrorDescription> can occur multiple times in a single response depending on how many errors are detected. <ErrorResponse>Invalid Username / Password <ErrorInformation> Please Contact ADSL Admin for More Information Fig. 3 - an example response for an ordered accepted condition Telephone: 0871 433 3682 Email: [email protected]
ADSL Create Order XML Documentation Version 1.7
Page 12
Fig. 3 - an example response for an ordered accepted condition <xml version=”1.0” encoding=”UTF-8”?> ADSL9999 0195294345
ADSL Create Order XML Documentation Version 1.7
Page 13
Troubleshooting Error message
Solution
Invalid Response Block Type
must be either 'Live' or 'Test'
Invalid Order Type
must be either 'ADSLOrder' or 'ADSLMigrationOrder'
Invalid Product Type
must be one of options specified within this documentation – refer to the 'Use' section of this document for more information.
Invalid Title
<Title> must be either 'Mr', 'Mrs', 'Miss', 'Dr' or 'Ms'
Missing Data: Firstname
cannot be empty
Missing Data: Surname
<Surname> cannot be empty
Missing Data: Street
<Street> cannot be empty
Missing Data: Town
cannot be empty
Missing Data: County
cannot be empty
Missing Data: Postcode
cannot be empty
Missing Data: Telephone Day
cannot be empty
Missing Data: Telephone Evening
cannot be empty
Missing Data: Email
<Email> cannot empty
Missing Data: Telephone
cannot be empty
Missing Data: Provision Date
cannot be empty
Invalid NAT Option
must be either 'Y', '8', '16' or 'D'
Invalid ISDN: ISDN Conversions are no longer supported
must be 'N' (We can no longer support conversions from ISDN lines)
Missing Data: Username
<Username> cannot be empty
Invalid Username Format
<Username> can only be letters, numbers or underscore characters
Missing Data: Password
<Password> cannot be empty
Invalid Billing Period
must be either 'Monthly' or 'Quarterly'
Invalid Contract Term
must be either '1' or '12'
ADSL Create Order XML Documentation Version 1.7
Page 14
Invalid Initial Payment Method
must be either 'Account' or 'DirectDebit'
Invalid Ongoing Payment Method
must be either 'Account' or 'DirectDebit'
Invalid Payment Method
<PaymentMethod> must be either '1', '2' or '3'
Unable to find existing customer record
must have a valid customerID that exists
Missing Data: Customer Title
must be either 'Mr', 'Mrs', 'Miss', 'Dr' or 'Ms'
Missing Data: Customer Firstname
cannot be empty
Missing Data: Customer Surname
cannot be empty
Missing Data: Customer Street
cannot be empty
Missing Data: Customer Town
cannot be empty
Missing Data: Customer County
cannot be empty
Missing Data: Customer Postcode
cannot be empty
Missing Data: Customer Telephone Day
cannot be empty
Missing Data: Customer Telephone Evening
cannot be empty
Missing Data: Customer Email
cannot empty
Missing Data: Telephone
cannot be empty
Initial care level fee below Entanet base price
cannot be lower than the minimum price (enter a higher value)
Ongoing care level fee below Entanet base price
cannot be lower than the minimum price (enter a higher value)
ADSL Create Order XML Documentation Version 1.7
Page 15
Changes August 2008 version 1.2 Merged 'ADSL Order' and 'ADSL Migration Order' services into one single service. Merged into one document from existing 'ADSLOrder.pdf' and 'ADSLMigrationOrder.pdf' documents. is now a compulsory field field now has an additional acceptable value 'D' Removed , , , , , and <Timeslot> fields Added new input fields , , , , Added information on the processes involved (emails that get sent) September 2008 version 1.3 Added new input field <StabilityOption> October 2008 version 1.4 Minor adjustment to example template March 2009 version 1.5 Updated for new products. April 2009 version 1.6 Updated for EWCS Products. November 2010 version 1.7 Updated to include Annex M.
ADSL Create Order XML Documentation Version 1.7
Page 16
Feedback Support for this service can be obtained by emailing [email protected]. All comments and suggestions on this service and its supporting documentation should be sent to [email protected].
ADSL Create Order XML Documentation Version 1.7
Page 17
Publication Date: November 2010 For the latest version of this document please visit https://synergi.enta.net.
© Copyright Entanet International Ltd 2010
Contents
Introduction ............................................................................................................... 3 Use ........................................................................................................................... 3 Troubleshooting ...................................................................................................... 14 Changes.................................................................................................................. 16 Feedback ................................................................................................................ 17
ADSL Create Order XML Documentation Version 1.7
Page 2
Introduction This document details the XML interface developed for the ADSL Create Order service. Please refer to the 'General Partners XML Documentation' before reading this document. This service provides the reseller with the ability to create new ADSL orders or migration orders.
Use The XML file sent needs to use the template made available to you at the time your access is granted. The URL to send the requests to is: https://partners.enta.net/xml/CreateADSLOrder.php The number of fields within the XML file is quite extensive. These are shown below although many of these are self-explanatory. - This must be either 'ADSLOrder' or 'ADSLMigrationOrder'. This will create a new ADSL order or a migration order respectively. - All details that are specific to the ADSL connection are within the ADSLAccount element. - This is the reseller's own reference number for the account. This field is optional. - This is one of the codes from the table below and identifies the product that is being migrated to. This field is compulsory.
ADSL Create Order XML Documentation Version 1.7
Page 3
Product Name
XML Code
Family 1
FAM1
Family 3
FAM3
Family 30
FAM30
Family 60
FAM60
Family 90
FAM90
Family 120
FAM120
Business 15
BUS15
Business 45
BUS45
Business 90
BUS90
Business 135
BUS135
Business 180
BUS180
EWCS WBC Band 1 Tail
EWCS_WBC1
EWCS WBC Band 2 Tail
EWCS_WBC2
EWCS 20CN Home Tail
EWCS_HOME
EWCS 20CN Office Tail
EWCS_OFFICE
Please Note: The product should be the required product. If the line currently has a different product the product will be changed as part of the migration process. <Title> - This will be Mr, Mrs, Ms, Miss or Dr. This field is compulsory. - This will contain the first name of the account contact. This field is compulsory. <Surname> - This will contain the surname for the account contact. This field is compulsory. - This will contain the company name for the account. This field is optional. <Building> - This will contain the name, if any, of the building where the ADSL is installed. This field is optional. <Street> - This will contain the street address detail where the ADSL is installed. This field is compulsory.
ADSL Create Order XML Documentation Version 1.7
Page 4
- This will contain the town address detail where the ADSL is installed. This field is compulsory. - This will contain the county address detail where the ADSL is installed. This field is compulsory. - This will contain the postcode detail where the ADSL is installed. This field is compulsory. - This will contain the daytime contact phone number. This field is compulsory. -This will contain the evening contact phone number. This field is compulsory. - This will contain a fax number. This field is optional. <Email> - This will contain an existing and valid email address for the ADSL. This field is compulsory. - This will contain the telephone number of the ADSL line being migrated. This field is compulsory. - This will contain the requested migration date. The minimum date is 28 days from date of ordering. The format of the field is dd/mm/yy. E.g. 11/06/04. - This will be either Y, 8, 16 or D. The following table shows the NAT/No-NAT options available. This field is compulsory. Nat Option
XML Code
NAT – 1 Static IP Address
Y
NAT – 8 Static IP Addresses
8
NAT – 16 Static IP Addresses
16
NAT – Dynamic IP
D
Please Note: having 16 Static IP Addresses is a chargeable service. - This field should be set to N. <Username> - This should be set to the username required without the realm. This field is compulsory.
ADSL Create Order XML Documentation Version 1.7
Page 5
E.g. user1 - valid [email protected] – invalid <Password> - This should be set to the password required for the connection. This field is compulsory. - Sets the speed of the line. Value FIXED500 FIXED1000 FIXED2000 RA8 RA24
Line Speed 512Kbps 1024Kbps 2048Kbps Up to 8192Kbps Up to 24576Kbps
- This is what should happen if you reach your bandwidth cap. Value TOPUP
PAYG
Action Once the selected products bandwidth cap is reached then the account will be rate limited until either manual top-up is added to the account or the next month‟s usage is added. Internet access will continue as normal until the bandwidth cost used reaches the amount set in <MaxPAYGAmount>. If that amount is reached then the account is rate limited.
<MaxPAYGAmount> - This tag is only used if „PAYG‟ is used in the tag. Please see above for tag explanation. - This should be set to the name of the ISP from which the ADSL is being migrated away from. This field is optional. - This field describes the level of care BT will provide for this ADSL Account. The only valid responses are Enhanced or Standard. This field is compulsory. - This field describes the initial fee charged for Enhanced Care when specified. This field is optional. If it is not specified then the default values will be used.
ADSL Create Order XML Documentation Version 1.7
Page 6
- This field describes the ongoing fee charged for Enhanced Care. This field is optional. If it is not specified then the default values will be used. - This section deals with the payment options for the ADSL initial fees and ongoing fees. - This is your purchase order number for this migration request. This field is optional. - This field describes the billing frequency of the connection. The only valid responses are Monthly or Quarterly. This field is compulsory. - This field describes the length of the minimum contract term. Please note this field has implications on the amount charged each billing period. The only valid responses are shown in the table below. This field is compulsory. Value
Length of Term
1
1 Month
12
1 Year
Please Note: It is possible have set to Monthly and set to 1 on all products except on 'Fixed' Family products. - This field describes how the initial charges will be paid. The only valid responses are Account and DirectDebit. Please Note: The initial payer needs to have the relevant payment facility setup at the time of the request. This field is compulsory. - This field describes how the ongoing charges will be paid. The only valid responses are Account and DirectDebit. Please Note: The initial payer needs to have the relevant payment facility setup at the time of the request. This field is compulsory. <PaymentMethod> - This field describes who the initial and ongoing charges will be invoiced to. The table below describes the options available. Value
Payment Method
Initial and Ongoing Charges To Reseller 1 Initial and Ongoing Charges to End User 2 Initial Charges to Reseller, Ongoing to End User
ADSL Create Order XML Documentation Version 1.7
3
Page 7
If method 3 is selected, then the is not required. However, if method 2 is selected then both and are not required. If method 2 is selected must be set to DirectDebit. If method 2 or 3 are selected an email will be sent to the End User directing them to go to Entanet's E-Billing site to pay for the order by credit/debit card and set up a recurring payment method (either direct debit or card). The ADSL order will be put on hold and will not be sent to BT until it has been paid for by the End User. <MAC> - This field is the BT Migration Authorisation Code (MAC) that must be in the form of between 12 to 14 letters and numbers followed by a “/” followed by 2 letters then 2 numbers then 1 letter. This field is compulsory. - This is compulsory and must be set to “YES” - This is only required if you registered a realm with BT. - This field is optional and can only be used if support for realms has already been setup with Entanet. If not this field will be ignored. - This field sets the status of Interleaving on the line this must be either Auto, Yes or No. - This field states if the line is forced to use a lower speed. If this is set to Y then the field should be set to 512, 1024 or 2048. This is optional. - This field is only required if is set to Y. If so then this should be set to 512, 1024 or 2048. This field is optional. Please Note: By default if the line is on 20CN. We will provision the best possible speed that BT claim on the line. If this is on a 'fixed' product that will be 0.5Mbps, 1Mbps or 2Mbps. Alternatively, if this is on a 'Max' product we will provision up to 8Mbps. It is possible to determine if an account is on 20CN or 21CN by using our ADSL Line Checker (Please refer to the ADSL Line Checker XML documentation).
ADSL Create Order XML Documentation Version 1.7
Page 8
- This field describes the upstream speed of a line and is applicable only to WBC enabled exchanges. Valid options are listed below. If this field is omitted it will default to uncapped upstream. Value
Meaning
Uncapped
Standard uncapped
AnnexM
Enable Annex M
- This field describes the initial fee charged for the upstream service specified. This field is optional. If it is not specified then the default values will be used. - This field describes the ongoing fee charged for the upstream option specified. This field is optional. If it is not specified then the default values will be used. - This section deals with who is going to be billed for this connection on an ongoing basis. It DOES NOT refer to the initial charges for the account. Please Note: You should receive guidance from Entanet‟s Customer Services department on how to fill in this section based on which billing scheme you are on when you are XML enabled. - This tells us who is going to be billed on a regular basis. If it is a new end user then you will enter the word „New‟. If you are being billed directly then please contact Customer Services for guidance on what to enter here. - This field is only to be completed if equals 'New'. This will be Mr, Mrs, Miss or Dr. - This field is only to be completed if equals 'New'. This will contain the first name of the billing contact. - This field is only to be completed if equals 'New'. This will contain the surname of the billing contact. - This field is only to be completed if equals 'New'. This will contain the company name for the billing contact. This field is optional. - This field is only to be completed if equals 'New'. This will contain the building name for the billing contact. This field is optional.
ADSL Create Order XML Documentation Version 1.7
Page 9
- This field is only to be completed if equals 'New'. This will contain the street name for the billing contact. - This field is only to be completed if equals 'New'. This will contain the town name for the billing contact. - This field is only to be completed if equals 'New'. This will contain the county name for the billing contact. - This field is only to be completed if equals 'New'. This will contain the postcode for the billing contact. - This field is only to be completed if equals 'New'. This will contain the daytime telephone number for the billing contact. - This field is only to be completed if equals 'New'. This will contain the evening telephone number for the billing contact. - This field is only to be completed if equals 'New'. This will contain the fax number for the billing contact. This field is optional. - This field is only to be completed if equals 'New'. This will contain the email address for the billing contact. The XML file sent needs to use the template made available to you at the time your access is granted. A sample file is shown in Fig. 1. Fig.1 – an example template FAM1 <Title>Mr Jonathon <Surname>Farmer Entanet International Ltd <Building> <Street>Stafford Park 6 Telford Continued on next page>>
ADSL Create Order XML Documentation Version 1.7
Page 10
>> Continued from previous page Shropshire TF3 3AT 08707709669 08707709669 <Email>[email protected] 01952594345 20/07/04 Y N <Username>mytestuser <Password>mytestpassword Monthly 1 DirectDebit DirectDebit <PaymentMethod>1 ADSL123456 <MAC> Enhanced Continued on next page>> ADSL Create Order XML Documentation Version 1.7
Page 11
>> Continued from previous page Enhanced 12.99 12.99
Fig. 2 shows an example response for an error condition. Please contact support if mysubdomain you require any further information regarding error conditions. basedomain Auto Y YES 1024
Please Note: The element <ErrorDescription> can occur multiple times in a single response depending on how many errors are detected. Fig. 2 – an example response for an error condition. Please contact support if you require any further information regarding error conditions. Please Note: The element <ErrorDescription> can occur multiple times in a single response depending on how many errors are detected. <ErrorResponse>Invalid Username / Password <ErrorInformation> Please Contact ADSL Admin for More Information Fig. 3 - an example response for an ordered accepted condition Telephone: 0871 433 3682 Email: [email protected]
ADSL Create Order XML Documentation Version 1.7
Page 12
Fig. 3 - an example response for an ordered accepted condition <xml version=”1.0” encoding=”UTF-8”?> ADSL9999 0195294345
ADSL Create Order XML Documentation Version 1.7
Page 13
Troubleshooting Error message
Solution
Invalid Response Block Type
must be either 'Live' or 'Test'
Invalid Order Type
must be either 'ADSLOrder' or 'ADSLMigrationOrder'
Invalid Product Type
must be one of options specified within this documentation – refer to the 'Use' section of this document for more information.
Invalid Title
<Title> must be either 'Mr', 'Mrs', 'Miss', 'Dr' or 'Ms'
Missing Data: Firstname
cannot be empty
Missing Data: Surname
<Surname> cannot be empty
Missing Data: Street
<Street> cannot be empty
Missing Data: Town
cannot be empty
Missing Data: County
cannot be empty
Missing Data: Postcode
cannot be empty
Missing Data: Telephone Day
cannot be empty
Missing Data: Telephone Evening
cannot be empty
Missing Data: Email
<Email> cannot empty
Missing Data: Telephone
cannot be empty
Missing Data: Provision Date
cannot be empty
Invalid NAT Option
must be either 'Y', '8', '16' or 'D'
Invalid ISDN: ISDN Conversions are no longer supported
must be 'N' (We can no longer support conversions from ISDN lines)
Missing Data: Username
<Username> cannot be empty
Invalid Username Format
<Username> can only be letters, numbers or underscore characters
Missing Data: Password
<Password> cannot be empty
Invalid Billing Period
must be either 'Monthly' or 'Quarterly'
Invalid Contract Term
must be either '1' or '12'
ADSL Create Order XML Documentation Version 1.7
Page 14
Invalid Initial Payment Method
must be either 'Account' or 'DirectDebit'
Invalid Ongoing Payment Method
must be either 'Account' or 'DirectDebit'
Invalid Payment Method
<PaymentMethod> must be either '1', '2' or '3'
Unable to find existing customer record
must have a valid customerID that exists
Missing Data: Customer Title
must be either 'Mr', 'Mrs', 'Miss', 'Dr' or 'Ms'
Missing Data: Customer Firstname
cannot be empty
Missing Data: Customer Surname
cannot be empty
Missing Data: Customer Street
cannot be empty
Missing Data: Customer Town
cannot be empty
Missing Data: Customer County
cannot be empty
Missing Data: Customer Postcode
cannot be empty
Missing Data: Customer Telephone Day
cannot be empty
Missing Data: Customer Telephone Evening
cannot be empty
Missing Data: Customer Email
cannot empty
Missing Data: Telephone
cannot be empty
Initial care level fee below Entanet base price
cannot be lower than the minimum price (enter a higher value)
Ongoing care level fee below Entanet base price
cannot be lower than the minimum price (enter a higher value)
ADSL Create Order XML Documentation Version 1.7
Page 15
Changes August 2008 version 1.2 Merged 'ADSL Order' and 'ADSL Migration Order' services into one single service. Merged into one document from existing 'ADSLOrder.pdf' and 'ADSLMigrationOrder.pdf' documents. is now a compulsory field field now has an additional acceptable value 'D' Removed , , , , , and <Timeslot> fields Added new input fields , , , , Added information on the processes involved (emails that get sent) September 2008 version 1.3 Added new input field <StabilityOption> October 2008 version 1.4 Minor adjustment to example template March 2009 version 1.5 Updated for new products. April 2009 version 1.6 Updated for EWCS Products. November 2010 version 1.7 Updated to include Annex M.
ADSL Create Order XML Documentation Version 1.7
Page 16
Feedback Support for this service can be obtained by emailing [email protected]. All comments and suggestions on this service and its supporting documentation should be sent to [email protected].
ADSL Create Order XML Documentation Version 1.7
Page 17
