GET api/v1/delivery/eddm/{postalCode}/route/{carrierRouteID}

Request Information

URI Parameters

Name	Description	Type	Additional information
postalCode		string	Required
carrierRouteID		string	Required

Body Parameters

None.

Response Information

Resource Description

EddmRoutePopulation

Name	Type	Additional information
CarrierRouteID	string	None.
ResidentialCount	integer	None.
BusinessCount	integer	None.
TotalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CarrierRouteID": "sample string 1",
  "ResidentialCount": 2,
  "BusinessCount": 3,
  "TotalCount": 4
}

application/xml, text/xml

Sample:

<EddmRoutePopulation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
  <BusinessCount>3</BusinessCount>
  <CarrierRouteID>sample string 1</CarrierRouteID>
  <ResidentialCount>2</ResidentialCount>
  <TotalCount>4</TotalCount>
</EddmRoutePopulation>

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.