{ "openapi": "3.1.0", "info": { "title": "ADI Quote API", "version": "1.0.5", "contact": { "name": "Product Owner", "url": "https://pricing-api.it.att.com/", "email": "pk755u@att.com" }, "description": "True North Next Gen pricing capability providing digital PO&M and realtime pricing experience" }, "servers": [ { "url": "https://pricing-api.dev.att.com", "description": "Dev server" } ], "tags": [ { "name": "createPriceEstimate", "description": "Pricing estimation method to get ADI product specific pricing" }, { "name": "healthCheck", "description": "Required healthcheck endpoint" } ], "paths": { "/adi-quotes": { "post": { "tags": [ "createPriceEstimate" ], "summary": "Create a new Price Estimate", "description": "Pricing estimation method to get ADI product specific pricing", "operationId": "createPriceEstimate", "security": [ { "bearerAuth": [] } ], "requestBody": { "description": "Parameters required to create quote", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "required": { "type": "object", "properties": { "geoId": { "type": "string", "description": "Represents unique site address identifier. In this version building level GLID is assumed. MoW is not supported.", "example": "00010Y4547" }, "customerId": { "type": "string", "description": "Represents CoEID in this version. Later it should be CIMS.", "example": "00000A" }, "termDuration": { "type": "integer", "description": "Represents contract term duration.", "enum": [ 12, 24, 36, 60 ], "example": 36 } }, "required": [ "geoId", "termDuration" ] }, "designOptions": { "$ref": "#/components/schemas/DesignOptions" }, "compatibility": { "$ref": "#/components/schemas/Compatibility" }, "usGeoCoding": { "$ref": "#/components/schemas/UsGeoCoding" }, "optionals": { "$ref": "#/components/schemas/Optionals" } }, "required": [ "required", "usGeoCoding", "compatibility", "designOptions", "optionals" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingsResponse200" } } } }, "201": { "description": "Created response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingsResponse201" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingsResponse400" } } } }, "422": { "description": "Unprocessable Content (input validation errors)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingsResponse422" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingsResponse500" } } } } } } }, "/ping": { "get": { "tags": [ "healthCheck" ], "summary": "Health check endpoint", "description": "Required healthcheck endpoint", "operationId": "healthCheck", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "pong" } } } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "DesignOptions": { "type": "object", "properties": { "accessSpeed": { "type": "integer", "description": "Represents desired access speed rate expressed in 1 Megabits", "example": 10000 }, "switched": { "type": "boolean", "description": "Defines the architecture for network access options Switched true, Dedicated false", "example": false }, "accessInterconnectTechnology": { "type": "boolean", "description": "Details the interconnect technology used for access - Direct - true, Gateway - false", "example": true }, "accessTransport": { "type": "boolean", "description": "Specifies the type of transport required for access. Valid values include Ethernet - true, Broadband - false", "example": true }, "onnetCheck": { "type": "boolean", "description": "Required field to check OnNet status. Valid values are Yes - True or No - false", "example": true }, "preferredVendor": { "type": "array", "items": { "type": "string", "description": "Represents list of names of the preferred vendors. Related to Out of footprint.", "example": "AT&T" } }, "avoidedVendor": { "type": "array", "items": { "type": "string", "description": "Represents list of names of the vendors to avoid. Related to Out of footprint.", "example": "AT&T" } }, "portSpeed": { "type": "integer", "description": "Represents desired port speed rate expressed in 1 Megabits.", "example": 1000 }, "physicalInterface": { "type": "string", "description": "Represents desired interface termination.", "enum": [ "10BaseTX Electrical", "10BaseT Electrical", "100BaseTX Electrical", "100BaseT Electrical", "100BaseFX Optical MMF", "1000BaseTX Electrical", "1000BaseT Electrical", "1000BaseZX Optical SMF", "1000BaseSX Optical MMF", "1000BaseLX Optical SMF", "10GBaseLR SMF", "10GBaseLW SMF", "10GBaseER SMF", "10GBaseEW SMF", "10GBaseSR MMF", "10GBaseSW MMF", "10GBaseZR SMF", "10GBaseZW SMF", "40GBaseSR4", "40GBaseLR4", "40GBaseFR", "40GBaseCR4", "40G OTU3 LR4", "40G OTU3 FR", "40G OTU3 ER4", "100GBaseSR10", "100GBaseER4", "100GBaseLR4", "100GBaseSR4", "100G OTU4 LR4", "100G OTU4 ER4", "1000 Base T", "1000 Base TX", "40GBaseER4" ], "example": "10GBaseLR SMF" } }, "required": [ "accessSpeed", "portSpeed", "physicalInterface" ] }, "Compatibility": { "type": "object", "properties": { "billing": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "USD" ], "description": "Represents currency used for given price.", "example": "USD" }, "portMBC": { "type": "integer", "description": "Represents MBC port for billing.", "example": 1 }, "billingOption": { "type": "string", "enum": [ "flat", "usage" ], "description": "Represents billing options for ADI.", "example": "flat" } }, "required": [ "billingOption" ] }, "algo": { "type": "object", "properties": { "routerPrice": { "type": "number", "format": "float", "description": "Represents the router price.", "example": 123.45 }, "portPrice": { "type": "number", "format": "float", "description": "Represents the port price.", "example": 234.56 } }, "required": [ "routerPrice", "portPrice" ] } }, "required": [ "algo", "billing" ] }, "UsGeoCoding": { "type": "object", "properties": { "standardAddress": { "type": "string", "description": "Represents the address in standardized form.", "example": "2270 LAKESIDE BLVD,RICHARDSON,TX,75082-4304" }, "city": { "type": "string", "description": "Represents city name.", "example": "RICHARDSON" }, "state": { "type": "string", "description": "Represents state code.", "enum": [ "NJ", "NY", "CA", "CO", "FL", "GA", "VA", "KY", "TX", "AK", "AL", "AR", "AZ", "CT", "DC", "DE", "HI", "ID", "IL", "IN", "IA", "KS", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NM", "NV", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "UT", "VT", "WA", "WV", "WI", "WY", "VI" ], "example": "TX" }, "streetAddress": { "type": "string", "description": "Represents street name.", "example": "2270 LAKESIDE BLVD" }, "zipCode": { "type": "string", "description": "Represents the main ZIP code.", "example": "75082" }, "zipCodeExt": { "type": "string", "description": "Represents the ZIP code extension.", "example": "4304" }, "custLatitude": { "type": "number", "format": "float", "description": "Represents the latitude for site location.", "example": -96.709767 }, "custLongitude": { "type": "number", "format": "float", "description": "Represents the longitude for site location.", "example": 32.980095 }, "hCoordinate": { "type": "string", "description": "Represents the horizontal coordinate for site location.", "example": "04035" }, "vCoordinate": { "type": "string", "description": "Represents the vertical coordinate for site location.", "example": "08391" }, "geoTransactionId": { "type": "string", "description": "Represents the customer provided id.", "example": "71525113444442370" }, "matchStatus": { "type": "string", "description": "Represents the match status.", "example": "M" }, "matchLevel": { "type": "string", "description": "Represents the match level.", "example": "Street" }, "matchScore": { "type": "string", "description": "Represents the match score.", "example": "890" }, "swClli": { "type": "string", "description": "Represents the swClli attribute.", "example": "DLLSTXRN" }, "ilecVendor": { "type": "string", "description": "Represents the LEC vendor.", "example": "SOUTHWESTERN BELL" }, "territoryIndicator": { "type": "string", "description": "Represents the territory indicator.", "example": "Y" }, "npanxx": { "type": "string", "description": "Represents the npanxx.", "example": "972231" }, "locator": { "type": "string", "description": "Represents the locator system.", "example": "EGM" }, "requestTime": { "type": "string", "format": "date-time", "description": "Represents date-time of request.", "example": "2024-09-20T11:47:30.173Z" }, "acceptAddrTime": { "type": "string", "format": "date-time", "description": "Represents date-time of request acceptance.", "example": "2024-09-20T11:47:30.173Z" }, "responseTime": { "type": "string", "format": "date-time", "description": "Represents date-time of response.", "example": "2024-09-20T11:47:30.173Z" }, "matchIndicator": { "type": "string", "description": "Represents the match indicator.", "example": "S00" }, "lata": { "type": "string", "description": "Represents the lata.", "example": "552" } }, "required": [ "standardAddress", "city", "state", "streetAddress", "zipCode", "custLatitude", "custLongitude", "hCoordinate", "vCoordinate", "geoTransactionId", "matchStatus", "matchLevel", "matchScore", "swClli", "ilecVendor", "territoryIndicator", "npanxx", "locator", "requestTime", "acceptAddrTime", "responseTime", "matchIndicator", "lata" ] }, "Optionals": { "type": "object", "properties": { "circuitCount": { "type": "integer", "description": "Desired number of circuits per Pricing Quote", "example": 1 }, "managed": { "type": "string", "description": "Represents selection between Customer managed and AT&T managed", "enum": [ "Customer", "AT&T" ], "example": "AT&T" }, "channel": { "type": "string", "description": "Represents sourcing channel for pricing request, so it could be paired within requesting application", "example": "Direct" }, "pricingSessionID": { "type": "string", "description": "Request ID for REST client, so the responses could be paired with requests", "example": "a5cbaa30-bbfd-4e2c-88c6-480ad424f1e3" }, "macd": { "type": "boolean", "description": "Represents options new start vs macd", "example": true } }, "required": [ "managed" ] }, "igloo": { "type": "object", "properties": { "quoteMemberId": { "type": "string", "example": "a7ldx000000EUO1AAO-0QLdx000000cf8bGAA" }, "customerName": { "type": "string", "example": "" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "2115 REXFORD RD" }, "city": { "type": "string", "example": "CHAR" }, "postalCode": { "type": "string", "example": "28211" }, "postalCodeExtension": { "type": "string", "example": "3550" }, "province": { "type": "string", "example": "NC" }, "countryIso": { "type": "string", "example": "United States" } } }, "latitude": { "type": "number", "format": "float", "example": -80.830688 }, "longitude": { "type": "number", "format": "float", "example": 35.158172 }, "npanxx": { "type": "string", "example": "704362" }, "visibilityType": { "type": "string", "example": "3" }, "probBuildDesc": { "type": "string", "example": "IF THE SELECTED VENDOR IS WINDSTREAM KDL OR XCHANGE THE ETHERNET ACCESS WILL BE PROVIDED VIA A FIXED WIRELESS SOLUTION" }, "probBuildWithRes": { "type": "string", "example": "FWRLS" }, "matchStatus": { "type": "string", "example": "M" }, "matchLevel": { "type": "string", "example": "Street" }, "matchScore": { "type": "string", "example": "890" }, "accessArrangement": { "type": "string", "example": "Total Service" }, "bandwidthQuote": { "type": "object", "properties": { "ethernetTokenId": { "type": "string", "example": "ETH1029JVL" }, "errorMessage": { "type": "string", "example": "" }, "discountPercentage": { "type": "number", "format": "float", "example": 0 }, "quoteRequestDate": { "type": "string", "example": "01/16/2025" }, "pricingTier": { "type": "string", "example": "0" }, "billableMileage": { "type": "number", "format": "float", "example": 0 }, "swcToSwcMileage": { "type": "number", "format": "float", "example": 5 }, "pricingZone": { "type": "string", "example": "2A" }, "serviceGuideEligible": { "type": "string", "example": "True" }, "customerPrefVendors": { "type": "array", "items": { "type": "object", "properties": { "preferredVendorName": { "type": "string", "example": "VendorName" } } } }, "customerAvoidedVendors": { "type": "array", "items": { "type": "object", "properties": { "avoidedVendorName": { "type": "string", "example": "VendorName" } } } }, "accessSupplier": { "type": "object", "properties": { "ituCode": { "type": "string", "example": "5181" }, "pmtu": { "type": "string", "example": "1500" }, "supplierName": { "type": "string", "example": "BELLSOUTH" }, "mtuSupportMessage": { "type": "string", "example": "" }, "leadTime": { "type": "integer", "example": -1 }, "node": { "type": "object", "properties": { "clli": { "type": "string", "example": "CHRLNCCA" }, "localCurrency": { "type": "string", "example": "USD" }, "clecLnsSwClli": { "type": "string", "example": "" }, "swclli": { "type": "string", "example": "CHRLNCCA" }, "quoteExpirationDate": { "type": "string", "example": "04/16/2025" }, "ethPseudoNpanxx": { "type": "string", "example": "" }, "coverageIndicator": { "type": "string", "example": "Found-Firm" }, "quoteQualifiedAsRequested": { "type": "string", "example": "True" }, "bandwidthMet": { "type": "string", "example": "Yes" }, "architectureMet": { "type": "string", "example": "Yes" }, "vendorPreferenceRequested": { "type": "boolean", "example": false }, "serialNumber": { "type": "string", "example": "71414676S" }, "rulesDerivedMessage": { "type": "string", "example": "Filter Vendor based on calculated final VSI, select one with lowest" }, "providerProductName": { "type": "string", "example": "OEM-AC" }, "quoteDaysTtl": { "type": "integer", "example": 90 }, "usClecDisplays": { "type": "array", "items": { "type": "object", "properties": { "usClecDisplay": { "type": "string", "example": "2406| {CHRLNC92} - 2115 REXFORD RD , CHARLOTTE, NC - " } } } }, "contractTerm": { "type": "object", "properties": { "oneTimePriceUsd": { "type": "number", "format": "float", "example": 0 }, "baseMonthlyPriceLocal": { "type": "number", "format": "float", "example": 925 }, "baseMonthlyPriceUsd": { "type": "number", "format": "float", "example": 925 }, "monthlyPriceLocal": { "type": "number", "format": "float", "example": 925 }, "monthlyPriceUsd": { "type": "number", "format": "float", "example": 925 }, "contractDuration": { "type": "string", "example": "36" }, "oneTimePriceLocal": { "type": "number", "format": "float", "example": 0 } } } } } } } } }, "ethernetIoc": { "type": "string", "example": "NO" }, "availability": { "type": "string", "example": "Yes" }, "productDesignDetails": { "type": "object", "properties": { "service": { "type": "string", "example": "MIS" }, "accessTransport": { "type": "string", "example": "Ethernet" }, "accessArchitecture": { "type": "string", "example": "Switched" }, "accessTechnology": { "type": "string", "example": "Ethernet" }, "accessTail": { "type": "string", "example": "ESP ETH Shared" }, "accessInterconnectTechnology": { "type": "string", "example": "Gateway Interconnect" }, "cmtu": { "type": "string", "example": "1500" }, "portLevelCos": { "type": "string", "example": "No" }, "accessSpeed": { "type": "string", "example": "500mbps" }, "accessSpeedRequested": { "type": "string", "example": "500mbps" }, "accessArchitectureRequested": { "type": "string", "example": "Switched" }, "physicalInterface": { "type": "string", "example": "1000BaseSX Optical MMF" }, "onnetCheck": { "type": "string", "example": "No" }, "zone": { "type": "string", "example": "Eth LC SW Zone2A BLS Select SWC" } } }, "responseMessage": { "type": "string", "example": "response" } } }, "PricingsResponse200": { "type": "object", "properties": { "status": { "type": "integer" }, "responseData": { "type": "object", "properties": { "pricingSessionID": { "type": "string", "description": "Unique quote identifier" }, "accessPrice": { "type": "number", "format": "float", "description": "Access price" }, "portPrice": { "type": "number", "format": "float", "description": "Port price" }, "routerPrice": { "type": "number", "format": "float", "description": "Router price" }, "totalPrice": { "type": "number", "format": "float", "description": "Total price" }, "currency": { "type": "string", "description": "Currency", "example": "USD" }, "discountPercent": { "type": "number", "format": "float", "description": "Discount information" }, "ethernetToken": { "type": "string", "description": "Ethernet Token defining access design" }, "contractDuration": { "type": "number", "format": "float", "description": "Contract duration" }, "message": { "type": "string", "description": "Success message" }, "channel": { "type": "string", "description": "Sourcing channel information", "example": "direct" }, "igloo": { "type": "object", "description": "Design element from IGLOO", "$ref": "#/components/schemas/igloo" }, "priceId": { "type": "string", "description": "Unique quote identifier" } } }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "timestamp" ] }, "PricingsResponse201": { "type": "object", "properties": { "status": { "type": "integer" }, "responseData": { "type": "object", "properties": { "pricingSessionID": { "type": "string", "description": "Unique quote identifier" }, "accessPrice": { "type": "number", "format": "float", "description": "Access price" }, "portPrice": { "type": "number", "format": "float", "description": "Port price" }, "routerPrice": { "type": "number", "format": "float", "description": "Router price" }, "totalPrice": { "type": "number", "format": "float", "description": "Total price" }, "currency": { "type": "string", "description": "Currency", "example": "USD" }, "discountPercent": { "type": "number", "format": "float", "description": "Discount information", "example": 10 }, "ethernetToken": { "type": "string", "description": "Ethernet Token defining access design", "example": "ETH12345" }, "contractDuration": { "type": "number", "format": "float", "description": "Contract duration" }, "message": { "type": "string", "description": "Success message", "example": "Operation successful" }, "channel": { "type": "string", "description": "Sourcing channel information", "example": "direct" }, "igloo": { "type": "object", "description": "Design element from IGLOO", "$ref": "#/components/schemas/igloo" }, "priceId": { "type": "string", "description": "Unique Identifier for pricing" } } }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "timestamp", "responseData" ] }, "PricingsResponse400": { "type": "object", "properties": { "status": { "type": "integer" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "object" } }, "required": [ "message" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "status", "errorDetail" ] }, "PricingsResponse422": { "type": "object", "properties": { "status": { "type": "integer" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "object" } }, "required": [ "message" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "status", "errorDetail" ] }, "PricingsResponse500": { "type": "object", "properties": { "status": { "type": "integer" }, "errorDetail": { "type": "object", "properties": { "message": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "object" } }, "required": [ "message" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "status", "errorDetail" ] } } } }