{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/subscriber/search": { "get": { "tags": [ "Subscriber" ], "operationId": "subscriberLookup", "description": "The parameters and request body are for method: subscriberLookup. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Account": { "type": "string" }, "AccountName": { "type": "string" }, "ServiceAddress": { "type": "string" } } } }, "example": [ { "Account": "123456203", "AccountName": "Roxanne Hunn", "ServiceAddress": "721 Kimball Terrace San Ysidro CA 94636-9101" } ] } } } }, "parameters": [ { "name": "externalID", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "dL", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sSN", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lookupCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}": { "get": { "tags": [ "Subscriber" ], "operationId": "getSubscriber", "description": "The parameters and request body are for method: getSubscriber. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Account": { "type": "string" }, "SubscriberStatus": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" }, "BaseCustStatus": { "type": "number" } } }, "SubscriberType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "AccountName": { "type": "string" }, "FirstName": { "type": "string" }, "SecondName": { "type": "string" }, "LastName": { "type": "string" }, "PhoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "PhoneNumber": { "type": "string" }, "PhoneNumberType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } } } }, "BillingEmail": { "type": "string" }, "ServiceAddress": { "type": "object", "properties": { "FullAddress": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "ZIP": { "type": "string" }, "ZIPPlus4": { "type": "string" }, "BlockFIPS": { "type": "string" }, "Franchise": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "PropertyType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "HeadEnd": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Hub": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Node": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "VoIPRateCenter": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "DropTag": { "type": "string" }, "Wired": { "type": "boolean" }, "DropConnected": { "type": "boolean" }, "TechRegion": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "SalesArea": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "ManagementArea": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } } }, "Franchise": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "TimeZone": { "type": "object", "properties": { "ID": { "type": "number" }, "BIAS": { "type": "number" }, "Name": { "type": "string" }, "Description": { "type": "string" } } }, "PaymentPlan": { "type": "string" }, "PaymentTypes": { "type": "array", "items": { "type": "object", "properties": { "ID": { "type": "number" }, "Code": { "type": "string" }, "Name": { "type": "string" } } } }, "DOB": { "type": "string" }, "WinScoreRiskFactor": { "type": "string" }, "ParentAccounts": { "type": "array", "items": { "type": "object", "properties": { "Account": { "type": "string" }, "AccountName": { "type": "string" } } } }, "ChildAccounts": { "type": "array", "items": { "type": "object", "properties": { "Account": { "type": "string" }, "AccountName": { "type": "string" } } } }, "SoftDisconnect": { "type": "object", "properties": { "SDStatus": { "type": "string" }, "SDDate": { "type": "string" } } }, "PINisSet": { "type": "boolean" }, "CanOrderPPV": { "type": "boolean" }, "PPVDenyReason": { "type": "object", "properties": { "Value": { "type": "number" }, "Text": { "type": "string" } } }, "InOutageArea": { "type": "boolean" }, "ActiveOutages": { "type": "array", "items": { "type": "object", "properties": { "ID": { "type": "number" }, "OutageStatus": { "type": "string" }, "OutageType": { "type": "string" }, "Description": { "type": "string" }, "StartTime": { "type": "string" }, "EstCloseTime": { "type": "string" }, "ActualEndDate": { "type": "string" }, "Resolutions": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } } } } } } }, "example": { "Account": "123456203", "SubscriberStatus": { "Code": "ACT", "Name": "Active", "BaseCustStatus": 237 }, "SubscriberType": { "Code": "RES", "Name": "Residential" }, "AccountName": "Roxanne Hunn", "FirstName": "Roxanne", "SecondName": "string", "LastName": "Hunn", "PhoneNumbers": [ { "PhoneNumber": "(760) 385-4792", "PhoneNumberType": { "Code": "HOM", "Name": "Home" } }, { "PhoneNumber": "(760) 385-4792", "PhoneNumberType": { "Code": "HOM", "Name": "Home" } }, { "PhoneNumber": "(760) 385-4792", "PhoneNumberType": { "Code": "HOM", "Name": "Home" } }, { "PhoneNumber": "(760) 385-4792", "PhoneNumberType": { "Code": "HOM", "Name": "Home" } }, { "PhoneNumber": "(760) 385-4792", "PhoneNumberType": { "Code": "HOM", "Name": "Home" } } ], "BillingEmail": "name@provider.com", "ServiceAddress": { "FullAddress": "721 Kimball Terrace San Ysidro CA 94636-9101", "City": "San Ysidro", "State": "CA", "ZIP": "94636", "ZIPPlus4": "94636-9101", "BlockFIPS": "060730176041014", "Franchise": { "Code": "001", "Name": "South Park1" }, "PropertyType": { "Code": "RES", "Name": "Residential" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Node": { "Code": "005", "Name": "005" }, "VoIPRateCenter": { "Code": "DRC", "Name": "Default" }, "DropTag": "LM89546", "Wired": true, "DropConnected": true, "TechRegion": { "Code": "TRD", "Name": "Default Tech Region" }, "SalesArea": { "Code": "DFT", "Name": "Default Sales Area" }, "ManagementArea": { "Code": "DFT", "Name": "Default Management Area" } }, "Franchise": { "Code": "001", "Name": "South Park1" }, "TimeZone": { "ID": 75, "BIAS": 480, "Name": "Pacific Standard Time (Mexico)", "Description": "(UTC-08:00) Baja California" }, "PaymentPlan": "Pre-paid", "PaymentTypes": [ { "ID": 5, "Code": "string", "Name": "string" }, { "ID": 2, "Code": "string", "Name": "string" }, { "ID": 2, "Code": "string", "Name": "string" }, { "ID": 9, "Code": "string", "Name": "string" }, { "ID": 6, "Code": "string", "Name": "string" }, { "ID": 3, "Code": "string", "Name": "string" } ], "DOB": "1975-03-09", "WinScoreRiskFactor": "RiskFactor", "ParentAccounts": [ { "Account": "123456201", "AccountName": "Parent Account Name" }, { "Account": "123456201", "AccountName": "Parent Account Name" }, { "Account": "123456201", "AccountName": "Parent Account Name" }, { "Account": "123456201", "AccountName": "Parent Account Name" }, { "Account": "123456201", "AccountName": "Parent Account Name" } ], "ChildAccounts": [ { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" }, { "Account": "123456204", "AccountName": "Child Account Name" } ], "SoftDisconnect": { "SDStatus": "Active", "SDDate": "2020-12-12" }, "PINisSet": true, "CanOrderPPV": false, "PPVDenyReason": { "Value": 20, "Text": "Subscriber's PPV is Temporary disabled" }, "InOutageArea": true, "ActiveOutages": [ { "ID": 1, "OutageStatus": "Closed", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Open", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Closed", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Closed", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Closed", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Open", "OutageType": "Planned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Closed", "OutageType": "Planned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Open", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Open", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Open", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] } ] } } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/balance": { "get": { "tags": [ "Subscriber" ], "operationId": "getBalance", "description": "The parameters and request body are for method: getBalance. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "PaymentPlan": { "type": "string" }, "LastBillAfterPayments": { "type": "number" }, "CurrentBalance": { "type": "number" }, "NewActivity": { "type": "number" }, "CurrentAging30": { "type": "number" }, "CurrentAging60": { "type": "number" }, "CurrentAging90": { "type": "number" }, "CurrentAging120": { "type": "number" }, "PastDueAmt": { "type": "number" }, "CurrentBillDueDate": { "type": "string" }, "LastBillAmount": { "type": "number" }, "LastBillDate": { "type": "string" }, "BillFormIsSet": { "type": "boolean" }, "LastCycleCloseDate": { "type": "string" }, "LastPaymentAmount": { "type": "number" }, "LastPaymentDate": { "type": "string" }, "LatePaymentAmount": { "type": "number" }, "MonthlyPPVCreditLimit": { "type": "number" }, "AvailPPVCreditLimit": { "type": "number" }, "PTP": { "type": "object", "properties": { "PTPDate": { "type": "string" }, "PTPAgingCategory": { "type": "string" }, "PTPAmount": { "type": "number" } } } } }, "example": { "PaymentPlan": "Post-paid", "LastBillAfterPayments": 13062.13, "CurrentBalance": 19991.3, "NewActivity": 6929.17, "CurrentAging30": 256.37, "CurrentAging60": 249.72, "CurrentAging90": 236.37, "CurrentAging120": 12319.67, "PastDueAmt": 12319.67, "CurrentBillDueDate": "2020-11-01", "LastBillAmount": 14690.5, "LastBillDate": "2020-10-30", "BillFormIsSet": false, "LastCycleCloseDate": "2020-10-30", "LastPaymentAmount": 99.99, "LastPaymentDate": "2020-10-30", "LatePaymentAmount": 1628.37, "MonthlyPPVCreditLimit": 100, "AvailPPVCreditLimit": 10.1, "PTP": { "PTPDate": "2020-12-12", "PTPAgingCategory": "31-60", "PTPAmount": 10 } } } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/buckets": { "get": { "tags": [ "Subscriber" ], "operationId": "getSubBucketBalances", "description": "The parameters and request body are for method: getSubBucketBalances. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Description": { "type": "string" }, "Balance": { "type": "number" } } } }, "example": [ { "Code": "TVD", "Description": "TV AND DATA", "Balance": -2.34 }, { "Code": "TVD", "Description": "TV AND DATA", "Balance": -2.34 }, { "Code": "TVD", "Description": "TV AND DATA", "Balance": -2.34 } ] } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/packages": { "get": { "tags": [ "Subscriber" ], "operationId": "getSubscriberPackages", "description": "The parameters and request body are for method: getSubscriberPackages. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "PackageCode": { "type": "string" }, "PackageName": { "type": "string" }, "Price": { "type": "number" } } } }, "example": [ { "PackageCode": "015", "PackageName": "HBO", "Price": 10 }, { "PackageCode": "015", "PackageName": "HBO", "Price": 10 }, { "PackageCode": "015", "PackageName": "HBO", "Price": 10 }, { "PackageCode": "015", "PackageName": "HBO", "Price": 10 } ] } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/packages/sis": { "get": { "tags": [ "Subscriber" ], "operationId": "getSIS", "description": "The parameters and request body are for method: getSIS. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Packages": { "type": "array", "items": { "type": "object", "properties": { "ServiceClass": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Code": { "type": "string" }, "Name": { "type": "string" }, "Quantity": { "type": "number" }, "Price": { "type": "number" }, "Taxes": { "type": "number" }, "ContractNumber": { "type": "string" }, "ContractEndDate": { "type": "string" } } } }, "Discounts": { "type": "array", "items": { "type": "object", "properties": { "ServiceClass": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Code": { "type": "string" }, "Name": { "type": "string" }, "Discount": { "type": "number" }, "Taxes": { "type": "number" }, "ContractNumber": { "type": "string" }, "ContractEndDate": { "type": "string" } } } }, "TaxesAndFees": { "type": "array", "items": { "type": "object", "properties": { "ServiceClass": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Code": { "type": "string" }, "Name": { "type": "string" }, "Amount": { "type": "number" } } } } } }, "example": { "Packages": [ { "ServiceClass": { "Code": "VID", "Name": "Video" }, "Code": "015", "Name": "HBO", "Quantity": 1, "Price": 10, "Taxes": 2.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" }, { "ServiceClass": { "Code": "VID", "Name": "Video" }, "Code": "015", "Name": "HBO", "Quantity": 1, "Price": 10, "Taxes": 2.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" }, { "ServiceClass": { "Code": "VID", "Name": "Video" }, "Code": "015", "Name": "HBO", "Quantity": 1, "Price": 10, "Taxes": 2.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" }, { "ServiceClass": { "Code": "VID", "Name": "Video" }, "Code": "015", "Name": "HBO", "Quantity": 1, "Price": 10, "Taxes": 2.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" }, { "ServiceClass": { "Code": "VID", "Name": "Video" }, "Code": "015", "Name": "HBO", "Quantity": 1, "Price": 10, "Taxes": 2.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" } ], "Discounts": [ { "ServiceClass": { "Code": "VID", "Name": "HBO" }, "Code": "SSS", "Name": "HBO VOIP Combo", "Discount": 1, "Taxes": 0.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" }, { "ServiceClass": { "Code": "VID", "Name": "HBO" }, "Code": "SSS", "Name": "HBO VOIP Combo", "Discount": 1, "Taxes": 0.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" }, { "ServiceClass": { "Code": "VID", "Name": "HBO" }, "Code": "SSS", "Name": "HBO VOIP Combo", "Discount": 1, "Taxes": 0.25, "ContractNumber": "2020-450-11", "ContractEndDate": "string" } ], "TaxesAndFees": [ { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 }, { "ServiceClass": { "Code": "384", "Name": "Taxes and Fees" }, "Code": "CTX", "Name": "City Sales Tax", "Amount": 10 } ] } } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/packages/summary": { "get": { "tags": [ "Subscriber" ], "operationId": "getSubscriberPackageSummary", "description": "The parameters and request body are for method: getSubscriberPackageSummary. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "RecurringCharges": { "type": "number" }, "RecurringDiscounts": { "type": "number" }, "TimedBilling": { "type": "number" }, "TimedPromoDiscounts": { "type": "number" }, "AfterDiscounts": { "type": "number" }, "TotalTaxed": { "type": "number" } } }, "example": { "RecurringCharges": 9, "RecurringDiscounts": 4, "TimedBilling": 10, "TimedPromoDiscounts": 6, "AfterDiscounts": 1, "TotalTaxed": 7 } } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/transactions/last/{x}": { "get": { "tags": [ "Subscriber" ], "operationId": "getLastSubscriberTransactions", "description": "The parameters and request body are for method: getLastSubscriberTransactions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Date": { "type": "string" }, "Amount": { "type": "number" } } } }, "example": [ { "Type": { "Code": "ADJ", "Name": "Adjustment" }, "Date": "2020-12-12", "Amount": 2 }, { "Type": { "Code": "ADJ", "Name": "Adjustment" }, "Date": "2020-12-12", "Amount": 5 }, { "Type": { "Code": "ADJ", "Name": "Adjustment" }, "Date": "2020-12-12", "Amount": 7 }, { "Type": { "Code": "ADJ", "Name": "Adjustment" }, "Date": "2020-12-12", "Amount": 5 } ] } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } }, { "name": "x", "in": "path", "required": true, "schema": { "title": "x", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/equipment": { "get": { "tags": [ "Equipment" ], "operationId": "getSubscriberEquipment", "description": "The parameters and request body are for method: getSubscriberEquipment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "EquipmentID": { "type": "string" }, "SecondaryID": { "type": "string" }, "Serial": { "type": "string" }, "Type": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Make": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Model": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Status": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "HeadEnd": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Hub": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Location": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Refreshable": { "type": "boolean" }, "SingleFamilyUnit": { "type": "boolean" }, "Interfaces": { "type": "array", "items": { "type": "object", "properties": { "EquipmentID": { "type": "string" }, "SecondaryID": { "type": "string" }, "Serial": { "type": "string" }, "Type": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Make": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Model": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "HeadEnd": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Hub": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Refreshable": { "type": "boolean" }, "Ports": { "type": "array", "items": { "type": "object", "properties": { "PortType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "PortId": { "type": "number" } } } } } } }, "Ports": { "type": "array", "items": { "type": "object", "properties": { "PortType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "PortId": { "type": "number" } } } } } } }, "example": [ { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "Status": { "Code": "RES", "Name": "Residential" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Location": { "Code": "LVR", "Name": "Living room" }, "Refreshable": false, "SingleFamilyUnit": false, "Interfaces": [ { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Refreshable": true, "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] }, { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Refreshable": false, "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] }, { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Refreshable": true, "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] }, { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Refreshable": false, "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] }, { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Refreshable": false, "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] }, { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Refreshable": true, "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] }, { "EquipmentID": "0000310770580", "SecondaryID": "0000310770581", "Serial": "GI1032TB70LO", "Type": { "Code": "CVT", "Name": "Converter" }, "Make": { "Code": "HIT", "Name": "Hits" }, "Model": { "Code": "041", "Name": "HITS DCT1000 w/ phone return" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Refreshable": true, "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] } ], "Ports": [ { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 }, { "PortType": { "Code": "DGE", "Name": "DGE Port" }, "PortId": 1 } ] } ] } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/equipment/refresh/all": { "get": { "tags": [ "Equipment" ], "operationId": "refreshAllEquipment", "description": "The parameters and request body are for method: refreshAllEquipment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/equipment/refresh": { "post": { "tags": [ "Equipment" ], "operationId": "refreshEquipment", "description": "The parameters and request body are for method: refreshEquipment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/equipment/{eQUIPMENTID}/action/{aCTIONCODE}": { "get": { "tags": [ "Equipment" ], "operationId": "performActionCode", "description": "The parameters and request body are for method: performActionCode. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "eQUIPMENTID", "in": "path", "required": true, "schema": { "title": "eQUIPMENTID", "type": "string" } }, { "name": "aCTIONCODE", "in": "path", "required": true, "schema": { "title": "aCTIONCODE", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/outages/last/{x}": { "get": { "tags": [ "Outages" ], "operationId": "getLastOutages", "description": "The parameters and request body are for method: getLastOutages. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "ID": { "type": "number" }, "OutageStatus": { "type": "string" }, "OutageType": { "type": "string" }, "Description": { "type": "string" }, "StartTime": { "type": "string" }, "EstCloseTime": { "type": "string" }, "ActualEndDate": { "type": "string" }, "Resolutions": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } } } } }, "example": [ { "ID": 1, "OutageStatus": "Closed", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" }, { "Code": "001", "Name": "Resolution 1" } ] }, { "ID": 1, "OutageStatus": "Closed", "OutageType": "Unplanned", "Description": "string", "StartTime": "string", "EstCloseTime": "string", "ActualEndDate": "string", "Resolutions": [ { "Code": "001", "Name": "Resolution 1" } ] } ] } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } }, { "name": "x", "in": "path", "required": true, "schema": { "title": "x", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/outage": { "put": { "tags": [ "Outages" ], "operationId": "createOutage", "description": "The parameters and request body are for method: createOutage. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Outage": { "type": "number" } } }, "example": { "Outage": 100 } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/outage/{oUTAGE}": { "patch": { "tags": [ "Outages" ], "operationId": "updateOutage", "description": "The parameters and request body are for method: updateOutage. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "oUTAGE", "in": "path", "required": true, "schema": { "title": "oUTAGE", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/outage/{oUTAGE}/cancel": { "delete": { "tags": [ "Outages" ], "operationId": "cancelOutage", "description": "The parameters and request body are for method: cancelOutage. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "oUTAGE", "in": "path", "required": true, "schema": { "title": "oUTAGE", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/subscriber/{aCCOUNT}/work-orders/last/{x}": { "get": { "tags": [ "WorkOrders" ], "operationId": "getLastWorkOrders", "description": "The parameters and request body are for method: getLastWorkOrders. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "WOnumber": { "type": "string" }, "WOStatus": { "type": "string" }, "CreatedBy": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "CreatedWhen": { "type": "string" }, "WOType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" }, "BaseType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } } }, "ScheduledDate": { "type": "string" }, "ScheduledPeriod": { "type": "object", "properties": { "Period": { "type": "number" }, "PeriodStart": { "type": "string" }, "PeriodEnd": { "type": "string" }, "PeriodDescription": { "type": "string" } } }, "Technician": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "ClosedBy": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Reasons": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "Reason": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } } } } } } }, "example": [ { "WOnumber": "2147486937", "WOStatus": "Open", "CreatedBy": { "Code": "CSD", "Name": "Mark Lawman" }, "CreatedWhen": "string", "WOType": { "Code": "COS", "Name": "Change of Service", "BaseType": { "Code": "COS", "Name": "Change of Service" } }, "ScheduledDate": "string", "ScheduledPeriod": { "Period": 354, "PeriodStart": "2020-10-30T12:00:00.000Z", "PeriodEnd": "2020-10-30T17:00:00.000Z", "PeriodDescription": "12PM-5PM" }, "Technician": { "Code": "1VD", "Name": "John Black" }, "ClosedBy": { "Code": "CSD", "Name": "Mark Lawman" }, "Reasons": [ { "type": "Initial", "Reason": { "Code": "201", "Name": "Too expensive" } }, { "type": "Secondary", "Reason": { "Code": "202", "Name": "Slow Speed" } }, { "type": "Secondary", "Reason": { "Code": "203", "Name": "Can't afford" } }, { "type": "Final", "Reason": { "Code": "204", "Name": "Downgrade" } } ] }, { "WOnumber": "2147486937", "WOStatus": "Open", "CreatedBy": { "Code": "CSD", "Name": "Mark Lawman" }, "CreatedWhen": "string", "WOType": { "Code": "COS", "Name": "Change of Service", "BaseType": { "Code": "COS", "Name": "Change of Service" } }, "ScheduledDate": "string", "ScheduledPeriod": { "Period": 354, "PeriodStart": "2020-10-30T12:00:00.000Z", "PeriodEnd": "2020-10-30T17:00:00.000Z", "PeriodDescription": "12PM-5PM" }, "Technician": { "Code": "1VD", "Name": "John Black" }, "ClosedBy": { "Code": "CSD", "Name": "Mark Lawman" }, "Reasons": [ { "type": "Initial", "Reason": { "Code": "201", "Name": "Too expensive" } }, { "type": "Secondary", "Reason": { "Code": "202", "Name": "Slow Speed" } }, { "type": "Secondary", "Reason": { "Code": "203", "Name": "Can't afford" } }, { "type": "Final", "Reason": { "Code": "204", "Name": "Downgrade" } } ] }, { "WOnumber": "2147486937", "WOStatus": "Open", "CreatedBy": { "Code": "CSD", "Name": "Mark Lawman" }, "CreatedWhen": "string", "WOType": { "Code": "COS", "Name": "Change of Service", "BaseType": { "Code": "COS", "Name": "Change of Service" } }, "ScheduledDate": "string", "ScheduledPeriod": { "Period": 354, "PeriodStart": "2020-10-30T12:00:00.000Z", "PeriodEnd": "2020-10-30T17:00:00.000Z", "PeriodDescription": "12PM-5PM" }, "Technician": { "Code": "1VD", "Name": "John Black" }, "ClosedBy": { "Code": "CSD", "Name": "Mark Lawman" }, "Reasons": [ { "type": "Initial", "Reason": { "Code": "201", "Name": "Too expensive" } }, { "type": "Secondary", "Reason": { "Code": "202", "Name": "Slow Speed" } }, { "type": "Secondary", "Reason": { "Code": "203", "Name": "Can't afford" } }, { "type": "Final", "Reason": { "Code": "204", "Name": "Downgrade" } } ] } ] } } } }, "parameters": [ { "name": "aCCOUNT", "in": "path", "required": true, "schema": { "title": "aCCOUNT", "type": "string" } }, { "name": "x", "in": "path", "required": true, "schema": { "title": "x", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/work-order/{wONUMBER}/availability": { "get": { "tags": [ "WorkOrders" ], "operationId": "getAvailability", "description": "The parameters and request body are for method: getAvailability. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Period": { "type": "number" }, "PeriodStart": { "type": "string" }, "PeriodEnd": { "type": "string" }, "PeriodDescription": { "type": "string" } } } }, "example": [ { "Period": 354, "PeriodStart": "2020-10-30T12:00:00.000Z", "PeriodEnd": "2020-10-30T17:00:00.000Z", "PeriodDescription": "12PM-5PM" }, { "Period": 354, "PeriodStart": "2020-10-30T12:00:00.000Z", "PeriodEnd": "2020-10-30T17:00:00.000Z", "PeriodDescription": "12PM-5PM" }, { "Period": 354, "PeriodStart": "2020-10-30T12:00:00.000Z", "PeriodEnd": "2020-10-30T17:00:00.000Z", "PeriodDescription": "12PM-5PM" }, { "Period": 354, "PeriodStart": "2020-10-30T12:00:00.000Z", "PeriodEnd": "2020-10-30T17:00:00.000Z", "PeriodDescription": "12PM-5PM" } ] } } } }, "parameters": [ { "name": "wONUMBER", "in": "path", "required": true, "schema": { "title": "wONUMBER", "type": "string" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/work-order/{wONUMBER}/reschedule/date/{dATE}/period/{pERIOD}": { "get": { "tags": [ "WorkOrders" ], "operationId": "rescheduleWorkOrder", "description": "The parameters and request body are for method: rescheduleWorkOrder. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "wONUMBER", "in": "path", "required": true, "schema": { "title": "wONUMBER", "type": "string" } }, { "name": "dATE", "in": "path", "required": true, "schema": { "title": "dATE", "type": "string" } }, { "name": "pERIOD", "in": "path", "required": true, "schema": { "title": "pERIOD", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/work-order/{wONUMBER}/cancel": { "get": { "tags": [ "WorkOrders" ], "operationId": "cancelWorkOrder", "description": "The parameters and request body are for method: cancelWorkOrder. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "wONUMBER", "in": "path", "required": true, "schema": { "title": "wONUMBER", "type": "string" } }, { "name": "reason", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/home/search": { "get": { "tags": [ "Home" ], "operationId": "homeLookup", "description": "The parameters and request body are for method: homeLookup. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Home": { "type": "number" }, "Address": { "type": "string" } } } }, "example": [ { "Home": 100, "Address": "721 Kimball Terrace San Ysidro CA 94636-9101" }, { "Home": 100, "Address": "721 Kimball Terrace San Ysidro CA 94636-9101" }, { "Home": 100, "Address": "721 Kimball Terrace San Ysidro CA 94636-9101" }, { "Home": 100, "Address": "721 Kimball Terrace San Ysidro CA 94636-9101" } ] } } } }, "parameters": [ { "name": "streetNumber", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apartment", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "city", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "postCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/home/{hOME}": { "get": { "tags": [ "Home" ], "operationId": "getHome", "description": "The parameters and request body are for method: getHome. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "FullAddress": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "ZIP": { "type": "string" }, "ZIPPlus4": { "type": "string" }, "BlockFIPS": { "type": "string" }, "Franchise": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "PropertyType": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "HeadEnd": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Hub": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "Node": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "VoIPRateCenter": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "DropTag": { "type": "string" }, "Wired": { "type": "boolean" }, "DropConnected": { "type": "boolean" }, "TechRegion": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "SalesArea": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "ManagementArea": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } } }, "example": { "FullAddress": "721 Kimball Terrace San Ysidro CA 94636-9101", "City": "San Ysidro", "State": "CA", "ZIP": "94636", "ZIPPlus4": "94636-9101", "BlockFIPS": "060730176041014", "Franchise": { "Code": "001", "Name": "South Park1" }, "PropertyType": { "Code": "RES", "Name": "Residential" }, "HeadEnd": { "Code": "HTS", "Name": "Hits" }, "Hub": { "Code": "HTS", "Name": "Hits" }, "Node": { "Code": "005", "Name": "005" }, "VoIPRateCenter": { "Code": "DRC", "Name": "Default" }, "DropTag": "LM89546", "Wired": true, "DropConnected": true, "TechRegion": { "Code": "TRD", "Name": "Default Tech Region" }, "SalesArea": { "Code": "DFT", "Name": "Default Sales Area" }, "ManagementArea": { "Code": "DFT", "Name": "Default Management Area" } } } } } }, "parameters": [ { "name": "hOME", "in": "path", "required": true, "schema": { "title": "hOME", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/reasons/{tYPE}": { "get": { "tags": [ "Other" ], "operationId": "getReasons", "description": "The parameters and request body are for method: getReasons. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } }, "example": [ { "Code": "string", "Name": "string" }, { "Code": "string", "Name": "string" }, { "Code": "string", "Name": "string" } ] } } } }, "parameters": [ { "name": "tYPE", "in": "path", "required": true, "schema": { "title": "tYPE", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/service-classes": { "get": { "tags": [ "Other" ], "operationId": "getServiceClassList", "description": "The parameters and request body are for method: getServiceClassList. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } } }, "example": [ { "Code": "string", "Name": "string" }, { "Code": "string", "Name": "string" }, { "Code": "string", "Name": "string" }, { "Code": "string", "Name": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }