https://dev.app.pol-crm.com/api/V4/prospects/search/form?itemsPerPage=10&page=1&sortField=&sortOrder=asc Return to referer URL

App\V4\Model\Prospect\Prospect Resource class

Resource Metadata

Short name: "Prospect"

Item operations Attributes
get_form
[
  "method" => "GET"
  "path" => "/V4/prospects/{id}/form"
  "controller" => "App\V4\Controller\Prospect\GetProspectFormAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
put_prospect
[
  "method" => "POST"
  "deserialize" => false
  "write" => false
  "controller" => "App\V4\Controller\Prospect\ProspectDataPersisterAction"
  "path" => "/V4/prospects/{id}"
  "input_formats" => [
    "multipart" => [
      "multipart/form-data"
    ]
  ]
  "normalization_context" => [
    "groups" => [
      "prospect:read"
    ]
  ]
  "denormalization_context" => [
    "groups" => []
  ]
  "input" => null
  "output" => null
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
delete_prospect
[
  "method" => "DELETE"
  "deserialize" => false
  "write" => false
  "controller" => "App\V4\Controller\Prospect\ProspectDataPersisterAction"
  "path" => "/V4/prospects/{id}"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
Collection operations Attributes
get
[
  "normalization_context" => [
    "groups" => [
      "prospect:list"
    ]
  ]
  "security" => "is_granted(constant('App\\V4\\Voters\\ProspectVoter::PROSPECT_SHOW_LIST'), 'App\V4\Voters\ProspectVoter')"
  "input" => null
  "output" => null
  "method" => "GET"
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
post_individual
[
  "method" => "POST"
  "deserialize" => false
  "write" => false
  "controller" => "App\V4\Controller\Prospect\ProspectDataPersisterAction"
  "path" => "/V4/prospects/individual"
  "input_formats" => [
    "multipart" => [
      "multipart/form-data"
    ]
  ]
  "normalization_context" => [
    "groups" => [
      "prospect:read"
    ]
  ]
  "denormalization_context" => [
    "groups" => []
  ]
  "input" => null
  "output" => null
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
post_company
[
  "method" => "POST"
  "deserialize" => false
  "write" => false
  "controller" => "App\V4\Controller\Prospect\ProspectDataPersisterAction"
  "path" => "/V4/prospects/business"
  "input_formats" => [
    "multipart" => [
      "multipart/form-data"
    ]
  ]
  "normalization_context" => [
    "groups" => [
      "prospect:read"
    ]
  ]
  "denormalization_context" => [
    "groups" => []
  ]
  "input" => null
  "output" => null
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
get_search
[
  "method" => "GET"
  "path" => "/V4/prospects/search/form"
  "controller" => "App\V4\Controller\Prospect\GetProspectSearchFormAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
post_search
[
  "method" => "POST"
  "deserialize" => false
  "path" => "/V4/prospects/search/form"
  "normalization_context" => [
    "groups" => [
      "prospect:list"
    ]
  ]
  "controller" => "App\V4\Controller\Prospect\PostProspectSearchFormAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
get_contacts
[
  "method" => "GET"
  "path" => "/V4/prospects/{id}/contacts"
  "normalization_context" => [
    "groups" => [
      "contact:list"
    ]
  ]
  "controller" => "App\V4\Controller\Contact\GetContactsByProspectAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
get_tasks
[
  "method" => "GET"
  "path" => "/V4/prospects/{id}/tasks"
  "normalization_context" => [
    "groups" => [
      "task:list"
    ]
  ]
  "controller" => "App\V4\Controller\Task\GetTasksByProspectAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
get_resume_tasks
[
  "method" => "GET"
  "path" => "/V4/prospects/{id}/tasks_resume"
  "controller" => "App\V4\Controller\Task\GetResumeTasksByProspectAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
get_quotes
[
  "method" => "GET"
  "path" => "/V4/prospects/{id}/quotes"
  "normalization_context" => [
    "groups" => [
      "quote:list"
    ]
  ]
  "controller" => "App\V4\Controller\Quote\GetQuotesByProspectAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
get_names
[
  "method" => "GET"
  "path" => "/V4/prospects/get_names"
  "controller" => "App\V4\Controller\Prospect\GetProspectsNamesAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
get_customer_code
[
  "method" => "GET"
  "path" => "/V4/prospects/customer-code/{customerCode}"
  "controller" => "App\V4\Action\Prospect\GetProspectByCustomerCodeAction"
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
post_export_request
[
  "method" => "POST"
  "path" => "/v4/export/prospect"
  "controller" => "App\V4\Action\Export\EntityExportRequestAction"
  "swagger_context" => [
    "summary" => "Demande de création d'export de prospects"
    "description" => "Demande de création d'export de prospects où 'ids' sont les ids des prospects et 'fields' les champs souhaités"
    "parameters" => [
      [
        "in" => "body"
        "name" => "body"
        "schema" => [
          "type" => "object"
          "properties" => [
            "ids" => [
              "type" => "array"
              "items" => [
                "type" => "string"
              ]
            ]
            "fields" => [
              "type" => "array"
              "items" => [
                "type" => "string"
              ]
            ]
          ]
        ]
      ]
    ]
    "responses" => [
      201 => [
        "description" => "Création de l'export avec succès"
        "schema" => [
          "type" => "object"
          "properties" => [
            "message" => [
              "type" => "string"
              "example" => "export_request_created"
            ]
          ]
        ]
      ]
      400 => [
        "description" => "Utilisateur non trouvé ou champs 'fields' ou 'ids' manquant dans le body request"
        "schema" => [
          "type" => "object"
          "properties" => [
            "message" => [
              "type" => "string"
              "example" => "user_not_found or missing_fields_or_ids"
            ]
          ]
        ]
      ]
      422 => [
        "description" => "Les champs 'fields' ou 'ids' du body request sont vides ou l'entité demandée est invalide"
        "schema" => [
          "type" => "object"
          "properties" => [
            "message" => [
              "type" => "string"
              "example" => "empty_fields_or_ids or entity_not_valid"
            ]
          ]
        ]
      ]
    ]
  ]
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
post_export_download
[
  "method" => "POST"
  "path" => "/v4/export/download/prospect/{id}"
  "controller" => "App\V4\Action\Export\EntityExportDownloadAction"
  "swagger_context" => [
    "summary" => "Demande de téléchargement d'un export prospects"
    "description" => "Demande de téléchargement d'un export prospects ou 'id' est le nom du fichier d'export"
    "requestBody" => []
    "parameters" => [
      [
        "in" => "path"
        "name" => "id"
        "type" => "string"
        "required" => "true"
      ]
    ]
    "responses" => [
      200 => [
        "description" => "Téléchargement de l'export réalisé avec succès"
      ]
      401 => [
        "description" => "Utilisateur non trouvé ou non connecté"
        "schema" => [
          "type" => "object"
          "properties" => [
            "message" => [
              "type" => "string"
              "example" => "need_authenticated"
            ]
          ]
        ]
      ]
      404 => [
        "description" => "Fichier introuvable"
        "schema" => [
          "type" => "object"
          "properties" => [
            "message" => [
              "type" => "string"
              "example" => "export_not_found"
            ]
          ]
        ]
      ]
    ]
  ]
  "input" => null
  "output" => null
  "input_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
  "output_formats" => [
    "jsonld" => [
      "application/ld+json"
    ]
    "json" => [
      "application/json"
    ]
    "html" => [
      "text/html"
    ]
  ]
]
Filters
annotated_app_v4_model_prospect_prospect_app_filters_paging_filter
"App\Filters\PagingFilter"
Attributes
api_allow_update
true
input
null
output
null

Data Providers

No calls to collection data provider have been recorded.

No calls to item data provider have been recorded.

No calls to subresource data provider have been recorded.

Data Persisters

No calls to data persister have been recorded.