Available services at a geographical address.

Endpoint

GET

https://sales-internal-api-test-e2.az.3pc.att.com/msapi/salesapi/service-qual-management-papi-test2/v2/query-service-qualification

Copy

In the request, the user must provide either the full address (zip code and address line 1) or the addressId (a unique identifier for every address). The service's response, based on the request, could be one of the following: <b> no match, out of footprint, close match, MDU (Multi-Dwelling Unit), existing service, or green address.</b> The serviceQualification object : This contains details about the list of services that are available at that address. This contains 2 objects, serviceQualificationItem and serviceInventory. Apart from salesChannelId and salesChannelType, <i>`either one of these fields is also required - PlaceId, ZipCode, enablerBan, telephoneNumber.`</i>

Security

http

Basic HTTP Authentication with a username and password

scheme:Basic

Request

Query Parameters

Body Parameters

Responses

Success

Body

application/json

REQUEST
curl --request GET \
     --url 'https://sales-internal-api-test-e2.az.3pc.att.com/msapi/salesapi/service-qual-management-papi-test2/v2/query-service-qualification?fields=string&offset=integer&limit=integer&placeId=100001&individualId=456&salesChannelId=WEB&salesChannelType=WEB&agentId=AG456&partnerId=PART101&storeId=S190&zipCode=98011&enablerBan=BAN%20EXAMPLE&telephoneNumber=9876543210&agentOverride=true&overrideServiceName=string&acpEligible=true&customerType=CONSUMER&currentSwimlanes=array&currentPlans=array&migrationAccountNumbers=array&ignoreCache=boolean&serviceType=Fiber&accessEligible=true' \
     --header 'accept: application/json;charset=utf-8'

RESPONSE
[
  {
    "externalId": "WEB",
    "queryServiceQualificationDate": "2021-09-16T15:35:09.574Z",
    "relatedParty": [
      {
        "id": "456",
        "href": "http://serverlocation:port/partyManagement/v4/party/456",
        "name": "John Smith",
        "role": "Buyer contact",
        "@type": "RelatedParty",
        "@referredType": "Individual"
      }
    ],
    "searchCriteria": {
      "service": {
        "place": [
          {
            "id": "100001",
            "role": "Installation Place",
            "@type": "GeographicAddress"
          }
        ]
      }
    },
    "serviceQualificationItem": [
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "WBB",
          "description": "Wireless Broad Band",
          "name": "WBB",
          "serviceType": "string",
          "serviceCharacteristic": [
            {
              "name": "QualificationResult",
              "valueType": "string",
              "value": "qualified"
            },
            {
              "name": "priority",
              "valueType": "number",
              "value": "1"
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "WLL",
          "description": "Wireless Local Loop",
          "name": "WLL",
          "serviceType": "string",
          "serviceCharacteristic": [
            {
              "name": "QualificationResult",
              "valueType": "string",
              "value": "unqualified"
            },
            {
              "name": "priority",
              "valueType": "number",
              "value": "2"
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "TV"
        },
        "service": {
          "category": "LIGHTSPEED-CATEGORY",
          "description": "lightspeed",
          "name": "LIGHTSPEED",
          "serviceType": "string",
          "serviceCharacteristic": [
            {
              "name": "QualificationResult",
              "valueType": "string",
              "value": "qualified"
            },
            {
              "name": "priority",
              "valueType": "number",
              "value": "3"
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "TV"
        },
        "service": {
          "category": "IPTV",
          "description": "iptv",
          "name": "IPTV",
          "serviceType": "string",
          "serviceCharacteristic": [
            {
              "name": "QualificationResult",
              "valueType": "string",
              "value": "QUALIFIED"
            },
            {
              "name": "priority",
              "valueType": "number",
              "value": "4"
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "VOIP"
        },
        "service": {
          "category": "VOIP",
          "description": "Voice Over Internet Protocol",
          "name": "VOIP",
          "serviceType": "string",
          "serviceCharacteristic": [
            {
              "name": "QualificationResult",
              "valueType": "string",
              "value": "UNQUALIFIED"
            },
            {
              "name": "priority",
              "valueType": "number",
              "value": "5"
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "HSIA",
          "description": "High Speed Internet Access",
          "name": "HSIA",
          "serviceType": "string",
          "serviceCharacteristic": [
            {
              "name": "QualificationResult",
              "valueType": "string",
              "value": "qualified"
            },
            {
              "name": "priority",
              "valueType": "number",
              "value": "6"
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "ADSL",
          "description": "ADSL",
          "name": "ADSL",
          "serviceType": "string",
          "serviceCharacteristic": [
            {
              "name": "QualificationResult",
              "valueType": "string",
              "value": "unqualified"
            },
            {
              "name": "priority",
              "valueType": "number",
              "value": "7"
            }
          ],
          "state": "feasibilityChecked"
        }
      }
    ],
    "serviceInventory": [
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "ADSL",
          "description": "ADSL",
          "name": "ADSL",
          "serviceType": "ADSL",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "8980980",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": true
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "HSIA",
          "description": "High Speed Internet Access",
          "name": "HSIA",
          "serviceType": "HSIA",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "986576",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": false
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "UVERSE",
          "description": "AT&T Uverse",
          "name": "UVERSE",
          "serviceType": "UVERSE",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "148703536",
              "accountStatusCode": "A",
              "customerTypeCode": "R",
              "migrationIndicator": false,
              "migrationIneligibleReasons": [
                {
                  "code": "FIBER_AVAILABLE",
                  "description": "Fiber available at location."
                },
                {
                  "code": "PENDING_DISCONNECT",
                  "description": "Customer has pending disconnect.."
                }
              ]
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "WBB",
          "description": "Wireless BroadBand",
          "name": "WBB",
          "serviceType": "WBB",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "23986576",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": false
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "INTERNET"
        },
        "service": {
          "category": "WLL",
          "description": "Wireless Local Loop",
          "name": "WLL",
          "serviceType": "WLL",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "1423986576",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": false
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "TV"
        },
        "service": {
          "category": "DTV",
          "description": "DTV",
          "name": "DTV",
          "serviceType": "DTV",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "51423986576",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": false
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "TV"
        },
        "service": {
          "category": "IPTV",
          "description": "IPTV",
          "name": "IPTV",
          "serviceType": "IPTV",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "81423986576",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": false
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "PHONE"
        },
        "service": {
          "category": "VOIP",
          "description": "VOIP",
          "name": "VOIP",
          "serviceType": "VOIP",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "91423986576",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": false
            }
          ],
          "state": "feasibilityChecked"
        }
      },
      {
        "category": {
          "name": "WLS"
        },
        "service": {
          "category": "WIRELESS",
          "description": "WIRELESS",
          "name": "WIRELESS",
          "serviceType": "WIRELESS",
          "isAvailable": true,
          "accountDetails": [
            {
              "billingAccountNumber": "10423986576",
              "accountStatusCode": "O",
              "customerTypeCode": "R",
              "migrationIndicator": false
            }
          ],
          "state": "feasibilityChecked"
        }
      }
    ],
    "state": "accepted",
    "@baseType": "string",
    "@schemaLocation": "http://uri",
    "@type": "string"
  }
]

AT&T DevEx

Omni APIs Central - Service Qualification Management