--- title: Search for properties and projects using the search criteria slug: docs.alep.co docTags: createdAt: 2023-04-20T08:59:04.000Z --- { "id": "iQCK1jdI5CWXGmADcaMJ-", "data": { "url": "http://localhost:8080/api/v0/search", "name": "Search for properties and projects using the search criteria", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "schema": [ { "kind": "optional", "name": "countries", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "optional", "name": "cities", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "optional", "name": "areas", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "optional", "name": "numberOfRooms", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "optional", "name": "minPrice", "type": "integer", "example": 0 }, { "kind": "optional", "name": "maxPrice", "type": "integer", "example": 0 }, { "kind": "optional", "name": "minSize", "type": "integer", "example": 0 }, { "kind": "optional", "name": "maxSize", "type": "integer", "example": 0 }, { "kind": "optional", "name": "isCitizenshipEligible", "type": "boolean", "example": "" }, { "kind": "optional", "name": "isReadyForDelivery", "type": "boolean", "example": "" }, { "kind": "optional", "name": "isReadyForTitleDeed", "type": "boolean", "example": "" }, { "kind": "optional", "name": "projectTypes", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "optional", "name": "paymentPlans", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "optional", "name": "facilities", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "optional", "name": "features", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" } ], "modelRef": "#/components/schemas/SearchRequest", "customType": "SearchRequest", "isExpanded": true, "description": "The search request that contains the search criteria" } ], "formDataParameters": [] }, "responses": [ { "schema": [ { "kind": "optional", "type": "object", "schema": [ { "kind": "required", "name": "projects", "type": "array", "schema": [ { "kind": "optional", "name": "id", "type": "string", "example": "9Q8YG862" }, { "kind": "optional", "name": "name", "type": "string", "example": "Istanbul Life" }, { "kind": "optional", "name": "description", "type": "string", "example": "Istanbul Life is a project that is located in Istanbul" }, { "kind": "optional", "name": "country", "type": "string", "example": "Turkey" }, { "kind": "optional", "name": "city", "type": "string", "example": "Istanbul" }, { "kind": "optional", "name": "lastUpdatedAt", "type": "string", "example": "Turkey" }, { "kind": "required", "name": "lat", "type": "number", "example": "" }, { "kind": "required", "name": "lng", "type": "number", "example": "" }, { "kind": "required", "name": "titleDeedStatus", "type": "string", "example": "" }, { "kind": "required", "name": "area", "type": "string", "example": "" }, { "kind": "required", "name": "type", "type": "string", "example": "" }, { "kind": "optional", "name": "titleDeedDate", "type": "string", "example": "" }, { "kind": "optional", "name": "numberOfFloors", "type": "integer", "example": 0 }, { "kind": "optional", "name": "citizenshipEligible", "type": "boolean", "example": "" }, { "kind": "required", "name": "readyForDelivery", "type": "boolean", "example": "" }, { "kind": "optional", "name": "deliveryDate", "type": "string", "example": "" }, { "kind": "required", "name": "imageUrls", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "required", "name": "videoUrls", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "required", "name": "facilities", "type": "array", "schema": [ { "kind": "required", "name": "id", "type": "string", "example": "" }, { "kind": "required", "name": "name", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/facility", "customType": "facility[]" }, { "kind": "required", "name": "properties", "type": "array", "schema": [ { "kind": "required", "name": "id", "type": "string", "example": "" }, { "kind": "required", "name": "name", "type": "string", "example": "" }, { "kind": "required", "name": "description", "type": "string", "example": "" }, { "kind": "required", "name": "minPrice", "type": "number", "example": "" }, { "kind": "required", "name": "maxPrice", "type": "number", "example": "" }, { "kind": "required", "name": "measurement", "type": "string", "example": "" }, { "kind": "required", "name": "numberOfRooms", "type": "string", "example": "" }, { "kind": "required", "name": "size", "type": "integer", "example": 0 }, { "kind": "required", "name": "lastUpdatedAt", "type": "string", "example": "" }, { "kind": "required", "name": "currency", "type": "string", "example": "" }, { "kind": "required", "name": "paymentPlan", "type": "string", "example": "" }, { "kind": "optional", "name": "downPaymentPercentage", "type": "number", "example": "" }, { "kind": "optional", "name": "installmentMonthCount", "type": "integer", "example": 0 }, { "kind": "required", "name": "features", "type": "array", "schema": [ { "kind": "required", "name": "id", "type": "string", "example": "" }, { "kind": "required", "name": "name", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/feature", "customType": "feature[]" }, { "kind": "required", "name": "imageUrls", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "required", "name": "videoUrls", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" }, { "kind": "required", "name": "planUrls", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "itemExample": "" } ], "modelRef": "#/components/schemas/property", "customType": "property[]" } ], "modelRef": "#/components/schemas/project", "customType": "project[]" } ], "modelRef": "#/components/schemas/SearchResponse", "customType": "SearchResponse", "isExpanded": true } ], "isExpanded": true, "statusCode": "200", "description": "Successful operation with some results or no results matching the search criteria", "jsonExample": "{\n \"SearchResponse\": {\n \"summary\": \"Successful operation with some results or no results matching the search criteria\",\n \"description\": \"SearchResponse\",\n \"value\": {\n \"projects\": [\n {\n \"id\": \"9Q8YG862\",\n \"name\": \"Istanbul Life\",\n \"description\": \"Istanbul Life is a project that is located in Istanbul\",\n \"country\": \"Turkey\",\n \"city\": \"Istanbul\",\n \"lastUpdatedAt\": \"2023-03-26T14:53:52\",\n \"lat\": 40.9814,\n \"lng\": 29.0247,\n \"titleDeedStatus\": \"Ready\",\n \"area\": \"Kadikoy\",\n \"type\": \"Residential\",\n \"citizenshipEligible\": true,\n \"readyForDelivery\": true,\n \"imageUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/images/Project/1/images-cb4ae8be-5b0e-4342-9231-45b804f300df\"\n ],\n \"videoUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/videos/Project/1/videos-c1e40a41-2716-4dfc-830e-884c7ab3f9e9\"\n ],\n \"facilities\": [\n \"Sauna\",\n \"Jacuzzi\",\n \"Pool\",\n \"Gym\",\n \"Tennis\",\n \"Squash\",\n \"Spa\",\n \"Restaurant\",\n \"Bar\",\n \"Cafe\",\n \"Playground\"\n ],\n \"properties\": [\n {\n \"id\": \"7VD318Z4\",\n \"name\": \"1+1\",\n \"description\": \"Our 1+1 apartments are located in Istanbul\",\n \"minPrice\": 2000000,\n \"maxPrice\": 2200000,\n \"measurement\": \"sqm2\",\n \"numberOfRooms\": \"OnePlusOne\",\n \"size\": 46,\n \"lastUpdatedAt\": \"2023-03-26T15:01:35\",\n \"currency\": \"TRY\",\n \"paymentPlan\": \"Cash\",\n \"features\": [\n \"Balcony\",\n \"American Kitchen\",\n \"Kitchenette\",\n \"Sea View\",\n \"Balcony\"\n ],\n \"imageUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/images/images-8e9853dd-639b-419b-8c74-98f9eb850b97\"\n ],\n \"videoUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/videos/videos-8e9853dd-639b-419b-8c74-98f9eb850b97\"\n ],\n \"planUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/plans/properties/9Q8YG862/plans-79a932fb-57a6-45e8-b14d-5c09d15857bd\",\n \"https://d18iwq8rvfnbhk.cloudfront.net/plans/properties/9Q8YG862/plans-fae7ac01-03cf-4ecf-aa47-7071122fd355\"\n ]\n }\n ]\n }\n ]\n }\n }\n}" }, { "schema": [ { "kind": "optional", "type": "object", "schema": [ { "kind": "required", "name": "success", "type": "boolean", "example": "" }, { "kind": "required", "name": "code", "type": "integer", "example": 0 }, { "kind": "optional", "name": "messages", "type": "object", "schema": [], "example": {} }, { "kind": "required", "name": "time", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "customType": "ErrorResponse", "isExpanded": true } ], "isExpanded": true, "statusCode": "400", "description": "Bad request, Some of the parameters are not valid", "jsonExample": "{\n \"ErrorResponse\": {\n \"summary\": \"Bad request, Some of the parameters are not valid\",\n \"description\": \"ErrorResponse\",\n \"value\": {\n \"success\": false,\n \"code\": 1,\n \"message\": \"Some of the parameters are not valid\"\n }\n }\n}" }, { "schema": [ { "kind": "optional", "type": "object", "schema": [ { "kind": "required", "name": "success", "type": "boolean", "example": "" }, { "kind": "required", "name": "code", "type": "integer", "example": 0 }, { "kind": "optional", "name": "messages", "type": "object", "schema": [], "example": {} }, { "kind": "required", "name": "time", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "customType": "ErrorResponse", "isExpanded": true } ], "isExpanded": true, "statusCode": "403", "description": "Access Denied, you don't have the right permissions", "jsonExample": "" }, { "schema": [ { "kind": "optional", "type": "object", "schema": [ { "kind": "required", "name": "success", "type": "boolean", "example": "" }, { "kind": "required", "name": "code", "type": "integer", "example": 0 }, { "kind": "optional", "name": "messages", "type": "object", "schema": [], "example": {} }, { "kind": "required", "name": "time", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "customType": "ErrorResponse", "isExpanded": true } ], "isExpanded": true, "statusCode": "500", "description": "System Exception, please contact the administrator", "jsonExample": "" } ], "contentType": "application/json", "examples": { "languages": [ { "id": "5ZH7Lyw-_4hIImFxfonzS", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url http://localhost:8080/api/v0/search \\\n --header 'accept: application/json'" }, { "id": "31ikkrQhXXVN-RKNR7eFl", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"http://localhost:8080/api/v0/search\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "kcQRfrEx8bYGR-rPk3aOi", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://localhost:8080/api/v0/search\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "RncqdjH2jVxpBgyHGoY5Y", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"http://localhost:8080/api/v0/search\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "5ZH7Lyw-_4hIImFxfonzS" }, "results": { "languages": [ { "id": "aCmFjRIsDkSUaLYNIl6LD", "language": "200", "code": "{\n \"SearchResponse\": {\n \"summary\": \"Successful operation with some results or no results matching the search criteria\",\n \"description\": \"SearchResponse\",\n \"value\": {\n \"projects\": [\n {\n \"id\": \"9Q8YG862\",\n \"name\": \"Istanbul Life\",\n \"description\": \"Istanbul Life is a project that is located in Istanbul\",\n \"country\": \"Turkey\",\n \"city\": \"Istanbul\",\n \"lastUpdatedAt\": \"2023-03-26T14:53:52\",\n \"lat\": 40.9814,\n \"lng\": 29.0247,\n \"titleDeedStatus\": \"Ready\",\n \"area\": \"Kadikoy\",\n \"type\": \"Residential\",\n \"citizenshipEligible\": true,\n \"readyForDelivery\": true,\n \"imageUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/images/Project/1/images-cb4ae8be-5b0e-4342-9231-45b804f300df\"\n ],\n \"videoUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/videos/Project/1/videos-c1e40a41-2716-4dfc-830e-884c7ab3f9e9\"\n ],\n \"facilities\": [\n \"Sauna\",\n \"Jacuzzi\",\n \"Pool\",\n \"Gym\",\n \"Tennis\",\n \"Squash\",\n \"Spa\",\n \"Restaurant\",\n \"Bar\",\n \"Cafe\",\n \"Playground\"\n ],\n \"properties\": [\n {\n \"id\": \"7VD318Z4\",\n \"name\": \"1+1\",\n \"description\": \"Our 1+1 apartments are located in Istanbul\",\n \"minPrice\": 2000000,\n \"maxPrice\": 2200000,\n \"measurement\": \"sqm2\",\n \"numberOfRooms\": \"OnePlusOne\",\n \"size\": 46,\n \"lastUpdatedAt\": \"2023-03-26T15:01:35\",\n \"currency\": \"TRY\",\n \"paymentPlan\": \"Cash\",\n \"features\": [\n \"Balcony\",\n \"American Kitchen\",\n \"Kitchenette\",\n \"Sea View\",\n \"Balcony\"\n ],\n \"imageUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/images/images-8e9853dd-639b-419b-8c74-98f9eb850b97\"\n ],\n \"videoUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/videos/videos-8e9853dd-639b-419b-8c74-98f9eb850b97\"\n ],\n \"planUrls\": [\n \"https://d18iwq8rvfnbhk.cloudfront.net/plans/properties/9Q8YG862/plans-79a932fb-57a6-45e8-b14d-5c09d15857bd\",\n \"https://d18iwq8rvfnbhk.cloudfront.net/plans/properties/9Q8YG862/plans-fae7ac01-03cf-4ecf-aa47-7071122fd355\"\n ]\n }\n ]\n }\n ]\n }\n }\n}" }, { "id": "AlEIPGJQ5VQCSdikfa_84", "language": "400", "code": "{\n \"ErrorResponse\": {\n \"summary\": \"Bad request, Some of the parameters are not valid\",\n \"description\": \"ErrorResponse\",\n \"value\": {\n \"success\": false,\n \"code\": 1,\n \"message\": \"Some of the parameters are not valid\"\n }\n }\n}" }, { "id": "9p73toeZy9VzN3ICTnB9Z", "language": "403", "code": "// Access Denied, you don't have the right permissions\n{\n \"success\": false,\n \"code\": \"\",\n \"messages\": {},\n \"time\": \"\"\n}" }, { "id": "SX81j_ioYPRB9ZIqZlZMy", "language": "500", "code": "// System Exception, please contact the administrator\n{\n \"success\": false,\n \"code\": \"\",\n \"messages\": {},\n \"time\": \"\"\n}" } ], "selectedLanguageId": "aCmFjRIsDkSUaLYNIl6LD" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }