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

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

A request will contain 1 or more fields to be amended - only fields supplied should be changed e.g. if a new contact phone number is provided then the existing contact name and email address would remain the same.

The supplier should validate the amendment request. If the request is invalid or not possible then a 422 code should be returned with reason(s) for the rejection in the response.

The supplier may return a 202 accepted response without confirming the cancellation if further validation/processing is required. In this scenario, the supplier must then send an order update (KCI) to later confirm the order was cancelled or if rejected.

Alternatively, the supplier can confirm the amendment immediately by returning a 201 created response.

SecuritybearerAuth
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

Tenant
required
string

The tenant that has placed the request on the gateway

Example: TENANT1
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).

id
required
number >= 1

Unique identifier for this provide service order amendment request (generated by the gateway)

orderId
required
number >= 1

Unique reference identifying the service order to be amended

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)

appointmentReservationReference
string [ 1 .. 50 ] characters

Unique reference identifying the appointment - supplier reference (if applicable)

requestedCompletionDate
string <date>

Where not appointed, allows the tenant/customer to request a date 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 was successful and the order has been updated.

202

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

Invalid or failed response from the supplier

503

Supplier API is temporarily unavailable

post/service-order-amendments
Request samples
application/json
{
  • "id": 234,
  • "orderId": 123,
  • "serviceCharacteristics": [
    • {
      • "name": "ENNI_ID",
      • "value": "1"
      }
    ],
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345,
  • "appointmentReservationReference": "A234X",
  • "requestedCompletionDate": "2022-01-10",
  • "engineerTasks": [
    • "TEST_SINGLE_DEVICE"
    ],
  • "hazards": "string",
  • "onSiteRestrictions": "string",
  • "notes": "Lorem ipsum dolor sit amet..."
}
Response samples
application/json
{
  • "supplierReference": "A123-1",
  • "id": 234,
  • "orderId": 123,
  • "serviceCharacteristics": [
    • {
      • "name": "ENNI_ID",
      • "value": "1"
      }
    ],
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345,
  • "appointmentReservationReference": "A234X",
  • "requestedCompletionDate": "2022-01-10",
  • "engineerTasks": [
    • "TEST_SINGLE_DEVICE"
    ],
  • "hazards": "string",
  • "onSiteRestrictions": "string",
  • "notes": "Lorem ipsum dolor sit amet..."
}