On this page
article
step 5 - Add Facilities to the Property
GetFacilities
-
API: getFacilities
-
Purpose & Use Cases: Retrieve available facilities in the system on http://Student.com.
-
Request:
query GetFacilities {
getFacilities {
features {
slug
label
name
group
type
}
bills {
slug
label
name
group
type
}
securityAndSafety {
slug
label
name
group
type
}
propertyRules {
slug
label
name
group
type
}
}
}
- Response:
{
"data": {
"getFacilities": {
"features": [
{
"slug": "bike_storage",
"label": "Bike Storage",
"name": "Bike storage",
"group": "",
"type": "PROPERTY"
},
{
"slug": "cinema",
"label": "Cinema Room",
"name": "Cinema Room",
"group": "",
"type": "PROPERTY"
},
{
"slug": "communal_kitchen",
"label": "Communal Kitchen",
"name": "Communal Kitchen",
"group": "",
"type": "PROPERTY"
},
{
"slug": "elevators",
"label": "Elevators",
"name": "Elevators",
"group": "",
"type": "PROPERTY"
},
{
"slug": "entertainment_area",
"label": "Entertainment Area/ Room",
"name": "Entertainment Area/ Room",
"group": "",
"type": "PROPERTY"
},
{
"slug": "fully_furnished",
"label": "Fully Furnished",
"name": "Fully Furnished",
"group": "furnished",
"type": "PROPERTY"
},
{
"slug": "furnished_additional_fee",
"label": "Furnished for Additional Fee",
"name": "Furnished for Additional Fee",
"group": "furnished",
"type": "PROPERTY"
},
{
"slug": "furnished_no_service",
"label": "No Service",
"name": "Furnished (no Service)",
"group": "furnished",
"type": "PROPERTY"
},
{
"slug": "gym",
"label": "Gym",
"name": "Gym",
"group": "",
"type": "PROPERTY"
},
{
"slug": "laundry",
"label": "Laundry Facilities in Student's Apartment",
"name": "Laundry Facilities in Student's Apartment",
"group": "laundry_facilities",
"type": "PROPERTY"
},
{
"slug": "laundry_coin",
"label": "Communal Laundry (Coin-operated)",
"name": "Communal Laundry (Coin-operated)",
"group": "laundry_facilities",
"type": "PROPERTY"
},
{
"slug": "laundry_facilities_no_service",
"label": "No Service",
"name": "Laundry Facilities (no Service)",
"group": "laundry_facilities",
"type": "PROPERTY"
},
{
"slug": "laundry_free",
"label": "Communal Laundry (Free)",
"name": "Communal Laundry (Free)",
"group": "laundry_facilities",
"type": "PROPERTY"
},
{
"slug": "library_study_area",
"label": "Library / Study Area",
"name": "Library / Study Area",
"group": "",
"type": "PROPERTY"
},
{
"slug": "onsite_manager",
"label": "Onsite Manager",
"name": "Onsite Manager",
"group": "",
"type": "PROPERTY"
},
{
"slug": "personal_contents_insurance_included",
"label": "Personal Contents Insurance Included",
"name": "Personal contents insurance included",
"group": "",
"type": "PROPERTY"
},
{
"slug": "reception",
"label": "Reception",
"name": "Reception",
"group": "",
"type": "PROPERTY"
},
{
"slug": "refrigrator",
"label": "Refrigerator",
"name": "Refrigerator",
"group": "",
"type": "PROPERTY"
},
{
"slug": "shuttle_bus_to_university",
"label": "Shuttle Bus to University",
"name": "Shuttle bus to university",
"group": "",
"type": "PROPERTY"
},
{
"slug": "unfurnished",
"label": "Unfurnished",
"name": "Unfurnished",
"group": "furnished",
"type": "PROPERTY"
},
{
"slug": "wifi",
"label": "Wifi",
"name": "Wifi",
"group": "",
"type": "PROPERTY"
}
],
"bills": [
{
"slug": "cleaning_service_charge_seperately",
"label": "Charge Separately",
"name": "Cleaning Service",
"group": "cleaning_service",
"type": "PROPERTY"
},
{
"slug": "cleaning_service_free",
"label": "Free",
"name": "Cleaning Service",
"group": "cleaning_service",
"type": "PROPERTY"
},
{
"slug": "cleaning_service_no_service",
"label": "No Service",
"name": "Cleaning Service",
"group": "cleaning_service",
"type": "PROPERTY"
},
{
"slug": "contents_insurance_charge_seperately",
"label": "Charge Separately",
"name": "Contents Insurance",
"group": "contents_insurance",
"type": "PROPERTY"
},
{
"slug": "contents_insurance_free",
"label": "Free",
"name": "Contents Insurance",
"group": "contents_insurance",
"type": "PROPERTY"
},
{
"slug": "contents_insurance_no_service",
"label": "No Service",
"name": "Contents Insurance",
"group": "contents_insurance",
"type": "PROPERTY"
},
{
"slug": "electricity_charge_seperately",
"label": "Charge Separately",
"name": "Electricity",
"group": "electricity",
"type": "PROPERTY"
},
{
"slug": "electricity_free",
"label": "Free",
"name": "Electricity",
"group": "electricity",
"type": "PROPERTY"
},
{
"slug": "electricity_free_within_usage_capacity",
"label": "Free within Usage Capacity",
"name": "Electricity (Within usage capacity)",
"group": "electricity",
"type": "PROPERTY"
},
{
"slug": "electricity_no_service",
"label": "No Service",
"name": "Electricity (no Service)",
"group": "electricity",
"type": "PROPERTY"
},
{
"slug": "gas_charge_seperately",
"label": "Charge Separately",
"name": "Gas",
"group": "gas",
"type": "PROPERTY"
},
{
"slug": "gas_free",
"label": "Free",
"name": "Gas",
"group": "gas",
"type": "PROPERTY"
},
{
"slug": "gas_free_within_usage_capacity",
"label": "Free within Usage Capacity",
"name": "Gas (Within usage capacity)",
"group": "gas",
"type": "PROPERTY"
},
{
"slug": "gas_no_service",
"label": "No Service",
"name": "Gas (no Service)",
"group": "gas",
"type": "PROPERTY"
},
{
"slug": "heating_charge_seperately",
"label": "Charge Separately",
"name": "Heating",
"group": "heating",
"type": "PROPERTY"
},
{
"slug": "heating_free",
"label": "Free",
"name": "Heating",
"group": "heating",
"type": "PROPERTY"
},
{
"slug": "heating_free_within_usage_capacity",
"label": "Free within Usage Capacity",
"name": "Heating (Within usage capacity)",
"group": "heating",
"type": "PROPERTY"
},
{
"slug": "heating_no_service",
"label": "No Service",
"name": "Heating (no Service)",
"group": "heating",
"type": "PROPERTY"
},
{
"slug": "meals_included_all_meals",
"label": "All Meals",
"name": "Meals",
"group": "meals",
"type": "PROPERTY"
},
{
"slug": "meals_included_flexi_meals",
"label": "Flexi Meals",
"name": "Meals",
"group": "meals",
"type": "PROPERTY"
},
{
"slug": "meals_included_half_board",
"label": "Half Board",
"name": "Half Meals",
"group": "meals",
"type": "PROPERTY"
},
{
"slug": "meals_included_no_service",
"label": "No Service",
"name": "Meals",
"group": "meals",
"type": "PROPERTY"
},
{
"slug": "water_charge_seperately",
"label": "Charge Separately",
"name": "Water",
"group": "water",
"type": "PROPERTY"
},
{
"slug": "water_free",
"label": "Free",
"name": "Water",
"group": "water",
"type": "PROPERTY"
},
{
"slug": "water_free_within_usage_capacity",
"label": "Free within Usage Capacity",
"name": "Water (Within usage capacity)",
"group": "water",
"type": "PROPERTY"
},
{
"slug": "water_no_service",
"label": "No Service",
"name": "Water (no Service)",
"group": "water",
"type": "PROPERTY"
},
{
"slug": "wifi_charge_seperately",
"label": "Charge Separately",
"name": "Wifi",
"group": "wifi",
"type": "PROPERTY"
},
{
"slug": "wifi_free",
"label": "Free",
"name": "Wifi",
"group": "wifi",
"type": "PROPERTY"
},
{
"slug": "wifi_free_within_usage_capacity",
"label": "Free within Usage Capacity",
"name": "Wi-Fi (Within usage capacity)",
"group": "wifi",
"type": "PROPERTY"
},
{
"slug": "wifi_no_service",
"label": "No Service",
"name": "Wifi (no Service)",
"group": "wifi",
"type": "PROPERTY"
}
],
"securityAndSafety": [
{
"slug": "cctv",
"label": "CCTV / Surveillance Cameras",
"name": "CCTV / Surveillance Cameras",
"group": "",
"type": "PROPERTY"
},
{
"slug": "controlled_access_gate_24_hour",
"label": "24-hour",
"name": "Controlled Access Gate (24-hour)",
"group": "controlled_access_gate",
"type": "PROPERTY"
},
{
"slug": "controlled_access_gate_fob_key",
"label": "Fob Key",
"name": "Controlled Access Gate (Fob key)",
"group": "controlled_access_gate",
"type": "PROPERTY"
},
{
"slug": "controlled_access_gate_locked_gate",
"label": "Locked Gate",
"name": "Controlled Access Gate (Locked gate)",
"group": "controlled_access_gate",
"type": "PROPERTY"
},
{
"slug": "controlled_access_gate_no_service",
"label": "No Service",
"name": "Controlled Access Gate (no Service)",
"group": "controlled_access_gate",
"type": "PROPERTY"
},
{
"slug": "controlled_access_gate_swipe_key",
"label": "Swipe Key",
"name": "Controlled Access Gate (Swipe key)",
"group": "controlled_access_gate",
"type": "PROPERTY"
},
{
"slug": "maintenance_team_24_hour_on_call",
"label": "24-hour on Call",
"name": "Maintenance Team (24-hour on call)",
"group": "maintenance_team",
"type": "PROPERTY"
},
{
"slug": "maintenance_team_24_hour_on_site",
"label": "24-hour on Site",
"name": "Maintenance Team (24-hour on site)",
"group": "maintenance_team",
"type": "PROPERTY"
},
{
"slug": "maintenance_team_daytime_only",
"label": "Daytime Only",
"name": "Maintenance Team (Daytime only)",
"group": "maintenance_team",
"type": "PROPERTY"
},
{
"slug": "maintenance_team_no_service",
"label": "No Service",
"name": "Maintenance Team (no Service)",
"group": "maintenance_team",
"type": "PROPERTY"
},
{
"slug": "security_alarm",
"label": "Security Alarm",
"name": "Security Alarm",
"group": "",
"type": "PROPERTY"
},
{
"slug": "security_officer_24_hour_patrol",
"label": "24-hour Patrol",
"name": "Security Officer (24-hour patrol)",
"group": "security_officer",
"type": "PROPERTY"
},
{
"slug": "security_officer_night_patrol",
"label": "Night Patrol",
"name": "Security Officer (Night patrol)",
"group": "security_officer",
"type": "PROPERTY"
},
{
"slug": "security_officer_no_service",
"label": "No Service",
"name": "Security Officer (no Service)",
"group": "security_officer",
"type": "PROPERTY"
}
],
"propertyRules": [
{
"slug": "family_friendly",
"label": "Family Friendly",
"name": "Family Friendly",
"group": "",
"type": "PROPERTY"
},
{
"slug": "no_alcohol",
"label": "No Alcohol in Communal/Public Areas",
"name": "No Alcohol in Communal/Public Areas",
"group": "",
"type": "PROPERTY"
},
{
"slug": "no_pets",
"label": "No Pets",
"name": "No Pets",
"group": "",
"type": "PROPERTY"
},
{
"slug": "no_smoking",
"label": "No Smoking",
"name": "No Smoking",
"group": "",
"type": "PROPERTY"
},
{
"slug": "no_under_18",
"label": "No under 18s",
"name": "No under 18s",
"group": "",
"type": "PROPERTY"
}
]
}
}
}
UpdatePropertyFacilities
-
API: updatePropertyFacilities
-
Purpose & Use Cases: Create or update the facilities for a specific property.
-
Request:
| Attribute Name | Data Type | Required | Details |
|---|---|---|---|
| propertyId | DecodedPropertyID | Yes | Identifier for the related property object |
| facilitySlugs | String[] | No | Slug list of the facilities, candidates are from getFacilities API |
QUERY
mutation UpdatePropertyFacilities($input: UpdatePropertyFacilitiesInput) {
updatePropertyFacilities(input: $input) {
success
}
}
GRAPHQL VARIABLES
{
"input": {
"facilitySlugs": ["bike_storage","communal_kitchen"],
"propertyId": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6MTA0NDc3M30"
}
}
- Response:
{
"data": {
"updatePropertyFacilities": {
"success": true
}
}
}
- Error Message:
| Error Message | Description |
|---|---|
| [${invalidSlugs}] are invalid for current property | Unable to update property facilities because the provided slugs are invalid for the current property |
Facility Object
| Attribute Name | Data Type | Details |
|---|---|---|
| slug | String | Identifier for the facility object |
| label | String | Label displayed in the system |
| name | String | Name of the facility |
| group | String | Group of the facility |
| type | FacilityType | Type of the facility; Possible values: PROPERTY UNIT_TYPE |