Reserve Appointment

Request

In order to reserve an appointment, the buyer should provide the UPRN, product and the appointment slot that they desire to the seller

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

appointmentSlotobject(appointmentSlot)required

Represents the appointment slot details. Simple orders always carry the single-day appointmentDate, appointmentStartTime and appointmentEndTime. Complex installation orders (orderSurvey/orderExternal/orderInternal) additionally carry cfh:startDateTime/cfh:endDateTime; for these the single-day triple is present only when the slot starts and ends on the same day and is omitted for multi-day slots (possible for orderExternal).

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

This is the product name

Example:"ftthl2r"

cfh:addressKeystring, <= 254 charactersrequired

The address key (UPRN)

Example:"123456789012"

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"

<reserveAppointmentRequest 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>
  <appointmentSlot>
    <appointmentDate>2012-01-20</appointmentDate>
    <appointmentStartTime>08:00</appointmentStartTime>
    <appointmentEndTime>13:00</appointmentEndTime>
  </appointmentSlot>
  <appointmentType>
    <order/>
  </appointmentType>
  <cfh:productName>ftthl2r</cfh:productName>
  <cfh:addressKey>123456789012</cfh:addressKey>
  <cfh:ispMigration>false</cfh:ispMigration>
  <cfh:reappointment>false</cfh:reappointment>
</reserveAppointmentRequest>

Responses

Reserve Appointment Response