POST api/UrbanRuralIndicator/GetUrbanRuralIndicatorBulk

Urban rural Indicator Bulk

Request Information

URI Parameters

None.

Body Parameters

List of latitude and longitude

Name	Description	Type	Additional information
ClientTrackingId	A client supplied tracking string	string	None.
InputParams	A list of addresses to get serviceability information about	Collection of RequestParam	None.

Request Formats

application/json, text/json

Sample:

{
  "clientTrackingId": "sample string 1",
  "inputParams": [
    {
      "latitude": "sample string 1",
      "longitude": "sample string 2"
    },
    {
      "latitude": "sample string 1",
      "longitude": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<MidasUrbanRuralIndicatorRequestBulk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Charter.Models">
  <ClientTrackingId>sample string 1</ClientTrackingId>
  <InputParams>
    <RequestParam>
      <Latitude>sample string 1</Latitude>
      <Longitude>sample string 2</Longitude>
    </RequestParam>
    <RequestParam>
      <Latitude>sample string 1</Latitude>
      <Longitude>sample string 2</Longitude>
    </RequestParam>
  </InputParams>
</MidasUrbanRuralIndicatorRequestBulk>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MidasUrbanRuralIndicatorRequestBulk'.

Response Information

Resource Description

success

MidasUrbanRuralIndicatorResponseBulk

Name	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		ServiceReturnStatus	None.
UrbanRuralIndicatorResults	Result data for each submitted address	Collection of UrbanRuralIndicatorResult	None.

Response Formats

application/json, text/json

Sample:

{
  "urbanRuralIndicatorResults": [
    {
      "latitude": "sample string 1",
      "longitude": "sample string 2",
      "urbanIndicator": "sample string 3",
      "prismUrbanIndicator": 4,
      "rdofType": "sample string 5"
    },
    {
      "latitude": "sample string 1",
      "longitude": "sample string 2",
      "urbanIndicator": "sample string 3",
      "prismUrbanIndicator": 4,
      "rdofType": "sample string 5"
    }
  ],
  "clientId": "sample string 1",
  "clientTrackingId": "sample string 2",
  "serviceReturnStatus": {
    "responseCode": 1,
    "responseMessage": "sample string 2",
    "currentPeriodRequestsUsed": 3,
    "currentPeriodRequestsAvailable": 4
  }
}

application/xml, text/xml

Sample:

<MidasUrbanRuralIndicatorResponseBulk 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>
  <UrbanRuralIndicatorResults>
    <UrbanRuralIndicatorResult>
      <Latitude>sample string 1</Latitude>
      <Longitude>sample string 2</Longitude>
      <RDOFType>sample string 5</RDOFType>
      <UrbanIndicator>sample string 3</UrbanIndicator>
    </UrbanRuralIndicatorResult>
    <UrbanRuralIndicatorResult>
      <Latitude>sample string 1</Latitude>
      <Longitude>sample string 2</Longitude>
      <RDOFType>sample string 5</RDOFType>
      <UrbanIndicator>sample string 3</UrbanIndicator>
    </UrbanRuralIndicatorResult>
  </UrbanRuralIndicatorResults>
</MidasUrbanRuralIndicatorResponseBulk>