### Example Request for single service ###
{
"client_id": "16c90482-a554-4c11-9af3-730cc3f48056", # Provided to you for authorization
"api_key": "SFh2AT_jlxtRzOtTa8CZ6w", # Corresponding key to the client_id for authorization
"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 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 ###
{
"client_id": "16c90482-a554-4c11-9af3-730cc3f48056", # Provided to you for authorization
"api_key": "SFh2AT_jlxtRzOtTa8CZ6w", # Corresponding key to the client_id for authorization
"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 Request with queue request true###
{
"client_id": "16c90482-a554-4c11-9af3-730cc3f48056", # Provided to you for authorization
"api_key": "SFh2AT_jlxtRzOtTa8CZ6w", # Corresponding key to the client_id for authorization
"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.
}
| Param name | Description |
|---|---|
| client_id *required |
Provided to you for authorization |
| 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. |
| api_key *required |
Corresponding key to the :client_id for authorization |
| 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 |
| Code | Description |
|---|---|
| 401 | Unauthorized |
| 422 | Bad Request |
### Example Request ###
quote_id: 'd071cd43-436f-4f41-a5ad-274f58296e04'
client_id: 'bebd6b78-20d4-452f-a60a-d95ed57b20da'
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 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."
},
.....
]
},
]
}