# 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.17
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):

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

  - `quoteItems` (array, required)

  - `quoteItems.id` (integer, required)
    A unique identifier of the quote item within the overall quote entity

  - `quoteItems.supplier` (string, required)
    System identifier for a supplier on the Fibre Cafe
    Example: "SUPPLIER2"

  - `quoteItems.sites` (array, required)

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

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

  - `quoteItems.sites.address.id` (string, required)
    Address identifier of given type
    Example: "A00000031882"

  - `quoteItems.sites.address.type` (string, required)
    Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
    Example: "NAD"

  - `quoteItems.sites.address.additionalIdentifiers` (array)
    Additional address identifiers where available/required for subsequent operations

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

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

  - `quoteItems.sites.siteCharacteristics` (array)

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

  - `quoteItems.sites.siteCharacteristics.value` (string, required)
    Value for this characteristic
    Example: "1G1G"

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

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

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

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

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

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

  - `quoteItems.service` (array, required)

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

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

  - `quoteItems.service.serviceCharacteristic` (array, required)

## Response 201 fields (application/json):

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

  - `created` (string, required)
    Date/time when the quote was created
    Example: "2022-01-01T09:09:33.001Z"

  - `externalId` (string, required)
    A unique identifier of the quote item within the overall quote entity, as provided by the tenant
    Example: "QUO-ETH-5001"

  - `quoteItems` (array, required)

## 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: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_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: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_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: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_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: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_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