Examples are available within the API documentation but here are some common end-to-end example KCIs demonstrating full scenarios.
Fibre Cafe will send a KCI once the order has been sent to the supplier:
{
"id": "d394b30d-944e-49b5-a2f6-da5824d0b31b",
"supplier": "FIBRECO",
"sequenceNumber": 1,
"issuedOn": "2024-04-10T09:53:17.044Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"status": "SENT_TO_SUPPLIER",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"information": {
"type": "UPDATE"
}
}This will be followed by 1 of 2 types of KCIS: ACKNOWLEDGED or REJECTED.
Note: some suppliers may send other KCIs before/after acknowledging/committing orders - these will be received as generic UPDATE KCIs.
Once the supplier receives the order and it meets initial validation rules, it will be acknowledged by the supplier sending a KCI. In some cases, suppliers respond synchronously so the Fibre Cafe will send this KCI.
{
"id": "1150e313-3020-49f3-ace3-f8aacfeec4e3",
"supplier": "FIBRECO",
"sequenceNumber": 2,
"issuedOn": "2024-04-10T09:53:39.144Z",
"receivedOn": "2024-04-10T09:53:58.476Z",
"deliveredOn": "2024-04-10T09:53:58.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "ACKNOWLEDGED",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:58.622Z"
},
"information": {
"type": "ACKNOWLEDGED"
}
}Once business rules are complete, the order will be committed and a COMMITTED KCI will be sent.
Where the Fibre Cafe cannot send the order to a supplier due to an error, an error KCI will be sent.
{
"id": "51adb86d-bbe1-43f0-94bf-9737ebef232e",
"supplier": "FIBRECO",
"sequenceNumber": 2,
"issuedOn": "2024-04-10T09:53:19.144Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "ERROR",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"status": "FAILED_TO_SEND",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"error": {
"uuid": "8a3138c9-6523-48b9-81bc-5870bdb5972f",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}This KCI is terminal and a new order must be created.
If the order does not meet validation rules, the order will be rejected via a terminated KCI.
{
"id": "1150e313-3020-49f3-ace3-f8aacfeec4e3",
"supplier": "FIBRECO",
"sequenceNumber": 2,
"issuedOn": "2024-04-10T09:53:19.144Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"status": "REJECTED",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"information": {
"type": "TERMINATED",
"code": "INVALID_REQUEST",
"text": "Property already has open order",
"supplierCode": "SL05"
}
}This KCI is terminal and a new order must be created/submitted.
Once the supplier has completed validation and business processing, the order will be committed. In some cases, suppliers respond synchronously so the Fibre Cafe will send this KCI.
{
"id": "ac38d11d-8eb7-478f-80f3-a5e16aabfa9e",
"supplier": "FIBRECO",
"sequenceNumber": 3,
"issuedOn": "2024-04-10T09:54:19.144Z",
"receivedOn": "2024-04-10T09:54:38.476Z",
"deliveredOn": "2024-04-10T09:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:58.622Z"
},
"information": {
"type": "COMMITTED"
}
}The order is now in progress and has a fixed committed date for the order to complete. Target date will show the current expected completion date where this date changes e.g. because of delay.
Where a new appointment is required, the supplier will send a REAPPOINT KCI to instruct the tenant to reserve a new appointment and amend the order.
{
"id": "970606e1-d5b0-44d0-995c-7f55ff14e94b",
"supplier": "FIBRECO",
"sequenceNumber": 4,
"issuedOn": "2024-04-12T09:55:25.144Z",
"receivedOn": "2024-04-12T09:55:47.476Z",
"deliveredOn": "2024-04-12T09:55:47.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "PENDING",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T09:55:47.622Z"
},
"action": {
"type": "REAPPOINT",
"code": "ACCESS_ISSUE",
"text": "Unable to access property",
"supplierCode": "SL11"
},
"supplierNotes": [
{
"note": "Rang doorbell but no answer. No answer on phone either.",
"created": "2024-04-12T09:55:47.622Z"
}
]
}Note: appointments are not usually required for cease orders and are only required for some modify orders (e.g. for regrades or where engineer tasks are necessary).
Where the customer needs to be contacted to address an issue prior to reappointing, the supplier will send the CONTACT_REAPPOINT KCI, to instruct the tenant to contact the customer before reserving a new appointment and amend the order.
Provide Order
{
"id": "970606e1-d5b0-44d0-995c-7f55ff14e94b",
"supplier": "FIBRECO",
"sequenceNumber": 4,
"issuedOn": "2024-04-12T09:55:25.144Z",
"receivedOn": "2024-04-12T09:55:47.476Z",
"deliveredOn": "2024-04-12T09:55:47.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "PENDING",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T09:55:47.622Z"
},
"action": {
"type": "CONTACT_REAPPOINT",
"code": "ACCESS_ISSUE",
"text": "Unable to access property",
"supplierCode": "SL11"
},
"supplierNotes": [
{
"note": "Dog on the property. Please contact customer before reappointing.",
"created": "2024-04-12T09:55:47.622Z"
}
]
}Notes:
Where the next action is for the tenant to contact the customer, then CONTACT_REAPPOINT KCI may be sent without a DELAY KCI first.
Where the supplier has been in contact with the end customer and/or arranged a new appointment, the supplier will send a REAPPOINTED KCI to confirm the new appointment.
Provide Order
{
"id": "36fffca2-6b7f-4c0b-8dd5-28f0b633607f",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-12T16:55:25.144Z",
"receivedOn": "2024-04-12T16:55:47.476Z",
"deliveredOn": "2024-04-12T16:55:47.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23460,
"appointmentSupplierReference": "123456688",
"appointmentTimeslot": {
"timeslotStartDateTime": "2024-04-13T09:00:00.000Z",
"timeslotEndDateTime": "2024-04-13T13:00:00.000Z"
},
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-13T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T16:55:47.622Z"
},
"information": {
"type": "REAPPOINTED",
"code": "ADDITIONAL_WORK",
"supplierCode": "SL12"
},
"supplierNotes": [
{
"note": "Customer wanted routing to the back of the property - completed externally. Agreed with customer for follow up tomorrow morning to complete internal works",
"created": "2024-04-12T09:55:47.622Z"
}
]
}Note: appointments are not usually required for cease orders and are only required for some modify orders (e.g. for regrades or where engineer tasks are necessary).
Where the supplier deems that the booked appointment is not required, the supplier will cancel the appointment and send a WARNING KCI to confirm.
Provide Order
{
"id": "60d8ebf0-49c5-4460-934e-55d708b8c08a",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-12T16:55:25.144Z",
"receivedOn": "2024-04-12T16:55:47.476Z",
"deliveredOn": "2024-04-12T16:55:47.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-13T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T16:55:47.622Z"
},
"information": {
"type": "WARNING",
"code": "APPOINTMENT_NOT_REQUIRED",
"supplierCode": "SL93"
}
}Where the order is delayed, the supplier will send a DELAYED KCI to inform the tenant of the delay and reason:
Provide Order
{
"id": "f7d66f78-0233-4568-a481-1acf8c320871",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-12T16:55:25.144Z",
"receivedOn": "2024-04-12T16:55:47.476Z",
"deliveredOn": "2024-04-12T16:55:47.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "HELD",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T16:55:47.622Z"
},
"information": {
"type": "DELAY",
"code": "NETWORK_ISSUE",
"text": "Distribution network fault - await further info",
"supplierCode": "SL46"
}
}When the order is delayed but the issue is resolved without impact on target date or existing appointment, the supplier will send a RESUMED KCI.
Provide Order
{
"id": "f7d66f78-0233-4568-a481-1acf8c320871",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-12T16:55:25.144Z",
"receivedOn": "2024-04-12T16:55:47.476Z",
"deliveredOn": "2024-04-12T16:55:47.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T16:55:47.622Z"
},
"information": {
"type": "RESUMED",
"text": "Fault identified and resolved - work to resume",
"supplierCode": "SL83"
}
}Where the supplier requires more information from the tenant, the supplier will send an INFORMATION REQUIRED KCI to request the information:
Provide Order
{
"id": "d9e2e207-67dd-4a4c-adb8-a765d4c7251d",
"supplier": "FIBRECO",
"sequenceNumber": 3,
"issuedOn": "2024-04-10T09:54:19.144Z",
"receivedOn": "2024-04-10T09:54:38.476Z",
"deliveredOn": "2024-04-10T09:54:38.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "PENDING",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:58.622Z"
},
"action": {
"type": "INFORMATION_REQUIRED",
"code": "INFORMATION_REQUIRED",
"text": "Please provide correct contact number for the end customer",
"supplierCode": "SL07"
}
}Where the supplier has sent new/updated information in a KCI, the Fibre Cafe will send an ADDITIONAL KCI to flag this:
Provide Order
{
"id": "01e34ebf-72d7-40ae-a4d2-e8d1c3bc9f2c",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z"
},
"supplierNotes": [
{
"note": "Confirmed route with customer, no issues expected",
"type": "Site Visit Notes",
"created": "2024-04-11T09:53:58.622Z"
}
],
"information": {
"type": "ADDITIONAL",
"text": "Adhoc Note to CP",
"supplierCode": "SL99"
}
}The supplier may flag a warning in a KCI - this is informational but may require the tenant to take action to avoid a delay:
Provide Order
{
"id": "81efec7d-0e09-4cda-8fd3-a6f69dfddab1",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z"
},
"information": {
"type": "WARNING",
"code": "COST_ISSUE",
"text": "Additional charges will apply for TMA Permit",
"supplierCode": "SL37"
}
}When the tenant places an amendment request on the order, the supplier will send an AMENDMENT ACCEPTED KCI to confirm the amendment has been accepted:
Provide Order
{
"id": "0a8c5541-2a2e-4a61-8cfb-7d05470c05cc",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23457,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-13T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"appointmentReservationId": 23457,
"status": "COMPLETED"
}
},
"information": {
"type": "AMENDED"
}
}Where the Fibre Cafe cannot send the order amendment to a supplier due to an error, an error KCI will be sent.
{
"id": "59d7136a-8a5a-45f3-bd64-ab13bea8b36f",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "ERROR",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-13T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"appointmentReservationId": 23457,
"status": "FAILED_TO_SEND"
}
},
"error": {
"uuid": "53f6cf50-5e21-48be-9717-7606f30ea0c3",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}Where the supplier rejects the tenant's amendment request, the supplier will send an AMENDMENT REJECTED KCI to inform the tenant that the amendment has been rejected:
{
"id": "067cb4d1-40ef-460a-9f16-29796dcfcdc9",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-13T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:58.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"appointmentReservationId": 23457,
"status": "REJECTED"
}
},
"action": {
"type": "RESUBMIT",
"code": "INVALID_REQUEST",
"text": "Requested appointment reservation has timed out - please reserve a new appointment"
}
}Where the Fibre Cafe cannot send the order cancellation to a supplier due to an error, an error KCI will be sent.
{
"id": "35b01108-3360-4463-9d53-749bb4d9f43f",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "ERROR",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderCancellation": {
"id": 3456,
"orderId": 12345,
"reasonCode": "CUSTOMER_CHANGED_MIND",
"status": "FAILED_TO_SEND"
}
},
"error": {
"uuid": "cd6d9ba4-dea6-49e9-8163-89e6eaaf6b56",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}Where the supplier rejects the tenant's cancellation request (e.g past the point of no return), the supplier will send an CANCEL REJECTED KCI to inform the tenant that the cancellation has been rejected:
{
"id": "35b01108-3360-4463-9d53-749bb4d9f43f",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderCancellation": {
"id": 3456,
"orderId": 12345,
"reasonCode": "CUSTOMER_CHANGED_MIND",
"status": "REJECTED"
}
},
"action": {
"type": "RESUBMIT",
"code": "INVALID_REQUEST",
"text": "Order is past the point of no return and cannot be cancelled"
}
}Where the order is cancelled by the supplier as a result of a cancel request from the tenant, this will result in a cancelled KCI:
{
"id": "d8d7fc5a-a8ee-43c9-8e34-7234b0b009ce",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "CANCELLED",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderCancellation": {
"id": 3456,
"orderId": 12345,
"reasonCode": "CUSTOMER_CHANGED_MIND",
"status": "ACCEPTED"
}
},
"information": {
"type": "CANCELLED"
}
}Where the order is cancelled by the supplier, this will result in a terminated KCI:
{
"id": "d8d7fc5a-a8ee-43c9-8e34-7234b0b009ce",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:54:19.144Z",
"receivedOn": "2024-04-11T09:54:38.476Z",
"deliveredOn": "2024-04-11T09:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "CANCELLED",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z"
},
"information": {
"type": "TERMINATED",
"text": "The order has been cancelled by the supplier on request."
}
}Where the customer needs to be contacted in order to continue or cancel the order, the supplier will send the CONTACT_CUSTOMER KCI, to instruct the tenant to contact the customer before reappointing or cancelling the order.
Provide Order
{
"id": "970606e1-d5b0-44d0-995c-7f55ff14e94b",
"supplier": "FIBRECO",
"sequenceNumber": 4,
"issuedOn": "2024-04-12T09:55:25.144Z",
"receivedOn": "2024-04-12T09:55:47.476Z",
"deliveredOn": "2024-04-12T09:55:47.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "PENDING",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T09:55:47.622Z"
},
"action": {
"type": "CONTACT_CUSTOMER",
"code": "CUSTOMER_CHANGED_MIND",
"text": "Customer has a sales query",
"supplierCode": "SL11"
},
"supplierNotes": [
{
"note": "Please contact customer before reappointing or cancelling.",
"created": "2024-04-12T09:55:47.622Z"
}
]
}The order has now completed but some engineer tasks were not done. For example, if the original order had 'INSTALL_BBU' task but this was not installed:
Provide Order
{
"id": "dfd22c59-d310-4be7-b465-104544f89bb0",
"supplier": "FIBRECO",
"sequenceNumber": 6,
"issuedOn": "2024-04-12T13:54:19.144Z",
"receivedOn": "2024-04-12T13:54:38.476Z",
"deliveredOn": "2024-04-12T013:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "PARTIAL",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
},
{
"name": "SERVICE_ID",
"value": "S123456"
},
{
"name": "ENNI_ID",
"value": "S12345"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"engineerTasks": [
"INSTALL_ROUTER",
"TEST_SINGLE_DEVICE"
],
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T13:53:58.622Z"
},
"information": {
"type": "COMPLETED",
"code": "PARTIAL_INSTALL",
"text": "Partial install complete - some engineer tasks were cancelled or not completed. Check supplier notes"
},
"supplierNotes": [
{
"note": "INSTALL_BBU : Unable to install service (Faulty / Missing / Unsuitable)",
"created": "2024-04-12T13:53:33.001Z"
}
]
}The order has now completed:
{
"id": "dfd22c59-d310-4be7-b465-104544f89bb0",
"supplier": "FIBRECO",
"sequenceNumber": 6,
"issuedOn": "2024-04-12T13:54:19.144Z",
"receivedOn": "2024-04-12T13:54:38.476Z",
"deliveredOn": "2024-04-12T013:54:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "PROVIDE_ORDER",
"entity": {
"orderType": "NEW",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "COMPLETED",
"supplier": "FIBRECO",
"address": {
"id": "10002429380",
"type": "UPRN"
},
"serviceOrderItem": {
"serviceSpecification": {
"id": "FTTP"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1"
},
{
"name": "SERVICE_ID",
"value": "S123456"
},
{
"name": "ENNI_ID",
"value": "S12345"
}
]
},
"primaryContact": {
"name": "John Smith",
"phoneNumber": "01234 567890"
},
"appointmentReservationId": 23456,
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T13:53:58.622Z"
},
"information": {
"type": "COMPLETED"
}
}