# Query Appointment Availability

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.

Endpoint: POST /queryAppointmentAvailability
Security: Certificate

## Request fields (application/xml):

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

  - `message.messageId` (string, required)
    A unique ID to identify the message
    Example: "b68b2cf4-475e-11e1-a92e-fb2ff6467c99"

  - `message.correlationId` (string, required)
    A Correlation ID, also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain
    Example: "bac72cfa-475e-11e1-a92e-fb2ff6467c99"

  - `message.sentAt` (string, required)
    The timestamp when the message has been sent
    Example: "2012-01-20T18:30:43Z"

  - `buyer` (object, required)
    The Service Provider who consumes the service is the buyer

  - `buyer.buyerIdentifier` (string, required)
    Unique identifier of the buyer
    Example: "SPDEV1"

  - `buyer.cfh:resellerId` (string)
    Unique identifier of the reseller. Sourced from the Ofcom Reseller Identification List
    Example: "BAQ"

  - `seller` (object, required)
    The Active Network Operator who provides the service is the seller

  - `seller.sellerIdentifier` (string, required)
    Unique identifier of the seller
    Example: "CITYFIBRE"

  - `addressKey` (string, required)
    Unique identifier of the address (UPRN)

  - `appointmentsFrom` (string, required)
    Appointments in the future from this date
    Example: "2017-10-18"

  - `appointmentType` (any, required)

  - `cfh:productName` (string, required)
    Name of the Product
    Example: "ftthl2r"

  - `cfh:reappointment` (string)
    Indicates whether the appointment is reappointing a previous appointment
    Example: "true"

  - `cfh:projectReference` (string)
    Example: "CST1234567"

## Response 400 fields (application/xml):

  - `fault` (object, required)

  - `fault.faultcode` (string, required)
    Code related to the fault

  - `fault.faultmessage` (string, required)
    Name of the fault

  - `fault.detail` (string)
    Details about the fault

## Response 401 fields (application/xml):

  - `fault` (object, required)

  - `fault.faultcode` (string, required)
    Code related to the fault

  - `fault.faultmessage` (string, required)
    Name of the fault

  - `fault.detail` (string)
    Details about the fault

## Response 403 fields (application/xml):

  - `fault` (object, required)

  - `fault.faultcode` (string, required)
    Code related to the fault

  - `fault.faultmessage` (string, required)
    Name of the fault

  - `fault.detail` (string)
    Details about the fault