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.
Fibre Cafe : Supplier API (1.15)
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
Languages
Servers
https://api.provided_by_supplier.net
Request
This endpoint is called to find what appointments a supplier has available to install service(s) at a given address.
An address query parameter will be supplied specifying address ID and type along with the required serviceSpecification(s) as returned by the /service-availability endpoint.
All parameters are mandatory and will always be supplied by the Fibre Cafe.
Security
oauth2
Query
Address identifier of provided type e.g. UPRN to check for appointment availability
Example: address={"id":"200004033694","type":"UPRN"}
The service to be installed during this appointment
Example: serviceSpecification={"id":"ftthl2r"}
Find appointment slots from this date
Example: appointmentFromDate=2022-01-05
Find appointment slots only of these classification types (comma delimited list)
Items Enum"WEEKDAY""WEEKDAY_AM""WEEKDAY_PM""WEEKDAY_EARLY""WEEKDAY_EVENING""SATURDAY""SATURDAY_AM""SATURDAY_PM""SATURDAY_EARLY""SATURDAY_EVENING"
Example: classifications=WEEKDAY_AM,WEEKDAY_PM
- https://api.provided_by_supplier.net/available-appointments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.provided_by_supplier.net/available-appointments?address={%22id%22%3A%22200004033694%22%2C%22type%22%3A%22UPRN%22}&serviceSpecification={%22id%22%3A%22ftthl2r%22}&appointmentFromDate=2022-01-05&classifications=WEEKDAY_AM%2CWEEKDAY_PM&appointmentPurpose=PROVIDE' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Tenant: TENANT1' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string'Request successful - zero or more available appointments were returned
Unique identifier to identify request and response events across the Fibre Cafe gateway
Details of a service the supplier provides at the selected address.
List of available appointment timeslots
Start date/time for this timeslot
Example: "2022-01-10T09:00:00.000Z"
End date/time for this timeslot
Example: "2022-01-10T13:00:00.000Z"
Timeslot classification
Enum"WEEKDAY""WEEKDAY_AM""WEEKDAY_PM""WEEKDAY_EARLY""WEEKDAY_EVENING""SATURDAY""SATURDAY_AM""SATURDAY_PM""SATURDAY_EARLY""SATURDAY_EVENING"
Example: "SATURDAY_AM"
Response
application/json
{ "address": { "id": "200004033694", "type": "UPRN" }, "serviceSpecification": { "id": "ftthl2r", "name": "FTTH" }, "availableTimeslots": [ { … } ] }
Request
This endpoint is called to reserve an appointment with a supplier to install service(s) at a given address.
This endpoint will be supplied a previously returned available appointment slot to be reserved according to the supplier reservation policy. Where the reservation has a TTL (time to live) before being released, the expiry time should be returned.
The returned appointment ID will be sent as part of the order at which point it should be considered confirmed.
Security
oauth2
Address identifier for location including type of identifier.
Details of a service the supplier provides at the selected address.
Purpose of the appointment : PROVIDE, REPAIR, MODIFY
Example: "PROVIDE"
Represents an appointment timeslot with a supplier.
- https://api.provided_by_supplier.net/appointments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.provided_by_supplier.net/appointments \
-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": 234,
"address": {
"id": "200004033694",
"type": "UPRN"
},
"serviceSpecification": {
"id": "ftthl2r"
},
"purpose": "PROVIDE",
"timeslot": {
"timeslotStartDateTime": "2022-01-10T09:00:00.000Z",
"timeslotEndDateTime": "2022-01-10T13:00:00.000Z"
}
}'Operation successful - appointment was reserved. Returned ID will be used when placing order
Unique identifier to identify request and response events across the Fibre Cafe gateway
Unique reference generated by the supplier for this appointment
Example: "A234"
Where an appointment is reserved, this contains the date/time when the reservation will expire.
Example: "2022-01-01T13:45:00.000Z"
Address identifier for location including type of identifier.
Details of a service the supplier provides at the selected address.
Purpose of the appointment : PROVIDE, REPAIR, MODIFY
Example: "PROVIDE"
Represents an appointment timeslot with a supplier.
Start date/time for this timeslot
Example: "2022-01-10T09:00:00.000Z"
End date/time for this timeslot
Example: "2022-01-10T13:00:00.000Z"
Timeslot classification
Enum"WEEKDAY""WEEKDAY_AM""WEEKDAY_PM""WEEKDAY_EARLY""WEEKDAY_EVENING""SATURDAY""SATURDAY_AM""SATURDAY_PM""SATURDAY_EARLY""SATURDAY_EVENING"
Example: "SATURDAY_AM"
Response
application/json
{ "supplierReference": "A234", "expiryDateTime": "2022-01-01T13:45:00.000Z", "id": 234, "address": { "id": "200004033694", "type": "UPRN" }, "serviceSpecification": { "id": "ftthl2r", "name": "FTTH" }, "purpose": "PROVIDE", "timeslot": { "timeslotStartDateTime": "2022-01-10T09:00:00.000Z", "timeslotEndDateTime": "2022-01-10T13:00:00.000Z", "classification": "SATURDAY_AM", "standard": true } }