definitions:
History:
type: object
properties:
id:
type: integer
user_id:
type: integer
agency_id:
type: integer
agency_co_id:
type: integer
company_id:
type: integer
brand_id:
type: integer
building_id:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
residence_id:
type: integer
contact_id:
type: integer
type_id:
type: integer
description: 'action_type'
origin_id:
type: integer
origin_name:
type: string
origin_sub_id:
type: integer
origin_sub_name:
type: string
access_id:
type: integer
description: 'action_method'
calendar_is:
type: boolean
start_at:
type: string
format: date-time
end_at:
type: string
format: date-time
email:
type: string
subject:
type: string
content:
type: string
reference:
type: string
auto:
type: boolean
created_at:
type: string
format: date-time
created_by:
type: integer
updated_at:
type: string
format: date-time
updated_by:
type: integer
contact:
$ref: '#/definitions/Contact'
building:
$ref: '#/definitions/residence'
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
residence:
$ref: '#/definitions/residence'
user:
$ref: '#/definitions/User'
documents:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
url:
type: string
size:
type: integer
internet:
type: boolean
extranet:
type: boolean
private:
type: boolean
properties:
type: array
items:
type: object
properties:
id:
type: integer
property_id:
type: integer
crawler_id:
type: integer
report_id:
type: string
price:
type: string
period_id:
type: integer
description: 'property_period'
currency:
type: string
assessment_id:
type: integer
description: 'action_assessment'
assessment:
type: string
PostHistory:
type: object
properties:
type_id:
type: integer
user_id:
type: integer
start_at:
type: string
format: date-time
start_time:
type: string
end_time:
type: string
access_id:
type: integer
contact_id:
type: integer
email:
type: string
content:
type: string
calendar_is:
type: boolean
properties:
type: array
items:
type: object
properties:
id:
type: integer
property_id:
type: integer
crawler_id:
type: integer
report_id:
type: string
price:
type: string
period_id:
type: integer
currency:
type: string
assessment_id:
type: integer
assessment:
type: string
HistoryWith:
type: array
items:
type: string
enum:
- all
- contact
- building
- residence
- documents
- properties
- user
collectionFormat: multi
HistoryColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- user_id
- agency_id
- agency_co_id
- company_id
- brand_id
- building_id
- residence_id
- contact_id
- type_id
- origin_id
- origin_name
- origin_sub_id
- origin_sub_name
- access_id
- start_at
- start_time
- end_time
- email
- subject
- content
- reference
- calendar_id
- auto
HistoryOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- start_at_asc
- start_at_desc
- end_at_asc
- end_at_desc
ResponseHistories:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
histories:
type: array
items:
$ref: '#/definitions/History'
ResponseHistory:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
history:
$ref: '#/definitions/History'
ResponseCountHistories:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
Lead:
type: object
properties:
id:
type: integer
step_id:
type: integer
description: 'lead_step'
agency_id:
type: integer
user_id:
type: integer
type_id:
type: integer
description: 'lead_type'
property_id:
type: integer
reference:
type: string
contact_id:
type: integer
request_id:
type: integer
parent_id:
type: integer
origin_id:
type: integer
suborigin_id:
type: integer
customer:
type: object
properties:
language:
type: string
title_id:
type: integer
description: 'contact_title'
lastname:
type: string
firstname:
type: string
email:
type: string
phone:
type: string
mobile:
type: string
message:
type: string
search:
type: object
properties:
category_id:
type: integer
description: 'property_category'
country:
type: string
rooms_min:
type: integer
rooms_max:
type: integer
bedrooms_min:
type: integer
bedrooms_max:
type: integer
area_min:
type: integer
area_max:
type: integer
area_unit_id:
type: integer
description: 'unit_area'
price_min:
type: integer
price_max:
type: integer
price_currency:
type: string
view_id:
type: integer
description: 'property_view_landscape'
view_type_id:
type: integer
description: 'property_view_type'
type_ids:
type: array
description: 'property_type'
items:
type: integer
region_ids:
type: array
items:
type: integer
city_ids:
type: array
items:
type: integer
district_ids:
type: array
items:
type: integer
regions:
type: array
items:
$ref: '#/definitions/Region'
cities:
type: array
items:
$ref: '#/definitions/City'
districts:
type: array
items:
$ref: '#/definitions/District'
received_at:
type: string
format: date-time
opened_at:
type: string
format: date-time
opened_by:
type: integer
assign_at:
type: string
format: date-time
assign_by:
type: integer
closed_at:
type: string
format: date-time
closed_by:
type: integer
created_at:
type: string
format: date-time
created_by:
type: integer
updated_at:
type: string
format: date-time
updated_by:
type: integer
agency:
$ref: '#/definitions/Agency'
user:
$ref: '#/definitions/User'
property:
$ref: '#/definitions/Property'
contact:
$ref: '#/definitions/Contact'
request:
$ref: '#/definitions/Request'
parent:
$ref: '#/definitions/Lead'
PostLead:
type: object
properties:
step_id:
type: integer
agency_id:
type: integer
user_id:
type: integer
type_id:
type: integer
property_id:
type: integer
property_reference:
type: string
contact_id:
type: integer
request_id:
type: integer
origin_id:
type: integer
suborigin_id:
type: integer
customer:
type: object
properties:
language:
type: string
title_id:
type: integer
lastname:
type: string
firstname:
type: string
email:
type: string
phone:
type: string
mobile:
type: string
message:
type: string
search:
type: object
properties:
category_id:
type: integer
country:
type: string
rooms_min:
type: integer
rooms_max:
type: integer
bedrooms_min:
type: integer
bedrooms_max:
type: integer
area_min:
type: integer
area_max:
type: integer
area_unit_id:
type: integer
price_min:
type: integer
price_max:
type: integer
price_currency:
type: string
view_id:
type: integer
view_type_id:
type: integer
type_ids:
type: array
items:
type: integer
region_ids:
type: array
items:
type: integer
city_ids:
type: array
items:
type: integer
district_ids:
type: array
items:
type: integer
received_at:
type: string
format: date-time
LeadWith:
type: array
collectionFormat: multi
items:
type: string
enum:
- all
- agency
- user
- property
- contact
- request
- parent
- cities
- regions
- districts
LeadColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- step_id
- agency_id
- user_id
- type_id
- property_id
- reference
- contact_id
- request_id
- parent_id
- origin_id
- suborigin_id
- search_category_id
- customer_language
- customer_title_id
- customer_lastname
- customer_firstname
- search_country
- customer_email
- customer_phone
- customer_mobile
- message
- search_room_min
- search_room_max
- search_bedrooms
- search_area_min
- search_area_max
- search_area_unit_id
- search_price_min
- search_price_max
- search_price_currency
- search_view_id
- search_view_type_id
- search_type_ids
- received_at
- opened_at
- opened_by
- assign_at
- assign_by
- closed_at
- closed_by
- created_at
- created_by
- updated_at
- updated_by
LeadOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- received_date_asc
- received_date_desc
- assign_date_asc
- assign_date_desc
ResponseLeads:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
leads:
type: array
items:
$ref: '#/definitions/Lead'
ResponseLead:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
lead:
type: array
items:
$ref: '#/definitions/Lead'
ResponseCountLeads:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
Sector:
type: object
properties:
id:
type: integer
company_id:
type: integer
name:
type: string
created_by:
type: integer
created_at:
type: string
format: date-time
updated_by:
type: integer
updated_at:
type: string
format: date-time
region_ids:
type: array
items:
type: integer
city_ids:
type: array
items:
type: integer
district_ids:
type: array
items:
type: integer
coordonates:
type: array
items:
type: string
regions:
type: array
items:
$ref: '#/definitions/Region'
cities:
type: array
items:
$ref: '#/definitions/City'
districts:
type: array
items:
$ref: '#/definitions/District'
SectorWith:
type: array
items:
type: string
enum:
- all
- regions
- cities
- districts
collectionFormat: multi
SectorColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- company_id
- name
- created_by
- created_at
- updated_by
- updated_at
SectorOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
ResponseSectors:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
sectors:
type: array
items:
$ref: '#/definitions/Sector'
ResponseSector:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
sector:
$ref: '#/definitions/Sector'
Property:
type: object
properties:
id:
type: integer
agency_id:
type: integer
agency_co_id:
type: integer
company_id:
type: integer
user_id:
type: integer
brand_id:
type: integer
step_id:
type: integer
description: 'property_step'
status_id:
type: integer
description: 'property_status'
group_id:
type: integer
description: 'property_group'
parent_id:
type: integer
ranking:
type: integer
category_id:
type: integer
description: 'property_category'
subcategory_id:
type: integer
description: 'property_subcategory'
name:
type: string
type_id:
type: integer
description: 'property_type'
subtype_id:
type: integer
description: 'property_subtype'
block_name:
type: string
lot_reference:
type: string
cadastre_reference:
type: string
reference:
type: string
postalcode:
type: string
standing_id:
type: integer
description: 'property_standing'
stairs_reference:
type: string
address:
type: string
address_more:
type: string
publish_address:
type: string
country:
type: string
region_id:
type: integer
city_id:
type: integer
city_web_id:
type: integer
district_id:
type: integer
district_web_id:
type: integer
latitude:
type: number
format: float
longitude:
type: number
format: float
public_id:
type: integer
public_latitude:
type: number
format: float
public_longitude:
type: number
format: float
public_radius:
type: integer
referral_id:
type: integer
description: 'referral'
subreferral_id:
type: integer
rooms:
type: number
format: float
bedrooms:
type: integer
sleeps:
type: integer
owner_id:
type: integer
tenant_id:
type: integer
condition_id:
type: integer
description: 'property_condition'
style:
type: string
url:
type: string
availability_id:
type: integer
description: 'property_availability'
available_at:
type: string
format: date
delivered_at:
type: string
format: date
filling_rate:
type: integer
private_comment:
type: string
status_comment:
type: string
internal_comment:
type: string
adjacency_id:
type: integer
created_at:
type: string
format: date-time
created_by:
type: string
updated_at:
type: string
format: date-time
updated_by:
type: string
user:
$ref: '#/definitions/User'
region:
$ref: '#/definitions/Region'
city:
$ref: '#/definitions/City'
district:
$ref: '#/definitions/District'
agency:
$ref: '#/definitions/Agency'
contracts:
type: array
items:
$ref: '#/definitions/Contract'
rates_period:
type: object
properties:
id:
type: integer
start_at:
type: string
end_at:
type: string
min:
type: integer
book_min:
type: integer
price:
type: string
currency:
type: string
commission_rate:
type: string
created_at:
type: string
created_by:
type: integer
updated_at:
type: string
updated_by:
type: integer
season:
type: object
properties:
id:
type: integer
name:
type: string
start_at:
type: string
end_at:
type: string
rates_booking:
type: object
properties:
id:
type: integer
contact_id:
type: integer
step_id:
type: integer
start_at:
type: string
end_at:
type: string
price:
type: string
commission:
type: integer
deposit:
type: integer
currency:
type: string
created_at:
type: string
created_by:
type: integer
updated_at:
type: string
updated_by:
type: integer
financial:
type: array
items:
type: object
properties:
id:
type: integer
result_id:
type: integer
amount:
type: integer
year:
type: string
created_at:
type: string
created_by:
type: integer
updated_at:
type: string
updated_by:
type: integer
pictures:
type: array
items:
type: object
properties:
id:
type: integer
property_id:
type: integer
rank:
type: integer
name:
type: string
max_width:
type: integer
max_height:
type: integer
watermarked_is:
type: boolean
transfer_is:
type: boolean
print_is:
type: boolean
panorama_is:
type: boolean
comments:
type: array
items:
type: object
properties:
culture:
type: string
comment:
type: string
services:
type: array
items:
type: object
properties:
id:
type: integer
type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
type_id:
type: integer
description: 'property_service'
number:
type: integer
comments:
type: array
items:
type: object
properties:
culture:
type: string
comment:
type: string
proximities:
type: array
items:
type: object
properties:
type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
type_id:
type: integer
description: 'property_proximity'
length:
type: integer
length_type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
length_type_id:
type: integer
tags:
type: array
description: 'tags'
items:
type: integer
custom_tags:
type: array
items:
type: object
properties:
id:
type: integer
created_at:
type: integer
type_id:
type: integer
group:
type: string
value:
type: string
name:
type: string
field_id:
type: integer
unit:
type: string
medias:
type: array
items:
type: object
properties:
id:
type: integer
type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
type_id:
type: integer
description: 'medias'
value:
type: integer
internet:
type: boolean
extranet:
type: boolean
documents:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
url:
type: string
size:
type: integer
internet:
type: boolean
extranet:
type: boolean
private:
type: boolean
comments:
type: array
items:
type: object
properties:
id:
type: integer
culture:
type: string
title:
type: string
subtitle:
type: string
hook:
type: string
comment:
type: string
comment_full:
type: string
areas:
type: array
items:
type: object
properties:
id:
type: integer
type_id:
type: integer
description: 'property_areas'
number:
type: integer
area:
type: integer
flooring_id:
type: integer
description: 'property_flooring'
ceiling_height:
type: integer
floor_id:
type: integer
description: 'property_floor'
lot_id:
type: integer
description: 'lots'
lot_name:
type: string
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
lot_name_i18ns:
type: array
items:
type: object
properties:
culture:
type: string
name:
type: string
orientations:
type: integer
description: 'property_orientation'
gross_revenue:
type: integer
comments:
type: array
items:
type: object
properties:
culture:
type: string
comment:
type: string
regulations:
type: array
items:
type: object
properties:
type:
type: integer
description: 'property_regulation'
value:
type: string
date:
type: string
graph:
type: string
logs:
type: array
items:
type: object
properties:
field:
type: string
value:
type: string
user_id:
type: string
date:
type: string
providers:
type: array
items:
type: object
properties:
provider_id:
type: integer
provider_name:
type: string
provider_picture_url:
type: string
created_at:
type: string
settings:
type: object
properties:
price_hide:
type: boolean
comment_hide:
type: boolean
pictures_hide:
type: boolean
no_watermark:
type: boolean
params:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
agreement:
type: object
properties:
reference:
type: integer
type_id:
type: integer
description: 'property_agreement'
start_at:
type: string
format: date
end_at:
type: string
format: date
area:
type: object
properties:
unit_id:
type: integer
description: 'unit_area'
value:
type: number
format: float
total:
type: number
format: float
weighted:
type: number
format: float
price:
type: object
properties:
value:
type: number
format: float
max:
type: integer
fees:
type: number
format: float
fees_details:
type: array
items:
type: integer
unit:
type: integer
description: 'unit_area'
period:
type: integer
description: 'property_period'
hide:
type: boolean
inventory:
type: number
format: float
deposit:
type: number
format: float
currency:
type: string
commission_buyer:
type: number
format: float
commission_owner:
type: number
format: float
sold:
type: number
format: float
sold_at:
type: string
format: date
transfer_tax:
type: integer
contribution:
type: integer
tenant_amount:
type: number
format: float
vat:
type: integer
seller:
type: integer
negotiable:
type: integer
vacancy_rate:
type: number
format: float
estimation:
type: object
properties:
min:
type: integer
max:
type: integer
orientations:
type: array
description: 'property_orientation'
items:
type: integer
activities:
type: array
description: 'property_activity'
items:
type: integer
view:
type: object
properties:
type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
type_id:
type: integer
description: 'property_view_type'
landscape:
type: array
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
items:
type: integer
landscape_ids:
type: array
items:
type: integer
description: /catalogDescription/property_view_landscape
residence:
type: object
properties:
id:
type: integer
type:
type: integer
description: 'property_building'
name:
type: string
fees:
type: number
format: float
period:
type: integer
description: 'property_period'
lots:
type: integer
facades:
type: integer
length:
type: number
format: float
height:
type: integer
construction:
type: object
properties:
construction_year:
type: string
renovation_year:
type: string
methods:
type: array
description: 'property_construction_method'
items:
type: integer
renovation_cost:
type: integer
floor:
type: object
properties:
type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
type_id:
type: integer
description: 'property_floor'
value:
type: integer
levels:
type: integer
floors:
type: integer
heating:
type: object
properties:
device_id:
type: array
description: 'property_heating_device'
items:
type: integer
access_id:
type: integer
description: 'property_heating_access'
type_id:
type: array
description: 'property_heating_type'
items:
type: integer
water:
type: object
properties:
hot_device_id:
type: integer
description: 'property_hot_water_device'
hot_access_id:
type: integer
description: 'property_hot_water_access'
waste_id:
type: integer
description: 'property_waste_water'
owner:
$ref: '#/definitions/Contact'
tenant:
$ref: '#/definitions/Contact'
visit:
type: object
properties:
contact_id:
type: integer
comment:
type: string
contact:
$ref: '#/definitions/Contact'
key_reference:
type: string
key_place_id:
type: integer
description: 'property_key'
crew:
type: integer
shop:
type: object
properties:
lease_id:
type: integer
window_height:
type: number
format: float
window_width:
type: number
format: float
area:
type: number
format: float
auction:
type: object
properties:
start_at:
type: string
format: date
start_time:
type: string
format: time
end_at:
type: string
format: date
end_time:
type: string
format: time
PropertyWith:
type: array
items:
type: string
enum:
- agency
- user
- region
- city
- district
- rates
- financial
- pictures
- parent_pictures
- services
- proximities
- tags
- custom_tags
- medias
- documents
- comments
- areas
- regulations
- logs
- providers
- owner
- tenant
- visit_contact
- contracts
collectionFormat: multi
PropertyColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- reference
- agency_id
- company_id
- user_id
- brand_id
- step_id
- status_id
- group_id
- parent
- ranking
- category_id
- subcategory_id
- name
- type_id
- subtype_id
- agreement_type_id
- agreement_reference
- agreement_start_at
- agreement_end_at
- block_name
- lot_reference
- cadastre_reference
- stairs_reference
- address
- address_more
- publish_address
- country
- region_id
- city_id
- city_web_id
- district_id
- district_web_id
- latitude
- longitude
- public_latitude
- public_longitude
- public_radius
- referral_id
- subreferral_id
- area_unit_id
- area_value
- area_total
- area_weighted
- rooms
- bedrooms
- sleeps
- owner_id
- tenant_id
- condition_id
- standing_id
- style
- twinned
- url
- availability_id
- available_at
- delivered_at
- filling_rate
- private_comment
- internal_comment
- status_id
- status_comment
- price_value
- price_max
- price_fees
- price_fees_details
- price_unit
- price_period
- price_hide
- price_inventory
- price_deposit
- price_currency
- price_commission_buyer
- price_commission_owner
- price_sold
- price_sold_at
- price_estimation_min
- price_estimation_max
- price_transfer_tax
- price_contribution
- price_tenant_amount
- price_vat
- price_seller
- price_negotiable
- price_vacancy_rate
- orientations
- activities
- view_type
- view_landscape
- visit_contact_id
- visit_comment
- visit_key_reference
- visit_key_place_id
- residence_id
- residence_name
- residence_type
- residence_fees
- residence_period
- residence_lots
- construction_methods_1
- construction_methods_2
- construction_construction_year
- construction_renovation_year
- floor_type
- floor_value
- floor_levels
- floor_floors
- heating_device
- heating_access
- heating_type
- water_hot_device
- water_hot_access
- water_waste
- adjacency_id
- auction_start_at
- auction_start_time
- auction_end_at
- auction_end_time
- shop_window_height
- shop_window_width
- shop_area
- crew
- created_at
- created_by
- updated_at
- updated_by
PropertyOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- rand
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- price_asc
- price_desc
- rooms_desc
- rooms_asc
- bedrooms_desc
- bedrooms_asc
- sleeps_asc
- sleeps_desc
- area_desc
- area_asc
ResponseProperties:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
properties:
type: array
items:
$ref: '#/definitions/Property'
ResponsePictures:
type: object
properties:
processing_time_sec:
type: number
format: float
pictures:
type: array
items:
type: object
properties:
id:
type: integer
property_id:
type: integer
rank:
type: integer
name:
type: string
watermarked_is:
type: boolean
max_width:
type: integer
max_height:
type: integer
transfer_is:
type: boolean
print_is:
type: boolean
urls:
type: object
properties:
400:
type: string
1024:
type: string
1920:
type: string
ResponsePicture:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
picture:
type: object
properties:
id:
type: integer
rank:
type: integer
name:
type: string
watermarked_is:
type: boolean
max_width:
type: integer
max_height:
type: integer
transfer_is:
type: boolean
print_is:
type: boolean
urls:
type: object
properties:
400:
type: string
1024:
type: string
1920:
type: string
ResponseProperty:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
property:
$ref: '#/definitions/Property'
ResponseCountProperties:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
matches:
type: object
properties:
category:
type: object
properties:
1:
type: integer
2:
type: integer
3:
type: integer
subtype:
type: object
properties:
1:
type: integer
4:
type: integer
PostProperty:
type: object
properties:
status_id:
type: integer
category_id:
type: integer
group_id:
type: integer
parent_id:
type: integer
reference:
type: string
type_id:
type: integer
owner_id:
type: integer
address:
type: string
address_more:
type: string
city_id:
type: integer
district_id:
type: integer
latitude:
type: number
format: float
longitutde:
type: number
format: float
country:
type: string
ranking:
type: number
format: float
referral_id:
type: integer
subreferral_id:
type: integer
agency_co_id:
type: integer
city_web_id:
type: integer
district_web_id:
type: integer
publish_address:
type: string
availability_id:
type: integer
orientations:
type: string
standing_id:
type: integer
style:
type: string
cadastre_reference:
type: string
lot_reference:
type: string
block_name:
type: string
stairs_reference:
type: string
private_comment:
type: string
url:
type: string
name:
type: string
sleeps:
type: integer
tenant_id:
type: integer
available_at:
type: string
format: date-time
delivered_at:
type: string
format: date-time
status_comment:
type: string
activities:
type: integer
adjacency_id:
type: integer
regulations:
type: array
items:
type: object
properties:
type:
type: integer
value:
type: string
date:
type: string
end_at:
type: string
tags:
type: array
items:
type: integer
custom_tags:
type: array
items:
type: object
additionalProperties:
type: string
properties: { }
visit:
type: object
properties:
contact_id:
type: integer
comment:
type: string
key_reference:
type: string
key_place_id:
type: integer
construction:
type: object
properties:
construction_year:
type: string
renovation_year:
type: string
methods:
type: array
items:
type: integer
renovation_cost:
type: integer
water:
type: object
properties:
hot_device_id:
type: integer
hot_access_id:
type: integer
waste_id:
type: integer
heating:
type: object
properties:
device_id:
type: array
items:
type: integer
access_id:
type: integer
type_id:
type: array
items:
type: integer
residence:
type: object
properties:
id:
type: integer
name:
type: string
fees:
type: integer
period:
type: integer
facades:
type: number
format: float
length:
type: number
format: float
height:
type: integer
agreement:
type: object
properties:
reference:
type: integer
type_id:
type: integer
start_at:
type: string
format: date
end_at:
type: string
format: date
price:
type: object
properties:
value:
type: integer
unit:
type: integer
period:
type: integer
contribution:
type: integer
tenant_amount:
type: integer
hide:
type: boolean
commission_owner:
type: integer
currency:
type: string
commission_buyer:
type: integer
commission_buyer_rate:
type: integer
commission_seller:
type: integer
commission_seller_rate:
type: integer
transfer_tax:
type: integer
seller:
type: integer
negotiable:
type: integer
estimation:
type: object
properties:
min:
type: integer
max:
type: integer
rooms:
type: number
format: float
floor:
type: object
properties:
type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
type_id:
type: integer
levels:
type: integer
floors:
type: integer
view:
type: object
properties:
type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
type_id:
type: integer
landscape_ids:
type: array
items:
type: integer
area:
type: object
properties:
value:
type: integer
unit_id:
type: integer
condition_id:
type: integer
proximity_ids:
type: object
properties:
type_id:
type: integer
length:
type: number
format: float
length_type:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
length_type_id:
type: integer
service_ids:
type: array
items:
type: integer
comments:
type: object
properties:
culture:
type: string
title:
type: string
comment:
type: string
subtitle:
type: string
hook:
type: string
comment_full:
type: string
areas:
type: object
properties:
number:
type: integer
type_id:
type: integer
area:
type: integer
floor_id:
type: integer
orientations:
type: integer
flooring_id:
type: integer
ceiling_height:
type: number
format: float
comments:
type: object
properties:
culture:
type: string
comment:
type: string
exchange_ids:
type: array
items:
type: integer
PostPropertyMedia:
type: object
properties:
type_id:
type: integer
value:
type: string
internet:
type: boolean
extranet:
type: boolean
ResponsePropertyMedia:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
media:
type: object
properties:
id:
type: integer
property_id:
type: integer
type_id:
type: integer
value:
type: string
internet:
type: boolean
extranet:
type: boolean
Document:
type: object
properties:
id:
type: integer
folder_id:
type: integer
brand_id:
type: integer
company_id:
type: integer
building_id:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
residence_id:
type: integer
property_id:
type: integer
type_id:
type: integer
name:
type: string
url:
type: string
size:
type: integer
culture:
type: string
website:
type: boolean
extranet:
type: boolean
private:
type: boolean
created_by:
type: integer
created_at:
type: string
format: date-time
updated_by:
type: integer
updated_at:
type: string
format: date-time
folder:
$ref: '#/definitions/Folder'
residence:
$ref: '#/definitions/Residence'
Folder:
type: object
properties:
id:
type: integer
name:
type: string
comment:
type: string
parent_id:
type: integer
created_by:
type: integer
created_at:
type: string
format: date-time
updated_by:
type: integer
updated_at:
type: string
format: date-time
DocumentWith:
type: array
items:
type: string
enum:
- folder
- residence
collectionFormat: multi
DocumentColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- folder_id
- brand_id
- company_id
- building_id
- residence_id
- property_id
- type_id
- name
- url
- size
- culture
- website
- extranet
- private
- created_by
- created_at
- update_by
- update_at
FolderColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- name
- comment
- parent_id
- created_by
- created_at
- update_by
- update_at
DocumentOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- size_asc
- size_desc
FolderOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
ResponseDocuments:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
documents:
type: array
items:
$ref: '#/definitions/Document'
ResponseDocument:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
document:
$ref: '#/definitions/Document'
ResponseCountDocuments:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
ResponseFolders:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
folders:
type: array
items:
$ref: '#/definitions/Folder'
ResponseFolder:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
folder:
$ref: '#/definitions/Folder'
ResponseCountFolders:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
Contact:
type: object
properties:
id:
type: integer
agency_id:
type: integer
user_id:
type: integer
category_id:
type: integer
description: 'contact_category'
activity_id:
type: integer
description: 'contact_activity'
title_id:
type: integer
description: 'contact_title'
lastname:
type: string
firstname:
type: string
name:
type: string
birthday_at:
type: string
nationality:
type: string
email:
type: string
phone:
type: string
mobile:
type: string
fax:
type: string
language:
type: string
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
languages:
type: array
items:
type: string
address:
type: string
address_more:
type: string
city_id:
type: integer
city_value:
type: string
postalcode:
type: string
country:
type: string
comment:
type: string
currency:
type: string
relationship_id:
type: integer
description: 'contact_relationship'
civil_status_id:
type: integer
description: 'contact_civil_status'
incoming_action_at:
type: string
outgoing_action_at:
type: string
job:
type: string
created_at:
type: string
created_by:
type: string
updated_at:
type: string
updated_by:
type: string
city:
$ref: '#/definitions/City'
spouse:
type: object
properties:
title:
type: string
description: 'contact_title'
lastname:
type: string
firstname:
type: string
birthday_at:
type: string
nationality:
type: string
email:
type: string
mobile:
type: string
mailing:
type: object
properties:
subscription:
type: integer
description: 'subscription'
subscribe_at:
type: string
unsubscribe_at:
type: string
emailing:
type: object
properties:
subscription:
type: integer
description: 'subscription'
subscribe_at:
type: string
unsubscribe_at:
type: string
magazine:
type: object
properties:
subscription:
type: integer
description: 'subscription'
subscribe_at:
type: string
unsubscribe_at:
type: string
contact_method:
type: array
description: 'contact_method'
items:
type: integer
tags:
type: array
description: 'tags'
items:
type: string
custom_tags:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
extranet:
type: object
properties:
password:
type: string
active:
type: boolean
logs:
type: array
items:
type: object
properties:
property_id:
type: integer
number_of_access:
type: integer
first_access_at:
type: string
last_access_at:
type: string
reminders:
type: array
items:
$ref: '#/definitions/Reminder'
leads:
type: array
items:
$ref: '#/definitions/Lead'
user:
$ref: '#/definitions/User'
company:
type: object
properties:
id:
type: integer
name:
type: string
brand:
type: object
properties:
id:
type: integer
name:
type: string
ContactWith:
type: array
items:
type: string
enum:
- all
- city
- custom_tags
- extranet_logs
- reminders
- leads
- user
collectionFormat: multi
ContactColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- agency_id
- company_id
- brand_id
- user_id
- category_id
- activity_id
- password
- title
- lastname
- firstname
- name
- birthday_at
- nationality
- email
- phone
- mobile
- fax
- spouse_title
- spouse_lastname
- spouse_firstname
- spouse_birthday_at
- spouse_nationality
- spouse_email
- spouse_mobile
- language
- address
- address_more
- city_id
- country
- comment
- mailing_subscription
- mailing_subscribe_at
- mailing_unsubscribe_at
- emailing_subscription
- emailing_subscribe_at
- emailing_unsubscribe_at
- magazine_subscription
- magazine_subscribe_at
- magazine_unsubscribe_at
- currency
- contact_method_1
- contact_method_2
- incoming_action_at
- outgoing_action_at
- created_at
- created_by
- updated_at
- updated_by
- tags_owner
- tags_active_owner
- tags_contracted_owner
- tags_prospect
- tags_seeker
- tags_active_seeker
- tags_contracted_customer
- relationship_id
- civil_status_id
ContactOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- firstname_asc
- firstname_desc
- lastname_asc
- lastname_desc
ResponseContacts:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
contacts:
type: array
items:
$ref: '#/definitions/Contact'
ResponseContact:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
contact:
$ref: '#/definitions/Contact'
ResponseCountContacts:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
PostContact:
type: object
properties:
category_id:
type: integer
user_id:
type: integer
address_line_1:
type: string
address_line_2:
type: string
zipcode:
type: string
city_id:
type: integer
city:
type: string
country:
type: string
phone:
type: string
fax:
type: string
comment:
type: string
name:
type: string
lead_id:
type: integer
contact_1:
type: object
properties:
civility_id:
type: integer
lastname:
type: string
firstname:
type: string
mail:
type: string
mobile:
type: string
contact_2:
type: object
properties:
civility_id:
type: integer
lastname:
type: string
firstname:
type: string
mail:
type: string
mobile:
type: string
mailing:
type: object
properties:
subscription:
type: integer
emailing:
type: object
properties:
subscription:
type: integer
magazine:
type: object
properties:
subscription:
type: integer
contact_method:
type: array
items:
type: integer
residence:
type: object
properties:
id:
type: integer
user_id:
type: integer
agency_id:
type: integer
company_id:
type: integer
brand_id:
type: integer
parent_id:
type: integer
type_id:
type: integer
description: 'property_building'
city_id:
type: integer
district_id:
type: integer
country:
type: string
name:
type: string
reference:
type: string
location_reference:
type: string
latitude:
type: number
format: float
longitude:
type: number
format: float
address:
type: string
address_more:
type: string
built_in:
type: string
standing_id:
type: integer
description: 'property_standing'
floors:
type: integer
lots:
type: integer
quota:
type: number
format: float
code:
type: string
code_at:
type: string
format: date
comment:
type: string
created_at:
type: string
format: date-time
created_by:
type: string
updated_at:
type: string
format: date-time
updated_by:
type: string
occupants:
type: array
items:
type: object
properties: { }
city:
$ref: '#/definitions/City'
district:
$ref: '#/definitions/District'
properties:
type: array
items:
$ref: '#/definitions/Property'
documents:
type: array
items:
$ref: '#/definitions/Document'
histories:
type: array
items:
$ref: '#/definitions/History'
heating:
type: object
properties:
device_id:
type: integer
description: 'property_heating_device'
type_id:
type: integer
description: 'property_heating_type'
access_id:
type: integer
description: 'property_heating_access'
water:
type: object
properties:
device_id:
type: integer
description: 'property_hot_water_device'
access_id:
type: integer
description: 'property_hot_water_access'
Residence:
allOf:
-
$ref: '#/definitions/residence'
-
properties:
residences:
type: array
items:
$ref: '#/definitions/residence'
ResidenceWith:
type: array
items:
type: string
enum:
- all
- occupants
- residences
- city
- district
- properties
- documents
- histories
collectionFormat: multi
ResidenceColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- user_id
- agency_id
- company_id
- brand_id
- parent
- type_id
- city_id
- district_id
- country
- name
- reference
- location_reference
- latitude
- longitude
- address_number
- address
- address_more
- longitude
- longitude
- built_in
- heating_device_id
- heating_type_id
- heating_access_id
- water_device_id
- water_access_id
- standing_id
- floors
- lots
- quota
- code
- code_at
- comment
- created_at
- created_by
- updated_at
- updated_by
ResidenceOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
PostResidence:
type: object
properties:
user_id:
type: integer
agency_id:
type: integer
parent_id:
type: integer
type_id:
type: integer
city_id:
type: integer
country:
type: string
name:
type: string
reference:
type: string
location_reference:
type: string
latitude:
type: number
format: float
longitude:
type: number
format: float
address:
type: string
address_more:
type: string
built_in:
type: string
standing_id:
type: integer
floors:
type: integer
lots:
type: integer
zipcode:
type: integer
quota:
type: number
format: float
code:
type: string
code_at:
type: string
format: date
comment:
type: string
heating:
type: object
properties:
device_id:
type: integer
type_id:
type: integer
access_id:
type: integer
water:
type: object
properties:
device_id:
type: integer
access_id:
type: integer
occupants:
type: object
properties:
contact_id:
type: integer
type_id:
type: integer
lot_reference:
type: string
quota:
type: number
format: float
property:
type: object
properties:
rooms:
type: number
format: float
bedrooms:
type: number
format: float
subtype:
type: integer
area:
type: number
format: float
floor_id:
type: integer
comment:
type: string
ResponseResidences:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
residences:
type: array
items:
$ref: '#/definitions/Residence'
ResponseResidence:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
residence:
$ref: '#/definitions/Residence'
ResponseCountResidences:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
User:
type: object
properties:
id:
type: integer
agency_id:
type: integer
city_id:
type: integer
active:
type: boolean
username:
type: string
firstname:
type: string
lastname:
type: string
language:
type: string
languages:
type: array
items:
type: string
group_id:
type: integer
description: 'user_group'
email:
type: string
phone:
type: integer
mobile:
type: integer
birthday_at:
type: string
format: date
timezone:
type: integer
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
picture:
type: string
city:
$ref: '#/definitions/City'
partners:
type: array
items:
type: object
properties:
type_id:
type: integer
description: 'partner'
name:
type: string
reference:
type: string
amount:
type: integer
currency:
type: string
stories:
type: array
items:
type: object
properties:
culture:
type: string
title:
type: string
content:
type: string
parameters:
type: object
properties: { }
sectors:
type: array
items:
type: object
properties:
sector_id:
type: integer
name:
type: string
coordinates:
type: string
cities:
type: array
items:
$ref: '#/definitions/City'
regions:
type: array
items:
$ref: '#/definitions/Region'
districts:
type: array
items:
$ref: '#/definitions/District'
UserWith:
type: array
items:
type: string
enum:
- all
- city
- partners
- stories
- parameters
- sectors
collectionFormat: multi
PostUser:
type: object
properties:
active:
type: boolean
agency_id:
type: integer
group_id:
type: integer
firstname:
type: string
lastname:
type: string
birthday_at:
type: string
username:
type: string
email:
type: string
mobile:
type: string
phone:
type: string
language:
type: string
reference:
type: string
timezone:
type: string
languages:
type: array
items:
type: string
sectors:
type: object
properties:
sector_id:
type: integer
UserColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- agency_id
- city_id
- active
- username
- firstname
- lastname
- language
- group_id
- email
- phone_code
- phone
- mobile_code
- mobile
- fax_code
- fax
- birthday_at
- timezone
- created_at
- updated_at
UserOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- rand
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- group_asc
- group_desc
ResponseUsers:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
users:
type: array
items:
$ref: '#/definitions/User'
ResponseUser:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
user:
$ref: '#/definitions/User'
ResponseCountUsers:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
ResponseUserPicture:
type: object
properties:
processing_time_sec:
type: number
format: float
pictures:
type: object
properties:
picture:
type: string
picture_200:
type: string
ResponseDeleteUserSector:
type: object
properties:
processing_time_sec:
type: number
format: float
Brand:
type: object
properties:
id:
type: integer
account_id:
type: integer
name:
type: string
template:
type: string
extranet_template:
type: string
logo:
type: string
logo_svg:
type: string
website_url:
type: string
software_url:
type: string
BrandColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- account_id
- name
- template
- extranet_template
- logo
- logo_svg
- website_url
- software_url
BrandOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- account_id_asc
- account_id_desc
- name_asc
- name_desc
ResponseBrands:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
brands:
type: array
items:
$ref: '#/definitions/Brand'
ResponseBrand:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
brand:
$ref: '#/definitions/Brand'
ResponseCountBrands:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
Book:
type: object
properties:
id:
type: integer
company_id:
type: integer
agency_id:
type: integer
user_id:
type: integer
step_id:
type: integer
description: 'register_step'
type_id:
type: integer
description: 'register_type'
subtype_id:
type: integer
description: 'property_agreement'
contracted_at:
type: string
format: date
start_at:
type: string
format: date
end_at:
type: string
format: date
reference:
type: string
subreference:
type: string
owner_id:
type: integer
owner_name:
type: string
comment:
type: string
created_at:
type: string
format: date-time
created_by:
type: string
updated_at:
type: string
format: date-time
updated_by:
type: string
property:
type: object
properties:
id:
type: integer
type_id:
type: integer
description: 'property_type'
address1:
type: string
address2:
type: string
zipcode:
type: string
country:
type: string
city_id:
type: integer
city:
$ref: '#/definitions/City'
agency:
$ref: '#/definitions/Agency'
company:
type: object
properties:
id:
type: integer
name:
type: string
user:
$ref: '#/definitions/User'
owner:
$ref: '#/definitions/Contact'
histories:
type: array
items:
type: object
properties:
book_id:
type: integer
field:
type: string
field_id:
type: integer
value:
type: string
value_i18n:
type: string
user_id:
type: integer
date:
type: string
BookWith:
type: array
items:
type: string
enum:
- all
- agency
- company
- user
- owner
- histories
collectionFormat: multi
BookColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- company_id
- agency_id
- user_id
- step_id
- type_id
- subtype_id
- contracted_at
- start_at
- end_at
- reference
- subreference
- owner_id
- owner
- property_id
- property_type_id
- property_address1
- property_address2
- property_zipcode
- property_country
- property_city_id
- comment
- created_at
- created_by
- updated_at
- updated_by
BookOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- reference_asc
- reference_desc
- step_asc
- step_desc
- type_asc
- type_desc
- contracted_date_asc
- contracted_date_desc
- start_date_asc
- start_date_desc
- end_date_asc
- end_date_desc
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
ResponseBooks:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
books:
type: array
items:
$ref: '#/definitions/Book'
ResponseBook:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
book:
$ref: '#/definitions/Book'
ResponseCountBooks:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
PostBook:
type: object
properties:
company_id:
type: integer
agency_id:
type: integer
user_id:
type: integer
step_id:
type: integer
type_id:
type: integer
subtype_id:
type: integer
contracted_at:
type: string
format: date-time
start_at:
type: string
format: date
end_at:
type: string
format: date
reference:
type: string
subreference:
type: string
owner_id:
type: integer
owner_name:
type: string
comment:
type: string
property:
type: object
properties:
id:
type: integer
type_id:
type: integer
address1:
type: string
address2:
type: string
zipcode:
type: string
country:
type: string
city_id:
type: integer
histories:
type: array
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
items:
type: object
properties:
field_id:
type: string
value:
type: string
Response401:
type: object
properties:
error:
type: string
error_description:
type: string
SchemaArrayMultiInteger:
type: array
collectionFormat: multi
items:
type: integer
SchemaArrayMultiString:
type: array
collectionFormat: multi
items:
type: string
ResponseCollection:
type: object
properties:
total_items:
type: integer
limit:
type: integer
offset:
type: integer
processing_time_sec:
type: number
format: float
ResponseObject:
type: object
properties:
processing_time_sec:
type: number
format: float
CatalogColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- name
- name_plurial
- value
- type_ids
- category_ids
- step_id
CatalogOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- rand
- id_asc
- id_desc
- value_asc
- value_desc
ResponseCatalogs:
type: object
properties:
processing_time_sec:
type: number
format: float
catalogs:
type: object
additionalProperties:
type: object
properties:
additionalProperties:
type: object
properties:
name:
type: string
name_plurial:
type: string
value:
type: string
example:
property_category:
1:
name: Sale
name_plurial: null
value: null
2:
name: Rental
name_plurial: null
value: null
property_type:
1:
name: Apartment
name_plurial: null
value: null
2:
name: House
name_plurial: null
value: null
properties: { }
ResponseCatalog:
type: object
properties:
processing_time_sec:
type: number
format: float
name:
type: string
entries:
type: object
additionalProperties:
type: object
properties:
additionalProperties:
type: object
properties:
name:
type: string
name_plurial:
type: string
value:
type: string
example:
1:
name: Sale
name_plurial: null
value: null
2:
name: Rental
name_plurial: null
value: null
properties: { }
Region:
type: object
properties:
id:
type: integer
parent_id:
type: integer
country:
type: string
name:
type: string
code:
type: string
parent:
type: object
properties:
id:
type: integer
parent_id:
type: integer
country:
type: string
name:
type: string
code:
type: string
RegionColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- parent_id
- country
- name
- code
RegionWith:
type: array
collectionFormat: multi
items:
type: string
enum:
- parent
RegionOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- code_asc
- code_desc
- country_asc
- country_desc
- parent_asc
- parent_desc
ResponseRegions:
type: object
properties:
total_items:
type: integer
limit:
type: integer
offset:
type: integer
processing_time_sec:
type: number
format: float
regions:
type: array
items:
$ref: '#/definitions/Region'
City:
type: object
properties:
id:
type: integer
region_id:
type: integer
country:
type: string
name:
type: string
zipcode:
type: string
zipcodes:
type: string
latitude:
type: number
format: float
longitude:
type: number
format: float
region:
$ref: '#/definitions/Region'
CityColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- region_id
- country
- name
- zipcode
- zipcodes
- latitude
- longitude
CityWith:
type: array
collectionFormat: multi
items:
type: string
enum:
- region
CityOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- region_id_asc
- region_id_desc
- name_asc
- name_desc
- country_asc
- country_desc
- zipcode_asc
- zipcode_desc
ResponseCities:
type: object
properties:
total_items:
type: integer
limit:
type: integer
offset:
type: integer
processing_time_sec:
type: number
format: float
cities:
type: array
items:
$ref: '#/definitions/City'
District:
type: object
properties:
id:
type: integer
city_id:
type: integer
name:
type: string
latitude:
type: number
format: float
longitude:
type: number
format: float
parent:
type: object
properties:
id:
type: integer
city_id:
type: integer
name:
type: string
latitude:
type: number
format: float
longitude:
type: number
format: float
city:
$ref: '#/definitions/City'
DistrictColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- parent_id
- city_id
- name
- latitude
- longitude
DistrictWith:
type: array
collectionFormat: multi
items:
type: string
enum:
- parent
- city
DistrictOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- parent_id_asc
- parent_id_desc
- city_id_asc
- city_id_desc
- name_asc
- name_desc
ResponseDistricts:
type: object
properties:
total_items:
type: integer
limit:
type: integer
offset:
type: integer
processing_time_sec:
type: number
format: float
districts:
type: array
items:
$ref: '#/definitions/District'
Cultures:
type: string
default: en_GB
enum:
- en_GB
- fr_FR
Subreferral:
type: object
properties:
id:
type: integer
company_id:
type: integer
brand_id:
type: integer
origine_id:
type: integer
provider_id:
type: integer
name:
type: string
created_at:
type: string
format: date-time
created_by:
type: string
updated_at:
type: string
format: date-time
updated_by:
type: string
SubreferralColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- brand_id
- company_id
- origine_id
- provider_id
- name
- created_at
- created_by
- updated_at
- updated_by
ResponseSubreferrals:
type: object
properties:
total_items:
type: integer
processing_time_sec:
type: number
format: float
subreferrals:
type: array
items:
$ref: '#/definitions/Subreferral'
CatalogMedia:
type: object
properties:
id:
type: integer
name:
type: string
content:
type: string
width:
type: integer
height:
type: integer
method:
type: string
CatalogMediaColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- name
- content
- width
- height
- method
ResponseCatalogMedia:
type: object
properties:
total_items:
type: integer
processing_time_sec:
type: number
format: float
medias:
type: array
items:
$ref: '#/definitions/CatalogMedia'
ResponseCatalogCountries:
type: object
properties:
processing_time_sec:
type: number
format: float
countries:
type: object
additionalProperties:
type: string
example:
FR: France
VN: 'Viêt Nam'
properties: { }
ResponseCatalogPhoneCodes:
type: object
properties:
processing_time_sec:
type: number
format: float
phone_codes:
type: object
additionalProperties:
type: string
example:
FR: 33
VN: 84
properties: { }
FieldsColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- table
- field
- name
- tip
ResponseCatalogField:
type: object
properties:
total_items:
type: integer
processing_time_sec:
type: number
format: float
fields:
type: object
additionalProperties:
type: object
properties:
additionalProperties:
type: object
properties:
table:
type: string
field:
type: string
name:
type: string
tip:
type: string
example:
1:
table: estate
field: parts
name: Rooms
tip: 'This is the total number of the rooms..."'
2:
name: request
name_plurial: origine_id
value: Origin
properties: { }
Apindex:
type: object
properties:
id:
type: integer
type_id:
type: integer
country:
type: string
publish_at:
type: string
format: date-time
period_start:
type: string
period_end:
type: string
name:
type: string
indice:
type: number
format: float
rate:
type: number
format: float
created_at:
type: string
format: date-time
ApindexColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- type_id
- country
- publish_at
- period_start
- period_end
- name
- indice
- rate
- created_at
ResponseApindex:
type: object
properties:
total_items:
type: integer
processing_time_sec:
type: number
format: float
apindex:
type: array
items:
$ref: '#/definitions/Apindex'
CatalogCulture:
type: object
properties:
fr_FR:
type: object
properties:
fr_FR:
type: object
properties:
language:
type: string
name:
type: string
region:
type: string
en_GB:
type: object
properties:
language:
type: string
name:
type: string
region:
type: string
ResponseCatalogCultures:
type: object
properties:
processing_time_sec:
type: number
format: float
cultures:
$ref: '#/definitions/CatalogCulture'
SubOrigin:
type: object
properties:
id:
type: integer
active:
type: boolean
brand_id:
type: integer
company_id:
type: integer
origin_id:
type: integer
provider_id:
type: integer
name:
type: string
created_by:
type: integer
created_at:
type: string
format: date-time
updated_by:
type: integer
updated_at:
type: string
format: date-time
brand:
type: object
properties:
id:
type: integer
name:
type: string
company:
type: object
properties:
id:
type: integer
name:
type: string
provider:
type: object
properties:
id:
type: integer
name:
type: string
SubOriginColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- active
- brand_id
- company_id
- origin_id
- provider_id
- name
- created_by
- created_at
- updated_by
- updated_at
SubOriginWith:
type: array
collectionFormat: multi
items:
type: string
enum:
- brand
- company
- provider
SubOriginOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- name_asc
- name_desc
ResponseSubOrigins:
type: object
properties:
total_items:
type: integer
limit:
type: integer
offset:
type: integer
processing_time_sec:
type: number
format: float
sub_origins:
type: array
items:
$ref: '#/definitions/SubOrigin'
CustomTag:
type: object
properties:
id:
type: integer
company_id:
type: integer
brand_id:
type: integer
type_id:
type: integer
field_id:
type: integer
group:
type: string
name:
type: string
CustomTagsColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- brand_id
- company_id
- type_id
- field_id
- group
- name
ResponseCustomTags:
type: object
properties:
total_items:
type: integer
limit:
type: integer
offset:
type: integer
processing_time_sec:
type: number
format: float
sub_origins:
type: array
items:
$ref: '#/definitions/CustomTag'
CatalogLots:
type: object
properties:
id:
type: integer
company_id:
type: integer
rank:
type: integer
names:
type: array
items:
type: object
properties:
language:
type: string
name:
type: string
CatalogLotsColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- company_id
- rank
ResponseCatalogLots:
type: object
properties:
total_items:
type: integer
limit:
type: integer
offset:
type: integer
processing_time_sec:
type: number
format: float
lots:
type: array
items:
$ref: '#/definitions/CatalogLots'
Calendar:
type: object
properties:
id:
type: integer
reference:
type: string
contact_id:
type: integer
history_id:
type: integer
property_id:
type: integer
user_id:
type: integer
group_id:
type: integer
description: 'calendar_type'
parent_id:
type: integer
start_at:
type: string
format: date-time
end_at:
type: string
format: date-time
start_tz:
type: string
end_tz:
type: string
subject:
type: string
location:
type: string
description:
type: string
repeat:
type: string
repeat_end_at:
type: string
format: date
created_by:
type: integer
created_at:
type: string
format: date-time
updated_by:
type: integer
updated_at:
type: string
format: date-time
user:
$ref: '#/definitions/User'
contact:
$ref: '#/definitions/Contact'
property:
$ref: '#/definitions/Property'
history:
$ref: '#/definitions/History'
guests:
type: array
items:
type: object
properties:
id:
type: integer
firstname:
type: string
lastname:
type: string
email:
type: string
mobile:
type: string
PostCalendar:
type: object
properties:
type_id:
type: integer
user_id:
type: integer
start_at:
type: string
format: date-time
start_tz:
type: string
end_at:
type: string
format: date-time
end_tz:
type: string
location:
type: string
description:
type: string
contact_id:
type: integer
guests_id:
type: array
items:
type: integer
repeat:
type: string
repeat_end_at:
type: string
format: date-time
required:
- type_id
- start_at
- end_at
CalendarWith:
type: array
items:
type: string
enum:
- all
- property
- user
- contact
- history
- guests
collectionFormat: multi
CalendarColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- reference
- contact_id
- history_id
- property_id
- user_id
- group_id
- start_at
- end_at
- location
- description
- repeat
- repeat_end_at
- created_by
- created_at
- updated_by
- updated_at
CalendarOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- group_asc
- group_desc
- start_at_asc
- start_at_desc
- end_at_asc
- end_at_desc
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
ResponseCalendars:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
calendars:
type: array
items:
$ref: '#/definitions/Calendar'
ResponseCalendar:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
calendar:
$ref: '#/definitions/Calendar'
Company:
type: object
properties:
id:
type: integer
account_id:
type: integer
name:
type: string
market:
type: object
properties:
is:
type: string
credential:
type: string
at:
type: string
CompanyColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- account_id
- name
- market_id
- market_credential
- market_at
- bank_name
- bank_rib
- bank_iban
- bank_bic
CompanyOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- account_id_asc
- account_id_desc
- name_asc
- name_desc
ResponseCompanies:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
companies:
type: array
items:
$ref: '#/definitions/Company'
ResponseCompany:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
company:
$ref: '#/definitions/Company'
ResponseCountCompanies:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
Request:
type: object
properties:
id:
type: integer
active:
type: boolean
contact_id:
type: integer
agency_id:
type: integer
agency_co_id:
type: integer
company_id:
type: integer
brand_id:
type: integer
user_id:
type: integer
classification_id:
type: integer
description: 'request_rating'
validated:
type: boolean
comment:
type: string
note:
type: string
last_action_at:
type: string
format: date
reference:
type: string
created_at:
type: string
format: date-time
updated_by:
type: integer
updated_at:
type: string
format: date-time
agency:
$ref: '#/definitions/Agency'
agency_co:
$ref: '#/definitions/Agency'
user:
$ref: '#/definitions/User'
contact:
$ref: '#/definitions/Contact'
histories:
type: array
items:
type: object
properties:
field_id:
type: integer
value:
type: string
comment:
type: string
created_by:
type: integer
created_at:
type: string
logs:
type: array
items:
type: object
properties:
user_id:
type: integer
num:
type: integer
created_at:
type: string
updated_at:
type: string
agreement:
type: object
properties:
type_id:
type: integer
description: 'property_agreement'
start_at:
type: string
end_at:
type: string
reference:
type: string
search:
type: object
properties:
category_id:
type: integer
description: 'property_category'
subcategory_id:
type: integer
description: 'property_subcategory'
type_ids:
type: array
description: 'property_type'
items:
type: integer
subtype_id:
type: integer
description: 'property_subtype'
origine_id:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
origin_id:
type: integer
description: 'referral'
suborigine_id:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
suborigin_id:
type: integer
country:
type: string
sector_id:
type: integer
coordonates:
type: string
rooms_min:
type: number
format: float
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
room_min:
type: number
format: float
rooms_max:
type: number
format: float
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
room_max:
type: number
format: float
bedrooms_min:
type: number
format: float
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
bedroom_min:
type: number
format: float
bedrooms_max:
type: number
format: float
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
bedroom_max:
type: number
format: float
margin:
type: integer
area_min:
type: integer
area_max:
type: integer
area_unit_id:
type: integer
description: 'unit_area'
area_floor_min:
type: integer
lot:
type: integer
start_at:
type: string
end_at:
type: string
price_min:
type: integer
price_max:
type: integer
price_currency:
type: string
floor:
type: string
description: 'property_floor'
delivery_at_min:
type: string
delivery_at_max:
type: string
view_id:
type: integer
description: 'property_view_landscape'
view_type_id:
type: integer
description: 'property_view_type'
standing_id:
type: integer
description: 'property_standing'
availability_id:
type: integer
description: 'property_availability'
condition_id:
type: integer
description: 'property_condition'
proximity_ids:
type: array
description: 'property_proximity'
items:
type: integer
services_ids:
type: array
description: 'property_service'
items:
type: integer
activity_ids:
type: array
description: 'property_activity'
items:
type: integer
tag_ids:
type: array
items:
type: integer
region_ids:
type: array
items:
type: integer
city_ids:
type: array
items:
type: integer
district_ids:
type: array
items:
type: integer
regions:
type: array
items:
$ref: '#/definitions/Region'
cities:
type: array
items:
$ref: '#/definitions/City'
districts:
type: array
items:
$ref: '#/definitions/District'
sector:
$ref: '#/definitions/Sector'
periods:
type: array
items:
type: object
properties:
start_at:
type: string
end_at:
type: string
min:
type: integer
max:
type: integer
reglementations:
type: array
items:
type: object
properties:
type_id:
type: integer
description: /catalogDescription/property_regulation
value:
type: integer
areas:
type: array
items:
type: object
properties:
number:
type: integer
room_id:
type: integer
area_min:
type: integer
custom_tags:
type: array
items:
type: object
properties:
id:
type: integer
type:
type: integer
group:
type: integer
value:
type: string
crossing:
type: object
properties:
counters:
type: object
additionalProperties:
type: object
properties:
type:
type: string
num:
type: integer
example:
-
type: brand
num: 45
-
name: company
num: 18
at:
type: string
automatic:
type: boolean
emailing:
type: object
properties:
id:
type: integer
at:
type: string
subscribe_at:
type: string
unsubscribe_at:
type: string
Crossing:
type: object
properties:
property_id:
type: integer
step_id:
type: integer
description: 'matching_step'
score:
type: integer
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
property:
$ref: '#/definitions/Property'
PostRequest:
type: object
properties:
active:
type: boolean
contact_id:
type: integer
agency_id:
type: integer
agency_co_id:
type: integer
user_id:
type: integer
classification_id:
type: integer
agreement:
type: object
properties:
type_id:
type: integer
start_at:
type: string
end_at:
type: string
reference:
type: string
crossing_automatic:
type: boolean
emailing_id:
type: integer
search:
type: object
properties:
category_id:
type: integer
subcategory_id:
type: integer
type_ids:
type: array
items:
type: integer
subtype_id:
type: integer
origine_id:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
origin_id:
type: integer
suborigine_id:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
suborigin_id:
type: integer
country:
type: string
sector_id:
type: integer
coordinates:
type: string
rooms_min:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
room_min:
type: integer
rooms_max:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
room_max:
type: integer
bedrooms_min:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
bedroom_min:
type: integer
bedrooms_max:
type: integer
deprecated: true
description: '!!! DEPRECATED : DO NOT USE !!!'
bedroom_max:
type: integer
margin:
type: integer
area_min:
type: integer
area_max:
type: integer
area_unit_id:
type: integer
lot:
type: integer
price_min:
type: integer
price_max:
type: integer
price_currency:
type: string
floor_equal:
type: integer
floor_id:
type: integer
view_id:
type: integer
view_type_id:
type: integer
standing_id:
type: integer
availability_id:
type: integer
condition_id:
type: integer
proximity_ids:
type: array
items:
type: integer
services_ids:
type: array
items:
type: integer
activity_ids:
type: array
items:
type: integer
tag_ids:
type: array
items:
type: integer
city_ids:
type: array
items:
type: integer
region_ids:
type: array
items:
type: integer
district_ids:
type: array
items:
type: integer
reglementations:
type: object
properties:
type_id:
type: integer
value:
type: string
areas:
type: object
properties:
area_id:
type: integer
number:
type: integer
area:
type: integer
custom_tag_ids:
type: array
items:
type: integer
comment:
type: string
note:
type: string
reference:
type: string
RequestWith:
type: array
items:
type: string
enum:
- all
- regions
- cities
- districts
- agency
- agency_co
- user
- sector
- histories
- logs
collectionFormat: multi
CrossingWith:
type: array
items:
type: string
enum:
- all
- property
collectionFormat: multi
RequestColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- active
- contact_id
- agency_id
- agency_co_id
- company_id
- brand_id
- user_id
- classification_id
- validated
- agreement_type_id
- agreement_start_at
- agreement_end_at
- agreement_reference
- search_category_id
- search_subcategory_id
- search_type_ids
- search_subtype_id
- search_origine_id
- search_origin_id
- search_suborigine_id
- search_suborigin_id
- crossing_prospect
- crossing_company
- crossing_company_all
- crossing_network
- crossing_brand
- crossing_apimarker
- crossing_at
- crossing_automatic
- emailing_id
- emailing_at
- emailing_subscribe_at
- emailing_unsubscribe_at
- search_country
- search_sector_id
- search_coordonates
- search_rooms
- search_bedrooms
- search_margin
- search_area_min
- search_area_max
- search_area_unit_id
- search_area_floor_min
- search_lot
- search_start_at
- search_end_at
- search_price_min
- search_price_max
- search_price_currency
- search_floor
- search_delivery_at_min
- search_delivery_at_max
- search_view_id
- search_view_type_id
- search_standing_id
- search_availability_id
- search_condition_id
- search_proximity_ids
- search_services_ids
- search_activity_ids
- search_tag_ids
- comment
- note
- last_action_at
- reference
- created_at
- updated_by
- updated_at
CrossingColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- property_id
- step_id
- score
- comment
- created_at
- updated_at
RequestOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- crossing_date_asc
- crossing_date_desc
- last_action_date_asc
- last_action_date_desc
CrossingOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
- score_asc
- score_desc
ResponseRequests:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
requests:
type: array
items:
$ref: '#/definitions/Request'
ResponseRequest:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
request:
$ref: '#/definitions/Request'
ResponseCrossings:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
crossings:
type: array
items:
$ref: '#/definitions/Crossing'
ResponseCountRequests:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
News:
type: object
properties:
id:
type: integer
property_id:
type: integer
request_id:
type: integer
user_id:
type: integer
message:
type: string
group_id:
type: integer
description: 'whatsnew'
file_id:
type: integer
end_at:
type: string
format: date-time
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
user:
$ref: '#/definitions/User'
property:
$ref: '#/definitions/Property'
request:
$ref: '#/definitions/Request'
comments:
type: array
items:
$ref: '#/definitions/NewsComment'
NewsComment:
type: object
properties:
message:
type: string
user_id:
type: integer
created_at:
type: string
format: date-time
PostNews:
type: object
properties:
property_id:
type: integer
request_id:
type: integer
user_id:
type: integer
forum_id:
type: integer
message:
type: string
group_id:
type: integer
file_id:
type: integer
warning_is:
type: boolean
end_at:
type: string
format: date-time
PostNewsComment:
type: object
properties:
property_id:
type: integer
user_id:
type: integer
message:
type: string
NewsWith:
type: array
items:
type: string
enum:
- user
- property
- request
- comments
collectionFormat: multi
NewsColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- property_id
- request_id
- user_id
- message
- group_id
- file_id
- end_at
- created_at
- updated_at
NewsOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- rand
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
ResponseNews:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
news:
type: array
items:
$ref: '#/definitions/News'
ResponseSingleNews:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
news:
$ref: '#/definitions/News'
Ticket:
type: object
properties:
id:
type: integer
agency_id:
type: integer
user_id:
type: integer
affected_user_id:
type: integer
step_id:
type: integer
description: 'support_step'
priority_id:
type: integer
description: 'support_priority'
type_id:
type: integer
description: 'support_type'
content:
type: string
filename1:
type: string
filename1_original:
type: string
filename2:
type: string
filename2_original:
type: string
filename3:
type: string
filename3_original:
type: string
created_by:
type: integer
created_at:
type: string
format: date-time
user:
$ref: '#/definitions/User'
affected_user:
$ref: '#/definitions/User'
TicketWith:
type: array
items:
type: string
enum:
- all
- user
- affected_user
collectionFormat: multi
TicketColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- agency_id
- user_id
- affected_user_id
- step_id
- priority_id
- type_id
- content
- filename1
- filename1_original
- filename2
- filename2_original
- filename3
- filename3_original
- created_by
- created_at
TicketOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- reference_asc
- reference_desc
- step_asc
- step_desc
- type_asc
- type_desc
- created_date_asc
- created_date_desc
ResponseTickets:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
tickets:
type: array
items:
$ref: '#/definitions/Ticket'
ResponseTicket:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
ticket:
$ref: '#/definitions/Ticket'
ResponseCountTickets:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
PostEmail:
type: object
properties:
from:
type: string
description: 'From email address'
content:
type: string
description: 'Email body'
subject:
type: string
description: 'Email subject'
property_id:
type: string
description: 'Send a mail related to a property'
crawler_id:
type: string
description: 'Send a mail related to a crawler'
reply_to:
type: object
properties:
contact_id:
type: integer
description: 'Contact and spouse to reply to'
to:
type: object
description: 'Users and Agencies to send emails to'
properties:
user_ids:
type: array
items:
type: integer
agency_ids:
type: array
items:
type: integer
cc:
type: object
description: 'Users and Agencies to send emails to in cc'
properties:
user_ids:
type: array
items:
type: integer
agency_ids:
type: array
items:
type: integer
required:
- to
- from
- content
ResponsePostEmail:
type: object
properties:
processing_time_sec:
type: number
format: float
Reminder:
type: object
properties:
id:
type: integer
user_id:
type: integer
callback_at:
type: string
format: date
complete:
type: boolean
type_id:
type: integer
description: 'callback_type'
contact_id:
type: integer
property_id:
type: integer
request_id:
type: integer
comment:
type: string
created_by:
type: integer
created_at:
type: string
format: date-time
user:
$ref: '#/definitions/User'
contact:
$ref: '#/definitions/Contact'
property:
$ref: '#/definitions/Property'
request:
$ref: '#/definitions/Request'
ReminderWith:
type: array
items:
type: string
enum:
- user
- contact
- property
- request
collectionFormat: multi
ReminderColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- user_id
- callback_at
- complete
- type_id
- contact_id
- property_id
- request_id
- comment
- created_by
- created_at
ReminderOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- id_asc
- id_desc
- reminder_at_asc
- reminder_at_desc
- created_date_asc
- created_date_desc
ResponseReminders:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
reminders:
type: array
items:
$ref: '#/definitions/Reminder'
ResponseReminder:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
reminder:
$ref: '#/definitions/Reminder'
ResponseCountReminders:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
PostReminder:
type: object
properties:
user_id:
type: integer
callback_at:
type: string
complete:
type: boolean
type_id:
type: integer
contact_id:
type: integer
property_id:
type: integer
request_id:
type: integer
comment:
type: string
PostShareProperties:
type: object
properties:
method:
type: string
enum:
- email
- manual
description: 'Sharing method. Possible values [email,manual]'
default: email
body:
type: string
format:
type: string
enum:
- hmtl
deprecated: true
description: 'Sharing format. Possible values [hmtl]'
emails:
type: array
collectionFormat: multi
uniqueItems: true
deprecated: true
items:
type: string
copy:
type: boolean
description: 'True to get a copy of this email (default: false)'
deprecated: true
default: false
subject:
type: string
deprecated: true
email:
type: object
properties:
format:
type: string
enum:
- hmtl
description: 'Sharing format. Possible values [hmtl]'
emails:
type: array
collectionFormat: multi
uniqueItems: true
items:
type: string
copy:
type: boolean
description: 'True to get a copy of this email (default: false)'
default: false
subject:
type: string
currency:
type: string
description: 'Currency use to convert prices (EUR, USD ...)'
language:
type: string
description: 'Language of the message (fr, it, en ...)'
contacts:
type: array
description: 'Contacts ID'
collectionFormat: multi
uniqueItems: true
items:
type: integer
properties:
type: array
description: 'Properties ID'
collectionFormat: multi
uniqueItems: true
items:
type: integer
required:
- method
- language
- properties
BodyGetShareProperties:
type: object
properties:
format:
type: string
enum:
- hmtl
- text
description: 'Sharing format. Possible values [hmtl,text]'
language:
type: string
description: 'Language of the message (fr, it, en ...)'
currency:
type: string
description: 'Currency use to convert prices (EUR, USD ...)'
contacts:
type: array
description: 'Contacts ID'
collectionFormat: multi
uniqueItems: true
items:
type: integer
properties:
type: array
description: 'Properties ID'
collectionFormat: multi
uniqueItems: true
items:
type: integer
required:
- format
- language
- currency
- properties
ResponsePostShareProperties:
type: object
properties:
processing_time_sec:
type: number
format: float
body:
type: string
report:
type: array
items:
type: object
properties:
contact_id:
type: integer
email:
type: integer
status:
type: string
detail:
type: string
ResponseGetShareProperties:
type: object
properties:
processing_time_sec:
type: number
format: float
subject:
type: string
body:
type: string
Contract:
type: object
properties:
id:
type: integer
agency_id:
type: integer
company_id:
type: integer
brand_id:
type: integer
property_id:
type: integer
request_id:
type: integer
step_id:
type: integer
description: 'contract_step'
lock:
type: integer
price:
type: integer
price_seller:
type: integer
deposit_id:
type: integer
deposit:
type: integer
commission:
type: number
format: float
commission_customer:
type: number
format: float
commission_owner:
type: number
format: float
fees_charged:
type: number
format: float
currency:
type: string
project_at:
type: string
format: date
offer_at:
type: string
format: date
commitment_at:
type: string
format: date
coolingoff_at:
type: string
format: date
condition_precedent_at:
type: string
format: date
contract_scheduled_at:
type: string
format: date
contract_at:
type: string
format: date
bill:
type: object
properties:
at:
type: string
format: date
reference:
type: string
amount:
type: number
format: float
collected_at:
type: string
format: date
tax_notice_at:
type: string
format: date
canceled_at:
type: string
format: date
vat_rate:
type: number
format: float
vat:
type: number
format: float
personal_contribution:
type: number
format: float
mortgage:
type: object
properties:
amount:
type: number
format: float
condition_precedent_at:
type: string
format: date
accepted_at:
type: string
format: date
visa_step:
type: integer
comment:
type: string
created_at:
type: string
format: date-time
created_by:
type: integer
updated_at:
type: string
format: date-time
updated_by:
type: integer
property:
$ref: '#/definitions/Property'
request:
$ref: '#/definitions/Request'
products:
type: array
items:
type: object
properties:
id:
type: integer
contract_id:
type: integer
type_id:
type: integer
description: 'contract_product'
parent_id:
type: integer
contact_id:
type: integer
user_id:
type: integer
agency_id:
type: integer
amount:
type: number
format: float
vat_rate:
type: number
format: float
vat:
type: number
format: float
title:
type: string
visas:
type: array
items:
type: object
properties:
id:
type: integer
contract_id:
type: integer
user_id:
type: integer
step:
type: integer
accept_at:
type: string
format: date-time
decline_at:
type: string
format: date-time
comment:
type: string
owners:
type: array
items:
$ref: '#/definitions/Contact'
customers:
type: array
items:
$ref: '#/definitions/Contact'
contacts:
type: array
items:
$ref: '#/definitions/Contact'
ContractWith:
type: array
items:
type: string
enum:
- all
- property
- request
- visas
- owners
- customers
- contacts
collectionFormat: multi
ContractColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- agency_id
- company_id
- brand_id
- property_id
- request_id
- step_id
- lock
- price
- price_seller
- deposit_id
- deposit
- commission
- commission_customer
- commission_owner
- fees_charged
- currency
- project_at
- offer_at
- commitment_at
- coolingoff_at
- condition_precedent_at
- contract_scheduled_at
- contract_at
- bill_at
- bill_reference
- bill_amount
- collected_at
- tax_notice_at
- canceled_at
- vat_rate
- vat
- personal_contribution
- mortgage_amount
- mortgage_condition_precedent_at
- mortgage_accepted_at
- visa_step
- comment
- created_at
- created_by
- updated_at
- updated_by
ContractOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- property_asc
- property_desc
- price_asc
- price_desc
- fees_charged_asc
- fees_charged_desc
- step_asc
- step_desc
- offer_date_asc
- offer_date_desc
- contract_date_asc
- contract_date_desc
- commitment_asc
- commitment_desc
- updated_date_asc
- updated_date_desc
- created_date_asc
- created_date_desc
ResponseContracts:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
contracts:
type: array
items:
$ref: '#/definitions/Contract'
ResponseContract:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
contract:
$ref: '#/definitions/Contract'
ResponseCountContracts:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
PostContract:
type: object
properties:
agency_id:
type: integer
property_id:
type: integer
request_id:
type: integer
step_id:
type: integer
lock:
type: integer
price:
type: integer
price_seller:
type: integer
deposit_id:
type: integer
deposit:
type: integer
commission:
type: number
format: float
commission_customer:
type: number
format: float
commission_owner:
type: number
format: float
fees_charged:
type: number
format: float
currency:
type: string
project_at:
type: string
format: date
offer_at:
type: string
format: date
commitment_at:
type: string
format: date
coolingoff_at:
type: string
format: date
condition_precedent_at:
type: string
format: date
contract_scheduled_at:
type: string
format: date
contract_at:
type: string
format: date
bill:
type: object
properties:
at:
type: string
format: date
reference:
type: string
amount:
type: number
format: float
collected_at:
type: string
format: date
tax_notice_at:
type: string
format: date
canceled_at:
type: string
format: date
vat_rate:
type: number
format: float
vat:
type: number
format: float
personal_contribution:
type: number
format: float
mortgage:
type: object
properties:
amount:
type: number
format: float
condition_precedent_at:
type: string
format: date
accepted_at:
type: string
format: date
visa_step:
type: integer
comment:
type: string
products:
type: array
items:
type: object
properties:
id:
type: integer
type_id:
type: integer
parent_id:
type: integer
contact_id:
type: integer
amount:
type: number
format: float
vat_rate:
type: number
format: float
vat:
type: number
format: float
title:
type: string
visas:
type: array
items:
type: object
properties:
id:
type: integer
contract_id:
type: integer
user_id:
type: integer
step:
type: integer
accept_at:
type: string
format: date-time
decline_at:
type: string
format: date-time
comment:
type: string
owner_ids:
type: array
items:
type: integer
customer_ids:
type: array
items:
type: integer
contact_ids:
type: array
items:
type: integer
Agency:
type: object
properties:
id:
type: integer
crm_refence:
type: string
bill_reference:
type: string
active:
type: boolean
name:
type: string
subscription:
type: string
address:
type: string
address_more:
type: string
zipcode:
type: integer
country:
type: string
city_id:
type: integer
region_id:
type: integer
latitude:
type: number
format: float
longitude:
type: number
format: float
email:
type: string
phone_code:
type: integer
phone:
type: string
fax_code:
type: integer
fax:
type: string
url:
type: string
logo:
type: string
logo_svg:
type: string
picture:
type: string
last_login_at:
type: string
format: date-time
currency:
type: string
timetable:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
region:
$ref: '#/definitions/Region'
city:
$ref: '#/definitions/City'
parameters:
type: object
additionalProperties:
type: string
properties: { }
providers:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
exchange_id:
type: integer
picture_url:
type: string
networks:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
brand_name:
type: string
rates:
type: array
items:
type: object
properties:
id:
type: integer
category_id:
type: integer
range_min:
type: integer
range_max:
type: integer
price:
type: integer
name:
type: string
rate:
type: string
comment:
type: string
partners:
type: array
items:
type: object
properties:
type:
type: integer
name:
type: string
reference:
type: string
amount:
type: integer
currency:
type: string
account:
type: object
properties:
id:
type: integer
name:
type: string
company:
type: object
properties:
id:
type: integer
name:
type: string
brand:
type: object
properties:
id:
type: integer
name:
type: string
AgencyWith:
type: array
items:
type: string
enum:
- all
- region
- city
- parameters
- providers
- rates
- partners
- options
collectionFormat: multi
AgencyColumns:
type: array
collectionFormat: multi
items:
type: string
enum:
- id
- account_id
- account_name
- company_id
- company_name
- brand_id
- brand_name
- crm_refence
- bill_reference
- active
- name
- subscription
- address
- address_more
- zipcode
- country
- city_id
- region_id
- latitude
- longitude
- email
- phone_code
- phone
- fax_code
- fax
- url
- logo
- logo_svg
- picture
- last_login_at
- currency
- timetable
- created_at
- updated_at
AgencyOrders:
type: array
collectionFormat: multi
items:
type: string
enum:
- rand
- created_date_asc
- created_date_desc
- updated_date_asc
- updated_date_desc
ResponseAgencies:
allOf:
-
$ref: '#/definitions/ResponseCollection'
-
properties:
agencies:
type: array
items:
$ref: '#/definitions/Agency'
ResponseAgency:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
agency:
$ref: '#/definitions/Agency'
ResponseCountAgencies:
allOf:
-
$ref: '#/definitions/ResponseObject'
-
properties:
total_items:
type: integer
paths:
/api/reminder:
post:
tags:
- reminders
summary: 'Post reminder'
description: ''
operationId: postReminder
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.reminders.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostReminder'
responses:
200:
description: 'New reminder'
content:
application/json:
schema:
$ref: '#/definitions/ResponseReminder'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/reminders/count:
get:
tags:
- reminders
summary: 'Count reminders'
description: ''
operationId: getCountReminders
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.reminders.read'
required: true
schema:
type: string
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ReminderColumns'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[contact]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[request]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[complete]'
in: query
required: false
schema:
type: boolean
-
name: 'search[reminder_start]'
in: query
required: false
schema:
type: string
-
name: 'search[reminder_end]'
in: query
required: false
schema:
type: string
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of Reminders'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountReminders'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/reminders:
get:
tags:
- reminders
summary: 'Get all reminders'
description: ''
operationId: getReminders
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.reminders.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ReminderWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ReminderColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/ReminderOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[contact]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[request]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[complete]'
in: query
required: false
schema:
type: boolean
-
name: 'search[reminder_start]'
in: query
required: false
schema:
type: string
-
name: 'search[reminder_end]'
in: query
required: false
schema:
type: string
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Reminders object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseReminders'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/reminders/{id}':
get:
tags:
- reminders
summary: 'Get a specific reminder'
description: ''
operationId: getReminder
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.reminders.read'
required: true
schema:
type: string
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ReminderWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ReminderColumns'
responses:
200:
description: 'Reminder object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseReminder'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
post:
tags:
- reminders
summary: 'Edit reminder'
description: ''
operationId: patchReminder
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.reminders.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostReminder'
responses:
200:
description: Reminder
content:
application/json:
schema:
$ref: '#/definitions/ResponseReminder'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/share/properties:
post:
tags:
- sharing
summary: 'Share properties'
description: ''
operationId: postShareProperties
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.sharing'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostShareProperties'
application/x-www-form-urlencoded:
schema:
$ref: '#/definitions/PostShareProperties'
multipart/form-data:
schema:
$ref: '#/definitions/PostShareProperties'
responses:
200:
description: Report
content:
application/json:
schema:
$ref: '#/definitions/ResponsePostShareProperties'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- sharing
summary: 'Get body / subject to share properties'
description: 'Get subject and body to share properties by e-mail or manually'
operationId: getShareProperties
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.sharing'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/BodyGetShareProperties'
responses:
200:
description: Report
content:
application/json:
schema:
$ref: '#/definitions/ResponseGetShareProperties'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/news:
post:
tags:
- news
summary: 'Create news'
description: ''
operationId: postNews
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.news.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostNews'
responses:
200:
description: 'New News'
content:
application/json:
schema:
$ref: '#/definitions/ResponseSingleNews'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- news
summary: 'Get all news'
description: ''
operationId: getNews
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.news.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/NewsWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/NewsColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/NewsOrders'
-
name: 'search[file]'
in: query
description: 'Search by file ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[group]'
in: query
description: 'Search by group ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property_category]'
in: query
description: 'Search by property category ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property_type]'
in: query
description: 'Search by property type ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property_country]'
in: query
description: 'Search by property country'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[property_city]'
in: query
description: 'Search by property city ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of News object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseNews'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/news/:id/comment':
post:
tags:
- news
summary: 'Create news comment'
description: ''
operationId: postNewsComment
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.news.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostNewsComment'
responses:
200:
description: News
content:
application/json:
schema:
$ref: '#/definitions/ResponseSingleNews'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/sectors:
get:
tags:
- sectors
summary: 'Get all the sectors'
description: ''
operationId: getSectors
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.sectors.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/SectorWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/SectorColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/SectorOrders'
-
name: 'search[id]'
in: query
description: 'Search by sector ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Sector objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseSectors'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/sectors/{id}':
get:
tags:
- sectors
summary: 'Get a specific sector'
description: ''
operationId: getSector
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.sectors.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by sector ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/SectorWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/SectorColumns'
responses:
200:
description: 'Sector object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseSector'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/oauth/token/info:
post:
tags:
- authentication
summary: 'Get token information'
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api'
required: true
schema:
type: string
responses:
200:
description: 'Token information'
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
client_id:
type: string
user_id:
type: integer
expires:
type: integer
scope:
type: string
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/definitions/Response401'
405:
description: 'Method Not Allowed'
content:
application/json:
schema:
allOf:
-
$ref: '#/definitions/Response401'
-
properties:
error_uri:
type: string
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/oauth/token:
post:
tags:
- authentication
summary: 'Get a new token'
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'Client credentials (Basic Authorization)
Required scope :
- user_api'
required: true
schema:
type: string
-
name: body
in: body
description: "grant_type available:
password, refresh_token, authorization_code
with all grant_type :
- scope. The scope list : user_api, user_api.catalogs.private
with grant_type = password
- username * required
- password * required
with grant_type = refresh_token
- refresh_token * required
with grant_type = authorization_code
- code * required
\n"
required: true
schema:
type: object
properties:
grant_type:
type: string
required: true
scope:
type: string
required: false
username:
type: string
required: false
password:
type: string
required: false
code:
type: string
required: false
refresh_token:
type: string
required: false
responses:
200:
description: 'Token information'
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
expires_in:
type: integer
token_type:
type: string
scope:
type: string
refresh_token:
type: string
client_id:
type: string
user_id:
type: integer
expires:
type: integer
user_culture:
type: string
user_language:
type: string
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/definitions/Response401'
405:
description: 'Method Not Allowed'
content:
application/json:
schema:
allOf:
-
$ref: '#/definitions/Response401'
-
properties:
error_uri:
type: string
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/folders/{id}':
get:
tags:
- documents
summary: 'Get a specific folder'
description: ''
operationId: getFolder
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.documents.folders.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by folder ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/FolderColumns'
responses:
200:
description: 'Folder object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseFolder'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
404:
description: 'Resouce not found'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/folders/count:
get:
tags:
- documents
summary: 'Count the folders'
description: ''
operationId: getCountFolders
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.documents.folders.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by folder ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of folders'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountFolders'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/folders:
get:
tags:
- documents
summary: 'Get all the folders'
description: ''
operationId: getFolders
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.documents.folders.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/FolderColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/FolderOrders'
-
name: 'search[id]'
in: query
description: 'Search by folder ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Folder objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseFolders'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/documents:
get:
tags:
- documents
summary: 'Get all the documents'
description: ''
operationId: getDocuments
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.documents.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/DocumentWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/DocumentColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/DocumentOrders'
-
name: 'search[id]'
in: query
description: 'Search by document ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[folder]'
in: query
description: 'Search by folder ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[building]'
in: query
description: 'Search by building ID'
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[residence]'
in: query
description: 'Search by residence ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
description: 'Search by property ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
description: 'Search by type ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[culture]'
in: query
description: 'Search by culture'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[name]'
in: query
description: 'Search by name'
required: false
schema:
type: string
-
name: 'search[website]'
in: query
description: 'Available on website'
required: false
schema:
type: boolean
-
name: 'search[extranet]'
in: query
description: 'Available on extranet'
required: false
schema:
type: boolean
-
name: 'search[private]'
in: query
description: 'Is private'
required: false
schema:
type: boolean
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Document objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDocuments'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/documents/count:
get:
tags:
- documents
summary: 'Count the documents'
description: ''
operationId: getCountDocuments
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.documents.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by document ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[folder]'
in: query
description: 'Search by folder ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[building]'
in: query
description: 'Search by building ID'
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[residence]'
in: query
description: 'Search by residence ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
description: 'Search by property ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
description: 'Search by type ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[culture]'
in: query
description: 'Search by culture'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[name]'
in: query
description: 'Search by name'
required: false
schema:
type: string
-
name: 'search[website]'
in: query
description: 'Available on website'
required: false
schema:
type: boolean
-
name: 'search[extranet]'
in: query
description: 'Available on extranet'
required: false
schema:
type: boolean
-
name: 'search[private]'
in: query
description: 'Is private'
required: false
schema:
type: boolean
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of documents'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountDocuments'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/documents/{id}':
delete:
tags:
- documents
summary: 'Delete a specific document'
description: ''
operationId: deleteDocument
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.documents.delete'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by document ID'
required: true
schema:
type: integer
responses:
200:
description: Success
content:
application/json:
schema:
type: object
properties:
id:
type: integer
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
404:
description: 'Resouce not found'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- documents
summary: 'Get a specific document'
description: ''
operationId: getDocument
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.documents.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by document ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/DocumentWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/DocumentColumns'
responses:
200:
description: 'Document object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDocument'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
404:
description: 'Resouce not found'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/books/count:
get:
tags:
- books
summary: 'Count the books'
description: ''
operationId: getCountBooks
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.books.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by book ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[step]'
in: query
description: 'Search by step ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
description: 'Search by type ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subtype]'
in: query
description: 'Search by subtype ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[owner]'
in: query
description: 'Search by owner ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[reference]'
in: query
description: 'Search by reference ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subreference]'
in: query
description: 'Search by subreference ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[contracted_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[contracted_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[start_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[start_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[end_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[end_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of Book'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountBooks'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/books/{id}':
get:
tags:
- books
summary: 'Get a specific book'
description: ''
operationId: getBook
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.books.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by book ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/BookWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/BookColumns'
responses:
200:
description: 'Book object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseBook'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
patch:
tags:
- books
summary: 'Edit book'
description: ''
operationId: patchBook
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.books.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostBook'
responses:
200:
description: Book
content:
application/json:
schema:
$ref: '#/definitions/ResponseBook'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/books:
post:
tags:
- books
summary: 'Create book'
description: ''
operationId: postBook
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.books.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostBook'
responses:
200:
description: 'New Book'
content:
application/json:
schema:
$ref: '#/definitions/ResponseBook'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- books
summary: 'Get all the books'
description: ''
operationId: getBooks
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.books.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/BookWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/BookColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/BookOrders'
-
name: 'search[id]'
in: query
description: 'Search by book ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[step]'
in: query
description: 'Search by step ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
description: 'Search by type ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subtype]'
in: query
description: 'Search by subtype ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[owner]'
in: query
description: 'Search by owner ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[reference]'
in: query
description: 'Search by reference ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subreference]'
in: query
description: 'Search by subreference ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[contracted_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[contracted_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[start_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[start_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[end_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[end_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Book objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseBooks'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/book:
post:
tags:
- books
summary: '!!! DEPRECATED : DO NOT USE !!!'
deprecated: true
description: ''
operationId: postBookOld
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.books.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostBook'
responses:
200:
description: 'New Book'
content:
application/json:
schema:
$ref: '#/definitions/ResponseBook'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/book/{id}':
post:
tags:
- books
summary: '!!! DEPRECATED : DO NOT USE !!!'
deprecated: true
description: ''
operationId: patchBookOld
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.books.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostBook'
responses:
200:
description: Book
content:
application/json:
schema:
$ref: '#/definitions/ResponseBook'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/contacts/{id}':
get:
tags:
- contacts
summary: 'Get a specific contact'
description: ''
operationId: getContact
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contacts.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by contact ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ContactWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ContactColumns'
responses:
200:
description: 'Contact object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseContact'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
delete:
tags:
- contacts
summary: 'Delete a specific contact'
description: ''
operationId: deleteContact
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contacts.delete'
required: true
schema:
type: string
-
name: id
in: path
description: 'Delete by contact ID'
required: true
schema:
type: integer
responses:
200:
description: 'Contact deleted'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/contacts/count:
get:
tags:
- contacts
summary: 'Count the contacts'
description: ''
operationId: getCountContacts
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contacts.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by contact ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[category]'
in: query
description: 'Search by category ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[city]'
in: query
description: 'Search by city ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[country]'
in: query
description: 'Search by country'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[language]'
in: query
description: 'Search by language'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[activity]'
in: query
description: 'Search by activity ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[has_email]'
in: query
required: false
schema:
type: boolean
-
name: 'search[has_phone]'
in: query
required: false
schema:
type: boolean
-
name: 'search[has_mobile]'
in: query
required: false
schema:
type: boolean
-
name: 'search[extranet]'
in: query
required: false
schema:
type: boolean
-
name: 'search[mailing_subscription]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[mailing_subscription_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[mailing_subscription_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[mailing_unsubscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[mailing_unsubscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_subscription]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[emailing_subscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_subscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_subscription]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[magazine_subscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_subscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_unsubscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_unsubscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[relationship]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[title]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[civil_status]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of Contact'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountContacts'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/contact:
post:
tags:
- contacts
summary: 'Create contact'
description: ''
operationId: postContact
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contacts.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostContact'
responses:
200:
description: 'Contact new id'
content:
application/json:
schema:
$ref: '#/definitions/ResponseContact'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/contacts:
get:
tags:
- contacts
summary: 'Get all the contacts'
description: ''
operationId: getContacts
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contacts.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ContactWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ContactColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/ContactOrders'
-
name: 'search[id]'
in: query
description: 'Search by contact ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[category]'
in: query
description: 'Search by category ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[city]'
in: query
description: 'Search by city ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[country]'
in: query
description: 'Search by country'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[language]'
in: query
description: 'Search by language'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[activity]'
in: query
description: 'Search by activity ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[has_email]'
in: query
required: false
schema:
type: boolean
-
name: 'search[has_phone]'
in: query
required: false
schema:
type: boolean
-
name: 'search[has_mobile]'
in: query
required: false
schema:
type: boolean
-
name: 'search[extranet]'
in: query
required: false
schema:
type: boolean
-
name: 'search[mailing_subscription]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[mailing_subscription_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[mailing_subscription_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[mailing_unsubscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[mailing_unsubscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_subscription]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[emailing_subscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_subscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_subscription]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[magazine_subscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_subscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_unsubscribe_at_min]'
in: query
required: false
schema:
type: string
-
name: 'search[magazine_unsubscribe_at_max]'
in: query
required: false
schema:
type: string
-
name: 'search[relationship]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[title]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[civil_status]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Contact objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseContacts'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/histories/count:
get:
tags:
- histories
summary: 'Count histories'
description: ''
operationId: getCountHistories
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.histories.read'
required: true
schema:
type: string
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/HistoryWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/HistoryColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/HistoryOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[agency_co]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[company]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[building]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[residence]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[contact]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origine]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origine_sub]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[access]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[calendar_is]'
in: query
required: false
schema:
type: boolean
-
name: 'search[start_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[start_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[end_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[end_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[created_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[created_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_max]'
in: query
required: false
schema:
type: string
format: date-time
responses:
200:
description: 'Number of Histories'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountHistories'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/history:
post:
tags:
- histories
summary: 'Post history'
description: ''
operationId: postHistory
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.histories.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostHistory'
responses:
200:
description: 'History object'
content:
application/json:
schema:
type: object
properties:
id:
type: integer
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/histories/{id}':
get:
tags:
- histories
summary: 'Get a specific history'
description: ''
operationId: getHistory
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.histories.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by history ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/HistoryWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/HistoryColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/HistoryOrders'
responses:
200:
description: 'History object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseHistory'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/histories:
get:
tags:
- histories
summary: 'Get all histories'
description: ''
operationId: getHistories
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.histories.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 1000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/HistoryWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/HistoryColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/HistoryOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[agency_co]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[company]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[building]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[residence]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[contact]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origine]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origine_sub]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origin_sub]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[access]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[calendar_is]'
in: query
required: false
schema:
type: boolean
-
name: 'search[start_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[start_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[end_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[end_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[created_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[created_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_max]'
in: query
required: false
schema:
type: string
format: date-time
responses:
200:
description: 'List of Histories object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseHistories'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/history/{id}':
post:
tags:
- histories
summary: 'Edit history'
description: ''
operationId: patchHistory
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.histories.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostHistory'
responses:
200:
description: History
content:
application/json:
schema:
type: object
properties:
id:
type: integer
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/medias:
get:
tags:
- catalogs
summary: 'Get medias'
description: ''
operationId: getCatalogsMedias
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs'
required: true
schema:
type: string
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CatalogMediaColumns'
responses:
200:
description: 'Catalog medias'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalogMedia'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/countries:
get:
tags:
- catalogs
summary: 'Get countries'
description: ''
operationId: getCatalogsCountries
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs'
required: true
schema:
type: string
-
name: 'search[culture]'
in: query
description: 'Search by culture'
required: false
schema:
$ref: '#/definitions/Cultures'
responses:
200:
description: 'Catalog countries'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalogCountries'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/custom_tags:
get:
tags:
- catalogs
summary: 'Get custom_tags'
description: ''
operationId: getCatalogsCustomTags
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'column[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CustomTagsColumns'
-
name: 'search[id]'
in: query
description: 'Search by tag ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
description: '1 = Tags for Estate entity, 2 = Tags for Contact entity'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[field]'
in: query
description: 'Type of field, 1 = check box, 2 = value input'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Custom_tags'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCustomTags'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/cities:
get:
tags:
- catalogs
summary: 'Get cities'
description: ''
operationId: getCatalogsCities
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs.location'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CityColumns'
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/CityWith'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/CityOrders'
-
name: 'search[id]'
in: query
description: 'Search by city ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[culture]'
in: query
description: 'Search by culture'
required: false
schema:
$ref: '#/definitions/Cultures'
-
name: 'search[name]'
in: query
description: 'Search by name'
required: false
schema:
type: string
-
name: 'search[zipcode]'
in: query
description: 'Search by zipcode'
required: false
schema:
type: integer
-
name: 'search[country]'
in: query
description: 'Search by country'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[region_id]'
in: query
description: 'Search by region id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Cities'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCities'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/sub_origins:
get:
tags:
- catalogs
summary: 'Get sub_origins'
description: ''
operationId: getCatalogsSubOrigins
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/SubOriginColumns'
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/SubOriginWith'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/SubOriginOrders'
-
name: 'search[id]'
in: query
description: 'Search by sub_origin ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[active]'
in: query
required: false
schema:
type: boolean
-
name: 'search[name]'
in: query
description: 'Search by name'
required: false
schema:
type: string
-
name: 'search[brand]'
in: query
description: 'Search by brand id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origin]'
in: query
description: 'Search by origin id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[provider]'
in: query
description: 'Search by provider id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Sub_origins'
content:
application/json:
schema:
$ref: '#/definitions/ResponseSubOrigins'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/apindex:
get:
tags:
- catalogs
summary: 'Get apindex'
description: ''
operationId: getCatalogsApindex
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs'
required: true
schema:
type: string
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ApindexColumns'
-
name: 'search[type]'
in: query
description: 'Search by apindex Type ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Apindex entries'
content:
application/json:
schema:
$ref: '#/definitions/ResponseApindex'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/cultures:
get:
tags:
- catalogs
summary: 'Get cultures'
description: ''
operationId: getCatalogsCultures
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs'
required: true
schema:
type: string
responses:
200:
description: 'List of cultures available + trad'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalogCultures'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/districts:
get:
tags:
- catalogs
summary: 'Get districts'
description: ''
operationId: getCatalogsDistricts
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs.location'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/DistrictColumns'
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/DistrictWith'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/DistrictOrders'
-
name: 'search[id]'
in: query
description: 'Search by district ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[name]'
in: query
description: 'Search by name'
required: false
schema:
type: string
-
name: 'search[city_id]'
in: query
description: 'Search by city id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Districts'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDistricts'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/regions:
get:
tags:
- catalogs
summary: 'Get regions'
description: ''
operationId: getCatalogsRegions
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs.location'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/RegionColumns'
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/RegionWith'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/RegionOrders'
-
name: 'search[id]'
in: query
description: 'Search by region ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[culture]'
in: query
description: 'Search by culture'
required: false
schema:
$ref: '#/definitions/Cultures'
-
name: 'search[name]'
in: query
description: 'Search by name'
required: false
schema:
type: string
-
name: 'search[code]'
in: query
description: 'Search by code'
required: false
schema:
type: integer
-
name: 'search[country]'
in: query
description: 'Search by country'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[parent_id]'
in: query
description: 'Search by parent id'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Regions'
content:
application/json:
schema:
$ref: '#/definitions/ResponseRegions'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/fields:
get:
tags:
- catalogs
summary: 'Get catalog fields'
description: ''
operationId: getCatalogsFields
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs'
required: true
schema:
type: string
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/FieldsColumns'
-
name: 'search[culture]'
in: query
description: culture
required: false
schema:
type: string
-
name: 'search[table]'
in: query
description: table
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
responses:
200:
description: 'Catalog entries'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalogField'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/phone_codes:
get:
tags:
- catalogs
summary: 'Get phone codes'
description: ''
operationId: getCatalogsPhoneCodes
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs'
required: true
schema:
type: string
responses:
200:
description: 'Catalog phone codes'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalogPhoneCodes'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs/lots:
get:
tags:
- catalogs
summary: 'Get catalog lots'
description: ''
operationId: getCatalogsLots
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'column[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CatalogLotsColumns'
responses:
200:
description: 'List of Lots'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalogLots'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/catalogs:
get:
tags:
- catalogs
summary: 'Get all the catalogs'
description: ''
operationId: getCatalogs
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs
Optional scope :
- user_api.catalogs.private'
required: true
schema:
type: string
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CatalogColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/CatalogOrders'
-
name: 'search[catalog]'
in: query
description: 'Search by catalog name'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[culture]'
in: query
description: 'Search by culture'
required: false
schema:
$ref: '#/definitions/Cultures'
responses:
200:
description: 'List of Catalogs'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalogs'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/catalogs/{name}':
get:
tags:
- catalogs
summary: 'Get a specific catalog'
description: ''
operationId: getCatalog
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.catalogs
Optional scope :
- user_api.catalogs.private'
required: true
schema:
type: string
-
name: name
in: path
description: 'Catalog name'
required: true
schema:
type: string
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CatalogColumns'
responses:
200:
description: 'Catalog entries'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCatalog'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/request/{id}':
post:
tags:
- requests
summary: 'Edit request'
description: ''
operationId: patchRequest
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.requests.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostRequest'
responses:
200:
description: Request
content:
application/json:
schema:
$ref: '#/definitions/ResponseRequest'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/requests/{id}':
get:
tags:
- requests
summary: 'Get a specific request'
description: ''
operationId: getRequest
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.requests.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by property ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/RequestWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/RequestColumns'
responses:
200:
description: 'Request object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseRequest'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/requests/{id}/crossings':
get:
tags:
- requests
summary: 'Get all the crossings of a specific request'
description: ''
operationId: getRequestCrossings
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.requests.crossings.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by request ID'
required: true
schema:
type: integer
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/CrossingWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CrossingColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/CrossingOrders'
-
name: 'search[step]'
in: query
description: 'Search by step ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Crossing objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCrossings'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/requests/count:
get:
tags:
- requests
summary: 'Count the requests'
description: ''
operationId: getCountRequests
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.requests.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by request ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[active]'
in: query
required: false
schema:
type: boolean
-
name: 'search[contact]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency_co]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[classification]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agreement_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agreement_start_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
pattern: '^([0-9]{2,4})-([0-1][0-9])-([0-3][0-9])(?:( [0-2][0-9]):([0-5][0-9]):([0-5][0-9]))?$'
-
name: 'search[agreement_start_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[agreement_end_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[agreement_end_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[agreement_reference]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[category]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subcategory]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subtype]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origine]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[suborigine]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[suborigin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[crossing_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[crossing_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[crossing_auto]'
in: query
required: false
deprecated: true
schema:
type: boolean
-
name: 'search[crossing_automatic]'
in: query
required: false
schema:
type: boolean
-
name: 'search[validated]'
in: query
required: false
schema:
type: boolean
-
name: 'search[emailing]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[emailing_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_subscribe_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_subscribe_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[country]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[sector]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[room_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[rooms_min]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[room_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[rooms_max]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[bedroom_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedrooms_min]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[bedroom_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedrooms_max]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[margin_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[margin_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_unit]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[floor_area_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[start_at]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[end_at]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[price_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_currency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[floor_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[floor_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[delivery_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[delivery_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[view]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[view_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[standing]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[availability]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[condition]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[proximity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[service]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[activity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[tag]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[last_action_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[last_action_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[reference]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[created_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_by]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'Number of Request'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountRequests'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/requests:
get:
tags:
- requests
summary: 'Get all the requests'
description: ''
operationId: getRequests
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.requests.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/RequestWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/RequestColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/RequestOrders'
-
name: 'search[id]'
in: query
description: 'Search by request ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[active]'
in: query
required: false
schema:
type: boolean
-
name: 'search[contact]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency_co]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[classification]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agreement_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agreement_start_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
pattern: '^([0-9]{2,4})-([0-1][0-9])-([0-3][0-9])(?:( [0-2][0-9]):([0-5][0-9]):([0-5][0-9]))?$'
-
name: 'search[agreement_start_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[agreement_end_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[agreement_end_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[agreement_reference]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[category]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subcategory]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subtype]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origine]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[suborigine]'
in: query
required: false
deprecated: true
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[suborigin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[crossing_auto]'
in: query
required: false
deprecated: true
schema:
type: boolean
-
name: 'search[crossing_automatic]'
in: query
required: false
schema:
type: boolean
-
name: 'search[validated]'
in: query
required: false
schema:
type: boolean
-
name: 'search[emailing]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[emailing_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_subscribe_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_subscribe_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[emailing_unsubscribe_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[country]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[sector]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[room_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[rooms_min]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[room_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[rooms_max]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[bedroom_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedrooms_min]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[bedroom_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedrooms_max]'
in: query
required: false
deprecated: true
schema:
type: integer
-
name: 'search[margin_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[margin_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_unit]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[floor_area_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[start_at]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[end_at]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[price_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_currency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[floor_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[floor_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[delivery_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[delivery_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[view]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[view_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[standing]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[availability]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[condition]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[proximity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[service]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[activity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[tag]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[last_action_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[last_action_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[reference]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[created_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_by]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Request objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseRequests'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/request:
post:
tags:
- requests
summary: 'Post request'
description: ''
operationId: postRequest
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.requests.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostRequest'
responses:
200:
description: 'New Request'
content:
application/json:
schema:
$ref: '#/definitions/ResponseRequest'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/brands/count:
get:
tags:
- brands
summary: 'Count brands'
description: ''
operationId: getCountBrands
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.brands.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[account]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'Number of Brands'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountBrands'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/brands/{id}/document':
post:
tags:
- brands
summary: 'Upload document'
description: ''
operationId: postBrandDocument
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.brands.document.write'
required: true
schema:
type: string
-
name: id
in: path
description: 'Brand ID'
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
document:
type: string
format: binary
folder_id:
type: integer
responses:
200:
description: 'Document object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDocument'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/brands/{id}':
get:
tags:
- brands
summary: 'Get a specific brand'
description: ''
operationId: getBrand
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.brands.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by brand ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/BrandColumns'
responses:
200:
description: 'Brands object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseBrand'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/brands:
get:
tags:
- brands
summary: 'Get all brands'
description: ''
operationId: getBrands
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.brands.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 1000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/BrandColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/BrandssOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[account]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Brands object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseBrands'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/tickets:
get:
tags:
- tickets
summary: 'Get all the tickets'
description: ''
operationId: getTickets
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.tickets.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/TicketWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/TicketColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/TicketOrders'
-
name: 'search[id]'
in: query
description: 'Search by ticket ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[step]'
in: query
description: 'Search by step ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Ticket objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseTickets'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/users:
get:
tags:
- users
summary: 'Get all the users'
description: ''
operationId: getUsers
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/UserWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/UserColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/UserOrders'
-
name: 'search[id]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[active]'
in: query
description: 'Search by active'
required: false
schema:
type: boolean
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of User objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseUsers'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
post:
tags:
- users
summary: 'Create user'
description: ''
operationId: postUser
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostUser'
responses:
200:
description: 'New User'
content:
application/json:
schema:
$ref: '#/definitions/ResponseUser'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/user:
post:
tags:
- users
summary: '!!! DEPRECATED : DO NOT USE !!!'
deprecated: true
description: ''
operationId: postUserOld
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostUser'
responses:
200:
description: 'New User'
content:
application/json:
schema:
$ref: '#/definitions/ResponseUser'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/users/{id}':
post:
tags:
- users
summary: '!!! DEPRECATED : DO NOT USE !!!'
deprecated: true
description: ''
operationId: patchUserOld
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostUser'
responses:
200:
description: User
content:
application/json:
schema:
$ref: '#/definitions/ResponseUser'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- users
summary: 'Get a specific user'
description: ''
operationId: getUser
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by user ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/UserWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/UserColumns'
responses:
200:
description: 'User object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseUser'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
patch:
tags:
- users
summary: 'Edit user'
description: ''
operationId: patchUser
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostUser'
responses:
200:
description: User
content:
application/json:
schema:
$ref: '#/definitions/ResponseUser'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/users/sectors/{id}':
delete:
tags:
- users
summary: 'Delete a specific user sector'
description: ''
operationId: deleteUserSector
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.write'
required: true
schema:
type: string
-
name: id
in: path
description: 'Delete by user sector ID'
required: true
schema:
type: integer
responses:
200:
description: 'User sector deleted'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDeleteUserSector'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/users/{id}/picture':
post:
tags:
- users
summary: 'Upload user picture'
description: ''
operationId: postUserPicture
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.write'
required: true
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
picture:
type: string
format: binary
responses:
200:
description: Pictures
content:
application/json:
schema:
$ref: '#/definitions/ResponseUserPicture'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/users/count:
get:
tags:
- users
summary: 'Count the users'
description: ''
operationId: getCountUsers
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.users.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[active]'
in: query
description: 'Search by active'
required: false
schema:
type: boolean
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of users'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountUsers'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/agencies:
get:
tags:
- agencies
summary: 'Get all the agencies'
description: ''
operationId: getAgencies
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.agencies.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/AgencyWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/AgencyColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/AgencyOrders'
-
name: 'search[id]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[account]'
in: query
description: 'Search by account ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[city]'
in: query
description: 'Search by city ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[region]'
in: query
description: 'Search by region ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[active]'
in: query
description: 'Search by active'
required: false
schema:
type: boolean
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Agency objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseAgencies'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/agencies/count:
get:
tags:
- agencies
summary: 'Count the agencies'
description: ''
operationId: getCountAgencies
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.agencies.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[account]'
in: query
description: 'Search by account ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[city]'
in: query
description: 'Search by city ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[region]'
in: query
description: 'Search by region ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[active]'
in: query
description: 'Search by active'
required: false
schema:
type: boolean
responses:
200:
description: 'Number of Agencies'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountAgencies'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/agencies/{id}':
get:
tags:
- agencies
summary: 'Get a specific agency'
description: ''
operationId: getAgency
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.agencies.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by agency ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/AgencyWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/AgencyColumns'
responses:
200:
description: 'Agency object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseAgency'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/companies/count:
get:
tags:
- companies
summary: 'Count companies'
description: ''
operationId: getCountCompanies
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.companies.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[account]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'Number of Companies'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountCompanies'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/companies/{id}':
get:
tags:
- companies
summary: 'Get a specific company'
description: ''
operationId: getCompany
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.companies.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by company ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CompanyColumns'
responses:
200:
description: 'Companies object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCompany'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/companies/{id}/document':
post:
tags:
- companies
summary: 'Upload document'
description: ''
operationId: postCompanyDocument
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.companies.document.write'
required: true
schema:
type: string
-
name: id
in: path
description: 'Company ID'
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
document:
type: string
format: binary
folder_id:
type: integer
responses:
200:
description: 'Document object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDocument'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/companies:
get:
tags:
- companies
summary: 'Get all companies'
description: ''
operationId: getCompanies
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.companies.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 1000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CompanyColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/CompanyOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[account]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Companies object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCompanies'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/residences/{id}':
post:
tags:
- residences
summary: 'Edit residence'
description: ''
operationId: patchResidence
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.residences.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostResidence'
responses:
200:
description: Residence
content:
application/json:
schema:
$ref: '#/definitions/ResponseResidence'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- residences
summary: 'Get a specific residence'
description: ''
operationId: getResidence
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.residences.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by residence ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ResidenceWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ResidenceColumns'
responses:
200:
description: 'Residences object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseResidence'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/residences:
get:
tags:
- residences
summary: 'Get all residences'
description: ''
operationId: getResidences
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.residences.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 1000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ResidenceWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ResidenceColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/ResidenceOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[parent]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[company]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[city]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[district]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[country]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[polygon]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[not_polygon]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[created_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[created_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Residences object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseResidences'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
post:
tags:
- residences
summary: 'Post residence'
description: ''
operationId: postResidence
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.residences.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostResidence'
responses:
200:
description: 'New Residence'
content:
application/json:
schema:
$ref: '#/definitions/ResponseResidence'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/residences/count:
get:
tags:
- residences
summary: 'Count residences'
description: ''
operationId: getCountResidences
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.residences.read'
required: true
schema:
type: string
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ResidenceWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ResidenceColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/ResidenceOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[parent]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[company]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[city]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[district]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[country]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[polygon]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[not_polygon]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[created_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[created_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_min]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[updated_at_max]'
in: query
required: false
schema:
type: string
format: date-time
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of Residences'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountResidences'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/residence/{id}/document':
post:
tags:
- residences
summary: 'Upload document'
description: ''
operationId: postResidenceDocument
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.residences.document.write'
required: true
schema:
type: string
-
name: id
in: path
description: 'Residence ID'
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
document:
type: string
format: binary
responses:
200:
description: 'Document object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDocument'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/calendar/{id}':
post:
tags:
- calendars
summary: 'Edit calendar'
description: ''
operationId: patchCalendar
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.calendars.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostCalendar'
responses:
200:
description: Calendar
content:
application/json:
schema:
$ref: '#/definitions/ResponseCalendar'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/calendars/{id}':
delete:
tags:
- calendars
summary: 'Delete a specific calendar'
description: ''
operationId: deleteCalendar
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.calendars.delete'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by calendar ID'
required: true
schema:
type: integer
responses:
200:
description: 'Calendar deleted'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- calendars
summary: 'Get all a specific calendar'
description: ''
operationId: getCalendar
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.calendars.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by agency ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/CalendarWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CalendarColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/CalendarOrders'
responses:
200:
description: 'List of Calendar objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCalendar'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/calendars:
get:
tags:
- calendars
summary: 'Get all the calendars'
description: ''
operationId: getCalendars
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.calendars.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/CalendarWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/CalendarColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/CalendarOrders'
-
name: 'search[id]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[reference]'
in: query
description: 'Search by reference'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[contact]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[history]'
in: query
description: 'Search by history ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
description: 'Search by property ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[group]'
in: query
description: 'Search by group ID'
required: false
schema:
type: boolean
-
name: 'search[start_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[start_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
format: date-time
-
name: 'search[end_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[end_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[repeat_end_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[repeat_end_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[created_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[created_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_at_min]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_at_max]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[is_repeated]'
in: query
required: false
schema:
type: boolean
-
name: 'search[repeat]'
in: query
required: false
schema:
type: array
collectionFormat: multi
items:
type: string
enum:
- day
- week
- year
responses:
200:
description: 'List of Calendar objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCalendars'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/calendar:
post:
tags:
- calendars
summary: 'Post calendar'
description: ''
operationId: postCalendar
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.calendars.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostCalendar'
responses:
200:
description: 'Calendar object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCalendar'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/contracts/{id}':
post:
tags:
- contracts
summary: 'Edit contract'
description: ''
operationId: patchContract
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contracts.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostContract'
responses:
200:
description: Contract
content:
application/json:
schema:
$ref: '#/definitions/ResponseContract'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
delete:
tags:
- contracts
summary: 'Delete a specific contract'
description: ''
operationId: deleteContract
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contracts.delete'
required: true
schema:
type: string
-
name: id
in: path
description: 'Delete by contract ID'
required: true
schema:
type: integer
responses:
200:
description: 'Contract deleted'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- contracts
summary: 'Get a specific contract'
description: ''
operationId: getContract
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contracts.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by contract ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ContractWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ContractColumns'
responses:
200:
description: 'Contract object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseContract'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/contracts/count:
get:
tags:
- contracts
summary: 'Count the contracts'
description: ''
operationId: getCountContracts
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contracts.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by contract ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
description: 'Search by property ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[step]'
in: query
description: 'Search by step ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[price_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[commission_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[commission_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[project_start]'
in: query
required: false
schema:
type: string
-
name: 'search[project_end]'
in: query
required: false
schema:
type: string
-
name: 'search[offer_start]'
in: query
required: false
schema:
type: string
-
name: 'search[offer_end]'
in: query
required: false
schema:
type: string
-
name: 'search[commitment_start]'
in: query
required: false
schema:
type: string
-
name: 'search[commitment_end]'
in: query
required: false
schema:
type: string
-
name: 'search[coolingoff_end_start]'
in: query
required: false
schema:
type: string
-
name: 'search[coolingoff_end_end]'
in: query
required: false
schema:
type: string
-
name: 'search[contract_start]'
in: query
required: false
schema:
type: string
-
name: 'search[contract_end]'
in: query
required: false
schema:
type: string
-
name: 'search[scheduled_start]'
in: query
required: false
schema:
type: string
-
name: 'search[scheduled_end]'
in: query
required: false
schema:
type: string
-
name: 'search[condition_precedent_start]'
in: query
required: false
schema:
type: string
-
name: 'search[condition_precedent_end]'
in: query
required: false
schema:
type: string
-
name: 'search[collected_start]'
in: query
required: false
schema:
type: string
-
name: 'search[collected_end]'
in: query
required: false
schema:
type: string
-
name: 'search[tax_notice_start]'
in: query
required: false
schema:
type: string
-
name: 'search[tax_notice_end]'
in: query
required: false
schema:
type: string
-
name: 'search[canceled_start]'
in: query
required: false
schema:
type: string
-
name: 'search[canceled_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'Number of Contract'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountContracts'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/contracts:
post:
tags:
- contracts
summary: 'Create contract'
description: ''
operationId: postContract
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contracts.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostContract'
responses:
200:
description: 'New Contract'
content:
application/json:
schema:
$ref: '#/definitions/ResponseContract'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- contracts
summary: 'Get all the contracts'
description: ''
operationId: getContracts
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.contracts.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/ContractWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/ContractColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/ContractOrders'
-
name: 'search[id]'
in: query
description: 'Search by contract ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[property]'
in: query
description: 'Search by property ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
description: 'Search by agency ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
description: 'Search by user ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[step]'
in: query
description: 'Search by step ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[price_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[commission_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[commission_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[project_start]'
in: query
required: false
schema:
type: string
-
name: 'search[project_end]'
in: query
required: false
schema:
type: string
-
name: 'search[offer_start]'
in: query
required: false
schema:
type: string
-
name: 'search[offer_end]'
in: query
required: false
schema:
type: string
-
name: 'search[commitment_start]'
in: query
required: false
schema:
type: string
-
name: 'search[commitment_end]'
in: query
required: false
schema:
type: string
-
name: 'search[coolingoff_end_start]'
in: query
required: false
schema:
type: string
-
name: 'search[coolingoff_end_end]'
in: query
required: false
schema:
type: string
-
name: 'search[contract_start]'
in: query
required: false
schema:
type: string
-
name: 'search[contract_end]'
in: query
required: false
schema:
type: string
-
name: 'search[scheduled_start]'
in: query
required: false
schema:
type: string
-
name: 'search[scheduled_end]'
in: query
required: false
schema:
type: string
-
name: 'search[condition_precedent_start]'
in: query
required: false
schema:
type: string
-
name: 'search[condition_precedent_end]'
in: query
required: false
schema:
type: string
-
name: 'search[collected_start]'
in: query
required: false
schema:
type: string
-
name: 'search[collected_end]'
in: query
required: false
schema:
type: string
-
name: 'search[tax_notice_start]'
in: query
required: false
schema:
type: string
-
name: 'search[tax_notice_end]'
in: query
required: false
schema:
type: string
-
name: 'search[canceled_start]'
in: query
required: false
schema:
type: string
-
name: 'search[canceled_end]'
in: query
required: false
schema:
type: string
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Contract objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseContracts'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/properties:
post:
tags:
- properties
summary: 'Create property'
description: ''
operationId: postProperty
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostProperty'
responses:
200:
description: 'Property new id'
content:
application/json:
schema:
$ref: '#/definitions/ResponseProperty'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- properties
summary: 'Get all properties'
description: ''
operationId: getProperties
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/PropertyWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/PropertyColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/PropertyOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[parent]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[company]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[residence]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[floor_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[floor_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[floor_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[step]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[category]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subcategory]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subtype]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[group]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[country]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[condition]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[availability]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[construction_year_min]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[construction_year_max]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[renovation_year_min]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[renovation_year_max]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[room_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[room_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedroom_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedroom_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[agreement_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agreement_reference]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[agreement_start_at]'
in: query
required: false
schema:
type: string
-
name: 'search[agreement_end_at]'
in: query
required: false
schema:
type: string
-
name: 'search[status]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[standing]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[hot_water_device]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[hot_water_access]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[heating_device]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[heating_access]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[price_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[area_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[referral]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subreferral]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[view_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[adjacency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[key_reference]'
in: query
required: false
schema:
type: string
-
name: 'search[owner]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[tenant]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[activity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[on_demande_price]'
in: query
required: false
deprecated: true
schema:
type: boolean
-
name: 'search[on_demand_price]'
in: query
required: false
schema:
type: boolean
-
name: 'search[region]'
in: query
required: false
schema:
type: integer
-
name: 'search[city]'
in: query
required: false
schema:
type: integer
-
name: 'search[district]'
in: query
required: false
schema:
type: integer
-
name: 'search[reference]'
in: query
required: false
schema:
type: string
-
name: 'search[provider]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[tag]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[custom_tag]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[service]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[proximity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[areas]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[view_landscape]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[has_picture]'
in: query
required: false
schema:
type: boolean
-
name: 'search[area_land_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_land_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[sms]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
responses:
200:
description: 'List of Properties object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseProperties'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/properties/count:
get:
tags:
- properties
summary: 'Count properties'
description: ''
operationId: getCountProperties
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.read'
required: true
schema:
type: string
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/PropertyWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/PropertyColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/PropertyOrders'
-
name: 'search[id]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[parent]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[company]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[residence]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[floor_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[floor_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[floor_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[step]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[category]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subcategory]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[subtype]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[country]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[condition]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[availability]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[construction_year_min]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[construction_year_max]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[renovation_year_min]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[renovation_year_max]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[room_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[room_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedroom_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[bedroom_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[agreement_type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agreement_reference]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiString'
-
name: 'search[agreement_start_at]'
in: query
required: false
schema:
type: string
-
name: 'search[agreement_end_at]'
in: query
required: false
schema:
type: string
-
name: 'search[status]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[standing]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[hot_water_device]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[hot_water_access]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[heating_device]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[heating_access]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[price_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[price_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[created_start]'
in: query
required: false
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
schema:
type: string
-
name: 'search[area_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[activity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[on_demande_price]'
in: query
required: false
deprecated: true
schema:
type: boolean
-
name: 'search[on_demand_price]'
in: query
required: false
schema:
type: boolean
-
name: 'search[region]'
in: query
required: false
schema:
type: integer
-
name: 'search[city]'
in: query
required: false
schema:
type: integer
-
name: 'search[district]'
in: query
required: false
schema:
type: integer
-
name: 'search[reference]'
in: query
required: false
schema:
type: string
-
name: 'search[provider]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[tag]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[custom_tag]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[service]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[proximity]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[areas]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[view_landscape]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[has_picture]'
in: query
required: false
schema:
type: boolean
-
name: 'search[area_land_min]'
in: query
required: false
schema:
type: integer
-
name: 'search[area_land_max]'
in: query
required: false
schema:
type: integer
-
name: 'search[sms]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[keyword]'
in: query
required: false
schema:
type: string
-
name: 'field[category]'
in: query
required: false
description: 'field and ID to count'
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'field[subcategory]'
in: query
required: false
description: 'field and ID to count'
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'field[type]'
in: query
required: false
description: 'field and ID to count'
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'field[subtype]'
in: query
required: false
description: 'field and ID to count'
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'Number of Properties'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountProperties'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/properties/{id}':
post:
tags:
- properties
summary: 'Edit property'
description: ''
operationId: patchProperty
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostProperty'
responses:
200:
description: Property
content:
application/json:
schema:
$ref: '#/definitions/ResponseProperty'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
get:
tags:
- properties
summary: 'Get a specific property'
description: ''
operationId: getProperty
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by property ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/PropertyWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/PropertyColumns'
responses:
200:
description: 'Property object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseProperty'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/properties/{id}/pictures':
post:
tags:
- properties
summary: '!!! DEPRECATED : DO NOT USE !!!'
deprecated: true
description: ''
operationId: postPropertyPictures
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.pictures.write'
required: true
schema:
type: string
-
name: id
in: path
description: 'Property ID'
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
pictures:
type: array
items:
type: string
format: binary
responses:
200:
description: 'Pictures object'
content:
application/json:
schema:
$ref: '#/definitions/ResponsePictures'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/properties/{id}/document':
post:
tags:
- properties
summary: 'Upload document'
description: ''
operationId: postPropertyDocument
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.documents.write'
required: true
schema:
type: string
-
name: id
in: path
description: 'Property ID'
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
document:
type: string
format: binary
responses:
200:
description: 'Document object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseDocument'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/properties/{id}/picture':
post:
tags:
- properties
summary: 'Upload picture'
description: ''
operationId: postPropertyPicture
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.properties.pictures.write'
required: true
schema:
type: string
-
name: id
in: path
description: 'Property ID'
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
picture:
type: string
format: binary
responses:
200:
description: 'Pictures object'
content:
application/json:
schema:
$ref: '#/definitions/ResponsePicture'
400:
description: 'Bad request'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
403:
description: 'Access denied'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/leads:
get:
tags:
- leads
summary: 'Get all the leads'
description: ''
operationId: getLeads
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.leads.read'
required: true
schema:
type: string
-
name: limit
in: query
description: 'The number of records to return (min: 1, max: 2000)'
required: false
schema:
type: integer
default: 100
-
name: offset
in: query
description: 'The number of records to skip (default: 0)'
required: false
schema:
type: integer
default: 0
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/LeadWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/LeadColumns'
-
name: 'order[]'
in: query
description: 'Order the results'
schema:
$ref: '#/definitions/LeadOrders'
-
name: 'search[id]'
in: query
description: 'Search by lead ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[brand]'
in: query
description: 'Search by brand ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[suborigin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[has_parent]'
in: query
required: false
schema:
type: boolean
-
name: 'search[category]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[received_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[received_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[created_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_by]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'List of Lead objects'
content:
application/json:
schema:
$ref: '#/definitions/ResponseLeads'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/lead/{id}':
post:
tags:
- leads
summary: 'Edit lead'
description: ''
operationId: patchLead
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.leads.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostLead'
responses:
200:
description: Lead
content:
application/json:
schema:
$ref: '#/definitions/ResponseLead'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/lead:
post:
tags:
- leads
summary: 'Create lead'
description: ''
operationId: postLead
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.leads.write'
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/definitions/PostLead'
responses:
200:
description: 'New Lead'
content:
application/json:
schema:
$ref: '#/definitions/ResponseLead'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
/api/leads/count:
get:
tags:
- leads
summary: 'Count the leads'
description: ''
operationId: getCountLeads
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.leads.read'
required: true
schema:
type: string
-
name: 'search[id]'
in: query
description: 'Search by lead ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[type]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[user]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[agency]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[company]'
in: query
description: 'Search by company ID'
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[origin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[suborigin]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[has_parent]'
in: query
required: false
schema:
type: boolean
-
name: 'search[category]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
-
name: 'search[created_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[created_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_start]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_end]'
in: query
required: false
description: 'Date-time (format YYYY-MM-DD hh:mm:ss)'
schema:
type: string
-
name: 'search[updated_by]'
in: query
required: false
schema:
$ref: '#/definitions/SchemaArrayMultiInteger'
responses:
200:
description: 'Number of Lead'
content:
application/json:
schema:
$ref: '#/definitions/ResponseCountLeads'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
'/api/leads/{id}':
get:
tags:
- leads
summary: 'Get a specific lead'
description: ''
operationId: getLead
consumes:
- application/json
produces:
- application/json
parameters:
-
name: Authorization
in: header
description: 'The authentication token
Required scope :
- user_api
- user_api.leads.read'
required: true
schema:
type: string
-
name: id
in: path
description: 'Search by lead ID'
required: true
schema:
type: integer
-
name: clean
in: query
description: 'Cleans the response by removing the empty node'
required: false
schema:
type: boolean
default: true
-
name: 'with[]'
in: query
description: 'Add sub entities'
required: false
schema:
$ref: '#/definitions/LeadWith'
-
name: 'columns[]'
in: query
description: 'Allows to select specific columns'
required: false
schema:
$ref: '#/definitions/LeadColumns'
responses:
200:
description: 'Request object'
content:
application/json:
schema:
$ref: '#/definitions/ResponseLead'
401:
description: 'Invalid Bearer token in header Authorization'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
301:
description: Forbidden
content:
application/json:
schema:
$ref: '#/definitions/Response401'
500:
description: 'Internal Server Error'
content:
application/json:
schema:
$ref: '#/definitions/Response401'
tags:
-
name: news
description: 'Access to news'
-
name: sectors
description: 'Access to sectors'
-
name: authentication
description: 'Get a new token'
-
name: documents
description: 'Access to Documents'
-
name: contacts
description: 'Access to contacts'
-
name: histories
description: 'Access to histories'
-
name: catalogs
description: 'Access to catalogs'
-
name: requests
description: 'Access to requests'
-
name: brands
description: 'Access to brands'
-
name: users
description: 'Access to users'
-
name: agencies
description: 'Access to agencies'
-
name: companies
description: 'Access to companies'
-
name: residences
description: 'Access to residences'
-
name: calendars
description: 'Access to calendars'
-
name: properties
description: 'Access to properties'
openapi: 3.0.0
info:
description: "
Name | Value | Description |
---|---|---|
Property | floor_type | Replaced by floor_type_id |
Property | view_type | Replaced by view_type_id |
Property | view_landscape | Replaced by view_landscape_ids |
Property | services_type | Replaced by services_type_id |
Property | proximities_type | Replaced by proximities_type_id |
Property | proximities_length_type | Replaced by proximities_length_type_id |
POST Property | floor_type | Replaced by floor_type_id |
POST Property | view_type | Replaced by view_type_id |
POST Property | view_landscape | Replaced by view_landscape_ids |
POST Property | proximities_type | Replaced by proximities_type_id |
POST Property | proximities_length_type | Replaced by proximities_length_type_id |
Name | Value | Description |
---|---|---|
DELETE User Sector | /api/users/sectors/{id} | Delete a specific User Sector |
Name | Value | Description |
---|---|---|
POST Book | /api/book | Replaced by POST /api/books |
POST Book | /api/book/{id} | Replaced by PATCH /api/books/{id} |
POST User | /api/user | Replaced by POST /api/users |
POST User | /api/users/{id} | Replaced by PATCH /api/users/{id} |
Name | Value | Description |
---|---|---|
Picture | panorama_is |
Name | Value | Description |
---|---|---|
Book | histories -> value_i18n | Field value_i18n of Book with[]=histories |
POST Book | histories | Book Histories sub-entity only for POST and PATCH |
Name | Value | Description |
---|---|---|
GET /documents/count | search[building] | |
GET /documents | search[building] | |
GET /histories/count | search[building] | |
GET /histories | search[building] | |
GET /histories | search[origine] | |
GET /histories | search[origine_sub] | |
GET /properties/count | search[on_demande_price] | |
GET /properties | search[on_demande_price] | |
GET /requests/count | search[origine] | |
GET /requests/count | search[suborigine] | |
GET /requests/count | search[crossing_auto] | |
GET /requests/count | search[rooms_min] | |
GET /requests/count | search[rooms_max] | |
GET /requests/count | search[bedrooms_min] | |
GET /requests/count | search[bedrooms_max] | |
GET /requests | search[origine] | |
GET /requests | search[suborigine] | |
GET /requests | search[crossing_auto] | |
GET /requests | search[rooms_min] | |
GET /requests | search[rooms_max] | |
GET /requests | search[bedrooms_min] | |
GET /requests | search[bedrooms_max] |
Name | Value | Description |
---|---|---|
History | building_id | |
History | building | |
Document | building_id | |
Request | origine_id | |
Request | suborigine_id | |
Request | rooms_min | |
Request | rooms_max | |
Request | bedrooms_min | |
Request | bedrooms_max | |
POST ShareProperties | format | |
POST ShareProperties | emails | |
POST ShareProperties | copy | |
POST ShareProperties | subject |