Skip to content

Fibre Cafe : Supplier API (1.15)

Introduction

The Fibre Cafe is a scalable, unified platform to support L2C provisioning, in-life modification/cease and T2R trouble resolution between communication providers (CP) and network operators or aggregators.

CPs are known as 'tenants' on the Fibre Cafe and communicate with the Fibre Cafe's Tenant API. The network operators and aggregators providing the underlying services are known as 'suppliers' and provide the Supplier API.

Each supplier is responsible for implementing this southbound API specification for the Fibre Cafe to retrieve available services and support appointing and order management.

Note: Order updates (KCIs) must be sent to the Supplier Updates API hosted by the Fibre Cafe. __

© 2022-2026 Strategic Imperatives

Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://api.provided_by_supplier.net

Service Availability

Retrieve what services (if any) the supplier has available for a given address.

This follows the concepts in TMF645 - Service Qualification API and TMF673 - Address Management API.

Operations

Quote Management

Create and manage a quote to provide service at requested sites. This follows the concepts in TMF648 - Quote Management API.

Operations

Appointment Management

Retrieve and reserve appointments for installing a service at a given address.

This follows the concepts in TMF646 - Appointment API.

Operations

Order Management

Create and manage an order to provide, cease or modify a service at a given address.

This follows the concepts in TMF641 - Service Ordering Management API.

Operations

Service Test Management

Handle a request to perform a service test on a given active line/service.

Operations

Service Problem Management

Create and manage a service problem for a given line/service.

Operations

Create a problem/incident for an active service owned by the communications provider (CP).

Request

This endpoint is called to raise a problem with the supplier to resolve a potential issue with a service.

The supplier should validate and accept the request if the validation is successful or otherwise reject it. If the request is rejected, a 422 code should be returned with reason(s) for the rejection in the response.

If the request is accepted, the supplier may return a 202 accepted response without acknowledging the service problem if further validation/processing is required. In this scenario, the supplier must then send an update (KCI) to later acknowledge the service problem and provide the problem reference.

Alternatively, the supplier can synchronously acknowledge the service problem by returning a 201 created response with the response containing the problem reference and status of ACKNOWLEDGED. The service problem can also be committed at this stage by returning the status of IN_PROGRESS.

Security
oauth2
Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Tenantstringrequired

The tenant that has placed the request on the Fibre Cafe

Example: TENANT1
Bodyapplication/json
idnumber>= 1required

Unique identifier for this service problem request (generated by the Fibre Cafe)

Example: 23467
problemTypestring(ServiceProblemType)^[A-Z_]{5,25}required

Codes representing the type of problem being encountered by the end user:

  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
  • CUSTOMER
  • CPE
Example: "STABILITY"
problemTextstring[ 10 .. 80 ] charactersrequired

The description of problem being raised as defined by the end user.

Example: "The service keeps dropping between 6pm and 9pm every evening."
serviceIdstring[ 1 .. 50 ] charactersrequired

Identifier of an existing live service

Example: "SI2345432345345"
serviceSpecificationobject(ServiceSpecification)required

Details of a service the supplier provides at the selected address.

serviceSpecification.​idstring[ 1 .. 50 ] charactersrequired

Unique identifier for this service specification (if available)

Example: "ftthl2r"
addressobject(AddressIdentifier)

Address identifier for location including type of identifier.

serviceTestIdnumber>= 1

Unique identifier for a current service test performed prior to raising the service problem (generated by the Fibre Cafe)

Example: 23467
serviceTestReferencestring^[A-Z0-9_]{5,25}

The unique supplier reference of a service test that has been performed against the service prior to raising the service problem.

Example: "TEST_233827673"
characteristicsArray of objects(ServiceProblemCharacteristic)non-emptyrequired

List of characteristics providing context on the problem

characteristics[].​namestring[ 1 .. 50 ] charactersrequired

Name of the characteristic

characteristics[].​valuestring[ 1 .. 50 ] charactersrequired

Value for this characteristic

primaryContactobject(Contact)required

Represents a contact available at the given site/address.

primaryContact.​namestring[ 1 .. 100 ] charactersrequired

Contact name

Example: "John Smith"
primaryContact.​emailstring^\S{1,64}@\S{2,254}$

Contact email address (if available)

Example: "john@smith.com"
primaryContact.​phoneNumberstring^\+?[\d\s\-#]{8,50}$required

Contact phone number

Example: "01234 567890"
secondaryContactobject(Contact)

Represents a contact available at the given site/address.

appointmentReservationIdnumber>= 1

Unique identifier for the reserved appointment (if applicable)

Example: 345
appointmentReservationReferencestring[ 1 .. 50 ] characters

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

Example: "A234X"
parentServiceProblemIdnumber>= 1

Unique reference for an issue that is believed to be related, for example a multiline network outage

Example: 12345
parentServiceProblemReferencestring^[A-Z0-9_]{1,25}

Unique reference identifying the parent problem - supplier reference (if applicable)

Example: "SI_RE23380000"
hazardsstring[ 1 .. 1000 ] characters

Hazard information about the site where the service will be restored

Example: "Hazardous materials stored on site"
onSiteRestrictionsstring[ 1 .. 1000 ] characters

Information about restrictions on the site where the service will be restored

Example: "Restricted access"
notesstring[ 1 .. 1000 ] charactersrequired

Notes about the problem which are required by the supplier.

Example: "Lorem ipsum dolor sit amet..."
curl -i -X POST \
  https://api.provided_by_supplier.net/service-problems \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Tenant: TENANT1' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string' \
  -d '{
    "id": 23467,
    "problemType": "STABILITY",
    "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
    "serviceId": "SI2345432345345",
    "serviceSpecification": {
      "id": "ftthl2r"
    },
    "address": {
      "id": "200004033694",
      "type": "UPRN"
    },
    "serviceTestId": 23467,
    "serviceTestReference": "TEST_233827673",
    "characteristics": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "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",
    "parentServiceProblemId": 12345,
    "parentServiceProblemReference": "SI_RE23380000",
    "hazards": "Hazardous materials stored on site",
    "onSiteRestrictions": "Restricted access",
    "notes": "Lorem ipsum dolor sit amet..."
  }'

Responses

Service problem was acknowledged - response should contain the problem reference and appropriate status

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
statusstring(ServiceProblemStatus)required

Service problem lifecycle adapted from TMF656 - update events (KCIs) will be sent from the supplier as the service problem transitions from one state to the other.

Enum"REJECTED""ACKNOWLEDGED""IN_PROGRESS""HELD""NETWORK_INCIDENT""PENDING_AMENDMENT""PENDING_CANCELLATION""CANCELLED""RESOLVED""COMPLETED"
Example: "ACKNOWLEDGED"
supplierReferencestring[ 1 .. 50 ] characters

Unique reference identifying this service problem (where applicable)

Example: "A123X"
idnumber>= 1required

Unique identifier for this service problem request (generated by the Fibre Cafe)

Example: 23467
problemTypestring(ServiceProblemType)^[A-Z_]{5,25}required

Codes representing the type of problem being encountered by the end user:

  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
  • CUSTOMER
  • CPE
Example: "STABILITY"
problemTextstring[ 10 .. 80 ] charactersrequired

The description of problem being raised as defined by the end user.

Example: "The service keeps dropping between 6pm and 9pm every evening."
serviceIdstring[ 1 .. 50 ] charactersrequired

Identifier of an existing live service

Example: "SI2345432345345"
serviceSpecificationobject(ServiceSpecification)required

Details of a service the supplier provides at the selected address.

serviceSpecification.​idstring[ 1 .. 50 ] charactersrequired

Unique identifier for this service specification (if available)

Example: "ftthl2r"
serviceSpecification.​namestring[ 1 .. 50 ] charactersread-only

Name of the service

Example: "FTTH"
addressobject(AddressIdentifier)

Address identifier for location including type of identifier.

serviceTestIdnumber>= 1

Unique identifier for a current service test performed prior to raising the service problem (generated by the Fibre Cafe)

Example: 23467
serviceTestReferencestring^[A-Z0-9_]{5,25}

The unique supplier reference of a service test that has been performed against the service prior to raising the service problem.

Example: "TEST_233827673"
characteristicsArray of objects(ServiceProblemCharacteristic)non-emptyrequired

List of characteristics providing context on the problem

characteristics[].​namestring[ 1 .. 50 ] charactersrequired

Name of the characteristic

characteristics[].​valuestring[ 1 .. 50 ] charactersrequired

Value for this characteristic

primaryContactobject(Contact)required

Represents a contact available at the given site/address.

primaryContact.​namestring[ 1 .. 100 ] charactersrequired

Contact name

Example: "John Smith"
primaryContact.​emailstring^\S{1,64}@\S{2,254}$

Contact email address (if available)

Example: "john@smith.com"
primaryContact.​phoneNumberstring^\+?[\d\s\-#]{8,50}$required

Contact phone number

Example: "01234 567890"
secondaryContactobject(Contact)

Represents a contact available at the given site/address.

appointmentReservationIdnumber>= 1

Unique identifier for the reserved appointment (if applicable)

Example: 345
appointmentReservationReferencestring[ 1 .. 50 ] characters

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

Example: "A234X"
parentServiceProblemIdnumber>= 1

Unique reference for an issue that is believed to be related, for example a multiline network outage

Example: 12345
parentServiceProblemReferencestring^[A-Z0-9_]{1,25}

Unique reference identifying the parent problem - supplier reference (if applicable)

Example: "SI_RE23380000"
hazardsstring[ 1 .. 1000 ] characters

Hazard information about the site where the service will be restored

Example: "Hazardous materials stored on site"
onSiteRestrictionsstring[ 1 .. 1000 ] characters

Information about restrictions on the site where the service will be restored

Example: "Restricted access"
notesstring[ 1 .. 1000 ] charactersrequired

Notes about the problem which are required by the supplier.

Example: "Lorem ipsum dolor sit amet..."
Response
application/json
{
  "status": "ACKNOWLEDGED",
  "supplierReference": "A123X",
  "id": 23467,
  "problemType": "STABILITY",
  "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
  "serviceId": "SI2345432345345",
  "serviceSpecification": {
    "id": "ftthl2r",
    "name": "FTTH"
  },
  "address": {
    "id": "200004033694",
    "type": "UPRN"
  },
  "serviceTestId": 23467,
  "serviceTestReference": "TEST_233827673",
  "characteristics": [
    { … }
  ],
  "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",
  "parentServiceProblemId": 12345,
  "parentServiceProblemReference": "SI_RE23380000",
  "hazards": "Hazardous materials stored on site",
  "onSiteRestrictions": "Restricted access",
  "notes": "Lorem ipsum dolor sit amet..."
}

Request to amend an inflight service problem.

Request

This endpoint is called to request amendment of an existing inflight service problem on an active service.

A request will contain 1 or more fields to be amended - only fields supplied should be changed.

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 amendment if further validation/processing is required. In this scenario, the supplier must then send an update (KCI) to later confirm the amendment was applied or if rejected.

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

Security
oauth2
Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Tenantstringrequired

The tenant that has placed the request on the Fibre Cafe

Example: TENANT1
Bodyapplication/json
idnumber>= 1required

Unique identifier for this service problem amendment request (generated by the Fibre Cafe)

Example: 23467
supplierReferencestring^[A-Z0-9_]{5,25}

Unique reference identifying this service problem amendment - generated by the supplier

Example: "SI_RE233827673"
serviceProblemIdnumber>= 1required

Unique reference identifying the service problem to be amended

Example: 12356
supplierServiceProblemReferencestring^[A-Z0-9_]{5,25}

Unique reference generated by the supplier for the service problem

Example: "SK_PRO233827673"
problemTextstring[ 10 .. 80 ] characters

The description of problem being raised as defined by the end user.

Example: "The service keeps dropping between 6pm and 9pm every evening."
escalationRequestboolean

Request to escalate the problem based on agreed SLA's.

Example: true
characteristicsArray of objects(Characteristic)non-empty

List of characteristics providing context on the problem

primaryContactobject(Contact)

Represents a contact available at the given site/address.

secondaryContactobject(Contact)

Represents a contact available at the given site/address.

appointmentReservationIdnumber>= 1

Unique identifier for the reserved appointment (if applicable)

Example: 345
appointmentReservationReferencestring[ 1 .. 50 ] characters

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

Example: "A234X"
hazardsstring[ 1 .. 1000 ] characters

Hazard information about the site where the service will be restored

Example: "Hazardous materials stored on site"
onSiteRestrictionsstring[ 1 .. 1000 ] characters

Information about restrictions on the site where the service will be restored

Example: "Restricted access"
notesstring[ 1 .. 1000 ] characters

Notes about the problem which are required by the supplier. This includes additional information that may be required

Example: "Lorem ipsum dolor sit amet..."
curl -i -X POST \
  https://api.provided_by_supplier.net/service-problem-amendments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Tenant: TENANT1' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string' \
  -d '{
    "id": 23467,
    "supplierReference": "SI_RE233827673",
    "serviceProblemId": 12356,
    "supplierServiceProblemReference": "SK_PRO233827673",
    "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
    "escalationRequest": true,
    "characteristics": [
      {
        "name": "END_USER_CPE",
        "value": "Zyzel DX3301"
      }
    ],
    "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",
    "hazards": "Hazardous materials stored on site",
    "onSiteRestrictions": "Restricted access",
    "notes": "Lorem ipsum dolor sit amet..."
  }'

Responses

Amendment request was successful and the service problem has been updated

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
idnumber>= 1required

Unique identifier for this service problem amendment request (generated by the Fibre Cafe)

Example: 23467
supplierReferencestring^[A-Z0-9_]{5,25}

Unique reference identifying this service problem amendment - generated by the supplier

Example: "SI_RE233827673"
serviceProblemIdnumber>= 1required

Unique reference identifying the service problem to be amended

Example: 12356
supplierServiceProblemReferencestring^[A-Z0-9_]{5,25}

Unique reference generated by the supplier for the service problem

Example: "SK_PRO233827673"
problemTextstring[ 10 .. 80 ] characters

The description of problem being raised as defined by the end user.

Example: "The service keeps dropping between 6pm and 9pm every evening."
escalationRequestboolean

Request to escalate the problem based on agreed SLA's.

Example: true
characteristicsArray of objects(Characteristic)non-empty

List of characteristics providing context on the problem

primaryContactobject(Contact)

Represents a contact available at the given site/address.

secondaryContactobject(Contact)

Represents a contact available at the given site/address.

appointmentReservationIdnumber>= 1

Unique identifier for the reserved appointment (if applicable)

Example: 345
appointmentReservationReferencestring[ 1 .. 50 ] characters

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

Example: "A234X"
hazardsstring[ 1 .. 1000 ] characters

Hazard information about the site where the service will be restored

Example: "Hazardous materials stored on site"
onSiteRestrictionsstring[ 1 .. 1000 ] characters

Information about restrictions on the site where the service will be restored

Example: "Restricted access"
notesstring[ 1 .. 1000 ] characters

Notes about the problem which are required by the supplier. This includes additional information that may be required

Example: "Lorem ipsum dolor sit amet..."
Response
application/json
{
  "id": 23467,
  "supplierReference": "SI_RE233827673",
  "serviceProblemId": 12356,
  "supplierServiceProblemReference": "SK_PRO233827673",
  "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
  "escalationRequest": true,
  "characteristics": [
    { … }
  ],
  "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",
  "hazards": "Hazardous materials stored on site",
  "onSiteRestrictions": "Restricted access",
  "notes": "Lorem ipsum dolor sit amet..."
}

Request to cancel an inflight service problem.

Request

This endpoint is called to request cancellation of an existing inflight service problem on an active service.

The supplier should validate the cancellation 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 update (KCI) to later confirm the cancellation was completed or if rejected.

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

Security
oauth2
Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Tenantstringrequired

The tenant that has placed the request on the Fibre Cafe

Example: TENANT1
Bodyapplication/json
idnumber>= 1required

Unique reference identifying this service problem cancellation request (generated by the Fibre Cafe)

Example: 123365
serviceProblemIdnumber>= 1required

Unique reference identifying the service problem to be cancelled

Example: 12356
supplierServiceProblemReferencestring^[A-Z0-9_]{5,25}required

Unique reference generated by the supplier for the service problem

Example: "SK_PRO233827673"
reasonCodestring(ServiceProblemCancellationReasonCode)^[A-Z_]{5,50}required

Codes representing reason for cancellation of the service problem:

  • ISSUE_RESOLVED
  • CUSTOMER_NETWORK_ISSUE
  • NO_LONGER_REQUIRED
  • OTHER
Example: "CUSTOMER_NETWORK_ISSUE"
textstring[ 1 .. 1000 ] characters

Textual reason for cancellation - provides more context as applicable

Example: "Issue appears to have rectified itself."
curl -i -X POST \
  https://api.provided_by_supplier.net/service-problem-cancellations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Tenant: TENANT1' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string' \
  -d '{
    "id": 123365,
    "serviceProblemId": 12356,
    "supplierServiceProblemReference": "SK_PRO233827673",
    "reasonCode": "CUSTOMER_NETWORK_ISSUE",
    "text": "Issue appears to have rectified itself."
  }'

Responses

Order cancellation request was successful and the order has been cancelled.

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
idnumber>= 1required

Unique reference identifying this service problem cancellation request (generated by the Fibre Cafe)

Example: 123365
supplierReferencestring^[A-Z0-9_]{5,25}read-only

Unique reference identifying this service problem cancellation request as generated by the supplier

Example: "SI_RE233827673"
serviceProblemIdnumber>= 1required

Unique reference identifying the service problem to be cancelled

Example: 12356
supplierServiceProblemReferencestring^[A-Z0-9_]{5,25}required

Unique reference generated by the supplier for the service problem

Example: "SK_PRO233827673"
reasonCodestring(ServiceProblemCancellationReasonCode)^[A-Z_]{5,50}required

Codes representing reason for cancellation of the service problem:

  • ISSUE_RESOLVED
  • CUSTOMER_NETWORK_ISSUE
  • NO_LONGER_REQUIRED
  • OTHER
Example: "CUSTOMER_NETWORK_ISSUE"
textstring[ 1 .. 1000 ] characters

Textual reason for cancellation - provides more context as applicable

Example: "Issue appears to have rectified itself."
Response
application/json
{
  "id": 123365,
  "supplierReference": "SI_RE233827673",
  "serviceProblemId": 12356,
  "supplierServiceProblemReference": "SK_PRO233827673",
  "reasonCode": "CUSTOMER_NETWORK_ISSUE",
  "text": "Issue appears to have rectified itself."
}

Request to accept or reject resolution of an inflight service problem.

Request

This endpoint is called to signify acceptance or rejection of a supplier's resolution to an inflight service problem.

Where the tenant is satisfied with the resolution, the status of the resolution will be set to ACCEPTED and the service problem can be closed with the status set to COMPLETED.

Alternatively, the status will be REJECTED if the tenant is not satisfied and they should provide a reason in the tenantNotes field. The status problem will be re-opened with the status set back to IN_PROGRESS.

Security
oauth2
Path
idstringrequired

Service problem resolution identifier

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Tenantstringrequired

The tenant that has placed the request on the Fibre Cafe

Example: TENANT1
Bodyapplication/json
statusstring(ServiceProblemResolutionStatus)required

State model for service problem resolution.

Enum"REJECTED""ACCEPTED"
Example: "REJECTED"
tenantNotesstring[ 1 .. 1000 ] characters

Text from the tenant giving notes or reason for rejection - as applicable

Example: "Issue still persists"
curl -i -X PATCH \
  'https://api.provided_by_supplier.net/service-problem-resolutions/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Tenant: TENANT1' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string' \
  -d '{
    "status": "REJECTED",
    "tenantNotes": "Issue still persists"
  }'

Responses

Service problem resolution has been updated successfully

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
supplierReferencestring[ 1 .. 50 ] charactersrequired

Unique reference identifying this service problem resolution (as provided by supplier)

Example: "1234"
statusstring(ServiceProblemResolutionStatus)required

State model for service problem resolution.

Enum"REJECTED""ACCEPTED"
Example: "REJECTED"
resolvedDatestring(date-time)required

Date/time the problem was resolved by the supplier

Example: "2022-01-10T09:00:00.000Z"
closedDatestring(date-time)

Date/time the problem was closed by the tenant or supplier

Example: "2022-01-10T09:00:00.000Z"
resolutionDetailsobject(ResolutionDetails)required

Details of resolution to a service problem request.

resolutionDetails.​resolutionCodestring(ResolutionCode)^[\w_]{5,25}required

A code published on the developer portal to uniquely identify the problem resolution.

Enum"ACCESS_ISSUE""BACKHAUL_CORE_NETWORK""CUSTOMER_FAULT""CUSTOMER_FAULT_B_END""CUSTOMER_FAULT_EQUIPMENT""CUSTOMER_FAULT_MODEM""CUSTOMER_FAULT_WIRING""EXTERNAL_REIN""INTERNAL_REIN""LINE_TEST_NORMAL"
Example: "NETWORK_ISSUE"
resolutionDetails.​resolutionTextstring<= 256 characters

Detailed text regarding the problem resolution

resolutionDetails.​supplierCodesArray of strings

Code(s) provided by the supplier regarding the resolution

Example: ["R9"]
resolutionDetails.​faultCodeArray of stringsnon-empty

Code(s) regarding the problem fault

Example: ["DAMAGED_ONT"]
slaViolationArray of stringsnon-empty

Indicates if the resolution has violated the agreed SLAs

Example: ["EXCEEDED_SLA_TIME_TO_REPAIR"]
tenantNotesstring[ 1 .. 1000 ] characters

Text from the tenant giving notes or reason for rejection - as applicable

Example: "The problem was not resolved"
Response
application/json
{
  "supplierReference": "1234",
  "status": "REJECTED",
  "resolvedDate": "2022-01-10T09:00:00.000Z",
  "closedDate": "2022-01-10T09:00:00.000Z",
  "resolutionDetails": {
    "resolutionCode": "NETWORK_ISSUE",
    "resolutionText": "string",
    "supplierCodes": [ … ],
    "faultCode": [ … ]
  },
  "slaViolation": [
    "EXCEEDED_SLA_TIME_TO_REPAIR"
  ],
  "tenantNotes": "The problem was not resolved"
}