Order KCI Examples
Examples are available within the API documentation but here are some common end-to-end example KCIs demonstrating full scenarios.
KCI: ORDER SENT
Fibre Cafe will send a KCI once the order has been sent to the supplier:
Provide OrderModify OrderCease Order
{
"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"
}
}{
"id": "ed16d69e-3971-4fe4-b22a-30258cf3294f",
"supplier": "FIBRECO",
"sequenceNumber": 1,
"issuedOn": "2024-04-10T09:53:17.044Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "SENT_TO_SUPPLIER",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"information": {
"type": "UPDATE"
}
}{
"id": "1bec5de1-2d2a-4018-90c3-e75c0f799531",
"supplier": "FIBRECO",
"sequenceNumber": 1,
"issuedOn": "2024-04-10T09:53:17.044Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "CEASE_ORDER",
"entity": {
"status": "SENT_TO_SUPPLIER",
"created": "2024-04-10T09:53:11.745Z",
"requestedCompletionDate": "2024-05-09T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"orderType": "CEASE",
"id": 12345,
"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.
KCI: ACKNOWLEDGED
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.
Provide OrderModify OrderCease Order
{
"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"
}
}{
"id": "86284960-9755-438c-b1e1-af2a40ae62cb",
"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": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "ACKNOWLEDGED",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:58.622Z"
},
"information": {
"type": "ACKNOWLEDGED"
}
}{
"id": "26086e46-55c2-48cc-b409-c5d5bb79b1c2",
"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": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "ACKNOWLEDGED",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"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.
KCI: SEND FAILED
Where the Fibre Cafe cannot send the order to a supplier due to an error, an error KCI will be sent.
Provide OrderModify OrderCease Order
{
"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"
]
}
}{
"id": "454cc593-eabd-4ce7-9625-65339a54958e",
"supplier": "FIBRECO",
"sequenceNumber": 2,
"issuedOn": "2024-04-10T09:53:19.144Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "ERROR",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "FAILED_TO_SEND",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"error": {
"uuid": "fdfb64a7-a8c4-4f17-94ba-4ab8935b47c4",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}{
"id": "bfb2abe0-bc6c-4293-a0c1-7095c19db756",
"supplier": "FIBRECO",
"sequenceNumber": 2,
"issuedOn": "2024-04-10T09:53:19.144Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "ERROR",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"status": "FAILED_TO_SEND",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"error": {
"uuid": "e50fb686-4de7-4fc7-ba8b-74e18a8eecd5",
"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.
KCI: REJECTED
If the order does not meet validation rules, the order will be rejected via a terminated KCI.
Provide OrderModify OrderCease Order
{
"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"
}
}{
"id": "454cc593-eabd-4ce7-9625-65339a54958e",
"supplier": "FIBRECO",
"sequenceNumber": 2,
"issuedOn": "2024-04-10T09:53:19.144Z",
"receivedOn": "2024-04-10T09:53:38.476Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "REJECTED",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"information": {
"type": "TERMINATED",
"code": "INVALID_REQUEST",
"text": "The serviceId is not active/known to the supplier",
"supplierCode": "SL02"
}
}{
"id": "e12270ad-42d6-478b-9423-68ab677ee806",
"supplier": "FIBRECO",
"sequenceNumber": 2,
"issuedOn": "2024-04-10T09:53:19.144Z",
"receivedOn": "2024-04-10T09:53:38.476Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"status": "REJECTED",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z"
},
"information": {
"type": "TERMINATED",
"code": "INVALID_REQUEST",
"text": "The serviceId is not active/known to the supplier",
"supplierCode": "SL02"
}
}This KCI is terminal and a new order must be created/submitted.
KCI: COMMITTED
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.
Provide OrderModify OrderCease Order
{
"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"
}
}{
"id": "57e7423b-ef95-412d-b7d8-27c6b969941c",
"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": "CEASE_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"committedDate": "2024-04-10T23:59:59Z",
"targetDate": "2024-04-10T23:59:59Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:54:38.622Z"
},
"information": {
"type": "COMMITTED"
}
}{
"id": "1e507f42-4fd0-4260-83f7-118b2977fb2f",
"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": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12T00:00:00Z",
"targetDate": "2024-04-12T00:00:00Z",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:54:38.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.
KCI: REAPPOINT
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).
KCI: REAPPOINTED
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.
{
"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).
KCI: APPOINTMENT NOT REQUIRED
Where the supplier deems that the booked appointment is not required, the supplier will cancel the appointment and send a WARNING KCI to confirm.
{
"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"
}
}KCI: DELAYED
Where the order is delayed, the supplier will send a DELAYED KCI to inform the tenant of the delay and reason:
{
"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"
}
}KCI: RESUMED
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.
{
"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"
}
}KCI: INFORMATION REQUIRED
Where the supplier requires more information from the tenant, the supplier will send an INFORMATION REQUIRED KCI to request the information:
{
"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"
}
}KCI: ADDITIONAL INFORMATION
Where the supplier has sent new/updated information in a KCI, the Fibre Cafe will send an ADDITIONAL KCI to flag this:
{
"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"
}
}KCI: WARNING
The supplier may flag a warning in a KCI - this is informational but may require the tenant to take action to avoid a delay:
{
"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"
}
}KCI: AMENDMENT ACCEPTED
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 OrderModify OrderCease 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"
}
}{
"id": "e2f3059d-70cd-43bd-b6af-b4bb3c8c1611",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:39.144Z",
"receivedOn": "2024-04-11T09:53:58.476Z",
"deliveredOn": "2024-04-11T09:53:58.817Z",
"updateType": "INFORMATIONAL",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "3"
}
],
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "3"
}
],
"status": "COMPLETED"
}
},
"information": {
"type": "AMENDED"
}
}{
"id": "ce5e0930-8688-45cf-8628-f301d1bbc910",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:19.144Z",
"receivedOn": "2024-04-11T09:53:38.476Z",
"deliveredOn": "2024-04-11T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"requestedCompletionDate": "2024-04-14T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-14",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:38.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"requestedCompletionDate": "2024-04-14T00:00:00Z",
"status": "COMPLETED"
}
},
"information": {
"type": "AMENDED"
}
}KCI: AMENDMENT SEND FAILED
Where the Fibre Cafe cannot send the order amendment to a supplier due to an error, an error KCI will be sent.
Provide OrderModify OrderCease Order
{
"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"
]
}
}{
"id": "c835fd5f-f0b3-4e2d-b33a-a1a886571947",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:39.144Z",
"receivedOn": "2024-04-11T09:53:58.476Z",
"deliveredOn": "2024-04-11T09:53:58.817Z",
"updateType": "ERROR",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "3"
}
],
"status": "FAILED_TO_SEND"
}
},
"error": {
"uuid": "198f3dde-04ed-4b64-a13c-e5865faab97f",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}{
"id": "c74589ba-3ad4-422f-b65f-459ed1fb21d3",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-10T09:53:19.144Z",
"receivedOn": "2024-04-10T09:53:38.476Z",
"deliveredOn": "2024-04-10T09:53:38.817Z",
"updateType": "ERROR",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-12",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T09:53:38.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"requestedCompletionDate": "2024-04-14T00:00:00Z",
"status": "FAILED_TO_SEND"
}
},
"error": {
"uuid": "fdfb64a7-a8c4-4f17-94ba-4ab8935b47c4",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}KCI: AMENDMENT REJECTED
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:
Provide OrderModify OrderCease Order
{
"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"
}
}{
"id": "c835fd5f-f0b3-4e2d-b33a-a1a886571947",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:39.144Z",
"receivedOn": "2024-04-11T09:53:58.476Z",
"deliveredOn": "2024-04-11T09:53:58.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:58.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "3"
}
],
"status": "REJECTED"
}
},
"action": {
"type": "RESUBMIT",
"code": "INVALID_REQUEST",
"text": "Order cannot be amended"
}
}{
"id": "724c9254-1534-405a-9e03-881c9e483134",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:19.144Z",
"receivedOn": "2024-04-11T09:53:38.476Z",
"deliveredOn": "2024-04-11T09:53:38.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-12",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:38.622Z",
"serviceOrderAmendment": {
"id": 2345,
"orderId": 12345,
"requestedCompletionDate": "2024-04-14T00:00:00Z",
"status": "REJECTED"
}
},
"action": {
"type": "RESUBMIT",
"code": "INVALID_REQUEST",
"text": "Order is past the point of no return and cannot be amended"
}
}KCI: CANCELLATION SEND FAILED
Where the Fibre Cafe cannot send the order cancellation to a supplier due to an error, an error KCI will be sent.
Provide OrderModify OrderCease Order
{
"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"
]
}
}{
"id": "73cc4bad-52b4-4949-838d-9f75e18986f2",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:39.144Z",
"receivedOn": "2024-04-11T09:53:58.476Z",
"deliveredOn": "2024-04-11T09:53:58.817Z",
"updateType": "ERROR",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"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": "40b9673a-3abe-4fd2-8def-fa72bd04907a",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}{
"id": "724c9254-1534-405a-9e03-881c9e483134",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:19.144Z",
"receivedOn": "2024-04-11T09:53:38.476Z",
"deliveredOn": "2024-04-11T09:53:38.817Z",
"updateType": "ERROR",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-12",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-11T09:53:38.622Z",
"serviceOrderCancellation": {
"id": 3456,
"orderId": 12345,
"reasonCode": "CUSTOMER_CHANGED_MIND",
"status": "FAILED_TO_SEND"
}
},
"error": {
"uuid": "fdfb64a7-a8c4-4f17-94ba-4ab8935b47c4",
"code": "SUPPLIER_FAULT",
"messages": [
"The supplier API returned the following message: 500 Service unavailable"
]
}
}KCI: CANCELLATION REJECTED
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:
Provide OrderModify OrderCease Order
{
"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"
}
}{
"id": "435ceed8-b308-41cc-b032-7bd4cdd8cbc7",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:39.144Z",
"receivedOn": "2024-04-11T09:53:58.476Z",
"deliveredOn": "2024-04-11T09:53:58.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"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"
}
}{
"id": "e6d8a4b6-6859-4e3f-9a52-6279644f755f",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:19.144Z",
"receivedOn": "2024-04-11T09:53:38.476Z",
"deliveredOn": "2024-04-11T09:53:38.817Z",
"updateType": "ACTION_REQUIRED",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "IN_PROGRESS",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-12",
"created": "2024-04-11T09:53:11.745Z",
"updated": "2024-04-11T09:53:38.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"
}
}KCI: 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:
Provide OrderModify OrderCease Order
{
"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"
}
}{
"id": "51d2f4b7-0443-4cf2-ba36-dfec811c8ddb",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:39.144Z",
"receivedOn": "2024-04-11T09:53:58.476Z",
"deliveredOn": "2024-04-11T09:53:58.817Z",
"updateType": "INFORMATIONAL",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "CANCELLED",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"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"
}
}{
"id": "ce5e0930-8688-45cf-8628-f301d1bbc910",
"supplier": "FIBRECO",
"sequenceNumber": 6,
"issuedOn": "2024-04-10T10:53:19.144Z",
"receivedOn": "2024-04-10T10:53:38.476Z",
"deliveredOn": "2024-04-10T10:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "CANCELLED",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-12",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T10:53:38.622Z",
"serviceOrderCancellation": {
"id": 3456,
"orderId": 12345,
"reasonCode": "CUSTOMER_CHANGED_MIND",
"status": "ACCEPTED"
}
},
"information": {
"type": "CANCELLED"
}
}KCI: TERMINATED
Where the order is cancelled by the supplier, this will result in a terminated KCI:
Provide OrderModify OrderCease Order
{
"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."
}
}{
"id": "51d2f4b7-0443-4cf2-ba36-dfec811c8ddb",
"supplier": "FIBRECO",
"sequenceNumber": 5,
"issuedOn": "2024-04-11T09:53:39.144Z",
"receivedOn": "2024-04-11T09:53:58.476Z",
"deliveredOn": "2024-04-11T09:53:58.817Z",
"updateType": "INFORMATIONAL",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "CANCELLED",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"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."
}
}{
"id": "ce5e0930-8688-45cf-8628-f301d1bbc910",
"supplier": "FIBRECO",
"sequenceNumber": 6,
"issuedOn": "2024-04-10T10:53:19.144Z",
"receivedOn": "2024-04-10T10:53:38.476Z",
"deliveredOn": "2024-04-10T10:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "CANCELLED",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-12",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-10T10:53:38.622Z"
},
"information": {
"type": "TERMINATED",
"text": "The order has been cancelled by the supplier on request."
}
}KCI: COMPLETED
The order has now completed:
Provide OrderModify OrderCease 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": "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"
}
}{
"id": "1dc18c3e-cc0a-4f7b-9e29-fa0089e8c11f",
"supplier": "FIBRECO",
"sequenceNumber": 6,
"issuedOn": "2024-04-12T09:53:39.144Z",
"receivedOn": "2024-04-12T09:53:58.476Z",
"deliveredOn": "2024-04-12T09:53:58.817Z",
"updateType": "INFORMATIONAL",
"entityType": "MODIFY_ORDER",
"entity": {
"orderType": "MODIFY",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "COMPLETED",
"supplier": "FIBRECO",
"serviceId": "S12345",
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "2"
}
],
"created": "2024-04-11T09:53:11.745Z",
"updated": "2024-04-12T09:53:58.622Z"
},
"information": {
"type": "COMPLETED"
}
}{
"id": "ce5e0930-8688-45cf-8628-f301d1bbc910",
"supplier": "FIBRECO",
"sequenceNumber": 6,
"issuedOn": "2024-04-12T09:53:19.144Z",
"receivedOn": "2024-04-12T09:53:38.476Z",
"deliveredOn": "2024-04-12T09:53:38.817Z",
"updateType": "INFORMATIONAL",
"entityType": "CEASE_ORDER",
"entity": {
"orderType": "CEASE",
"id": 12345,
"supplierOrderNumber": "FC123",
"status": "COMPLETED",
"requestedCompletionDate": "2024-04-12T00:00:00Z",
"supplier": "FIBRECO",
"serviceId": "S12345",
"committedDate": "2024-04-12",
"targetDate": "2024-04-12",
"created": "2024-04-10T09:53:11.745Z",
"updated": "2024-04-12T09:53:38.622Z"
},
"information": {
"type": "COMPLETED"
}
}