POST api/v1/zipcodes/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SearchText	string	Required
NumberOfResults	integer	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:

{
  "SearchText": "sample string 1",
  "NumberOfResults": 2,
  "ApiKey": "454ff23d-abc2-4eae-8f28-f9770d72012e",
  "ApplicationVersion": 4,
  "Udid": "sample string 5",
  "UserID": "06239227-b18a-4a63-bf63-ea5cb33367d6",
  "ZoneID": 7
}

application/xml, text/xml

Sample:

<ZipCodeApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.ZipCodes.Search">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">454ff23d-abc2-4eae-8f28-f9770d72012e</ApiKey>
  <ApplicationVersion xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">4</ApplicationVersion>
  <Udid xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">sample string 5</Udid>
  <UserID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">06239227-b18a-4a63-bf63-ea5cb33367d6</UserID>
  <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">7</ZoneID>
  <NumberOfResults>2</NumberOfResults>
  <SearchText>sample string 1</SearchText>
</ZipCodeApiRequest>

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

Response Information

Resource Description

ZipCodeApiResult

Name	Type	Additional information
TotalCount	integer	None.
Zipcodes	Collection of ZipCode	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "Zipcodes": [
    {
      "GeoCoordinate": {
        "Longitude": 1.1,
        "Latitude": 2.1
      },
      "CleanedZip": "sample string 1",
      "CleanedName": "sample string 2",
      "CleanedText": "sample string 3",
      "ZipCodeID": "4a8cbd52-713b-4f8a-a373-b53ad5243d56",
      "ZoneID": 5,
      "Zip": "sample string 6",
      "Name": "sample string 7",
      "Text": "sample string 6 sample string 7"
    },
    {
      "GeoCoordinate": {
        "Longitude": 1.1,
        "Latitude": 2.1
      },
      "CleanedZip": "sample string 1",
      "CleanedName": "sample string 2",
      "CleanedText": "sample string 3",
      "ZipCodeID": "4a8cbd52-713b-4f8a-a373-b53ad5243d56",
      "ZoneID": 5,
      "Zip": "sample string 6",
      "Name": "sample string 7",
      "Text": "sample string 6 sample string 7"
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<ZipCodeApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.ZipCodes.Search">
  <Success>true</Success>
  <TotalCount>1</TotalCount>
  <Zipcodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">
    <d2p1:ZipCode>
      <d2p1:CleanedName>sample string 2</d2p1:CleanedName>
      <d2p1:CleanedText>sample string 3</d2p1:CleanedText>
      <d2p1:CleanedZip>sample string 1</d2p1:CleanedZip>
      <d2p1:GeoCoordinate xmlns:d4p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.library.DTOs">
        <d4p1:Latitude>2.1</d4p1:Latitude>
        <d4p1:Longitude>1.1</d4p1:Longitude>
      </d2p1:GeoCoordinate>
      <d2p1:Name>sample string 7</d2p1:Name>
      <d2p1:Zip>sample string 6</d2p1:Zip>
      <d2p1:ZipCodeID>4a8cbd52-713b-4f8a-a373-b53ad5243d56</d2p1:ZipCodeID>
      <d2p1:ZoneID>5</d2p1:ZoneID>
    </d2p1:ZipCode>
    <d2p1:ZipCode>
      <d2p1:CleanedName>sample string 2</d2p1:CleanedName>
      <d2p1:CleanedText>sample string 3</d2p1:CleanedText>
      <d2p1:CleanedZip>sample string 1</d2p1:CleanedZip>
      <d2p1:GeoCoordinate xmlns:d4p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.library.DTOs">
        <d4p1:Latitude>2.1</d4p1:Latitude>
        <d4p1:Longitude>1.1</d4p1:Longitude>
      </d2p1:GeoCoordinate>
      <d2p1:Name>sample string 7</d2p1:Name>
      <d2p1:Zip>sample string 6</d2p1:Zip>
      <d2p1:ZipCodeID>4a8cbd52-713b-4f8a-a373-b53ad5243d56</d2p1:ZipCodeID>
      <d2p1:ZoneID>5</d2p1:ZoneID>
    </d2p1:ZipCode>
  </Zipcodes>
</ZipCodeApiResult>