Untitled

The OrderRejected notification is sent when an order you have placed has been rejected by the nbn.

Along with the headers listed on the main Superloop Connect page, The request headers that are sent with the request to the callback URL includes the following:

Table 1. Webhook Event Notification Request Headers
Header	Value
z-event-type	order.rejected.event
z-notification-type	order.rejected.notification
z-notification-model	order

The payload of the notification will include the order id (id) and the 360 service id (serviceId) that the order is set to provide as well as the service’s configuration.

Example payload of the OrderRejected webhook notification

{
    "id": 100,
    "type": "transfer",
    "serviceClass": "3",
    "technologyType": "FTTP",
    "trafficClass": "TC4",
    "installationType": "nbn-no-action",
    "customerRef": "Albany Creek Library",
    "locId": "LOC000000000000",
    "avcId": null,
    "avcIdForTransfer": null,
    "vlanId": 100,
    "poi": "4BNB",
    "poiName": "Aspley Depot",
    "region": "Urban",
    "eSla": "Standard",
    "bandwidthProfile": {
        "speedDown": 50,
        "speedUp": 20,
        "planName": "Home Fast 50/20",
        "cvcInclusion": 2.25
    },
    "infrastructure": {
        "id": "NTD000000000000",
        "portId": "1",
        "productId": "PRI000000000000"
    },
    "address": {
        "buildingLevel": "Level 1",
        "unitNumber": "U5",
        "buildingName": "Building at 16",
        "streetNumber": "2494",
        "street": "BOOGDR",
        "suburb": "TENNYSON POINT",
        "state": "NSW",
        "postcode": "2111",
        "formattedAddress": "Unit 6, 5-7 BERESFORD Road, STRATHFIELD, New South Wales, 2135"
    },
    "rejectedReason": "Order was rejected: VLAN ID is not able to be applied",
    "rejectedOn": "2021-02-23T04:36:00Z",
    "serviceId": 300,
    "aggregationMethod": "L2TP",
    "isNfas": true,
    "legacyTechnologyType": "FTTN",
    "isCancellable": true,
    "transferType": "SERVICE_TRANSFER"
}

Table 2. Fields specific to OrderRejected
Field	Explanation
`rejectedReason`	The reason to reject the order by nbn.
`rejectedOn`	The date/time, including UTC offset, when the nbn rejected the order.

Table 3. Fields for all Order based webhooks
Field	Explanation
`type`	Whether the order is for a new service or a transfer. `new` - when placing an order for the first infrastructure or an additional infrastructure `transfer` - when placing an order for an in use infrastructure
`serviceClass`	The standard nbn service class of the site.
`technologyType`	The type of nbn technology that the service is delivered through. See "nbn Technology Type Map" below
`trafficClass`	The nbn traffic class, e.g. `TC4`
`installationType`	Whether the NTD is going to be installed by an nbn technician or by the site’s tenant. `nbn-tech` - an nbn technician is going to install the NTD `nbn-dispatch` - the NTD will be shipped to either the site or a separate delivery address and someone from the site will install it `nbn-no-action` - The is no need for a new NTD to be installed
`customerRef`	The reference string that you provided when you placed the order
`locId`	The nbn LOC ID of the address of the site the order is for
`avcId`	The AVC ID of the virtual circuit that is created for this service. This is only set on OrderAccepted, OrderFttcActivate and OrderHfcNtdNotOnline notifications.
`avcIdForTransfer`	The AVC ID that was specified at order time for a transfer order. That is for an NTD with a port that is Used or NCD (Copper Pair) with a Line In Use. Null in all other cases.
`vlanId`	The VLAN that was specified at order time
`poi`	The code of the nbn POI that the site will be serviced from
`poiName`	The name of the nbn POI that the site will be serviced from
`region`	The nbn region identifier that nbn places the site in. Possible values are: `Major Rural` `Minor Rural` `Remote` `Urban` `Isolated Area` `Limited Access Area`
`eSla`	The level of restoration SLA that the service will have. Currently, only `Standard` is available.
`bandwidthProfile`	An object that contains details on the bandwidth profile that was selected for the service
`bandwidthProfile.speedDown`	The download speed of the service, in mbps
`bandwidthProfile.speedUp`	The upload speed of the service, in mbps
`bandwidthProfile.planName`	The name of the plan that was selected for the service
`bandwidthProfile.cvcInclusion`	The CVC inclusion that is applied to CVC rebates, if applicable.
`infrastructure`	Information about the infrastructure at the site, including NTDs and Copper Pairs
`infrastructure.id`	The nbn identifier of the equipment
`infrastructure.portId`	The port on the device that was chosen for the service.Only for NTD infrastructure.
`infrastructure.productId`	The nbn identifier of the product component that is activated for the Customer.
`address`	The address of the site where the service is being provided
`address.buildingLevel`	The level that the site is on, if applicable
`address.unitNumber`	The unit number of the site, if applicable
`address.buildingName`	The name of the building, if applicable
`address.streetNumber`	The street number of the site
`address.street`	The name of the street, including street type
`address.suburb`	The suburb
`address.state`	The state
`address.postcode`	The postcode
`address.formattedAddress`	The whole address, formatted in a single line
`serviceId`	The ID of the 360 service that the order fulfils
`id`	The ID of the 360 order
`aggregationMethod`	The aggregation method of the order. Possible values are: `L2TP` `ETHERNET`
`isNfas`	Indicates whether the order is for a nbn Co’s Fibre Access Service (NFAS). Possible values are: `true` `false`
`legacyTechnologyType`	Legacy nbn technology type of the the service if the service is NFAS otherwise NULL
`isCancellable`	Indicates whether the order is cancellable. Possible values are: `true` `false`
`transferType`	Indicates type of the transfer if the order is a transfer order otherwise value will be `NULL`. Possible values are: `SERVICE_TRANSFER` `CONNECT_OUTSTANDING`

Table 4. nbn Technology Type Map
Acronym	Description
FTTP	Fibre to the Premises
FTTB	Fibre to the Building
FTTN	Fibre to the Node
FTTC	Fibre to the Curb
HFC	Hybrid Fibre-Coaxial
FW	Fixed Wireless
SAT	Satellite