Request an amendment to an inflight provide, cease or modify order.

post/service-order-amendments

This endpoint is called to request amendment(s) to an existing inflight order to provision, modify or cease a service.

The gateway will validate the request and generate an amendment reference which is returned. If the order amendment is rejected immediately then a 400 code will be returned with reason(s) for the rejection in the response.

The order amendment will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the amendment does not meet supplier validation/processing rules.

Securityoauth2
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 a request to amend an existing inflight service provide order. Any value(s) supplied will replace the existing value(s).

orderId
required
number

Unique identifier for the modify service order to be amended

supplier
string^\w{1,20}$

System identifier for a supplier on the gateway that is associated with this order

Array of objects (ServiceCharacteristic) non-empty

List of service characteristics for the service order item

object (Contact)

Represents a contact available at the given address - primary contact must be provided.

object (Contact)

Represents a contact available at the given address - primary contact must be provided.

appointmentReservationId
number >= 1

Unique identifier for the reserved appointment (if applicable)

requestedCompletionDate
string <date>

Where not appointed, allows a date to be requested for the service activation

engineerTasks
Array of strings (EngineerTasks)

Engineer tasks to be performed at installation appointment.

  • INSTALL_ROUTER
  • TEST_SINGLE_DEVICE
  • ADDITIONAL_CABLING
  • TEST_MULTIPLE_DEVICES
  • INSTALL_BBU
  • VOICE_REINJECTION
  • PROVE_IP_VOICE
hazards
string [ 1 .. 1000 ] characters

Hazard information about the site where the service will be installed

onSiteRestrictions
string [ 1 .. 1000 ] characters

Information about restrictions on the site where the service(s) will be installed

notes
string [ 1 .. 1000 ] characters

Notes about the order

Responses
201

Order amendment request has been received and will be confirmed or rejected later by 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
{
  • "orderId": 123,
  • "supplier": "DUMMY_SUPPLIER",
  • "serviceCharacteristics": [
    • {
      • "name": "LINE_PROFILE",
      • "value": "1G1G"
      }
    ],
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345,
  • "requestedCompletionDate": "2022-01-10",
  • "engineerTasks": [
    • "TEST_SINGLE_DEVICE"
    ],
  • "hazards": "string",
  • "onSiteRestrictions": "string",
  • "notes": "Lorem ipsum dolor sit amet..."
}
Response samples
application/json
{
  • "id": 234,
  • "supplierReference": "A123X-1",
  • "status": "REJECTED",
  • "orderId": 123,
  • "supplier": "DUMMY_SUPPLIER",
  • "serviceCharacteristics": [
    • {
      • "name": "LINE_PROFILE",
      • "value": "1G1G"
      }
    ],
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345,
  • "requestedCompletionDate": "2022-01-10",
  • "engineerTasks": [
    • "TEST_SINGLE_DEVICE"
    ],
  • "hazards": "string",
  • "onSiteRestrictions": "string",
  • "notes": "Lorem ipsum dolor sit amet..."
}