Retrieve current ethernet order details including updates (KCIs).

get/ethernet/service-orders/{id}

This endpoint is called to retrieve the current details (including KCIs) about an inflight ethernet order.

Securityoauth2
Request
path Parameters
id
required
string

Find order details relating to the specified ethernet order

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

Responses
200

Request successful - order details were returned

400

Bad request - supplied parameters were malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

404

Order not found with the specified id

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Gateway error

502

Invalid or no response from the supplier

503

Fibre Gateway is temporarily unavailable

Response samples
application/json
{
  • "id": 123,
  • "status": "ACKNOWLEDGED",
  • "supplierOrderNumber": "A123X",
  • "created": "2022-01-01T09:09:33.001Z",
  • "updated": "2022-01-01T09:45:39.001Z",
  • "updates": [
    • {
      • "id": "3456cf7d-4471-42e4-a5be-c24ed58a7aa6",
      • "supplier": "SUPPLIER1",
      • "sequenceNumber": 1,
      • "issuedOn": "2022-01-10T09:00:00.000Z",
      • "receivedOn": "2022-01-10T09:00:00.000Z",
      • "deliveredOn": "2022-01-10T09:00:00.000Z",
      • "deliveryStatus": "PENDING",
      • "updateType": "ACTION_REQUIRED",
      • "supplierNotes": [
        • {
          • "note": "Lorem ipsum dolor sit amet...",
          • "type": "Engineer Note",
          • "created": "2022-01-01T09:09:33.001Z"
          }
        ],
      • "information": {
        • "type": "CREATED",
        • "code": "NETWORK_ISSUE",
        • "text": "Resolving network issue",
        • "supplierCode": "313",
        • "supplierCodes": [
          • "313"
          ]
        },
      • "action": {
        • "type": "INFORMATION_REQUIRED",
        • "code": "NETWORK_ISSUE",
        • "text": "Fault between Node and Toby.",
        • "supplierCode": "313",
        • "supplierCodes": [
          • "313"
          ]
        },
      • "error": {
        • "uuid": "87432dfb-2e47-4532-a1b7-4b113d48867d",
        • "code": "GATEWAY_FAULT",
        • "messages": [
          • "e.g. Invalid value for field x - accepted values are y"
          ]
        }
      }
    ],
  • "committedDate": "2022-01-01T09:09:33.001Z",
  • "targetDate": "2022-01-01T09:09:33.001Z",
  • "supplier": "SUPPLIER2",
  • "supplierQuoteId": "SUPP2-QUO-ETH-5001",
  • "siteInformation": [
    • {
      • "name": "Strategic Imperative Offices",
      • "address": {
        • "id": "A00000031882",
        • "type": "NAD",
        • "additionalIdentifiers": [
          • {
            • "id": "A00000031882",
            • "type": "NAD"
            }
          ]
        },
      • "postcode": "TW184LG",
      • "role": "A-END",
      • "siteCharacteristics": [
        • {
          • "name": "POINT_OF_INTERCONNECT",
          • "value": "1G1G"
          }
        ],
      • "wayleave": {
        • "wayleaveOwner": true,
        • "wayleaveCharacteristics": [
          • {
            • "name": "POINT_OF_INTERCONNECT",
            • "value": "1G1G"
            }
          ],
        • "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",
      • "address": {
        • "id": "A00000031882",
        • "type": "NAD",
        • "additionalIdentifiers": [
          • {
            • "id": "A00000031882",
            • "type": "NAD"
            }
          ]
        },
      • "postcode": "TW184LG",
      • "role": "A-END",
      • "siteCharacteristics": [
        • {
          • "name": "POINT_OF_INTERCONNECT",
          • "value": "1G1G"
          }
        ],
      • "wayleave": {
        • "wayleaveOwner": true,
        • "wayleaveCharacteristics": [
          • {
            • "name": "POINT_OF_INTERCONNECT",
            • "value": "1G1G"
            }
          ],
        • "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..."
      }
    ],
  • "ethernetOrderItems": [
    • {
      • "service": {
        • "serviceSpecification": {
          • "id": "ftthl2r",
          • "name": "FTTH"
          },
        • "serviceCharacteristic": [
          • {
            • "name": "POINT_OF_INTERCONNECT",
            • "value": "1G1G"
            }
          ]
        },
      • "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"
        }
      }
    ]
}