Get Availability Requests
After an availability request is created, the data is gathered asynchronously from all sources that match the provided address and filters. The current state of the availability requests can be viewed as follows.
{
"data": [
{
"id": "63e3b06f9d021699ad0c0442",
"address": {
"id": "63e3b06f9d021699ad0c0443",
"street": "Lijnbaansgracht",
"city": "Amsterdam",
"continent_code": "EU",
"country_code": "NL",
"postal_code": "1016XA",
"house_number": "206",
"house_number_addition": "H",
"coordinates": {
"latitude": 52.36800976742718,
"longitude": 4.8791514526625805
},
"_document_type": "address"
},
"created_at": "2023-02-08T14:23:43+00:00",
"updated_at": "2023-02-08T14:23:46+00:00",
"filters": {
"contract_terms": [],
"connection_types": [],
"bandwidths": [],
"technology_types": [],
"networks": []
},
"networks_progress_percentage": "60.87",
"_document_type": "availability_request"
}
{
"id": "63e2815851345f22c50856d3",
"address": {
"id": "63e2815851345f22c50856d4",
"street": "Northumberland Avenue",
"city": "London",
"continent_code": "EU",
"country_code": "GB",
"postal_code": "WC2N 5BW",
"house_number": "1",
"house_number_addition": "",
"coordinates": {
"latitude": 51.5071847,
"longitude": -0.1272394
},
"_document_type": "address"
},
"created_at": "2023-02-07T16:50:32+00:00",
"updated_at": "2023-02-07T16:50:35+00:00",
"filters": {
"contract_terms": [],
"connection_types": [],
"bandwidths": [],
"technology_types": [],
"networks": []
},
"networks_progress_percentage": "100.00",
"_document_type": "availability_request"
}
],
"sse_jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NzU4NzE2NDMuMzk2MjczLCJtZXJjdXJlIjp7InB1Ymxpc2giOltdLCJzdWJzY3JpYmUiOlsiNjM3NjA2MTE3MmY1ZTdiYmJiMGExZWQyL2F2YWlsYWJpbGl0eV9yZXF1ZXN0Il19fQ.YRA5ebo8ihOZRvWuZ3NGxlV3OE1jShwPB1UONWIgU4o",
"pagination": {
"page_size": 1,
"current_page": 1,
"total_items": 2,
"total_pages": 1
}
}Results are paginated. Pagination details can be found at the bottom.
Accessing the second-page for example can be done as follows.
GET /availability-requests?paginate[page]=2The Availability request has a status field. The possible values are 'pending', 'in_progress' and 'completed'. You can retrieve the status using the endpoint below.
GET /availability-requests/{id}/status{
"data": {
"id": "63e3b06f9d021699ad0c0442",
"created_by_user": {
"id": "6238a14e204753515646559a",
"first_name": "Firstname",
"last_name": "Lastname",
"_document_type": "user"
},
"status": "completed",
"_document_type": "availability_request"
}
}The id indicates the unique identifier of the availability request. This value can be used to retrieve an availability request with all its details.
GET /availability-requests/63e3b06f9d021699ad0c0442{
"data": {
"id": "63e3b06f9d021699ad0c0442",
"networks": [{
"id": "67c1ad21a4feb13cda0134f3",
"network": "Trunkstar Super Network",
"technology_type": "FIBER",
"connection_group": "DEDICATED",
"protection": "",
"products": [{
"id": "67c1ad2334011ba8930f8ad4",
"currency": "EUR",
"distance_class": "onnet",
"contract_term": 12,
"bandwidth_down": 2000,
"bandwidth_up": 2000,
"capacity_bearer": 100000,
"connection_type": "DIA",
"handover_interface": "",
"wired": true,
"pop_node_reference": "",
"sla": "",
"interconnect": null,
"reseller": {
"id": "6238a0ba2047535156265492",
"name": "Trunkstar",
"_document_type": "account"
},
"connectivity_product_id": "3d6e2524-7ca6-4c11-9586-11b73656e782",
"total_sales_mrc": 135.3,
"total_sales_nrc": 0,
"mandatory_products": [],
"budgetary": false,
"supplier_request": null,
"custom": false,
"vat_applied": false,
"included_subnet": null,
"cpe_included": null,
"notes_external": "",
"has_tbd_prices": false,
"record_history": {
"created_at": "2025-02-28T12:33:39+00:00",
"created_by_user_id": "6628c9c4fe1c3598260120a3",
"created_by_first_name": "Trunkstar",
"created_by_last_name": "System",
"updated_at": "2025-02-28T12:33:39+00:00",
"updated_by_user_id": "6628c9c4fe1c3598260120a3",
"updated_by_first_name": "Trunkstar",
"updated_by_last_name": "System"
},
"created_at": "2025-02-28T12:33:39+00:00",
"updated_at": "2025-02-28T12:33:39+00:00",
"created_by_user": null,
"commercial_uptime_percentage": null,
"commercial_mttr_minutes": null,
"commercial_support_days": [],
"commercial_cancellation_term_days": null,
"commercial_renewal_term_days": null,
"commercial_proactive_support": null,
"commercial_expected_delivery_time_days": null,
"commercial_installation_included": true,
"mrc": "135.30",
"nrc": "0.00",
"supplier": null,
"commercial_delivery_time": 0,
"purchase_delivery_time": 6,
"_document_type": "availability_request_product"
}],
"sort_rank": 1,
"logo_id": "655f2d55126d8a8d4a0024a2",
"record_history": {
"created_at": "2025-02-28T12:33:37+00:00",
"created_by_user_id": "6628c9c4fe1c3598260120a3",
"created_by_first_name": "Trunkstar",
"created_by_last_name": "System",
"updated_at": "2025-02-28T12:33:37+00:00",
"updated_by_user_id": "6628c9c4fe1c3598260120a3",
"updated_by_first_name": "Trunkstar",
"updated_by_last_name": "System"
},
"created_at": "2025-02-28T12:33:37+00:00",
"updated_at": "2025-02-28T12:33:37+00:00",
"created_by_user": null,
"distance_class": "onnet",
"progress_percentage": "100.00",
"completed": true,
"dark_fiber_geojson": [],
"distance_meters": 0,
"_document_type": "availability_request_network"
},
{
"id": "67c1ad21a4feb13cda0134f4",
"network": "Trunkstar Super Network",
"technology_type": "FTTH",
"connection_group": "SHARED",
"protection": "",
"products": [{
"id": "67c1ad2334011ba8930f8ade",
"currency": "EUR",
"distance_class": "onnet",
"contract_term": 12,
"bandwidth_down": 30000,
"bandwidth_up": 10000,
"capacity_bearer": 100000,
"connection_type": "SHARED",
"handover_interface": "",
"wired": true,
"pop_node_reference": "",
"sla": "",
"interconnect": null,
"reseller": {
"id": "6238a0ba2047535156265492",
"name": "Trunkstar",
"_document_type": "account"
},
"connectivity_product_id": "8bdeebfe-2a9a-4847-8dd6-0997f79d3ff6",
"total_sales_mrc": 220,
"total_sales_nrc": 220,
"mandatory_products": [],
"budgetary": false,
"supplier_request": null,
"custom": false,
"vat_applied": false,
"included_subnet": null,
"cpe_included": null,
"notes_external": "",
"has_tbd_prices": false,
"record_history": {
"created_at": "2025-02-28T12:33:39+00:00",
"created_by_user_id": "6628c9c4fe1c3598260120a3",
"created_by_first_name": "Trunkstar",
"created_by_last_name": "System",
"updated_at": "2025-02-28T12:33:39+00:00",
"updated_by_user_id": "6628c9c4fe1c3598260120a3",
"updated_by_first_name": "Trunkstar",
"updated_by_last_name": "System"
},
"created_at": "2025-02-28T12:33:39+00:00",
"updated_at": "2025-02-28T12:33:39+00:00",
"created_by_user": null,
"commercial_uptime_percentage": 100,
"commercial_mttr_minutes": 90,
"commercial_support_days": [{
"start_time": "09:00",
"end_time": "17:00",
"day_of_week": "Monday"
},
{
"start_time": "09:00",
"end_time": "17:00",
"day_of_week": "Tuesday"
},
{
"start_time": "09:00",
"end_time": "17:00",
"day_of_week": "Wednesday"
},
{
"start_time": "09:00",
"end_time": "17:00",
"day_of_week": "Thursday"
},
{
"start_time": "09:00",
"end_time": "17:00",
"day_of_week": "Friday"
}
],
"commercial_cancellation_term_days": 30,
"commercial_renewal_term_days": 30,
"commercial_proactive_support": null,
"commercial_expected_delivery_time_days": 30,
"commercial_installation_included": true,
"mrc": "220.00",
"nrc": "220.00",
"supplier": null,
"commercial_delivery_time": 5,
"purchase_delivery_time": 6,
"_document_type": "availability_request_product"
}],
"sort_rank": 2,
"logo_id": "655f2d55126d8a8d4a0024a2",
"record_history": {
"created_at": "2025-02-28T12:33:37+00:00",
"created_by_user_id": "6628c9c4fe1c3598260120a3",
"created_by_first_name": "Trunkstar",
"created_by_last_name": "System",
"updated_at": "2025-02-28T12:33:37+00:00",
"updated_by_user_id": "6628c9c4fe1c3598260120a3",
"updated_by_first_name": "Trunkstar",
"updated_by_last_name": "System"
},
"created_at": "2025-02-28T12:33:37+00:00",
"updated_at": "2025-02-28T12:33:37+00:00",
"created_by_user": null,
"distance_class": "onnet",
"progress_percentage": "100.00",
"completed": true,
"dark_fiber_geojson": [],
"distance_meters": 0,
"_document_type": "availability_request_network"
},
{
"id": "67c1ad21a4feb13cda0134f2",
"network": "Trunkstar Super Network",
"technology_type": "FTTB",
"connection_group": "SHARED",
"protection": "",
"products": [{
"id": "67c1ad2334011ba8930f8ad9",
"currency": "EUR",
"distance_class": "onnet",
"contract_term": 12,
"bandwidth_down": 30000,
"bandwidth_up": 10000,
"capacity_bearer": 100000,
"connection_type": "SHARED",
"handover_interface": "",
"wired": true,
"pop_node_reference": "",
"sla": "",
"interconnect": null,
"reseller": {
"id": "6238a0ba2047535156265492",
"name": "Trunkstar",
"_document_type": "account"
},
"connectivity_product_id": "287c9edc-8ed1-4451-9a44-942870ae908e",
"total_sales_mrc": 242,
"total_sales_nrc": 330,
"mandatory_products": [],
"budgetary": false,
"supplier_request": null,
"custom": false,
"vat_applied": false,
"included_subnet": null,
"cpe_included": null,
"notes_external": "",
"has_tbd_prices": false,
"record_history": {
"created_at": "2025-02-28T12:33:39+00:00",
"created_by_user_id": "6628c9c4fe1c3598260120a3",
"created_by_first_name": "Trunkstar",
"created_by_last_name": "System",
"updated_at": "2025-02-28T12:33:39+00:00",
"updated_by_user_id": "6628c9c4fe1c3598260120a3",
"updated_by_first_name": "Trunkstar",
"updated_by_last_name": "System"
},
"created_at": "2025-02-28T12:33:39+00:00",
"updated_at": "2025-02-28T12:33:39+00:00",
"created_by_user": null,
"commercial_uptime_percentage": null,
"commercial_mttr_minutes": null,
"commercial_support_days": [],
"commercial_cancellation_term_days": null,
"commercial_renewal_term_days": null,
"commercial_proactive_support": null,
"commercial_expected_delivery_time_days": null,
"commercial_installation_included": true,
"mrc": "242.00",
"nrc": "330.00",
"supplier": null,
"commercial_delivery_time": 0,
"purchase_delivery_time": 6,
"_document_type": "availability_request_product"
}],
"sort_rank": 5,
"logo_id": "655f2d55126d8a8d4a0024a2",
"record_history": {
"created_at": "2025-02-28T12:33:37+00:00",
"created_by_user_id": "6628c9c4fe1c3598260120a3",
"created_by_first_name": "Trunkstar",
"created_by_last_name": "System",
"updated_at": "2025-02-28T12:33:37+00:00",
"updated_by_user_id": "6628c9c4fe1c3598260120a3",
"updated_by_first_name": "Trunkstar",
"updated_by_last_name": "System"
},
"created_at": "2025-02-28T12:33:37+00:00",
"updated_at": "2025-02-28T12:33:37+00:00",
"created_by_user": null,
"distance_class": "onnet",
"progress_percentage": "100.00",
"completed": true,
"dark_fiber_geojson": [],
"distance_meters": 0,
"_document_type": "availability_request_network"
}
],
"id": "63e3b06f9d021699ad0c0443",
"street": "Lijnbaansgracht",
"city": "Amsterdam",
"continent_code": "EU",
"country_code": "NL",
"postal_code": "1016XA",
"house_number": "206",
"house_number_addition": "H",
"coordinates": {
"latitude": 52.36800976742718,
"longitude": 4.8791514526625805
},
"_document_type": "address"
},
"created_at": "2023-02-08T14:23:43+00:00",
"updated_at": "2023-02-08T14:23:46+00:00",
"filters": {
"contract_terms": [],
"connection_types": [],
"bandwidths": [],
"technology_types": [],
"networks": []
},
"networks_progress_percentage": "60.87",
"status": "in_progress",
"_document_type": "availability_request"
},
"sse_jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NzU4NzIyNzEuNjYxNjk5LCJtZXJjdXJlIjp7InB1Ymxpc2giOltdLCJzdWJzY3JpYmUiOlsiNjM3NjA2MTE3MmY1ZTdiYmJiMGExZWQyL2F2YWlsYWJpbGl0eV9yZXF1ZXN0LzYzZTNiMDZmOWQwMjE2OTlhZDBjMDQ0MiJdfX0._u560p3TNz-4IsED97wkLts6v9HjbBJfsm-TfmcnN_s"
}Last updated
Was this helpful?