Documentación API Impulso Raíz

Propiedades

Get Properties

Request

MethodURL
GET https://impulsoraiz.com/api/properties

      Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros

PageInteger
take                     Integer, x ∈ [1, 100]

Filtros

type_id Integer Es enumerador:
1: ‘Casa’,
2: ‘Apartamento’,
3: ‘Finca’,
4: ‘Lote’,5: ‘Bodega’,
6: ‘Local’,
7: ‘Oficina’,
8: ‘Edificio’,
9: ‘Negocio’,
10: ‘Lote en parcelación’,
11: ‘Finca en parcelación’,
12: ‘Lote industrial’,
13: ‘Finca productiva’
for_id Integer Es enumerador:
1: ‘venta’,
2: ‘arriendo’,
3: ‘venta y arriendo’
location_id Integer
location_name String
sector_id Integer
sector_name String
sale_price_from Double
sale_price_to Double
rend_price_from Double
rend_price_to Double
min_rooms Integer
min_baths Integer
min_parkings Integer
min_livings Integer
floors Integer
unit_of_area Integer, x ∈ {1, 2, 3} Es enumerador:
1: ‘m2’,
2: ‘ha’,
3: ‘cuadra’
area_from Double
area_to Double
built_area_from Double
built_area_to Double
antiquity_id Integer, x ∈ {1, 2, 3, 4, 5, 6, 7, 8, 9, 10} Es enumerador:
1: ‘Para estrenar’,
2: ‘Menos de 1 año’,
3: ‘1 a 5 años’,
4: ‘6 a 10 años’,
5: ’11 a 20 años’,
6: ’21 a 30 años’,
7: ’31 a 50 años’,
8: ’51 a 70 años’,
9: ’71 a 100 años’,
10: ‘+ 100 años’
status_id Integer, x ∈ {1, 2, 3, 4} Es enumerador:
1: ‘Disponible’,
2: ‘No disponible’,
3: ‘Vendida’,
4: ‘Arrendada’
code String
comments String
admin_comments String
has_image Integer, x ∈ {1, 0}
filed Integer, x ∈ {1, 0}
publish Integer, x ∈ {1, 0}
sharing Integer, x ∈ {1, 0}
property_registration String
owner_id Integer
consultant_id Integer

Ejemplo de entrada:

https://impulsoraiz.com/api/properties?page=1&take=10&has_image=1&unit_of_area=2&area_from=2 

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

{
           “data”: [
               {
                   “id”: 1,
                   “code”: “74A15”,
                   “type”: {
                       “id”: 10,
                       “description”: “Lote en parcelación”
                   },
                   “for”: {
                       “id”: 1,
                       “description”: “venta”
                   },
                   “location”: {
                       “id”: 85,
                       “name”: “Rionegro (Antioquia)”
                   },
                   “sector”: {
                       “id”: 107,
                       “name”: “Vía San Antonio – La Ceja”
                   },
                   “address”: “Vereda El Capiro”,
                   “stratum”: 3,
                   “longitude”: null,
                   “latitude”: null,
                   “sale_price”: 850000000,
                   “rent_price”: null,
                   “area”: 3500,
                   “built_area”: null,
                   “unit_of_area”: {
                       “id”: 1,
                       “description”: “m2”
                   },
                   “baths”: null,
                   “rooms”: null,
                   “livings”: null,
                   “floors”: null,
                   “parkings”: null,
                   “antiquity”: null,
                   “administration_fee”: null,
                   “comments”: “Lote en venta, con vías pavimentadas e iluminadas.”,
                   “en_coments”: null,
                   “main_image_url”: “17030719480314889160835300.jpg”,
                   “main_image_url_small”: null,
                   “video_url”: null,
                   “publish”: null,
                   “sharing”: null,
                   “status”: {
                       “id”: 2,
                       “description”: “No disponible”
                   },
                   “owner_id”: 35,
                   “consultant_id”: 1,
                   “created_at”: “2017-03-06 00:00:00”,
                   “updated_at”: null,
                   “shared_property”: null,
                   “appropiate_property_id”: null
               },
               {
                   “id”: 2,
                   “code”: “74A16”,
                   “type”: {
                       “id”: 10,
                       “description”: “Lote en parcelación”
                   },
                   “for”: {
                       “id”: 1,
                       “description”: “venta”
                   },
                   “location”: {
                       “id”: 85,
                       “name”: “Rionegro (Antioquia)”
                   },
                   “sector”: {
                       “id”: 80,
                       “name”: “Llanogrande”
                   },
                   “address”: “Cerca al Club de Llanogrande.”,
                   “stratum”: 6,
                   “longitude”: null,
                   “latitude”: null,
                   “sale_price”: 800000000,
                   “rent_price”: null,
                   “area”: 2845,
                   “built_area”: null,
                   “unit_of_area”: {
                       “id”: 1,
                       “description”: “m2”
                   },
                   “baths”: null,
                   “rooms”: null,
                   “livings”: null,
                   “floors”: null,
                   “parkings”: null,
                   “antiquity”: null,
                   “administration_fee”: 420000,
                   “coments”: “Lote en exclusiva parcelación, vista a la montaña.”,
                   “en_coments”: null,
                   “main_image_url”: “17030719591014889167500982.jpg”,
                   “main_image_url_small”: null,
                   “video_url”: null,
                   “publish”: 1,
                   “sharing”: 1,
                   “status”: {
                       “id”: 1,
                       “description”: “Disponible”
                   },
                   “owner_id”: 18,
                   “consultant_id”: 1,
                   “created_at”: “2017-03-06 00:00:00”,
                   “updated_at”: null,
                   “shared_property”: null,
                   “appropiate_property_id”: “96927”
               }
           ],
           “from”: 1,
           “to”: 2,
           “per_page”: 2,
           “current_page”: 1,
           “last_page”: 590,
           “total”: 1179
       }

Get one property

Request

Method URL
POST                     https://impulsoraiz.com/api/properties/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “id”: 1188,
            “code”: “10A1188”,
            “type”: {
                “id”: 1,
                “description”: “Casa”
            },
            “for”: {
                “id”: 1,
                “description”: “venta”
            },
            “location”: {
                “id”: 45,
                “name”: “El Retiro (Antioquia)”
            },
            “sector”: {
                “id”: 3,
                “name”: “Don Diego”
            },
            “address”: “Vía Las Palmas”,
            “stratum”: 6,
            “longitude”: “-75.48028”,
            “latitude”: “6.0964116”,
            “price”: 1200000000,
            “area”: 2000,
            “built_area”: 250,
            “unit_of_area”: {
                “id”: 1,
                “description”: “m2”
            },
            “baths”: 4,
            “rooms”: 6,
            “livings”: 2,
            “floors”: 1,
            “parkings”: 3,
            “antiquity”: {
                “id”: 1,
                “description”: “Para estrenar”
            },
            “internal_details”: [
                {
                    “id”: 1,
                    “descripcion”: “Cocina Integral”
                },
                {
                    “id”: 2,
                    “descripcion”: “Servicios públicos”
                },
                {
                    “id”: 3,
                    “descripcion”: “Aire acondicionado”
                },
                {
                    “id”: 4,
                    “descripcion”: “Chimenea”
                },
                {
                    “id”: 5,
                    “descripcion”: “Zona de lavandería”
                },
                {
                    “id”: 6,
                    “descripcion”: “Alarma”
                },
                {
                    “id”: 7,
                    “descripcion”: “Baño en habitación principal”
                }
            ],
            “external_details”: [
                {
                    “id”: 1,
                    “descripcion”: “Parqueadero cubierto”
                },
                {
                    “id”: 2,
                    “descripcion”: “Vigilancia privada”
                },
                {
                    “id”: 10,
                    “descripcion”: “Área social”
                },
                {
                    “id”: 12,
                    “descripcion”: “BBQ”
                },
                {
                    “id”: 18,
                    “descripcion”: “Piscina”
                }
            ],
            “sector_details”: [
                {
                    “id”: 1,
                    “descripcion”: “Trans. público cercano”
                },
                {
                    “id”: 2,
                    “descripcion”: “Colegios/Universidad cerca”
                }
            ],
            “administration_fee”: 250000,
            “cadastral_valuation”: 650000000,
            “comercial_valuation”: 1200000000,
            “property_tax”: 1800000,
            “coments”: “Casa en excelente sector con buena zona verde y muy buenos acabados.”,
            “en_coments”: null,
            “private_admin_coments”: null,
            “property_registration”: “45567238273”,
            “main_image_url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-959022352.png”,
            “video_url”: null,
            “normal_images”: [
                {
                    “id”: 15996,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-431484124.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-431484124.png”,
                    “position”: 1
                },
                {
                    “id”: 15997,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-959131529.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-959131529.png”,
                    “position”: 2
                },
                {
                    “id”: 15998,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-592823036.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-592823036.png”,
                    “position”: 3
                },
                {
                    “id”: 15999,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-1789117920.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-1789117920.png”,
                    “position”: 4
                },
                {
                    “id”: 16000,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-661879181.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-661879181.png”,
                    “position”: 5
                },
                {
                    “id”: 16001,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-1085426307.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-1085426307.png”,
                    “position”: 6
                },
                {
                    “id”: 16002,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-251822296.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-251822296.png”,
                    “position”: 7
                }
            ],
            “panoramic_images”: [],
            “spherical_images”: [
                {
                    “id”: 15995,
                    “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-959022352.png”,
                    “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-959022352.png”,
                    “position”: 1
                }
            ],
            “publish”: 0,
            “sharing”: 0,
            “has_been_shared”: 0,
            “status”: {
                “id”: 1,
                “description”: 1
            },
            “owner”: {
                “id”: 1,
                “name”: “Propietario Apellido”,
                “email”: “propietario@propietario.com”,
                “document”: null,
                “phone1”: “3500550505”,
                “phone2”: “3500550505”
            },
            “consultant”: {
                “id”: 1,
                “name”: “Asesor Inmobiliaria”,
                “phone”: 3500550505,
                “email”: “asesor@inmobiliaria.com”
            },
            “comission”: 3,
            “created_at”: “2018-12-04”,
            “updated_at”: “2018-12-04 21:31:55”,
            “filed_at”: null,
            “shared_property”: null
        }

Save property

Request

MethodURL
POSThttps://impulsoraiz.com/api/properties

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros

type_id integer|required|in: [1: ‘Casa’, 2: ‘Apartamento’, 3: ‘Finca’, 4: ‘Lote’, 5: ‘Bodega’, 6: ‘Local’, 7: ‘Oficina’, 8: ‘Edificio’, 9: ‘Negocio’, 10: ‘Lote en parcelación’, 11: ‘Finca en parcelación’, 12: ‘Lote industrial’, 13: ‘Finca productiva’ ],
for_id integer|required|in: [1: ‘venta’, 2: ‘arriendo’, 3: ‘venta y arriendo’],
location_id integer|required,
sector_id integer|required,
addressstring|nullable|max:100,
stratuminteger|nullable|in: [1, 2, 3, 4, 5, 6]
latitudestring|nullable|max:50,
longitude string|nullable|max:50,
sale_pricedouble|nullable|required_if:for_id in [1, 3],
rent_pricedouble|nullable|required_if:for_id in [1, 3],
area double|nullable,
built_area: double|nullable,
unit_of_area_id: integer|nullable|in: [1: ‘m2’, 2: ‘ha’, 3: ‘cuadra’],
bathsinteger|nullable,
roomsinteger|nullable,
livingsinteger|nullable,
floorsinteger|nullable,
parkingsinteger|nullable,
antiquityinteger|nullable|in: [1: ‘Para estrenar’, 2: ‘Menos de 1 año’, 3: ‘1 a 5 años’, 4: ‘6 a 10 años’, 5: ’11 a 20 años’, 6: ’21 a 30 años’, 7: ’31 a 50 años’, 8: ’51 a 70 años’, 9: ’71 a 100 años’, 10: ‘+ 100 años’],
administration_feedouble|nullable,
cadastral_valuationdouble|nullable,
comercial_valuationdouble|nullable,
property_taxdouble|nullable,
commentsstring|nullable|max:1000,
en_commentsstring|nullable,
private_admins_commentsstring|nullable|max:300,
property_registrationstring|nullable|max:50,
video_urlstring|nullable|max:191,
publishinteger|nullable|in: [0, 1],
sharinginteger|nullable|in: [0, 1],
statusinteger|nullable|in: [1: ‘Disponible’, 2: ‘No disponible’, 3: ‘Vendida’, 4: ‘Arrendada’],
owner_idinteger|nullable,
consultant_id integer|nullable,
commission double|nullable,
internal_detail_idsarray|nullable,
internal_detail_ids*integer|distinct|in: [1: ‘Cocina Integral’, 2: ‘Servicios públicos’, 3: ‘Aire acondicionado’, 4: ‘Chimenea’, 5: ‘Zona de lavandería’, 6: ‘Alarma’, 7: ‘Baño en habitación principal’, 8: ‘Balcón’, 9: ‘Sauna’, 10: ‘Turco’, 11: ‘Jacuzzi’, 12: ‘Habitación de servicio’, 13: ‘Estudio / Biblioteca’, 14: ‘Citófono’, 15: ‘Oficina’, 16: ‘Muelle’, 17: ‘Energía Trifásica’, 18: ‘Puerta Camión’],
external_detail_ids array|nullable,
external_detail_ids*integer|distinct|in: [1: ‘Parqueadero cubierto’, 2: ‘Vigilancia privada’, 3: ‘Árboles frutales’, 4: ‘Vista panorámica’, 5: ‘Portero’, 6: ‘En edificio’, 7: ‘En unidad cerrada’, 8: ‘En parcelación’, 9: ‘Acceso pavimentado’, 10: ‘Área social’, 11: ‘Ascensor’, 12: ‘BBQ’, 13: ‘Bosque’, 14: ‘Cancha deportiva’, 15: ‘Pesebrera’, 16: ‘Lago’, 17: ‘Parqueadero visitantes’, 18: ‘Piscina’, 19: ‘Sobre vía principal’, 20: ‘Portería’, 21: ‘Planta de tratamiento de aguas residuales’, 22: ‘Tanque de reserva de agua’],
sector_detail_ids array|nullable,
sector_detail_ids*integer|distinct|in: [1: ‘Trans. público cercano’, 2: ‘Colegios/Universidad cerca’, 3: ‘Biblioteca cercana’, 4: ‘Cerca de zona urbana’, 5: ‘Supermercados / C. Comerciales’, 6: ‘Cerca al aeropuerto’],
normal_images array|nullable,
normal_images*url: string|distinct|required,
normal_images*position: integer|distinct|required|between:1,20,
panoramic_imagesarray|nullable,
panoramic_images* url: string|distinct|required,
panoramic_images* position: integer|distinct|required|between:1,20,

spherical_images
array|nullable,
spherical_images*url: string|distinct|required,
spherical_images* position: integer|distinct|required|between:1,5,

Ejemplo de entrada:

{
            “type_id”: 1,
            “for_id”: 1,
            “location_id”: 45,
            “sector_id”: 3,
            “address”: “Vía las palmas”,
            “stratum”: 6,
            “latitude”: “6.0964116”,
            “longitude”: “-75.48028”,
            “sale_price”: 1200000000,
            “rent_price”: null,
            “area”: 2000,
            “built_area”: 250,
            “unit_of_area_id”: 1,
            “baths”: 4,
            “rooms”: 6,
            “livings”: 2,
            “floors”: 1,
            “parkings”: 3,
            “antiquity”: 1,
            “administration_fee”: 250000,
            “cadastral_valuation”: 650000000,
            “comercial_valuation”: 1200000000,
            “property_tax”: 1800000,
            “coments”: “Casa en excelente sector con buena zona verde y muy buenos acabados.”,
            “en_coments”: null,
            “private_admin_coments”: null,
            “property_registration”: “45567238275”,
            “video_url”: null,
            “status_id”: 1,
            “owner_id”: 1,
            “consultant_id”: 1,
            “comission”: 3,
            “internal_detail_ids”: [1, 2, 3, 4, 5, 6, 7],
            “external_detail_ids”: [1, 2, 10, 12, 18],
            “sector_detail_ids”: [1, 2],
            “normal_images”: [
                {
                    “url”: “https://s3-us-west-2.amazonaws.com/inmobiliarias/74/images/properties/890/large/753144442ab64a0fde719f94e9dece9b1dc09c492.png”,
                    “position”: 1
                },
                {
                    “url”: “https://s3-us-west-2.amazonaws.com/inmobiliarias/74/images/properties/890/large/442982850e9dcd881bfdacd40c9c004ffcfb3105d.png”,
                    “position”: 2
                },
                {
                    “url”: “https://s3-us-west-2.amazonaws.com/inmobiliarias/74/images/properties/890/large/34625255e9dcd881bfdacd40c9c004ffcfb3105d.png”,
                    “position”: 3
                },
                {
                    “url”: “https://s3-us-west-2.amazonaws.com/inmobiliarias/74/images/properties/890/large/1699368531e9dcd881bfdacd40c9c004ffcfb3105d.png”,
                    “position”: 4
                },
                {
                    “url”: “https://s3-us-west-2.amazonaws.com/inmobiliarias/74/images/properties/890/large/1041623700ab64a0fde719f94e9dece9b1dc09c492.png”,
                    “position”: 5
                },
                {
                    “url”: “https://s3-us-west-2.amazonaws.com/inmobiliarias/74/images/properties/890/large/1564872364ab64a0fde719f94e9dece9b1dc09c492.png”,
                    “position”: 6
                },
                {
                    “url”: “https://s3-us-west-2.amazonaws.com/inmobiliarias/74/images/properties/221/large/189069787043bb04b97fe7ddb364f41252e3e0970e.png”,
                    “position”: 7
                }
            ],
            “panoramic_images”: [],
            “spherical_images”: []“
        }      

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

415 HTTP_UNSUPPORTED_MEDIA_TYPE
Archivos multimedia sin soporte.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

{}

Nota: Falta ejemplo de salida

Update property

Request

MethodURL
PUT
https://impulsoraiz.com/api/properties/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros

type_id integer|required|in: [1: ‘Casa’, 2: ‘Apartamento’, 3: ‘Finca’, 4: ‘Lote’, 5: ‘Bodega’, 6: ‘Local’, 7: ‘Oficina’, 8: ‘Edificio’, 9: ‘Negocio’, 10: ‘Lote en parcelación’, 11: ‘Finca en parcelación’, 12: ‘Lote industrial’, 13: ‘Finca productiva’ ],
for_id integer|required|in: [1: ‘venta’, 2: ‘arriendo’, 3: ‘venta y arriendo’],
location_id integer|required,
sector_id integer|required,
addressstring|nullable|max:100,
stratuminteger|nullable|in: [1, 2, 3, 4, 5, 6]
latitudestring|nullable|max:50,
longitude string|nullable|max:50,
sale_pricedouble|nullable|required_if:for_id in [1, 3],
rent_pricedouble|nullable|required_if:for_id in [1, 3],
area double|nullable,
built_area: double|nullable,
unit_of_area_id: integer|nullable|in: [1: ‘m2’, 2: ‘ha’, 3: ‘cuadra’],
bathsinteger|nullable,
roomsinteger|nullable,
livingsinteger|nullable,
floorsinteger|nullable,
parkingsinteger|nullable,
antiquityinteger|nullable|in: [1: ‘Para estrenar’, 2: ‘Menos de 1 año’, 3: ‘1 a 5 años’, 4: ‘6 a 10 años’, 5: ’11 a 20 años’, 6: ’21 a 30 años’, 7: ’31 a 50 años’, 8: ’51 a 70 años’, 9: ’71 a 100 años’, 10: ‘+ 100 años’],
administration_feedouble|nullable,
cadastral_valuationdouble|nullable,
comercial_valuationdouble|nullable,
property_taxdouble|nullable,
commentsstring|nullable|max:1000,
en_commentsstring|nullable,
private_admins_commentsstring|nullable|max:300,
property_registrationstring|nullable|max:50,
video_urlstring|nullable|max:191,
publishinteger|nullable|in: [0, 1],
sharinginteger|nullable|in: [0, 1],
statusinteger|nullable|in: [1: ‘Disponible’, 2: ‘No disponible’, 3: ‘Vendida’, 4: ‘Arrendada’],
owner_idinteger|nullable,
consultant_id integer|nullable,
commission double|nullable,
internal_detail_idsarray|nullable,
internal_detail_ids*integer|distinct|in: [1: ‘Cocina Integral’, 2: ‘Servicios públicos’, 3: ‘Aire acondicionado’, 4: ‘Chimenea’, 5: ‘Zona de lavandería’, 6: ‘Alarma’, 7: ‘Baño en habitación principal’, 8: ‘Balcón’, 9: ‘Sauna’, 10: ‘Turco’, 11: ‘Jacuzzi’, 12: ‘Habitación de servicio’, 13: ‘Estudio / Biblioteca’, 14: ‘Citófono’, 15: ‘Oficina’, 16: ‘Muelle’, 17: ‘Energía Trifásica’, 18: ‘Puerta Camión’],
external_detail_ids array|nullable,
external_detail_ids*integer|distinct|in: [1: ‘Parqueadero cubierto’, 2: ‘Vigilancia privada’, 3: ‘Árboles frutales’, 4: ‘Vista panorámica’, 5: ‘Portero’, 6: ‘En edificio’, 7: ‘En unidad cerrada’, 8: ‘En parcelación’, 9: ‘Acceso pavimentado’, 10: ‘Área social’, 11: ‘Ascensor’, 12: ‘BBQ’, 13: ‘Bosque’, 14: ‘Cancha deportiva’, 15: ‘Pesebrera’, 16: ‘Lago’, 17: ‘Parqueadero visitantes’, 18: ‘Piscina’, 19: ‘Sobre vía principal’, 20: ‘Portería’, 21: ‘Planta de tratamiento de aguas residuales’, 22: ‘Tanque de reserva de agua’],
sector_detail_ids array|nullable,
sector_detail_ids*integer|distinct|in: [1: ‘Trans. público cercano’, 2: ‘Colegios/Universidad cerca’, 3: ‘Biblioteca cercana’, 4: ‘Cerca de zona urbana’, 5: ‘Supermercados / C. Comerciales’, 6: ‘Cerca al aeropuerto’],
normal_images array|nullable,
normal_images*url: string|distinct|required,
normal_images*position: integer|distinct|required|between:1,20,
panoramic_imagesarray|nullable,
panoramic_images* url: string|distinct|required,
panoramic_images* position: integer|distinct|required|between:1,20,

spherical_images
array|nullable,
spherical_images*url: string|distinct|required,
spherical_images* position: integer|distinct|required|between:1,5,

Ejemplo de entrada:

 {
            “type_id”: 1,
            “for_id”: 1,
            “location_id”: 45,
            “sector_id”: 3,
            “address”: “Vía Las Palmas”,
            “stratum”: 6,
            “latitude”: “6.0964118”,
            “longitude”: “-75.48029”,
            “sale_price”: 1200000000,
            “rent_price”: null,
            “area”: 2000,
            “built_area”: 250,
            “unit_of_area_id”: 1,
            “baths”: 4,
            “rooms”: 6,
            “livings”: 2,
            “floors”: 1,
            “parkings”: 3,
            “antiquity”: 1,
            “administration_fee”: 250000,
            “cadastral_valuation”: 650000000,
            “comercial_valuation”: 1200000000,
            “property_tax”: 1800000,
            “coments”: “Casa en excelente sector con buena zona verde y muy buenos acabados", 
            “en_coments”: null,
            “private_admin_coments”: null,
            “property_registration”: “45569238273”,
            “video_url”: null,
            “publish”: 0,
            “sharing”: 0,
            “status”: 1,
            “owner_id”: 1,
            “consultant_id”: 1,
            “comission”: 3,
            “internal_detail_ids”: [1, 2, 3, 4, 5, 6, 7],
            “external_detail_ids”: [1, 2, 10, 12, 18],
            “sector_detail_ids”: [1, 2],
            “normal_images”: [],
            “panoramic_images”: [],
            “spherical_images”: [],
         }

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

415 HTTP_UNSUPPORTED_MEDIA_TYPE
Archivos multimedia sin soporte.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “data”: {
                “id”: 1188,
                “code”: “10A1188”,
                “type”: {
                    “id”: 1,
                    “description”: “Casa”
                },
                “for”: {
                    “id”: 1,
                    “description”: “venta”
                },
                “location”: {
                    “id”: 45,
                    “name”: “El Retiro (Antioquia)”
                },
                “sector”: {
                    “id”: 3,
                    “name”: “Don Diego”
                },
                “address”: “Vía Las Palmas”,
                “stratum”: 6,
                “longitude”: “-75.48024”,
                “latitude”: “6.0964115”,
                “sale_price”: 1200000000,
                “rent_price”: null,
                “area”: 2000,
                “built_area”: 250,
                “unit_of_area”: {
                    “id”: 1,
                    “description”: “m2”
                },
                “baths”: 4,
                “rooms”: 6,
                “livings”: 2,
                “floors”: 1,
                “parkings”: 3,
                “antiquity”: {
                    “id”: 1,
                    “description”: “Para estrenar”
                },
                “internal_details”: [
                    {
                        “id”: 1,
                        “descripcion”: “Cocina Integral”
                    },
                    {
                        “id”: 2,
                        “descripcion”: “Servicios públicos”
                    },
                    {
                        “id”: 3,
                        “descripcion”: “Aire acondicionado”
                    },
                    {
                        “id”: 4,
                        “descripcion”: “Chimenea”
                    },
                    {
                        “id”: 5,
                        “descripcion”: “Zona de lavandería”
                    },
                    {
                        “id”: 6,
                        “descripcion”: “Alarma”
                    },
                    {
                        “id”: 7,
                        “descripcion”: “Baño en habitación principal”
                    }
                ],
                “external_details”: [
                    {
                        “id”: 1,
                        “descripcion”: “Parqueadero cubierto”
                    },
                    {
                        “id”: 2,
                        “descripcion”: “Vigilancia privada”
                    },
                    {
                        “id”: 10,
                        “descripcion”: “Área social”
                    },
                    {
                        “id”: 12,
                        “descripcion”: “BBQ”
                    },
                    {
                        “id”: 18,
                        “descripcion”: “Piscina”
                    }
                ],
                “sector_details”: [
                    {
                        “id”: 1,
                        “descripcion”: “Trans. público cercano”
                    },
                    {
                        “id”: 2,
                        “descripcion”: “Colegios/Universidad cerca”
                    }
                ],
                “administration_fee”: 250000,
                “cadastral_valuation”: 650000000,
                “comercial_valuation”: 1200000000,
                “property_tax”: 1800000,
                “coments”: “Casa en excelente sector con buena zona verde y muy buenos acabados.”,
                “en_coments”: null,
                “private_admin_coments”: null,
                “property_registration”: “45567238277”,
                “main_image_url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-959022352.png”,
                “video_url”: null,
                “normal_images”: [
                    {
                        “id”: 15996,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-431484124.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-431484124.png”,
                        “position”: 1
                    },
                    {
                        “id”: 15997,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-959131529.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-959131529.png”,
                        “position”: 2
                    },
                    {
                        “id”: 15998,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-592823036.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-592823036.png”,
                        “position”: 3
                    },
                    {
                        “id”: 15999,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-1789117920.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-1789117920.png”,
                        “position”: 4
                    },
                    {
                        “id”: 16000,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-661879181.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-661879181.png”,
                        “position”: 5
                    },
                    {
                        “id”: 16001,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-1085426307.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-1085426307.png”,
                        “position”: 6
                    },
                    {
                        “id”: 16002,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-251822296.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-251822296.png”,
                        “position”: 7
                    }
                ],
                “panoramic_images”: [],
                “spherical_images”: [
                    {
                        “id”: 15995,
                        “url”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/large/casa-en-venta-el-retiro-antioquia-959022352.png”,
                        “url_small”: “https://impulso-dev.s3-us-west-2.amazonaws.com/24/images/properties/1188/small/casa-en-venta-el-retiro-antioquia-959022352.png”,
                        “position”: 1
                    }
                ],
                “publish”: 0,
                “sharing”: 0,
                “has_been_shared”: 0,
                “status”: {
                    “id”: 1,
                    “description”: 1
                },
                “owner”: {
                    “id”: 1,
                    “name”: “Alejandra Pelaez”,
                    “email”: “alejadra.p@insumitec.com”,
                    “document”: null,
                    “phone1”: “3146806225”,
                    “phone2”: “3122883976”
               
                “comission”: 3,
                “created_at”: “2018-12-04”,
                “updated_at”: “2018-12-04 21:31:55”,
                “filed_at”: null,
                “shared_property”: null
            },
            “messages”: [
                “La propiedad se creó.”
            ]
        }

File property

Request

MethodURL
PATCHhttps://impulsoraiz.com/api/properties/{id}/file

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Restore property

Request

MethodURL
PATCHhttps://impulsoraiz.com/api/properties/{id}/restore

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Delete property

Request

MethodURL
DELETEhttps://impulsoraiz.com/api/properties/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Publicar propiedad / Quitar publicación de una propiedad

Request

MethodURL
PATCH https://impulsoraiz.com/api/properties/{id}/switch-publish-status

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Compartir propiedad / Dejar de compartir una propiedad

Request

MethodURL
PATCH https://impulsoraiz.com/api/properties/{id}/switch-sharing-status

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ubicaciones

Get locations

Request

MethodURL
GET https://impulsoraiz.com/api/locations

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros

PageInteger
take                     Integer, x ∈ [1, 100]

Filtros

name
String
state_id
Integer
state_name
String
country_id
Integer
country_name
String

Ejemplo de entrada:

 http://local.impulzoraiz/api/locations?page=1&take=5

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “data”: [
                {
                    “id”: 1,
                    “name”: “Abejorral (Antioquia)”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 2,
                    “name”: “Abriaquí (Antioquia)”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 3,
                    “name”: “Alejandría (Antioquia)”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 4,
                    “name”: “Amagá (Antioquia)”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 5,
                    “name”: “Amalfi (Antioquia)”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                }
            ],
            “from”: 1,
            “to”: 5,
            “per_page”: 5,
            “current_page”: 1,
            “last_page”: 25,
            “total”: 125
        }

Sectores

Get sectors

Request

MethodURL
GET https://impulsoraiz.com/api/sectors

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros

PageInteger
take                     Integer, x ∈ [1, 100]

Filtros

name String
location_id Integer
location_name String
state_id Integer
state_name String
country_id Integer
country_name String

Ejemplo de entrada:

http://local.impulzoraiz/api/properties?page=1&take=5&location_name=Envigado

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

{
            “data”: [
                {
                    “id”: 134,
                    “name”: “Alto de Palmas”,
                    “location_id”: 48,
                    “location_name”: “Envigado”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 287,
                    “name”: “Arrayanes”,
                    “location_id”: 48,
                    “location_name”: “Envigado”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 195,
                    “name”: “El Cebadero”,
                    “location_id”: 48,
                    “location_name”: “Envigado”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 299,
                    “name”: “El Trianon”,
                    “location_id”: 48,
                    “location_name”: “Envigado”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                },
                {
                    “id”: 277,
                    “name”: “Ensenillos”,
                    “location_id”: 48,
                    “location_name”: “Envigado”,
                    “state_id”: 1,
                    “state_name”: “Antioquia”,
                    “country_id”: 1,
                    “country_name”: “Colombia”
                }
            ],
            “from”: 1,
            “to”: 5,
            “per_page”: 5,
            “current_page”: 1,
            “last_page”: 4,
            “total”: 17
        }

Get one sector

Request

MethodURL
GET https://impulsoraiz.com/api/sectors/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

404 HTTP_NOT_FOUND
Detalle del error encontrado, puede ser por que el sector no existe.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

 {
            “id”: 1,
            “name”: “La Fé”,
            “location”: {
                “id”: 45,
                “name”: “El Retiro (Antioquia)”,
                “state”: {
                    “id”: 1,
                    “name”: “Antioquia”,
                    “country”: {
                        “id”: 1,
                        “name”: “Colombia”
                    }
                }
            }
        }            

Save sector

Request

MethodURL
POST https://impulsoraiz.com/api/sectors

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros de entrada

namestring|required|max:50,
location_id                    integer|required,

Ejemplo de entrada:

        {
            “name”: “Tierra firma – Los colores”,
            “location_id”: 71
        }

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “id”: 304,
            “name”: “Tierra firma – Los colores”,
            “location”: {
                “id”: 71,
                “name”: “Medellín (Antioquia)”,
                “state”: {
                    “id”: 1,
                    “name”: “Antioquia”,
                    “country”: {
                        “id”: 1,
                        “name”: “Colombia”
                    }
                }
            }
        }

Update sector

Request

MethodURL
GET https://impulsoraiz.com/api/sectors/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros de entrada

namestring|required|max:50,
location_id                    integer|required,

Ejemplo de entrada:

        {
            “name”: “Tierra firma – San German / Los colores”,
            “location_id”: 71
        }

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “id”: 304,
            “name”: “Tierra firma – San German / Los colores”,
            “location”: {
                “id”: 71,
                “name”: “Medellín (Antioquia)”,
                “state”: {
                    “id”: 1,
                    “name”: “Antioquia”,
                    “country”: {
                        “id”: 1,
                        “name”: “Colombia”
                    }
                }
            }
        }

Delete sector

Request

MethodURL
DELETEhttps://impulsoraiz.com/api/properties/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Asesores

Get consultants

Request

MethodURL
GET https://impulsoraiz.com/api/consultants

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros

PageInteger
take                     Integer, x ∈ [1, 100]

Filtros

nameString
phoneString
emailString

Ejemplo de entrada:

http://local.impulzoraiz/api/properties?page=1&take=10

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “data”: [
                {
                    “id”: 1,
                   
                    “appropiate_consultant_id”: null
                },
                {
                    “id”: 2,
                    
                    “appropiate_consultant_id”: null
                }
            ],
            “from”: 1,
            “to”: 2,
            “per_page”: 10,
            “current_page”: 1,
            “last_page”: 1,
            “total”: 2
        }

Get one consultant

Request

MethodURL
GET https://impulsoraiz.com/api/sectors/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

404 HTTP_NOT_FOUND
Detalle del error encontrado, puede ser por que el sector no existe.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “id”: 1,
            

Save consultants

Request

MethodURL
POSThttps://impulsoraiz.com/api/consultants

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros de entrada

namestring|required|max:50,
phonestring|nullable|max:191,
emailstring|nullable|max:50,

Ejemplo de entrada:

       

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

{
          

Update consultant

Request

MethodURL
PUThttps://impulsoraiz.com/api/consultants/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros de entrada

namestring|required|max:50,
phonestring|nullable|max:191,
emailstring|nullable|max:50,

Ejemplo de entrada:

        

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “id”: 3,
          
        }

Delete consultant

Request

MethodURL
DELETEhttps://impulsoraiz.com/api/consultants/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Propietarios

Get owners

Request

MethodURL
GET https://impulsoraiz.com/api/owners

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros

PageInteger
take                     Integer, x ∈ [1, 100]

Filtros

nameString
phoneString
emailString
documentString

Ejemplo de entrada:

http://local.impulzoraiz/api/owners?page=1&take=5

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones en los parámetros de entrada.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “data”: [
                {
                    “id”: 1,
                    “name”: “Propietario 1”,
                    “email”: “propietario1@gmail.com”,
                    “document”: null,
                    “phone1”: null,
                    “phone2”: “3214567890”
                },
                {
                    “id”: 2,
                    “name”: “Propietario 2”,
                    “email”: “propietario2@gmail.com”,
                    “document”: null,
                    “phone1”: null,
                    “phone2”: “3114356744”
                },
                {
                    “id”: 3,
                    “name”: “Propietario 3”,
                    “email”: “propietario3@gmail.com”,
                    “document”: null,
                    “phone1”: “3214567543”,
                    “phone2”: null
                },
                {
                    “id”: 4,
                    “name”: “Propietario 4”,
                    “email”: “propietario4@gmail.com”,
                    “document”: 5619026,
                    “phone1”: “3145654432”,
                    “phone2”: null
                },
                {
                    “id”: 5,
                    “name”: “Propietario 5”,
                    “email”: “propietario5@gmail.com”,
                    “document”: null,
                    “phone1”: “3129875634”,
                    “phone2”: null
                }
            ],
            “from”: 1,
            “to”: 5,
            “per_page”: 5,
            “current_page”: 1,
            “last_page”: 275,
            “total”: 1374
        }

Get one owner

Request

MethodURL
GET https://impulsoraiz.com/api/owners/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

404 HTTP_NOT_FOUND
Detalle del error encontrado, puede ser por que el sector no existe.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “id”: 1,
            “name”: “Propietario 1”,
            “email”: “propietario1@gmail.com”,
            “document”: null,
            “phone1”: null,
            “phone2”: “3214567890”
        }

Save owner

Request

MethodURL
POST https://impulsoraiz.com/api/owners

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros de entrada

namestring|required|max:100,
phone1string|nullable|max:80,
phone2 string|nullable|max:80,
emailstring|nullable|max:50,
documentinteger|nullable,

Ejemplo de entrada:

        {
            “name”: “Propietario N”,
            “email”: “propietarion@gmail.com”,
            “document”: null,
            “phone1”: null,
            “phone2”: “3214567890”
        }

Responses

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Content-Type: application/json

Ejemplo de salida:

        {
            “id”: 1463,
            “name”: “Propietario N”,
            “email”: “propietarion@gmail.com”,
            “document”: null,
            “phone1”: “3214567890”,
            “phone2”: null
        }        

Update owner

Request

MethodURL
PUT https://impulsoraiz.com/api/owners/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Parámetros de entrada

namestring|required|max:100,
phone1string|nullable|max:80,
phone2 string|nullable|max:80,
emailstring|nullable|max:50,
documentinteger|nullable,

Ejemplo de entrada:

        {
            “name”: “Propietario N2”,
            “email”: “propietarion@gmail.com”,
            “document”: null,
            “phone1”: “3214567890”,
            “phone2”: null
        }

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.

Ejemplo de salida:

        {
            “id”: 1463,
            “name”: “Propietario N2”,
            “email”: “propietarion@gmail.com”,
            “document”: null,
            “phone1”: “3214567890”,
            “phone2”: null
        }     

Delete owner

Request

MethodURL
GET https://impulsoraiz.com/api/owners/{id}

Content-Type: application/json
       Authorization: Bearer {authentication_token}

Responses

Content-Type: application/json

HTTP Status Codes

200 HTTP_OK
Array con la colección de propiedades

400 HTTP_BAD_REQUEST
Detalle del error encontrado, puede ser por validaciones de los parámetros de entrada.

409 HTTP_CONFLICT
Detalle del error encontrado, puede ser por un problema transaccional.

500 HTTP_INTERNAL_SERVER_ERROR
Error inesperado en el servidor, en caso de responder con este código de estado por favor contactar con el área de soporte.