# Return a quote for available services for a given address.

This endpoint can be called to generate a quote for advanced services, such as Ethernet.
The details of the individual supplier or list of suppliers must be specified in the request.

Endpoint: POST /quote
Version: 1.15
Security: oauth2

## Header parameters:

  - `X-Request-ID` (string, required)
    Unique identifier to link request and response events across the Fibre Cafe gateway

  - `X-Conversation-ID` (string, required)
    Identifier to track message journey across the Fibre Cafe gateway

## Request fields (application/json):

  - `id` (integer, required)
    A unique identifier of the quote (generated by the Fibre Cafe)

  - `externalIdentifier` (string)
    A unique identifier of the quote as provided by the tenant
    Example: "QUO-ETH-5001"

  - `sites` (array, required)

  - `sites.name` (string, required)
    The name of the site
    Example: "Strategic Imperative Offices"

  - `sites.postcode` (string, required)
    Postal code
    Example: "TW184LG"

  - `sites.role` (string, required)
    The role of the site in an Ethernet connection
    Enum: "A-END", "B-END", "MULTI-POINT"

  - `sites.address` (object, required)
    Address identifier for location including type of identifier.

  - `sites.address.id` (string, required)
    Address identifier of provided type e.g. UPRN
    Example: "200004033694"

  - `sites.address.type` (string, required)
    Type of addressId provided e.g. UPRN
    Example: "UPRN"

  - `sites.siteCharacteristics` (array)

  - `sites.siteCharacteristics.name` (string, required)
    Name of the object characteristic
    Example: "END_USER_CPE"

  - `sites.siteCharacteristics.value` (string, required)
    Value for this characteristic
    Example: "Zyzel DX3301"

  - `contractDetails` (object, required)
    A generic entity to capture the contract details of a product/service.

  - `contractDetails.contractLength` (object, required)
    A generic entity to capture the duration of a contract

  - `contractDetails.contractLength.value` (integer, required)
    The length of the contract
    Example: 36

  - `contractDetails.contractLength.unit` (string, required)
    The duration unit of the contract
    Enum: "MONTH", "YEAR"

  - `contractDetails.billingFrequency` (string, required)
    The frequency the product/service will be invoiced by the supplier
    Enum: "MONTHLY", "QUARTERLY", "ANNUALLY"

  - `contractDetails.priceAlteration` (string)
    A price override/promotion code available between the tenant and supplier

  - `service` (array, required)

  - `service.serviceSpecification` (object, required)
    Details of a service the supplier provides at the selected address.

  - `service.serviceSpecification.id` (string, required)
    Unique identifier for this service specification (if available)
    Example: "ftthl2r"

  - `service.serviceCharacteristic` (array, required)

## Response 201 fields (application/json):

  - `id` (string, required)
    Unique reference identifying this quote request - generated by the Fibre Cafe)
    Example: "3456cf7d-4471-42e4-a5be-c24ed58a7aa6"

  - `externalIdentifier` (string)
    A unique identifier of the quote as provided by the tenant
    Example: "QUO-ETH-5001"

## Response 400 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 401 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 422 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 500 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]


## Response 403 fields

## Response 503 fields