AT&T DevEx

Omni APIs Central | Wireline Solutions | Shop New Fiber

List or find address objects

Version 1.0.0
download iconDownload spec

Endpoint

POST
https://sales-internal-api-test-e2.az.3pc.att.com/msapi/salesapi/sales-business-process-layer-papi-test3/v1/qualified-addresses

This operation retrieves all the associated addresses for the given address type. This api orchestrates the calls in similar way as /query-service-qualification. If the given address type is a service address a list of all qualified service addresses is retrieved. For a billing or shipping address type, a generic operation to retrieve address list from various sources is called.

arrowSecurity

http

Enter the username and password here for authorization.
scheme:basic
arrowRequest

Header Parameters

        Query Parameters

            Body Parameters

            Responses

            Success

            arrowBody

            application/json

            REQUEST

            1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
            curl --request POST \
     --url 'https://sales-internal-api-test-e2.az.3pc.att.com/msapi/salesapi/sales-business-process-layer-papi-test3/v1/qualified-addresses?addressType=service&validate=boolean' \
     --header 'accept: application/json;charset=utf-8' \
     --header 'content-type: application/json' \
     --header 'idpctx-linkeduverseaccnums: 144656129' \
     --header 'idpctx-linkedwirelineaccnums: string' \
     --header 'idpctx-uuid: 557409171' \
     --data '
{
  "channel": {
    "name": "SelfService",
    "role": "customer"
  },
  "cartId": "f4f53120-9e73-11ec-b017-4df92759f1bf"
}
'

            RESPONSE

            1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
            {
  "addresses": [
    {
      "priority": 1,
      "validationResult": "success",
      "geographicAddress": {
        "id": "0000196C3S",
        "city": "BROOKFIELD",
        "stateOrProvince": "WI",
        "postcode": "53005",
        "addressCharacteristic": [
          {
            "name": "addressLine1",
            "value": "13445 BURLAWN PKWY"
          },
          {
            "name": "cityAbbreviatedName",
            "value": "BROOKFIELD"
          }
        ]
      },
      "validationTypeRecommendation": [
        {
          "validationType": "BILLING",
          "validationRecommendation": "ACCEPT"
        }
      ]
    }
  ]
}