4 * API Get - lew13010/OCR-Api GitHub Wiki

Query list "GET" to search

Get adverts by category

yourdomain.com/api/get/adverts/category/{category}/{pagination}

Parameters

Mandatory :

  • category (slugCat)

Optional :

  • pagination (default : '1')

Exemple

yourdomain.com/api/get/adverts/category/category-1

Return Success :

{
 'success'   =>  true,
 'code'      =>  200,
  "message": "1 annonces trouvé dans la categorie : categorie-1",
  "annonces": [
    {
      "id": 1,
      "title": "Title",
      "categorie": "Categorie 1",
      "city": "Paris",
      "price": null,
      "description": "image",
      "images": [
        null
      ],
  "page": "1/1"
}

Return Failure :

{
 'success'   =>  false,
 'code'      =>  412,
 'message'   => 'La categorie demandé est vide ou n'existe pas dans la BDD'
}

Get adverts by city

yourdomain.com/api/get/adverts/city/{city}/{pagination}

Parameters

Mandatory :

  • city (name)

Optional :

  • pagination (default : '1')

Exemple

yourdomain.com/api/get/adverts/city/Paris

Return Success :

{
 'success'   =>  true,
 'code'      =>  200,
  "message": "1 annonces trouvé dans la ville: Paris",
  "annonces": [
    {
      "id": 1,
      "title": "Title",
      "categorie": "Categorie 1",
      "city": "Paris",
      "price": null,
      "description": "image",
      "images": [
        null
      ],
  "page": "1/1"
}

Return Failure :

{
 'success'   =>  false,
 'code'      =>  412,
 'message'   => 'La ville demandé est vide ou n'existe pas dans la BDD'
}

Get adverts by category and by city

yourdomain.com/api/get/adverts/category/{category}/city/{city}/{pagination}

Parameters

Mandatory :

  • category (slugCat)
  • city (name)

Optional :

  • pagination (default : '1')

Exemple

yourdomain.com/api/get/adverts/category/Categorie-1/city/Paris

Return Success :

{
 'success'   =>  true,
 'code'      =>  200,
  "message": "1 annonces trouvé dans la ville : Paris et dans la categorie: Categorie 1",
  "annonces": [
    {
      "id": 1,
      "title": "Title",
      "categorie": "Categorie 1",
      "city": "Paris",
      "price": null,
      "description": "image",
      "images": [
        null
      ],
  "page": "1/1"
}

Return Failure :

{
 'success'   =>  false,
 'code'      =>  412,
 'message'   => 'La ville/categorie demandé est vide ou n'existe pas dans la BDD'
}