CityFibre has implemented an automated process to accommodate the dispatch of Job Packs related to the installation of FTTH/P services. This requires the Partner to follow the same process in terms of the integration points, message types and message payloads relayed between each party. The implementation is based on JSON over RPC and has a common definition for inbound and outbound calls.

Standard Installation Flow

• CityFibre sends createJob for each job pack due. N.B. this can be at any point from when the Service Order was received to the day prior to installation.
• Installation Partner responds with providerJobId
• Installation Partner assigns the job to an engineer and sends notifyJob with Engineer Details
• On the day of installation
  • Installation Partner sends notifyJob when the engineer has indicated that they are en-route to the installation with coordinates/time
  • Installation Partner sends notifyJob when the engineer has indicated that they are onsite with coordinates/time
  • Installation Partner sends notifyJob when the Engineer scans QR Code on the ONT, with the ONT FSAN and Serial Number
  • CityFibre sends notifyJob when ONT is provisioned
  • After additional install steps/tests, Installer sends back closeJob with question based closure and appropriate close and secondary close code with description

The codes and descriptions below should be included on the closeJob notification when closureCode is either CON or POP. The secondary closure code provides additional detail as to the closure reason.

For further details please refer to separately provided Question Based Closure Matrix – which details the relationship between closure and secondary closure codes, question and answer definitions and question flow.

"questions_answers":
        [
            {
                "question": "Did Sponge Pass?",
                "question_code": "1100",
                "answer": "Yes",
                "response_received": "2018-01-02T09:32:33+00:00",
                "source": "notifyJob"            },

The question should match the text from the related question The question code should match the ID of the related question The answer should match the answer of the related question The source should match the point in the journey it was sent, either “notifyJob” or “closeJob”

"questions_answers": [
        {
            "question": "Time of first call Mandatory Photos of call log & Photos of door/house",
            "question_code": "4900",
            "answer": "07:56",
            "response_received": "2023-09-25T11:37:10.9362823+01:00",
            "source": "Closure",
            "files": [
                {
                    "name": "example.jpg",
                    "url": "",
                    "object_path": "s3://URLcode.enta.cloud/example.jpg"
                }
            ]
        },

Files can optionally be included with each structured response, defined in an array. Each file listed should include the following details:

• name
• type
• object_path
• url (optional) The object_path parameter should be the full S3 endpoint including the filename.

The url is an optional field which if included should be a url which can be used to retrieve the file using a standard http (GET) request. This may be a pre-signed URL generated from S3.
Note that the S3 bucket will be shared with the Installation Partner by CityFibre in advance.

Create Job

Cancel Job

Notify Job

Authentication is by means of HTTPS client certificate. It is also restricted to pre-agreed source IP addresses.

Cityfibre provides two fixed-address API endpoints for redundancy:

api-gw1.cityfibre.com 52.51.45.11 (IPv6: 2a05:d018:9a3:b500::100)

api-gw2.cityfibre.com 52.58.75.78 (IPv6: 2a05:d014:b31:f200::100)

Messages may be POSTed to either of these. For convenience there is also a round-robin DNS entry: api-gw.cityfibre.com (resolves to both addresses)

Required firewall configuration is as follows.

The CityFibre endpoint is: https://api-gw.cityfibre.com:41223/prod/ftth-installer