GET api/UrbanRuralIndicator/GetUrbanRuralIndicator?trackingId={trackingId}&Latitude={Latitude}&Longitude={Longitude}

Urban Rural Indicator for latitude and longitude

Request Information

URI Parameters

NameDescriptionTypeAdditional information
trackingId

An ID supplied by the client to track or name this request

string

Required

Latitude

string

None.

Longitude

string

None.

Body Parameters

None.

Response Information

Resource Description

success

MidasUrbanRuralIndicatorResponse
NameDescriptionTypeAdditional 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.

UrbanRuralServiceabilityResult

Result data for submitted address

UrbanRuralIndicatorResult

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
  },
  "urbanRuralServiceabilityResult": {
    "latitude": "sample string 1",
    "longitude": "sample string 2",
    "urbanIndicator": "sample string 3",
    "prismUrbanIndicator": 4,
    "rdofType": "sample string 5"
  }
}

application/xml, text/xml

Sample:
<MidasUrbanRuralIndicatorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Charter.Models">
  <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>
  <UrbanRuralServiceabilityResult>
    <Latitude>sample string 1</Latitude>
    <Longitude>sample string 2</Longitude>
    <RDOFType>sample string 5</RDOFType>
    <UrbanIndicator>sample string 3</UrbanIndicator>
  </UrbanRuralServiceabilityResult>
</MidasUrbanRuralIndicatorResponse>