GET api/CarrierServiceability/GetCarrierUSServiceability?trackingId={trackingId}&address={address}&city={city}&state={state}&zip={zip}&clientAddressKey={clientAddressKey}
Carrier Serviceability for Single Address
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
trackingId |
An ID supplied by the client to track or name this request |
string |
Required |
address |
Main Address with optional suite information |
string |
Required |
city |
City |
string |
Required |
state |
State abbreviation |
string |
Required |
zip |
Five digit ZIPCode |
string |
Required |
clientAddressKey |
ID of the address |
string |
Default value is Not Supplied |
Body Parameters
None.
Response Information
Resource Description
success
MidasCarrierUSServiceabilityResponseName | Description | Type | Additional information |
---|---|---|---|
ClientId |
The name of the client using the service |
string |
None. |
ClientTrackingId |
A client supplied tracking string that is parrotted back to the client here |
string |
None. |
ServiceReturnStatus |
Status information about the response for the submitted addresses |
ServiceReturnStatus |
None. |
CarrierServiceabilityResult |
Result data for submitted address |
CarrierUSServiceabilityResult |
None. |
Response Formats
application/json, text/json
Sample:
{ "ClientId": "sample string 1", "ClientTrackingId": "sample string 2", "ServiceReturnStatus": { "ResponseCode": 1, "ResponseMessage": "sample string 2", "CurrentPeriodRequestsUsed": 3, "CurrentPeriodRequestsAvailable": 4 }, "CarrierServiceabilityResult": { "AddressStatus": { "StatusCode": 1, "StatusMessage": "sample string 2" }, "ClientAddressKey": "sample string 1", "RequestNumber": 2, "ValidatedAddress": { "MapPoint": { "Longitude": 1.0, "Latitude": 2.0 }, "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "ZipCode": "sample string 5" }, "RequestAddress": { "ClientAddressKey": "sample string 1", "Address": "sample string 2", "City": "sample string 3", "State": "sample string 4", "Zipcode": "sample string 5" }, "Serviceability": { "BuildingKey": 1, "Lata": "sample string 2", "ClliCode": "sample string 3", "WholesaleFiberStatus": "sample string 4", "InstallationInterval": "sample string 5", "PricingTier": "sample string 6", "LegacyFootprint": "sample string 7" } } }
application/xml, text/xml
Sample:
<MidasCarrierUSServiceabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Charter.Models"> <CarrierServiceabilityResult> <AddressStatus> <StatusCode>1</StatusCode> <StatusMessage>sample string 2</StatusMessage> </AddressStatus> <ClientAddressKey>sample string 1</ClientAddressKey> <RequestAddress> <Address>sample string 2</Address> <City>sample string 3</City> <ClientAddressKey>sample string 1</ClientAddressKey> <State>sample string 4</State> <Zipcode>sample string 5</Zipcode> </RequestAddress> <RequestNumber>2</RequestNumber> <Serviceability> <BuildingKey>1</BuildingKey> <ClliCode>sample string 3</ClliCode> <InstallationInterval>sample string 5</InstallationInterval> <Lata>sample string 2</Lata> <LegacyFootprint>sample string 7</LegacyFootprint> <PricingTier>sample string 6</PricingTier> <WholesaleFiberStatus>sample string 4</WholesaleFiberStatus> </Serviceability> <ValidatedAddress> <Address1>sample string 1</Address1> <Address2>sample string 2</Address2> <City>sample string 3</City> <MapPoint> <Latitude>2</Latitude> <Longitude>1</Longitude> </MapPoint> <State>sample string 4</State> <ZipCode>sample string 5</ZipCode> </ValidatedAddress> </CarrierServiceabilityResult> <ClientId>sample string 1</ClientId> <ClientTrackingId>sample string 2</ClientTrackingId> <ServiceReturnStatus> <CurrentPeriodRequestsAvailable>4</CurrentPeriodRequestsAvailable> <CurrentPeriodRequestsUsed>3</CurrentPeriodRequestsUsed> <ResponseCode>1</ResponseCode> <ResponseMessage>sample string 2</ResponseMessage> </ServiceReturnStatus> </MidasCarrierUSServiceabilityResponse>