{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/calloutcome/subscriber/call-outcome": { "get": { "tags": [ "CallOutcome" ], "operationId": "getCalloutcomeSubscriberCallOutcome", "description": "The parameters and request body are for method: getCalloutcomeSubscriberCallOutcome. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "SubscriberId": { "type": "number" }, "DeviceId": { "type": "string" }, "CallType": { "type": "string" }, "Status": { "type": "string" }, "RootCause": { "type": "string" }, "SubRootCause": { "type": "string" }, "Notes": { "type": "string" } } } }, "example": [ { "SubscriberId": 12345, "DeviceId": "CLXN123", "CallType": "InBound", "Status": "Resolved", "RootCause": "Wi-Fi, Hardware", "SubRootCause": "Wi-Fi interference, Faulty Device", "Notes": "Free text input" }, { "SubscriberId": 12345, "DeviceId": "CLXN123", "CallType": "InBound", "Status": "Resolved", "RootCause": "Wi-Fi, Hardware", "SubRootCause": "Wi-Fi interference, Faulty Device", "Notes": "Free text input" } ] } } } }, "parameters": [ { "name": "subscriberLocationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "extref", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/calea/access-logs": { "get": { "tags": [ "AccessLogs" ], "operationId": "getCaleaAccessLogs", "description": "The parameters and request body are for method: getCaleaAccessLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "gatewayMACAddress": { "type": "string" }, "eventType": { "type": "string" }, "reasonCode": { "type": "string" }, "clientInfoVersion": { "type": "string" }, "serialNumber": { "type": "string" }, "classOfService": { "type": "string" }, "communityName": { "type": "string" }, "timestamp": { "type": "string" }, "subscriberId": { "type": "string" }, "radioFrequencyBand": { "type": "string" }, "clientName": { "type": "string" }, "clientType": { "type": "string" }, "clientOS": { "type": "string" }, "clientMACAddress": { "type": "string" }, "clientIPAddress": { "type": "string" }, "clientModel": { "type": "string" }, "clientVendor": { "type": "string" } } } }, "example": [ { "date": "20221018", "gatewayMACAddress": "b8:94:70:29:9b:ec", "eventType": "connect", "reasonCode": "3", "clientInfoVersion": "1", "serialNumber": "CXNK00FF9BB7", "classOfService": "15", "communityName": "temp", "timestamp": "1666123521562", "subscriberId": "6e4f5013-993a-4590-aab7-7afbdee5c215", "radioFrequencyBand": "5", "clientName": "iPhone", "clientType": "Smart Phone", "clientOS": "iOS", "clientMACAddress": "cc:08:8d:65:e8:71", "clientIPAddress": "172.29.11.149", "clientModel": "iPhone", "clientVendor": "Apple" } ] } } } }, "parameters": [ { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "clientMACAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/net-perf-test/cafIITest": { "get": { "tags": [ "NetPerfTest" ], "operationId": "getNetPerfTestCafIITest", "description": "The parameters and request body are for method: getNetPerfTestCafIITest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "timezone": { "type": "string" }, "primaryOoklaServerId": { "type": "string" }, "speedThreshold": { "type": "number" }, "latencyThreshold": { "type": "number" }, "serviceTierDownloadSpeed": { "type": "number" }, "serviceTierUploadSpeed": { "type": "number" }, "downloadUrl": { "type": "string" }, "uploadUrl": { "type": "string" }, "uploadFileSize": { "type": "number" }, "startDate": { "type": "string" }, "numberOfDays": { "type": "number" }, "startHour": { "type": "number" }, "numberOfHours": { "type": "number" }, "devices": { "type": "array", "items": { "type": "string" } } } } }, "example": [ { "name": "CA_10M/1M", "description": "2019 Q1 Northern California Gold Internet Subscribers", "timezone": "America/Chicago", "primaryOoklaServerId": "1234", "speedThreshold": 80, "latencyThreshold": 10, "serviceTierDownloadSpeed": 1000000, "serviceTierUploadSpeed": 1000000, "downloadUrl": "http://9.9.9.9/download/10M", "uploadUrl": "http://9.9.9.9/upload", "uploadFileSize": 1000000, "startDate": "2018-12-12", "numberOfDays": 7, "startHour": 18, "numberOfHours": 6, "devices": [ "CXNK00112233", "CXNK004E6DEF" ] }, { "name": "CA_10M/1M", "description": "2019 Q1 Northern California Gold Internet Subscribers", "timezone": "America/Chicago", "primaryOoklaServerId": "1234", "speedThreshold": 80, "latencyThreshold": 10, "serviceTierDownloadSpeed": 1000000, "serviceTierUploadSpeed": 1000000, "downloadUrl": "http://9.9.9.9/download/10M", "uploadUrl": "http://9.9.9.9/upload", "uploadFileSize": 1000000, "startDate": "2018-12-12", "numberOfDays": 7, "startHour": 18, "numberOfHours": 6, "devices": [ "CXNK00112233", "CXNK004E6DEF" ] } ] } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "NetPerfTest" ], "operationId": "postNetPerfTestCafIITest", "description": "The parameters and request body are for method: postNetPerfTestCafIITest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/net-perf-test/cafIITest/{id}": { "get": { "tags": [ "NetPerfTest" ], "operationId": "getNetPerfTestCafIITestId", "description": "The parameters and request body are for method: getNetPerfTestCafIITestId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "NetPerfTest" ], "operationId": "putNetPerfTestCafIITestId", "description": "The parameters and request body are for method: putNetPerfTestCafIITestId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "NetPerfTest" ], "operationId": "deleteNetPerfTestCafIITestId", "description": "The parameters and request body are for method: deleteNetPerfTestCafIITestId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/net-perf-test/cafIITest/{id}/suspend": { "put": { "tags": [ "NetPerfTest" ], "operationId": "putNetPerfTestCafIITestIdSuspend", "description": "The parameters and request body are for method: putNetPerfTestCafIITestIdSuspend. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/net-perf-test/cafIITest/{id}/resume": { "put": { "tags": [ "NetPerfTest" ], "operationId": "putNetPerfTestCafIITestIdResume", "description": "The parameters and request body are for method: putNetPerfTestCafIITestIdResume. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/net-perf-test/ooklaServer": { "get": { "tags": [ "NetPerfTest" ], "operationId": "getNetPerfTestOoklaServer", "description": "The parameters and request body are for method: getNetPerfTestOoklaServer. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "cityState": { "type": "string" }, "host": { "type": "string" }, "asn": { "type": "number" }, "fccDesignatedAsn": { "type": "boolean" } } } }, "example": [ { "_id": "13516", "cityState": "Orlando, FL", "host": "mco.speedtest.sbcglobal.net", "asn": 7108, "fccDesignatedAsn": true }, { "_id": "13516", "cityState": "Orlando, FL", "host": "mco.speedtest.sbcglobal.net", "asn": 7108, "fccDesignatedAsn": true }, { "_id": "13516", "cityState": "Orlando, FL", "host": "mco.speedtest.sbcglobal.net", "asn": 7108, "fccDesignatedAsn": true } ] } } } }, "parameters": [ { "name": "country", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/net-perf-test/testResult/zip/external": { "get": { "tags": [ "NetPerfTest" ], "operationId": "getNetPerfTestTestResultZipExternal", "description": "The parameters and request body are for method: getNetPerfTestTestResultZipExternal. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "testId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers": { "get": { "tags": [ "Subscriber" ], "operationId": "getBillingSubscribers", "description": "The parameters and request body are for method: getBillingSubscribers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "devices", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "account", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "phone", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "billingStatus", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "withDevices", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "withServices", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Subscriber" ], "operationId": "postBillingSubscribers", "description": "The parameters and request body are for method: postBillingSubscribers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/billing/subscribers/{subscriberId}": { "get": { "tags": [ "Subscriber" ], "operationId": "getBillingSubscribersSubscriberId", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "includeDeviceData", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeDecommissionedDevices", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Subscriber" ], "operationId": "putBillingSubscribersSubscriberId", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Subscriber" ], "operationId": "deleteBillingSubscribersSubscriberId", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/devices": { "get": { "tags": [ "SubscriberDevices" ], "operationId": "getBillingSubscribersSubscriberIdDevices", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdDevices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SubscriberDevices" ], "operationId": "putBillingSubscribersSubscriberIdDevices", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdDevices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "deviceList", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "SubscriberDevices" ], "operationId": "postBillingSubscribersSubscriberIdDevices", "description": "The parameters and request body are for method: postBillingSubscribersSubscriberIdDevices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/devices/{deviceId}": { "put": { "tags": [ "SubscriberDevices" ], "operationId": "putBillingSubscribersSubscriberIdDevicesDeviceId", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdDevicesDeviceId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "string" } }, { "name": "newDeviceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "SubscriberDevices" ], "operationId": "deleteBillingSubscribersSubscriberIdDevicesDeviceId", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberIdDevicesDeviceId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/fccIdentifiers": { "get": { "tags": [ "SubscriberFCCIdentifier" ], "operationId": "getBillingSubscribersSubscriberIdFccIdentifiers", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdFccIdentifiers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SubscriberFCCIdentifier" ], "operationId": "putBillingSubscribersSubscriberIdFccIdentifiers", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdFccIdentifiers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "post": { "tags": [ "SubscriberFCCIdentifier" ], "operationId": "postBillingSubscribersSubscriberIdFccIdentifiers", "description": "The parameters and request body are for method: postBillingSubscribersSubscriberIdFccIdentifiers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "SubscriberFCCIdentifier" ], "operationId": "deleteBillingSubscribersSubscriberIdFccIdentifiers", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberIdFccIdentifiers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/services": { "get": { "tags": [ "SubscriberServices" ], "operationId": "getBillingSubscribersSubscriberIdServices", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdServices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "summaryOnly", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SubscriberServices" ], "operationId": "putBillingSubscribersSubscriberIdServices", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdServices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "ignoreDuplicates", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } }, "post": { "tags": [ "SubscriberServices" ], "operationId": "postBillingSubscribersSubscriberIdServices", "description": "The parameters and request body are for method: postBillingSubscribersSubscriberIdServices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/billing/subscribers/{subscriberId}/services/{serviceId}": { "get": { "tags": [ "SubscriberServices" ], "operationId": "getBillingSubscribersSubscriberIdServicesServiceId", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdServicesServiceId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "serviceId", "in": "path", "required": true, "schema": { "title": "serviceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SubscriberServices" ], "operationId": "putBillingSubscribersSubscriberIdServicesServiceId", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdServicesServiceId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "serviceId", "in": "path", "required": true, "schema": { "title": "serviceId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "SubscriberServices" ], "operationId": "deleteBillingSubscribersSubscriberIdServicesServiceId", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberIdServicesServiceId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "serviceId", "in": "path", "required": true, "schema": { "title": "serviceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/services/status": { "get": { "tags": [ "SubscriberServices" ], "operationId": "getBillingSubscribersSubscriberIdServicesStatus", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdServicesStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/appServices": { "get": { "tags": [ "SubscriberAppServices" ], "operationId": "getBillingSubscribersSubscriberIdAppServices", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdAppServices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/appServices/{appServiceName}": { "get": { "tags": [ "SubscriberAppServices" ], "operationId": "getBillingSubscribersSubscriberIdAppServicesAppServiceName", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdAppServicesAppServiceName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "appServiceName", "in": "path", "required": true, "schema": { "title": "appServiceName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SubscriberAppServices" ], "operationId": "putBillingSubscribersSubscriberIdAppServicesAppServiceName", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdAppServicesAppServiceName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "appServiceName", "in": "path", "required": true, "schema": { "title": "appServiceName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/billing/subscribers/{subscriberId}/arlo-service": { "get": { "tags": [ "SubscriberArloServiceDeprecated" ], "operationId": "getBillingSubscribersSubscriberIdArloService", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdArloService. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SubscriberArloServiceDeprecated" ], "operationId": "putBillingSubscribersSubscriberIdArloService", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdArloService. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "post": { "tags": [ "SubscriberArloServiceDeprecated" ], "operationId": "postBillingSubscribersSubscriberIdArloService", "description": "The parameters and request body are for method: postBillingSubscribersSubscriberIdArloService. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "SubscriberArloServiceDeprecated" ], "operationId": "deleteBillingSubscribersSubscriberIdArloService", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberIdArloService. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/servify-contract": { "get": { "tags": [ "SubscriberServifyContractDeprecated" ], "operationId": "getBillingSubscribersSubscriberIdServifyContract", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdServifyContract. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "SubscriberServifyContractDeprecated" ], "operationId": "postBillingSubscribersSubscriberIdServifyContract", "description": "The parameters and request body are for method: postBillingSubscribersSubscriberIdServifyContract. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "SubscriberServifyContractDeprecated" ], "operationId": "deleteBillingSubscribersSubscriberIdServifyContract", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberIdServifyContract. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "reasonCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/managed-service/arlo": { "get": { "tags": [ "ManagedServiceArlo" ], "operationId": "getBillingSubscribersSubscriberIdManagedServiceArlo", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdManagedServiceArlo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ManagedServiceArlo" ], "operationId": "putBillingSubscribersSubscriberIdManagedServiceArlo", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdManagedServiceArlo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "post": { "tags": [ "ManagedServiceArlo" ], "operationId": "postBillingSubscribersSubscriberIdManagedServiceArlo", "description": "The parameters and request body are for method: postBillingSubscribersSubscriberIdManagedServiceArlo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "ManagedServiceArlo" ], "operationId": "deleteBillingSubscribersSubscriberIdManagedServiceArlo", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberIdManagedServiceArlo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/managed-service/servify": { "get": { "tags": [ "ManagedServiceServify" ], "operationId": "getBillingSubscribersSubscriberIdManagedServiceServify", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdManagedServiceServify. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ManagedServiceServify" ], "operationId": "putBillingSubscribersSubscriberIdManagedServiceServify", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdManagedServiceServify. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "planCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "ManagedServiceServify" ], "operationId": "postBillingSubscribersSubscriberIdManagedServiceServify", "description": "The parameters and request body are for method: postBillingSubscribersSubscriberIdManagedServiceServify. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "ManagedServiceServify" ], "operationId": "deleteBillingSubscribersSubscriberIdManagedServiceServify", "description": "The parameters and request body are for method: deleteBillingSubscribersSubscriberIdManagedServiceServify. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } }, { "name": "reasonCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/subscribers/{subscriberId}/smarttown-wifi/subscriber": { "get": { "tags": [ "SubscriberSmartTownWiFi" ], "operationId": "getBillingSubscribersSubscriberIdSmarttownWifiSubscriber", "description": "The parameters and request body are for method: getBillingSubscribersSubscriberIdSmarttownWifiSubscriber. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SubscriberSmartTownWiFi" ], "operationId": "putBillingSubscribersSubscriberIdSmarttownWifiSubscriber", "description": "The parameters and request body are for method: putBillingSubscribersSubscriberIdSmarttownWifiSubscriber. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriberId", "in": "path", "required": true, "schema": { "title": "subscriberId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/billing/serviceDefinitions": { "get": { "tags": [ "ServiceDefinitions" ], "operationId": "getBillingServiceDefinitions", "description": "The parameters and request body are for method: getBillingServiceDefinitions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ServiceDefinitions" ], "operationId": "putBillingServiceDefinitions", "description": "The parameters and request body are for method: putBillingServiceDefinitions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } }, "post": { "tags": [ "ServiceDefinitions" ], "operationId": "postBillingServiceDefinitions", "description": "The parameters and request body are for method: postBillingServiceDefinitions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/billing/serviceDefinitions/{serviceDefinitionId}": { "get": { "tags": [ "ServiceDefinitions" ], "operationId": "getBillingServiceDefinitionsServiceDefinitionId", "description": "The parameters and request body are for method: getBillingServiceDefinitionsServiceDefinitionId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serviceDefinitionId", "in": "path", "required": true, "schema": { "title": "serviceDefinitionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ServiceDefinitions" ], "operationId": "putBillingServiceDefinitionsServiceDefinitionId", "description": "The parameters and request body are for method: putBillingServiceDefinitionsServiceDefinitionId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serviceDefinitionId", "in": "path", "required": true, "schema": { "title": "serviceDefinitionId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "ServiceDefinitions" ], "operationId": "deleteBillingServiceDefinitionsServiceDefinitionId", "description": "The parameters and request body are for method: deleteBillingServiceDefinitionsServiceDefinitionId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serviceDefinitionId", "in": "path", "required": true, "schema": { "title": "serviceDefinitionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/support/operator/ssid": { "get": { "tags": [ "SSID" ], "operationId": "getBillingSupportOperatorSsid", "description": "The parameters and request body are for method: getBillingSupportOperatorSsid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "Enable": { "type": "boolean" }, "SSID": { "type": "string" }, "SSIDAdvertisementEnabled": { "type": "boolean" }, "BeaconType": { "type": "string" }, "BasicEncryptionModes": { "type": "string" }, "BasicAuthenticationMode": { "type": "string" }, "WPAEncryptionModes": { "type": "string" }, "IEEE11iEncryptionModes": { "type": "string" }, "IEEE11iAuthenticationMode": { "type": "string" }, "KeyPassphrase": { "type": "string" }, "freqBand": { "type": "string" }, "PRConfig": { "type": "object", "properties": { "Enable": { "type": "boolean" }, "SSID": { "type": "string" }, "SSIDAdvertisementEnabled": { "type": "boolean" }, "BeaconType": { "type": "string" }, "BasicEncryptionModes": { "type": "string" }, "BasicAuthenticationMode": { "type": "string" }, "WPAEncryptionModes": { "type": "string" }, "IEEE11iEncryptionModes": { "type": "string" }, "IEEE11iAuthenticationMode": { "type": "string" }, "KeyPassphrase": { "type": "string" } } }, "isInL2Bridge": { "type": "boolean" } } } }, "example": [ { "id": "SSID1", "Enable": true, "SSID": "2.4G Primary", "SSIDAdvertisementEnabled": true, "BeaconType": "WPAand11i", "BasicEncryptionModes": "None", "BasicAuthenticationMode": "None", "WPAEncryptionModes": "AESEncryption", "IEEE11iEncryptionModes": "AESEncryption", "IEEE11iAuthenticationMode": "PSKAuthentication", "KeyPassphrase": "ATCadb#?!?_", "freqBand": "2.4GHz", "PRConfig": { "Enable": true, "SSID": "2.4G Primary", "SSIDAdvertisementEnabled": true, "BeaconType": "WPAand11i", "BasicEncryptionModes": "None", "BasicAuthenticationMode": "None", "WPAEncryptionModes": "AESEncryption", "IEEE11iEncryptionModes": "AESEncryption", "IEEE11iAuthenticationMode": "PSKAuthentication", "KeyPassphrase": "ATCadb#?!?_" }, "isInL2Bridge": false } ] } } } }, "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SSID" ], "operationId": "putBillingSupportOperatorSsid", "description": "The parameters and request body are for method: putBillingSupportOperatorSsid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "result": { "type": "string" } } } }, "example": [ { "result": "OK" }, { "result": "OK" }, { "result": "OK" }, { "result": "OK" } ] } } } }, "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/billing/support/operator/secondarynetwork/availability": { "get": { "tags": [ "SSID" ], "operationId": "getBillingSupportOperatorSecondarynetworkAvailability", "description": "The parameters and request body are for method: getBillingSupportOperatorSecondarynetworkAvailability. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/billing/support/operator/secondarynetwork": { "get": { "tags": [ "SSID" ], "operationId": "getBillingSupportOperatorSecondarynetwork", "description": "The parameters and request body are for method: getBillingSupportOperatorSecondarynetwork. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string" }, "eventName": { "type": "string" }, "isIndefinite": { "type": "boolean" }, "duration": { "type": "object", "properties": { "startTime": { "type": "number" }, "endTime": { "type": "number" } } }, "ssid": { "type": "string" }, "encryptionType": { "type": "number" }, "type": { "type": "number" }, "isolated": { "type": "boolean" }, "smartQos": { "type": "boolean" }, "band24": { "type": "boolean" }, "band5": { "type": "boolean" }, "band6": { "type": "boolean" }, "impaired": { "type": "boolean" } } } }, "example": [ { "eventId": "60abf177-fd67-4227-9b53-f2e3a80b5e58", "eventName": "CU_WiFi4", "isIndefinite": true, "duration": { "startTime": 0, "endTime": 0 }, "ssid": "CU_WiFi4", "encryptionType": 5, "type": 1, "isolated": true, "smartQos": false, "band24": true, "band5": true, "band6": false, "impaired": false }, { "eventId": "60abf177-fd67-4227-9b53-f2e3a80b5e58", "eventName": "CU_WiFi4", "isIndefinite": true, "duration": { "startTime": 0, "endTime": 0 }, "ssid": "CU_WiFi4", "encryptionType": 5, "type": 1, "isolated": true, "smartQos": false, "band24": true, "band5": true, "band6": false, "impaired": false } ] } } } }, "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SSID" ], "operationId": "putBillingSupportOperatorSecondarynetwork", "description": "The parameters and request body are for method: putBillingSupportOperatorSecondarynetwork. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "post": { "tags": [ "SSID" ], "operationId": "postBillingSupportOperatorSecondarynetwork", "description": "The parameters and request body are for method: postBillingSupportOperatorSecondarynetwork. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "SSID" ], "operationId": "deleteBillingSupportOperatorSecondarynetwork", "description": "The parameters and request body are for method: deleteBillingSupportOperatorSecondarynetwork. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "subscriberId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/billing/e2e/serviceDefinitions": { "get": { "tags": [ "E2EServiceDefinitionTemplate" ], "operationId": "searchServiceDefinitions", "description": "The parameters and request body are for method: searchServiceDefinitions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "tierName": { "type": "string" }, "serviceTemplateName": { "type": "string" }, "tagAction": { "type": "string" }, "napNodeId": { "type": "string" }, "ouiMatchListName": { "type": "string" }, "description": { "type": "string" }, "multicastVlanName": { "type": "string" }, "multicastRangeName": { "type": "string" } } } }, "example": [ { "name": "string", "tierName": "string", "serviceTemplateName": "string", "tagAction": "string", "napNodeId": "string", "ouiMatchListName": "string", "description": "string", "multicastVlanName": "string", "multicastRangeName": "string" }, { "name": "string", "tierName": "string", "serviceTemplateName": "string", "tagAction": "string", "napNodeId": "string", "ouiMatchListName": "string", "description": "string", "multicastVlanName": "string", "multicastRangeName": "string" }, { "name": "string", "tierName": "string", "serviceTemplateName": "string", "tagAction": "string", "napNodeId": "string", "ouiMatchListName": "string", "description": "string", "multicastVlanName": "string", "multicastRangeName": "string" } ] } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serviceType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/insights/subscribers/{subscriber}/trafficusage": { "get": { "tags": [ "Reports" ], "operationId": "getTrafficUsage", "description": "The parameters and request body are for method: getTrafficUsage. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "startPeriodSec": { "type": "number" }, "usOctets": { "type": "number" }, "dsOctets": { "type": "number" }, "totalOctets": { "type": "number" }, "subscriberId": { "type": "string" }, "subscriberName": { "type": "string" }, "subscriberLocationId": { "type": "string" }, "account": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "peakUsRate": { "type": "number" }, "peakDsRate": { "type": "number" }, "usRate": { "type": "number" }, "dsRate": { "type": "number" }, "endpoint": { "type": "string" }, "ipAddress": { "type": "string" } } } }, "example": [ { "startPeriodSec": 1646956800, "usOctets": 10160136322385, "dsOctets": 10159327006780, "totalOctets": 20319463329165, "subscriberId": "3d273d57-724d-41f1-b01a-76cbec876e83", "subscriberName": "John Doe", "subscriberLocationId": "123-4-5678:555 5TH ST", "account": "123-4-5678", "phone": "555-555-5555", "email": "johndoe@555.com", "peakUsRate": 1127235167, "peakDsRate": 1131424602, "usRate": 940753363, "dsRate": 940678427, "endpoint": "123-4-5678/CXNK55555555", "ipAddress": "1.2.3.4" }, { "startPeriodSec": 1646956800, "usOctets": 10160136322385, "dsOctets": 10159327006780, "totalOctets": 20319463329165, "subscriberId": "3d273d57-724d-41f1-b01a-76cbec876e83", "subscriberName": "John Doe", "subscriberLocationId": "123-4-5678:555 5TH ST", "account": "123-4-5678", "phone": "555-555-5555", "email": "johndoe@555.com", "peakUsRate": 1127235167, "peakDsRate": 1131424602, "usRate": 940753363, "dsRate": 940678427, "endpoint": "123-4-5678/CXNK55555555", "ipAddress": "1.2.3.4" }, { "startPeriodSec": 1646956800, "usOctets": 10160136322385, "dsOctets": 10159327006780, "totalOctets": 20319463329165, "subscriberId": "3d273d57-724d-41f1-b01a-76cbec876e83", "subscriberName": "John Doe", "subscriberLocationId": "123-4-5678:555 5TH ST", "account": "123-4-5678", "phone": "555-555-5555", "email": "johndoe@555.com", "peakUsRate": 1127235167, "peakDsRate": 1131424602, "usRate": 940753363, "dsRate": 940678427, "endpoint": "123-4-5678/CXNK55555555", "ipAddress": "1.2.3.4" } ] } } } }, "parameters": [ { "name": "subscriber", "in": "path", "required": true, "schema": { "title": "subscriber", "type": "string" } }, { "name": "granularity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/insights/subscriberstrafficusage": { "get": { "tags": [ "Reports" ], "operationId": "getTrafficUsageForAllSubs", "description": "The parameters and request body are for method: getTrafficUsageForAllSubs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "startPeriodSec": { "type": "number" }, "usOctets": { "type": "number" }, "dsOctets": { "type": "number" }, "totalOctets": { "type": "number" }, "subscriberId": { "type": "string" }, "subscriberName": { "type": "string" }, "subscriberLocationId": { "type": "string" }, "account": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "peakUsRate": { "type": "number" }, "peakDsRate": { "type": "number" }, "usRate": { "type": "number" }, "dsRate": { "type": "number" }, "endpoint": { "type": "string" }, "ipAddress": { "type": "string" } } } }, "example": [ { "startPeriodSec": 1646956800, "usOctets": 10160136322385, "dsOctets": 10159327006780, "totalOctets": 20319463329165, "subscriberId": "3d273d57-724d-41f1-b01a-76cbec876e83", "subscriberName": "John Doe", "subscriberLocationId": "123-4-5678:555 5TH ST", "account": "123-4-5678", "phone": "555-555-5555", "email": "johndoe@555.com", "peakUsRate": 1127235167, "peakDsRate": 1131424602, "usRate": 940753363, "dsRate": 940678427, "endpoint": "123-4-5678/CXNK55555555", "ipAddress": "1.2.3.4" }, { "startPeriodSec": 1646956800, "usOctets": 10160136322385, "dsOctets": 10159327006780, "totalOctets": 20319463329165, "subscriberId": "3d273d57-724d-41f1-b01a-76cbec876e83", "subscriberName": "John Doe", "subscriberLocationId": "123-4-5678:555 5TH ST", "account": "123-4-5678", "phone": "555-555-5555", "email": "johndoe@555.com", "peakUsRate": 1127235167, "peakDsRate": 1131424602, "usRate": 940753363, "dsRate": 940678427, "endpoint": "123-4-5678/CXNK55555555", "ipAddress": "1.2.3.4" }, { "startPeriodSec": 1646956800, "usOctets": 10160136322385, "dsOctets": 10159327006780, "totalOctets": 20319463329165, "subscriberId": "3d273d57-724d-41f1-b01a-76cbec876e83", "subscriberName": "John Doe", "subscriberLocationId": "123-4-5678:555 5TH ST", "account": "123-4-5678", "phone": "555-555-5555", "email": "johndoe@555.com", "peakUsRate": 1127235167, "peakDsRate": 1131424602, "usRate": 940753363, "dsRate": 940678427, "endpoint": "123-4-5678/CXNK55555555", "ipAddress": "1.2.3.4" } ] } } } }, "parameters": [ { "name": "granularity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }