Circuit Laundry View
Product Information
Category | Other |
Sub-category | Laundry |
Website | https://www.circuit.co.uk/i-want-to-do-my-laundry/laundry-view/ |
Product version | |
Documentation | https://www.circuit.co.uk/i-want-to-do-my-laundry/laundry-help/ |
API Documentation |
About Circuit Laundry View
Circuit is the UK’s biggest managed laundry partner, helping thousands of sites like yours open up revenue streams through on-premise launderettes. But it’s the emphasis we place on the little things that set us apart… an attention to detail that others often overlook.
We’ll be with you all the way on your managed laundry site, and make sure everything from the height of the detergent dispensers to the positioning of informational posters is ‘just so’. With end-to-end assistance, all you’ll need to do is watch the profits roll in. There’s no hassle, no capital outlay….and no reason not to choose Circuit.
Integration Overview
The campusM integration with the Circuit Laundry View provides the following functions:
- View all available laundry rooms and their available appliances
- For each room view the details of each appliance
- For each machine view the full details
- Report an issue with an appliance or room
Integration Method
- API
Prerequisites
There are several prerequisites to the campusM integration with Circuit Laundry View:
Prerequisite | Additional Information |
---|---|
Provide an API Key |
User Experience
Property | Static Tile |
---|---|
Default Size | 1x1 |
Minimum Size | 1x1 |
Suggested Design |
Screenshots
Sample Request and Response
Sample Room Data Request |
---|
http://api.laundryview.com/school/?api_key=<API_KEY>&method=getRoomData |
Sample Response |
---|
<school> <school_name>NORTHERSHIRE UNIVERSITY</school_name> <laundry_rooms> <laundryroom> <location>000001</location> <campus_name>NORTHERSHIRE UNIVERSITY</campus_name> <laundry_room_name> Dorms Laundry 101</laundry_room_name> <status>online</status> </laundryroom> <laundryroom> <location>000002</location> <campus_name>NORTHERSHIRE UNIVERSITY</campus_name> <laundry_room_name>Main Building – 1st Floor</laundry_room_name> <status>online</status> </laundryroom> </laundry_rooms> </school> |
Sample Room Availability Data Request |
---|
http://api.laundryview.com/school/?api_key=<API_KEY> |
Sample Response |
---|
<laundry_rooms> <laundryroom> <location>000001</location> <available_washers>4</available_washers> <available_dryers>16</available_dryers> </laundryroom> <laundryroom> <location>000002</location> <available_washers>2</available_washers> <available_dryers>3</available_dryers> </laundryroom> </laundry_rooms> |
Sample Appliances Status Request |
---|
http://api.laundryview.com/room/?api_key=<API_KEY> |
Sample Response |
---|
<laundry_room> <laundry_room_name>Main Building – 1st Floor</laundry_room_name> <campus_name>NORTHERSHIRE UNIVERSITY</campus_name> <appliances> <appliance> <appliance_desc_key>001</appliance_desc_key> <lrm_status>Online</lrm_status> <appliance_type>WASHER</appliance_type> <status>In Use</status> <out_of_service>0</out_of_service> <label>02</label> <avg_cycle_time>35</avg_cycle_time> <time_remaining>est. time remaining 17 min</time_remaining> </appliance> <appliance> <appliance_desc_key>002</appliance_desc_key> <lrm_status>Online</lrm_status> <appliance_type>WASHER</appliance_type> <status>Available</status> <out_of_service>0</out_of_service> <label>04</label> <avg_cycle_time>35</avg_cycle_time> <time_remaining>available</time_remaining> </appliance> </appliances> </laundry_room> |
Offline Functionality
Not supported.
Configuration Options
Not supported.
Labels
Label | Default Value |
---|---|
Page Title | Laundry Rooms |
Total Machines | Total Machines |
Available Washers | Available Washers |
Available Dryers | Available Dryers |
Suggested Testing Guidelines
The following acceptance criteria is recommend to be used as part of the testing and approval process:
- User can view the list of laundry rooms
- User can select a laundry room to view appliances status
- User can select an appliance to view its full status details and report a problem