Relynk API (2.0.0_beta)

Download OpenAPI specification:Download

customers

get list of customers

Authorizations:

BearerAuthApiKeyAuth

query Parameters

limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Value: "name" sort the returned list
name	string filter by name
id	string <uuid> filter by id
name__contains	string filter by name contains

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]

spaces

get list of spaces

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> filter by customer id
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" sort the returned list
name	string filter by name
name__contains	string filter by name contains
id	string <uuid> filter by id
type	string filter by type
subtype	string filter by subtype
levelNumber	integer filter by level number
isPartOfSpaceId	string <uuid> filter by is part of space id
path__contains	string filter by path contains
includeOptionalFields	Array of strings Items Enum: "hasPartSpaceIds" "isLocationOfAssetIds" "isLocationOfBuildingElementIds" "hasGeometryIds" "hasFileIds" "hasPointIds" "isFedByAssetIds" "isOwnedByAgentIds" "includedByCollectionIds" "meteredByAssetIds" include optional fields

Responses

Response samples

200

Content type

application/json

[{"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"path": "string",
"subtype": "string",
"type": "string",
"levelNumber": 0,
"isPartOfSpaceId": "02d78627-e569-44a0-9d8e-6e27bf556961",
"identifiers": { },
"grossArea": 0,
"netArea": 0,
"rentableArea": 0,
"hasPartSpaceIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"isLocationOfAssetIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"isLocationOfBuildingElementIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"hasGeometryIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"maxOccupancy": 0,
"seatingCapacity": 0,
"hasFileIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"hasPointIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"isFedByAssetIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"isOwnedByAgentIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"includedByCollectionIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"meteredByAssetIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]

get status of spaces

Authorizations:

BearerAuthApiKeyAuth

query Parameters

customerId required	string <uuid> filter by customer id
limit	integer (Limit) [ 1 .. 500 ] limit the number returned
offset	integer (Offset) >= 0 offset the returned list
order	string (Order) Enum: "asc" "desc" order the returned list
sort	string Enum: "id" "name" sort the returned list
name	string filter by name
name__contains	string filter by name contains
id	string <uuid> filter by id
type	string filter by type
subtype	string filter by subtype
levelNumber	integer filter by level number
isPartOfSpaceId	string <uuid> filter by is part of space id
path__contains	string filter by path contains
includeOptionalFields	Array of strings Items Enum: "name" "occupancy" "occupancyCount" "temperature" "humidity" "co2" "todaysBookingEvents" include status fields

Responses

Response samples

200

Content type

application/json

[{"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"occupancy": 0,
"occupancyCount": 0,
"todaysBookingEvents": [{"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"organizerName": "string",
"organizerDomain": "string"
}
],
"temperature": 0,
"temperatureUnit": "string",
"humidity": 0,
"humidityUnit": "string",
"co2": 0,
"co2Unit": "string",
"tvoc": 0,
"tvocUnit": "string"
}
]