Introduction
When you do a qualification there may be no infrastructure at the location or if there are existing infrastructure you may have the option to request an additional infrastructure. You can always order an additional NTD, however you can only order an additional copper pair when all existing copper pairs are in use. In the qualification results if you can order an additional infrastructure, a fee will be listed for the nbn-tech install option in the infrastructure install options (infrastructureInstallationOptions[option='nbn-tech'].fees.tc4.name = 'ADDITIONAL_INFRASTRUCTURE'). If you place an order for an additional infrastructure with the nbn-tech install option you will be charged the additional infrastructure fee. You will not be charged the additional infrastructure fee if there are currently no infrastructures at the location (the fee will not be in the infrastructure install options for any install option). When placing an order for the first infrastructure or an additional infrastructure the order will have an associated order type (orderType) of new.
Note: POTS can cause an order to have an order type (orderType) of transfer instead of new. Refer to the POTS documentation for more information.
Examples
New NTD Port - First at location
Step 1 Perform a Qualification
GET Response Qualification containing in use NTDs
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1927
{
"locationId" : "LOC151638001142",
"sourceType" : "nbn",
"address" : "1142 MACLEAN Street, NARRABEEN, New South Wales, 2101",
"addressDetails" : {
"buildingName" : null,
"buildingLevel" : null,
"unitNumber" : null,
"streetNumber" : "1142",
"street" : "MACLEAN Street",
"suburb" : "NARRABEEN",
"state" : "New South Wales",
"postcode" : "2101"
},
"technologyType" : "TC4",
"qualificationSearchId" : "c18eda52-db36-47f0-bd12-7535beb6db7e",
"remoteQualificationSearchId" : "1eb7c686-32cc-67fe-9e2c-7e380507f753",
"status" : "Serviceable - Shortfall",
"region" : "Urban",
"accessTechnology" : "FTTP",
"accessTechnologyDescription" : "Fibre",
"availableProducts" : {
"id" : 2,
"name" : "tc4",
"description" : "TC4",
"options" : [ ]
},
"latitude" : "-33.40001142",
"longitude" : "151.400001142",
"avcId" : null,
"orderId" : "1eb7c686-3288-6900-9439-7e380507f753",
"alternativeAccessTechnology" : null,
"poiId" : null,
"poiName" : null,
"sqType" : "STANDARD",
"serviceClass" : "1",
"serviceClassDescription" : "Location serviced by FTTP however requires Premises Connection Device (PCD) and Network Termination Device (NTD) to be installed",
"orderSlas" : [ ],
"newDevelopmentsCharge" : {
"applies" : true,
"fees" : [ {
"name" : "NDF",
"oneTimeCharge" : {
"amount" : "300.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
},
"infrastructureInstallationOptions" : [ {
"option" : "nbn-tech",
"recommended" : true,
"fees" : [ ],
"hardwareShortfall" : null
} ],
"infrastructures" : [ ],
"potsInterconnect" : null,
"ntdSelfInstallEligible" : null,
"restorationSlas" : [ ],
"allowedAggregationMethods" : [ "ETHERNET", "L2TP" ]
}In the above example no NTDs are returned (infrastructures.isEmpty()). This means the order will be for the first service at the location. As such there is no additional infrastructure fee in the list of fees for the infrastructure install options (infrastructureInstallationOptions[option='nbn-tech'].fees.tc4.isEmpty()).
If an order is placed for a service at this location the order type (orderType) will be new.
Step 2 Place the Order for a new Service
POST Request Place Order
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 663
Host: 360-api.superloop.com
{
"sourceType" : "nbn",
"planName" : "Home Fast 100/20",
"term" : 1,
"trafficClass" : "tc4",
"remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
"qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
"locationId" : "LOC151638001142",
"remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
"productType" : "Access Only",
"restorationSla" : "Standard",
"contactName" : "Bruce Wayne",
"contactPhone" : "4000000000",
"contactEmail" : "bruce@wayne.com",
"infrastructureId" : null,
"requireVLAN" : false,
"ntdInstallation" : "nbn-tech",
"customerReference" : "ABC123",
"aggregationMethod" : "L2TP"
}POST Response Place Order
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2115
{
"id" : 1,
"orderType" : "new",
"status" : "OPEN",
"serviceClass" : "1",
"technologyType" : "FTTP",
"trafficClass" : "TC4",
"installationType" : "nbn-tech",
"customerRef" : "ABC123",
"locId" : "LOC151638001142",
"avcId" : null,
"avcIdForTransfer" : null,
"vlanId" : null,
"poi" : null,
"poiName" : null,
"region" : "Urban",
"eSla" : "Standard",
"bandwidthProfile" : {
"speedDown" : 100,
"speedUp" : 20,
"planName" : "Home Fast 100/20",
"cvcInclusion" : null
},
"infrastructure" : null,
"address" : {
"buildingLevel" : null,
"unitNumber" : null,
"buildingName" : null,
"streetNumber" : "1142",
"street" : "MACLEAN ST",
"suburb" : "NARRABEEN",
"state" : "NSW",
"postcode" : "2101",
"formattedAddress" : "1142 MACLEAN Street, NARRABEEN, New South Wales, 2101"
},
"fee" : {
"attributes" : {
"plan" : "Home Fast 100/20",
"term" : "1"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "65.00",
"currency" : "AUD",
"symbol" : "$"
}
},
"additionalFees" : [ {
"addOnTypeName" : "SLA",
"fee" : {
"attributes" : {
"sla" : "Standard"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
}, {
"addOnTypeName" : "NDF",
"fee" : {
"attributes" : {
"ndf" : "New Development Fee"
},
"oneTimeCharge" : {
"amount" : "300.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
} ],
"appointments" : [ ],
"aggregationMethod" : "L2TP",
"legacyTechnologyType" : null,
"transferType" : null,
"360ServiceId" : null,
"isCancellable" : false,
"isNfas" : false
}In the above example an order was placed for the first service at the location. The creation was successful and the Order resource returned. The order type is new (orderType = 'new') and additional fees (additionalFees) does not contains the additional infrastructure fee.
New Copper Pair - First at location
Step 1 Perform a Qualification
GET Response Qualification containing in use Copper Pair
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4747
{
"locationId" : "LOC151638001813",
"sourceType" : "nbn",
"address" : "4424 GOLSEN Road, ASHFIELD, New South Wales, 2131",
"addressDetails" : {
"buildingName" : null,
"buildingLevel" : null,
"unitNumber" : null,
"streetNumber" : "4424",
"street" : "GOLSEN Road",
"suburb" : "ASHFIELD",
"state" : "New South Wales",
"postcode" : "2131"
},
"technologyType" : "TC4",
"qualificationSearchId" : "c18eda52-db36-47f0-bd12-7535beb6db7e",
"remoteQualificationSearchId" : "1eb7bcfc-5b6e-6ba0-a109-7e380507f753",
"status" : "Serviceable - Shortfall",
"region" : "Urban",
"accessTechnology" : "FTTC",
"accessTechnologyDescription" : "Fibre To The Curb",
"availableProducts" : {
"id" : 2,
"name" : "tc4",
"description" : "TC4",
"options" : [ "Home Fast 25/5", "Home Fast 100/20", "Home Fast 12/1", "Home Fast 25/10", "Home Fast 50/20", "Home Fast 100/40" ]
},
"latitude" : "-33.40004424",
"longitude" : "151.400004424",
"avcId" : null,
"orderId" : "1eb7bcfc-5b53-6292-9959-7e380507f753",
"alternativeAccessTechnology" : null,
"poiId" : "4avuzteny",
"poiName" : "Heathcotemouth",
"sqType" : "STANDARD",
"serviceClass" : "31",
"serviceClassDescription" : "Location serviced by FTTC however no line is available and requires Network Connection Device to be installed",
"orderSlas" : [ "Standard", "Accelerated" ],
"newDevelopmentsCharge" : {
"applies" : false,
"fees" : [ ]
},
"infrastructureInstallationOptions" : [ {
"option" : "nbn-tech",
"recommended" : true,
"fees" : [ ],
"hardwareShortfall" : null
} ],
"infrastructures" : [ ],
"potsInterconnect" : null,
"ntdSelfInstallEligible" : null,
"restorationSlas" : [ {
"sla" : "Standard",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "17.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "28.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "62.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "37.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "73.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "84.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
} ],
"allowedAggregationMethods" : [ "ETHERNET", "L2TP" ]
}In the above example no copper pairs are returned (infrastructures.isEmpty()). This means the order will be for the first service at the location. As such there is no additional infrastructure fee in the list of fees for the infrastructure install options (infrastructureInstallationOptions[option='nbn-tech'].fees.tc4.isEmpty().
If an order is placed for a service at this location the order type (orderType) will be new.
Step 2 Place the Order for a new Service
POST Request Place Order
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 663
Host: 360-api.superloop.com
{
"sourceType" : "nbn",
"planName" : "Home Fast 100/20",
"term" : 1,
"trafficClass" : "tc4",
"remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
"qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
"locationId" : "LOC151638001813",
"remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
"productType" : "Access Only",
"restorationSla" : "Standard",
"contactName" : "Bruce Wayne",
"contactPhone" : "4000000000",
"contactEmail" : "bruce@wayne.com",
"infrastructureId" : null,
"requireVLAN" : false,
"ntdInstallation" : "nbn-tech",
"customerReference" : "ABC123",
"aggregationMethod" : "L2TP"
}POST Response Place Order
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1759
{
"id" : 1,
"orderType" : "new",
"status" : "OPEN",
"serviceClass" : "31",
"technologyType" : "FTTC",
"trafficClass" : "TC4",
"installationType" : "nbn-tech",
"customerRef" : "ABC123",
"locId" : "LOC151638001813",
"avcId" : null,
"avcIdForTransfer" : null,
"vlanId" : null,
"poi" : "4avuzteny",
"poiName" : "Heathcotemouth",
"region" : "Urban",
"eSla" : "Standard",
"bandwidthProfile" : {
"speedDown" : 100,
"speedUp" : 20,
"planName" : "Home Fast 100/20",
"cvcInclusion" : null
},
"infrastructure" : null,
"address" : {
"buildingLevel" : null,
"unitNumber" : null,
"buildingName" : null,
"streetNumber" : "4424",
"street" : "GOLSEN RD",
"suburb" : "ASHFIELD",
"state" : "NSW",
"postcode" : "2131",
"formattedAddress" : "4424 GOLSEN Road, ASHFIELD, New South Wales, 2131"
},
"fee" : {
"attributes" : {
"plan" : "Home Fast 100/20",
"term" : "1"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "65.00",
"currency" : "AUD",
"symbol" : "$"
}
},
"additionalFees" : [ {
"addOnTypeName" : "SLA",
"fee" : {
"attributes" : {
"sla" : "Standard"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
} ],
"appointments" : [ ],
"aggregationMethod" : "L2TP",
"legacyTechnologyType" : null,
"transferType" : null,
"360ServiceId" : null,
"isCancellable" : false,
"isNfas" : false
}In the above example an order was placed for the first service at the location. The creation was successful and the Order resource returned. The order type is new (orderType = 'new') and additional fees (additionalFees) does not contains the additional infrastructure fee.
New NTD - Additional at location
Step 1 Perform a Qualification
GET Response Qualification allows an additional NTD to be requested
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7570
{
"locationId" : "LOC151638001451",
"sourceType" : "nbn",
"address" : "1451 GARLAND Drive, BALWYN EAST, Victoria, 3103",
"addressDetails" : {
"buildingName" : null,
"buildingLevel" : null,
"unitNumber" : null,
"streetNumber" : "1451",
"street" : "GARLAND Drive",
"suburb" : "BALWYN EAST",
"state" : "Victoria",
"postcode" : "3103"
},
"technologyType" : "TC4",
"qualificationSearchId" : "c18eda52-db36-47f0-bd12-7535beb6db7e",
"remoteQualificationSearchId" : "1eb7bea4-250e-6d90-b95e-7e380507f753",
"status" : "Serviceable",
"region" : "Urban",
"accessTechnology" : "FTTP",
"accessTechnologyDescription" : "Fibre",
"availableProducts" : {
"id" : 2,
"name" : "tc4",
"description" : "TC4",
"options" : [ "Home Fast 25/5", "Home Fast 25/10", "Home Fast 50/20", "Home Fast 100/40", "Home Superfast 250/100", "Home Superfast 500/200", "Home Ultrafast 1000/400", "Home Fast 12/1" ]
},
"latitude" : "-33.40001451",
"longitude" : "151.400001451",
"avcId" : null,
"orderId" : "1eb7bc5c-637a-6920-8262-7e380507f753",
"alternativeAccessTechnology" : null,
"poiId" : "3CBN",
"poiName" : "Cranbourne",
"sqType" : "STANDARD",
"serviceClass" : "3",
"serviceClassDescription" : "Location serviced by FTTP and has infrastructure in place",
"orderSlas" : [ "Standard", "Accelerated" ],
"newDevelopmentsCharge" : {
"applies" : false,
"fees" : [ ]
},
"infrastructureInstallationOptions" : [ {
"option" : "nbn-tech",
"recommended" : true,
"fees" : [ {
"name" : "SUBSEQUENT_INSTALLATION_CHARGE",
"oneTimeCharge" : {
"amount" : "180.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ],
"hardwareShortfall" : null
} ],
"infrastructures" : [ {
"infrastructureId" : "NTD151638001451",
"installationOptions" : [ {
"option" : "nbn-no-action",
"recommended" : true,
"fees" : [ ],
"hardwareShortfall" : null
} ],
"ntdType" : "Internal",
"ntdPowerType" : "AC",
"batteryPowerUnit" : "No",
"ntdLocation" : "Indoor",
"ntdPorts" : [ {
"portId" : "1",
"portName" : "1-UNI-D1",
"uniType" : "UNI-D",
"status" : "Used",
"referencedData" : {
"productInstanceId" : "PRI151638001451",
"serviceProviderId" : "0615",
"serviceProviderName" : null,
"owner" : false
},
"fees" : [ {
"name" : "SERVICE_TRANSFER_FEE",
"oneTimeCharge" : {
"amount" : "10.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ],
"avcIdMatch" : null
}, {
"portId" : "2",
"portName" : "1-UNI-D2",
"uniType" : "UNI-D",
"status" : "Used",
"referencedData" : {
"productInstanceId" : "PRI100000019555",
"serviceProviderId" : "0427",
"serviceProviderName" : null,
"owner" : false
},
"fees" : [ {
"name" : "SERVICE_TRANSFER_FEE",
"oneTimeCharge" : {
"amount" : "10.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ],
"avcIdMatch" : null
}, {
"portId" : "3",
"portName" : "1-UNI-D3",
"uniType" : "UNI-D",
"status" : "Used",
"referencedData" : {
"productInstanceId" : "PRI100000020378",
"serviceProviderId" : "0427",
"serviceProviderName" : null,
"owner" : false
},
"fees" : [ {
"name" : "SERVICE_TRANSFER_FEE",
"oneTimeCharge" : {
"amount" : "10.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ],
"avcIdMatch" : null
}, {
"portId" : "4",
"portName" : "1-UNI-D4",
"uniType" : "UNI-D",
"status" : "Free",
"referencedData" : null,
"fees" : [ ],
"avcIdMatch" : null
} ],
"subsequentInstallationCharge" : null
} ],
"potsInterconnect" : null,
"ntdSelfInstallEligible" : null,
"restorationSlas" : [ {
"sla" : "Standard",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "17.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "28.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "62.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "37.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "73.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "84.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
} ],
"allowedAggregationMethods" : [ "ETHERNET", "L2TP" ]
}In the above example several existing infrastructures (NTDs) are returned. However in this scenario we don’t want a service added to any of them. Instead we want to request an additional NTD for the service to go on. You know you can request an additional NTD because the infrastructure installation options is populated (!infrastructureInstallationOptions.isEmpty()). In this scenario there is only one install option nbn-tech you can choose. It has an associated additional infrastructure fee (infrastructureInstallationOptions[option='nbn-tech'].fees.tc4[name='ADDITIONAL_INFRASTRUCTURE'']). In the above example the additional infrastructure fee for the "nbn-tech" installation option consists of a one time charge of AUD $180.00.
If an order is placed for a service on an additional NTD the order type (orderType) will be new and you will incur the additional infrastructure fee.
Step 2 Place the Order for a new Service on an additional NTD
POST Request Place Order
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 680
Host: 360-api.superloop.com
{
"sourceType" : "nbn",
"planName" : "Home Fast 100/20",
"term" : 1,
"trafficClass" : "tc4",
"remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
"qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
"locationId" : "LOC151638001251",
"remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
"productType" : "Access Only",
"restorationSla" : "Standard",
"contactName" : "Bruce Wayne",
"contactPhone" : "4000000000",
"contactEmail" : "bruce@wayne.com",
"infrastructureId" : null,
"requireVLAN" : true,
"vlanId" : 100,
"ntdInstallation" : "nbn-tech",
"customerReference" : "ABC123",
"aggregationMethod" : "L2TP"
}POST Response Place Order
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2144
{
"id" : 1,
"orderType" : "new",
"status" : "OPEN",
"serviceClass" : "3",
"technologyType" : "FTTP",
"trafficClass" : "TC4",
"installationType" : "nbn-tech",
"customerRef" : "ABC123",
"locId" : "LOC151638001251",
"avcId" : null,
"avcIdForTransfer" : null,
"vlanId" : 100,
"poi" : "3CBN",
"poiName" : "Cranbourne",
"region" : "Urban",
"eSla" : "Standard",
"bandwidthProfile" : {
"speedDown" : 100,
"speedUp" : 20,
"planName" : "Home Fast 100/20",
"cvcInclusion" : null
},
"infrastructure" : null,
"address" : {
"buildingLevel" : null,
"unitNumber" : null,
"buildingName" : null,
"streetNumber" : "1451",
"street" : "GARLAND DR",
"suburb" : "BALWYN EAST",
"state" : "VIC",
"postcode" : "3103",
"formattedAddress" : "1451 GARLAND Drive, BALWYN EAST, Victoria, 3103"
},
"fee" : {
"attributes" : {
"plan" : "Home Fast 100/20",
"term" : "1"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "65.00",
"currency" : "AUD",
"symbol" : "$"
}
},
"additionalFees" : [ {
"addOnTypeName" : "SLA",
"fee" : {
"attributes" : {
"sla" : "Standard"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
}, {
"addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
"fee" : {
"attributes" : {
"technology_type" : "fttp"
},
"oneTimeCharge" : {
"amount" : "180.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
} ],
"appointments" : [ ],
"aggregationMethod" : "L2TP",
"legacyTechnologyType" : null,
"transferType" : null,
"360ServiceId" : null,
"isCancellable" : false,
"isNfas" : false
}In the above example an order was placed for a service on an additional NTD. The creation was successful and the Order resource returned. The order type is new (orderType = 'new') and additional fees (additionalFees) contains the additional infrastructure fee as one of the fees charged (additionalFees.addOnTypeName = 'ADDITIONAL_INFRASTRUCTURE').
New Copper Pair - Additional at location
Step 1 Perform a Qualification
GET Response Qualification allows an additional copper pair to be requested
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 6554
{
"locationId" : "LOC151638004861",
"sourceType" : "nbn",
"address" : "4861 ROCKWELL Avenue, KEILOR EAST, Victoria, 3033",
"addressDetails" : {
"buildingName" : null,
"buildingLevel" : null,
"unitNumber" : null,
"streetNumber" : "4861",
"street" : "ROCKWELL Avenue",
"suburb" : "KEILOR EAST",
"state" : "Victoria",
"postcode" : "3033"
},
"technologyType" : "TC4",
"qualificationSearchId" : "c18eda52-db36-47f0-bd12-7535beb6db7e",
"remoteQualificationSearchId" : "1ebafd65-dc07-6af8-a83a-7e380507f753",
"status" : "Serviceable",
"region" : "Urban",
"accessTechnology" : "FTTC",
"accessTechnologyDescription" : "Fibre To The Curb",
"availableProducts" : {
"id" : 2,
"name" : "tc4",
"description" : "TC4",
"options" : [ "Home Fast 25/5", "Home Fast 100/20", "Home Fast 12/1", "Home Fast 25/10", "Home Fast 50/20", "Home Fast 100/40" ]
},
"latitude" : "-33.40004861",
"longitude" : "151.400004861",
"avcId" : null,
"orderId" : "1ebafd65-daaa-6750-ab5e-7e380507f753",
"alternativeAccessTechnology" : null,
"poiId" : "9zrvcxfsn",
"poiName" : "East Antonette",
"sqType" : "STANDARD",
"serviceClass" : "34",
"serviceClassDescription" : "Location serviced by FTTC and has infrastructure in place",
"orderSlas" : [ "Standard", "Accelerated" ],
"newDevelopmentsCharge" : {
"applies" : true,
"fees" : [ {
"name" : "NDF",
"oneTimeCharge" : {
"amount" : "300.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
},
"infrastructureInstallationOptions" : [ {
"option" : "nbn-tech",
"recommended" : true,
"fees" : [ {
"name" : "SUBSEQUENT_INSTALLATION_CHARGE",
"oneTimeCharge" : {
"amount" : "180.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ],
"hardwareShortfall" : null
} ],
"infrastructures" : [ {
"infrastructureId" : "CPI151638004861",
"installationOptions" : [ {
"option" : "nbn-no-action",
"recommended" : true,
"fees" : [ ],
"hardwareShortfall" : false
} ],
"serviceabilityClass" : "34",
"serviceStatus" : "Line In Use",
"serviceType" : null,
"recommended" : true,
"upstream" : {
"lowerRate" : "20Mbps",
"upperRate" : "40Mbps"
},
"downstream" : {
"lowerRate" : "70Mbps",
"upperRate" : "100Mbps"
},
"referencedData" : {
"productInstanceId" : "PRI100000017775",
"serviceProviderId" : "0427",
"serviceProviderName" : null,
"owner" : false
},
"copperPairStatus" : null,
"hasActivePOTS" : false,
"potsInterconnectMatch" : false,
"potsInterconnect" : null,
"ntdSelfInstallEligible" : true,
"fees" : [ {
"name" : "SERVICE_TRANSFER_FEE",
"oneTimeCharge" : {
"amount" : "10.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ],
"subsequentInstallationCharge" : {
"applies" : false,
"fees" : [ ]
},
"networkCoexistence" : "Yes",
"avcIdMatch" : null
} ],
"potsInterconnect" : null,
"ntdSelfInstallEligible" : null,
"restorationSlas" : [ {
"sla" : "Standard",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "17.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "28.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "62.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "37.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "73.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "84.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
} ],
"allowedAggregationMethods" : [ "ETHERNET", "L2TP" ]
}In the above example one infrastructure (copper pair) is returned. However in this scenario we don’t want a service added to it. Instead we want to request an additional copper pair for the service to go on. We can do this because all copper pair’s at the location are in use. You know you can request an additional copper pair because the infrastructure installation options is populated (!infrastructureInstallationOptions.isEmpty()). In this scenario there is only one install option nbn-tech you can choose. It has an associated additional infrastructure fee (infrastructureInstallationOptions[option='nbn-tech'].fees.tc4[name='ADDITIONAL_INFRASTRUCTURE'']). In the above example the additional infrastructure fee for the "nbn-tech" installation option consists of a one time charge of AUD $180.00.
If an order is placed for a service on an additional copper pair the order type (orderType) will be new and you will incur the additional infrastructure fee.
Step 2 Place the Order for a new Service on an additional Copper Pair
POST Request Place Order
POST /api/connect/orders/create HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 686
Host: 360-api.superloop.com
{
"sourceType" : "nbn",
"planName" : "Home Fast 100/20",
"term" : 1,
"trafficClass" : "tc4",
"remoteQualificationSearchId" : "1eb878c4-d5e1-63cc-8780-7e380507f753",
"qualificationSearchId" : "d8a71e0b-4da6-44b4-a28e-b6d3ff5abb5c",
"locationId" : "LOC151638004861",
"remoteOrderId" : "1eb878c4-d4b9-6e0e-9f99-7e380507f753",
"productType" : "Access Only",
"restorationSla" : "Standard",
"contactName" : "Bruce Wayne",
"contactPhone" : "4000000000",
"contactEmail" : "bruce@wayne.com",
"infrastructureId" : null,
"requireVLAN" : false,
"ntdInstallation" : "nbn-tech",
"customerReference" : "ABC123",
"potsWaiver" : true,
"aggregationMethod" : "L2TP"
}POST Response Place Order
HTTP/1.1 201 Created
Location: /api/connect/orders/1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2528
{
"id" : 1,
"orderType" : "new",
"status" : "OPEN",
"serviceClass" : "34",
"technologyType" : "FTTC",
"trafficClass" : "TC4",
"installationType" : "nbn-tech",
"customerRef" : "ABC123",
"locId" : "LOC151638004861",
"avcId" : null,
"avcIdForTransfer" : null,
"vlanId" : null,
"poi" : "9zrvcxfsn",
"poiName" : "East Antonette",
"region" : "Urban",
"eSla" : "Standard",
"bandwidthProfile" : {
"speedDown" : 100,
"speedUp" : 20,
"planName" : "Home Fast 100/20",
"cvcInclusion" : null
},
"infrastructure" : null,
"address" : {
"buildingLevel" : null,
"unitNumber" : null,
"buildingName" : null,
"streetNumber" : "4861",
"street" : "ROCKWELL AV",
"suburb" : "KEILOR EAST",
"state" : "VIC",
"postcode" : "3033",
"formattedAddress" : "4861 ROCKWELL Avenue, KEILOR EAST, Victoria, 3033"
},
"fee" : {
"attributes" : {
"plan" : "Home Fast 100/20",
"term" : "1"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "65.00",
"currency" : "AUD",
"symbol" : "$"
}
},
"additionalFees" : [ {
"addOnTypeName" : "SLA",
"fee" : {
"attributes" : {
"sla" : "Standard"
},
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
}, {
"addOnTypeName" : "NDF",
"fee" : {
"attributes" : {
"ndf" : "New Development Fee"
},
"oneTimeCharge" : {
"amount" : "300.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
}, {
"addOnTypeName" : "SUBSEQUENT_INSTALLATION_CHARGE",
"fee" : {
"attributes" : {
"technology_type" : "fttc"
},
"oneTimeCharge" : {
"amount" : "180.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
}
} ],
"appointments" : [ ],
"aggregationMethod" : "L2TP",
"legacyTechnologyType" : null,
"transferType" : null,
"360ServiceId" : null,
"isCancellable" : false,
"isNfas" : false
}In the above example an order was placed for a service on an additional copper pair. The creation was successful and the Order resource returned. The order type is new (orderType = 'new') and additional fees (additionalFees) contains the additional infrastructure fee as one of the fees charged (additionalFees.addOnTypeName = 'ADDITIONAL_INFRASTRUCTURE').
New Copper Pair - Cannot request an additional Copper Pair
GET Response Qualification does NOT allow an additional copper pair to be added
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 6288
{
"locationId" : "LOC151638005051",
"sourceType" : "nbn",
"address" : "5051 MARSALIS Drive, AVONDALE HEIGHTS, Victoria, 3034",
"addressDetails" : {
"buildingName" : null,
"buildingLevel" : null,
"unitNumber" : null,
"streetNumber" : "5051",
"street" : "MARSALIS Drive",
"suburb" : "AVONDALE HEIGHTS",
"state" : "Victoria",
"postcode" : "3034"
},
"technologyType" : "TC4",
"qualificationSearchId" : "c18eda52-db36-47f0-bd12-7535beb6db7e",
"remoteQualificationSearchId" : "1eb7be9a-b486-6540-a9e8-7e380507f753",
"status" : "Serviceable",
"region" : "Urban",
"accessTechnology" : "FTTC",
"accessTechnologyDescription" : "Fibre To The Curb",
"availableProducts" : {
"id" : 2,
"name" : "tc4",
"description" : "TC4",
"options" : [ "Home Fast 25/5", "Home Fast 100/20", "Home Fast 12/1", "Home Fast 25/10", "Home Fast 50/20", "Home Fast 100/40" ]
},
"latitude" : "-33.40005051",
"longitude" : "151.400005051",
"avcId" : null,
"orderId" : "1eb7be9a-b34b-6b76-b99b-7e380507f753",
"alternativeAccessTechnology" : null,
"poiId" : "9zrvcxfsn",
"poiName" : "East Antonette",
"sqType" : "STANDARD",
"serviceClass" : "34",
"serviceClassDescription" : "Location serviced by FTTC and has infrastructure in place",
"orderSlas" : [ "Standard", "Accelerated" ],
"newDevelopmentsCharge" : {
"applies" : true,
"fees" : [ {
"name" : "NDF",
"oneTimeCharge" : {
"amount" : "300.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
},
"infrastructureInstallationOptions" : [ ],
"infrastructures" : [ {
"infrastructureId" : "CPI151638005051",
"installationOptions" : [ {
"option" : "nbn-no-action",
"recommended" : true,
"fees" : [ ],
"hardwareShortfall" : false
}, {
"option" : "nbn-dispatch",
"recommended" : false,
"fees" : [ ],
"hardwareShortfall" : true
}, {
"option" : "nbn-tech",
"recommended" : false,
"fees" : [ {
"name" : "NBN_TECHNICIAN_FOR_INSTALL",
"oneTimeCharge" : {
"amount" : "180.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ],
"hardwareShortfall" : true
} ],
"serviceabilityClass" : "34",
"serviceStatus" : "Line Not In Use",
"serviceType" : null,
"recommended" : true,
"upstream" : {
"lowerRate" : "20Mbps",
"upperRate" : "40Mbps"
},
"downstream" : {
"lowerRate" : "70Mbps",
"upperRate" : "100Mbps"
},
"referencedData" : null,
"copperPairStatus" : null,
"hasActivePOTS" : false,
"potsInterconnectMatch" : false,
"potsInterconnect" : null,
"ntdSelfInstallEligible" : true,
"fees" : [ ],
"subsequentInstallationCharge" : {
"applies" : false,
"fees" : [ ]
},
"networkCoexistence" : "Yes",
"avcIdMatch" : null
} ],
"potsInterconnect" : null,
"ntdSelfInstallEligible" : null,
"restorationSlas" : [ {
"sla" : "Standard",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "17.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 12 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "28.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 8 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "62.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "37.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 6 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "73.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "45.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
}, {
"sla" : "Enhanced - 4 (24/7)",
"fees" : [ {
"name" : "SLA",
"oneTimeCharge" : {
"amount" : "0.00",
"currency" : "AUD",
"symbol" : "$"
},
"monthlyRecurringCharge" : {
"amount" : "84.00",
"currency" : "AUD",
"symbol" : "$"
}
} ]
} ],
"allowedAggregationMethods" : [ "ETHERNET", "L2TP" ]
}In the above example one infrastructure (copper pair) is returned. It is not in use as there is no product instance id (reference data (referenceData) is null). You know you cannot request an additional copper pair because the infrastructure installation options is NOT populated (infrastructureInstallationOptions.isEmpty()).
First or Addition Infrastructure at location, Avc Id not required, but provided
If you are ordering the first or additional infrastructure at the location an avc id (avcIdForTransfer) should NOT be provided. If you provide the avc id (avcIdForTransfer) a 422 is returned.
POST Response Place Order Without Avc Id When Required
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 466
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.avc.id.not.required",
"message" : "avcId should not be provided if first or additional infrastructure at location",
"object" : "CreateServiceQuoteNbnCommand",
"field" : "avcIdForTransfer",
"rejectedValue" : "AVC123456789012"
} ],
"timestamp" : "2025-03-11T22:25:54.687171975Z"
}First or Addition Infrastructure at location, Transfer Type not required, but provided
If you are ordering the first or additional infrastructure at the location a Transfer Type (transferType) should NOT be provided. If you provide the Transfer Type (transferType) a 422 is returned.
POST Response Place Order With Transfer Type When Not Required
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 480
{
"httpStatusCode" : 422,
"type" : "client.validation",
"code" : "validation",
"message" : "Validation error",
"apiSubErrors" : [ {
"code" : "constraints.transfer.type.not.required",
"message" : "transferType should not be provided if first or additional infrastructure at location",
"object" : "CreateServiceQuoteNbnCommand",
"field" : "transferType",
"rejectedValue" : "CONNECT_OUTSTANDING"
} ],
"timestamp" : "2025-03-11T22:25:45.449781962Z"
}