{"docs":{"name":"Enterprise Telecom Api","info":"\n\u003cp\u003eEnterprise Telecom Quote API docs\u003c/p\u003e\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"https://partner.enterprisetelecom.com","resources":{"quotes":{"doc_url":"/api/docs/1.0/quotes","id":"quotes","api_url":"https://partner.enterprisetelecom.com","name":"Quotes","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/quotes/create","name":"create","apis":[{"api_url":"https://partner.enterprisetelecom.com/api/quote","http_method":"POST","short_description":"Request a quote for an address","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Bad Request","metadata":null}],"params":[{"name":"client_id","full_name":"client_id","description":"\n\u003cp\u003eAPI Credential. *Required if Authorization header is not passed in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"api_key","full_name":"api_key","description":"\n\u003cp\u003eAPI Credential. *Required if Authorization header is not passed in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"queue_request","full_name":"queue_request","description":"\n\u003cp\u003eTo process the quote asynchronously. Use the :quote_id in the response to fetch the quote results via /quotes/:quote_id later.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_id","full_name":"service_id","description":"\n\u003cp\u003eThe id of the service you\u0026#39;d like to request. Multiple service ids can be provided.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone","full_name":"phone","description":"\n\u003cp\u003ePhone number in the format 000-000-0000\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"\n\u003cp\u003eThe location where the service is to be deployed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"line_1","full_name":"location[line_1]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"line_2","full_name":"location[line_2]","description":"","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"location[city]","description":"\n\u003cp\u003eEither City or Locality is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locality","full_name":"location[locality]","description":"\n\u003cp\u003eEither City or Locality is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state","full_name":"location[state]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"postal_code","full_name":"location[postal_code]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country","full_name":"location[country]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"contact","full_name":"contact","description":"\n\u003cp\u003eContact Information for the location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"contact[name]","description":"\n\u003cp\u003eThe contact name for the business/location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone","full_name":"contact[phone]","description":"\n\u003cp\u003ePhone number in format 000-000-0000\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"contact[email]","description":"\n\u003cp\u003eEmail address for the contact\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["\n### Example Parameters ###\n{\n  \"service_id\": \"1\", # The id of the service you'd like to request. See the services API for the list of available services\n  \"phone\": \"360-647-1680\", # Phone number in the format 000-000-0000\n  \"location\": {   # The location where the service is to be deployed\n    \"line_1\": \"1313 E Maple Street\",\n    \"line_2\": \"Suite #642\",\n    \"city\": \"Bellingham\",\n    \"state\": \"\",\n    \"postal_code\": \"\",\n    \"country\": \"\"\n  },\n  \"contact\": {  # Contact information for the location\n    \"name\": \"Tom\",\n    \"phone\": \"360-647-1680\",\n    \"email\": \"info@enterprisetelecom.com\"\n  }\n}\n\n### Example Request for single service ###\n\ncurl -X POST https://partner.enterprisetelecom.com/api/quote/services \\\n-H \"Authorization: bebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w\" \\\n-H \"Content-Type: application/json\" \\\n--data '{\n  \"service_id\": \"1\",\n  \"phone\": \"360-647-1680\",\n  \"location\": {\n    \"line_1\": \"1313 E Maple Street\",\n    \"line_2\": \"Suite #642\",\n    \"city\": \"Bellingham\",\n    \"state\": \"\",\n    \"postal_code\": \"\",\n    \"country\": \"\"\n  },\n  \"contact\": {\n    \"name\": \"Tom\",\n    \"phone\": \"360-647-1680\",\n    \"email\": \"info@enterprisetelecom.com\"\n  }\n}'\n\n\n### Example Response for single service request###\n{\n  \"quote_id\": \"eacae3dd-8ce6-4a19-9443-13b6177dd18f\", # the identifier for the code\n  \"products\": [\n    {\n      \"service_id\": \"1\",\n      \"description\": \"4G LTE Wireless - 1 GB\", # Name of the service\n      \"bandwidth_up\": 5120, # Bandwidth Downstream\n      \"bandwidth_down\": 15360, # Bandwidth Upstream\n      \"price_includes_router\": true, # false if router charge is extra\n      \"contract_period\": 3, # Contract term in number of months\n      \"monthly_recurring_charge\": 10.5, # Monthly charge\n      \"installation_charge\": 0,\n      \"installation_rebate\": 0,\n      \"network\": \"BroadSky\", # Name of the network supplier\n      \"supplier\": \"Broad Sky Networks\", # Name of the supplier\n      \"is_estimate\": false,\n      \"details\": [  # Additional details for the product. Some may also be an explanation of the values above.\n        {\n            \"name\": \"Service Details\",\n            \"value\": \"4G LTE Wireless - 1 GB\",\n            \"description\": \"\"\n        },\n        {\n            \"name\": \"Term\",\n            \"value\": \"3 Year\",\n            \"description\": \"This is the term of this contract, which is renewable upon completion.  Many service providers offer significant discounts for longer term commitments.\"\n        },\n        {\n            \"name\": \"Total\",\n            \"value\": \"$79.95\",\n            \"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.\"\n        },\n        .....\n      ]\n    },\n  ]\n}\n","### Example Request for multiple service ###\n{\n  \"service_id\": \"1,2\", # The id of the service you'd like to request. See the services API for the list of available services\n  \"phone\": \"360-647-1680\", # Phone number in the format 000-000-0000\n  \"location\": {   # The location where the service is to be deployed\n    \"line_1\": \"1313 E Maple Street\",\n    \"line_2\": \"Suite #642\",\n    \"city\": \"Bellingham\",\n    \"state\": \"\",\n    \"postal_code\": \"\",\n    \"country\": \"\"\n  },\n  \"contact\": {  # Contact information for the location\n    \"name\": \"Tom\",\n    \"phone\": \"360-647-1680\",\n    \"email\": \"info@enterprisetelecom.com\"\n  }\n}\n### Example Response for multiple service###\n{\n  \"quote_id\": \"eacae3dd-8ce6-4a19-9443-13b6177dd18f\", # the identifier for the code\n  \"products\": [\n    {\n      \"service_id\": \"1\",\n      \"description\": \"4G LTE Wireless - 1 GB\", # Name of the service\n      \"bandwidth_up\": 5120, # Bandwidth Downstream\n      \"bandwidth_down\": 15360, # Bandwidth Upstream\n      \"price_includes_router\": true, # false if router charge is extra\n      \"contract_period\": 3, # Contract term in number of months\n      \"monthly_recurring_charge\": 10.5, # Monthly charge\n      \"installation_charge\": 0,\n      \"installation_rebate\": 0,\n      \"network\": \"BroadSky\", # Name of the network supplier\n      \"supplier\": \"Broad Sky Networks\", # Name of the supplier\n      \"is_estimate\": false,\n      \"details\": [  # Additional details for the product. Some may also be an explanation of the values above.\n          {\n              \"name\": \"Service Details\",\n              \"value\": \"4G LTE Wireless - 1 GB\",\n              \"description\": \"\"\n          },\n          {\n              \"name\": \"Term\",\n              \"value\": \"3 Year\",\n              \"description\": \"This is the term of this contract, which is renewable upon completion.  Many service providers offer significant discounts for longer term commitments.\"\n          },\n          {\n              \"name\": \"Total\",\n              \"value\": \"$79.95\",\n              \"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.\"\n          },\n        .....\n      ],\n    },\n\n    {\n      \"service_id\": \"2\",\n      \"description\": \"4G LTE Wireless - 1 GB\", # Name of the service\n      \"bandwidth_up\": 5120, # Bandwidth Downstream\n      \"bandwidth_down\": 15360, # Bandwidth Upstream\n      ......\n    }\n  ]\n}\n","### Example Parameters with queue_request:true ###\n{\n  \"queue_request\": \"true\",\n  \"service_id\": \"1\", # The id of the service you'd like to request. See the services API for the list of available services\n  \"phone\": \"360-647-1680\", # Phone number in the format 000-000-0000\n  \"location\": {   # The location where the service is to be deployed\n    \"line_1\": \"1313 E Maple Street\",\n    \"line_2\": \"Suite #642\",\n    \"city\": \"Bellingham\",\n    \"state\": \"\",\n    \"postal_code\": \"\",\n    \"country\": \"\"\n  },\n  \"contact\": {  # Contact information for the location\n    \"name\": \"Tom\",\n    \"phone\": \"360-647-1680\",\n    \"email\": \"info@enterprisetelecom.com\"\n  }\n}\n\n### Example Response ###\n{\n  \"quote_id\": \"eacae3dd-8ce6-4a19-9443-13b6177dd18f\", # Use the :quote_id to fetch the quote results via /quotes/:quote_id later.\n}\n"],"metadata":null,"see":[{"link":"/api/docs/1.0/services/index","description":"The list of available services"}],"headers":[{"name":"Authorization","description":"Auth header in the format \u003cb\u003e${client_id}:${api_key}\u003c/b\u003e\u003cbr /\u003eE.g. \u003cb\u003ebebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w\u003c/b\u003e","options":{"required":true}}],"show":true},{"doc_url":"/api/docs/1.0/quotes/show","name":"show","apis":[{"api_url":"https://partner.enterprisetelecom.com/api/quote/:quote_id","http_method":"GET","short_description":"Retrieve results for a previously requested quote","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"client_id","full_name":"client_id","description":"\n\u003cp\u003eAPI Credential. *Required if Authorization header is not passed in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"api_key","full_name":"api_key","description":"\n\u003cp\u003eAPI Credential. *Required if Authorization header is not passed in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["### Example Request ###\ncurl -X GET https://partner.enterprisetelecom.com/api/quote/d071cd43-436f-4f41-a5ad-274f58296e04 \\\n-H \"Authorization: bebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w\"\n\nOR\n\ncurl -X GET https://partner.enterprisetelecom.com/api/quote/d071cd43-436f-4f41-a5ad-274f58296e04?client_id=1999ba30-7f53-4e01-a784-2440df76e958\u0026api_key=SFh2AT_jlxtRzOtTa8CZ6w\n\n### Example Response ###\n# Returns 204 status code if it's not complete.\n\n{\n  \"quote_id\": \"d071cd43-436f-4f41-a5ad-274f58296e04\", # the identifier for the quote\n  \"products\": [\n    {\n      \"service_id\": \"1\"\n      \"description\": \"4G LTE Wireless - 1 GB\", # Name of the service\n      \"bandwidth_up\": 5120, # Bandwidth Downstream\n      \"bandwidth_down\": 15360, # Bandwidth Upstream\n      \"price_includes_router\": true, # false if router charge is extra\n      \"contract_period\": 3, # Contract term in number of months\n      \"monthly_recurring_charge\": 10.5, # Monthly charge\n      \"installation_charge\": 0,\n      \"installation_rebate\": 0,\n      \"network\": \"BroadSky\", # Name of the network supplier\n      \"supplier\": \"Broad Sky Networks\", # Name of the supplier\n      \"is_estimate\": false,\n      \"details\": [  # Additional details for the product. Some may also be an explanation of the values above.\n        {\n            \"name\": \"Service Details\",\n            \"value\": \"4G LTE Wireless - 1 GB\",\n            \"description\": \"\"\n        },\n        {\n            \"name\": \"Term\",\n            \"value\": \"3 Year\",\n            \"description\": \"This is the term of this contract, which is renewable upon completion.  Many service providers offer significant discounts for longer term commitments.\"\n        },\n        {\n            \"name\": \"Total\",\n            \"value\": \"$79.95\",\n            \"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.\"\n        },\n        .....\n      ]\n    },\n  ]\n}\n"],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Auth header in the format \u003cb\u003e${client_id}:${api_key}\u003c/b\u003e\u003cbr /\u003eE.g. \u003cb\u003ebebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w\u003c/b\u003e","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"services":{"doc_url":"/api/docs/1.0/services","id":"services","api_url":"https://partner.enterprisetelecom.com","name":"Services","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/services/index","name":"index","apis":[{"api_url":"https://partner.enterprisetelecom.com/api/quote/services","http_method":"POST","short_description":"Request list of available services","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"client_id","full_name":"client_id","description":"\n\u003cp\u003eAPI Credential. *Required if Authorization header is not passed in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"api_key","full_name":"api_key","description":"\n\u003cp\u003eAPI Credential. *Required if Authorization header is not passed in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be String.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["### Example Request ###\ncurl -X POST https://partner.enterprisetelecom.com/api/quote/services \\\n-H \"Authorization: bebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w\"\n\nOR\n\ncurl -X POST https://partner.enterprisetelecom.com/api/quote/services \\\n-H \"Content-Type: application/json\" \\\n--data '{ \"client_id\": \"bebd6b78-20d4-452f-a60a-d95ed57b20da\", \"api_key\": \"SFh2AT_jlxtRzOtTa8CZ6w\"}'\n\n### Example Response ###\n{\n   \"services\": [\n    {\n        \"id\": \"10\", # the id to use for the quotes request\n        \"title\": \"Satellite\",\n        \"description\": \"Satellite High-Speed Internet\",\n        \"phone_required\": false\n    },\n    {\n        \"id\": \"9\",\n        \"title\": \"Ethernet (Copper)\",\n        \"description\": \"Ethernet (Copper)\",\n        \"phone_required\": true\n    },\n    ....\n}\n"],"metadata":null,"see":[],"headers":[{"name":"Authorization","description":"Auth header in the format \u003cb\u003e${client_id}:${api_key}\u003c/b\u003e\u003cbr /\u003eE.g. \u003cb\u003ebebd6b78-20d4-452f-a60a-d95ed57b20da:SFh2AT_jlxtRzOtTa8CZ6w\u003c/b\u003e","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null}}}}