Create an order to provide ethernet service.

post/ethernet/service-orders

This endpoint can be called to place an ethernet order with a supplier to provide service. Ability to cease or modify a service will follow in a later update.

The supplier should validate the order request and accept the order if the validation is successful or otherwise reject the order. If the order is rejected, a 422 code should be returned with reason(s) for the rejection in the response.

If the order is accepted, the supplier may return a 202 accepted response without acknowledging the order if further validation/processing is required. In this scenario, the supplier must then send an order update (KCI) to later acknowledge the order and provide the order number.

Alternatively, the supplier can synchronously acknowledge the order by returning a 201 created response with the returned order containing the supplier order number and status of ACKNOWLEDGED. The order can also be committed at this stage by returning the order status of IN_PROGRESS.

Request
header Parameters
X-Request-ID
required
string

Unique identifier to identify request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Request Body schema: application/json
One of:

Represents an Ethernet order for new service(s) between the sites provided.

id
required
number >= 1

Unique id identifying this service order - generated by the Gateway

tenant
required
string [ 1 .. 50 ] characters

The tenant that has placed the order on the Gateway

supplierQuoteId
required
string [ 0 .. 64 ] characters

A unique identifier of the quote item within the overall quote entity, as provided by the supplier

required
Array of objects (EthernetSiteInformation) >= 2 items
required
Array of objects (EthernetOrderItem) non-empty
Responses
201

Order was acknowledged - returned order should contain the supplier order number and appropriate status

202

Order was accepted and will be acknowledged later via a KCI

400

Bad request - supplied request was malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Request samples
application/json
{
  • "id": 123,
  • "tenant": "TENANT1",
  • "supplierQuoteId": "SUPP2-QUO-ETH-5001",
  • "siteInformation": [
    • {
      • "name": "Strategic Imperative Offices",
      • "postcode": "TW184LG",
      • "role": "A-END",
      • "address": {
        • "id": "200004033694",
        • "type": "UPRN"
        },
      • "siteCharacteristics": [
        • {
          • "name": "END_USER_CPE",
          • "value": "Zyzel DX3301"
          }
        ],
      • "wayleave": {
        • "wayleaveOwner": true,
        • "wayleaveCharacteristics": [
          • {
            • "name": "END_USER_CPE",
            • "value": "Zyzel DX3301"
            }
          ],
        • "wayleaveContact": {
          • "name": "John Smith",
          • "email": "john@smith.com",
          • "phoneNumber": "01234 567890"
          }
        },
      • "primaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "secondaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "hazards": "Hazardous materials stored on site",
      • "onSiteRestrictions": "Restricted access",
      • "notes": "Lorem ipsum dolor sit amet..."
      },
    • {
      • "name": "Strategic Imperative Offices",
      • "postcode": "TW184LG",
      • "role": "A-END",
      • "address": {
        • "id": "200004033694",
        • "type": "UPRN"
        },
      • "siteCharacteristics": [
        • {
          • "name": "END_USER_CPE",
          • "value": "Zyzel DX3301"
          }
        ],
      • "wayleave": {
        • "wayleaveOwner": true,
        • "wayleaveCharacteristics": [
          • {
            • "name": "END_USER_CPE",
            • "value": "Zyzel DX3301"
            }
          ],
        • "wayleaveContact": {
          • "name": "John Smith",
          • "email": "john@smith.com",
          • "phoneNumber": "01234 567890"
          }
        },
      • "primaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "secondaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "hazards": "Hazardous materials stored on site",
      • "onSiteRestrictions": "Restricted access",
      • "notes": "Lorem ipsum dolor sit amet..."
      }
    ],
  • "ethernetOrderItem": [
    • {
      • "service": {
        • "serviceSpecification": {
          • "id": "ftthl2r"
          },
        • "serviceCharacteristic": [
          • {
            • "name": "END_USER_CPE",
            • "value": "Zyzel DX3301"
            }
          ]
        },
      • "contractDetails": {
        • "contractLength": {
          • "value": 36,
          • "unit": "MONTH"
          },
        • "billingFrequency": "MONTHLY",
        • "priceAlteration": "string"
        },
      • "requestedCompletionDate": "2022-01-10",
      • "technicalContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        }
      }
    ]
}
Response samples
application/json
{
  • "id": 123,
  • "tenant": "TENANT1",
  • "status": "PENDING_CANCELLATION",
  • "supplierOrderNumber": "A123X",
  • "created": "2022-01-01T09:09:33.001Z",
  • "updated": "2022-01-01T09:45:39.001Z",
  • "committedDate": "2022-01-01T09:09:33.001Z",
  • "targetDate": "2022-01-01T09:09:33.001Z",
  • "supplierQuoteId": "SUPP2-QUO-ETH-5001",
  • "siteInformation": [
    • {
      • "name": "Strategic Imperative Offices",
      • "postcode": "TW184LG",
      • "role": "A-END",
      • "address": {
        • "id": "200004033694",
        • "type": "UPRN"
        },
      • "siteCharacteristics": [
        • {
          • "name": "END_USER_CPE",
          • "value": "Zyzel DX3301"
          }
        ],
      • "wayleave": {
        • "wayleaveOwner": true,
        • "wayleaveCharacteristics": [
          • {
            • "name": "END_USER_CPE",
            • "value": "Zyzel DX3301"
            }
          ],
        • "wayleaveContact": {
          • "name": "John Smith",
          • "email": "john@smith.com",
          • "phoneNumber": "01234 567890"
          }
        },
      • "primaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "secondaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "hazards": "Hazardous materials stored on site",
      • "onSiteRestrictions": "Restricted access",
      • "notes": "Lorem ipsum dolor sit amet..."
      },
    • {
      • "name": "Strategic Imperative Offices",
      • "postcode": "TW184LG",
      • "role": "A-END",
      • "address": {
        • "id": "200004033694",
        • "type": "UPRN"
        },
      • "siteCharacteristics": [
        • {
          • "name": "END_USER_CPE",
          • "value": "Zyzel DX3301"
          }
        ],
      • "wayleave": {
        • "wayleaveOwner": true,
        • "wayleaveCharacteristics": [
          • {
            • "name": "END_USER_CPE",
            • "value": "Zyzel DX3301"
            }
          ],
        • "wayleaveContact": {
          • "name": "John Smith",
          • "email": "john@smith.com",
          • "phoneNumber": "01234 567890"
          }
        },
      • "primaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "secondaryContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        },
      • "hazards": "Hazardous materials stored on site",
      • "onSiteRestrictions": "Restricted access",
      • "notes": "Lorem ipsum dolor sit amet..."
      }
    ],
  • "ethernetOrderItem": [
    • {
      • "service": {
        • "serviceSpecification": {
          • "id": "ftthl2r",
          • "name": "FTTH"
          },
        • "serviceCharacteristic": [
          • {
            • "name": "END_USER_CPE",
            • "value": "Zyzel DX3301"
            }
          ]
        },
      • "contractDetails": {
        • "contractLength": {
          • "value": 36,
          • "unit": "MONTH"
          },
        • "billingFrequency": "MONTHLY",
        • "priceAlteration": "string"
        },
      • "requestedCompletionDate": "2022-01-10",
      • "technicalContact": {
        • "name": "John Smith",
        • "email": "john@smith.com",
        • "phoneNumber": "01234 567890"
        }
      }
    ]
}