@itentialopensource/adapter-glds_customerexperiencegateway

openapi: 3.0.0 info: title: Customer Experience Gateway description: "## Get Started\n\nCustomer Experience Gateway is a REST API which provides third-party systems data on the state of a customer/subscriber so that aspects of that customer/subscriber can be managed in the third-party system. By providing some of the data BroadHub has about a customer/subscriber, third-party systems can eliminate some of the reasons a customer/subscriber would call or look for help online and provide a more personalized experience to them while reducing the number of calls that need to get to a customer service representative (CSR). API enables the ability to perform some BroadHub actions such as rescheduling and canceling work orders and refreshing equipment. \n\n## Features\nThe API will need to provide data for the following data points in BroadHub when requested by a third-party integrator. REST will need to be used for the data communication:\n\n- Subscriber Lookup\n- Customer/Subscriber Information\n - Payment Information\n - Promise-to-Pay (PTP) Information \n - Equipment Information \n - Soft-Disconnect Information \n- Home Lookup\n- Homes Passed Information\n- Equipment Actions\n- Work Order Information\n- Work Order Rescheduling/Canceling\n- Outage Information\n- Outage Actions (Create, Update, and Cancel)\n\n## Authentication\nCustomer Experience Gateway uses Basic Authentication. Basic authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password. For example, to authorize as demo / p@55w0rd the client would send\n\n```json\nAuthorization: Basic ZGVtbzpwQDU1dzByZA==\n```\n\nNote: Because base64 is easily decoded, HTTPS/SSL must be used.\n\n## Use Case Diagrams\n\n[Diagrams](https://www.glds.com/files/ceg_diagrams.pdf)\n\n## Date and Time Formats\n\n- date – full-date notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), for example, 2017-07-21\n- date-time – the date-time notation as defined by [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z" contact: name: '' url: https://www.glds.com/contact/ email: support@glds.com version: 'v1.0' servers: - url: https://bhas.glds.com:15920/customer-experience-gateway/v1 variables: {} paths: /subscriber/search: get: tags: - Subscriber summary: SubscriberLookup description: Lookup subscriber operationId: SubscriberLookup parameters: - name: ExternalID in: query description: External ID style: form explode: true schema: maxLength: 40 minLength: 1 type: string - name: PhoneNumber in: query description: Unformated phone number without country code style: form explode: true schema: maxLength: 15 minLength: 1 pattern: ^[0-9]+ type: string example: '7606021916' - name: DL in: query description: Driver's license style: form explode: true schema: maxLength: 16 minLength: 1 pattern: ^[A-Z0-9- ]+ type: string - name: SSN in: query description: Social security number style: form explode: true schema: maxLength: 16 minLength: 1 pattern: ^[A-Z0-9- ]+ type: string - name: LookupCode in: query description: PPV Lookup Code, unique per subscriber record style: form explode: true schema: maxLength: 10 minLength: 1 type: string - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberSearchResponse' description: '' example: - Account: '123456203' AccountName: Roxanne Hunn ServiceAddress: 721 Kimball Terrace San Ysidro CA 94636-9101 examples: example: value: - Account: '123456203' AccountName: Roxanne Hunn ServiceAddress: 721 Kimball Terrace San Ysidro CA 94636-9101 '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}: get: tags: - Subscriber summary: GetSubscriber description: Get subscriber operationId: GetSubscriber parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriberResponse' - example: Account: '008316' SubscriberStatus: Code: ACT Name: Active BaseCustStatus: 173 SubscriberType: Code: RES Name: Residential Subscriber AccountName: Dan G Falana FirstName: Dan SecondName: G LastName: Falana PhoneNumbers: - PhoneNumber: '9018723602' PhoneNumberType: Code: HOM Name: Home phone - PhoneNumber: '7616035031' PhoneNumberType: Code: VOI Name: VoIP Phone BillingEmail: '' ServiceAddress: FullAddress: 4780 Navy Rd Encinitas, CA 92024 City: Encinitas State: CA ZIP: '92024' ZIPPlus4: '92024' BlockFIPS: '' Franchise: Code: '009' Name: Ocean Beach PropertyType: Code: RES Name: Residential HeadEnd: Code: '001' Name: NCTC Member Hub: Code: S_A Name: Scientific Atlanta Node: Code: '005' Name: Blue Lake VoIPRateCenter: Code: DRC Name: Default Wired: true DropConnected: true TechRegion: Code: '001' Name: North Franchise: Code: '009' Name: Ocean Beach CanOrderPPV: false PPVDenyReason: Value: 17 Text: Subscriber is not PPV Enabled PINisSet: true TimeZone: ID: 40 BIAS: 480 Name: Pacific Standard Time Description: (UTC-08:00) Pacific Time (US & Canada) PaymentPlan: Post-paid PaymentTypes: - ID: 255 Code: CHG Name: Credit Card Payment - ID: 253 Code: CSH Name: Cash Payment InOutageArea: true ActiveOutages: - ID: 9 OutageStatus: Open OutageType: Planned Description: Planned Outage Test StartTime: 2020-08-05T23:26:14.096Z examples: example-008316: value: Account: '008316' SubscriberStatus: Code: ACT Name: Active BaseCustStatus: 173 SubscriberType: Code: RES Name: Residential Subscriber AccountName: Dan G Falana FirstName: Dan SecondName: G LastName: Falana PhoneNumbers: - PhoneNumber: '9018723602' PhoneNumberType: Code: HOM Name: Home phone - PhoneNumber: '7616035031' PhoneNumberType: Code: VOI Name: VoIP Phone BillingEmail: '' ServiceAddress: FullAddress: 4780 Navy Rd Encinitas, CA 92024 City: Encinitas State: CA ZIP: '92024' ZIPPlus4: '92024' BlockFIPS: '' Franchise: Code: '009' Name: Ocean Beach PropertyType: Code: RES Name: Residential HeadEnd: Code: '001' Name: NCTC Member Hub: Code: S_A Name: Scientific Atlanta Node: Code: '005' Name: Blue Lake VoIPRateCenter: Code: DRC Name: Default Wired: true DropConnected: true TechRegion: Code: '001' Name: North Franchise: Code: '009' Name: Ocean Beach CanOrderPPV: false PPVDenyReason: Value: 17 Text: Subscriber is not PPV Enabled PINisSet: true TimeZone: ID: 40 BIAS: 480 Name: Pacific Standard Time Description: (UTC-08:00) Pacific Time (US & Canada) PaymentPlan: Post-paid PaymentTypes: - ID: 255 Code: CHG Name: Credit Card Payment - ID: 253 Code: CSH Name: Cash Payment InOutageArea: true ActiveOutages: - ID: 9 OutageStatus: Open OutageType: Planned Description: Planned Outage Test StartTime: 2020-08-05T23:26:14.096Z '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/balance: get: tags: - Subscriber summary: GetBalance description: Get subscriber balance operationId: GetBalance parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriberBalanceResponse' - example: PaymentPlan: Post-paid LastBillAfterPayments: 0 CurrentBalance: 0 NewActivity: 0 CurrentAging30: 0 CurrentAging60: 0 CurrentAging90: 0 CurrentAging120: 0 PastDueAmt: 0 LastBillAmount: 243.03 LastBillDate: 2021-01-25 BillFormIsSet: true LastPaymentAmount: -243.03 LastPaymentDate: 2021-02-10 MonthlyPPVCreditLimit: 100 AvailPPVCreditLimit: 100 LatePaymentAmount: 0 examples: example-008316: value: PaymentPlan: Post-paid LastBillAfterPayments: 0 CurrentBalance: 0 NewActivity: 0 CurrentAging30: 0 CurrentAging60: 0 CurrentAging90: 0 CurrentAging120: 0 PastDueAmt: 0 LastBillAmount: 243.03 LastBillDate: 2021-01-25 BillFormIsSet: true LastPaymentAmount: -243.03 LastPaymentDate: 2021-02-10 MonthlyPPVCreditLimit: 100 AvailPPVCreditLimit: 100 LatePaymentAmount: 0 '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/buckets: get: tags: - Subscriber summary: GetSubBucketBalances description: Used to get pre-pay subscriber buckets. It will return single post-pay bucket for post-pay subscriber. operationId: GetSubBucketBalances parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberBucketsResponse' description: '' example: - Code: TVB Description: TV AND DATA Balance: -2.34 - Code: PHN Description: PHONE Balance: -5678.9 examples: example: value: - Code: TVB Description: TV AND DATA Balance: -2.34 - Code: PHN Description: PHONE Balance: -5678.9 '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/packages: get: tags: - Subscriber summary: GetSubscriberPackages description: Get subscriber packages operationId: GetSubscriberPackages parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberPackagesResponse' description: Packages example: - PackageCode: TRB PackageName: Retention Discount - -20 Price: -20 - PackageCode: '001' PackageName: 10-Star Digital Basic Price: 54.95 - PackageCode: '018' PackageName: Hi-Speed Residential Price: 49.95 - PackageCode: '024' PackageName: Superphone Unlimited Price: 59.95 - PackageCode: TRC PackageName: Discount Tracking Code Price: -15 examples: example-008316: value: - PackageCode: TRB PackageName: Retention Discount - -20 Price: -20 - PackageCode: '001' PackageName: 10-Star Digital Basic Price: 54.95 - PackageCode: '018' PackageName: Hi-Speed Residential Price: 49.95 - PackageCode: '024' PackageName: Superphone Unlimited Price: 59.95 - PackageCode: TRC PackageName: Discount Tracking Code Price: -15 '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/packages/sis: get: tags: - Subscriber summary: GetSIS description: Get subscriber service information summary operationId: GetSIS parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriberPackagesSisResponse' - example: Packages: - ServiceClass: Code: VID Name: Video Code: '001' Name: 10-Star Digital Basic Quantity: 1 Price: 24.95 Taxes: 0 - ServiceClass: Code: VID Name: Video Code: TRC Name: Discount Tracking Code Quantity: 1 Price: 0 Taxes: 0 - ServiceClass: Code: VID Name: Video Code: TRB Name: Retention Discount - -20 Quantity: 1 Price: 0 Taxes: 0 - ServiceClass: Code: INT Name: Internet Code: '018' Name: Hi-Speed Residential Quantity: 1 Price: 49.95 Taxes: 0 - ServiceClass: Code: PHN Name: Phone Code: '024' Name: Superphone Unlimited Quantity: 1 Price: 59.95 Taxes: 5.6 - ServiceClass: Code: OTH Name: Other Code: '001' Name: 10-Star Digital Basic Quantity: 1 Price: 30 Taxes: 0 Discounts: - ServiceClass: Code: VID Name: Video Code: TRD Name: Retention Discount - $15 Discount: -15 Taxes: -1.65 - ServiceClass: Code: VID Name: Video Code: TRE Name: Retention Discount - $20 Discount: -20 Taxes: 0 TaxesAndFees: - ServiceClass: Code: '384' Name: Taxes and Fees Code: CI1 Name: City Sales Tax Amount: 0.6 - ServiceClass: Code: '384' Name: Taxes and Fees Code: FR1 Name: Franchise Fee Amount: 1.25 - ServiceClass: Code: '384' Name: Taxes and Fees Code: ST1 Name: State Sales Tax Amount: 2.1 examples: example-008316: value: Packages: - ServiceClass: Code: VID Name: Video Code: '001' Name: 10-Star Digital Basic Quantity: 1 Price: 24.95 Taxes: 0 - ServiceClass: Code: VID Name: Video Code: TRC Name: Discount Tracking Code Quantity: 1 Price: 0 Taxes: 0 - ServiceClass: Code: VID Name: Video Code: TRB Name: Retention Discount - -20 Quantity: 1 Price: 0 Taxes: 0 - ServiceClass: Code: INT Name: Internet Code: '018' Name: Hi-Speed Residential Quantity: 1 Price: 49.95 Taxes: 0 - ServiceClass: Code: PHN Name: Phone Code: '024' Name: Superphone Unlimited Quantity: 1 Price: 59.95 Taxes: 5.6 - ServiceClass: Code: OTH Name: Other Code: '001' Name: 10-Star Digital Basic Quantity: 1 Price: 30 Taxes: 0 Discounts: - ServiceClass: Code: VID Name: Video Code: TRD Name: Retention Discount - $15 Discount: -15 Taxes: -1.65 - ServiceClass: Code: VID Name: Video Code: TRE Name: Retention Discount - $20 Discount: -20 Taxes: 0 TaxesAndFees: - ServiceClass: Code: '384' Name: Taxes and Fees Code: CI1 Name: City Sales Tax Amount: 0.6 - ServiceClass: Code: '384' Name: Taxes and Fees Code: FR1 Name: Franchise Fee Amount: 1.25 - ServiceClass: Code: '384' Name: Taxes and Fees Code: ST1 Name: State Sales Tax Amount: 2.1 '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/packages/summary: get: tags: - Subscriber summary: GetSubscriberPackageSummary description: Get subscriber package summary operationId: GetSubscriberPackageSummary parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriberPackagesSummaryResponse' - example: RecurringCharges: 164.85 RecurringDiscounts: -35 TimedBilling: 0 TimedPromoDiscounts: 0 AfterDiscounts: 129.85 TotalTaxed: 133.8 examples: example-008316: value: RecurringCharges: 164.85 RecurringDiscounts: -35 TimedBilling: 0 TimedPromoDiscounts: 0 AfterDiscounts: 129.85 TotalTaxed: 133.8 '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/transactions/last/{X}: get: tags: - Subscriber summary: GetLastSubscriberTransactions description: Get last X transactions operationId: GetLastSubscriberTransactions parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: X in: path description: Last X transactions required: true style: simple schema: type: integer format: int32 - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberTransactionsLastResponse' description: Last X Transactions (X provided by third-party using API) example: - Type: Code: PAY Name: Payment Date: 2021-02-10 Amount: -243.03 - Type: Code: LAT Name: Late Charge Date: 2021-01-25 Amount: 5 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: -56.13 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 - Type: Code: PRO Name: ProRated Date: 2020-12-07 Amount: 0 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: -42.1 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 - Type: Code: PRO Name: ProRated Date: 2020-12-07 Amount: 0 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 examples: example-008316: value: - Type: Code: PAY Name: Payment Date: 2021-02-10 Amount: -243.03 - Type: Code: LAT Name: Late Charge Date: 2021-01-25 Amount: 5 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: -56.13 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 - Type: Code: PRO Name: ProRated Date: 2020-12-07 Amount: 0 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: -42.1 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 - Type: Code: PRO Name: ProRated Date: 2020-12-07 Amount: 0 - Type: Code: DIS Name: Discount Date: 2020-12-29 Amount: 0 '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/equipment: get: tags: - Equipment - Subscriber summary: GetSubscriberEquipment description: Get subscriber equipment operationId: GetSubscriberEquipment parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '200': description: Successful Operation. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriberEquipmentResponse' description: List of Equipment on the Customer/Subscriber Account example: - EquipmentID: '0001094803040206' SecondaryID: '' Serial: M90646FGF529 Type: Code: CVT Name: Converter Make: Code: MOT Name: Motorola Model: Code: M70 Name: DCT 700 Two-Way RF Status: Code: RES Name: Residential HeadEnd: Code: DAC Name: DAC 6000 Hub: Code: D11 Name: Location 1 (DAC 6000) Refreshable: true SingleFamilyUnit: true - EquipmentID: '0001094803229005' SecondaryID: '' Serial: M90646FGF530 Type: Code: CVT Name: Converter Make: Code: MOT Name: Motorola Model: Code: M70 Name: DCT 700 Two-Way RF Status: Code: RES Name: Residential HeadEnd: Code: DAC Name: DAC 6000 Hub: Code: D11 Name: Location 1 (DAC 6000) Refreshable: true SingleFamilyUnit: true - EquipmentID: '0001094804017209' SecondaryID: '' Serial: M90646FGF531 Type: Code: CVT Name: Converter Make: Code: MOT Name: Motorola Model: Code: M70 Name: DCT 700 Two-Way RF Status: Code: RES Name: Residential HeadEnd: Code: DAC Name: DAC 6000 Hub: Code: D11 Name: Location 1 (DAC 6000) Refreshable: true SingleFamilyUnit: true - EquipmentID: 0005CA433DC4 SecondaryID: '' Serial: '' Type: Code: CMD Name: Cable Modem Make: Code: MOT Name: Motorola Model: Code: '612' Name: SurfBoard 6121 (Modems) Status: Code: RES Name: Residential HeadEnd: Code: SPG Name: SPG Data and Voice Hub: Code: S51 Name: Location 1 (SPG D&V) Refreshable: true SingleFamilyUnit: true examples: example-008316: value: - EquipmentID: '0001094803040206' SecondaryID: '' Serial: M90646FGF529 Type: Code: CVT Name: Converter Make: Code: MOT Name: Motorola Model: Code: M70 Name: DCT 700 Two-Way RF Status: Code: RES Name: Residential HeadEnd: Code: DAC Name: DAC 6000 Hub: Code: D11 Name: Location 1 (DAC 6000) Refreshable: true SingleFamilyUnit: true - EquipmentID: '0001094803229005' SecondaryID: '' Serial: M90646FGF530 Type: Code: CVT Name: Converter Make: Code: MOT Name: Motorola Model: Code: M70 Name: DCT 700 Two-Way RF Status: Code: RES Name: Residential HeadEnd: Code: DAC Name: DAC 6000 Hub: Code: D11 Name: Location 1 (DAC 6000) Refreshable: true SingleFamilyUnit: true - EquipmentID: '0001094804017209' SecondaryID: '' Serial: M90646FGF531 Type: Code: CVT Name: Converter Make: Code: MOT Name: Motorola Model: Code: M70 Name: DCT 700 Two-Way RF Status: Code: RES Name: Residential HeadEnd: Code: DAC Name: DAC 6000 Hub: Code: D11 Name: Location 1 (DAC 6000) Refreshable: true SingleFamilyUnit: true - EquipmentID: 0005CA433DC4 SecondaryID: '' Serial: '' Type: Code: CMD Name: Cable Modem Make: Code: MOT Name: Motorola Model: Code: '612' Name: SurfBoard 6121 (Modems) Status: Code: RES Name: Residential HeadEnd: Code: SPG Name: SPG Data and Voice Hub: Code: S51 Name: Location 1 (SPG D&V) Refreshable: true SingleFamilyUnit: true '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Subscriber Not Found: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/equipment/refresh/all: get: tags: - Equipment - Subscriber summary: RefreshAllEquipment description: Refresh all equipment operationId: RefreshAllEquipment parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string responses: '204': description: Successful Operation. headers: {} content: {} '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Invalid Subscriber value: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /subscriber/{ACCOUNT}/equipment/refresh: post: tags: - Equipment - Subscriber summary: RefreshEquipment description: Refresh equipment operationId: RefreshEquipment parameters: - name: ACCOUNT in: path description: 'Subscriber Account #' required: true style: simple schema: maxLength: 9 minLength: 6 pattern: ^[0-9]+ type: string example: '123456203' - name: Authorization in: header description: '' required: true style: simple schema: type: string requestBody: description: List of unformated equipment ID (MAC address), serial or equipment port object. content: application/json: schema: type: array items: oneOf: - maxLength: 45 type: string example: '0000310770580' - $ref: '#/components/schemas/SubscriberEquipmentRefreshRequest' description: List of unformated equipment ID (MAC address), serial or equipment port object. example: - 00A0C914C8291 - 00A0C914C830 examples: MAC Address list: value: - 00A0C914C8291 - 00A0C914C830 Serial List: value: - GI1044TAA274 - GI1044TAA275 Single Port Refresh: value: - EquipmentID: ONUCLX1 PortTypeCode: DGE PortId: 1 required: true responses: '204': description: Successful Operation. headers: {} content: {} '400': description: The request was malformed headers: {} content: {} '401': description: Unauthorized headers: {} content: {} '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' Invalid Subscriber value: schema: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false security: - basicAuth: [] /equipment/{EQUIPMENTID}/action/{ACTIONCODE}: get: tags: - Equipment summary: PerformActionCode description: Perform action code operationId: PerformActionCode parameters: - name: EQUIPMENTID in: path description: Equipment ID required: true style: simple schema: maxLe