POST api/v1/zipcodes/nearest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
GeoCoordinate	GeoCoordinateDto	None.
ApiKey	globally unique identifier	Required
ApplicationVersion	integer	Required
Udid	string	Required
UserID	globally unique identifier	Required
ZoneID	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "GeoCoordinate": {
    "Longitude": 1.1,
    "Latitude": 2.1
  },
  "ApiKey": "166b3b36-b6ca-4fe2-ae40-8151aed5b226",
  "ApplicationVersion": 2,
  "Udid": "sample string 3",
  "UserID": "b769a9a2-17c5-4322-893b-b29c90bc39b7",
  "ZoneID": 5
}

application/xml, text/xml

Sample:

<NearestZipCodeApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.ZipCodes.Nearest">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">166b3b36-b6ca-4fe2-ae40-8151aed5b226</ApiKey>
  <ApplicationVersion xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">2</ApplicationVersion>
  <Udid xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">sample string 3</Udid>
  <UserID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">b769a9a2-17c5-4322-893b-b29c90bc39b7</UserID>
  <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">5</ZoneID>
  <GeoCoordinate xmlns:d2p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.library.DTOs">
    <d2p1:Latitude>2.1</d2p1:Latitude>
    <d2p1:Longitude>1.1</d2p1:Longitude>
  </GeoCoordinate>
</NearestZipCodeApiRequest>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.