{ "openapi": "3.1.3", "info": { "version": "1.0.5", "title": "extpartneromnisvcsms", "description": "This is an OpenAPI Specification for APIs for external partners to perform ServiceQualification checks.", "contact": { "name": "Omni API Support", "email": "DL-OmniAdapter@att.com" } }, "servers": [ { "url": "https://partner.att.com/omni-svcs" } ], "security": [], "tags": [ { "name": "Service Qualification", "description": "Omni Service Qualification " } ], "paths": { "/v1/service-qualification": { "post": { "tags": [ "Service Qualification" ], "description": "Allows external partners to verify whether a given service address and Postal code are eligible for fiber connectivity.", "summary": "Service qualification based on address", "operationId": "ServiceQualification", "parameters": [ { "$ref": "#/components/parameters/ParameterAppname" } ], "requestBody": { "description": "Service Qualification request payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceQualificationRequest" }, "examples": { "ServiceQualification_perfect_match_location_attributes": { "summary": "Service Qualification Perfect Match with Location Attributes", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer" ], "value": { "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "subChannel", "value": "bestbuy" }, { "name": "subChannelGroup", "value": "National Retail" }, { "name": "agentId", "value": "s12345" } ] }, "geographicAddress": { "id": "00010GZFZX" }, "customerType": "CONSUMER" } }, "servicequalification_with_addressId": { "summary": "Service Qualificaiton with addressId", "value": { "geographicAddress": { "id": "00000QS4QU" }, "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "subChannel", "value": "bestbuy" }, { "name": "subChannelGroup", "value": "National Retail" }, { "name": "agentId", "value": "s12345" } ] }, "customerType": "CONSUMER" } } } } } }, "responses": { "200": { "description": "Service Qualification response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceQualificationResponse" }, "examples": { "servicequalification_perfect_match_location_attributes": { "summary": "Service Qualification Perfect Match with Location Attributes", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer" ], "$ref": "#/components/examples/ServiceQual_Perfectmatch_LocationAttributes_response" }, "servicequalification_with_No_Qualification_response": { "summary": "Service Qualification With No Qualification Items", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQualification_with_No_Qualification" }, "servicequalification_with_NoOffers_response": { "summary": "Service Qualification With No Offers", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQualification_with_No_Offers" }, "servicequal_noaddressmatch": { "summary": "Service Qualification No Address Match", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "value": { "addressValidation": { "validationResult": "nomatch" } } }, "servicequalification_with_addressId_w_streetDirection": { "summary": "Service Qualification with Address Id returning Street Direction", "$ref": "#/components/examples/ServiceQual_with_street_direction_response" }, "servicequalification_with_partial_response_error_retrieving_offers": { "summary": "Service Qualification With Partial Failure Error Retrieving Offers", "description": "Service Qualification With Partial Failure Error Retrieving Offers", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQualification_partial_response_with_offer_failure" }, "servicequalification_with_partial_response_error_retrieving_qualification_inventory": { "summary": "Service Qualification With Partial Failure Error Retrieving Qualification & Inventory", "description": "Service Qualification With Partial Failure Error Retrieving Qualification & Inventory", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQualification_partial_response_with_qualification_failure" }, "servicequalification_wsc_existing_service": { "summary": "Service Qualification WSC - Existing Service", "description": "Working service conflict response with an existing service.", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQual_WSC_Existing_Service" }, "servicequalification_wsc_pending_provide": { "summary": "Service Qualification WSC - Pending Provide", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQual_WSC_Pending_Provide_response" }, "servicequalification_wsc_pending_disconnect": { "summary": "Service Qualification WSC - Pending Disconnect", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQual_WSC_Pending_Disconnect_response" }, "servicequalification_no_wsc": { "summary": "Service Qualification No WSC", "x-tags": [ "Fiber-Provide-Consumer", "Fiber-Move-Consumer", "Fiber-Change-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "$ref": "#/components/examples/ServiceQual_NO_WSC_response" } } } } }, "400": { "description": "Bad request - Missing fields, Invalid input data, validation failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "MissingFields": { "summary": "Missing fields", "value": { "error": { "errorId": "EXT_SERVICE_QUAL-SBPL-0001", "message": "Required fields are missing", "errorSystemId": "Service Qualification", "details": [ { "code": "SBP-S100003", "message": "Postal Code is Invalid" } ] } } } } } } }, "429": { "description": "Rate limiting - Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "ServiceQualificationSystemError": { "summary": "System Error", "value": { "error": { "errorId": "EXT_SERVICE_QUAL-SBPL-500", "message": "System Error", "errorSystemId": "Service Qualification", "details": [ { "code": "SBP-S10003", "message": "system error" } ] } } }, "ServiceQualificationAIAError": { "summary": "AIA Error", "value": { "error": { "errorId": "EXTPNO-OFFERS-CPOPOFFER-0006", "message": "Unsupported Flow", "errorSystemId": "extpartnerproductoffersdiscovery", "details": [ { "code": "INT-0010", "message": "AIA is not supported yet, please switch to regular AT&T internet AIR flow" } ] } } } } } } } } } } }, "components": { "schemas": { "ServiceQualificationRequest": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/SalesChannel", "description": "Information about the sales channel and sub-channel through which the service qualification request is being made." }, "geographicAddress": { "$ref": "#/components/schemas/Address", "description": "The service address for which the service qualification check needs to be performed." }, "customerType": { "description": "Customer Type to be used for filtering offers. e.g. CONSUMER, IRU, CRU, BUSINESS.", "maxLength": 100, "minLength": 2, "type": "string", "enum": [ "CONSUMER", "IRU", "CRU", "BUSINESS" ] }, "offers": { "type": "array", "description": "List of offers to check for eligibility during service qualification. For Move orders, billingAccountNumber and intent fields are also used for offer filtering.", "items": { "type": "object", "properties": { "productOfferingTypeGroup": { "type": "string", "description": "The productOfferingTypeGroup field is used to identify the type of offer (e.g., BBOffers for broadband offers)", "enum": [ "mobilePlan", "mobileAddon", "mobileDevice", "mobileOffer", "sim", "BBAddons", "BBOffers" ] }, "billingAccountNumber": { "type": "string", "description": "Customer Billing Account Number", "example": "123456789" }, "intent": { "type": "string", "description": "Intent of the flow (e.g., MOVE). For the Provide flow, this will be empty.", "example": "MOVE" } } } } } }, "ServiceQualificationResponse": { "type": "object", "properties": { "addressValidation": { "$ref": "#/components/schemas/AddressValidation", "description": "Results of address validation, including a valid geographic addresses and an address match code indicating the quality of the match between the input address and the validated addresses." }, "serviceQualification": { "$ref": "#/components/schemas/ServiceQualification", "description": "Service qualification results for the given address, including service qualification items and service inventory." }, "serviceCharacteristic": { "type": "array", "description": "Populated with the list of serviceCharacteristic if the validationResult is a perfect match.", "items": { "$ref": "#/components/schemas/ServiceCharacteristic" } }, "swimlaneList": { "type": "array", "description": "List of swim lane configurations for each available plan at a successfully qualified address.", "items": { "type": "object", "properties": { "plan": { "type": "string", "description": "Plan identifier", "example": "Hsia1000g" }, "swimlane": { "type": "string", "description": "Swim lane identifier for the plan", "example": "29" }, "planTier": { "type": "string", "description": "Plan tier designation", "example": "D" }, "planMRCBillingOffer": { "type": "string", "description": "Monthly Recurring Charge (MRC) billing offer identifier for the plan", "example": "88541733" }, "BBFootPrint": { "type": "string", "description": "Broadband footprint indicator describing the service delivery method", "example": "FiberKitOptional" }, "PSid": { "type": "string", "description": "Product Service identifier", "example": "NA001" } } } }, "offers": { "type": "object", "description": "List of Offers that are eligible for the given address.", "properties": { "BBOffers": { "$ref": "#/components/schemas/OfferList", "description": "BBOffers that are eligible for the given address. This field is only returned if the request includes offers with productOfferingTypeGroup as BBOffers. If there are no eligible BBOffers, this field will be returned as an empty list." } } }, "error": { "$ref": "#/components/schemas/PartnerServiceError", "description": "Use to report partial response failures" } } }, "OfferList": { "type": "array", "description": "List of offers that are eligible for the given address. Each offer includes details such as the offer name, description, and other relevant characteristics.", "items": { "$ref": "#/components/schemas/ProductOffering" } }, "ValidGeographicAddress": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Place Id for the address" }, "streetNr": { "type": "string", "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" }, "streetDirection": { "type": "string", "description": "Direction of the street" }, "streetName": { "type": "string", "description": "Name of the street or other street type" }, "streetType": { "type": "string", "description": "Type of the street. Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf" }, "streetSuffix": { "type": "string", "description": "Street Suffix that the address is in" }, "city": { "type": "string", "description": "City that the address is in" }, "stateOrProvince": { "type": "string", "description": "The State or Province that the address is in" }, "postcode": { "type": "string", "description": "Descriptor for a postal delivery area, used to speed and simplify the delivery of mail." }, "postcodeExtension": { "type": "string", "description": "4 digit extension of the postcode" }, "country": { "type": "string", "description": "Country that the address is in" }, "completeTimeZone": { "type": "string", "description": "Complete time zone information for the address" }, "geographicSubAddress": { "type": "array", "items": { "type": "object", "properties": { "subUnitType": { "type": "string", "description": "The type of subunit\ne.g. BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" }, "subUnitNumber": { "type": "string", "description": "The discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" }, "structureType": { "type": "string", "description": "Type of the Structure" }, "structureValue": { "type": "string", "description": "Value of the Structure" }, "buildingName": { "type": "string", "description": "Name of the building" }, "levelNumber": { "type": "string", "description": "Level number of the address" }, "levelType": { "type": "string", "description": "Type of the level" }, "subAddressType": { "type": "string", "description": "The type of subaddress, e.g. APARTMENT, FLOOR, SUITE" } } } } } }, "AddressValidation": { "type": "object", "properties": { "validationResult": { "type": "string", "description": "Address Match Code." }, "validGeographicAddress": { "$ref": "#/components/schemas/ValidGeographicAddress", "description": "Populated with the validated address if the validationResult is a perfect match." }, "alternateGeographicAddress": { "type": "array", "description": "Populated with the list of addresses if there are multiple matches or MDU (Multiple Dwelling Units)", "items": { "$ref": "#/components/schemas/ValidGeographicAddress" } } } }, "ServiceQualification": { "type": "array", "items": { "type": "object", "properties": { "queryServiceQualificationDate": { "type": "string", "format": "date-time", "description": "The date and time when the service qualification check was performed." }, "serviceQualificationItem": { "type": "array", "description": "A list of service qualification items.", "items": { "type": "object", "description": "A service qualification item providing details about the service category and service.", "properties": { "category": { "type": "object", "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", "properties": { "name": { "type": "string", "description": "Name of the category" }, "displayName": { "type": "string", "description": "Display name of the category" } } }, "service": { "type": "object", "properties": { "category": { "type": "string" }, "displayName": { "type": "string", "description": "Display name of the service" }, "serviceType": { "type": "string" }, "serviceCharacteristic": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service characteristic" }, "valueType": { "type": "string", "description": "Type of the value" }, "value": { "type": "string", "description": "Value of the service characteristic" } }, "description": "A list of characteristics that characterize this service e.g. QualificationResult, Priority, TransportTypes " } } }, "description": "Name of the service" } } } }, "serviceInventory": { "type": "array", "description": "A list of existing services at the address.", "items": { "type": "object", "properties": { "category": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the category" } }, "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories." }, "service": { "type": "object", "properties": { "serviceType": { "type": "string", "description": "Type of the service" }, "accountDetails": { "type": "array", "description": "Account details associated with the existing service.", "items": { "type": "object", "properties": { "accountStatusCode": { "type": "string", "description": "Status code of the account (e.g., A, pendingDisconnect, pendingOrder)" }, "customerTypeCode": { "type": "string", "description": "Customer type code (e.g., R for residential, B for business)" }, "migrationIndicator": { "type": "boolean", "description": "Indicates if the account is migrating from xDSL" } } } } }, "description": "An existing service at the address." } } } } } } }, "Address": { "type": "object", "properties": { "id": { "type": "string", "description": "Address Id for the address, if id is present all other address fields are ignored." }, "postcode": { "type": "string", "description": "Descriptor for a postal delivery area, used to speed and simplify the delivery of mail.", "example": "91911" }, "city": { "type": "string", "description": "City that the address is in", "example": "CHULA VISTA" }, "stateOrProvince": { "type": "string", "description": "The State or Province that the address is in", "example": "CA" }, "addressCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/AddressCharacteristic" } } } }, "AddressCharacteristic": { "type": "object", "properties": { "name": { "type": "string", "description": "Key of addressLine1 from Address characteristic.", "example": "addressLine1" }, "valueType": { "type": "string", "example": "string" }, "value": { "type": "string", "description": "Value of addressLine1 from Address characteristic.", "example": "3802 EAST MAIN ST" } }, "description": "Representation of a GeographicSubAddress\nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building." }, "ServiceCharacteristic": { "properties": { "name": { "type": "string", "description": "Name of the service characteristic" }, "valueType": { "type": "string", "description": "Type of the value" }, "value": { "type": "string", "description": "Value of the service characteristic" } }, "description": "A list of characteristics that characterize this service e.g. DwellingType, InstantHSIAOnIndicator, icoServingWireCenterCLLI, legalEntity, exchangeCode, primaryNpaNxx, rateCenterCode, rateZone, rateZoneBandCode, tarCode, buildingType, videoHubOffice " }, "SalesChannel": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a channel eg. IND." }, "name": { "type": "string", "description": "Name of the channel eg. IND." }, "extensions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the characteristic", "enum": [ "subChannelGroup", "subChannel", "agentId" ] }, "value": { "type": "string", "description": "Value of the characteristic" } } } } }, "description": "Sales channel through which the customer is being served." }, "PriceRef": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "description": "Price amount without tax", "properties": { "unit": { "type": "string", "description": "Currency unit of the price amount, if this field is empty assume USD", "example": "USD" }, "value": { "description": "Numeric value of the price amount", "type": "number" } } }, "marketingAmount": { "type": "object", "description": "Marketing amount is the price which business wants to show to customer which may exclude certain limited time promotions to show more accurate price over longer duration", "properties": { "unit": { "type": "string", "description": "Currency unit of the marketing amount, if this field is empty assume USD", "example": "USD" }, "value": { "type": "number", "description": "Numeric value of the marketing amount", "example": 60.99 } } } } }, "PriceAlterationRef": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the price e.g. Discount", "example": "Discount" }, "priceType": { "type": "string", "description": "Price type of the price alteration e.g. RC, OC", "example": "RC" }, "immediatePromotionId": { "type": "string", "description": "Reference to the promotion instance Id that is applied as part of this price alteration", "example": "RC" }, "chargeType": { "type": "string", "description": "Charge type of the price alteration", "example": "credit", "enum": [ "credit", "debit", "discount" ] }, "price": { "type": "object", "description": "Price alteration amount", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of price", "example": "USD" }, "value": { "type": "number", "description": "Numeric value of the price alteration", "example": 10 } } } } } } }, "ProductOfferingPrice": { "type": "object", "properties": { "name": { "type": "string", "description": "Optional field depicting Name of the price", "example": "Easy self-setup kit Price" }, "priceCategory": { "type": "string", "description": "Optional field depicting Price category", "example": "serviceRC" }, "priceType": { "type": "string", "description": "Price type", "example": "RC" }, "recurringChargePeriod": { "type": "string", "description": "Recurring charge period", "example": "month", "enum": [ "month", "week" ] }, "recurringChargePeriodLength": { "type": "number", "description": "Length of the recurring charge period", "example": 1 }, "role": { "type": "string", "description": "Role of the price", "example": "Price", "enum": [ "Price", "Bundle Price Alteration" ] }, "price": { "$ref": "#/components/schemas/PriceRef" }, "finalPrice": { "$ref": "#/components/schemas/PriceRef" }, "standalonePrice": { "$ref": "#/components/schemas/PriceRef" }, "priceAlteration": { "type": "array", "description": "List of price alterations that are applied on the price such as promotions", "items": { "$ref": "#/components/schemas/PriceAlterationRef" } }, "productOfferingPrice": { "type": "object", "description": "Hyperlocal Pricing Strategy attributes", "properties": { "id": { "type": "string", "description": "Hyperlocal pricing strategy id", "example": "SO003" }, "name": { "type": "string", "description": "Hyperlocal pricing strategy name", "example": "South East LA" }, "priceType": { "type": "string", "description": "Hyperlocal pricing strategy price type", "example": "Subsidy" } } }, "periodCoverage": { "type": "object", "description": "Hyperlocal Pricing Strategy attributes", "properties": { "startDateTime": { "type": "string", "description": "Start date and time of the hyperlocal pricing strategy", "example": "2024-01-01T00:00:00Z" }, "endDateTime": { "type": "string", "description": "End date and time of the hyperlocal pricing strategy", "example": "2024-12-31T23:59:59Z" } } }, "taxIncluded": { "type": "string", "description": "Indicates whether the price includes tax or not", "example": "Excluded" } } }, "ProductOfferingCharacteristic": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the product offer characteristic", "example": "Payment_Type" }, "localizedName": { "type": "string", "description": "Localized name of the product offer characteristic", "example": "" }, "valueType": { "type": "string", "description": "Value type of the product offer characteristic useful for parsing values of number, or boolean type", "example": "" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "example": "Pay_on_Bill" }, "localizedValue": { "type": "string", "example": "Pay on Bill" }, "default": { "type": "boolean", "example": false } } } } } }, "BundledProductOfferingOption": { "type": "object", "description": "Pricing options for bundled product", "properties": { "numberRelOfferDefault": { "type": "integer", "description": "Default number of related offers to include when selecting this option" }, "numberRelOfferLowerLimit": { "type": "integer", "description": "Lower limit for number of related offers that can be selected" }, "numberRelOfferUpperLimit": { "type": "integer", "description": "Upper limit for number of related offers that can be selected" }, "productOfferingPrice": { "type": "array", "description": "Price of all bundled products and price alterations with promotion references", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "productOfferingTotalPrice": { "type": "array", "description": "Total price of all bundled products with aggregated price alterations by price type", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "productOfferingCharacteristic": { "type": "array", "description": "Bundled product offer options characteristics", "items": { "$ref": "#/components/schemas/ProductOfferingCharacteristic" } } } }, "BundledProductOffering": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the bundled product offering", "example": "c9715944-afed-42eb-a35f-51c2ced6bea4" }, "name": { "type": "string", "description": "Name of the bundled product offering", "example": "Bring Your Own Phone" }, "description": { "type": "string", "description": "Description of the bundled product offering", "example": "Bring Your Own Phone" }, "productOfferingType": { "type": "string", "description": "Type of the bundled product offering", "example": "Mobile_Device" }, "productOfferingTypeGroup": { "type": "string", "description": "Group of the bundled product offering type", "example": "mobileDevice" }, "bundledProductOfferingOption": { "type": "array", "description": "List of options available for the bundled product offering", "items": { "$ref": "#/components/schemas/BundledProductOfferingOption" } }, "conflictingProductOfferIds": { "type": "array", "description": "List of IDs of conflicting product offers for the bundled product offering", "items": { "type": "string", "description": "Product offer ID of a conflicting product offer" } }, "productOfferingTotalPrice": { "type": "array", "description": "Total price of the bundled product offering including promotions", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "BundledProductOfferingGroupOption": { "type": "object", "description": "Shows if multiple options are available of which only one or more needs to be selected e.g. SelfInstallation and TechInstallation", "properties": { "groupOptionId": { "type": "string", "example": "3405d3aa-b60a-11ef-ae7c-27965683c6f2" }, "description": { "type": "string", "description": "Description of the group option", "example": "Select Device" }, "bundledProductOffering": { "type": "array", "description": "List of bundled product offers that are part of this group option", "items": { "$ref": "#/components/schemas/BundledProductOffering" } } } }, "ImmediatePromotionRef": { "type": "object", "properties": { "id": { "type": "string", "description": "Promotion instance Id, used for referencing promotions in priceAlterations", "example": "62900028" }, "status": { "type": "string", "description": "Status of the promotion application", "example": "add", "enum": [ "add", "keep", "revoke", "update" ] }, "promotion": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the promotion", "example": "wrlnpr-62900028" }, "name": { "type": "string", "description": "Name of the promotion", "example": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a bank account. Or $5/mo. with a debit card." }, "description": { "type": "string", "description": "Description of the promotion", "example": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a bank account. Or $5/mo. with a debit card." }, "type": { "type": "string", "description": "Type of the promotion", "example": "discount" }, "applyPolicy": { "type": "string", "description": "Policy for applying the promotion can be manual or automatic", "example": "automatic" }, "promotionCharacteristics": { "type": "array", "description": "List of characteristics of the promotion", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "duration" }, "value": { "type": "string", "example": "999" } } } } } } } }, "ProductOffering": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the product offer, use this for adding to cart or for fetching addons based on this product offer", "example": "06c387fb-bfd5-4287-a1e8-b9da4c0be06e" }, "name": { "type": "string", "description": "Name of the product offer", "example": "Value Plus VL" }, "localizedName": { "type": "string", "description": "Localized name of the product offer based on channel locale", "example": "Value Plus VL" }, "description": { "type": "string", "description": "Description of the product offer", "example": "Value Plus VL" }, "productOfferingType": { "type": "string", "description": "Type of the product offer", "example": "BB_Offer, Mobile_Offer" }, "productOfferingTypeGroup": { "type": "string", "description": "Product offering type is part of this group e.g. mobilePlan, mobileAddon, mobileDevice, mobileOffer, sim, BBOffer, BBPlan, BBInstallation, BBHomeTechProtectionPlan, BBREWARD", "example": "BBOffer" }, "broadbandFactsUrl": { "type": "string", "description": "Url for broadband nutrition label facts for the offer if taxation geocode can be determined from address", "example": "https://test2.att.com/static-content-service-ui/v1/labelfeed/shared/nutrition/CONS/85333ec5-e9aa-4c8e-b886-04afb19e4a6a?taxationgeocode=261830000" }, "bundledProductOffering": { "type": "array", "description": "List of bundled product offers that are part of this product offer", "items": { "$ref": "#/components/schemas/BundledProductOffering" } }, "productOfferingTotalPrice": { "type": "array", "description": "Total price of the bundled offers including promotions", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "bundledProductOfferingGroupOption": { "type": "array", "description": "Shows if multiple options are available of which only one or more needs to be selected e.g. SelfInstallation and TechInstallation", "items": { "$ref": "#/components/schemas/BundledProductOfferingGroupOption" } }, "immediatePromotion": { "type": "array", "description": "List of applicable promotions", "items": { "$ref": "#/components/schemas/ImmediatePromotionRef" } }, "productOfferingCharacteristic": { "type": "array", "description": "List of characteristics of the product offer", "items": { "$ref": "#/components/schemas/ProductOfferingCharacteristic" } } } }, "PartnerServiceError": { "type": "object", "properties": { "errorId": { "type": "string", "example": "Top level error code" }, "message": { "type": "string", "example": "Top level error message" }, "errorSystemId": { "type": "string", "example": "System name" }, "details": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "Detail code 1" }, "message": { "type": "string", "example": "Detail message 1" } } } } } }, "WrappedPartnerServiceError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/PartnerServiceError" } } }, "GatewayError": { "type": "object", "properties": { "error": { "type": "string", "description": "Descriptive Error Message for the failure.", "example": "Quota has been exceeded" } } } }, "parameters": { "ParameterAppname": { "name": "appname", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Application name making the request" } }, "examples": { "ServiceQual_Perfectmatch_LocationAttributes_response": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00010GZFZX", "streetNr": "1801", "streetName": "BAYSIDE", "streetType": "DR", "city": "ROWLETT", "stateOrProvince": "TX", "county": "DALLAS COUNTY", "postcode": "75088", "postcodeExtension": "6705", "country": "US", "geographicSubAddress": [ { "subUnitType": "APT", "subUnitNumber": "9304", "subAddressType": "H" } ], "addressCharacteristic": [ { "name": "addressLine1", "value": "1801 BAYSIDE DR" }, { "name": "addressLine2", "value": "APT 9304" } ] } }, "serviceCharacteristic": [ { "name": "InstantHSIAOnIndicator", "valueType": "string", "value": "false" }, { "name": "icoServingWireCenterCLLI", "valueType": "string", "value": "DLLSTXDA" }, { "name": "legalEntity", "valueType": "string", "value": "TT00" }, { "name": "exchangeCode", "valueType": "string", "value": "PLO" }, { "name": "primaryNpaNxx", "valueType": "string", "value": "214321" }, { "name": "rateCenterCode", "valueType": "string", "value": "PLANO" }, { "name": "rateZone", "valueType": "string", "value": "DALLAS-FT. WORTH, TX" }, { "name": "rateZoneBandCode", "valueType": "string", "value": "623" }, { "name": "tarCode", "valueType": "string", "value": "ZVY" }, { "name": "buildingType", "valueType": "string", "value": "Y" }, { "name": "videoHubOffice", "valueType": "string", "value": "RCSNTX" } ], "serviceQualification": [ { "externalId": "IND", "searchCriteria": { "service": { "place": [ { "id": "00010GZFZX" } ], "serviceCharacteristic": [ { "name": "DwellingType", "valueType": "string", "value": "MDU General" }, { "name": "TitanExistingIndicator", "valueType": "boolean", "value": "true" }, { "name": "RateZoneBandCode", "valueType": "string", "value": "623" }, { "name": "LastTransport", "valueType": "string", "value": "FTTP-GPON" }, { "name": "InstantHSIAOnIndicator", "valueType": "boolean", "value": "false" }, { "name": "NetworkProvider", "valueType": "string", "value": "ATT" } ] } }, "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "description": "AT&T Fiber", "displayName": "AT&T Fiber", "name": "FIBER", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "1" }, { "name": "TransportTypes", "valueType": "string", "value": "FTTP-GPON" }, { "name": "NetworkTransportType", "valueType": "string", "value": "FTTP-GPON" }, { "name": "PreferredNetworkType", "valueType": "string", "value": "FTTP-GPON" }, { "name": "UversePendingOrder", "valueType": "boolean", "value": "false" }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": "false" }, { "name": "MaxDownloadSpeedMbps", "valueType": "number", "value": "1000" }, { "name": "MaxUploadSpeedMbps", "valueType": "number", "value": "1000" }, { "name": "LightGig", "valueType": "boolean", "value": "true" }, { "name": "MultiGig", "valueType": "boolean", "value": "false" }, { "name": "GigaPowerAvailabilityIndicator", "valueType": "boolean", "value": "true" }, { "name": "UverseEligible", "valueType": "boolean", "value": "true" }, { "name": "AvailableForSell", "valueType": "boolean", "value": "true" }, { "name": "OpticType", "valueType": "string", "value": "Standard" }, { "name": "OntCategory", "valueType": "string", "value": "INTERNAL" }, { "name": "HomeBasedBusiness", "valueType": "boolean", "value": "true" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "description": "AT&T Internet", "displayName": "AT&T Internet", "name": "HSIA", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "2" }, { "name": "UversePendingOrder", "valueType": "boolean", "value": "false" }, { "name": "LightGreenIndicator", "valueType": "boolean", "value": "false" }, { "name": "MaxDownloadSpeedMbps", "valueType": "number", "value": "0" }, { "name": "MaxUploadSpeedMbps", "valueType": "number", "value": "0" }, { "name": "LightSpeedEligible", "valueType": "boolean", "value": "true" }, { "name": "UverseEligible", "valueType": "boolean", "value": "true" }, { "name": "GigaPowerAvailabilityIndicator", "valueType": "boolean", "value": "true" }, { "name": "InternetBandwidthEligible", "valueType": "boolean", "value": "false" }, { "name": "IpdslInternetEligible", "valueType": "boolean", "value": "false" }, { "name": "IpdslEligible", "valueType": "boolean", "value": "false" }, { "name": "IpdslamBondedPairEligible", "valueType": "boolean", "value": "false" }, { "name": "AvailableForSell", "valueType": "boolean", "value": "true" } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "IPTV", "description": "AT&T IPTV", "displayName": "AT&T IPTV", "name": "IPTV", "serviceType": "IPTV", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "1" } ], "state": "feasibilityChecked" } }, { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "description": "Wireless", "displayName": "Wireless", "name": "WIRELESS", "serviceType": "WIRELESS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "1" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WLL", "description": "AT&T Fixed Wireless", "displayName": "AT&T Fixed Wireless", "name": "WLL", "serviceType": "WLL", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "description": "AT&T Business Fiber", "displayName": "AT&T Business Fiber", "name": "BUSINESS FIBER", "serviceType": "BUSINESS FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "ADSL", "description": "AT&T DSL", "displayName": "AT&T DSL", "name": "ADSL", "serviceType": "ADSL", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WBB", "description": "AT&T Internet Air", "displayName": "AT&T Internet Air", "name": "WBB", "serviceType": "WBB", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "AIA-B", "description": "AT&T Internet Air - Business", "displayName": "AT&T Internet Air - Business", "name": "AIA-B", "serviceType": "AIA-B", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "DTV", "description": "DirectTV", "displayName": "DirectTV", "name": "DTV", "serviceType": "DTV", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "VOIP", "description": "VOIP", "displayName": "VOIP", "name": "VOIP", "serviceType": "VOIP", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "AP-A", "description": "AP-A", "displayName": "AP-A", "name": "AP-A", "serviceType": "AP-A", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "IPDSL Voice", "description": "IPDSL Voice", "displayName": "IPDSL Voice", "name": "IPDSL Voice", "serviceType": "IPDSL Voice", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "POTS", "description": "AT&T POTS", "displayName": "AT&T POTS", "name": "POTS", "serviceType": "POTS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "Wireless Home Phone", "description": "Wireless Home Phone", "displayName": "Wireless Home Phone", "name": "Wireless Home Phone", "serviceType": "Wireless Home Phone", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } }, { "category": { "name": "HOME SECURITY", "displayName": "Home Security" }, "service": { "category": "Digital Life", "description": "Digital Life", "displayName": "Digital Life", "name": "Digital Life", "serviceType": "Digital Life", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "unqualified" } ], "state": "feasibilityChecked" } } ], "serviceInventory": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "name": "FIBER", "serviceType": "FIBER", "available": true } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "ADSL", "name": "ADSL", "serviceType": "ADSL", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "name": "HSIA", "serviceType": "HSIA", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "name": "BUSINESS FIBER", "serviceType": "BUSINESS FIBER", "available": false } }, { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "name": "WIRELESS", "serviceType": "WIRELESS", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WLL", "name": "WLL", "serviceType": "WLL", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "WBB", "name": "WBB", "serviceType": "WBB", "available": false } }, { "category": { "name": "TV" }, "service": { "category": "DTV", "name": "DTV", "serviceType": "DTV", "available": false } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "UVERSE", "name": "UVERSE", "serviceType": "UVERSE", "available": true } }, { "category": { "name": "PHONE", "displayName": "Phone" }, "service": { "category": "VOIP", "name": "VOIP", "serviceType": "VOIP", "available": false } }, { "category": { "name": "TV", "displayName": "TV" }, "service": { "category": "IPTV", "name": "IPTV", "serviceType": "IPTV", "available": false } } ] } ] } }, "ServiceQualification_with_No_Qualification": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "000013Q2A6", "streetNr": "5200", "streetName": "SUMMIT RIDGE", "streetType": "DR", "city": "RENO", "stateOrProvince": "NV", "postcode": "89523", "postcodeExtension": "9014", "country": "USA", "geographicSubAddress": [ { "subUnitType": "APT", "subUnitNumber": "1212" } ] } }, "serviceQualification": [ { "queryServiceQualificationDate": "2026-03-20T16:58:08.848Z" } ] } }, "ServiceQualification_with_No_Offers": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00001Y1AV1", "streetNr": "18504", "streetName": "126TH", "streetType": "AVE", "streetSuffix": "NE", "city": "BOTHELL", "stateOrProvince": "WA", "postcode": "98011", "postcodeExtension": "9318", "country": "USA" } }, "serviceQualification": [ { "queryServiceQualificationDate": "2026-02-09T20:04:28.461425835Z", "serviceQualificationItem": [ { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "displayName": "Wireless", "serviceType": "WIRELESS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "1" } ] } } ] } ], "swimlaneList": [ { "plan": "Hsia5000g", "swimlane": "29", "planTier": "F", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKit", "PSid": "NA001" }, { "plan": "Hsia2000g", "swimlane": "29", "planTier": "E", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKit", "PSid": "NA001" }, { "plan": "Hsia1000g", "swimlane": "29", "planTier": "D", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia500g", "swimlane": "29", "planTier": "C", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia300g", "swimlane": "29", "planTier": "B", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia100g", "swimlane": "29", "planTier": "A", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" } ], "offers": {} } }, "ServiceQual_with_street_direction_response": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00000QS4QU", "streetNr": "1276", "streetDirection": "W", "streetName": "COURT", "streetType": "ST", "city": "LOS ANGELES", "stateOrProvince": "CA", "postcode": "90026", "postcodeExtension": "5664", "country": "USA", "completeTimeZone": "Pacific Time (PST/PDT)", "geographicSubAddress": [ { "subAddressType": "S" } ] } }, "serviceCharacteristic": [ { "name": "InstantHSIAOnIndicator", "valueType": "string", "value": "false" } ], "serviceQualification": [ { "queryServiceQualificationDate": "2025-10-09T20:47:12.05Z", "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "displayName": "AT&T Internet", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "displayName": "AT&T Fiber", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } } ], "serviceInventory": [ { "category": { "name": "INTERNET" }, "service": { "serviceType": "FIBER", "accountDetails": [ { "accountStatusCode": "A", "customerTypeCode": "R", "migrationIndicator": false } ] } }, { "category": { "name": "INTERNET" }, "service": { "serviceType": "HSIA", "accountDetails": [ { "accountStatusCode": "A", "customerTypeCode": "R", "migrationIndicator": false } ] } } ] } ], "swimlaneList": [ { "plan": "Hsia5000g", "swimlane": "29", "planTier": "F", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKit", "PSid": "NA001" }, { "plan": "Hsia2000g", "swimlane": "29", "planTier": "E", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKit", "PSid": "NA001" }, { "plan": "Hsia1000g", "swimlane": "29", "planTier": "D", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia500g", "swimlane": "29", "planTier": "C", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia300g", "swimlane": "29", "planTier": "B", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia100g", "swimlane": "29", "planTier": "A", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" } ] } }, "ServiceQualification_partial_response_with_offer_failure": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00001Y1AV1", "streetNr": "18504", "streetName": "126TH", "streetType": "AVE", "streetSuffix": "NE", "city": "BOTHELL", "stateOrProvince": "WA", "postcode": "98011", "postcodeExtension": "9318", "country": "USA" } }, "serviceQualification": [ { "queryServiceQualificationDate": "2026-02-09T20:04:28.461425835Z", "serviceQualificationItem": [ { "category": { "name": "WLS", "displayName": "Wireless" }, "service": { "category": "WIRELESS", "displayName": "Wireless", "serviceType": "WIRELESS", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" }, { "name": "priority", "valueType": "number", "value": "1" } ] } } ] } ], "swimlaneList": [ { "plan": "Hsia5000g", "swimlane": "29", "planTier": "F", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKit", "PSid": "NA001" }, { "plan": "Hsia2000g", "swimlane": "29", "planTier": "E", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKit", "PSid": "NA001" }, { "plan": "Hsia1000g", "swimlane": "29", "planTier": "D", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia500g", "swimlane": "29", "planTier": "C", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia300g", "swimlane": "29", "planTier": "B", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" }, { "plan": "Hsia100g", "swimlane": "29", "planTier": "A", "planMRCBillingOffer": "88541733", "BBFootPrint": "FiberKitOptional", "PSid": "NA001" } ], "error": { "errorId": "EXTPNO-SERVICE-QUAL-SBPL-0007", "message": "Partial Response Failure", "errorSystemId": "cpopoffer", "details": [ { "code": "INT-0033", "message": "Downstream error occurred while retrieving offers" } ] } } }, "ServiceQualification_partial_response_with_qualification_failure": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00001Y1AV1", "streetNr": "18504", "streetName": "126TH", "streetType": "AVE", "streetSuffix": "NE", "city": "BOTHELL", "stateOrProvince": "WA", "postcode": "98011", "postcodeExtension": "9318", "country": "USA" } }, "error": { "errorId": "EXTPNO-SERVICE-QUAL-SBPL-0007", "message": "Partial Response Failure", "errorSystemId": "Service Qualification", "details": [ { "code": "INT-0032", "message": "Downstream error occurred while retrieving address qualification & existing service inventory" } ] } } }, "ServiceQual_WSC_Existing_Service": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00000NG3XH", "streetNr": "3802", "streetName": "MAIN", "streetType": "ST", "city": "CHULA VISTA", "stateOrProvince": "CA", "postcode": "91911", "postcodeExtension": "6246", "country": "USA", "completeTimeZone": "Pacific Time (PST/PDT)", "geographicSubAddress": [ { "subUnitType": "APT", "subUnitNumber": "5" } ] } }, "serviceQualification": [ { "queryServiceQualificationDate": "2025-10-09T20:47:12.05Z", "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "displayName": "AT&T Internet", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "displayName": "AT&T Fiber", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } } ], "serviceInventory": [ { "category": { "name": "INTERNET" }, "service": { "serviceType": "FIBER", "accountDetails": [ { "accountStatusCode": "active" } ] } } ] } ] } }, "ServiceQual_WSC_Pending_Provide_response": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00000NG3XH", "streetNr": "3802", "streetName": "MAIN", "streetType": "ST", "city": "CHULA VISTA", "stateOrProvince": "CA", "postcode": "91911", "postcodeExtension": "6246", "country": "USA", "completeTimeZone": "Pacific Time (PST/PDT)", "geographicSubAddress": [ { "subUnitType": "APT", "subUnitNumber": "5" } ] } }, "serviceQualification": [ { "queryServiceQualificationDate": "2025-10-09T20:47:12.05Z", "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "displayName": "AT&T Internet", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "displayName": "AT&T Fiber", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } } ], "serviceInventory": [ { "category": { "name": "INTERNET" }, "service": { "serviceType": "FIBER", "accountDetails": [ { "accountStatusCode": "pendingProvide" } ] } } ] } ] } }, "ServiceQual_WSC_Pending_Disconnect_response": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00000NG3XH", "streetNr": "3802", "streetName": "MAIN", "streetType": "ST", "city": "CHULA VISTA", "stateOrProvince": "CA", "postcode": "91911", "postcodeExtension": "6246", "country": "USA", "completeTimeZone": "Pacific Time (PST/PDT)", "geographicSubAddress": [ { "subUnitType": "APT", "subUnitNumber": "5" } ] } }, "serviceQualification": [ { "queryServiceQualificationDate": "2025-10-09T20:47:12.05Z", "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "displayName": "AT&T Internet", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "displayName": "AT&T Fiber", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } } ], "serviceInventory": [ { "category": { "name": "INTERNET" }, "service": { "serviceType": "FIBER", "accountDetails": [ { "accountStatusCode": "pendingDisconnect" } ] } } ] } ] } }, "ServiceQual_NO_WSC_response": { "value": { "addressValidation": { "validationResult": "success", "validGeographicAddress": { "id": "00000NG3XH", "streetNr": "3802", "streetName": "MAIN", "streetType": "ST", "city": "CHULA VISTA", "stateOrProvince": "CA", "postcode": "91911", "postcodeExtension": "6246", "country": "USA", "completeTimeZone": "Pacific Time (PST/PDT)", "geographicSubAddress": [ { "subUnitType": "APT", "subUnitNumber": "5" } ] } }, "serviceQualification": [ { "queryServiceQualificationDate": "2025-10-09T20:47:12.05Z", "serviceQualificationItem": [ { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "HSIA", "displayName": "AT&T Internet", "serviceType": "HSIA", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } }, { "category": { "name": "INTERNET", "displayName": "Internet" }, "service": { "category": "FIBER", "displayName": "AT&T Fiber", "serviceType": "FIBER", "serviceCharacteristic": [ { "name": "QualificationResult", "valueType": "string", "value": "qualified" } ] } } ], "serviceInventory": [ { "category": { "name": "WLS" }, "service": { "serviceType": "WIRELESS", "accountDetails": [ { "accountStatusCode": "A", "customerTypeCode": "R", "migrationIndicator": false } ] } } ] } ] } } } } }