Show/hide List Operations Expand Operations

Prospect

POST /prospects

Send new Entity:Prospect, return the prospect's id created

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
ref_id_marque	integer	false	Reference id for marque
name	string	false	Name of prospect
married_name	string	false	Married name of prospect
first_name	string	false	First name of prospect
birth_date	datetime	false	birth date of the prospect
street_number	integer	false	Adress: Number of the street
adress_1	string	false	First part of the adress
adress_2	string	false	Second part of the adress
postal_code	string	false	Adress: Postal code
city	string	false	Adress: City
email	string	false	Email of prospect
telephone	string	false	phone number of prospect
cellphone	string	false	cell phone number of prospect
dogs_number	string	false	Number dogs of the prospect
cats_number	string	false	Number cats of the prospect
veterinary_name	string	false	Name of the veterinary
veterinary_city	string	false	Name of the veterinary's city
extra_fields	array	false	Extra fields

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some datas are invalid
400	Returned when some serializer errors

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /prospects/anonymize

Anonymize Entity:Prospect, return the prospect's id updated

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
filters	string	true		JSON containing an e-mail and at least a phone number

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some data are invalid
400	Returned when some serializer errors

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /prospects/{id}

Update Entity:Prospect, return the prospect's id updated

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	prospect id

Parameters

Parameter	Type	Required?	Description
ref_id_marque	integer	false	Reference id for marque
name	string	false	Name of prospect
married_name	string	false	Married name of prospect
first_name	string	false	First name of prospect
birth_date	datetime	false	birth date of the prospect
street_number	integer	false	Adress: Number of the street
adress_1	string	false	First part of the adress
adress_2	string	false	Second part of the adress
postal_code	string	false	Adress: Postal code
city	string	false	Adress: City
email	string	false	Email of prospect
telephone	string	false	phone number of prospect
cellphone	string	false	cell phone number of prospect
dogs_number	string	false	Number dogs of the prospect
cats_number	string	false	Number cats of the prospect
veterinary_name	string	false	Name of the veterinary
veterinary_city	string	false	Name of the veterinary's city
extra_fields	array	false	Extra fields

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some data are invalid
400	Returned when some serializer errors

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Quotation

POST /quotations

Send new Entity:Quotation, return the Quotation's id created

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
quotation_date	datetime	false	Quotation date creation
is_finalized	integer	false
updated_at	datetime	false	Quotation date update
prospect[ref_id_marque]	integer	false	Reference id for marque
prospect[name]	string	false	Name of prospect
prospect[married_name]	string	false	Married name of prospect
prospect[first_name]	string	false	First name of prospect
prospect[birth_date]	datetime	false	birth date of the prospect
prospect[street_number]	integer	false	Adress: Number of the street
prospect[adress_1]	string	false	First part of the adress
prospect[adress_2]	string	false	Second part of the adress
prospect[postal_code]	string	false	Adress: Postal code
prospect[city]	string	false	Adress: City
prospect[email]	string	false	Email of prospect
prospect[telephone]	string	false	phone number of prospect
prospect[cellphone]	string	false	cell phone number of prospect
prospect[dogs_number]	integer	false	Number dogs of the prospect
prospect[cats_number]	integer	false	Number cats of the prospect
prospect[veterinary_name]	string	false	Name of the veterinary
prospect[veterinary_city]	string	false	Name of the veterinary's city
prospect[extra_fields]	array	false	Extra fields
prospect[animals][][father_breed]	integer	false	animal father's breed name
prospect[animals][][mother_breed]	integer	false	animal mother's breed name
prospect[animals][][breed]	integer	false	animal father's breed name
prospect[animals][][birth_date]	datetime	false	animal date of birth
prospect[animals][][name]	string	false	animal name
prospect[animals][][gender]	string	false	gender
prospect[animals][][chip]	string	false	animal chip number
prospect[animals][][tattoo]	string	false	animal tattoo number
prospect[animals][][color]	string	false	animal color
prospect[animals][][description]	string	false
prospect[animals][][is_castrated]	boolean	false

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some datas are invalid
400	Returned when some serializer errors

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /quotations/search

Retrieves a paginated list of quotations, with prospects and animals

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
page	integer	false	number of page for Paginator
results_per_page	integer	false	number of results per page
filters[quotation_id]	integer	false	quotation id
filters[prospect_id]	integer	false	Prospect id
filters[name]	string	false	Name of prospect
filters[firstname]	string	false	Firstname of prospect
filters[status]	integer	false	status of quotation
filters[min_date]	datetime	false	minimum date for quotation's creation
filters[max_date]	datetime	false	maximum date for quotation's creation
filters[extra_fields]	array	false	Extra fields

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some datas are invalid
400	Returned when some serializer errors

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /quotations/subscribe

Send new Entity:Quotation, return the Quotation's id created

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
quotation_date	datetime	false	Quotation date creation
is_finalized	integer	false
updated_at	datetime	false	Quotation date update
prospect[ref_id_marque]	integer	false	Reference id for marque
prospect[name]	string	false	Name of prospect
prospect[married_name]	string	false	Married name of prospect
prospect[first_name]	string	false	First name of prospect
prospect[birth_date]	datetime	false	birth date of the prospect
prospect[street_number]	integer	false	Adress: Number of the street
prospect[adress_1]	string	false	First part of the adress
prospect[adress_2]	string	false	Second part of the adress
prospect[postal_code]	string	false	Adress: Postal code
prospect[city]	string	false	Adress: City
prospect[email]	string	false	Email of prospect
prospect[telephone]	string	false	phone number of prospect
prospect[cellphone]	string	false	cell phone number of prospect
prospect[dogs_number]	integer	false	Number dogs of the prospect
prospect[cats_number]	integer	false	Number cats of the prospect
prospect[veterinary_name]	string	false	Name of the veterinary
prospect[veterinary_city]	string	false	Name of the veterinary's city
prospect[extra_fields]	array	false	Extra fields
prospect[animals][][father_breed]	integer	false	animal father's breed name
prospect[animals][][mother_breed]	integer	false	animal mother's breed name
prospect[animals][][breed]	integer	false	animal father's breed name
prospect[animals][][birth_date]	datetime	false	animal date of birth
prospect[animals][][name]	string	false	animal name
prospect[animals][][gender]	string	false	gender
prospect[animals][][chip]	string	false	animal chip number
prospect[animals][][tattoo]	string	false	animal tattoo number
prospect[animals][][color]	string	false	animal color
prospect[animals][][description]	string	false
prospect[animals][][is_castrated]	boolean	false

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some datas are invalid
400	Returned when some serializer errors

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /quotations/{id}

Get some Entity:Quotation, return the entity

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	quotation id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /quotations/{id}

Update Entity:Quotation, return the Quotation's id updated

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	quotation id

Parameters

Parameter	Type	Required?	Description
quotation_date	datetime	false	Quotation date creation
is_finalized	integer	false
updated_at	datetime	false	Quotation date update
prospect[ref_id_marque]	integer	false	Reference id for marque
prospect[name]	string	false	Name of prospect
prospect[married_name]	string	false	Married name of prospect
prospect[first_name]	string	false	First name of prospect
prospect[birth_date]	datetime	false	birth date of the prospect
prospect[street_number]	integer	false	Adress: Number of the street
prospect[adress_1]	string	false	First part of the adress
prospect[adress_2]	string	false	Second part of the adress
prospect[postal_code]	string	false	Adress: Postal code
prospect[city]	string	false	Adress: City
prospect[email]	string	false	Email of prospect
prospect[telephone]	string	false	phone number of prospect
prospect[cellphone]	string	false	cell phone number of prospect
prospect[dogs_number]	integer	false	Number dogs of the prospect
prospect[cats_number]	integer	false	Number cats of the prospect
prospect[veterinary_name]	string	false	Name of the veterinary
prospect[veterinary_city]	string	false	Name of the veterinary's city
prospect[extra_fields]	array	false	Extra fields
prospect[animals][][father_breed]	integer	false	animal father's breed name
prospect[animals][][mother_breed]	integer	false	animal mother's breed name
prospect[animals][][breed]	integer	false	animal father's breed name
prospect[animals][][birth_date]	datetime	false	animal date of birth
prospect[animals][][name]	string	false	animal name
prospect[animals][][gender]	string	false	gender
prospect[animals][][chip]	string	false	animal chip number
prospect[animals][][tattoo]	string	false	animal tattoo number
prospect[animals][][color]	string	false	animal color
prospect[animals][][description]	string	false
prospect[animals][][is_castrated]	boolean	false

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some datas are invalid
400	Returned when some serializer errors

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /quotations/{id}/rates

Get some Entity:Quotation, return the entity

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	quotation id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /quotations/{id}/subscribe

Send new Entity:Quotation, return the Quotation's id created

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id		null

Parameters

Parameter	Type	Required?	Description
quotation_date	datetime	false	Quotation date creation
is_finalized	integer	false
updated_at	datetime	false	Quotation date update
prospect[ref_id_marque]	integer	false	Reference id for marque
prospect[name]	string	false	Name of prospect
prospect[married_name]	string	false	Married name of prospect
prospect[first_name]	string	false	First name of prospect
prospect[birth_date]	datetime	false	birth date of the prospect
prospect[street_number]	integer	false	Adress: Number of the street
prospect[adress_1]	string	false	First part of the adress
prospect[adress_2]	string	false	Second part of the adress
prospect[postal_code]	string	false	Adress: Postal code
prospect[city]	string	false	Adress: City
prospect[email]	string	false	Email of prospect
prospect[telephone]	string	false	phone number of prospect
prospect[cellphone]	string	false	cell phone number of prospect
prospect[dogs_number]	integer	false	Number dogs of the prospect
prospect[cats_number]	integer	false	Number cats of the prospect
prospect[veterinary_name]	string	false	Name of the veterinary
prospect[veterinary_city]	string	false	Name of the veterinary's city
prospect[extra_fields]	array	false	Extra fields
prospect[animals][][father_breed]	integer	false	animal father's breed name
prospect[animals][][mother_breed]	integer	false	animal mother's breed name
prospect[animals][][breed]	integer	false	animal father's breed name
prospect[animals][][birth_date]	datetime	false	animal date of birth
prospect[animals][][name]	string	false	animal name
prospect[animals][][gender]	string	false	gender
prospect[animals][][chip]	string	false	animal chip number
prospect[animals][][tattoo]	string	false	animal tattoo number
prospect[animals][][color]	string	false	animal color
prospect[animals][][description]	string	false
prospect[animals][][is_castrated]	boolean	false

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some datas are invalid
400	Returned when some serializer errors

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /quotations/{id}/to-validate

Update Entity:Quotation, set default value to subscribe as internet validation, return the Quotation's id updated

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	quotation id

Parameters

Parameter	Type	Required?	Description
quotation_date	datetime	false	Quotation date creation
is_finalized	integer	false
updated_at	datetime	false	Quotation date update
prospect[ref_id_marque]	integer	false	Reference id for marque
prospect[name]	string	false	Name of prospect
prospect[married_name]	string	false	Married name of prospect
prospect[first_name]	string	false	First name of prospect
prospect[birth_date]	datetime	false	birth date of the prospect
prospect[street_number]	integer	false	Adress: Number of the street
prospect[adress_1]	string	false	First part of the adress
prospect[adress_2]	string	false	Second part of the adress
prospect[postal_code]	string	false	Adress: Postal code
prospect[city]	string	false	Adress: City
prospect[email]	string	false	Email of prospect
prospect[telephone]	string	false	phone number of prospect
prospect[cellphone]	string	false	cell phone number of prospect
prospect[dogs_number]	integer	false	Number dogs of the prospect
prospect[cats_number]	integer	false	Number cats of the prospect
prospect[veterinary_name]	string	false	Name of the veterinary
prospect[veterinary_city]	string	false	Name of the veterinary's city
prospect[extra_fields]	array	false	Extra fields
prospect[animals][][father_breed]	integer	false	animal father's breed name
prospect[animals][][mother_breed]	integer	false	animal mother's breed name
prospect[animals][][breed]	integer	false	animal father's breed name
prospect[animals][][birth_date]	datetime	false	animal date of birth
prospect[animals][][name]	string	false	animal name
prospect[animals][][gender]	string	false	gender
prospect[animals][][chip]	string	false	animal chip number
prospect[animals][][tattoo]	string	false	animal tattoo number
prospect[animals][][color]	string	false	animal color
prospect[animals][][description]	string	false
prospect[animals][][is_castrated]	boolean	false

Status Codes

Status Code	Description
200	Returned when successful
401	Returned when some datas are invalid
400	Returned when some serializer errors

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /quotations/{uniqueId}

Get some Entity:Quotation, return the entity

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+	integer	quotation id
uniqueId	([a-zA-Z0-9]{40,60})	null

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Rate

GET /rates

Get rates and options

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
postal_code	string	false	Adress: Postal code
father_breed	integer	false	animal father's breed name
mother_breed	integer	false	animal mother's breed name
breed	integer	false	animal father's breed name
birth_date	datetime	false	animal date of birth

Status Codes

Status Code	Description
200	Returned when successful
204	Returned when no rates are available for the given parameters
400	Returned when the rates could not be retrieved for the given parameters
422	Returned when the request parameters are invalid (e.g. missing postal_code or birth_date)

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Status
- - - GET /status
      
      Get the API status
      Documentation
      
      Sandbox
      
      Input
      
      Headers
      = -
      
      Content
      = Replaces header if set
      
      Request URL
      
      Request body
      
      Response Headers [Expand] [Profiler]
      
      Response Body [Raw]
      
      Curl Command Line

API documentation

Prospect

POST /prospects

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /prospects/anonymize

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /prospects/{id}

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Quotation

POST /quotations

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /quotations/search

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /quotations/subscribe

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /quotations/{id}

Requirements

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /quotations/{id}

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /quotations/{id}/rates

Requirements