{
  "openapi": "3.1.2",
  "info": {
    "version": "1.0.2",
    "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"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Service Qualification response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceQualificationResponse"
                },
                "examples": {
                  "servicequalification_with_No_Qualification_response": {
                    "summary": "Service Qualification With No Qualification Items",
                    "x-tags": [
                      "Fiber-Provide-Consumer",
                      "Fiber-Move-Consumer",
                      "Fiber-Change-Consumer"
                    ],
                    "$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"
                    ],
                    "$ref": "#/components/examples/ServiceQualification_with_No_Offers"
                  }
                }
              }
            }
          },
          "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"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "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": "UNSUPPORTED FLOW",
                            "message": "Broadband service is not available at this address; however, AIA is available. Because AIA isn’t supported through this service, please switch to the legacy AT&T AIA workflow"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "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."
          },
          "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"
                  ]
                },
                "customerType": {
                  "description": "Customer Type to be used for filtering offers. e.g. CONSUMER, IRU, CRU.",
                  "maxLength": 100,
                  "minLength": 2,
                  "type": "string",
                  "enum": [
                    "CONSUMER",
                    "IRU",
                    "CRU"
                  ]
                },
                "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."
          },
          "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."
              }
            }
          }
        }
      },
      "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"
          },
          "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"
                }
              }
            }
          }
        }
      },
      "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"
                      },
                      "displayName": {
                        "type": "string",
                        "description": "Display 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": {
                      "category": {
                        "type": "string",
                        "description": "Category of the service"
                      },
                      "name": {
                        "type": "string",
                        "description": "Name of the service"
                      },
                      "serviceType": {
                        "type": "string",
                        "description": "Type of the service"
                      },
                      "available": {
                        "type": "boolean",
                        "description": "Indicates whether the service is available at the address"
                      }
                    },
                    "description": "Name of the service"
                  }
                }
              }
            }
          }
        }
      },
      "Address": {
        "type": "object",
        "properties": {
          "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."
      },
      "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"
            }
          },
          "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": {
          "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"
            }
          },
          "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"
          },
          "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"
          }
        }
      }
    },
    "parameters": {
      "ParameterAppname": {
        "name": "appname",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "Application name making the request"
      }
    },
    "examples": {
      "ServiceQualification_with_No_Qualification": {
        "value": {
          "addressValidation": {
            "validationResult": "success",
            "validGeographicAddress": {
              "id": "00011TAJVD",
              "streetNr": "4005",
              "streetName": "OHIO",
              "streetType": "DR",
              "city": "PLANO",
              "stateOrProvince": "TX",
              "postcode": "75093"
            }
          },
          "serviceQualification": [
            {}
          ]
        }
      },
      "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"
                      }
                    ]
                  }
                }
              ]
            }
          ],
          "offers": {}
        }
      }
    }
  }
}