YPCListingSearch


Click here for a complete list of operations.

GetListings

Listings request to the YPC API utilizing City, State search term and other parameters passed, and returns a collection of Listings.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
apiID:
term:
searchLoc:
listingCount:
sponsoredCount:
pageNum:
sort:
referrer:
visitorID:
userAgent:
ip:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /YPCListingSearch.asmx HTTP/1.1
Host: acsyellowpages.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Berry.YPCAPI/YPCListingSearch.asmx/GetListings"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetListings xmlns="http://Berry.YPCAPI/YPCListingSearch.asmx">
      <apiID>string</apiID>
      <term>string</term>
      <searchLoc>string</searchLoc>
      <listingCount>int</listingCount>
      <sponsoredCount>int</sponsoredCount>
      <pageNum>int</pageNum>
      <sort>string</sort>
      <referrer>string</referrer>
      <visitorID>string</visitorID>
      <userAgent>string</userAgent>
      <ip>string</ip>
    </GetListings>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetListingsResponse xmlns="http://Berry.YPCAPI/YPCListingSearch.asmx">
      <GetListingsResult>
        <Listing>
          <SearchLoc>string</SearchLoc>
          <AdImageURL>string</AdImageURL>
          <AdImageClick>string</AdImageClick>
          <AdditionalText>string</AdditionalText>
          <AudioURL>string</AudioURL>
          <AverageRating>float</AverageRating>
          <BaseClickURL>string</BaseClickURL>
          <BusinessName>string</BusinessName>
          <Categories>
            <string>string</string>
            <string>string</string>
          </Categories>
          <City>string</City>
          <CouponFlag>boolean</CouponFlag>
          <CouponURL>string</CouponURL>
          <Description>string</Description>
          <DistribAdImage>string</DistribAdImage>
          <DistribAdImageClick>string</DistribAdImageClick>
          <Email>string</Email>
          <HasDisplayAddress>boolean</HasDisplayAddress>
          <HasPriorityShading>boolean</HasPriorityShading>
          <IsRedListing>boolean</IsRedListing>
          <Latitude>float</Latitude>
          <Longitude>float</Longitude>
          <ListingID>string</ListingID>
          <MoreInforURL>string</MoreInforURL>
          <NoAddressMessage>string</NoAddressMessage>
          <OmitAddress>boolean</OmitAddress>
          <OmitPhone>boolean</OmitPhone>
          <OpenHours>string</OpenHours>
          <PaymentMethods>string</PaymentMethods>
          <Phone>string</Phone>
          <PrintAdImage>string</PrintAdImage>
          <PrintAdImageClick>string</PrintAdImageClick>
          <RatingCount>int</RatingCount>
          <RingToNumberDisplay>string</RingToNumberDisplay>
          <SearchResultType>string</SearchResultType>
          <Services>string</Services>
          <Slogan>string</Slogan>
          <State>string</State>
          <Street>string</Street>
          <VideoURL>string</VideoURL>
          <ViewPhone>string</ViewPhone>
          <WebsiteDisplayURL>string</WebsiteDisplayURL>
          <WebsiteURL>string</WebsiteURL>
          <Zip>string</Zip>
          <IsSponsored>boolean</IsSponsored>
          <TotalAvailable>int</TotalAvailable>
        </Listing>
        <Listing>
          <SearchLoc>string</SearchLoc>
          <AdImageURL>string</AdImageURL>
          <AdImageClick>string</AdImageClick>
          <AdditionalText>string</AdditionalText>
          <AudioURL>string</AudioURL>
          <AverageRating>float</AverageRating>
          <BaseClickURL>string</BaseClickURL>
          <BusinessName>string</BusinessName>
          <Categories>
            <string>string</string>
            <string>string</string>
          </Categories>
          <City>string</City>
          <CouponFlag>boolean</CouponFlag>
          <CouponURL>string</CouponURL>
          <Description>string</Description>
          <DistribAdImage>string</DistribAdImage>
          <DistribAdImageClick>string</DistribAdImageClick>
          <Email>string</Email>
          <HasDisplayAddress>boolean</HasDisplayAddress>
          <HasPriorityShading>boolean</HasPriorityShading>
          <IsRedListing>boolean</IsRedListing>
          <Latitude>float</Latitude>
          <Longitude>float</Longitude>
          <ListingID>string</ListingID>
          <MoreInforURL>string</MoreInforURL>
          <NoAddressMessage>string</NoAddressMessage>
          <OmitAddress>boolean</OmitAddress>
          <OmitPhone>boolean</OmitPhone>
          <OpenHours>string</OpenHours>
          <PaymentMethods>string</PaymentMethods>
          <Phone>string</Phone>
          <PrintAdImage>string</PrintAdImage>
          <PrintAdImageClick>string</PrintAdImageClick>
          <RatingCount>int</RatingCount>
          <RingToNumberDisplay>string</RingToNumberDisplay>
          <SearchResultType>string</SearchResultType>
          <Services>string</Services>
          <Slogan>string</Slogan>
          <State>string</State>
          <Street>string</Street>
          <VideoURL>string</VideoURL>
          <ViewPhone>string</ViewPhone>
          <WebsiteDisplayURL>string</WebsiteDisplayURL>
          <WebsiteURL>string</WebsiteURL>
          <Zip>string</Zip>
          <IsSponsored>boolean</IsSponsored>
          <TotalAvailable>int</TotalAvailable>
        </Listing>
      </GetListingsResult>
    </GetListingsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /YPCListingSearch.asmx HTTP/1.1
Host: acsyellowpages.org
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetListings xmlns="http://Berry.YPCAPI/YPCListingSearch.asmx">
      <apiID>string</apiID>
      <term>string</term>
      <searchLoc>string</searchLoc>
      <listingCount>int</listingCount>
      <sponsoredCount>int</sponsoredCount>
      <pageNum>int</pageNum>
      <sort>string</sort>
      <referrer>string</referrer>
      <visitorID>string</visitorID>
      <userAgent>string</userAgent>
      <ip>string</ip>
    </GetListings>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetListingsResponse xmlns="http://Berry.YPCAPI/YPCListingSearch.asmx">
      <GetListingsResult>
        <Listing>
          <SearchLoc>string</SearchLoc>
          <AdImageURL>string</AdImageURL>
          <AdImageClick>string</AdImageClick>
          <AdditionalText>string</AdditionalText>
          <AudioURL>string</AudioURL>
          <AverageRating>float</AverageRating>
          <BaseClickURL>string</BaseClickURL>
          <BusinessName>string</BusinessName>
          <Categories>
            <string>string</string>
            <string>string</string>
          </Categories>
          <City>string</City>
          <CouponFlag>boolean</CouponFlag>
          <CouponURL>string</CouponURL>
          <Description>string</Description>
          <DistribAdImage>string</DistribAdImage>
          <DistribAdImageClick>string</DistribAdImageClick>
          <Email>string</Email>
          <HasDisplayAddress>boolean</HasDisplayAddress>
          <HasPriorityShading>boolean</HasPriorityShading>
          <IsRedListing>boolean</IsRedListing>
          <Latitude>float</Latitude>
          <Longitude>float</Longitude>
          <ListingID>string</ListingID>
          <MoreInforURL>string</MoreInforURL>
          <NoAddressMessage>string</NoAddressMessage>
          <OmitAddress>boolean</OmitAddress>
          <OmitPhone>boolean</OmitPhone>
          <OpenHours>string</OpenHours>
          <PaymentMethods>string</PaymentMethods>
          <Phone>string</Phone>
          <PrintAdImage>string</PrintAdImage>
          <PrintAdImageClick>string</PrintAdImageClick>
          <RatingCount>int</RatingCount>
          <RingToNumberDisplay>string</RingToNumberDisplay>
          <SearchResultType>string</SearchResultType>
          <Services>string</Services>
          <Slogan>string</Slogan>
          <State>string</State>
          <Street>string</Street>
          <VideoURL>string</VideoURL>
          <ViewPhone>string</ViewPhone>
          <WebsiteDisplayURL>string</WebsiteDisplayURL>
          <WebsiteURL>string</WebsiteURL>
          <Zip>string</Zip>
          <IsSponsored>boolean</IsSponsored>
          <TotalAvailable>int</TotalAvailable>
        </Listing>
        <Listing>
          <SearchLoc>string</SearchLoc>
          <AdImageURL>string</AdImageURL>
          <AdImageClick>string</AdImageClick>
          <AdditionalText>string</AdditionalText>
          <AudioURL>string</AudioURL>
          <AverageRating>float</AverageRating>
          <BaseClickURL>string</BaseClickURL>
          <BusinessName>string</BusinessName>
          <Categories>
            <string>string</string>
            <string>string</string>
          </Categories>
          <City>string</City>
          <CouponFlag>boolean</CouponFlag>
          <CouponURL>string</CouponURL>
          <Description>string</Description>
          <DistribAdImage>string</DistribAdImage>
          <DistribAdImageClick>string</DistribAdImageClick>
          <Email>string</Email>
          <HasDisplayAddress>boolean</HasDisplayAddress>
          <HasPriorityShading>boolean</HasPriorityShading>
          <IsRedListing>boolean</IsRedListing>
          <Latitude>float</Latitude>
          <Longitude>float</Longitude>
          <ListingID>string</ListingID>
          <MoreInforURL>string</MoreInforURL>
          <NoAddressMessage>string</NoAddressMessage>
          <OmitAddress>boolean</OmitAddress>
          <OmitPhone>boolean</OmitPhone>
          <OpenHours>string</OpenHours>
          <PaymentMethods>string</PaymentMethods>
          <Phone>string</Phone>
          <PrintAdImage>string</PrintAdImage>
          <PrintAdImageClick>string</PrintAdImageClick>
          <RatingCount>int</RatingCount>
          <RingToNumberDisplay>string</RingToNumberDisplay>
          <SearchResultType>string</SearchResultType>
          <Services>string</Services>
          <Slogan>string</Slogan>
          <State>string</State>
          <Street>string</Street>
          <VideoURL>string</VideoURL>
          <ViewPhone>string</ViewPhone>
          <WebsiteDisplayURL>string</WebsiteDisplayURL>
          <WebsiteURL>string</WebsiteURL>
          <Zip>string</Zip>
          <IsSponsored>boolean</IsSponsored>
          <TotalAvailable>int</TotalAvailable>
        </Listing>
      </GetListingsResult>
    </GetListingsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /YPCListingSearch.asmx/GetListings?apiID=string&term=string&searchLoc=string&listingCount=string&sponsoredCount=string&pageNum=string&sort=string&referrer=string&visitorID=string&userAgent=string&ip=string HTTP/1.1
Host: acsyellowpages.org
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfListing xmlns="http://Berry.YPCAPI/YPCListingSearch.asmx">
  <Listing>
    <SearchLoc>string</SearchLoc>
    <AdImageURL>string</AdImageURL>
    <AdImageClick>string</AdImageClick>
    <AdditionalText>string</AdditionalText>
    <AudioURL>string</AudioURL>
    <AverageRating>float</AverageRating>
    <BaseClickURL>string</BaseClickURL>
    <BusinessName>string</BusinessName>
    <Categories>
      <string>string</string>
      <string>string</string>
    </Categories>
    <City>string</City>
    <CouponFlag>boolean</CouponFlag>
    <CouponURL>string</CouponURL>
    <Description>string</Description>
    <DistribAdImage>string</DistribAdImage>
    <DistribAdImageClick>string</DistribAdImageClick>
    <Email>string</Email>
    <HasDisplayAddress>boolean</HasDisplayAddress>
    <HasPriorityShading>boolean</HasPriorityShading>
    <IsRedListing>boolean</IsRedListing>
    <Latitude>float</Latitude>
    <Longitude>float</Longitude>
    <ListingID>string</ListingID>
    <MoreInforURL>string</MoreInforURL>
    <NoAddressMessage>string</NoAddressMessage>
    <OmitAddress>boolean</OmitAddress>
    <OmitPhone>boolean</OmitPhone>
    <OpenHours>string</OpenHours>
    <PaymentMethods>string</PaymentMethods>
    <Phone>string</Phone>
    <PrintAdImage>string</PrintAdImage>
    <PrintAdImageClick>string</PrintAdImageClick>
    <RatingCount>int</RatingCount>
    <RingToNumberDisplay>string</RingToNumberDisplay>
    <SearchResultType>string</SearchResultType>
    <Services>string</Services>
    <Slogan>string</Slogan>
    <State>string</State>
    <Street>string</Street>
    <VideoURL>string</VideoURL>
    <ViewPhone>string</ViewPhone>
    <WebsiteDisplayURL>string</WebsiteDisplayURL>
    <WebsiteURL>string</WebsiteURL>
    <Zip>string</Zip>
    <IsSponsored>boolean</IsSponsored>
    <TotalAvailable>int</TotalAvailable>
  </Listing>
  <Listing>
    <SearchLoc>string</SearchLoc>
    <AdImageURL>string</AdImageURL>
    <AdImageClick>string</AdImageClick>
    <AdditionalText>string</AdditionalText>
    <AudioURL>string</AudioURL>
    <AverageRating>float</AverageRating>
    <BaseClickURL>string</BaseClickURL>
    <BusinessName>string</BusinessName>
    <Categories>
      <string>string</string>
      <string>string</string>
    </Categories>
    <City>string</City>
    <CouponFlag>boolean</CouponFlag>
    <CouponURL>string</CouponURL>
    <Description>string</Description>
    <DistribAdImage>string</DistribAdImage>
    <DistribAdImageClick>string</DistribAdImageClick>
    <Email>string</Email>
    <HasDisplayAddress>boolean</HasDisplayAddress>
    <HasPriorityShading>boolean</HasPriorityShading>
    <IsRedListing>boolean</IsRedListing>
    <Latitude>float</Latitude>
    <Longitude>float</Longitude>
    <ListingID>string</ListingID>
    <MoreInforURL>string</MoreInforURL>
    <NoAddressMessage>string</NoAddressMessage>
    <OmitAddress>boolean</OmitAddress>
    <OmitPhone>boolean</OmitPhone>
    <OpenHours>string</OpenHours>
    <PaymentMethods>string</PaymentMethods>
    <Phone>string</Phone>
    <PrintAdImage>string</PrintAdImage>
    <PrintAdImageClick>string</PrintAdImageClick>
    <RatingCount>int</RatingCount>
    <RingToNumberDisplay>string</RingToNumberDisplay>
    <SearchResultType>string</SearchResultType>
    <Services>string</Services>
    <Slogan>string</Slogan>
    <State>string</State>
    <Street>string</Street>
    <VideoURL>string</VideoURL>
    <ViewPhone>string</ViewPhone>
    <WebsiteDisplayURL>string</WebsiteDisplayURL>
    <WebsiteURL>string</WebsiteURL>
    <Zip>string</Zip>
    <IsSponsored>boolean</IsSponsored>
    <TotalAvailable>int</TotalAvailable>
  </Listing>
</ArrayOfListing>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /YPCListingSearch.asmx/GetListings HTTP/1.1
Host: acsyellowpages.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apiID=string&term=string&searchLoc=string&listingCount=string&sponsoredCount=string&pageNum=string&sort=string&referrer=string&visitorID=string&userAgent=string&ip=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfListing xmlns="http://Berry.YPCAPI/YPCListingSearch.asmx">
  <Listing>
    <SearchLoc>string</SearchLoc>
    <AdImageURL>string</AdImageURL>
    <AdImageClick>string</AdImageClick>
    <AdditionalText>string</AdditionalText>
    <AudioURL>string</AudioURL>
    <AverageRating>float</AverageRating>
    <BaseClickURL>string</BaseClickURL>
    <BusinessName>string</BusinessName>
    <Categories>
      <string>string</string>
      <string>string</string>
    </Categories>
    <City>string</City>
    <CouponFlag>boolean</CouponFlag>
    <CouponURL>string</CouponURL>
    <Description>string</Description>
    <DistribAdImage>string</DistribAdImage>
    <DistribAdImageClick>string</DistribAdImageClick>
    <Email>string</Email>
    <HasDisplayAddress>boolean</HasDisplayAddress>
    <HasPriorityShading>boolean</HasPriorityShading>
    <IsRedListing>boolean</IsRedListing>
    <Latitude>float</Latitude>
    <Longitude>float</Longitude>
    <ListingID>string</ListingID>
    <MoreInforURL>string</MoreInforURL>
    <NoAddressMessage>string</NoAddressMessage>
    <OmitAddress>boolean</OmitAddress>
    <OmitPhone>boolean</OmitPhone>
    <OpenHours>string</OpenHours>
    <PaymentMethods>string</PaymentMethods>
    <Phone>string</Phone>
    <PrintAdImage>string</PrintAdImage>
    <PrintAdImageClick>string</PrintAdImageClick>
    <RatingCount>int</RatingCount>
    <RingToNumberDisplay>string</RingToNumberDisplay>
    <SearchResultType>string</SearchResultType>
    <Services>string</Services>
    <Slogan>string</Slogan>
    <State>string</State>
    <Street>string</Street>
    <VideoURL>string</VideoURL>
    <ViewPhone>string</ViewPhone>
    <WebsiteDisplayURL>string</WebsiteDisplayURL>
    <WebsiteURL>string</WebsiteURL>
    <Zip>string</Zip>
    <IsSponsored>boolean</IsSponsored>
    <TotalAvailable>int</TotalAvailable>
  </Listing>
  <Listing>
    <SearchLoc>string</SearchLoc>
    <AdImageURL>string</AdImageURL>
    <AdImageClick>string</AdImageClick>
    <AdditionalText>string</AdditionalText>
    <AudioURL>string</AudioURL>
    <AverageRating>float</AverageRating>
    <BaseClickURL>string</BaseClickURL>
    <BusinessName>string</BusinessName>
    <Categories>
      <string>string</string>
      <string>string</string>
    </Categories>
    <City>string</City>
    <CouponFlag>boolean</CouponFlag>
    <CouponURL>string</CouponURL>
    <Description>string</Description>
    <DistribAdImage>string</DistribAdImage>
    <DistribAdImageClick>string</DistribAdImageClick>
    <Email>string</Email>
    <HasDisplayAddress>boolean</HasDisplayAddress>
    <HasPriorityShading>boolean</HasPriorityShading>
    <IsRedListing>boolean</IsRedListing>
    <Latitude>float</Latitude>
    <Longitude>float</Longitude>
    <ListingID>string</ListingID>
    <MoreInforURL>string</MoreInforURL>
    <NoAddressMessage>string</NoAddressMessage>
    <OmitAddress>boolean</OmitAddress>
    <OmitPhone>boolean</OmitPhone>
    <OpenHours>string</OpenHours>
    <PaymentMethods>string</PaymentMethods>
    <Phone>string</Phone>
    <PrintAdImage>string</PrintAdImage>
    <PrintAdImageClick>string</PrintAdImageClick>
    <RatingCount>int</RatingCount>
    <RingToNumberDisplay>string</RingToNumberDisplay>
    <SearchResultType>string</SearchResultType>
    <Services>string</Services>
    <Slogan>string</Slogan>
    <State>string</State>
    <Street>string</Street>
    <VideoURL>string</VideoURL>
    <ViewPhone>string</ViewPhone>
    <WebsiteDisplayURL>string</WebsiteDisplayURL>
    <WebsiteURL>string</WebsiteURL>
    <Zip>string</Zip>
    <IsSponsored>boolean</IsSponsored>
    <TotalAvailable>int</TotalAvailable>
  </Listing>
</ArrayOfListing>