Skip to content
Aziz Catalogue API

List project features and amenities

GET
/project-preferences
curl --request GET \
  --url 'https://agent-dev.azizdubai.com/project-preferences?type=1' \
  --header 'X-API-Key: <X-API-Key>'

Grouped into two sections: features (type=1) and amenities (type=2).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
type
integer
Allowed values: 1 2

Restrict the result to one section.

Responses

Section titled “Responses”

200

Section titled “200”

The catalogue, grouped by section.

Media typeapplication/json
object
status
required
string
Allowed value: success
data
required

The shape depends on the operation.

data
required
object
features
Array<object>
object
id
integer
name
string
type

1 — feature, 2 — amenity.

integer
Allowed values: 1 2
amenities
Array<object>
object
id
integer
name
string
type

1 — feature, 2 — amenity.

integer
Allowed values: 1 2

Example 

{
  "status": "success",
  "data": {
    "features": [
      {
        "name": "Infinity Pool",
        "type": 1
      }
    ],
    "amenities": [
      {
        "name": "Infinity Pool",
        "type": 1
      }
    ]
  }
}

400

Section titled “400”

A parameter or the request body failed validation.

Media typeapplication/json
object
status
required
string
Allowed value: error
message
required

Human-readable message.

string

Examples

ExamplebadID
{
  "status": "error",
  "message": "id must be a positive integer"
}

401

Section titled “401”

The key is missing (missing api key) or invalid (invalid api key). The latter covers unknown, revoked and deleted keys. Every operation requires a key, so any request without one receives this response.

Media typeapplication/json
object
status
required
string
Allowed value: error
message
required

Human-readable message.

string

Examples

Exampleinvalid
{
  "status": "error",
  "message": "invalid api key"
}

403

Section titled “403”

The key is valid, but it is restricted to a list of domains and the request’s Origin (or Referer) does not match any of them; or the key’s agency has no approved licence.

Media typeapplication/json
object
status
required
string
Allowed value: error
message
required

Human-readable message.

string

Examples

{
  "status": "error",
  "message": "origin is not allowed for this api key"
}

500

Section titled “500”

An unexpected error. The cause is logged; a generic message is returned.

Media typeapplication/json
object
status
required
string
Allowed value: error
message
required

Human-readable message.

string

Examples

Examplegeneric
{
  "status": "error",
  "message": "internal server error"
}