Appointments

The buyer can query appointment availability, reserve an appointment and include the reservation key in the order request. If this is not done, the order will go into a waiting state and not progress, the buyer will need to reserve an appointment and then amend the order to include the appointment reservation key before the order can complete.

Operations

Query Appointment Availability

Request

To check the availability for an appointment on a given location, timeframe, and product.

The buyer should send a request containing a UPRN.

The seller is then going to respond with detailed information about available appointment slots.

Security

Certificate

Bodyapplication/xml

messageobject(message)required

The meta-data of the request. It includes information regarding the message UUID, transaction ID and the sent timestamp

buyerobject(buyer)required

The Service Provider who consumes the service is the buyer

sellerobject(seller)required

the Active Network Operator who provides the service is the seller

addressKeystring, <= 63 characters(addressKey)required

Unique identifier of the address (UPRN)

Example:200004753569

appointmentsFromstring, (date), <= 10 charactersrequired

Appointments in the future from this date

Example:"2017-10-18"

appointmentTypeOrder (object) or Fault (object) or Order Survey (object) or Order External (object) or Order Internal (object)(appointmentType)required

One of:

Identifies the type of appointment being queried, reserved or amended. Complex installation orders progress through the survey, build-to-wall and standard-install appointment types in turn.

cfh:productNamestring, <= 254 charactersrequired

Name of the Product

Example:"ftthl2r"

cfh:ispMigrationstring

Flag for ISP Migration

Example:"true"

cfh:reappointmentstring

Indicates whether the appointment is reappointing a previous appointment

Example:"true"

cfh:projectReferencestring, <= 80 characters

Example:"CST1234567"

<queryAppointmentAvailabilityRequest xmlns="http://www.niccstandards.org.uk/ala_1.0.xsd" xmlns:cfh="http://www.cityfibre.com/ala/ext1">
  <message>
    <messageId>b68b2cf4-475e-11e1-a92e-fb2ff6467c99</messageId>
    <correlationId>bac72cfa-475e-11e1-a92e-fb2ff6467c99</correlationId>
    <sentAt>2012-01-20T18:30:43Z</sentAt>
  </message>
  <buyer>
    <buyerIdentifier>SPDEV1</buyerIdentifier>
  </buyer>
  <seller>
    <sellerIdentifier>CITYFIBRE</sellerIdentifier>
  </seller>
  <addressKey>10002491172</addressKey>
  <appointmentsFrom>2017-10-18</appointmentsFrom>
  <appointmentType>
    <order/>
  </appointmentType>
  <cfh:productName>ftthl2r</cfh:productName>
  <cfh:ispMigration>false</cfh:ispMigration>
  <cfh:reappointment>false</cfh:reappointment>
</queryAppointmentAvailabilityRequest>

Responses

Appointment Availability Response