POST Api/Utilities/RetrieveZipCodes

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
VendorExternalSourceCode	string	None.
VendorExternalSourceId	string	None.
StateCode	string	Max length: 2 Min length: 2
Cities	string	None.
SourceZip	string	Max length: 5 Min length: 5
Range	integer	Range: inclusive between 0 and 3000
IncludeAssigned	string	None.
AsOfDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "vendorExternalSourceCode": "sample string 1",
  "vendorExternalSourceId": "sample string 2",
  "stateCode": "sample string 3",
  "cities": "sample string 4",
  "sourceZip": "sample string 5",
  "range": 6,
  "includeAssigned": "sample string 7",
  "asOfDate": "2025-05-02T08:50:25.4690728-05:00"
}

application/xml, text/xml

Sample:

<ZipCodesSearch xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VendorExternalSourceCode>sample string 1</VendorExternalSourceCode>
  <VendorExternalSourceId>sample string 2</VendorExternalSourceId>
  <StateCode>sample string 3</StateCode>
  <Cities>sample string 4</Cities>
  <SourceZip>sample string 5</SourceZip>
  <Range>6</Range>
  <IncludeAssigned>sample string 7</IncludeAssigned>
  <AsOfDate>2025-05-02T08:50:25.4690728-05:00</AsOfDate>
</ZipCodesSearch>

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 'ZipCodesSearch'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.