Quotes

>>>

POST https://partner.enterprisetelecom.com/api/quote
Request a quote for an address

Also see The list of available services.

Supported Formats

json

Examples

### Example Parameters ###
{
  "service_id": "1", # The id of the service you'd like to request. See the services API for the list of available services
  "phone": "360-647-1680", # Phone number in the format 000-000-0000
  "location": {   # The location where the service is to be deployed
    "line_1": "1313 E Maple Street",
    "line_2": "Suite #642",
    "city": "Bellingham",
    "state": "",
    "postal_code": "",
    "country": ""
  },
  "contact": {  # Contact information for the location
    "name": "Tom",
    "phone": "360-647-1680",
    "email": "info@enterprisetelecom.com"
  }
}

### Example Request for single service ###

curl -X POST https://partner.enterprisetelecom.com/api/quote/services \
-H "Authorization: bebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w" \
-H "Content-Type: application/json" \
--data '{
  "service_id": "1",
  "phone": "360-647-1680",
  "location": {
    "line_1": "1313 E Maple Street",
    "line_2": "Suite #642",
    "city": "Bellingham",
    "state": "",
    "postal_code": "",
    "country": ""
  },
  "contact": {
    "name": "Tom",
    "phone": "360-647-1680",
    "email": "info@enterprisetelecom.com"
  }
}'


### Example Response for single service request###
{
  "quote_id": "eacae3dd-8ce6-4a19-9443-13b6177dd18f", # the identifier for the code
  "products": [
    {
      "service_id": "1",
      "description": "4G LTE Wireless - 1 GB", # Name of the service
      "bandwidth_up": 5120, # Bandwidth Downstream
      "bandwidth_down": 15360, # Bandwidth Upstream
      "price_includes_router": true, # false if router charge is extra
      "contract_period": 3, # Contract term in number of months
      "monthly_recurring_charge": 10.5, # Monthly charge
      "installation_charge": 0,
      "installation_rebate": 0,
      "network": "BroadSky", # Name of the network supplier
      "supplier": "Broad Sky Networks", # Name of the supplier
      "is_estimate": false,
      "details": [  # Additional details for the product. Some may also be an explanation of the values above.
        {
            "name": "Service Details",
            "value": "4G LTE Wireless - 1 GB",
            "description": ""
        },
        {
            "name": "Term",
            "value": "3 Year",
            "description": "This is the term of this contract, which is renewable upon completion.  Many service providers offer significant discounts for longer term commitments."
        },
        {
            "name": "Total",
            "value": "$79.95",
            "description": "This is the total amount of Monthly Recurring Charges, including LOOP and PORT fees. This price is good through the end of June, 2018."
        },
        .....
      ]
    },
  ]
}

### Example Request for multiple service ###
{
  "service_id": "1,2", # The id of the service you'd like to request. See the services API for the list of available services
  "phone": "360-647-1680", # Phone number in the format 000-000-0000
  "location": {   # The location where the service is to be deployed
    "line_1": "1313 E Maple Street",
    "line_2": "Suite #642",
    "city": "Bellingham",
    "state": "",
    "postal_code": "",
    "country": ""
  },
  "contact": {  # Contact information for the location
    "name": "Tom",
    "phone": "360-647-1680",
    "email": "info@enterprisetelecom.com"
  }
}
### Example Response for multiple service###
{
  "quote_id": "eacae3dd-8ce6-4a19-9443-13b6177dd18f", # the identifier for the code
  "products": [
    {
      "service_id": "1",
      "description": "4G LTE Wireless - 1 GB", # Name of the service
      "bandwidth_up": 5120, # Bandwidth Downstream
      "bandwidth_down": 15360, # Bandwidth Upstream
      "price_includes_router": true, # false if router charge is extra
      "contract_period": 3, # Contract term in number of months
      "monthly_recurring_charge": 10.5, # Monthly charge
      "installation_charge": 0,
      "installation_rebate": 0,
      "network": "BroadSky", # Name of the network supplier
      "supplier": "Broad Sky Networks", # Name of the supplier
      "is_estimate": false,
      "details": [  # Additional details for the product. Some may also be an explanation of the values above.
          {
              "name": "Service Details",
              "value": "4G LTE Wireless - 1 GB",
              "description": ""
          },
          {
              "name": "Term",
              "value": "3 Year",
              "description": "This is the term of this contract, which is renewable upon completion.  Many service providers offer significant discounts for longer term commitments."
          },
          {
              "name": "Total",
              "value": "$79.95",
              "description": "This is the total amount of Monthly Recurring Charges, including LOOP and PORT fees. This price is good through the end of June, 2018."
          },
        .....
      ],
    },

    {
      "service_id": "2",
      "description": "4G LTE Wireless - 1 GB", # Name of the service
      "bandwidth_up": 5120, # Bandwidth Downstream
      "bandwidth_down": 15360, # Bandwidth Upstream
      ......
    }
  ]
}

### Example Parameters with queue_request:true ###
{
  "queue_request": "true",
  "service_id": "1", # The id of the service you'd like to request. See the services API for the list of available services
  "phone": "360-647-1680", # Phone number in the format 000-000-0000
  "location": {   # The location where the service is to be deployed
    "line_1": "1313 E Maple Street",
    "line_2": "Suite #642",
    "city": "Bellingham",
    "state": "",
    "postal_code": "",
    "country": ""
  },
  "contact": {  # Contact information for the location
    "name": "Tom",
    "phone": "360-647-1680",
    "email": "info@enterprisetelecom.com"
  }
}

### Example Response ###
{
  "quote_id": "eacae3dd-8ce6-4a19-9443-13b6177dd18f", # Use the :quote_id to fetch the quote results via /quotes/:quote_id later.
}

Params

Param name Description
client_id

API Credential. *Required if Authorization header is not passed in.
api_key

API Credential. *Required if Authorization header is not passed in.
queue_request , nil allowed

To process the quote asynchronously. Use the :quote_id in the response to fetch the quote results via /quotes/:quote_id later.
service_id *required

The id of the service you'd like to request. Multiple service ids can be provided.
phone *required

Phone number in the format 000-000-0000
location *required

The location where the service is to be deployed
location[line_1] *required
location[line_2] , nil allowed
location[city] , nil allowed

Either City or Locality is required
location[locality] , nil allowed

Either City or Locality is required
location[state] *required
location[postal_code] *required
location[country] *required
contact *required

Contact Information for the location
contact[name] *required

The contact name for the business/location
contact[phone] *required

Phone number in format 000-000-0000
contact[email] *required

Email address for the contact

Errors

Code Description
401 Unauthorized
422 Bad Request

Headers

Header name Description
Authorization
required 		Auth header in the format ${client_id}:${api_key}
E.g. bebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w
>>>

GET https://partner.enterprisetelecom.com/api/quote/:quote_id
Retrieve results for a previously requested quote

Examples

### Example Request ###
curl -X GET https://partner.enterprisetelecom.com/api/quote/d071cd43-436f-4f41-a5ad-274f58296e04 \
-H "Authorization: bebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w"

OR

curl -X GET https://partner.enterprisetelecom.com/api/quote/d071cd43-436f-4f41-a5ad-274f58296e04?client_id=1999ba30-7f53-4e01-a784-2440df76e958&api_key=SFh2AT_jlxtRzOtTa8CZ6w

### Example Response ###
# Returns 204 status code if it's not complete.

{
  "quote_id": "d071cd43-436f-4f41-a5ad-274f58296e04", # the identifier for the quote
  "products": [
    {
      "service_id": "1"
      "description": "4G LTE Wireless - 1 GB", # Name of the service
      "bandwidth_up": 5120, # Bandwidth Downstream
      "bandwidth_down": 15360, # Bandwidth Upstream
      "price_includes_router": true, # false if router charge is extra
      "contract_period": 3, # Contract term in number of months
      "monthly_recurring_charge": 10.5, # Monthly charge
      "installation_charge": 0,
      "installation_rebate": 0,
      "network": "BroadSky", # Name of the network supplier
      "supplier": "Broad Sky Networks", # Name of the supplier
      "is_estimate": false,
      "details": [  # Additional details for the product. Some may also be an explanation of the values above.
        {
            "name": "Service Details",
            "value": "4G LTE Wireless - 1 GB",
            "description": ""
        },
        {
            "name": "Term",
            "value": "3 Year",
            "description": "This is the term of this contract, which is renewable upon completion.  Many service providers offer significant discounts for longer term commitments."
        },
        {
            "name": "Total",
            "value": "$79.95",
            "description": "This is the total amount of Monthly Recurring Charges, including LOOP and PORT fees. This price is good through the end of June, 2018."
        },
        .....
      ]
    },
  ]
}

Params

Param name Description
client_id

API Credential. *Required if Authorization header is not passed in.
api_key

API Credential. *Required if Authorization header is not passed in.

Headers

Header name Description
Authorization
required 		Auth header in the format ${client_id}:${api_key}
E.g. bebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w