Inquire market service areas
Version 4.0.0
Endpoint
GET
undefined/geographicSite
Copy
This operation lists or finds Market Service Area entities. (TMF 674)
Query Parameters
- queryStringRequiredqueryString can be ONE OF the following schemas:
- schema#0object
- schema#1object
- schema#2object
- schema#3object
- schema#4object
Header Parameters
- AuthorizationstringRequiredJWT Bearer Token. Token URL: https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-xxxxxx/oauth2/v2.0/token See example below. curl --location --request POST 'https://login.microsoftonline.com/e741d71c-c6b6-47b0-803c-xxxxx/oauth2/v2.0/token' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Cookie: fpc=Aswi39iZZIlGtV66yM1qCANKExLGAQAAAOqRbtgOAAAA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' --data-urlencode 'grant_type=client_credentials' --data-urlencode 'client_id=xxxxx' --data-urlencode 'client_secret=xxxxx.KOKc_V4h__csa3M' Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct one
- AcceptstringRequiredSpecifies the media type as "application/json".
- X-ATT-CorrelationIdstringRecommended format is 32 hexadecimal characters GUID (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX).
Body Parameters
Responses
Success
Body
application/json
- array of objectsRequired
- idstringUnique identifier of the place
- hrefstringUnique reference of the place
- codestringA code that may be used for some addressing schemes eg: [ANSI T1.253-1999]
- namestringThe name of the service area.
- @typestringWhen sub-classing, this defines the sub-class entity name
- statusstringThe condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former
- @baseTypestringWhen sub-classing, this defines the super-class
- descriptionstringText describing additional information regarding the site
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationships
- marketCodestring
- subMarketCodestring
- matchTypestringEnum: [E, C]The relationship of the service area to the location (zipcode, city/state, market) entered. E=Exact Match; C=Closest Match
- technologyarray of stringsThe available technology for this service area
- distancestringThe service area distance
- legacyWirelineFootprintstringThe legacy wireline footprint specified by zipcode (if available).
- isLocalstringThe service area is a local call from the Local Calling Area number supplied in the request
- localMarketTypestringThe local market type which can be either TLG or CPW
- domainstringEnum: [Activation, Portin, AutoAssign]
- npastringSpecified NPA for SubscriberNumber searches
- NumberBlockNPAarray of stringsThe available number blocks for this service area. Only the npa value will be returned. Nxx and line will not.
- zipCodeInfoarray of strings
- countyInfoarray of strings
- internationalPostalCodeInfoarray of strings
[{]}