=========
Endpoints
=========

.. toctree::
   :maxdepth: 1
   :hidden:

   URL Format <urlformat>
   Search listings <get_listings>
   Search listings (Solr)<get_listings_solr>
   Get listing by ID <get_listings_id>
   Get listing categories <get_listing_categories>
   Get listing images <get_listing_images>
   Add listing <add_listing>
   Update listing <update_listing>
   Delete listing <delete_listing>
   Search categories <get_categories>
   Get an id map <get_listings_map>
   Claim listing <add_listing_claim>
   Unclaim listing <delete_listing_claim>
   Suppress listing <add_listing_suppress>
   Unsuppress listing <delete_listing_suppress>
   Add listing image <add_listing_image>
   Update listing image <update_listing_image>
   Delete listing image <delete_listing_image>
   Get a review <get_listing_review>
   Get listing reviews <get_listing_reviews>
   Add review <add_listing_review>
   Delete review <delete_listing_review>

.. list-table::
    :widths: 50 50

    * - `GET /:country/listings`_
      - Search listings by phone number

    * - `GET /:country/listings/:id`_
      - Fetch a single listing by ID

    * - `GET /:country/listings/:id/categories`_
      - Fetch a single listing's categories

    * - `PUT /:country/listings/:id`_
      - Update a listing

    * - `POST /:country/listings`_
      - Create a new listing

    * - `DELETE /:country/listings/:id`_
      - Delete a listing

    * - `GET /:country/listings/:id/offer`_
      - Gets a offer for a listing

    * - `PUT /:country/listings/:id/offer`_
      - Adds a offer for a listing

    * - `DELETE /:country/listings/:id/offer`_
      - Adds a offer for a listing

    * - `GET /:country/categories`_
      - Fetch a list of available categories

    * - `DELETE /:country/listings/:id/claim`_
      - Unclaim a listing

    * - `GET /:country/listings/map`_
      - Fetch a map of parnter's listing IDs with corresponding Opendi listing
        IDs

    * - `PUT /:country/listings/:id/claim`_
      - Claim a listing

    * - `PUT /:country/listings/:id/suppress`_
      - Add a suppression flag to a listing

    * - `DELETE /:country/listings/:id/suppress`_
      - Remove a suppression flag from a listing

    * - `GET /:country/listings/:id/images`_
      - Fetch images for a listing

    * - `POST /:country/listings/:id/image`_
      - Add an image to a listing

    * - `PUT /:country/listings/:id/image/:imageId`_
      - Update an existing image

    * - `DELETE /:country/listings/:id/image/:imageId`_
      - Delete an existing image

    * - `GET /:country/listings/:id/reviews/:reviewId`_
      - Fetch a review

    * - `GET /:country/listings/:id/reviews`_
      - Fetch all reviews for a listing

    * - `POST /:country/listings/:id/reviews`_
      - Add a review to a listing

    * - `DELETE /:country/listings/:id/reviews/:reviewId`_
      - Delete a review

.. _GET /:country/listings: get_listings.html
.. _GET /:country/listings/:id: get_listings_id.html
.. _GET /:country/listings/:id/categories: get_listing_categories.html
.. _PUT /:country/listings/:id: update_listing.html
.. _POST /:country/listings: add_listing.html
.. _DELETE /:country/listings/:id: delete_listing.html

.. _PUT /:country/listings/:id/offer: add_listing_offer.html
.. _GET /:country/listings/:id/offer: get_listing_offer.html
.. _DELETE /:country/listings/:id/offer: delete_listing_offer.html

.. _GET /:country/categories: get_categories.html
.. _GET /:country/listings/map: get_listings_map.html

.. _PUT /:country/listings/:id/claim: add_listing_claim.html
.. _DELETE /:country/listings/:id/claim: delete_listing_claim.html
.. _PUT /:country/listings/:id/suppress: add_listing_suppress.html
.. _DELETE /:country/listings/:id/suppress: delete_listing_suppress.html

.. _GET /:country/listings/:id/images: get_listing_images.html
.. _POST /:country/listings/:id/image: add_listing_image.html
.. _PUT /:country/listings/:id/image/:imageId: update_listing_image.html
.. _DELETE /:country/listings/:id/image/:imageId: delete_listing_image.html

.. _GET /:country/listings/:id/reviews/:reviewId: get_listing_review.html
.. _GET /:country/listings/:id/reviews: get_listing_reviews.html
.. _POST /:country/listings/:id/reviews: add_listing_review.html
.. _DELETE /:country/listings/:id/reviews/:reviewId: delete_listing_review.html